docs: expand gameobject helper docs

This commit is contained in:
2026-04-03 16:11:48 +08:00
parent ee44e14960
commit 2c2e1fab1c
34 changed files with 597 additions and 603 deletions

View File

@@ -1,30 +1,27 @@
# GameObject::GetName
获取相关状态或对象
返回当前对象名称
```cpp
const std::string& GetName() const;
```
该方法声明于 `XCEngine/Components/GameObject.h`,当前页面用于固定 `GameObject` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:**
这个接口直接返回底层 `m_name` 的只读引用
**返回:** `const std::string&` - 返回值语义详见头文件声明。
按当前实现:
**示例:**
- 默认构造名称是 `"GameObject"`
- 带参构造会把名字初始化为传入值
- [SetName](SetName.md) 直接改写这个字段
- [Find](Find.md) 每次查询时都会读取当前名字
```cpp
#include <XCEngine/Components/GameObject.h>
## 返回值
void Example() {
XCEngine::Components::GameObject object;
// 根据上下文补齐参数后调用 GameObject::GetName(...)。
(void)object;
}
```
- `const std::string&` - 当前对象名的只读引用。
## 相关文档
- [返回类总览](GameObject.md)
- [返回模块目录](../Components.md)
- [SetName](SetName.md)
- [Find](Find.md)