docs: update scripting API docs
This commit is contained in:
@@ -6,11 +6,17 @@
|
||||
|
||||
**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h`
|
||||
|
||||
**描述**: 以字段名为键保存脚本字段值的本地缓存容器。
|
||||
**描述**: 以字段名为键保存脚本字段覆盖值的本地缓存容器。
|
||||
|
||||
## 概览
|
||||
|
||||
`ScriptFieldStorage` 是当前脚本系统的数据缓冲层。它保存的不是“任意运行时变量”,而是需要在原生侧被识别、查询、序列化和可能回写的一组字段。
|
||||
`ScriptFieldStorage` 是当前脚本系统的数据缓冲层。它保存的不是“任意运行时变量”,而是需要在原生侧被识别、查询、序列化和可能回写的一组字段覆盖值。
|
||||
|
||||
在当前实现里它承担三种职责:
|
||||
|
||||
- 场景序列化时持久化脚本字段覆盖值。
|
||||
- 运行前为 Inspector/工具提供可编辑的本地字段落点。
|
||||
- 运行中接收 `MonoScriptRuntime::SyncManagedFieldsToStorage()` 的回写。
|
||||
|
||||
## 设计要点
|
||||
|
||||
@@ -23,6 +29,7 @@
|
||||
|
||||
- 不是线程安全容器。
|
||||
- 不做类型自动转换。
|
||||
- 不负责解释字段是否仍被脚本类声明;这部分语义由 `ScriptEngine::TryGetScriptFieldModel()` 结合类元数据来判定。
|
||||
- 遇到非法反序列化行时会跳过,而不是抛异常中断整个恢复流程。
|
||||
|
||||
## 公开方法
|
||||
|
||||
Reference in New Issue
Block a user