docs(scripting): add baseline api reference and guide
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
# IScriptRuntime::TryGetClassFieldMetadata
|
||||
|
||||
**命名空间**: `XCEngine::Scripting`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Scripting/IScriptRuntime.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
virtual bool TryGetClassFieldMetadata(
|
||||
const std::string& assemblyName,
|
||||
const std::string& namespaceName,
|
||||
const std::string& className,
|
||||
std::vector<ScriptFieldMetadata>& outFields) const = 0;
|
||||
```
|
||||
|
||||
## 作用
|
||||
|
||||
查询某个脚本类公开字段的元数据。
|
||||
|
||||
## 返回值语义
|
||||
|
||||
- 返回 `true`:后端确认这个类存在,并成功返回字段元数据。
|
||||
- 返回 `false`:类不存在、后端未初始化,或后端根本不支持这类查询。
|
||||
|
||||
## 设计意义
|
||||
|
||||
`ScriptEngine` 依赖它来做字段编辑校验、字段模型拼装和运行时/本地字段差异对比。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [ScriptField](../ScriptField/ScriptField.md)
|
||||
- [ScriptEngine::TryGetScriptFieldModel](../ScriptEngine/TryGetScriptFieldModel.md)
|
||||
Reference in New Issue
Block a user