docs: rebuild Scene API content
This commit is contained in:
@@ -1,30 +1,26 @@
|
||||
# SceneManager::OnActiveSceneChanged
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
访问活动场景切换事件。
|
||||
|
||||
```cpp
|
||||
Core::Event<Scene*>& OnActiveSceneChanged();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Scene/SceneManager.h`,当前页面用于固定 `SceneManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前头文件内联实现直接返回 `m_onActiveSceneChanged` 的引用。
|
||||
|
||||
**返回:** `Core::Event<Scene*>&` - 返回值语义详见头文件声明。
|
||||
这个事件会在:
|
||||
|
||||
**示例:**
|
||||
- [SetActiveScene](SetActiveScene.md) 真正改变 `m_activeScene` 时触发。
|
||||
- [UnloadScene](UnloadScene.md) 卸载当前活动场景并自动选择新的后备场景时触发。
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Scene/SceneManager.h>
|
||||
## 返回值
|
||||
|
||||
void Example() {
|
||||
XCEngine::Components::SceneManager object;
|
||||
// 根据上下文补齐参数后调用 SceneManager::OnActiveSceneChanged(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- `Core::Event<Scene*>&` - 活动场景切换事件对象引用。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](SceneManager.md)
|
||||
- [返回模块目录](../Scene.md)
|
||||
- [返回类型总览](SceneManager.md)
|
||||
- [SetActiveScene](SetActiveScene.md)
|
||||
- [Event](../../Core/Event/Event.md)
|
||||
|
||||
Reference in New Issue
Block a user