docs: rebuild Scene API content

This commit is contained in:
2026-03-26 19:34:24 +08:00
parent dc252502ac
commit 5ca5ca1f19
40 changed files with 752 additions and 658 deletions

View File

@@ -1,31 +1,29 @@
# SceneManager::GetScene
获取相关状态或对象
按内部 key 获取场景
```cpp
Scene* GetScene(const std::string& name) const;
```
该方法声明于 `XCEngine/Scene/SceneManager.h`,当前页面用于固定 `SceneManager` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:**
- `name` - 参数语义详见头文件声明。
当前实现直接用 `name``m_scenes` 里做哈希表查找。
**返回:** `Scene*` - 返回值语义详见头文件声明。
## 参数
**示例:**
- `name` - 场景 key。
```cpp
#include <XCEngine/Scene/SceneManager.h>
## 返回值
void Example() {
XCEngine::Components::SceneManager object;
// 根据上下文补齐参数后调用 SceneManager::GetScene(...)。
(void)object;
}
```
- `Scene*` - 找到时返回场景指针;找不到时返回 `nullptr`
## 注意事项
- 这个 `name` 对于 [CreateScene](CreateScene.md) 来说是创建时传入的名称。
- 对于 [LoadScene](LoadScene.md) 来说,它是文件名 stem而不一定等于场景内部的 `Scene::GetName()`
## 相关文档
- [返回类总览](SceneManager.md)
- [返回模块目录](../Scene.md)
- [返回类总览](SceneManager.md)
- [LoadScene](LoadScene.md)