docs(scripting): add baseline api reference and guide
This commit is contained in:
@@ -0,0 +1,31 @@
|
||||
# ScriptEngine::TryGetScriptFieldValue
|
||||
|
||||
**命名空间**: `XCEngine::Scripting`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Scripting/ScriptEngine.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
bool TryGetScriptFieldValue(
|
||||
const ScriptComponent* component,
|
||||
const std::string& fieldName,
|
||||
ScriptFieldValue& outValue) const;
|
||||
```
|
||||
|
||||
## 当前实现行为
|
||||
|
||||
- 先检查参数。
|
||||
- 如果运行时正在运行且该组件已有实例,会优先向运行时请求托管字段值。
|
||||
- 只有运行时读取失败时,才回退到 `ScriptFieldStorage`。
|
||||
|
||||
## 含义
|
||||
|
||||
这让用户看到的字段值尽量反映“当前活实例真实状态”,而不只是场景文件里最后一次保存的值。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [TrySetScriptFieldValue](TrySetScriptFieldValue.md)
|
||||
- [TryGetScriptFieldModel](TryGetScriptFieldModel.md)
|
||||
Reference in New Issue
Block a user