From 359fe2adb3e6fb8801da0d415def82e342aa85e8 Mon Sep 17 00:00:00 2001 From: ssdfasd <2156608475@qq.com> Date: Sat, 28 Mar 2026 15:10:54 +0800 Subject: [PATCH] docs(scripting): add baseline api reference and guide --- docs/api/XCEngine/Scene/Scene.md | 45 +++--- .../Scene/SceneRuntime/FixedUpdate.md | 33 +++++ .../XCEngine/Scene/SceneRuntime/LateUpdate.md | 33 +++++ .../Scene/SceneRuntime/SceneRuntime.md | 63 +++++++++ docs/api/XCEngine/Scene/SceneRuntime/Start.md | 42 ++++++ docs/api/XCEngine/Scene/SceneRuntime/Stop.md | 34 +++++ .../api/XCEngine/Scene/SceneRuntime/Update.md | 33 +++++ .../IScriptRuntime/CreateScriptInstance.md | 28 ++++ .../IScriptRuntime/DestroyScriptInstance.md | 23 +++ .../IScriptRuntime/IScriptRuntime.md | 71 ++++++++++ .../Scripting/IScriptRuntime/InvokeMethod.md | 33 +++++ .../IScriptRuntime/OnRuntimeStart.md | 31 ++++ .../Scripting/IScriptRuntime/OnRuntimeStop.md | 27 ++++ .../SyncManagedFieldsToStorage.md | 31 ++++ .../TryGetClassFieldMetadata.md | 35 +++++ .../IScriptRuntime/TryGetManagedFieldValue.md | 29 ++++ .../IScriptRuntime/TrySetManagedFieldValue.md | 30 ++++ docs/api/XCEngine/Scripting/Mono/Mono.md | 45 ++++++ .../Mono/MonoScriptRuntime/Constructor.md | 22 +++ .../CreateManagedComponentWrapper.md | 31 ++++ .../MonoScriptRuntime/CreateScriptInstance.md | 34 +++++ .../DestroyScriptInstance.md | 24 ++++ .../Mono/MonoScriptRuntime/Destructor.md | 21 +++ .../Mono/MonoScriptRuntime/GetLastError.md | 22 +++ .../GetManagedInstanceCount.md | 21 +++ .../GetManagedInstanceObject.md | 26 ++++ .../MonoScriptRuntime/GetScriptClassNames.md | 25 ++++ .../MonoScriptRuntime/HasManagedInstance.md | 21 +++ .../Mono/MonoScriptRuntime/Initialize.md | 34 +++++ .../Mono/MonoScriptRuntime/InvokeMethod.md | 34 +++++ .../MonoScriptRuntime/IsClassAvailable.md | 24 ++++ .../MonoScriptRuntime/MonoScriptRuntime.md | 86 ++++++++++++ .../Mono/MonoScriptRuntime/OnRuntimeStart.md | 27 ++++ .../Mono/MonoScriptRuntime/OnRuntimeStop.md | 28 ++++ .../Mono/MonoScriptRuntime/Shutdown.md | 30 ++++ .../SyncManagedFieldsToStorage.md | 32 +++++ .../TryGetClassFieldMetadata.md | 36 +++++ .../MonoScriptRuntime/TryGetFieldValue.md | 30 ++++ .../TryGetManagedFieldValue.md | 28 ++++ .../TrySetManagedFieldValue.md | 27 ++++ .../NullScriptRuntime/CreateScriptInstance.md | 28 ++++ .../DestroyScriptInstance.md | 21 +++ .../NullScriptRuntime/InvokeMethod.md | 25 ++++ .../NullScriptRuntime/NullScriptRuntime.md | 57 ++++++++ .../NullScriptRuntime/OnRuntimeStart.md | 21 +++ .../NullScriptRuntime/OnRuntimeStop.md | 21 +++ .../SyncManagedFieldsToStorage.md | 23 +++ .../TryGetClassFieldMetadata.md | 32 +++++ .../TryGetManagedFieldValue.md | 27 ++++ .../TrySetManagedFieldValue.md | 30 ++++ .../Scripting/ScriptComponent/Constructor.md | 27 ++++ .../Scripting/ScriptComponent/Deserialize.md | 35 +++++ .../ScriptComponent/GetFieldStorage.md | 28 ++++ .../ScriptComponent/GetFullClassName.md | 31 ++++ .../ScriptComponent/HasScriptClass.md | 31 ++++ .../Scripting/ScriptComponent/OnDestroy.md | 21 +++ .../Scripting/ScriptComponent/OnDisable.md | 22 +++ .../Scripting/ScriptComponent/OnEnable.md | 26 ++++ .../ScriptComponent/ScriptComponent.md | 72 ++++++++++ .../Scripting/ScriptComponent/Serialize.md | 39 ++++++ .../ScriptComponent/SetScriptClass.md | 39 ++++++ .../XCEngine/Scripting/ScriptEngine/Get.md | 25 ++++ .../ScriptEngine/GetTrackedScriptCount.md | 21 +++ .../ScriptEngine/HasRuntimeInstance.md | 25 ++++ .../ScriptEngine/HasTrackedScriptComponent.md | 21 +++ .../Scripting/ScriptEngine/OnFixedUpdate.md | 31 ++++ .../Scripting/ScriptEngine/OnLateUpdate.md | 21 +++ .../Scripting/ScriptEngine/OnRuntimeStart.md | 35 +++++ .../Scripting/ScriptEngine/OnRuntimeStop.md | 36 +++++ .../OnScriptComponentDestroyed.md | 23 +++ .../ScriptEngine/OnScriptComponentDisabled.md | 24 ++++ .../ScriptEngine/OnScriptComponentEnabled.md | 24 ++++ .../Scripting/ScriptEngine/OnUpdate.md | 29 ++++ .../Scripting/ScriptEngine/ScriptEngine.md | 100 +++++++++++++ .../Scripting/ScriptEngine/SetRuntime.md | 28 ++++ .../ScriptEngine/TryGetScriptFieldModel.md | 61 ++++++++ .../TryGetScriptFieldSnapshots.md | 25 ++++ .../ScriptEngine/TryGetScriptFieldValue.md | 31 ++++ .../ScriptEngine/TrySetScriptFieldValue.md | 40 ++++++ .../CreateDefaultScriptFieldValue.md | 27 ++++ .../ScriptField/EscapeScriptString.md | 25 ++++ .../IsScriptFieldValueCompatible.md | 27 ++++ .../Scripting/ScriptField/ScriptField.md | 75 ++++++++++ .../ScriptField/ScriptFieldTypeToString.md | 21 +++ .../ScriptField/SerializeScriptFieldValue.md | 28 ++++ .../TryDeserializeScriptFieldValue.md | 28 ++++ .../ScriptField/TryParseScriptFieldType.md | 23 +++ .../ScriptField/UnescapeScriptString.md | 21 +++ .../Scripting/ScriptFieldStorage/Clear.md | 21 +++ .../Scripting/ScriptFieldStorage/Contains.md | 21 +++ .../ScriptFieldStorage/Deserialize.md | 21 +++ .../DeserializeFromString.md | 29 ++++ .../Scripting/ScriptFieldStorage/FindField.md | 22 +++ .../ScriptFieldStorage/GetFieldCount.md | 21 +++ .../ScriptFieldStorage/GetFieldNames.md | 26 ++++ .../Scripting/ScriptFieldStorage/Remove.md | 22 +++ .../ScriptFieldStorage/ScriptFieldStorage.md | 48 +++++++ .../Scripting/ScriptFieldStorage/Serialize.md | 21 +++ .../ScriptFieldStorage/SerializeToString.md | 27 ++++ .../ScriptFieldStorage/SetFieldValue.md | 29 ++++ .../ScriptFieldStorage/TryGetFieldValue.md | 26 ++++ docs/api/XCEngine/Scripting/Scripting.md | 60 ++++++++ docs/api/XCEngine/XCEngine.md | 18 ++- .../Scripting-Runtime-And-Field-Model.md | 132 ++++++++++++++++++ 104 files changed, 3377 insertions(+), 27 deletions(-) create mode 100644 docs/api/XCEngine/Scene/SceneRuntime/FixedUpdate.md create mode 100644 docs/api/XCEngine/Scene/SceneRuntime/LateUpdate.md create mode 100644 docs/api/XCEngine/Scene/SceneRuntime/SceneRuntime.md create mode 100644 docs/api/XCEngine/Scene/SceneRuntime/Start.md create mode 100644 docs/api/XCEngine/Scene/SceneRuntime/Stop.md create mode 100644 docs/api/XCEngine/Scene/SceneRuntime/Update.md create mode 100644 docs/api/XCEngine/Scripting/IScriptRuntime/CreateScriptInstance.md create mode 100644 docs/api/XCEngine/Scripting/IScriptRuntime/DestroyScriptInstance.md create mode 100644 docs/api/XCEngine/Scripting/IScriptRuntime/IScriptRuntime.md create mode 100644 docs/api/XCEngine/Scripting/IScriptRuntime/InvokeMethod.md create mode 100644 docs/api/XCEngine/Scripting/IScriptRuntime/OnRuntimeStart.md create mode 100644 docs/api/XCEngine/Scripting/IScriptRuntime/OnRuntimeStop.md create mode 100644 docs/api/XCEngine/Scripting/IScriptRuntime/SyncManagedFieldsToStorage.md create mode 100644 docs/api/XCEngine/Scripting/IScriptRuntime/TryGetClassFieldMetadata.md create mode 100644 docs/api/XCEngine/Scripting/IScriptRuntime/TryGetManagedFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/IScriptRuntime/TrySetManagedFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/Mono/Mono.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Constructor.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/CreateManagedComponentWrapper.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/CreateScriptInstance.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/DestroyScriptInstance.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Destructor.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetLastError.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetManagedInstanceCount.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetManagedInstanceObject.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetScriptClassNames.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/HasManagedInstance.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Initialize.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/InvokeMethod.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/IsClassAvailable.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/MonoScriptRuntime.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/OnRuntimeStart.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/OnRuntimeStop.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Shutdown.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/SyncManagedFieldsToStorage.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetClassFieldMetadata.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetManagedFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TrySetManagedFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/NullScriptRuntime/CreateScriptInstance.md create mode 100644 docs/api/XCEngine/Scripting/NullScriptRuntime/DestroyScriptInstance.md create mode 100644 docs/api/XCEngine/Scripting/NullScriptRuntime/InvokeMethod.md create mode 100644 docs/api/XCEngine/Scripting/NullScriptRuntime/NullScriptRuntime.md create mode 100644 docs/api/XCEngine/Scripting/NullScriptRuntime/OnRuntimeStart.md create mode 100644 docs/api/XCEngine/Scripting/NullScriptRuntime/OnRuntimeStop.md create mode 100644 docs/api/XCEngine/Scripting/NullScriptRuntime/SyncManagedFieldsToStorage.md create mode 100644 docs/api/XCEngine/Scripting/NullScriptRuntime/TryGetClassFieldMetadata.md create mode 100644 docs/api/XCEngine/Scripting/NullScriptRuntime/TryGetManagedFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/NullScriptRuntime/TrySetManagedFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/Constructor.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/Deserialize.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/GetFieldStorage.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/GetFullClassName.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/HasScriptClass.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/OnDestroy.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/OnDisable.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/OnEnable.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/ScriptComponent.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/Serialize.md create mode 100644 docs/api/XCEngine/Scripting/ScriptComponent/SetScriptClass.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/Get.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/GetTrackedScriptCount.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/HasRuntimeInstance.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/HasTrackedScriptComponent.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/OnFixedUpdate.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/OnLateUpdate.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/OnRuntimeStart.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/OnRuntimeStop.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentDestroyed.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentDisabled.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentEnabled.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/OnUpdate.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/ScriptEngine.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/SetRuntime.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldModel.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldSnapshots.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/ScriptEngine/TrySetScriptFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/ScriptField/CreateDefaultScriptFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/ScriptField/EscapeScriptString.md create mode 100644 docs/api/XCEngine/Scripting/ScriptField/IsScriptFieldValueCompatible.md create mode 100644 docs/api/XCEngine/Scripting/ScriptField/ScriptField.md create mode 100644 docs/api/XCEngine/Scripting/ScriptField/ScriptFieldTypeToString.md create mode 100644 docs/api/XCEngine/Scripting/ScriptField/SerializeScriptFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/ScriptField/TryDeserializeScriptFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/ScriptField/TryParseScriptFieldType.md create mode 100644 docs/api/XCEngine/Scripting/ScriptField/UnescapeScriptString.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/Clear.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/Contains.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/Deserialize.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/DeserializeFromString.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/FindField.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/GetFieldCount.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/GetFieldNames.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/Remove.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/ScriptFieldStorage.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/Serialize.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/SerializeToString.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/SetFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/ScriptFieldStorage/TryGetFieldValue.md create mode 100644 docs/api/XCEngine/Scripting/Scripting.md create mode 100644 docs/api/_guides/Scripting/Scripting-Runtime-And-Field-Model.md diff --git a/docs/api/XCEngine/Scene/Scene.md b/docs/api/XCEngine/Scene/Scene.md index b0a6b752..d5e99296 100644 --- a/docs/api/XCEngine/Scene/Scene.md +++ b/docs/api/XCEngine/Scene/Scene.md @@ -4,47 +4,46 @@ **类型**: `module` -**描述**: 提供场景容器 `Scene` 与多场景入口 `SceneManager`，负责组织 `GameObject` 层级、场景级更新与自定义文本序列化。 +**描述**: 提供场景容器、多场景管理入口以及场景运行时调度器。 -## 概述 +## 概览 -`XCEngine/Scene` 这组头文件位于 `Scene` 目录下，但公开类型实际放在 `XCEngine::Components` 命名空间中。这反映了当前引擎的建模方式： +当前 `XCEngine/Scene` 目录里的 public API 主要分成三层： -- `Scene` 负责持有一组 `GameObject`。 -- `GameObject` 负责父子层级、`TransformComponent` 和其它组件。 -- `SceneManager` 负责持有多个已加载场景，并暴露“当前活动场景”入口。 +- [Scene](Scene/Scene.md) 负责对象树、场景级更新和场景序列化。 +- [SceneManager](SceneManager/SceneManager.md) 负责多场景注册与活动场景入口。 +- [SceneRuntime](SceneRuntime/SceneRuntime.md) 负责把某个场景真正“跑起来”，并和脚本系统衔接。 -这和商业引擎里常见的 Unity 风格思路接近：场景是对象集合与生命周期边界，真正可组合的行为仍然落在对象与组件层。 - -## 当前实现成熟度 - -这一组 API 已经能支撑基础场景树、更新和保存/加载，但需要对当前边界保持诚实： - -- `Scene::IsActive()` / `SetActive()` 当前只是存储一个标志位，不会阻止 `Update()`、`FixedUpdate()` 或 `LateUpdate()` 运行。 -- `FindGameObjectWithTag()` 当前并没有真正的 tag 系统支持，实际按对象名称匹配。 -- `Scene::~Scene()` 不会逐个调用 `DestroyGameObject()`，因此不会触发场景销毁事件，也不会为组件调用 `OnDestroy()`。 -- `SceneManager::LoadSceneAsync()` 当前不是异步加载，只是同步包装。 -- `SceneManager` 的活动场景指针，与 `Scene` 自身的 active 标志当前是两套彼此独立的状态。 +这种分层和商业引擎里常见的思路接近：`Scene` 是数据与对象容器，`SceneManager` 负责更高层的场景切换，而 `SceneRuntime` 则承担运行时执行语义。 ## 设计要点 -- `Scene` 采用“所有权集中、访问返回裸指针”的模式：内部由 `std::unique_ptr` 持有对象，API 对外返回非拥有指针。 -- 根对象列表与父子层级分开维护，这让“遍历根对象”和“对象挂接到父节点”可以各自保持简单。 -- 序列化走的是引擎私有文本格式，而不是通用 JSON。这样实现成本低、易于直接落地组件自定义序列化，但兼容性和健壮性也相对有限。 +- `Scene` 专注对象拥有权、查询和序列化，不直接变成庞大的运行时调度中心。 +- `SceneRuntime` 把脚本生命周期和场景更新顺序集中管理，避免脚本系统散落到 `Scene` 内部。 +- `SceneManager` 让多场景入口和单个场景数据模型解耦，便于以后扩展更复杂的场景切换策略。 + +## 当前实现边界 + +- 当前公开类型都位于 `XCEngine::Components` 命名空间，而不是单独的 `XCEngine::Scene` 命名空间，这反映了引擎当前建模历史。 +- `SceneRuntime` 目前只管理单个运行中的场景。 +- `SceneManager::LoadSceneAsync()` 仍是同步包装，不是完整异步加载系统。 +- 场景序列化使用引擎私有文本格式，强调可落地而不是通用交换格式。 ## 头文件 -- [Scene](Scene/Scene.md) - `Scene.h`，单个场景容器、更新入口和序列化接口。 -- [SceneManager](SceneManager/SceneManager.md) - `SceneManager.h`，多场景注册表与活动场景入口。 +- [Scene](Scene/Scene.md) - `Scene.h` +- [SceneManager](SceneManager/SceneManager.md) - `SceneManager.h` +- [SceneRuntime](SceneRuntime/SceneRuntime.md) - `SceneRuntime.h` ## 相关指南 -- [Scene Lifecycle And Serialization](../../_guides/Scene/Scene-Lifecycle-And-Serialization.md) - 解释场景树为什么这样设计、活动状态分层意味着什么，以及当前序列化链路的实际限制。 +- [Scene Lifecycle And Serialization](../../_guides/Scene/Scene-Lifecycle-And-Serialization.md) - 解释场景容器、运行时调度和序列化之间的关系，以及当前实现的真实限制。 ## 相关文档 - [GameObject](../Components/GameObject/GameObject.md) - [Component](../Components/Component/Component.md) - [TransformComponent](../Components/TransformComponent/TransformComponent.md) +- [Scripting](../Scripting/Scripting.md) - [上级目录](../XCEngine.md) - [API 总索引](../../main.md) diff --git a/docs/api/XCEngine/Scene/SceneRuntime/FixedUpdate.md b/docs/api/XCEngine/Scene/SceneRuntime/FixedUpdate.md new file mode 100644 index 00000000..5d3755b4 --- /dev/null +++ b/docs/api/XCEngine/Scene/SceneRuntime/FixedUpdate.md @@ -0,0 +1,33 @@ +# SceneRuntime::FixedUpdate + +**命名空间**: `XCEngine::Components` + +**类型**: `method` + +**头文件**: `XCEngine/Scene/SceneRuntime.h` + +## 签名 + +```cpp +void FixedUpdate(float fixedDeltaTime); +``` + +## 作用 + +驱动固定步长更新阶段。 + +## 当前实现行为 + +- 只有在 `m_running == true`、`m_scene != nullptr` 且 `m_scene->IsActive()` 时才继续执行。 +- 执行顺序固定为： + 1. `ScriptEngine::Get().OnFixedUpdate(fixedDeltaTime)` + 2. `m_scene->FixedUpdate(fixedDeltaTime)` + +## 设计重点 + +脚本先于原生组件运行，这样脚本在固定步长阶段做出的状态修改能被同一帧的原生组件观察到。测试 `tests/Scene/test_scene_runtime.cpp` 已验证这个顺序。 + +## 相关文档 + +- [SceneRuntime](SceneRuntime.md) +- [SceneRuntime::Update](Update.md) diff --git a/docs/api/XCEngine/Scene/SceneRuntime/LateUpdate.md b/docs/api/XCEngine/Scene/SceneRuntime/LateUpdate.md new file mode 100644 index 00000000..c36a416e --- /dev/null +++ b/docs/api/XCEngine/Scene/SceneRuntime/LateUpdate.md @@ -0,0 +1,33 @@ +# SceneRuntime::LateUpdate + +**命名空间**: `XCEngine::Components` + +**类型**: `method` + +**头文件**: `XCEngine/Scene/SceneRuntime.h` + +## 签名 + +```cpp +void LateUpdate(float deltaTime); +``` + +## 作用 + +驱动后更新阶段。 + +## 当前实现行为 + +- 与 `FixedUpdate` / `Update` 一样，只有在运行中且场景活动时才执行。 +- 当前顺序为： + 1. `ScriptEngine::Get().OnLateUpdate(deltaTime)` + 2. `m_scene->LateUpdate(deltaTime)` + +## 设计含义 + +这维持了当前运行时一贯的脚本优先策略。对商业引擎文档来说，这一点必须明确，因为很多用户会默认认为 `LateUpdate` 主要用于相机跟随、动画后修正和最终姿态收敛，而顺序差异会直接影响结果。 + +## 相关文档 + +- [SceneRuntime](SceneRuntime.md) +- [SceneRuntime::Update](Update.md) diff --git a/docs/api/XCEngine/Scene/SceneRuntime/SceneRuntime.md b/docs/api/XCEngine/Scene/SceneRuntime/SceneRuntime.md new file mode 100644 index 00000000..0ddf0444 --- /dev/null +++ b/docs/api/XCEngine/Scene/SceneRuntime/SceneRuntime.md @@ -0,0 +1,63 @@ +# SceneRuntime + +**命名空间**: `XCEngine::Components` + +**类型**: `class` + +**头文件**: `XCEngine/Scene/SceneRuntime.h` + +**描述**: 把 `Scene` 的逐帧更新与 `ScriptEngine` 的运行时生命周期绑在一起的轻量执行器。 + +## 概览 + +`SceneRuntime` 不是场景数据本身，而是“让一个 `Scene` 真正跑起来”的那层对象。当前职责主要有两件： + +- 管理“当前正在运行哪一个场景”。 +- 在每个帧阶段先驱动脚本，再驱动原生组件更新。 + +这种拆分和 Unity 里“Scene 是数据容器，PlayerLoop/Runtime 才是执行者”的思路接近。好处是场景对象本身可以继续承担加载、保存和对象组织职责，而运行态切换、脚本启动和帧阶段调度则集中在一个小类里。 + +## 生命周期 + +- [Start](Start.md) 会先停止旧运行时，再接管新场景。 +- [Stop](Stop.md) 会通知 `ScriptEngine` 结束运行，并清空当前场景。 +- 运行中 `GetScene()` 返回当前绑定场景，`IsRunning()` 表示是否处于运行状态。 + +## 线程语义 + +- 当前实现没有内部同步。 +- `Start()`、`Stop()` 和三类帧更新函数都应视为主线程 API。 + +## 当前实现边界 + +- 只有场景本身 `IsActive()` 为真时，帧更新才会继续执行。 +- 每个阶段都先调 `ScriptEngine`，再调 `Scene` 本体，因此脚本改动会在同一帧被后续原生组件看见。 +- `SceneRuntime` 当前只管理单个活动场景，不负责多场景叠加或异步切换。 + +## 公开方法 + +| 方法 | 说明 | +|------|------| +| [Start](Start.md) | 开始运行一个场景。 | +| [Stop](Stop.md) | 停止当前场景运行。 | +| [FixedUpdate](FixedUpdate.md) | 驱动物理步长阶段。 | +| [Update](Update.md) | 驱动常规逐帧更新阶段。 | +| [LateUpdate](LateUpdate.md) | 驱动后更新阶段。 | + +## 真实行为依据 + +- `engine/src/Scene/SceneRuntime.cpp` +- `tests/Scene/test_scene_runtime.cpp` + +这些测试明确验证了： + +- 启停会转发到 `ScriptEngine`。 +- 脚本生命周期调用先于原生组件。 +- 非活动场景会跳过帧执行。 +- 切到新场景前会先停掉旧场景。 + +## 相关文档 + +- [Scene](../Scene/Scene.md) +- [ScriptEngine](../../Scripting/ScriptEngine/ScriptEngine.md) +- [Scene Lifecycle And Serialization](../../../_guides/Scene/Scene-Lifecycle-And-Serialization.md) diff --git a/docs/api/XCEngine/Scene/SceneRuntime/Start.md b/docs/api/XCEngine/Scene/SceneRuntime/Start.md new file mode 100644 index 00000000..2730c9c1 --- /dev/null +++ b/docs/api/XCEngine/Scene/SceneRuntime/Start.md @@ -0,0 +1,42 @@ +# SceneRuntime::Start + +**命名空间**: `XCEngine::Components` + +**类型**: `method` + +**头文件**: `XCEngine/Scene/SceneRuntime.h` + +## 签名 + +```cpp +void Start(Scene* scene); +``` + +## 作用 + +让一个场景进入运行状态，并启动其脚本运行时。 + +## 当前实现流程 + +按 `engine/src/Scene/SceneRuntime.cpp`： + +1. 如果当前已经在运行同一个 `scene`，直接返回。 +2. 先调用 [Stop](Stop.md) 清掉旧运行时。 +3. 如果传入空场景，返回。 +4. 写入 `m_scene`，把 `m_running` 设为 `true`。 +5. 调用 `ScriptEngine::Get().OnRuntimeStart(scene)`。 + +## 参数 + +| 参数 | 说明 | +|------|------| +| `scene` | 要开始运行的场景；可为空，空时表示“停掉当前运行时但不启动新场景”。 | + +## 设计含义 + +这种“先停再启”的切换方式很直接，也和很多商业引擎的 play mode 切场景行为一致。优点是生命周期边界清晰；代价是当前没有做平滑切换或状态迁移。 + +## 相关文档 + +- [SceneRuntime](SceneRuntime.md) +- [SceneRuntime::Stop](Stop.md) diff --git a/docs/api/XCEngine/Scene/SceneRuntime/Stop.md b/docs/api/XCEngine/Scene/SceneRuntime/Stop.md new file mode 100644 index 00000000..9fb53e17 --- /dev/null +++ b/docs/api/XCEngine/Scene/SceneRuntime/Stop.md @@ -0,0 +1,34 @@ +# SceneRuntime::Stop + +**命名空间**: `XCEngine::Components` + +**类型**: `method` + +**头文件**: `XCEngine/Scene/SceneRuntime.h` + +## 签名 + +```cpp +void Stop(); +``` + +## 作用 + +停止当前场景运行并结束脚本运行时。 + +## 当前实现行为 + +- 如果当前并不处于运行状态，只会把 `m_scene` 清成 `nullptr`。 +- 如果当前正在运行： + - 先调用 `ScriptEngine::Get().OnRuntimeStop()`。 + - 再把 `m_running` 置为 `false`。 + - 最后把 `m_scene` 清空。 + +## 副作用 + +`ScriptEngine` 当前会在 `OnRuntimeStop()` 中触发脚本的 `OnDisable`、`OnDestroy`、实例销毁和运行时停止回调，因此这个接口不只是“停更”，而是真正结束脚本运行态。 + +## 相关文档 + +- [SceneRuntime](SceneRuntime.md) +- [ScriptEngine::OnRuntimeStop](../../Scripting/ScriptEngine/OnRuntimeStop.md) diff --git a/docs/api/XCEngine/Scene/SceneRuntime/Update.md b/docs/api/XCEngine/Scene/SceneRuntime/Update.md new file mode 100644 index 00000000..0af6e128 --- /dev/null +++ b/docs/api/XCEngine/Scene/SceneRuntime/Update.md @@ -0,0 +1,33 @@ +# SceneRuntime::Update + +**命名空间**: `XCEngine::Components` + +**类型**: `method` + +**头文件**: `XCEngine/Scene/SceneRuntime.h` + +## 签名 + +```cpp +void Update(float deltaTime); +``` + +## 作用 + +驱动常规逐帧更新阶段。 + +## 当前实现行为 + +- 运行条件与 [FixedUpdate](FixedUpdate.md) 相同：必须正在运行，场景存在且活动。 +- 当前顺序为： + 1. `ScriptEngine::Get().OnUpdate(deltaTime)` + 2. `m_scene->Update(deltaTime)` + +## 额外说明 + +`ScriptEngine::OnUpdate()` 当前还负责在第一次正常帧更新前补发脚本 `Start`，因此 `SceneRuntime::Update()` 实际上承担了“脚本 Start 落地阶段”的入口职责。 + +## 相关文档 + +- [SceneRuntime](SceneRuntime.md) +- [ScriptEngine::OnUpdate](../../Scripting/ScriptEngine/OnUpdate.md) diff --git a/docs/api/XCEngine/Scripting/IScriptRuntime/CreateScriptInstance.md b/docs/api/XCEngine/Scripting/IScriptRuntime/CreateScriptInstance.md new file mode 100644 index 00000000..21783e6f --- /dev/null +++ b/docs/api/XCEngine/Scripting/IScriptRuntime/CreateScriptInstance.md @@ -0,0 +1,28 @@ +# IScriptRuntime::CreateScriptInstance + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/IScriptRuntime.h` + +## 签名 + +```cpp +virtual bool CreateScriptInstance( + const ScriptRuntimeContext& context) = 0; +``` + +## 作用 + +为某个 `ScriptComponent` 创建对应的脚本实例。 + +## 契约要求 + +- 成功返回 `true`，失败返回 `false`。 +- 实现应使用 `context` 里的 UUID 和组件信息完成绑定。 + +## 相关文档 + +- [DestroyScriptInstance](DestroyScriptInstance.md) +- [ScriptEngine::OnRuntimeStart](../ScriptEngine/OnRuntimeStart.md) diff --git a/docs/api/XCEngine/Scripting/IScriptRuntime/DestroyScriptInstance.md b/docs/api/XCEngine/Scripting/IScriptRuntime/DestroyScriptInstance.md new file mode 100644 index 00000000..e1ff2a13 --- /dev/null +++ b/docs/api/XCEngine/Scripting/IScriptRuntime/DestroyScriptInstance.md @@ -0,0 +1,23 @@ +# IScriptRuntime::DestroyScriptInstance + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/IScriptRuntime.h` + +## 签名 + +```cpp +virtual void DestroyScriptInstance( + const ScriptRuntimeContext& context) = 0; +``` + +## 作用 + +销毁某个脚本实例，并释放运行时后端对它的跟踪状态。 + +## 相关文档 + +- [CreateScriptInstance](CreateScriptInstance.md) +- [ScriptEngine::OnRuntimeStop](../ScriptEngine/OnRuntimeStop.md) diff --git a/docs/api/XCEngine/Scripting/IScriptRuntime/IScriptRuntime.md b/docs/api/XCEngine/Scripting/IScriptRuntime/IScriptRuntime.md new file mode 100644 index 00000000..cd65da6c --- /dev/null +++ b/docs/api/XCEngine/Scripting/IScriptRuntime/IScriptRuntime.md @@ -0,0 +1,71 @@ +# IScriptRuntime + +**命名空间**: `XCEngine::Scripting` + +**类型**: `class (abstract)` + +**头文件**: `XCEngine/Scripting/IScriptRuntime.h` + +**描述**: 定义引擎脚本调度层与具体脚本后端之间的统一契约。 + +## 概览 + +`IScriptRuntime` 是 `ScriptEngine` 唯一应该依赖的脚本后端接口。它把脚本后端抽象成三类能力： + +- 运行时启停。 +- 托管类/字段元数据查询与字段读写。 +- 脚本实例创建销毁与生命周期方法调用。 + +这种设计让 `ScriptEngine` 能专注于“调度”，而把 Mono、GCHandle、程序集加载这些实现细节留给具体后端。 + +## 公开概念 + +### ScriptLifecycleMethod + +当前生命周期枚举值为： + +- `Awake` +- `OnEnable` +- `Start` +- `FixedUpdate` +- `Update` +- `LateUpdate` +- `OnDisable` +- `OnDestroy` + +### ScriptRuntimeContext + +`ScriptRuntimeContext` 是后端执行脚本实例时的最小上下文： + +| 字段 | 说明 | +|------|------| +| `scene` | 当前运行场景。 | +| `gameObject` | 当前脚本所属对象。 | +| `component` | 当前脚本组件。 | +| `gameObjectUUID` | 原生对象 UUID。 | +| `scriptComponentUUID` | 脚本组件 UUID。 | + +## 线程语义 + +- 接口本身不承诺线程安全。 +- 当前引擎默认由主线程按固定时序调用这些方法。 + +## 公开方法 + +| 方法 | 说明 | +|------|------| +| [OnRuntimeStart](OnRuntimeStart.md) | 运行时开始时的后端入口。 | +| [OnRuntimeStop](OnRuntimeStop.md) | 运行时停止时的后端入口。 | +| [TryGetClassFieldMetadata](TryGetClassFieldMetadata.md) | 查询脚本类字段元数据。 | +| [TrySetManagedFieldValue](TrySetManagedFieldValue.md) | 向托管实例写字段。 | +| [TryGetManagedFieldValue](TryGetManagedFieldValue.md) | 从托管实例读字段。 | +| [SyncManagedFieldsToStorage](SyncManagedFieldsToStorage.md) | 把托管字段同步回本地存储。 | +| [CreateScriptInstance](CreateScriptInstance.md) | 创建脚本实例。 | +| [DestroyScriptInstance](DestroyScriptInstance.md) | 销毁脚本实例。 | +| [InvokeMethod](InvokeMethod.md) | 调用生命周期方法。 | + +## 相关文档 + +- [ScriptEngine](../ScriptEngine/ScriptEngine.md) +- [NullScriptRuntime](../NullScriptRuntime/NullScriptRuntime.md) +- [MonoScriptRuntime](../Mono/MonoScriptRuntime/MonoScriptRuntime.md) diff --git a/docs/api/XCEngine/Scripting/IScriptRuntime/InvokeMethod.md b/docs/api/XCEngine/Scripting/IScriptRuntime/InvokeMethod.md new file mode 100644 index 00000000..2eac177b --- /dev/null +++ b/docs/api/XCEngine/Scripting/IScriptRuntime/InvokeMethod.md @@ -0,0 +1,33 @@ +# IScriptRuntime::InvokeMethod + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/IScriptRuntime.h` + +## 签名 + +```cpp +virtual void InvokeMethod( + const ScriptRuntimeContext& context, + ScriptLifecycleMethod method, + float deltaTime) = 0; +``` + +## 作用 + +调用脚本实例上的某个生命周期方法。 + +## 参数 + +| 参数 | 说明 | +|------|------| +| `context` | 当前脚本实例上下文。 | +| `method` | 要调用的生命周期枚举。 | +| `deltaTime` | 帧相关时间参数；并非每个生命周期都会使用。 | + +## 相关文档 + +- [ScriptLifecycleMethod](IScriptRuntime.md) +- [ScriptEngine::OnUpdate](../ScriptEngine/OnUpdate.md) diff --git a/docs/api/XCEngine/Scripting/IScriptRuntime/OnRuntimeStart.md b/docs/api/XCEngine/Scripting/IScriptRuntime/OnRuntimeStart.md new file mode 100644 index 00000000..a7d44ec4 --- /dev/null +++ b/docs/api/XCEngine/Scripting/IScriptRuntime/OnRuntimeStart.md @@ -0,0 +1,31 @@ +# IScriptRuntime::OnRuntimeStart + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/IScriptRuntime.h` + +## 签名 + +```cpp +virtual void OnRuntimeStart(Components::Scene* scene) = 0; +``` + +## 作用 + +通知具体脚本后端：某个场景的脚本运行时已经开始。 + +## 调用方 + +当前由 [ScriptEngine::OnRuntimeStart](../ScriptEngine/OnRuntimeStart.md) 调用。 + +## 契约要求 + +- 后端可以在这里做场景绑定、运行时初始化或缓存清理。 +- 不应假定脚本实例已经全部创建；实例创建由后续 `CreateScriptInstance()` 驱动。 + +## 相关文档 + +- [IScriptRuntime](IScriptRuntime.md) +- [OnRuntimeStop](OnRuntimeStop.md) diff --git a/docs/api/XCEngine/Scripting/IScriptRuntime/OnRuntimeStop.md b/docs/api/XCEngine/Scripting/IScriptRuntime/OnRuntimeStop.md new file mode 100644 index 00000000..8dff331d --- /dev/null +++ b/docs/api/XCEngine/Scripting/IScriptRuntime/OnRuntimeStop.md @@ -0,0 +1,27 @@ +# IScriptRuntime::OnRuntimeStop + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/IScriptRuntime.h` + +## 签名 + +```cpp +virtual void OnRuntimeStop(Components::Scene* scene) = 0; +``` + +## 作用 + +通知脚本后端当前场景运行时正在结束。 + +## 契约要求 + +- 应释放与当前运行场景关联的运行态资源。 +- 不应再假定脚本实例继续可用。 + +## 相关文档 + +- [IScriptRuntime](IScriptRuntime.md) +- [OnRuntimeStart](OnRuntimeStart.md) diff --git a/docs/api/XCEngine/Scripting/IScriptRuntime/SyncManagedFieldsToStorage.md b/docs/api/XCEngine/Scripting/IScriptRuntime/SyncManagedFieldsToStorage.md new file mode 100644 index 00000000..e97a2586 --- /dev/null +++ b/docs/api/XCEngine/Scripting/IScriptRuntime/SyncManagedFieldsToStorage.md @@ -0,0 +1,31 @@ +# IScriptRuntime::SyncManagedFieldsToStorage + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/IScriptRuntime.h` + +## 签名 + +```cpp +virtual void SyncManagedFieldsToStorage( + const ScriptRuntimeContext& context) = 0; +``` + +## 作用 + +把托管实例中的字段变化同步回原生侧字段存储。 + +## 调用时机 + +当前 `ScriptEngine` 会在每次生命周期方法调用后执行这一步。 + +## 设计意义 + +这让场景序列化层可以观察到运行时字段回写结果，而不要求场景系统直接理解托管对象。 + +## 相关文档 + +- [ScriptFieldStorage](../ScriptFieldStorage/ScriptFieldStorage.md) +- [InvokeMethod](InvokeMethod.md) diff --git a/docs/api/XCEngine/Scripting/IScriptRuntime/TryGetClassFieldMetadata.md b/docs/api/XCEngine/Scripting/IScriptRuntime/TryGetClassFieldMetadata.md new file mode 100644 index 00000000..a8cfde91 --- /dev/null +++ b/docs/api/XCEngine/Scripting/IScriptRuntime/TryGetClassFieldMetadata.md @@ -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& outFields) const = 0; +``` + +## 作用 + +查询某个脚本类公开字段的元数据。 + +## 返回值语义 + +- 返回 `true`：后端确认这个类存在，并成功返回字段元数据。 +- 返回 `false`：类不存在、后端未初始化，或后端根本不支持这类查询。 + +## 设计意义 + +`ScriptEngine` 依赖它来做字段编辑校验、字段模型拼装和运行时/本地字段差异对比。 + +## 相关文档 + +- [ScriptField](../ScriptField/ScriptField.md) +- [ScriptEngine::TryGetScriptFieldModel](../ScriptEngine/TryGetScriptFieldModel.md) diff --git a/docs/api/XCEngine/Scripting/IScriptRuntime/TryGetManagedFieldValue.md b/docs/api/XCEngine/Scripting/IScriptRuntime/TryGetManagedFieldValue.md new file mode 100644 index 00000000..ad802e5b --- /dev/null +++ b/docs/api/XCEngine/Scripting/IScriptRuntime/TryGetManagedFieldValue.md @@ -0,0 +1,29 @@ +# IScriptRuntime::TryGetManagedFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/IScriptRuntime.h` + +## 签名 + +```cpp +virtual bool TryGetManagedFieldValue( + const ScriptRuntimeContext& context, + const std::string& fieldName, + ScriptFieldValue& outValue) const = 0; +``` + +## 作用 + +从托管实例读取一个字段值。 + +## 当前使用方式 + +`ScriptEngine` 会优先尝试从运行中的托管实例读取字段；只有失败时才回退到 `ScriptFieldStorage`。 + +## 相关文档 + +- [TrySetManagedFieldValue](TrySetManagedFieldValue.md) +- [ScriptEngine::TryGetScriptFieldValue](../ScriptEngine/TryGetScriptFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/IScriptRuntime/TrySetManagedFieldValue.md b/docs/api/XCEngine/Scripting/IScriptRuntime/TrySetManagedFieldValue.md new file mode 100644 index 00000000..35216ba8 --- /dev/null +++ b/docs/api/XCEngine/Scripting/IScriptRuntime/TrySetManagedFieldValue.md @@ -0,0 +1,30 @@ +# IScriptRuntime::TrySetManagedFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/IScriptRuntime.h` + +## 签名 + +```cpp +virtual bool TrySetManagedFieldValue( + const ScriptRuntimeContext& context, + const std::string& fieldName, + const ScriptFieldValue& value) = 0; +``` + +## 作用 + +向一个已经存在的托管脚本实例写入字段值。 + +## 契约要求 + +- 调用时实例未必一定存在，因此实现应自行检查。 +- 如果字段不存在、类型不匹配或实例不可用，应返回 `false`。 + +## 相关文档 + +- [TryGetManagedFieldValue](TryGetManagedFieldValue.md) +- [ScriptEngine::TrySetScriptFieldValue](../ScriptEngine/TrySetScriptFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/Mono/Mono.md b/docs/api/XCEngine/Scripting/Mono/Mono.md new file mode 100644 index 00000000..ac27c3ba --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/Mono.md @@ -0,0 +1,45 @@ +# Mono + +**命名空间**: `XCEngine::Scripting` + +**类型**: `submodule` + +**描述**: 收纳基于 Mono 的托管脚本运行时实现。 + +## 概览 + +`docs/api/XCEngine/Scripting/Mono` 对应的是 `engine/include/XCEngine/Scripting/Mono` 子目录。它不是独立命名空间，而是脚本模块下按实现后端划分出的子目录。 + +当前这里的核心类型只有 [MonoScriptRuntime](MonoScriptRuntime/MonoScriptRuntime.md)。它负责： + +- 初始化 Mono root domain 和 app domain。 +- 加载脚本核心程序集与游戏程序集。 +- 发现可用脚本类和公共实例字段。 +- 把 `ScriptComponent`、`GameObject` 与托管对象实例绑定起来。 +- 在生命周期调用后把托管字段同步回本地存储。 + +## 为什么单独分目录 + +把 Mono 运行时放进独立子目录，而不是直接塞进 `Scripting` 根目录，有两个直接好处： + +- 可以清楚区分“脚本系统公共契约”和“具体后端实现”。 +- 以后如果接入别的脚本后端，这里天然就是平行扩展点。 + +## 当前实现边界 + +- 当前只实现了 Mono 后端，没有并列的 IL2CPP、Lua 或自研 VM 后端。 +- 目录里只有一个 public header，说明当前重点仍然是把单条托管脚本链路先跑顺。 +- 内部调用注册已覆盖 `GameObject`、`Transform`、`Camera`、`Light`、`MeshFilter`、`MeshRenderer` 和基础日志/时间桥接，但远不是完整编辑器级 API 面。 + +## 头文件 + +- [MonoScriptRuntime](MonoScriptRuntime/MonoScriptRuntime.md) - `MonoScriptRuntime.h` + +## 相关指南 + +- [Scripting Runtime And Field Model](../../../_guides/Scripting/Scripting-Runtime-And-Field-Model.md) + +## 相关文档 + +- [Scripting](../Scripting.md) +- [IScriptRuntime](../IScriptRuntime/IScriptRuntime.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Constructor.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Constructor.md new file mode 100644 index 00000000..c7feeb0e --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Constructor.md @@ -0,0 +1,22 @@ +# MonoScriptRuntime::Constructor + +**命名空间**: `XCEngine::Scripting` + +**类型**: `constructor` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +explicit MonoScriptRuntime(Settings settings = {}); +``` + +## 当前实现行为 + +- 保存传入的 `Settings`。 +- 立即调用内部 `ResolveSettings()`，补全程序集目录和默认路径。 + +## 相关文档 + +- [Initialize](Initialize.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/CreateManagedComponentWrapper.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/CreateManagedComponentWrapper.md new file mode 100644 index 00000000..fa6b32b4 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/CreateManagedComponentWrapper.md @@ -0,0 +1,31 @@ +# MonoScriptRuntime::CreateManagedComponentWrapper + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +MonoObject* CreateManagedComponentWrapper( + MonoClass* componentClass, + uint64_t gameObjectUUID); +``` + +## 当前实现行为 + +- 只有在运行时已初始化、`componentClass` 非空且 `gameObjectUUID` 非零时才继续。 +- 查找目标托管包装类型的单参构造函数。 +- 创建托管对象。 +- 以 `gameObjectUUID` 作为构造参数调用该对象构造函数。 +- 如果托管构造抛异常，会记录异常并返回 `nullptr`。 + +## 用途 + +当前主要服务于 internal call，例如从托管脚本中获取 `Transform`、`Camera`、`Light` 等原生组件包装对象。 + +## 相关文档 + +- [TryGetFieldValue](TryGetFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/CreateScriptInstance.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/CreateScriptInstance.md new file mode 100644 index 00000000..d99f5291 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/CreateScriptInstance.md @@ -0,0 +1,34 @@ +# MonoScriptRuntime::CreateScriptInstance + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +bool CreateScriptInstance( + const ScriptRuntimeContext& context) override; +``` + +## 当前实现流程 + +1. 若 `context.component` 为空，失败并记录错误。 +2. 若该实例已存在，直接返回 `true`。 +3. 若运行时尚未初始化，先调用 [Initialize](Initialize.md)。 +4. 根据组件的程序集名、命名空间和类名查找类元数据；程序集名为空时回退到 `Settings::appAssemblyName`。 +5. 在 app domain 中创建托管对象并执行默认构造。 +6. 写入上下文字段：`gameObjectUUID` 与 `scriptComponentUUID`。 +7. 把 `ScriptFieldStorage` 中能匹配上的字段写入托管对象。 +8. 创建 `gcHandle` 并写入实例缓存。 + +## 失败路径 + +类不存在、分配失败、上下文字段写入失败、存储字段应用失败时都会返回 `false` 并更新 `m_lastError`。 + +## 相关文档 + +- [DestroyScriptInstance](DestroyScriptInstance.md) +- [SyncManagedFieldsToStorage](SyncManagedFieldsToStorage.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/DestroyScriptInstance.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/DestroyScriptInstance.md new file mode 100644 index 00000000..a3974685 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/DestroyScriptInstance.md @@ -0,0 +1,24 @@ +# MonoScriptRuntime::DestroyScriptInstance + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +void DestroyScriptInstance( + const ScriptRuntimeContext& context) override; +``` + +## 当前实现行为 + +- 通过 `(gameObjectUUID, scriptComponentUUID)` 找到实例缓存。 +- 若有 `gcHandle`，先释放它。 +- 再从实例缓存表删除该项。 + +## 相关文档 + +- [CreateScriptInstance](CreateScriptInstance.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Destructor.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Destructor.md new file mode 100644 index 00000000..21084bbb --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Destructor.md @@ -0,0 +1,21 @@ +# MonoScriptRuntime::~MonoScriptRuntime + +**命名空间**: `XCEngine::Scripting` + +**类型**: `destructor` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +~MonoScriptRuntime() override; +``` + +## 当前实现行为 + +析构时直接调用 [Shutdown](Shutdown.md)。 + +## 相关文档 + +- [Shutdown](Shutdown.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetLastError.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetLastError.md new file mode 100644 index 00000000..eec7cb2a --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetLastError.md @@ -0,0 +1,22 @@ +# MonoScriptRuntime::GetLastError + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +const std::string& GetLastError() const; +``` + +## 当前语义 + +返回最近一次初始化、类发现、实例创建或托管调用失败时记录的错误信息。 + +## 相关文档 + +- [Initialize](Initialize.md) +- [CreateScriptInstance](CreateScriptInstance.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetManagedInstanceCount.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetManagedInstanceCount.md new file mode 100644 index 00000000..9a7cc184 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetManagedInstanceCount.md @@ -0,0 +1,21 @@ +# MonoScriptRuntime::GetManagedInstanceCount + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +size_t GetManagedInstanceCount() const; +``` + +## 当前实现行为 + +直接返回实例缓存表大小。 + +## 相关文档 + +- [HasManagedInstance](HasManagedInstance.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetManagedInstanceObject.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetManagedInstanceObject.md new file mode 100644 index 00000000..ad09ed96 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetManagedInstanceObject.md @@ -0,0 +1,26 @@ +# MonoScriptRuntime::GetManagedInstanceObject + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +MonoObject* GetManagedInstanceObject( + const ScriptComponent* component) const; +``` + +## 当前实现行为 + +通过实例缓存查找并用 `mono_gchandle_get_target()` 取回托管对象指针。 + +## 注意事项 + +这是诊断和桥接接口，不是高层推荐业务 API。 + +## 相关文档 + +- [HasManagedInstance](HasManagedInstance.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetScriptClassNames.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetScriptClassNames.md new file mode 100644 index 00000000..1d902c18 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/GetScriptClassNames.md @@ -0,0 +1,25 @@ +# MonoScriptRuntime::GetScriptClassNames + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +std::vector GetScriptClassNames( + const std::string& assemblyName = std::string()) const; +``` + +## 当前实现行为 + +- 遍历内部类缓存。 +- 若传了 `assemblyName`，只返回该程序集中的类。 +- 返回值会在最后排序。 + +## 相关文档 + +- [IsClassAvailable](IsClassAvailable.md) +- [TryGetClassFieldMetadata](TryGetClassFieldMetadata.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/HasManagedInstance.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/HasManagedInstance.md new file mode 100644 index 00000000..9cb1a0bd --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/HasManagedInstance.md @@ -0,0 +1,21 @@ +# MonoScriptRuntime::HasManagedInstance + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +bool HasManagedInstance(const ScriptComponent* component) const; +``` + +## 当前实现行为 + +查询实例缓存并检查对应 `gcHandle` 能否取回托管对象。 + +## 相关文档 + +- [GetManagedInstanceObject](GetManagedInstanceObject.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Initialize.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Initialize.md new file mode 100644 index 00000000..32b690f6 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Initialize.md @@ -0,0 +1,34 @@ +# MonoScriptRuntime::Initialize + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +bool Initialize(); +``` + +## 当前实现流程 + +1. 重新 `ResolveSettings()`。 +2. 清空 `m_lastError`。 +3. 若已初始化，直接返回 `true`。 +4. 初始化 Mono root domain。 +5. 创建 app domain。 +6. 加载核心程序集和游戏程序集。 +7. 发现脚本类并建立缓存。 +8. 成功后置 `m_initialized = true`。 + +## 失败处理 + +- 若加载程序集或类发现失败，会销毁 app domain。 +- 失败原因会写入 `m_lastError`。 + +## 相关文档 + +- [Shutdown](Shutdown.md) +- [GetLastError](GetLastError.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/InvokeMethod.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/InvokeMethod.md new file mode 100644 index 00000000..2e3f7605 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/InvokeMethod.md @@ -0,0 +1,34 @@ +# MonoScriptRuntime::InvokeMethod + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +void InvokeMethod( + const ScriptRuntimeContext& context, + ScriptLifecycleMethod method, + float deltaTime) override; +``` + +## 当前实现行为 + +- 先找实例缓存和类元数据。 +- 再从类元数据里取出对应生命周期方法指针。 +- 若方法不存在，直接返回，不视为错误。 +- 调用前暂存当前 internal call 的 `deltaTime`。 +- 把本次 `deltaTime` 写入 internal call 全局状态。 +- 调用托管方法。 +- 调用后恢复旧的 `deltaTime`。 + +## 设计意义 + +这说明当前托管 `Time.deltaTime` 一类能力，并不是通过每次参数注入，而是通过 internal call 共享状态提供。 + +## 相关文档 + +- [IScriptRuntime::InvokeMethod](../../IScriptRuntime/InvokeMethod.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/IsClassAvailable.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/IsClassAvailable.md new file mode 100644 index 00000000..4ab28b48 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/IsClassAvailable.md @@ -0,0 +1,24 @@ +# MonoScriptRuntime::IsClassAvailable + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +bool IsClassAvailable( + const std::string& assemblyName, + const std::string& namespaceName, + const std::string& className) const; +``` + +## 当前实现行为 + +通过内部类缓存查找 `assembly|fullName` 组合键，存在则返回 `true`。 + +## 相关文档 + +- [GetScriptClassNames](GetScriptClassNames.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/MonoScriptRuntime.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/MonoScriptRuntime.md new file mode 100644 index 00000000..518cedd9 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/MonoScriptRuntime.md @@ -0,0 +1,86 @@ +# MonoScriptRuntime + +**命名空间**: `XCEngine::Scripting` + +**类型**: `class` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +**描述**: 基于 Mono 的脚本运行时实现，负责程序集加载、类发现、实例创建、internal call 桥接和生命周期调用。 + +## 概览 + +`MonoScriptRuntime` 是当前唯一的真实托管脚本后端。它把 `ScriptEngine` 提供的抽象调用翻译成 Mono 世界里的具体动作： + +- 初始化 root domain 和 app domain。 +- 加载脚本核心程序集与游戏程序集。 +- 发现继承 `MonoBehaviour` 的可用脚本类。 +- 构建类元数据缓存。 +- 创建和销毁脚本实例。 +- 通过 internal call 让托管脚本访问原生 `GameObject`、`Transform`、`Camera` 等能力。 + +## 生命周期 + +- 构造时接收一份 `Settings`，并做路径补全。 +- [Initialize](Initialize.md) 会完成完整 Mono 初始化流程。 +- [Shutdown](Shutdown.md) 会销毁 app domain、清空类缓存与实例缓存。 +- 析构会自动调用 `Shutdown()`。 + +## 常用访问器 + +- `IsInitialized()` +- `GetSettings()` +- `GetLastError()` + +这些访问器主要用于测试、诊断和工具层。当前文档对 `GetLastError()` 单独补页，因为它直接关系到失败排查。 + +## 设计要点 + +- `ScriptEngine` 不直接碰 Mono API；所有后端细节收敛在这个类里。 +- 类缓存和实例缓存都基于稳定键，便于场景重建和脚本回绑。 +- internal call 注册集中在本实现里，说明当前托管 API 面是围绕 Mono 后端组织的，而不是独立脚本 ABI。 + +## 当前实现边界 + +- 当前只发现应用程序集中的非抽象 `MonoBehaviour` 子类。 +- 支持的公共字段类型只覆盖 `float / double / bool / int32 / uint64 / string / Vector2 / Vector3 / Vector4 / GameObject`。 +- `SyncManagedFieldsToStorage()` 只会回写已经存在于 `ScriptFieldStorage` 中的字段；运行时临时字段不会自动持久化。 +- `OnRuntimeStop()` 只清理当前活动场景与实例，不会做完整 `Shutdown()`。 + +## 公开方法 + +| 方法 | 说明 | +|------|------| +| [Constructor](Constructor.md) | 创建 Mono 运行时对象并解析设置。 | +| [Destructor](Destructor.md) | 析构时执行 `Shutdown()`。 | +| [Initialize](Initialize.md) | 初始化 Mono 域并发现脚本类。 | +| [Shutdown](Shutdown.md) | 关闭当前 Mono 运行时。 | +| [GetLastError](GetLastError.md) | 读取最近一次错误描述。 | +| [IsClassAvailable](IsClassAvailable.md) | 查询脚本类是否已发现。 | +| [GetScriptClassNames](GetScriptClassNames.md) | 返回已发现脚本类名列表。 | +| [TryGetClassFieldMetadata](TryGetClassFieldMetadata.md) | 读取脚本类字段元数据。 | +| [HasManagedInstance](HasManagedInstance.md) | 判断某脚本组件是否已有托管实例。 | +| [GetManagedInstanceCount](GetManagedInstanceCount.md) | 返回当前托管实例数。 | +| [GetManagedInstanceObject](GetManagedInstanceObject.md) | 读取托管对象裸指针。 | +| [CreateManagedComponentWrapper](CreateManagedComponentWrapper.md) | 为原生组件创建托管包装对象。 | +| [TryGetFieldValue](TryGetFieldValue.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) | 调用生命周期方法。 | + +## 真实行为依据 + +- `engine/src/Scripting/Mono/MonoScriptRuntime.cpp` +- `tests/scripting/test_mono_script_runtime.cpp` + +## 相关文档 + +- [Mono](../Mono.md) +- [IScriptRuntime](../../IScriptRuntime/IScriptRuntime.md) +- [ScriptEngine](../../ScriptEngine/ScriptEngine.md) +- [Scripting Runtime And Field Model](../../../../_guides/Scripting/Scripting-Runtime-And-Field-Model.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/OnRuntimeStart.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/OnRuntimeStart.md new file mode 100644 index 00000000..e8f96835 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/OnRuntimeStart.md @@ -0,0 +1,27 @@ +# MonoScriptRuntime::OnRuntimeStart + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +void OnRuntimeStart(Components::Scene* scene) override; +``` + +## 当前实现行为 + +- 先把 `m_activeScene` 清空，并把 internal call 的 `deltaTime` 重置为 `0`。 +- 调用 [Initialize](Initialize.md)。 +- 初始化成功后，把 `m_activeScene` 和 internal call 场景都指向当前 `scene`。 + +## 设计意义 + +这一步的重点不是创建所有脚本实例，而是让 Mono 后端进入“可服务当前场景”的状态。 + +## 相关文档 + +- [OnRuntimeStop](OnRuntimeStop.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/OnRuntimeStop.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/OnRuntimeStop.md new file mode 100644 index 00000000..9aaf5ea8 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/OnRuntimeStop.md @@ -0,0 +1,28 @@ +# MonoScriptRuntime::OnRuntimeStop + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +void OnRuntimeStop(Components::Scene* scene) override; +``` + +## 当前实现行为 + +- 忽略传入场景参数。 +- 清空托管实例缓存。 +- 清空活动场景和 internal call 场景。 +- 把 internal call 的 `deltaTime` 重置为 `0`。 + +## 注意事项 + +它不会执行完整 [Shutdown](Shutdown.md)，因此类缓存和 Mono 域仍然保留。 + +## 相关文档 + +- [Shutdown](Shutdown.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Shutdown.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Shutdown.md new file mode 100644 index 00000000..3ed36db2 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/Shutdown.md @@ -0,0 +1,30 @@ +# MonoScriptRuntime::Shutdown + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +void Shutdown(); +``` + +## 当前实现行为 + +- 清空托管实例缓存。 +- 清空类缓存。 +- 清空所有 Mono 相关指针成员。 +- 销毁 app domain。 +- 重置活动场景和 internal call 上下文。 +- 把 `m_initialized` 置回 `false`。 + +## 注意事项 + +`OnRuntimeStop()` 不等价于 `Shutdown()`；前者更像运行场景停止，后者则是整个 Mono 运行时关闭。 + +## 相关文档 + +- [OnRuntimeStop](OnRuntimeStop.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/SyncManagedFieldsToStorage.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/SyncManagedFieldsToStorage.md new file mode 100644 index 00000000..834ab7b8 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/SyncManagedFieldsToStorage.md @@ -0,0 +1,32 @@ +# MonoScriptRuntime::SyncManagedFieldsToStorage + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +void SyncManagedFieldsToStorage( + const ScriptRuntimeContext& context) override; +``` + +## 当前实现行为 + +- 要求 `context.component`、实例缓存和类元数据都存在。 +- 只遍历当前 `ScriptFieldStorage` 里已经存在的字段名。 +- 只有字段名存在于类元数据中且类型匹配，才会从托管对象读回并写回本地缓存。 + +## 重要边界 + +这意味着： + +- 托管运行时中新出现但本地没存过的字段，不会自动持久化。 +- 本地字段类型如果和类定义不匹配，也不会被强行覆盖。 + +## 相关文档 + +- [CreateScriptInstance](CreateScriptInstance.md) +- [ScriptFieldStorage](../../ScriptFieldStorage/ScriptFieldStorage.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetClassFieldMetadata.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetClassFieldMetadata.md new file mode 100644 index 00000000..a13c73c2 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetClassFieldMetadata.md @@ -0,0 +1,36 @@ +# MonoScriptRuntime::TryGetClassFieldMetadata + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +bool TryGetClassFieldMetadata( + const std::string& assemblyName, + const std::string& namespaceName, + const std::string& className, + std::vector& outFields) const override; +``` + +## 当前实现行为 + +- 先查找类缓存。 +- 找不到返回 `false` 并清空输出。 +- 找到后把缓存中的字段元数据复制到 `outFields`。 +- 最终按字段名排序。 + +## 字段来源边界 + +当前只会收录： + +- 公共实例字段 +- 非静态字段 +- 可映射到当前支持脚本字段类型的字段 + +## 相关文档 + +- [IScriptRuntime::TryGetClassFieldMetadata](../../IScriptRuntime/TryGetClassFieldMetadata.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetFieldValue.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetFieldValue.md new file mode 100644 index 00000000..7248fd48 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetFieldValue.md @@ -0,0 +1,30 @@ +# MonoScriptRuntime::TryGetFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +bool TryGetFieldValue( + const ScriptComponent* component, + const std::string& fieldName, + ScriptFieldValue& outValue) const; +``` + +## 当前实现行为 + +- 先通过组件找到实例缓存。 +- 再检查类元数据中是否存在该字段。 +- 成功时直接从托管对象读出字段值。 + +## 与 `TryGetManagedFieldValue` 的区别 + +这个接口用 `ScriptComponent*` 作为入口，更适合测试和诊断；`TryGetManagedFieldValue()` 则是实现 `IScriptRuntime` 接口的标准路径。 + +## 相关文档 + +- [TryGetManagedFieldValue](TryGetManagedFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetManagedFieldValue.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetManagedFieldValue.md new file mode 100644 index 00000000..1b907483 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TryGetManagedFieldValue.md @@ -0,0 +1,28 @@ +# MonoScriptRuntime::TryGetManagedFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +bool TryGetManagedFieldValue( + const ScriptRuntimeContext& context, + const std::string& fieldName, + ScriptFieldValue& outValue) const override; +``` + +## 当前实现行为 + +和写路径类似： + +- 先找实例缓存。 +- 再找字段元数据。 +- 成功后直接从托管对象字段读出当前值。 + +## 相关文档 + +- [TrySetManagedFieldValue](TrySetManagedFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TrySetManagedFieldValue.md b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TrySetManagedFieldValue.md new file mode 100644 index 00000000..793cf136 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Mono/MonoScriptRuntime/TrySetManagedFieldValue.md @@ -0,0 +1,27 @@ +# MonoScriptRuntime::TrySetManagedFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/Mono/MonoScriptRuntime.h` + +## 签名 + +```cpp +bool TrySetManagedFieldValue( + const ScriptRuntimeContext& context, + const std::string& fieldName, + const ScriptFieldValue& value) override; +``` + +## 当前实现行为 + +- 先用 `context` 找到实例缓存。 +- 再在类元数据里查字段。 +- 字段不存在或类型不兼容则失败。 +- 成功时把原生值写进托管对象字段。 + +## 相关文档 + +- [TryGetManagedFieldValue](TryGetManagedFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/NullScriptRuntime/CreateScriptInstance.md b/docs/api/XCEngine/Scripting/NullScriptRuntime/CreateScriptInstance.md new file mode 100644 index 00000000..a9a05fd5 --- /dev/null +++ b/docs/api/XCEngine/Scripting/NullScriptRuntime/CreateScriptInstance.md @@ -0,0 +1,28 @@ +# NullScriptRuntime::CreateScriptInstance + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/NullScriptRuntime.h` + +## 签名 + +```cpp +bool CreateScriptInstance(const ScriptRuntimeContext& context) override; +``` + +## 当前实现行为 + +当前只做一个检查： + +```cpp +return context.component != nullptr; +``` + +也就是说，它不创建真实实例，只是告诉上层“这个组件至少存在，可以继续走生命周期占位流程”。 + +## 相关文档 + +- [NullScriptRuntime](NullScriptRuntime.md) +- [DestroyScriptInstance](DestroyScriptInstance.md) diff --git a/docs/api/XCEngine/Scripting/NullScriptRuntime/DestroyScriptInstance.md b/docs/api/XCEngine/Scripting/NullScriptRuntime/DestroyScriptInstance.md new file mode 100644 index 00000000..05b0b0f9 --- /dev/null +++ b/docs/api/XCEngine/Scripting/NullScriptRuntime/DestroyScriptInstance.md @@ -0,0 +1,21 @@ +# NullScriptRuntime::DestroyScriptInstance + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/NullScriptRuntime.h` + +## 签名 + +```cpp +void DestroyScriptInstance(const ScriptRuntimeContext& context) override; +``` + +## 当前实现行为 + +空实现，不释放额外资源。 + +## 相关文档 + +- [NullScriptRuntime](NullScriptRuntime.md) diff --git a/docs/api/XCEngine/Scripting/NullScriptRuntime/InvokeMethod.md b/docs/api/XCEngine/Scripting/NullScriptRuntime/InvokeMethod.md new file mode 100644 index 00000000..a8db043c --- /dev/null +++ b/docs/api/XCEngine/Scripting/NullScriptRuntime/InvokeMethod.md @@ -0,0 +1,25 @@ +# NullScriptRuntime::InvokeMethod + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/NullScriptRuntime.h` + +## 签名 + +```cpp +void InvokeMethod( + const ScriptRuntimeContext& context, + ScriptLifecycleMethod method, + float deltaTime) override; +``` + +## 当前实现行为 + +空实现，不会真正调用任何脚本方法。 + +## 相关文档 + +- [NullScriptRuntime](NullScriptRuntime.md) +- [IScriptRuntime::InvokeMethod](../IScriptRuntime/InvokeMethod.md) diff --git a/docs/api/XCEngine/Scripting/NullScriptRuntime/NullScriptRuntime.md b/docs/api/XCEngine/Scripting/NullScriptRuntime/NullScriptRuntime.md new file mode 100644 index 00000000..5e5795d5 --- /dev/null +++ b/docs/api/XCEngine/Scripting/NullScriptRuntime/NullScriptRuntime.md @@ -0,0 +1,57 @@ +# NullScriptRuntime + +**命名空间**: `XCEngine::Scripting` + +**类型**: `class` + +**头文件**: `XCEngine/Scripting/NullScriptRuntime.h` + +**描述**: `IScriptRuntime` 的空实现，用作无托管环境时的默认兜底后端。 + +## 概览 + +`NullScriptRuntime` 的作用不是执行脚本，而是让整个脚本系统在“没有真实脚本后端”的情况下仍然保持接口闭合： + +- `ScriptEngine` 仍然可以安全持有一个运行时对象。 +- 场景和脚本组件的原生数据层仍然可以工作。 +- 测试或工具链不需要为“没有运行时时指针为空”额外兜底。 + +这是一种很典型的 Null Object 模式，在商业引擎底层模块中很常见。 + +## 当前实现行为 + +- 运行时启停是 no-op。 +- 元数据查询总是失败，并清空输出数组。 +- 托管写字段总是返回 `true`，相当于“我接受这个请求，但没有实际后端可写”。 +- 托管读字段总是返回 `false`。 +- 同步字段是 no-op。 +- 创建实例时，只要 `context.component` 非空就返回 `true`。 +- 销毁实例和生命周期调用都是 no-op。 + +## 设计代价 + +这种兜底方案能让主流程更简单，但也意味着： + +- “返回成功”不一定真的代表有托管实例存在。 +- 如果用户误以为自己接了真实脚本后端，问题会更偏逻辑层而不是崩溃层暴露出来。 + +因此文档必须清楚说明它是占位运行时，而不是简化版脚本解释器。 + +## 公开方法 + +| 方法 | 说明 | +|------|------| +| [OnRuntimeStart](OnRuntimeStart.md) | 空实现。 | +| [OnRuntimeStop](OnRuntimeStop.md) | 空实现。 | +| [TryGetClassFieldMetadata](TryGetClassFieldMetadata.md) | 始终失败并清空输出。 | +| [TrySetManagedFieldValue](TrySetManagedFieldValue.md) | 始终返回 `true`。 | +| [TryGetManagedFieldValue](TryGetManagedFieldValue.md) | 始终返回 `false`。 | +| [SyncManagedFieldsToStorage](SyncManagedFieldsToStorage.md) | 空实现。 | +| [CreateScriptInstance](CreateScriptInstance.md) | 仅检查组件指针是否存在。 | +| [DestroyScriptInstance](DestroyScriptInstance.md) | 空实现。 | +| [InvokeMethod](InvokeMethod.md) | 空实现。 | + +## 相关文档 + +- [IScriptRuntime](../IScriptRuntime/IScriptRuntime.md) +- [ScriptEngine](../ScriptEngine/ScriptEngine.md) diff --git a/docs/api/XCEngine/Scripting/NullScriptRuntime/OnRuntimeStart.md b/docs/api/XCEngine/Scripting/NullScriptRuntime/OnRuntimeStart.md new file mode 100644 index 00000000..52e7b3e7 --- /dev/null +++ b/docs/api/XCEngine/Scripting/NullScriptRuntime/OnRuntimeStart.md @@ -0,0 +1,21 @@ +# NullScriptRuntime::OnRuntimeStart + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/NullScriptRuntime.h` + +## 签名 + +```cpp +void OnRuntimeStart(Components::Scene* scene) override; +``` + +## 当前实现行为 + +空实现，只显式忽略参数，不做任何初始化。 + +## 相关文档 + +- [NullScriptRuntime](NullScriptRuntime.md) diff --git a/docs/api/XCEngine/Scripting/NullScriptRuntime/OnRuntimeStop.md b/docs/api/XCEngine/Scripting/NullScriptRuntime/OnRuntimeStop.md new file mode 100644 index 00000000..e04c53fc --- /dev/null +++ b/docs/api/XCEngine/Scripting/NullScriptRuntime/OnRuntimeStop.md @@ -0,0 +1,21 @@ +# NullScriptRuntime::OnRuntimeStop + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/NullScriptRuntime.h` + +## 签名 + +```cpp +void OnRuntimeStop(Components::Scene* scene) override; +``` + +## 当前实现行为 + +空实现，不清理额外状态。 + +## 相关文档 + +- [NullScriptRuntime](NullScriptRuntime.md) diff --git a/docs/api/XCEngine/Scripting/NullScriptRuntime/SyncManagedFieldsToStorage.md b/docs/api/XCEngine/Scripting/NullScriptRuntime/SyncManagedFieldsToStorage.md new file mode 100644 index 00000000..9fea99fa --- /dev/null +++ b/docs/api/XCEngine/Scripting/NullScriptRuntime/SyncManagedFieldsToStorage.md @@ -0,0 +1,23 @@ +# NullScriptRuntime::SyncManagedFieldsToStorage + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/NullScriptRuntime.h` + +## 签名 + +```cpp +void SyncManagedFieldsToStorage( + const ScriptRuntimeContext& context) override; +``` + +## 当前实现行为 + +空实现，不做字段回写。 + +## 相关文档 + +- [NullScriptRuntime](NullScriptRuntime.md) +- [IScriptRuntime::SyncManagedFieldsToStorage](../IScriptRuntime/SyncManagedFieldsToStorage.md) diff --git a/docs/api/XCEngine/Scripting/NullScriptRuntime/TryGetClassFieldMetadata.md b/docs/api/XCEngine/Scripting/NullScriptRuntime/TryGetClassFieldMetadata.md new file mode 100644 index 00000000..dbd9039a --- /dev/null +++ b/docs/api/XCEngine/Scripting/NullScriptRuntime/TryGetClassFieldMetadata.md @@ -0,0 +1,32 @@ +# NullScriptRuntime::TryGetClassFieldMetadata + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/NullScriptRuntime.h` + +## 签名 + +```cpp +bool TryGetClassFieldMetadata( + const std::string& assemblyName, + const std::string& namespaceName, + const std::string& className, + std::vector& outFields) const override; +``` + +## 当前实现行为 + +- 忽略输入参数。 +- 先清空 `outFields`。 +- 返回 `false`。 + +## 含义 + +这明确表示当前不存在可查询的托管类元数据。 + +## 相关文档 + +- [NullScriptRuntime](NullScriptRuntime.md) +- [IScriptRuntime::TryGetClassFieldMetadata](../IScriptRuntime/TryGetClassFieldMetadata.md) diff --git a/docs/api/XCEngine/Scripting/NullScriptRuntime/TryGetManagedFieldValue.md b/docs/api/XCEngine/Scripting/NullScriptRuntime/TryGetManagedFieldValue.md new file mode 100644 index 00000000..f362e972 --- /dev/null +++ b/docs/api/XCEngine/Scripting/NullScriptRuntime/TryGetManagedFieldValue.md @@ -0,0 +1,27 @@ +# NullScriptRuntime::TryGetManagedFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/NullScriptRuntime.h` + +## 签名 + +```cpp +bool TryGetManagedFieldValue( + const ScriptRuntimeContext& context, + const std::string& fieldName, + ScriptFieldValue& outValue) const override; +``` + +## 当前实现行为 + +- 忽略所有参数。 +- 不写 `outValue` 的有效结果。 +- 直接返回 `false`。 + +## 相关文档 + +- [NullScriptRuntime](NullScriptRuntime.md) +- [TrySetManagedFieldValue](TrySetManagedFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/NullScriptRuntime/TrySetManagedFieldValue.md b/docs/api/XCEngine/Scripting/NullScriptRuntime/TrySetManagedFieldValue.md new file mode 100644 index 00000000..e5f8266e --- /dev/null +++ b/docs/api/XCEngine/Scripting/NullScriptRuntime/TrySetManagedFieldValue.md @@ -0,0 +1,30 @@ +# NullScriptRuntime::TrySetManagedFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/NullScriptRuntime.h` + +## 签名 + +```cpp +bool TrySetManagedFieldValue( + const ScriptRuntimeContext& context, + const std::string& fieldName, + const ScriptFieldValue& value) override; +``` + +## 当前实现行为 + +- 忽略所有参数。 +- 直接返回 `true`。 + +## 注意事项 + +这里的成功只代表“空运行时接受了这个接口调用”，不代表真实托管实例被更新。 + +## 相关文档 + +- [NullScriptRuntime](NullScriptRuntime.md) +- [TryGetManagedFieldValue](TryGetManagedFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/Constructor.md b/docs/api/XCEngine/Scripting/ScriptComponent/Constructor.md new file mode 100644 index 00000000..d2276b7d --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/Constructor.md @@ -0,0 +1,27 @@ +# ScriptComponent::Constructor + +**命名空间**: `XCEngine::Scripting` + +**类型**: `constructor` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +## 签名 + +```cpp +ScriptComponent(); +``` + +## 当前实现行为 + +- 调用内部 `GenerateScriptComponentUUID()` 生成一个非零随机 `uint64_t`。 +- `m_assemblyName` 默认初始化为 `GameScripts`。 +- 命名空间、类名和字段存储初始为空。 + +## 设计意义 + +组件 UUID 的存在，是为了让脚本运行时实例绑定不依赖对象内存地址。这样场景序列化、反序列化和运行时重建时，脚本实例可以通过 `(GameObjectUUID, ScriptComponentUUID)` 这组键稳定识别。 + +## 相关文档 + +- [ScriptComponent](ScriptComponent.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/Deserialize.md b/docs/api/XCEngine/Scripting/ScriptComponent/Deserialize.md new file mode 100644 index 00000000..e450ecb1 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/Deserialize.md @@ -0,0 +1,35 @@ +# ScriptComponent::Deserialize + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +## 签名 + +```cpp +void Deserialize(std::istream& is) override; +``` + +## 作用 + +从文本流恢复脚本组件状态。 + +## 当前实现行为 + +- 先把整个流读入字符串。 +- 用 `;` 切分键值对。 +- 识别 `scriptComponentUUID / assembly / namespace / class / fields`。 +- `fields` 会先做 `UnescapeScriptString()`，再交给 `ScriptFieldStorage::DeserializeFromString()`。 + +## 容错行为 + +- 空 token 会跳过。 +- 没有 `=` 的 token 会跳过。 +- 未识别的键会被忽略。 + +## 相关文档 + +- [Serialize](Serialize.md) +- [ScriptFieldStorage::DeserializeFromString](../ScriptFieldStorage/DeserializeFromString.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/GetFieldStorage.md b/docs/api/XCEngine/Scripting/ScriptComponent/GetFieldStorage.md new file mode 100644 index 00000000..2e2e2460 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/GetFieldStorage.md @@ -0,0 +1,28 @@ +# ScriptComponent::GetFieldStorage + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +## 签名 + +```cpp +ScriptFieldStorage& GetFieldStorage(); +const ScriptFieldStorage& GetFieldStorage() const; +``` + +## 作用 + +访问当前脚本组件的持久化字段缓存。 + +## 当前语义 + +- 返回内部成员对象的引用，不转移所有权。 +- 这份存储既用于场景序列化，也用于脚本运行时字段回写。 + +## 相关文档 + +- [ScriptFieldStorage](../ScriptFieldStorage/ScriptFieldStorage.md) +- [Serialize](Serialize.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/GetFullClassName.md b/docs/api/XCEngine/Scripting/ScriptComponent/GetFullClassName.md new file mode 100644 index 00000000..b6480dca --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/GetFullClassName.md @@ -0,0 +1,31 @@ +# ScriptComponent::GetFullClassName + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +## 签名 + +```cpp +std::string GetFullClassName() const; +``` + +## 当前实现行为 + +- 如果 `m_className` 为空，返回空字符串。 +- 如果命名空间为空，只返回类名。 +- 否则返回 `namespace + "." + class`。 + +## 用途 + +这个接口主要用于： + +- 日志描述。 +- 测试断言。 +- 错误信息里构造完整脚本类名。 + +## 相关文档 + +- [ScriptComponent](ScriptComponent.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/HasScriptClass.md b/docs/api/XCEngine/Scripting/ScriptComponent/HasScriptClass.md new file mode 100644 index 00000000..20c93554 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/HasScriptClass.md @@ -0,0 +1,31 @@ +# ScriptComponent::HasScriptClass + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +## 签名 + +```cpp +bool HasScriptClass() const; +``` + +## 当前实现行为 + +当前只检查 `m_className` 是否为空： + +```cpp +return !m_className.empty(); +``` + +## 含义 + +- 这表示“是否已经绑定某个脚本类名”。 +- 不代表该类在运行时中真的可用；类是否存在要看 `IScriptRuntime::TryGetClassFieldMetadata()` 或 `MonoScriptRuntime::IsClassAvailable()`。 + +## 相关文档 + +- [SetScriptClass](SetScriptClass.md) +- [ScriptEngine::TryGetScriptFieldModel](../ScriptEngine/TryGetScriptFieldModel.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/OnDestroy.md b/docs/api/XCEngine/Scripting/ScriptComponent/OnDestroy.md new file mode 100644 index 00000000..965becc4 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/OnDestroy.md @@ -0,0 +1,21 @@ +# ScriptComponent::OnDestroy + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +## 签名 + +```cpp +void OnDestroy() override; +``` + +## 当前实现行为 + +直接调用 `ScriptEngine::Get().OnScriptComponentDestroyed(this)`。 + +## 相关文档 + +- [ScriptEngine::OnScriptComponentDestroyed](../ScriptEngine/OnScriptComponentDestroyed.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/OnDisable.md b/docs/api/XCEngine/Scripting/ScriptComponent/OnDisable.md new file mode 100644 index 00000000..0f4abec1 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/OnDisable.md @@ -0,0 +1,22 @@ +# ScriptComponent::OnDisable + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +## 签名 + +```cpp +void OnDisable() override; +``` + +## 当前实现行为 + +直接调用 `ScriptEngine::Get().OnScriptComponentDisabled(this)`。 + +## 相关文档 + +- [OnEnable](OnEnable.md) +- [OnDestroy](OnDestroy.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/OnEnable.md b/docs/api/XCEngine/Scripting/ScriptComponent/OnEnable.md new file mode 100644 index 00000000..dea6f4a8 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/OnEnable.md @@ -0,0 +1,26 @@ +# ScriptComponent::OnEnable + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +## 签名 + +```cpp +void OnEnable() override; +``` + +## 当前实现行为 + +直接转发到： + +```cpp +ScriptEngine::Get().OnScriptComponentEnabled(this); +``` + +## 相关文档 + +- [OnDisable](OnDisable.md) +- [ScriptEngine::OnScriptComponentEnabled](../ScriptEngine/OnScriptComponentEnabled.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/ScriptComponent.md b/docs/api/XCEngine/Scripting/ScriptComponent/ScriptComponent.md new file mode 100644 index 00000000..dd0b45ea --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/ScriptComponent.md @@ -0,0 +1,72 @@ +# ScriptComponent + +**命名空间**: `XCEngine::Scripting` + +**类型**: `class` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +**描述**: 挂在 `GameObject` 上的脚本绑定组件，负责保存脚本类标识、组件 UUID 和字段存储。 + +## 概览 + +`ScriptComponent` 是脚本系统的数据入口。它本身不执行脚本逻辑，而是保存三类信息： + +- 这个组件绑定的是哪个程序集、命名空间和类。 +- 这个脚本组件自己的稳定 UUID。 +- 这份脚本实例的可持久化字段缓存 `ScriptFieldStorage`。 + +这和 Unity 场景里挂着的 `MonoBehaviour` 序列化槽位很接近，但当前实现更明确地把“数据层”和“运行时实例层”拆开了。 + +## 生命周期 + +- 构造时会生成一个非零随机 `scriptComponentUUID`。 +- 默认程序集名是 `GameScripts`。 +- 启用、禁用、销毁回调会直接转发给 `ScriptEngine`。 +- 序列化/反序列化会持久化 UUID、脚本类绑定和字段存储内容。 + +## 所有权 + +- `ScriptComponent` 本身归 `GameObject` 所有。 +- `ScriptFieldStorage` 作为成员对象直接内嵌，不单独分配。 + +## 当前实现边界 + +- `SetScriptClass()` 只有在“之前没有脚本类，现在有了”这个转换点，才会主动通知 `ScriptEngine::OnScriptComponentEnabled()`。 +- 单纯修改已有脚本类名，不会自动触发一轮完整的重绑定流程。 +- 反序列化使用引擎私有的分号分隔文本格式，不是通用 JSON/YAML。 + +## 常用访问器 + +- `GetAssemblyName()` / `SetAssemblyName()` +- `GetNamespaceName()` / `SetNamespaceName()` +- `GetClassName()` / `SetClassName()` +- `GetScriptComponentUUID()` + +这些访问器大多是简单内联函数，因此当前文档重点放在会改变生命周期或序列化语义的核心方法上。 + +## 公开方法 + +| 方法 | 说明 | +|------|------| +| [Constructor](Constructor.md) | 创建组件并生成 UUID。 | +| [SetScriptClass](SetScriptClass.md) | 设置脚本类绑定。 | +| [HasScriptClass](HasScriptClass.md) | 判断当前是否已经绑定脚本类。 | +| [GetFullClassName](GetFullClassName.md) | 返回带命名空间的完整类名。 | +| [GetFieldStorage](GetFieldStorage.md) | 访问持久化字段缓存。 | +| [OnEnable](OnEnable.md) | 通知 `ScriptEngine` 组件启用。 | +| [OnDisable](OnDisable.md) | 通知 `ScriptEngine` 组件禁用。 | +| [OnDestroy](OnDestroy.md) | 通知 `ScriptEngine` 组件销毁。 | +| [Serialize](Serialize.md) | 把组件状态写出到文本流。 | +| [Deserialize](Deserialize.md) | 从文本流恢复组件状态。 | + +## 真实行为依据 + +- `engine/src/Scripting/ScriptComponent.cpp` +- `tests/scripting/test_script_component.cpp` + +## 相关文档 + +- [ScriptEngine](../ScriptEngine/ScriptEngine.md) +- [ScriptFieldStorage](../ScriptFieldStorage/ScriptFieldStorage.md) +- [Scripting Runtime And Field Model](../../../_guides/Scripting/Scripting-Runtime-And-Field-Model.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/Serialize.md b/docs/api/XCEngine/Scripting/ScriptComponent/Serialize.md new file mode 100644 index 00000000..4c400288 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/Serialize.md @@ -0,0 +1,39 @@ +# ScriptComponent::Serialize + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +## 签名 + +```cpp +void Serialize(std::ostream& os) const override; +``` + +## 作用 + +把脚本组件的原生数据状态写到文本流。 + +## 当前实现行为 + +当前会按键值对形式写出： + +- `scriptComponentUUID` +- `assembly` +- `namespace` +- `class` +- `fields` + +字符串内容会经过 `EscapeScriptString()` 转义，字段存储则通过 `ScriptFieldStorage::SerializeToString()` 序列化后再整体转义。 + +## 注意事项 + +- 这是引擎私有格式，不承诺对外通用。 +- `fields` 本身是嵌套序列化文本，因此二次转义是必须的。 + +## 相关文档 + +- [Deserialize](Deserialize.md) +- [ScriptField::EscapeScriptString](../ScriptField/EscapeScriptString.md) diff --git a/docs/api/XCEngine/Scripting/ScriptComponent/SetScriptClass.md b/docs/api/XCEngine/Scripting/ScriptComponent/SetScriptClass.md new file mode 100644 index 00000000..352067eb --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptComponent/SetScriptClass.md @@ -0,0 +1,39 @@ +# ScriptComponent::SetScriptClass + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptComponent.h` + +## 签名 + +```cpp +void SetScriptClass( + const std::string& namespaceName, + const std::string& className); + +void SetScriptClass( + const std::string& assemblyName, + const std::string& namespaceName, + const std::string& className); +``` + +## 作用 + +设置当前脚本组件绑定的托管类信息。 + +## 当前实现行为 + +- 两个重载都会先记录“之前是否已经有脚本类”。 +- 然后覆盖程序集名、命名空间和类名。 +- 只有在“之前没有脚本类，设置后有脚本类”时，才会主动调用 `ScriptEngine::Get().OnScriptComponentEnabled(this)`。 + +## 设计含义 + +当前实现把“首次绑定脚本类”视作一个启用事件，但并没有把“换到另一个脚本类”也当成完整重建流程。这是一个当前版本的真实边界，用户不应该误以为修改类名会自动完成热切换。 + +## 相关文档 + +- [HasScriptClass](HasScriptClass.md) +- [OnEnable](OnEnable.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/Get.md b/docs/api/XCEngine/Scripting/ScriptEngine/Get.md new file mode 100644 index 00000000..bb7974ed --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/Get.md @@ -0,0 +1,25 @@ +# ScriptEngine::Get + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +static ScriptEngine& Get(); +``` + +## 当前实现行为 + +返回函数内静态单例。 + +## 设计意义 + +当前脚本系统被组织成全局运行时服务，这样 `SceneRuntime`、`ScriptComponent` 和工具代码都能通过统一入口触达同一套状态。 + +## 相关文档 + +- [ScriptEngine](ScriptEngine.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/GetTrackedScriptCount.md b/docs/api/XCEngine/Scripting/ScriptEngine/GetTrackedScriptCount.md new file mode 100644 index 00000000..ab908be9 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/GetTrackedScriptCount.md @@ -0,0 +1,21 @@ +# ScriptEngine::GetTrackedScriptCount + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +size_t GetTrackedScriptCount() const; +``` + +## 当前实现行为 + +内联返回 `m_scriptOrder.size()`，即当前被调度层纳入跟踪的脚本组件数。 + +## 相关文档 + +- [HasTrackedScriptComponent](HasTrackedScriptComponent.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/HasRuntimeInstance.md b/docs/api/XCEngine/Scripting/ScriptEngine/HasRuntimeInstance.md new file mode 100644 index 00000000..80c29904 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/HasRuntimeInstance.md @@ -0,0 +1,25 @@ +# ScriptEngine::HasRuntimeInstance + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +bool HasRuntimeInstance(const ScriptComponent* component) const; +``` + +## 当前实现行为 + +只有对应状态存在且 `instanceCreated == true` 时返回 `true`。 + +## 注意事项 + +这反映的是原生调度层状态，而不是直接去后端查询对象句柄。 + +## 相关文档 + +- [HasTrackedScriptComponent](HasTrackedScriptComponent.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/HasTrackedScriptComponent.md b/docs/api/XCEngine/Scripting/ScriptEngine/HasTrackedScriptComponent.md new file mode 100644 index 00000000..996e60bd --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/HasTrackedScriptComponent.md @@ -0,0 +1,21 @@ +# ScriptEngine::HasTrackedScriptComponent + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +bool HasTrackedScriptComponent(const ScriptComponent* component) const; +``` + +## 当前实现行为 + +通过内部状态表查找该组件是否已被 `ScriptEngine` 追踪。 + +## 相关文档 + +- [HasRuntimeInstance](HasRuntimeInstance.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/OnFixedUpdate.md b/docs/api/XCEngine/Scripting/ScriptEngine/OnFixedUpdate.md new file mode 100644 index 00000000..30604c03 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/OnFixedUpdate.md @@ -0,0 +1,31 @@ +# ScriptEngine::OnFixedUpdate + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +void OnFixedUpdate(float fixedDeltaTime); +``` + +## 当前实现行为 + +- 只在 `m_runtimeRunning` 为真时继续执行。 +- 复制当前脚本顺序表，按顺序遍历。 +- 对每个脚本要求同时满足： + - `ShouldScriptRun(state)` + - `EnsureScriptReady(state, true)` + - `state.enabled == true` +- 满足后调用运行时 `FixedUpdate` 生命周期。 + +## 设计意义 + +复制顺序表再遍历，可以避免遍历过程中容器被增删时直接打乱当前帧顺序。 + +## 相关文档 + +- [OnUpdate](OnUpdate.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/OnLateUpdate.md b/docs/api/XCEngine/Scripting/ScriptEngine/OnLateUpdate.md new file mode 100644 index 00000000..eb901b52 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/OnLateUpdate.md @@ -0,0 +1,21 @@ +# ScriptEngine::OnLateUpdate + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +void OnLateUpdate(float deltaTime); +``` + +## 当前实现行为 + +与 `OnFixedUpdate()` 类似，只是在最终阶段调用 `LateUpdate(deltaTime)` 生命周期。 + +## 相关文档 + +- [OnUpdate](OnUpdate.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/OnRuntimeStart.md b/docs/api/XCEngine/Scripting/ScriptEngine/OnRuntimeStart.md new file mode 100644 index 00000000..b817b263 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/OnRuntimeStart.md @@ -0,0 +1,35 @@ +# ScriptEngine::OnRuntimeStart + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +void OnRuntimeStart(Components::Scene* scene); +``` + +## 当前实现流程 + +按 `engine/src/Scripting/ScriptEngine.cpp`： + +1. 先调用 `OnRuntimeStop()` 清理旧运行时。 +2. 如果 `scene == nullptr`，直接返回。 +3. 记录 `m_runtimeScene`，置 `m_runtimeRunning = true`。 +4. 调用当前运行时 `m_runtime->OnRuntimeStart(scene)`。 +5. 订阅 `scene->OnGameObjectCreated()`，保证运行中创建的新对象也会被脚本系统追踪。 +6. 递归收集场景现有的所有 `ScriptComponent`。 +7. 对满足 `ShouldScriptRun()` 的组件调用 `EnsureScriptReady(..., true)`，从而创建实例并触发 `Awake / OnEnable`。 + +## 设计重点 + +- 这一步不会直接触发 `Start`；`Start` 留到第一次 `OnUpdate()` 再补发。 +- 订阅场景创建事件，保证 runtime-spawn 出来的对象不会漏掉脚本初始化。 + +## 相关文档 + +- [OnRuntimeStop](OnRuntimeStop.md) +- [OnUpdate](OnUpdate.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/OnRuntimeStop.md b/docs/api/XCEngine/Scripting/ScriptEngine/OnRuntimeStop.md new file mode 100644 index 00000000..c7a7908c --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/OnRuntimeStop.md @@ -0,0 +1,36 @@ +# ScriptEngine::OnRuntimeStop + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +void OnRuntimeStop(); +``` + +## 当前实现流程 + +- 如果订阅了场景创建事件，会先退订并处理退订队列。 +- 若当前并未运行： + - 清空 `m_runtimeScene` + - 清空跟踪状态和顺序表 + - 返回 +- 若正在运行： + - 遍历所有跟踪脚本，调用 `StopTrackingScript(..., true)` + - 清空状态表与顺序表 + - 把 `m_runtimeRunning` 置为 `false` + - 清空 `m_runtimeScene` + - 最后调用 `m_runtime->OnRuntimeStop(stoppedScene)` + +## 当前真实语义 + +`StopTrackingScript()` 会在实例存在时按 `OnDisable -> OnDestroy -> DestroyScriptInstance` 清理，因此这不是简单停更，而是完整结束脚本运行态。 + +## 相关文档 + +- [OnRuntimeStart](OnRuntimeStart.md) +- [OnScriptComponentDestroyed](OnScriptComponentDestroyed.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentDestroyed.md b/docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentDestroyed.md new file mode 100644 index 00000000..b844b11b --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentDestroyed.md @@ -0,0 +1,23 @@ +# ScriptEngine::OnScriptComponentDestroyed + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +void OnScriptComponentDestroyed(ScriptComponent* component); +``` + +## 当前实现行为 + +- 只有运行时启动且组件存在时处理。 +- 找到对应状态后调用 `StopTrackingScript(..., false)`。 +- 这会在需要时触发 `OnDisable`、`OnDestroy`、实例销毁，并把该组件从跟踪表移除。 + +## 相关文档 + +- [HasTrackedScriptComponent](HasTrackedScriptComponent.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentDisabled.md b/docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentDisabled.md new file mode 100644 index 00000000..317ba778 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentDisabled.md @@ -0,0 +1,24 @@ +# ScriptEngine::OnScriptComponentDisabled + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +void OnScriptComponentDisabled(ScriptComponent* component); +``` + +## 当前实现行为 + +- 只有运行时已启动、组件存在且当前状态 `enabled == true` 时才继续。 +- 调用 `OnDisable` 生命周期。 +- 然后把 `state.enabled` 置为 `false`。 + +## 相关文档 + +- [OnScriptComponentEnabled](OnScriptComponentEnabled.md) +- [OnScriptComponentDestroyed](OnScriptComponentDestroyed.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentEnabled.md b/docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentEnabled.md new file mode 100644 index 00000000..bb84911b --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/OnScriptComponentEnabled.md @@ -0,0 +1,24 @@ +# ScriptEngine::OnScriptComponentEnabled + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +void OnScriptComponentEnabled(ScriptComponent* component); +``` + +## 当前实现行为 + +- 只有运行时已启动且 `component` 非空时才处理。 +- 会先把组件纳入跟踪表。 +- 如果当前满足 `ShouldScriptRun()`，则立刻尝试 `EnsureScriptReady(..., true)`，从而补齐实例创建、`Awake` 和 `OnEnable`。 + +## 相关文档 + +- [OnScriptComponentDisabled](OnScriptComponentDisabled.md) +- [ScriptComponent::OnEnable](../ScriptComponent/OnEnable.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/OnUpdate.md b/docs/api/XCEngine/Scripting/ScriptEngine/OnUpdate.md new file mode 100644 index 00000000..d3af5a7c --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/OnUpdate.md @@ -0,0 +1,29 @@ +# ScriptEngine::OnUpdate + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +void OnUpdate(float deltaTime); +``` + +## 当前实现行为 + +和 `OnFixedUpdate()` 类似，但多了一步关键逻辑： + +- 如果 `state.startPending && !state.startCalled`，先调用一次 `Start`。 +- 随后再调用 `Update(deltaTime)`。 + +## 为什么 `Start` 在这里触发 + +当前实现选择把 `Start` 定义成“第一次正常逐帧更新前的初始化阶段”，而不是运行时刚启动就立刻调用。这和很多商业引擎的语义更接近，也更利于保证对象与脚本都已经进入稳定运行态。 + +## 相关文档 + +- [OnRuntimeStart](OnRuntimeStart.md) +- [OnLateUpdate](OnLateUpdate.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/ScriptEngine.md b/docs/api/XCEngine/Scripting/ScriptEngine/ScriptEngine.md new file mode 100644 index 00000000..92a2050a --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/ScriptEngine.md @@ -0,0 +1,100 @@ +# ScriptEngine + +**命名空间**: `XCEngine::Scripting` + +**类型**: `class (singleton)` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +**描述**: 当前脚本系统的总调度器，负责运行时启停、脚本实例追踪、生命周期调用与字段模型拼装。 + +## 概览 + +`ScriptEngine` 是当前脚本模块里最重要的原生协调者。它自己不执行脚本字节码，也不保存场景数据，而是负责把下面几层真正串起来： + +- `SceneRuntime` 提供“场景开始运行/停止运行/每帧更新”的入口。 +- `ScriptComponent` 提供脚本绑定与字段缓存。 +- `IScriptRuntime` 提供具体脚本后端能力。 + +当前它的核心职责包括： + +- 在运行时开始时收集场景中的脚本组件并建立追踪表。 +- 根据对象激活状态、组件启用状态和脚本类绑定状态决定脚本是否应当运行。 +- 按顺序创建实例、调用 `Awake / OnEnable / Start / Update...`。 +- 在运行时字段、本地字段缓存和类元数据之间建立一致的读取模型。 + +## 生命周期 + +- [Get](Get.md) 返回进程级单例。 +- 默认运行时是内部持有的 `NullScriptRuntime`。 +- [SetRuntime](SetRuntime.md) 可替换具体后端；传 `nullptr` 时回退到空运行时。 +- [OnRuntimeStart](OnRuntimeStart.md) / [OnRuntimeStop](OnRuntimeStop.md) 管理整条脚本运行链路。 + +## 内部追踪模型 + +当前 `ScriptEngine` 通过 `(gameObjectUUID, scriptComponentUUID)` 唯一标识一个脚本实例状态，并保存： + +- `context` +- `instanceCreated` +- `awakeCalled` +- `enabled` +- `startCalled` +- `startPending` + +这说明当前生命周期状态是显式状态机，而不是每次调用都从托管世界反查。 + +## 线程语义 + +- 当前实现没有锁。 +- 应视为主线程运行时服务。 +- 不应该在并发线程里同时改脚本组件集合和驱动脚本生命周期。 + +## 当前实现边界 + +- 只跟踪当前运行场景里的脚本组件。 +- `Start` 生命周期会在第一次 `OnUpdate()` 前补发一次，而不是在 `OnRuntimeStart()` 里立即调用。 +- `TrySetScriptFieldValue()` 只有在后端能返回类字段元数据时，才会强校验字段名和类型。 +- `TryGetScriptFieldModel()` 会把类元数据、运行时值和本地存储值融合成一份快照模型，这对调试和编辑器非常重要。 + +## 常用访问器 + +- `GetRuntime()` +- `IsRuntimeRunning()` +- `GetRuntimeScene()` + +这些是简单内联访问器，当前文档重点放在影响状态机和运行行为的核心方法上。 + +## 公开方法 + +| 方法 | 说明 | +|------|------| +| [Get](Get.md) | 获取全局脚本引擎实例。 | +| [SetRuntime](SetRuntime.md) | 设置具体脚本后端。 | +| [OnRuntimeStart](OnRuntimeStart.md) | 启动脚本运行时。 | +| [OnRuntimeStop](OnRuntimeStop.md) | 停止脚本运行时。 | +| [OnFixedUpdate](OnFixedUpdate.md) | 驱动固定步长脚本更新。 | +| [OnUpdate](OnUpdate.md) | 驱动常规逐帧更新，并补发 `Start`。 | +| [OnLateUpdate](OnLateUpdate.md) | 驱动后更新。 | +| [OnScriptComponentEnabled](OnScriptComponentEnabled.md) | 处理脚本组件启用事件。 | +| [OnScriptComponentDisabled](OnScriptComponentDisabled.md) | 处理脚本组件禁用事件。 | +| [OnScriptComponentDestroyed](OnScriptComponentDestroyed.md) | 处理脚本组件销毁事件。 | +| [HasTrackedScriptComponent](HasTrackedScriptComponent.md) | 查询某组件是否被跟踪。 | +| [HasRuntimeInstance](HasRuntimeInstance.md) | 查询某组件是否已有运行时实例。 | +| [GetTrackedScriptCount](GetTrackedScriptCount.md) | 返回当前跟踪脚本数。 | +| [TrySetScriptFieldValue](TrySetScriptFieldValue.md) | 写脚本字段。 | +| [TryGetScriptFieldValue](TryGetScriptFieldValue.md) | 读脚本字段。 | +| [TryGetScriptFieldModel](TryGetScriptFieldModel.md) | 构建完整字段模型。 | +| [TryGetScriptFieldSnapshots](TryGetScriptFieldSnapshots.md) | 直接返回字段快照数组。 | + +## 真实行为依据 + +- `engine/src/Scripting/ScriptEngine.cpp` +- `tests/scripting/test_script_engine.cpp` +- `tests/Scene/test_scene_runtime.cpp` + +## 相关文档 + +- [IScriptRuntime](../IScriptRuntime/IScriptRuntime.md) +- [ScriptComponent](../ScriptComponent/ScriptComponent.md) +- [ScriptFieldStorage](../ScriptFieldStorage/ScriptFieldStorage.md) +- [Scripting Runtime And Field Model](../../../_guides/Scripting/Scripting-Runtime-And-Field-Model.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/SetRuntime.md b/docs/api/XCEngine/Scripting/ScriptEngine/SetRuntime.md new file mode 100644 index 00000000..18bfb9a4 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/SetRuntime.md @@ -0,0 +1,28 @@ +# ScriptEngine::SetRuntime + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +void SetRuntime(IScriptRuntime* runtime); +``` + +## 当前实现行为 + +- 传入非空指针时，直接把 `m_runtime` 指向该对象。 +- 传入 `nullptr` 时，回退到内部持有的 `m_nullRuntime`。 + +## 注意事项 + +- 不转移所有权；调用方需要自己保证外部运行时对象的生命周期。 +- 当前没有在切换时自动停掉已有运行时，实际使用时应先处理好时序。 + +## 相关文档 + +- [IScriptRuntime](../IScriptRuntime/IScriptRuntime.md) +- [NullScriptRuntime](../NullScriptRuntime/NullScriptRuntime.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldModel.md b/docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldModel.md new file mode 100644 index 00000000..6e35f9cd --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldModel.md @@ -0,0 +1,61 @@ +# ScriptEngine::TryGetScriptFieldModel + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +bool TryGetScriptFieldModel( + const ScriptComponent* component, + ScriptFieldModel& outModel) const; +``` + +## 作用 + +构建一份融合类元数据、托管值和本地缓存值的完整字段模型。 + +## 当前实现逻辑 + +### 1. 判定类状态 + +- 没绑定脚本类：`Unassigned` +- 绑定了脚本类且后端能返回元数据：`Available` +- 绑定了脚本类但后端查不到：`Missing` + +### 2. 为已声明字段建立快照 + +对于运行时可见的每个字段： + +- 先用字段类型生成默认值。 +- 如果本地存储里有同名字段，则记录 `storedType / storedValue`。 +- 若类型不匹配，标记 `TypeMismatch`。 +- 若托管实例可读该字段，则当前值来源记为 `ManagedValue`。 +- 否则若本地存储类型匹配，则当前值来源记为 `StoredValue`。 + +### 3. 追加仅存储字段 + +如果本地缓存里有字段名，但类元数据里没有： + +- 会以 `StoredOnly` 问题状态附加到模型末尾。 + +### 4. 排序规则 + +- 当类状态不是 `Available` 时，会按字段名整体排序。 +- 类状态为 `Available` 时，已声明字段按运行时元数据顺序构建，存储遗留字段再追加。 + +## 为什么这很重要 + +这套模型不是“为了文档好看”，而是当前脚本系统里最接近商业引擎 Inspector 数据模型的一层。它让工具或调试界面能回答这些关键问题： + +- 这个字段类里声明了吗？ +- 当前显示的是托管值还是存储值？ +- 本地存储是否已经和类定义不匹配？ + +## 相关文档 + +- [TryGetScriptFieldSnapshots](TryGetScriptFieldSnapshots.md) +- [ScriptField](../ScriptField/ScriptField.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldSnapshots.md b/docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldSnapshots.md new file mode 100644 index 00000000..36213365 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldSnapshots.md @@ -0,0 +1,25 @@ +# ScriptEngine::TryGetScriptFieldSnapshots + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +bool TryGetScriptFieldSnapshots( + const ScriptComponent* component, + std::vector& outFields) const; +``` + +## 当前实现行为 + +- 内部直接调用 [TryGetScriptFieldModel](TryGetScriptFieldModel.md)。 +- 成功后把 `model.fields` 移交给 `outFields`。 +- 如果结果为空，返回 `false`。 + +## 相关文档 + +- [TryGetScriptFieldModel](TryGetScriptFieldModel.md) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldValue.md b/docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldValue.md new file mode 100644 index 00000000..1e59674f --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/TryGetScriptFieldValue.md @@ -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) diff --git a/docs/api/XCEngine/Scripting/ScriptEngine/TrySetScriptFieldValue.md b/docs/api/XCEngine/Scripting/ScriptEngine/TrySetScriptFieldValue.md new file mode 100644 index 00000000..222b6020 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptEngine/TrySetScriptFieldValue.md @@ -0,0 +1,40 @@ +# ScriptEngine::TrySetScriptFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptEngine.h` + +## 签名 + +```cpp +bool TrySetScriptFieldValue( + ScriptComponent* component, + const std::string& fieldName, + ScriptFieldType type, + const ScriptFieldValue& value); +``` + +## 当前实现流程 + +1. 先拒绝空组件、空字段名或类型/值不兼容的请求。 +2. 如果组件已绑定脚本类，并且运行时能返回类字段元数据： + - 字段必须存在。 + - 字段类型必须完全匹配。 +3. 如果当前运行时正在运行，且组件已有实例： + - 先尝试写托管字段。 + - 托管写失败则整体失败。 +4. 托管写通过后，再写入 `ScriptFieldStorage`。 + +## 设计意义 + +当前实现坚持“先过元数据校验，再写活实例，最后更新本地缓存”这条顺序。这样可以避免： + +- 向不存在的托管字段写脏数据。 +- 运行时值与本地缓存不一致。 + +## 相关文档 + +- [TryGetScriptFieldValue](TryGetScriptFieldValue.md) +- [TryGetScriptFieldModel](TryGetScriptFieldModel.md) diff --git a/docs/api/XCEngine/Scripting/ScriptField/CreateDefaultScriptFieldValue.md b/docs/api/XCEngine/Scripting/ScriptField/CreateDefaultScriptFieldValue.md new file mode 100644 index 00000000..b717994e --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptField/CreateDefaultScriptFieldValue.md @@ -0,0 +1,27 @@ +# CreateDefaultScriptFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `function` + +**头文件**: `XCEngine/Scripting/ScriptField.h` + +## 签名 + +```cpp +ScriptFieldValue CreateDefaultScriptFieldValue(ScriptFieldType type); +``` + +## 当前实现行为 + +为每种支持类型返回一个显式默认值，例如： + +- 数值类型返回 `0` +- `Bool` 返回 `false` +- `String` 返回空字符串 +- 向量返回 `Zero()` +- `GameObject` 返回 UUID 为 `0` 的引用 + +## 相关文档 + +- [IsScriptFieldValueCompatible](IsScriptFieldValueCompatible.md) diff --git a/docs/api/XCEngine/Scripting/ScriptField/EscapeScriptString.md b/docs/api/XCEngine/Scripting/ScriptField/EscapeScriptString.md new file mode 100644 index 00000000..dcf20533 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptField/EscapeScriptString.md @@ -0,0 +1,25 @@ +# EscapeScriptString + +**命名空间**: `XCEngine::Scripting` + +**类型**: `function` + +**头文件**: `XCEngine/Scripting/ScriptField.h` + +## 签名 + +```cpp +std::string EscapeScriptString(const std::string& value); +``` + +## 当前实现行为 + +对非安全字符做 `%XX` 百分号编码。当前视为安全的字符包括字母数字、`_ - . /` 和空格。 + +## 用途 + +用于脚本组件和字段存储的私有文本序列化格式，避免 `= ; |` 等分隔符破坏解析。 + +## 相关文档 + +- [UnescapeScriptString](UnescapeScriptString.md) diff --git a/docs/api/XCEngine/Scripting/ScriptField/IsScriptFieldValueCompatible.md b/docs/api/XCEngine/Scripting/ScriptField/IsScriptFieldValueCompatible.md new file mode 100644 index 00000000..cd9d9227 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptField/IsScriptFieldValueCompatible.md @@ -0,0 +1,27 @@ +# IsScriptFieldValueCompatible + +**命名空间**: `XCEngine::Scripting` + +**类型**: `function` + +**头文件**: `XCEngine/Scripting/ScriptField.h` + +## 签名 + +```cpp +bool IsScriptFieldValueCompatible( + ScriptFieldType type, + const ScriptFieldValue& value); +``` + +## 当前实现行为 + +按 `std::variant` 当前持有的替代类型逐项匹配，不做自动转换。 + +## 含义 + +`Int32` 和 `UInt64`、`float` 和 `double` 等都被视为不同类型，必须显式匹配。 + +## 相关文档 + +- [CreateDefaultScriptFieldValue](CreateDefaultScriptFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/ScriptField/ScriptField.md b/docs/api/XCEngine/Scripting/ScriptField/ScriptField.md new file mode 100644 index 00000000..b3b9c9a5 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptField/ScriptField.md @@ -0,0 +1,75 @@ +# ScriptField + +**命名空间**: `XCEngine::Scripting` + +**类型**: `utility header` + +**头文件**: `XCEngine/Scripting/ScriptField.h` + +**描述**: 定义脚本字段类型系统、字段快照模型以及序列化/反序列化辅助函数。 + +## 概览 + +`ScriptField.h` 是当前脚本字段系统的核心协议头。它既定义“允许持久化哪些字段类型”，也定义“如何把字段值在文本、原生缓存和托管运行时之间搬运”。 + +## 公开类型 + +### ScriptFieldType + +当前支持： + +- `None` +- `Float` +- `Double` +- `Bool` +- `Int32` +- `UInt64` +- `String` +- `Vector2` +- `Vector3` +- `Vector4` +- `GameObject` + +### ScriptFieldValue + +当前是一个 `std::variant`，可持有： + +- `std::monostate` +- `float` +- `double` +- `bool` +- `int32_t` +- `uint64_t` +- `std::string` +- `Math::Vector2` +- `Math::Vector3` +- `Math::Vector4` +- `GameObjectReference` + +### ScriptFieldSnapshot / ScriptFieldModel + +它们用于字段面板、字段模型比对和“已声明字段 vs 已存储字段”诊断。`ScriptEngine::TryGetScriptFieldModel()` 会用到这组结构。 + +## 设计要点 + +- 字段类型集合是显式白名单，而不是任意模板反射。 +- 文本序列化逻辑集中在这个头对应的实现里，保证 `ScriptFieldStorage` 和脚本组件共用同一套规则。 +- `StoredOnly`、`TypeMismatch` 这类问题状态被直接编码进快照模型，便于编辑器或调试工具解释当前字段状态。 + +## 公开函数 + +| 函数 | 说明 | +|------|------| +| [ScriptFieldTypeToString](ScriptFieldTypeToString.md) | 枚举转字符串。 | +| [TryParseScriptFieldType](TryParseScriptFieldType.md) | 字符串转枚举。 | +| [IsScriptFieldValueCompatible](IsScriptFieldValueCompatible.md) | 判断类型和值是否兼容。 | +| [CreateDefaultScriptFieldValue](CreateDefaultScriptFieldValue.md) | 创建某个类型的默认值。 | +| [SerializeScriptFieldValue](SerializeScriptFieldValue.md) | 把字段值序列化成文本。 | +| [TryDeserializeScriptFieldValue](TryDeserializeScriptFieldValue.md) | 从文本恢复字段值。 | +| [EscapeScriptString](EscapeScriptString.md) | 转义脚本文本字符串。 | +| [UnescapeScriptString](UnescapeScriptString.md) | 反转义脚本文本字符串。 | + +## 相关文档 + +- [ScriptFieldStorage](../ScriptFieldStorage/ScriptFieldStorage.md) +- [ScriptEngine](../ScriptEngine/ScriptEngine.md) diff --git a/docs/api/XCEngine/Scripting/ScriptField/ScriptFieldTypeToString.md b/docs/api/XCEngine/Scripting/ScriptField/ScriptFieldTypeToString.md new file mode 100644 index 00000000..ad2c9156 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptField/ScriptFieldTypeToString.md @@ -0,0 +1,21 @@ +# ScriptFieldTypeToString + +**命名空间**: `XCEngine::Scripting` + +**类型**: `function` + +**头文件**: `XCEngine/Scripting/ScriptField.h` + +## 签名 + +```cpp +std::string ScriptFieldTypeToString(ScriptFieldType type); +``` + +## 当前实现行为 + +把 `ScriptFieldType` 枚举映射为稳定字符串，如 `Float`、`Vector3`、`GameObject`。未知值默认回退到 `None`。 + +## 相关文档 + +- [TryParseScriptFieldType](TryParseScriptFieldType.md) diff --git a/docs/api/XCEngine/Scripting/ScriptField/SerializeScriptFieldValue.md b/docs/api/XCEngine/Scripting/ScriptField/SerializeScriptFieldValue.md new file mode 100644 index 00000000..2d585bca --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptField/SerializeScriptFieldValue.md @@ -0,0 +1,28 @@ +# SerializeScriptFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `function` + +**头文件**: `XCEngine/Scripting/ScriptField.h` + +## 签名 + +```cpp +std::string SerializeScriptFieldValue( + ScriptFieldType type, + const ScriptFieldValue& value); +``` + +## 当前实现行为 + +- 先检查类型和值兼容。 +- 标量类型直接转文本。 +- `Bool` 序列化为 `1` 或 `0`。 +- 字符串先经过 `EscapeScriptString()`。 +- 向量序列化为逗号分隔文本。 +- `GameObject` 序列化为 UUID 数字文本。 + +## 相关文档 + +- [TryDeserializeScriptFieldValue](TryDeserializeScriptFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/ScriptField/TryDeserializeScriptFieldValue.md b/docs/api/XCEngine/Scripting/ScriptField/TryDeserializeScriptFieldValue.md new file mode 100644 index 00000000..876a73c7 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptField/TryDeserializeScriptFieldValue.md @@ -0,0 +1,28 @@ +# TryDeserializeScriptFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `function` + +**头文件**: `XCEngine/Scripting/ScriptField.h` + +## 签名 + +```cpp +bool TryDeserializeScriptFieldValue( + ScriptFieldType type, + const std::string& value, + ScriptFieldValue& outValue); +``` + +## 当前实现行为 + +- 数值类型通过标准库解析。 +- `Bool` 接受 `"1"`、`"true"`、`"True"` 作为真。 +- 向量支持逗号或空格分隔。 +- 字符串会先做 `UnescapeScriptString()`。 +- 解析异常统一返回 `false`。 + +## 相关文档 + +- [SerializeScriptFieldValue](SerializeScriptFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/ScriptField/TryParseScriptFieldType.md b/docs/api/XCEngine/Scripting/ScriptField/TryParseScriptFieldType.md new file mode 100644 index 00000000..dac529d9 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptField/TryParseScriptFieldType.md @@ -0,0 +1,23 @@ +# TryParseScriptFieldType + +**命名空间**: `XCEngine::Scripting` + +**类型**: `function` + +**头文件**: `XCEngine/Scripting/ScriptField.h` + +## 签名 + +```cpp +bool TryParseScriptFieldType( + const std::string& value, + ScriptFieldType& outType); +``` + +## 当前实现行为 + +只接受当前实现里硬编码支持的类型名；匹配失败返回 `false`。 + +## 相关文档 + +- [ScriptFieldTypeToString](ScriptFieldTypeToString.md) diff --git a/docs/api/XCEngine/Scripting/ScriptField/UnescapeScriptString.md b/docs/api/XCEngine/Scripting/ScriptField/UnescapeScriptString.md new file mode 100644 index 00000000..80fd8e9f --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptField/UnescapeScriptString.md @@ -0,0 +1,21 @@ +# UnescapeScriptString + +**命名空间**: `XCEngine::Scripting` + +**类型**: `function` + +**头文件**: `XCEngine/Scripting/ScriptField.h` + +## 签名 + +```cpp +std::string UnescapeScriptString(const std::string& value); +``` + +## 当前实现行为 + +把 `%XX` 形式的十六进制编码恢复成原字符；不合法的转义序列会按原样保留。 + +## 相关文档 + +- [EscapeScriptString](EscapeScriptString.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/Clear.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/Clear.md new file mode 100644 index 00000000..d97d9897 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/Clear.md @@ -0,0 +1,21 @@ +# ScriptFieldStorage::Clear + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +void Clear(); +``` + +## 当前实现行为 + +直接清空内部字段表。 + +## 相关文档 + +- [Remove](Remove.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/Contains.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/Contains.md new file mode 100644 index 00000000..d18f04fb --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/Contains.md @@ -0,0 +1,21 @@ +# ScriptFieldStorage::Contains + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +bool Contains(const std::string& fieldName) const; +``` + +## 当前实现行为 + +检查内部哈希表是否存在这个字段名。 + +## 相关文档 + +- [Remove](Remove.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/Deserialize.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/Deserialize.md new file mode 100644 index 00000000..6e785561 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/Deserialize.md @@ -0,0 +1,21 @@ +# ScriptFieldStorage::Deserialize + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +void Deserialize(std::istream& is); +``` + +## 当前实现行为 + +先把整个输入流读入字符串，再转交 [DeserializeFromString](DeserializeFromString.md)。 + +## 相关文档 + +- [Serialize](Serialize.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/DeserializeFromString.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/DeserializeFromString.md new file mode 100644 index 00000000..f4b53b03 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/DeserializeFromString.md @@ -0,0 +1,29 @@ +# ScriptFieldStorage::DeserializeFromString + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +void DeserializeFromString(const std::string& data); +``` + +## 当前实现行为 + +- 先清空已有字段。 +- 按行读取。 +- 只接受以 `field=` 开头的行。 +- 必须存在两个 `|` 分隔符。 +- 类型名解析失败或值解析失败时，该行会被跳过。 + +## 设计含义 + +当前恢复策略偏容错而不是强校验，更适合场景文件向前兼容和调试阶段手工修复。 + +## 相关文档 + +- [SerializeToString](SerializeToString.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/FindField.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/FindField.md new file mode 100644 index 00000000..164d54fa --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/FindField.md @@ -0,0 +1,22 @@ +# ScriptFieldStorage::FindField + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +const StoredScriptField* FindField(const std::string& fieldName) const; +StoredScriptField* FindField(const std::string& fieldName); +``` + +## 当前实现行为 + +按字段名在内部 `unordered_map` 里查找，找不到返回 `nullptr`。 + +## 相关文档 + +- [Contains](Contains.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/GetFieldCount.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/GetFieldCount.md new file mode 100644 index 00000000..b9edc691 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/GetFieldCount.md @@ -0,0 +1,21 @@ +# ScriptFieldStorage::GetFieldCount + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +size_t GetFieldCount() const; +``` + +## 当前实现行为 + +内联返回内部字段表元素数量。 + +## 相关文档 + +- [GetFieldNames](GetFieldNames.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/GetFieldNames.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/GetFieldNames.md new file mode 100644 index 00000000..f8f91b55 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/GetFieldNames.md @@ -0,0 +1,26 @@ +# ScriptFieldStorage::GetFieldNames + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +std::vector GetFieldNames() const; +``` + +## 当前实现行为 + +- 收集所有字段名。 +- 在返回前做字典序排序。 + +## 设计意义 + +这保证序列化输出顺序稳定，可重复，便于 diff 与测试。 + +## 相关文档 + +- [SerializeToString](SerializeToString.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/Remove.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/Remove.md new file mode 100644 index 00000000..37e949b6 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/Remove.md @@ -0,0 +1,22 @@ +# ScriptFieldStorage::Remove + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +bool Remove(const std::string& fieldName); +``` + +## 当前实现行为 + +删除成功返回 `true`，字段不存在返回 `false`。 + +## 相关文档 + +- [Contains](Contains.md) +- [Clear](Clear.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/ScriptFieldStorage.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/ScriptFieldStorage.md new file mode 100644 index 00000000..fa1c4578 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/ScriptFieldStorage.md @@ -0,0 +1,48 @@ +# ScriptFieldStorage + +**命名空间**: `XCEngine::Scripting` + +**类型**: `class` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +**描述**: 以字段名为键保存脚本字段值的本地缓存容器。 + +## 概览 + +`ScriptFieldStorage` 是当前脚本系统的数据缓冲层。它保存的不是“任意运行时变量”，而是需要在原生侧被识别、查询、序列化和可能回写的一组字段。 + +## 设计要点 + +- 用字段名映射到 `StoredScriptField`，读写简单直接。 +- 用模板 `SetFieldValue` / `TryGetFieldValue` 提供方便访问，同时保留显式类型版本。 +- `GetFieldNames()` 始终返回排序后的名字，保证序列化稳定性。 +- 反序列化会先清空旧数据，再导入新数据，避免旧字段残留。 + +## 当前实现边界 + +- 不是线程安全容器。 +- 不做类型自动转换。 +- 遇到非法反序列化行时会跳过，而不是抛异常中断整个恢复流程。 + +## 公开方法 + +| 方法 | 说明 | +|------|------| +| [SetFieldValue](SetFieldValue.md) | 写入字段。 | +| [TryGetFieldValue](TryGetFieldValue.md) | 读取字段。 | +| [FindField](FindField.md) | 按名称查找底层存储项。 | +| [Contains](Contains.md) | 判断字段是否存在。 | +| [Remove](Remove.md) | 删除字段。 | +| [Clear](Clear.md) | 清空所有字段。 | +| [GetFieldCount](GetFieldCount.md) | 返回字段数。 | +| [GetFieldNames](GetFieldNames.md) | 返回排序后的字段名列表。 | +| [SerializeToString](SerializeToString.md) | 序列化为文本。 | +| [DeserializeFromString](DeserializeFromString.md) | 从文本恢复。 | +| [Serialize](Serialize.md) | 写入输出流。 | +| [Deserialize](Deserialize.md) | 从输入流恢复。 | + +## 相关文档 + +- [ScriptField](../ScriptField/ScriptField.md) +- [ScriptComponent](../ScriptComponent/ScriptComponent.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/Serialize.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/Serialize.md new file mode 100644 index 00000000..1535d946 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/Serialize.md @@ -0,0 +1,21 @@ +# ScriptFieldStorage::Serialize + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +void Serialize(std::ostream& os) const; +``` + +## 当前实现行为 + +直接把 [SerializeToString](SerializeToString.md) 的结果写入输出流。 + +## 相关文档 + +- [Deserialize](Deserialize.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/SerializeToString.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/SerializeToString.md new file mode 100644 index 00000000..2aa9ff08 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/SerializeToString.md @@ -0,0 +1,27 @@ +# ScriptFieldStorage::SerializeToString + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +std::string SerializeToString() const; +``` + +## 当前实现行为 + +当前按逐行文本格式输出： + +```text +field=|| +``` + +字段顺序由 [GetFieldNames](GetFieldNames.md) 保证稳定。 + +## 相关文档 + +- [DeserializeFromString](DeserializeFromString.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/SetFieldValue.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/SetFieldValue.md new file mode 100644 index 00000000..a91336a0 --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/SetFieldValue.md @@ -0,0 +1,29 @@ +# ScriptFieldStorage::SetFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +template +bool SetFieldValue(const std::string& fieldName, const T& value); + +bool SetFieldValue( + const std::string& fieldName, + ScriptFieldType type, + const ScriptFieldValue& value); +``` + +## 当前实现行为 + +- 模板重载会先通过 `ScriptFieldTypeResolver` 推导类型。 +- 显式重载会拒绝空字段名或类型/值不兼容的输入。 +- 成功时覆盖或写入对应字段。 + +## 相关文档 + +- [TryGetFieldValue](TryGetFieldValue.md) diff --git a/docs/api/XCEngine/Scripting/ScriptFieldStorage/TryGetFieldValue.md b/docs/api/XCEngine/Scripting/ScriptFieldStorage/TryGetFieldValue.md new file mode 100644 index 00000000..05c52f0d --- /dev/null +++ b/docs/api/XCEngine/Scripting/ScriptFieldStorage/TryGetFieldValue.md @@ -0,0 +1,26 @@ +# ScriptFieldStorage::TryGetFieldValue + +**命名空间**: `XCEngine::Scripting` + +**类型**: `method` + +**头文件**: `XCEngine/Scripting/ScriptFieldStorage.h` + +## 签名 + +```cpp +template +bool TryGetFieldValue( + const std::string& fieldName, + T& outValue) const; +``` + +## 当前实现行为 + +- 先查字段。 +- 再检查底层 `variant` 当前持有的类型是否正好是 `T`。 +- 匹配成功才写 `outValue` 并返回 `true`。 + +## 相关文档 + +- [FindField](FindField.md) diff --git a/docs/api/XCEngine/Scripting/Scripting.md b/docs/api/XCEngine/Scripting/Scripting.md new file mode 100644 index 00000000..fe398dc1 --- /dev/null +++ b/docs/api/XCEngine/Scripting/Scripting.md @@ -0,0 +1,60 @@ +# Scripting + +**命名空间**: `XCEngine::Scripting` + +**类型**: `module` + +**描述**: 提供脚本组件数据模型、运行时调度器、字段序列化系统以及托管脚本后端抽象。 + +## 概览 + +`XCEngine::Scripting` 当前已经形成了一条比较清晰的运行链路： + +1. [ScriptComponent](ScriptComponent/ScriptComponent.md) 挂在 `GameObject` 上，保存脚本类绑定和序列化字段。 +2. [ScriptEngine](ScriptEngine/ScriptEngine.md) 在场景运行时追踪这些组件，管理实例创建、生命周期调用和字段同步。 +3. [IScriptRuntime](IScriptRuntime/IScriptRuntime.md) 定义脚本后端必须实现的统一桥接接口。 +4. [NullScriptRuntime](NullScriptRuntime/NullScriptRuntime.md) 提供无托管环境时的空实现兜底。 +5. [Mono](Mono/Mono.md) 子目录里的 [MonoScriptRuntime](Mono/MonoScriptRuntime/MonoScriptRuntime.md) 则是当前真正可运行的托管后端。 + +如果从 Unity 的经验去理解，这一层大致对应： + +- `ScriptComponent` 类似挂在对象上的脚本实例槽位。 +- `ScriptEngine` 类似引擎内部的脚本生命周期调度器。 +- `MonoScriptRuntime` 则像 C++ 引擎层和托管 `MonoBehaviour` 世界之间的桥梁。 + +但当前实现仍然比成熟商业引擎轻很多，文档必须明确区分“已经成立的真实行为”和“未来可能扩展的方向”。 + +## 设计要点 + +- 把“脚本绑定数据”和“具体托管后端”拆开，可以让场景序列化不依赖 Mono。 +- `ScriptFieldStorage` 作为本地缓存，使脚本字段在无运行时、运行时和场景序列化三种状态间都能有统一落点。 +- `IScriptRuntime` 让引擎主流程只依赖抽象接口，方便以后接入别的脚本后端。 +- `ScriptEngine` 集中处理生命周期顺序，这比让各组件自己直接碰运行时更容易保证一致性。 + +## 当前实现边界 + +- 当前公开支持的脚本字段类型是有限集合：标量、字符串、`Vector2/3/4` 和 `GameObject` 引用。 +- 生命周期覆盖 `Awake / OnEnable / Start / FixedUpdate / Update / LateUpdate / OnDisable / OnDestroy`。 +- `NullScriptRuntime` 只是桥接占位，不会真正执行脚本代码。 +- `MonoScriptRuntime` 当前围绕单个活动场景工作，还没有做域热重载、程序集增量刷新或完整编辑器脚本生态。 + +## 头文件 + +- [IScriptRuntime](IScriptRuntime/IScriptRuntime.md) - `IScriptRuntime.h` +- [NullScriptRuntime](NullScriptRuntime/NullScriptRuntime.md) - `NullScriptRuntime.h` +- [ScriptComponent](ScriptComponent/ScriptComponent.md) - `ScriptComponent.h` +- [ScriptEngine](ScriptEngine/ScriptEngine.md) - `ScriptEngine.h` +- [ScriptField](ScriptField/ScriptField.md) - `ScriptField.h` +- [ScriptFieldStorage](ScriptFieldStorage/ScriptFieldStorage.md) - `ScriptFieldStorage.h` +- [Mono](Mono/Mono.md) - `Mono/` + +## 相关指南 + +- [Scripting Runtime And Field Model](../../_guides/Scripting/Scripting-Runtime-And-Field-Model.md) - 解释当前脚本系统如何把场景、脚本字段缓存和 Mono 运行时衔接起来，以及为什么这样设计。 + +## 相关文档 + +- [SceneRuntime](../Scene/SceneRuntime/SceneRuntime.md) +- [Scene](../Scene/Scene.md) +- [上级目录](../XCEngine.md) +- [API 总索引](../../main.md) diff --git a/docs/api/XCEngine/XCEngine.md b/docs/api/XCEngine/XCEngine.md index 6629c7fb..52bf8aaf 100644 --- a/docs/api/XCEngine/XCEngine.md +++ b/docs/api/XCEngine/XCEngine.md @@ -1,16 +1,25 @@ -# XCEngine API 平行目录 +# XCEngine **命名空间**: `XCEngine` **类型**: `module-root` -**描述**: 以 `XCEngine` 为统一入口的 API 文档根目录；主体与 `engine/include/XCEngine` 平行，同时承载独立编辑器应用 `editor/src` 的 `Editor` API 文档。 +**描述**: `XCEngine` public API 的根目录入口，对齐 `engine/include/XCEngine` 的源码模块结构。 ## 概览 -该目录的主体与 `engine/include/XCEngine` 对应的 public headers 保持平行，用于承载唯一的 canonical API 文档入口。 +`docs/api/XCEngine` 是当前唯一的 canonical API 文档树。它和 `engine/include/XCEngine` 保持平行目录结构，用来回答两类问题： -额外地，当前也在这里统一收纳了 [Editor](Editor/Editor.md) 应用层文档，用于描述独立编辑器程序 `editor/src/**` 的 API 与架构。 +- 这个模块在引擎里负责什么，边界在哪里。 +- 这个 public header 在当前版本里到底做到了什么程度。 + +同时，这里也统一收纳编辑器侧 API 文档入口 [Editor](Editor/Editor.md)，用于描述与引擎并行协作的编辑器应用层接口。 + +## 设计原则 + +- 目录结构与源码平行，避免“文档是一套世界，源码又是一套世界”。 +- 类型页聚焦契约、生命周期和当前真实行为。 +- `_guides` 负责教程、设计理念和工作流解释，不再维护第二套 API 树。 ## 子目录 @@ -26,6 +35,7 @@ - [Rendering](Rendering/Rendering.md) - [Resources](Resources/Resources.md) - [Scene](Scene/Scene.md) +- [Scripting](Scripting/Scripting.md) - [Threading](Threading/Threading.md) ## 相关文档 diff --git a/docs/api/_guides/Scripting/Scripting-Runtime-And-Field-Model.md b/docs/api/_guides/Scripting/Scripting-Runtime-And-Field-Model.md new file mode 100644 index 00000000..e6e98cff --- /dev/null +++ b/docs/api/_guides/Scripting/Scripting-Runtime-And-Field-Model.md @@ -0,0 +1,132 @@ +# Scripting Runtime And Field Model + +## 这份指南解决什么问题 + +只看单个 API 页，很难一下子理解当前脚本系统为什么同时存在： + +- `ScriptComponent` +- `ScriptFieldStorage` +- `ScriptEngine` +- `IScriptRuntime` +- `MonoScriptRuntime` + +这份指南的目标，是把它们放回同一条真实运行链路里解释清楚。 + +## 一句话理解当前架构 + +当前脚本系统采用的是“原生场景数据层 + 运行时调度层 + 可替换托管后端”三段式设计： + +1. 场景和对象层只保存脚本绑定与字段缓存。 +2. `ScriptEngine` 负责生命周期和实例追踪。 +3. 具体脚本代码执行交给 `IScriptRuntime` 的实现，当前实现是 `MonoScriptRuntime`。 + +这种分层和商业引擎里常见的脚本体系很接近。它的核心收益，不是“代码显得更抽象”，而是让三个原本会互相缠死的问题被拆开： + +- 场景序列化 +- 运行时生命周期 +- 托管语言桥接 + +## 为什么 `ScriptComponent` 不直接等于“脚本实例” + +很多用户第一反应会是：既然组件名叫 `ScriptComponent`，为什么它不自己持有托管对象？ + +原因很现实： + +- 场景在未运行时也需要保存脚本绑定信息。 +- 场景加载、复制、序列化、反序列化时，不应该强依赖 Mono 已经初始化。 +- 编辑器或工具链可能只想改字段，不想真正启动托管运行时。 + +所以当前 `ScriptComponent` 更像“脚本实例描述与持久化容器”，而不是托管对象本身。真正的托管实例是在运行期由 `ScriptEngine + IScriptRuntime` 动态创建的。 + +## 为什么还要有 `ScriptFieldStorage` + +`ScriptFieldStorage` 的存在，是为了让脚本字段有一个不依赖托管运行时的落点。它解决了三类问题： + +- 场景序列化时，字段值需要写进文本数据。 +- 运行前，用户仍然需要能编辑脚本字段默认值。 +- 运行中，托管对象的字段变化需要有机会回写到本地缓存。 + +这和 Unity Inspector 里的“脚本字段序列化层”在理念上很接近，但当前实现更轻量，也更直接。 + +## 当前生命周期是怎么串起来的 + +真实顺序如下： + +1. `SceneRuntime::Start()` 调用 `ScriptEngine::OnRuntimeStart(scene)`。 +2. `ScriptEngine` 收集场景里的 `ScriptComponent`。 +3. 对满足运行条件的组件，调用运行时 `CreateScriptInstance()`。 +4. 然后按顺序补发 `Awake`、`OnEnable`。 +5. 第一次 `OnUpdate()` 前，会先补发一次 `Start`。 +6. 每个生命周期调用后，运行时会把托管字段同步回 `ScriptFieldStorage`。 +7. 停止运行时，按 `OnDisable -> OnDestroy -> DestroyScriptInstance` 回收。 + +这里最关键的一点，是当前引擎把生命周期顺序集中收口在 `ScriptEngine`，而不是让 Mono 运行时自己决定。这样未来即便更换脚本后端，生命周期语义仍然可以保持一致。 + +## `IScriptRuntime` 的真正意义 + +`IScriptRuntime` 不是为了“为了抽象而抽象”。它解决的是一个很实际的问题： + +- 引擎主流程需要操心“什么时候创建实例、什么时候调用生命周期、字段怎么读写”。 +- 但它不应该知道 Mono API、GCHandle、程序集加载这些实现细节。 + +因此 `IScriptRuntime` 只暴露引擎真正关心的契约： + +- 运行时启停 +- 类字段元数据查询 +- 托管字段读写 +- 实例创建/销毁 +- 生命周期方法调用 + +这样 `ScriptEngine` 才能成为“脚本系统总调度器”，而不是某个具体运行时的包装类。 + +## 当前 Mono 方案做到了哪一步 + +`MonoScriptRuntime` 当前已经具备以下实际能力： + +- 初始化 Mono 域并加载核心/游戏程序集。 +- 发现继承 `MonoBehaviour` 的非抽象脚本类。 +- 枚举支持类型的公共实例字段。 +- 创建托管实例，并注入 `GameObject` / `ScriptComponent` 上下文。 +- 通过 internal call 桥接基础引擎 API。 +- 生命周期调用后把已存储字段同步回本地缓存。 + +但也要明确它还没有做到什么： + +- 没有热重载和程序集增量刷新。 +- 没有完整的脚本调试器集成。 +- 没有更细的域隔离和编辑器运行时分层。 +- `SyncManagedFieldsToStorage()` 当前只回写“本地已经存在的字段”，不会自动持久化运行时临时新增字段。 + +## 为什么字段同步策略这么保守 + +当前字段同步只回写 `ScriptFieldStorage` 里已经存在且类型匹配的字段。这种设计看上去保守，但它有明确好处： + +- 不会因为运行时临时字段把场景数据层污染得越来越不可控。 +- 可以保住“场景里声明了哪些持久化字段”这条边界。 +- 对编辑器和序列化格式更安全。 + +代价也很明显： + +- 运行中动态产生的临时计数器、缓存值，不会自动进场景。 +- 如果字段类型改了，系统会把它标成 mismatch，而不是偷偷帮你转换。 + +这是一种更偏工程安全的选择。 + +## 推荐阅读顺序 + +如果你第一次接触这个模块，建议按下面顺序看： + +1. [Scripting](../../XCEngine/Scripting/Scripting.md) +2. [ScriptComponent](../../XCEngine/Scripting/ScriptComponent/ScriptComponent.md) +3. [ScriptField](../../XCEngine/Scripting/ScriptField/ScriptField.md) +4. [ScriptFieldStorage](../../XCEngine/Scripting/ScriptFieldStorage/ScriptFieldStorage.md) +5. [ScriptEngine](../../XCEngine/Scripting/ScriptEngine/ScriptEngine.md) +6. [IScriptRuntime](../../XCEngine/Scripting/IScriptRuntime/IScriptRuntime.md) +7. [MonoScriptRuntime](../../XCEngine/Scripting/Mono/MonoScriptRuntime/MonoScriptRuntime.md) + +## 相关 API + +- [SceneRuntime](../../XCEngine/Scene/SceneRuntime/SceneRuntime.md) +- [ScriptComponent](../../XCEngine/Scripting/ScriptComponent/ScriptComponent.md) +- [ScriptEngine](../../XCEngine/Scripting/ScriptEngine/ScriptEngine.md) +- [MonoScriptRuntime](../../XCEngine/Scripting/Mono/MonoScriptRuntime/MonoScriptRuntime.md)