docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录 - 重命名 index.md 为 main.md - 修正所有模块文档中的错误: - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式 - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节 - core: 修复 types 链接错误 - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI - memory: 修复头文件路径, malloc vs operator new, 新增方法文档 - resources: 修复 Shader/Texture 链接错误 - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接 - 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
48
docs/api/core/event/Subscribe.md
Normal file
48
docs/api/core/event/Subscribe.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# Event::Subscribe
|
||||
|
||||
```cpp
|
||||
uint64_t Subscribe(Callback callback);
|
||||
```
|
||||
|
||||
订阅事件回调。
|
||||
|
||||
**描述**
|
||||
|
||||
将回调函数添加到事件订阅列表中,并返回一个唯一的订阅 ID。该 ID 可用于后续退订。线程安全,可在任意线程调用。
|
||||
|
||||
**参数:**
|
||||
- `callback` - 要订阅的回调函数,类型为 `std::function<void(Args...)>`
|
||||
|
||||
**返回:** `uint64_t` - 订阅 ID,用于退订
|
||||
|
||||
**复杂度:** O(1) amortized
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Core/Event.h>
|
||||
|
||||
// 定义事件
|
||||
Event<int, float> damageEvent;
|
||||
|
||||
// 订阅多个回调
|
||||
uint64_t id1 = damageEvent.Subscribe([](int damage, float time) {
|
||||
printf("Damage taken: %d at time %f\n", damage, time);
|
||||
});
|
||||
|
||||
uint64_t id2 = damageEvent.Subscribe([](int damage, float time) {
|
||||
// 记录伤害日志
|
||||
});
|
||||
|
||||
// 使用 lambda 表达式
|
||||
auto callback = [](int damage, float time) {
|
||||
// 处理伤害
|
||||
};
|
||||
uint64_t id3 = damageEvent.Subscribe(callback);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Event 总览](event.md) - 返回类总览
|
||||
- [Unsubscribe](Unsubscribe.md) - 退订事件
|
||||
- [Invoke](Invoke.md) - 触发事件
|
||||
Reference in New Issue
Block a user