Appearance
API 到源码解析覆盖矩阵
这一页用于追踪 KBEngine API 中的接口是否已经在源码解析中展开。KBEngine API 入口是
docs/api/kbengine/**。KBEngine API 仍保持和 CHM 一致,只在确认原文或迁移错误时修正;源码解析页引用 API 作为接口契约,再解释实现、调用链和运行时边界。
状态定义
| 状态 | 含义 |
|---|---|
| 已深入解析 | 已有专题段落,能说明源码入口、关键对象、调用链和边界。 |
| 部分覆盖 | 在主线中出现过,或解释了所属机制,但还没有逐接口源码走读。 |
| 未覆盖 | 当前源码解析目录还没有解释该 API 的实现或调用链。 |
当前矩阵按 API 文件维度维护。重复 API 名按所在文件分别统计,因为同名接口在不同组件里的语义可能不同。
总体快照
| 范围 | 数量 | 说明 |
|---|---|---|
| API 函数条目 | 255 | 来自 docs/api/kbengine/** 的 ### def ... 标题,不含索引页、审计页和 CHM 文件。 |
| 显式提及条目 | 121 | 机器初筛:接口名在 docs/architecture/source-analysis/** 中出现。 |
| 未显式提及条目 | 134 | 机器初筛:接口名没有出现在源码解析目录。 |
这个快照只做覆盖追踪,不代表最终质量判断。后续补文档时,应优先把“部分覆盖”和“未覆盖”项收敛为可链接的源码专题。
高优先级缺口
| 优先级 | 缺口 | 建议新增专题 |
|---|---|---|
| P2 | client/KBEngine 的 resetPassword / bindAccountEmail / newPassword 在核心 client_lib 的直注册入口边界 | client-login-and-space-data-api.md 补充段 |
baseapp/Entity
API 页面:docs/api/kbengine/baseapp/Entity.md
baseapp/KBEngine
API 页面:docs/api/kbengine/baseapp/KBEngine.md
baseapp/Proxy
API 页面:docs/api/kbengine/baseapp/Proxy.md
bots/Entity
API 页面:docs/api/kbengine/bots/Entity.md
| 状态 | 接口 | 源码解析落点 / 缺口 |
|---|---|---|
| 已深入解析 | moveToPoint, cancelController, isPlayer, onEnterWorld, onLeaveWorld, onEnterSpace, onLeaveSpace | 客户端实体生命周期 与 客户端本地移动控制器 |
| 已深入解析 | fireEvent, registerEvent, deregisterEvent | 事件系统 |
| 已深入解析 | getComponent | 客户端登录、重登录与 SpaceData API |
bots/KBEngine
API 页面:docs/api/kbengine/bots/KBEngine.md
| 状态 | 接口 | 源码解析落点 / 缺口 |
|---|---|---|
| 已深入解析 | addBots, scriptLogType, onInit, onFinish | 组件型脚本 API |
| 已深入解析 | callback, cancelCallback, getWatcher, getWatcherDir, urlopen, genUUID64 | 通用运行时工具 API |
bots/PyClientApp
API 页面:docs/api/kbengine/bots/PyClientApp.md
| 状态 | 接口 | 源码解析落点 / 缺口 |
|---|---|---|
| 已深入解析 | player | 客户端句柄表 |
| 已深入解析 | getSpaceData | 客户端登录、重登录与 SpaceData API |
cellapp/Entity
API 页面:docs/api/kbengine/cellapp/Entity.md
cellapp/KBEngine
API 页面:docs/api/kbengine/cellapp/KBEngine.md
client/Entity
API 页面:docs/api/kbengine/client/Entity.md
| 状态 | 接口 | 源码解析落点 / 缺口 |
|---|---|---|
| 已深入解析 | baseCall, cellCall | 客户端远程调用链 |
| 已深入解析 | isPlayer, onEnterWorld, onLeaveWorld, onEnterSpace, onLeaveSpace | 客户端实体生命周期 |
| 已深入解析 | fireEvent, registerEvent, deregisterEvent | 事件系统 |
| 已深入解析 | onDestroy | 客户端登录、重登录与 SpaceData API |
| 已深入解析 | getComponent | 客户端登录、重登录与 SpaceData API |
client/KBEngine
API 页面:docs/api/kbengine/client/KBEngine.md
| 状态 | 接口 | 源码解析落点 / 缺口 |
|---|---|---|
| 已深入解析 | player, findEntity | 客户端句柄表 |
| 已深入解析 | login, reloginBaseapp | 客户端登录、重登录与 SpaceData API |
| 已深入解析 | createAccount, getSpaceData | 客户端登录、重登录与 SpaceData API |
| 部分覆盖 | resetPassword, bindAccountEmail, newPassword | 客户端登录、重登录与 SpaceData API 已解释服务端链、客户端回包与 SDK 模板对照,但当前核心 client_lib 里仍未看到直接 Python 模块注册点。 |
dbmgr/KBEngine
API 页面:docs/api/kbengine/dbmgr/KBEngine.md
| 状态 | 接口 | 源码解析落点 / 缺口 |
|---|---|---|
| 已深入解析 | executeRawDatabaseCommand, onDBMgrReady, onDBMgrShutDown, onReadyForShutDown, onSelectAccountDBInterface | 组件型脚本 API |
| 已深入解析 | addTimer, delTimer, urlopen | 通用运行时工具 API |
interfaces/KBEngine
API 页面:docs/api/kbengine/interfaces/KBEngine.md
logger/KBEngine
API 页面:docs/api/kbengine/logger/KBEngine.md
| 状态 | 接口 | 源码解析落点 / 缺口 |
|---|---|---|
| 已深入解析 | onLoggerAppReady, onLoggerAppShutDown, onLogWrote, onReadyForShutDown | 组件型脚本 API |
| 已深入解析 | addTimer, delTimer, urlopen | 通用运行时工具 API |
loginapp/KBEngine
API 页面:docs/api/kbengine/loginapp/KBEngine.md
关键词与基础类型
API 页面:docs/api/kbengine/keywords.md、docs/api/kbengine/basetypes.md
| 状态 | 项目 | 源码解析落点 / 缺口 |
|---|---|---|
| 已深入解析 | EntityCall, entity, base, cell, client | 实体系统、网络与消息系统 |
| 已深入解析 | View, Witness, Space, real, ghost, cellapp, baseapp | 空间与 AOI、进程模型 |
| 已深入解析 | entities.xml, 基础数据类型, ENTITYCALL, .def 类型系统 | 类型系统与实体定义文件 |
| 已深入解析 | KBE_ROOT, KBE_RES_PATH, kbengine_defaults.xml, kbengine.xml, vector3 | 运行时配置与基础类型 |
| 已深入解析 | KBE_HYBRID_PATH | 运行时配置与基础类型 已说明:当前源码树未命中该名字,实际贯穿实现的是 KBE_BIN_PATH。 |
后续维护规则
- 新增源码解析专题时,应同步更新本页,把对应接口从“未覆盖”移动到“部分覆盖”或“已深入解析”。
- 若发现 KBEngine API 页与 CHM 不一致,只修
docs/api/kbengine/**的错误;不要在 API 页中扩写源码解析。 - 如果某个 API 只适合保留 CHM 原文、不值得展开源码专题,也应在本页标注原因,避免重复排查。
