docs: 更新 API 文档 - 多模块修复和完善
- audio: 更新 audio-system 方法文档 - components: 新增 audio-listener/audio-source 组件方法文档,新增 remove-component 方法 - core: 更新 filewriter, types 文档 - math: 更新 box 方法文档 - memory: 更新 proxy-allocator 文档 - resources: 更新 loader 和 texture 文档 - rhi: 更新 opengl 设备、shader、swap-chain 文档 - threading: 更新 mutex 和 task-system 文档
This commit is contained in:
@@ -42,6 +42,7 @@ GameObject 是 XCEngine ECS 架构中的实体(Entity)类,代表游戏世
|
||||
| [`GetComponentInChildren`](get-component-in-children.md) | 在子对象中查找组件 |
|
||||
| [`GetComponentInParent`](get-component-in-parent.md) | 在父对象中查找组件 |
|
||||
| [`GetComponentsInChildren`](get-components-in-children.md) | 获取所有子对象的指定组件 |
|
||||
| [`RemoveComponent`](remove-component.md) | 移除组件(模板方法) |
|
||||
|
||||
### 层级结构
|
||||
|
||||
|
||||
26
docs/api/components/game-object/remove-component.md
Normal file
26
docs/api/components/game-object/remove-component.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# GameObject::RemoveComponent
|
||||
|
||||
移除指定类型的组件。
|
||||
|
||||
```cpp
|
||||
template<typename T>
|
||||
void RemoveComponent();
|
||||
|
||||
bool RemoveComponent(Component* component);
|
||||
```
|
||||
|
||||
模板版本根据类型移除组件,参数版本根据指针移除具体组件实例。TransformComponent 无法被移除。
|
||||
|
||||
**模板参数:**
|
||||
- `T` - 组件类型
|
||||
|
||||
**参数:**
|
||||
- `component` - 要移除的组件指针
|
||||
|
||||
**返回:** `bool` - 对于指针版本,如果成功移除则返回 true
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [GameObject 总览](game-object.md)
|
||||
- [AddComponent](add-component.md)
|
||||
- [GetComponent](get-component.md)
|
||||
Reference in New Issue
Block a user