docs: rebuild Scene API content
This commit is contained in:
@@ -1,30 +1,24 @@
|
||||
# SceneManager::GetAllScenes
|
||||
|
||||
获取相关状态或对象。
|
||||
获取全部已登记场景。
|
||||
|
||||
```cpp
|
||||
std::vector<Scene*> GetAllScenes() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Scene/SceneManager.h`,当前页面用于固定 `SceneManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现会遍历 `m_scenes`,把每个 `unique_ptr<Scene>` 的裸指针收集到结果数组中返回。
|
||||
|
||||
**返回:** `std::vector<Scene*>` - 返回值语义详见头文件声明。
|
||||
## 返回值
|
||||
|
||||
**示例:**
|
||||
- `std::vector<Scene*>` - 所有已登记场景的非拥有指针数组。
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Scene/SceneManager.h>
|
||||
## 注意事项
|
||||
|
||||
void Example() {
|
||||
XCEngine::Components::SceneManager object;
|
||||
// 根据上下文补齐参数后调用 SceneManager::GetAllScenes(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 返回顺序取决于 `std::unordered_map` 的迭代顺序,不应把它当作稳定顺序。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](SceneManager.md)
|
||||
- [返回模块目录](../Scene.md)
|
||||
- [返回类型总览](SceneManager.md)
|
||||
- [GetScene](GetScene.md)
|
||||
|
||||
Reference in New Issue
Block a user