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