Skip to content

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机器初筛:接口名没有出现在源码解析目录。

这个快照只做覆盖追踪,不代表最终质量判断。后续补文档时,应优先把“部分覆盖”和“未覆盖”项收敛为可链接的源码专题。

高优先级缺口

优先级缺口建议新增专题
P2client/KBEngineresetPassword / bindAccountEmail / newPassword 在核心 client_lib 的直注册入口边界client-login-and-space-data-api.md 补充段

baseapp/Entity

API 页面:docs/api/kbengine/baseapp/Entity.md

状态接口源码解析落点 / 缺口
已深入解析createCellEntity, onGetCell实体系统:Base -> Cell 交接
已深入解析fireEvent, registerEvent, deregisterEvent事件系统
已深入解析addTimer, delTimer, onTimerBase 实体生命周期
已深入解析destroy, onDestroyBase 实体生命周期
已深入解析writeToDB, onWriteToDB, onRestore, onPreArchiveBase 实体生命周期持久化与数据库
已深入解析createCellEntityInNewSpace, destroyCellEntity, onCreateCellFailure, onLoseCellBase 实体生命周期
已深入解析getComponentBase 实体生命周期

baseapp/KBEngine

API 页面:docs/api/kbengine/baseapp/KBEngine.md

状态接口源码解析落点 / 缺口
已深入解析baseAppData, globalData, onBaseAppData, onGlobalData全局数据同步链
已深入解析createEntity, createEntityLocally, createEntityAnywhere, createEntityRemotely, createEntityFromDBID, createEntityAnywhereFromDBID, createEntityRemotelyFromDBID, deleteEntityByDBID, lookUpEntityByDBIDBaseApp 运行时 API
已深入解析MemoryStreamBaseApp 运行时 API
已深入解析getResFullPath, hasRes, listPathRes, matchPath, open通用运行时工具 API
已深入解析publish, reloadScript, scriptLogType, time, onInit, onBaseAppReady, onReadyForLogin, onReadyForShutDown, onBaseAppShutDown, onCellAppDeath, onAutoLoadEntityCreateBaseApp 运行时 API
已深入解析addWatcher, delWatcher, getWatcher, getWatcherDir通用运行时工具 API
已深入解析address, debugTracing, getAppFlags, setAppFlags, isShuttingDown, genUUID64通用运行时工具 API
已深入解析quantumPassedPercentBaseApp 运行时 API
已深入解析charge, onLoseChargeCBBaseApp 运行时 API
已深入解析executeRawDatabaseCommandBaseApp 运行时 API
已深入解析registerReadFileDescriptor, registerWriteFileDescriptor, deregisterReadFileDescriptor, deregisterWriteFileDescriptor通用运行时工具 API
已深入解析urlopen通用运行时工具 API
已深入解析onBaseAppDataDel, onGlobalDataDel全局数据同步链
已深入解析onFiniBaseApp 运行时 API 已说明:当前源码树未查到明确触发点,实际可追关闭链是 onReadyForShutDownonBaseAppShutDown(state)

baseapp/Proxy

API 页面:docs/api/kbengine/baseapp/Proxy.md

状态接口源码解析落点 / 缺口
已深入解析giveClientTo, onClientEnabledProxy.giveClientTo 客户端迁移链
已深入解析getClientType, disconnect, getClientDatas, streamFileToClient, streamStringToClient, onClientDeath, onClientGetCell, onGiveClientToFailure, onLogOnAttempt, onStreamCompleteProxy 会话与流式传输 API

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

状态接口源码解析落点 / 缺口
已深入解析addTimer, delTimer, onTimerCell 实体定时器
已深入解析moveToPoint, moveToEntity, navigate, navigatePathPoints, cancelControllerCell 移动控制器链
已深入解析fireEvent, registerEvent, deregisterEvent事件系统
已深入解析onEnterTrap, onEnteredView, onLeaveTrap, onLoseControlledBy, onMove, onMoveOver, onMoveFailure, onSpaceGone, onTurn, onTeleport, onTeleportFailure, onTeleportSuccess, onUpdateBegin, onUpdateEnd, onWitnessedCell Entity 回调触发点矩阵
已深入解析setViewRadius, getViewRadius, getViewHystArea, entitiesInView, getWitnessesWitness 运行态 API
已深入解析canNavigate, destroySpace, debugView, entitiesInRange, getRandomPoints空间运行态 API
已深入解析accelerate, getComponent控制器调速与组件访问 API
已深入解析clientEntity, isReal, onGetWitness, onLoseWitnessWitness 运行态 API
已深入解析destroy, onDestroyCell 销毁与摘链
已深入解析onRestore, onWriteToDB, writeToDB持久化与数据库
已深入解析addYawRotator, addProximity, teleport控制器调速与组件访问 APICell Entity 回调触发点矩阵

cellapp/KBEngine

API 页面:docs/api/kbengine/cellapp/KBEngine.md

状态接口源码解析落点 / 缺口
已深入解析cellAppData, globalData, onCellAppData, onGlobalData全局数据同步链
已深入解析MemoryStream, createEntity, publish, reloadScript, scriptLogType, time, onInit, onSpaceData, onSpaceGeometryLoaded, onAllSpaceGeometryLoadedCellApp 空间运行时 API
已深入解析getResFullPath, hasRes, listPathRes, matchPath, open通用运行时工具 API
已深入解析addSpaceGeometryMapping, delSpaceData, getSpaceData, getSpaceGeometryMapping, setSpaceDataCellApp 空间运行时 API
已深入解析addWatcher, delWatcher, getWatcher, getWatcherDir通用运行时工具 API
已深入解析address, debugTracing, getAppFlags, setAppFlags, isShuttingDown, genUUID64通用运行时工具 API
已深入解析executeRawDatabaseCommand, raycastCellApp 空间运行时 API
已深入解析urlopen通用运行时工具 API
已深入解析registerReadFileDescriptor, registerWriteFileDescriptor, deregisterReadFileDescriptor, deregisterWriteFileDescriptor通用运行时工具 API
已深入解析onCellAppDataDel, onGlobalDataDel, onReadyForLoginCellApp 空间运行时 API

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

状态接口源码解析落点 / 缺口
已深入解析accountLoginResponse, createAccountResponse, chargeResponse, executeRawDatabaseCommand, onInterfaceAppReady, onInterfaceAppShutDown, onRequestCreateAccount, onRequestAccountLogin, onRequestCharge组件型脚本 API
已深入解析addTimer, delTimer, urlopen通用运行时工具 API

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

状态接口源码解析落点 / 缺口
已深入解析onLoginAppReady, onLoginAppShutDown, onRequestLogin, onLoginCallbackFromDB, onRequestCreateAccount, onCreateAccountCallbackFromDB组件型脚本 API
已深入解析addTimer, delTimer, urlopen通用运行时工具 API

关键词与基础类型

API 页面:docs/api/kbengine/keywords.mddocs/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 原文、不值得展开源码专题,也应在本页标注原因,避免重复排查。