docs: sync api and planning docs

docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/MonoScriptRuntime.md

@@ -6,156 +6,205 @@
 
 **头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h`
 
-**描述**: 基于 Mono 的脚本运行时实现，负责程序集解析与加载、类发现、实例创建、字段桥接、默认值读取和生命周期调用。
+**描述**: 当前唯一的托管脚本运行时后端，实现程序集加载、脚本类发现、字段元数据/默认值查询、实例创建、字段同步和生命周期调用。
 
 ## 概览
 
-`MonoScriptRuntime` 是当前唯一的真实托管脚本后端。它把 `ScriptEngine` 提供的抽象调用翻译成 Mono 世界里的具体动作：
+`MonoScriptRuntime` 是 `IScriptRuntime` 的当前唯一实现。它把 `ScriptEngine` 需要的抽象操作落到 Mono 世界中：
 
-- 初始化 root domain 和 app domain。
-- 加载脚本核心程序集与游戏程序集。
-- 发现继承 `MonoBehaviour` 的可用脚本类，并缓存生命周期方法与字段元数据。
-- 读取类字段默认值。
-- 创建和销毁脚本实例。
-- 通过 internal call 让托管脚本访问原生 `GameObject`、`Transform`、`Camera`、`Light`、`MeshFilter`、`MeshRenderer`、`tag` / `layer` 元数据、日志、输入与时间能力，并把 `Object.Destroy(...)` 这类托管销毁请求回落到原生对象或组件销毁逻辑。
-- 把本地字段覆盖写入托管实例，并在生命周期之后同步回 `ScriptFieldStorage`。
+- 初始化和关闭 Mono 运行时上下文
+- 加载核心程序集与应用程序集
+- 发现可绑定脚本类
+- 缓存字段元数据和生命周期方法
+- 创建/销毁托管实例
+- 读写托管字段
+- 把托管 API 通过 internal call 接回原生系统
 
-它的设计取向和商业引擎常见方案一致：先把脚本编译成程序集，再以程序集元数据作为类发现、默认值读取和真正实例化的共同事实来源。
+这层分工的关键价值，在于让 `ScriptEngine` 负责“什么时候调度”，让 `MonoScriptRuntime` 负责“如何在 Mono 里执行”。这样后续即使更换后端，场景生命周期和字段同步模型也仍然可以保持一致。
 
 ## Settings
 
-构造函数接收一个 `Settings` 结构体，当前公开字段如下：
+构造函数接收一个 `Settings` 结构体。当前重要字段如下：
 
 | 字段 | 说明 |
 |------|------|
-| `assemblyDirectory` | 程序集目录；若 `coreAssemblyPath` / `appAssemblyPath` 缺失，会以它为基准推导 DLL 路径。 |
-| `corlibDirectory` | Mono 解析 `mscorlib.dll` 的目录；为空时会回退到 `assemblyDirectory` 或 `coreAssemblyPath` 所在目录。 |
-| `coreAssemblyPath` | `XCEngine.ScriptCore.dll` 的完整路径。 |
-| `appAssemblyPath` | `GameScripts.dll` 的完整路径。 |
-| `coreAssemblyName` | 脚本核心程序集名，默认 `XCEngine.ScriptCore`。 |
+| `assemblyDirectory` | 程序集目录；若显式路径为空，会以它推导 DLL 路径。 |
+| `corlibDirectory` | Mono 查找 `mscorlib.dll` 的目录。 |
+| `coreAssemblyPath` | `XCEngine.ScriptCore.dll` 的路径。 |
+| `appAssemblyPath` | `GameScripts.dll` 的路径。 |
+| `coreAssemblyName` | 核心程序集名，默认 `XCEngine.ScriptCore`。 |
 | `appAssemblyName` | 应用程序集名，默认 `GameScripts`。 |
-| `baseNamespace` | 核心托管 API 的命名空间，默认 `XCEngine`。 |
-| `baseClassName` | 作为脚本基类查找入口的类型名，默认 `MonoBehaviour`。 |
+| `baseNamespace` | 托管基础 API 命名空间，默认 `XCEngine`。 |
+| `baseClassName` | 作为脚本基类入口的类型名，默认 `MonoBehaviour`。 |
 
-`ResolveSettings()` 会在构造时和 `Initialize()` 前再次运行，补全目录和程序集路径。因此只提供 `assemblyDirectory` 也是合法用法；`tests/scripting/test_project_script_assembly.cpp` 就是基于项目脚本程序集目录这样初始化的。
+`ResolveSettings()` 会补全这些路径，因此当前既可以显式指定 DLL，也可以只指定程序集目录。
 
 ## 程序集与类发现模型
 
-当前 `MonoScriptRuntime` 的类发现有两个关键边界：
+当前脚本类发现遵循两个核心边界：
 
-- 只加载两份程序集:
-  - `XCEngine.ScriptCore.dll`
-  - `GameScripts.dll`
-- 只把应用程序集，也就是 `m_appImage` 这一侧的非抽象 `MonoBehaviour` 子类纳入可绑定脚本类缓存。
+- 只从 `m_appImage`，也就是应用程序集这一侧发现可绑定脚本类
+- 只接受非抽象的 `MonoBehaviour` 子类
 
 这意味着：
 
-- `ScriptCore` 负责基础 API 和托管基类，不负责向 Inspector 暴露可绑定游戏脚本。
-- 项目脚本是否可绑定，不取决于源码目录本身，而取决于它最终有没有进入 `GameScripts.dll`，以及它是不是非抽象 `MonoBehaviour` 子类。
-- `GetScriptClassNames()` 和 `TryGetAvailableScriptClasses()` 都只是读取这份已发现缓存，不会在查询时临时再做一遍程序集扫描。
+- `XCEngine.ScriptCore` 负责基础 API，不直接成为可绑定游戏脚本来源
+- `GameScripts.dll` 才是当前脚本类列表、字段元数据和默认值读取的共同事实来源
 
-## internal call 桥接语义
+## 字段发现规则
 
-当前 internal call 已经形成一套相对完整的脚本运行桥：
+字段发现发生在 `DiscoverScriptClassesInImage(...)` 阶段。当前真实筛选顺序是：
+
+1. 排除 `static`
+2. 排除 `literal / const`
+3. 排除 `init-only / readonly`
+4. 接受 `public` 字段，或者带 `[SerializeField]` 的 `private` 字段
+5. 再由 `BuildFieldMetadata(...)` 检查字段类型是否受支持
+
+这让当前字段模型和 Unity 风格更加接近：既支持公开字段，也支持“保持封装但允许序列化”的 `[SerializeField] private` 字段。
+
+## 当前支持的字段类型
+
+`BuildFieldMetadata(...)` 当前支持以下字段类型：
+
+- `float`
+- `double`
+- `bool`
+- `int32`
+- `uint64`
+- `string`
+- `enum`
+  - 当前以 `ScriptFieldType::Int32` 暴露
+  - 仅支持基础类型为 `I1 / U1 / I2 / U2 / I4 / U4` 的枚举
+- `Vector2`
+- `Vector3`
+- `Vector4`
+- `GameObject`
+- 具体组件引用
+  - `Transform`
+  - `Camera`
+  - `Light`
+  - `MeshFilter`
+  - `MeshRenderer`
+  - 具体脚本组件类型
+
+以下类型当前不会进入字段模型：
+
+- 未标注的 `private` 字段
+- `readonly` 字段
+- `Quaternion`
+- `Component` / `MonoBehaviour` 这类过于宽泛的基类引用
+- 数组、列表、泛型容器等当前未桥接类型
+- 64 位底层枚举等未列入支持范围的枚举底层类型
+
+## `TryGetClassFieldMetadata()` 与 `TryGetClassFieldDefaultValues()`
+
+[TryGetClassFieldMetadata](TryGetClassFieldMetadata.md) 和 [TryGetClassFieldDefaultValues](TryGetClassFieldDefaultValues.md) 都只操作“已经通过上述规则进入字段缓存”的字段集合。
+
+其中默认值查询当前会：
+
+1. 切到 app domain
+2. 临时创建一个托管对象
+3. 执行默认构造和字段初始化
+4. 逐个读取字段值
+
+因此它返回的是“真实 C# 初始化后”的默认值，而不是单纯的 CLR 零值。
+
+这也是为什么测试里可以直接读到：
+
+- `FieldMetadataProbe.State == 2`
+- `FieldMetadataProbe.HiddenFlag == true`
+- `ProjectScriptProbe.Label == "ProjectScriptProbe"`
+
+## 实例创建与字段同步
+
+当前实例与字段同步模型是：
+
+- [CreateScriptInstance](CreateScriptInstance.md)
+  - 根据 `ScriptComponent` 找类
+  - 创建托管对象
+  - 注入 `gameObjectUUID` / `scriptComponentUUID`
+  - 把 `ScriptFieldStorage` 里的同名且类型匹配字段写回托管实例
+- [SyncManagedFieldsToStorage](SyncManagedFieldsToStorage.md)
+  - 把运行中的托管字段同步回本地存储
+
+这一模型和商业引擎的常见做法一致：类默认值提供初始模板，场景存储提供覆盖值，运行时再在同一字段集合上做双向同步。
+
+## 为什么支持 `[SerializeField] private`
+
+这是当前设计里非常关键的一点。支持它不是为了“多兼容一个语法糖”，而是为了兼顾两件事：
+
+- 脚本作者需要字段能进入序列化和 Inspector 体系
+- 但不希望因此把类的外部 API 全部暴露为 `public`
+
+这带来的直接好处是：
+
+- 封装边界更清晰
+- Inspector / 场景序列化体验更接近 Unity
+- 重构字段访问级别时更安全
+
+而继续忽略“未标注的 private 字段”，则能避免把纯内部实现状态误持久化。
+
+## internal call 桥接
+
+当前 internal call 已经接通一套相对完整的托管 API：
 
-- `Time.deltaTime`
-  - 来自 `InvokeMethod()` 在生命周期调用前写入的当前 delta。
-- `Time.fixedDeltaTime`
-  - 直接读取 `ScriptEngine::GetRuntimeFixedDeltaTime()`。
-- `Input`
-  - 直接转发到原生 [InputManager](../../../Input/InputManager/InputManager.md) 的当前状态。
-  - `GetKeyUp()` 当前对应释放边沿语义。
-  - `anyKey` / `anyKeyDown` 会把鼠标按钮也计入。
 - `Debug.Log*`
-  - 直接写入原生日志系统。
-- `GameObject.tag` / `GameObject.layer` / `GameObject.CompareTag()`
-  - 分别落到 `InternalCall_GameObject_GetTag / SetTag / CompareTag / GetLayer / SetLayer`
-  - `managed/XCEngine.ScriptCore/GameObject.cs` 同时提供 `Tag` / `tag`、`Layer` / `layer` 两组 Unity 风格属性别名
-  - `managed/XCEngine.ScriptCore/Component.cs` 再把这些属性直接转发到宿主 `GameObject`
-  - tag setter 会把 `null` 先归一成空字符串，再由 native `SetTag("")` 回退到 `"Untagged"`
-  - layer setter 会在 native internal call 中显式 clamp 到 `[0, 31]`
-
+- `Time`
+- `Input`
+- `GameObject`
+- `Transform`
+- `Camera`
+- `Light`
+- `MeshFilter`
+- `MeshRenderer`
 - `Object.Destroy(...)`
-  - 会走 `InternalCall_Object_Destroy -> MonoScriptRuntime::DestroyManagedObject(...)`
-  - 当前支持销毁活动运行时场景里的 `GameObject`，以及由托管包装对象映射到的 `Camera`、`Light`、`MeshFilter`、`MeshRenderer` 与脚本组件
-  - `Transform` 包装对象不会被当作可移除组件销毁
 
-这意味着托管脚本看到的 `Input` / `Time` / `tag` / `layer` 都不是独立副本，而是直接共享原生运行时当前状态。`tests/scripting/test_mono_script_runtime.cpp` 里 `GameObjectTagAndLayerApiExposeUnityStylePropertiesAndCompareTag` 也明确验证了：
+这些托管 API 当前并不是各自维护一套独立状态，而是直接桥接回原生系统。
 
-- 托管脚本能先读到原生侧已有的 tag/layer
-- 托管脚本写回后的 `"Player"` / `31` 会真实更新 native `GameObject`
-- 原生 `Scene::FindGameObjectWithTag("Player")` 会立刻看到这次更新
+## 测试锚点
 
-脚本端如果想正确理解边沿输入、fixed step 配置和对象元数据桥接，应同时对照 [Input Flow And Frame Semantics](../../../../_guides/Input/Input-Flow-and-Frame-Semantics.md) 与 [ScriptEngine](../../ScriptEngine/ScriptEngine.md)。
+当前行为直接受到以下测试约束：
 
-## 实例与字段同步
-
-`MonoScriptRuntime` 当前把“创建实例”和“字段同步”拆成两步：
-
-- `CreateScriptInstance()`
-  - 先根据 `ScriptComponent` 绑定解析类元数据。
-  - 创建托管对象并执行构造。
-  - 注入 `gameObjectUUID` / `scriptComponentUUID`。
-  - 再把 `ScriptFieldStorage` 中同名且类型匹配的字段写入托管实例。
-- `SyncManagedFieldsToStorage()`
-  - 只遍历本地已经存在的字段名。
-  - 只在类元数据仍存在且类型匹配时回写。
-
-这种策略比“看到字段就自动持久化”更保守，但更像工程级引擎的做法：场景层和运行时层边界更清楚，不容易被临时字段污染。
-
-## 生命周期
-
-- 构造时接收一份 `Settings`，并做路径补全。
-- [Initialize](Initialize.md) 会完成完整 Mono 初始化流程。
-- [OnRuntimeStart](OnRuntimeStart.md) 会清空活动场景 / `deltaTime` 共享状态，并在初始化成功后接入当前场景。
-- [OnRuntimeStop](OnRuntimeStop.md) 会清理活动场景与实例缓存，但不会做完整 `Shutdown()`。
-- [Shutdown](Shutdown.md) 会销毁 app domain、清空类缓存与实例缓存。
-- 析构会自动调用 `Shutdown()`。
-
-## 设计要点
-
-- `ScriptEngine` 不直接碰 Mono API；所有后端细节收敛在这个类里。
-- 类缓存和实例缓存都基于稳定键，便于场景重建、类切换和实例回绑。
-- `TryGetClassFieldDefaultValues()` 会创建一个临时托管对象并读取字段值，因此脚本字段默认值可以反映 C# 初始化表达式，而不只是原生零值。
-- `CreateScriptInstance()` 会先注入上下文 UUID，再把本地存储里同名且类型匹配的字段写入托管实例。
-- `SyncManagedFieldsToStorage()` 只回写本地已有字段，保证运行时不会把临时字段偷偷持久化到场景。
+- `ClassFieldMetadataListsSupportedPublicInstanceFields`
+- `ClassFieldDefaultValueQueryReturnsSerializeFieldPrivateInitializers`
+- `SerializeFieldPrivateFieldsApplyStoredValuesAndPersistAcrossSceneRoundTrip`
+- `test_project_script_assembly.cpp` 中的项目程序集发现与默认值读取用例
 
 ## 当前实现边界
 
-- 当前只发现应用程序集中的非抽象 `MonoBehaviour` 子类。
-- 支持的公共字段类型只覆盖 `float / double / bool / int32 / uint64 / string / Vector2 / Vector3 / Vector4 / GameObject`。
-- `TryGetAvailableScriptClasses()`、`GetScriptClassNames()` 和字段元数据查询都要求运行时已经初始化完成。
-- `SyncManagedFieldsToStorage()` 只会回写已经存在于 `ScriptFieldStorage` 中且类型仍匹配的字段；运行时临时字段不会自动持久化。
-- `OnRuntimeStop()` 只清理当前活动场景与实例，不会做完整 `Shutdown()`；程序集和类缓存会保留到显式 `Shutdown()` 或析构。
-- 目前没有程序集热重载、增量编译监听或多场景并发运行支持。
+- 当前只发现应用程序集里的非抽象 `MonoBehaviour` 子类。
+- `[SerializeField] private` 已纳入字段模型，但“未标注 private”依旧被忽略。
+- 默认值查询依赖真实托管对象实例化，因此类缺失、实例构造失败或字段读取失败都会让整次查询失败。
+- 当前没有程序集热重载、增量刷新或调试器集成。
 
 ## 公开方法
 
 | 方法 | 说明 |
 |------|------|
-| [Constructor](Constructor.md) | 创建 Mono 运行时对象并解析设置。 |
+| [Constructor](Constructor.md) | 创建运行时对象并解析设置。 |
 | [Destructor](Destructor.md) | 析构时执行 `Shutdown()`。 |
 | [Initialize](Initialize.md) | 初始化 Mono 域并发现脚本类。 |
 | [Shutdown](Shutdown.md) | 关闭当前 Mono 运行时。 |
 | [GetLastError](GetLastError.md) | 读取最近一次错误描述。 |
 | [IsClassAvailable](IsClassAvailable.md) | 查询脚本类是否已发现。 |
-| [GetScriptClassNames](GetScriptClassNames.md) | 返回已发现脚本类名列表。 |
-| `IsInitialized()` | 判断运行时是否已完成初始化。 |
-| `GetSettings()` | 返回已解析的运行时设置。 |
-| [TryGetAvailableScriptClasses](TryGetAvailableScriptClasses.md) | 返回完整脚本类描述列表。 |
-| [TryGetClassFieldMetadata](TryGetClassFieldMetadata.md) | 读取脚本类字段元数据。 |
-| [TryGetClassFieldDefaultValues](TryGetClassFieldDefaultValues.md) | 读取脚本类字段默认值。 |
-| [HasManagedInstance](HasManagedInstance.md) | 判断某脚本组件是否已有托管实例。 |
+| [GetScriptClassNames](GetScriptClassNames.md) | 返回已发现脚本类全名列表。 |
+| `IsInitialized()` | 判断运行时是否完成初始化。 |
+| `GetSettings()` | 返回已解析的设置。 |
+| [TryGetAvailableScriptClasses](TryGetAvailableScriptClasses.md) | 返回脚本类描述列表。 |
+| [TryGetClassFieldMetadata](TryGetClassFieldMetadata.md) | 返回当前字段模型中的字段元数据。 |
+| [TryGetClassFieldDefaultValues](TryGetClassFieldDefaultValues.md) | 返回当前字段模型中的真实默认值。 |
+| [HasManagedInstance](HasManagedInstance.md) | 判断脚本组件是否已有托管实例。 |
 | [GetManagedInstanceCount](GetManagedInstanceCount.md) | 返回当前托管实例数。 |
-| [GetManagedInstanceObject](GetManagedInstanceObject.md) | 读取托管对象裸指针。 |
+| [GetManagedInstanceObject](GetManagedInstanceObject.md) | 获取托管对象裸指针。 |
 | [CreateManagedComponentWrapper](CreateManagedComponentWrapper.md) | 为原生组件创建托管包装对象。 |
-| [DestroyManagedObject](DestroyManagedObject.md) | 根据托管包装对象销毁对应的原生 `GameObject` 或组件。 |
+| [DestroyManagedObject](DestroyManagedObject.md) | 销毁托管对象映射到的原生对象或组件。 |
 | [TryGetFieldValue](TryGetFieldValue.md) | 直接读取托管实例字段。 |
-| [OnRuntimeStart](OnRuntimeStart.md) | 启动脚本运行时上下文。 |
-| [OnRuntimeStop](OnRuntimeStop.md) | 停止当前运行场景的托管上下文。 |
-| [TrySetManagedFieldValue](TrySetManagedFieldValue.md) | 写托管字段。 |
-| [TryGetManagedFieldValue](TryGetManagedFieldValue.md) | 读托管字段。 |
-| [SyncManagedFieldsToStorage](SyncManagedFieldsToStorage.md) | 回写本地字段缓存。 |
+| [OnRuntimeStart](OnRuntimeStart.md) | 启动当前场景的托管上下文。 |
+| [OnRuntimeStop](OnRuntimeStop.md) | 停止当前场景的托管上下文。 |
+| [TrySetManagedFieldValue](TrySetManagedFieldValue.md) | 向托管实例写字段。 |
+| [TryGetManagedFieldValue](TryGetManagedFieldValue.md) | 从托管实例读字段。 |
+| [SyncManagedFieldsToStorage](SyncManagedFieldsToStorage.md) | 把托管字段同步回存储。 |
 | [CreateScriptInstance](CreateScriptInstance.md) | 创建脚本实例。 |
 | [DestroyScriptInstance](DestroyScriptInstance.md) | 销毁脚本实例。 |
 | [InvokeMethod](InvokeMethod.md) | 调用生命周期方法。 |
@@ -163,10 +212,11 @@
 ## 真实行为依据
 
 - `engine/src/Scripting/Mono/MonoScriptRuntime.cpp`
-- `managed/XCEngine.ScriptCore/Input.cs`
-- `managed/XCEngine.ScriptCore/Time.cs`
-- `tests/scripting/test_mono_script_runtime.cpp`
-- `tests/scripting/test_project_script_assembly.cpp`
+- `managed/XCEngine.ScriptCore/SerializeField.cs`
+- `managed/GameScripts/FieldMetadataProbe.cs`
+- `managed/GameScripts/SerializeFieldProbe.cs`
+- `tests/Scripting/test_mono_script_runtime.cpp`
+- `tests/Scripting/test_project_script_assembly.cpp`
 
 ## 相关文档