docs(scripting): add baseline api reference and guide
This commit is contained in:
31
docs/api/XCEngine/Scripting/IScriptRuntime/OnRuntimeStart.md
Normal file
31
docs/api/XCEngine/Scripting/IScriptRuntime/OnRuntimeStart.md
Normal file
@@ -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)
|
||||
Reference in New Issue
Block a user