refactor api documentation structure
This commit is contained in:
66
docs/api/XCEngine/Components/GameObject/GameObject.md
Normal file
66
docs/api/XCEngine/Components/GameObject/GameObject.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# GameObject
|
||||
|
||||
**命名空间**: `XCEngine::Components`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Components/GameObject.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Components` 子目录中的 `GameObject` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`GameObject.h` 是 `XCEngine/Components` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `GameObject` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [GameObject()](Constructor.md) | 构造对象。 |
|
||||
| [~GameObject()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [GetID](GetID.md) | 获取相关状态或对象。 |
|
||||
| [GetUUID](GetUUID.md) | 获取相关状态或对象。 |
|
||||
| [GetName](GetName.md) | 获取相关状态或对象。 |
|
||||
| [SetName](SetName.md) | 设置相关状态或配置。 |
|
||||
| [DetachFromParent](DetachFromParent.md) | 公开方法,详见头文件声明。 |
|
||||
| [GetScene](GetScene.md) | 获取相关状态或对象。 |
|
||||
| [GetTransform](GetTransform.md) | 获取相关状态或对象。 |
|
||||
| [AddComponent](AddComponent.md) | 添加元素或建立关联。 |
|
||||
| [GetComponent](GetComponent.md) | 获取相关状态或对象。 |
|
||||
| [GetComponents](GetComponents.md) | 获取相关状态或对象。 |
|
||||
| [RemoveComponent](RemoveComponent.md) | 移除元素或解除关联。 |
|
||||
| [GetComponentInChildren](GetComponentInChildren.md) | 获取相关状态或对象。 |
|
||||
| [GetComponentInParent](GetComponentInParent.md) | 获取相关状态或对象。 |
|
||||
| [GetComponentsInChildren](GetComponentsInChildren.md) | 获取相关状态或对象。 |
|
||||
| [GetParent](GetParent.md) | 获取相关状态或对象。 |
|
||||
| [SetParent](SetParent.md) | 设置相关状态或配置。 |
|
||||
| [GetChildCount](GetChildCount.md) | 获取相关状态或对象。 |
|
||||
| [GetChild](GetChild.md) | 获取相关状态或对象。 |
|
||||
| [GetChildren](GetChildren.md) | 获取相关状态或对象。 |
|
||||
| [DetachChildren](DetachChildren.md) | 公开方法,详见头文件声明。 |
|
||||
| [IsActive](IsActive.md) | 查询当前状态。 |
|
||||
| [SetActive](SetActive.md) | 设置相关状态或配置。 |
|
||||
| [IsActiveInHierarchy](IsActiveInHierarchy.md) | 查询当前状态。 |
|
||||
| [Find](Find.md) | 查找并返回匹配对象。 |
|
||||
| [FindObjectsOfType](FindObjectsOfType.md) | 查找并返回匹配对象。 |
|
||||
| [FindGameObjectsWithTag](FindGameObjectsWithTag.md) | 查找并返回匹配对象。 |
|
||||
| [Awake](Awake.md) | 公开方法,详见头文件声明。 |
|
||||
| [Start](Start.md) | 公开方法,详见头文件声明。 |
|
||||
| [Update](Update.md) | 更新运行时状态。 |
|
||||
| [FixedUpdate](FixedUpdate.md) | 公开方法,详见头文件声明。 |
|
||||
| [LateUpdate](LateUpdate.md) | 公开方法,详见头文件声明。 |
|
||||
| [OnDestroy](OnDestroy.md) | 公开方法,详见头文件声明。 |
|
||||
| [Destroy](Destroy.md) | 公开方法,详见头文件声明。 |
|
||||
| [Serialize](Serialize.md) | 公开方法,详见头文件声明。 |
|
||||
| [Deserialize](Deserialize.md) | 公开方法,详见头文件声明。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Components.md) - 返回 `Components` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user