Starry手册导览
从模块进入子模块与具体功能,查阅功能用途、配置步骤、技术架构和扩展方法。
本页内容6 节
按功能理解 Starry
Starry 是基于 Unreal Engine 5.8 开发的游戏项目。手册按模块组织内容:先选择要使用的系统,再进入子模块或具体功能,了解它解决什么问题、怎样配置、内部如何协作以及怎样扩展。
每个模块的入口先解释职责与组成,功能目录继续展开细分内容。使用步骤与技术架构围绕同一项功能编写;需要独立说明复杂机制时,也归在该功能所属层级下。
例如,AstraAI 的“行为执行”下包含 Logic 生命周期与树后端;Input 的“动作处理”下包含 Handler 分派、输入值修饰与触发规则。可以直接进入对应功能,不必先按全站文章顺序阅读。
当前已整理 AstraAI、HaloDebug、Input、Async Message System和 AsyncMixin。其他模块按实际功能持续补充,已有目录不代表项目全部能力。
查阅一项功能
以新增一个玩家动作为例:
- 从 Input 模块了解 Action、IMC、Setup 与 Controller 的接入关系。
- 进入“动作处理”的 Handler 与能力分派,选择事件和处理器。
- 需要在动画窗口中延迟执行时,再读“输入缓存”的通道输入缓存。
- 配置不生效时,进入同模块的调试与排查,沿实际输入链定位。
需要观察技能失败、背包或快捷栏事件时,从 Async Message System进入消息收发与项目接入;蓝图示例把监听、载荷解包、发送和停止直接画在正文中。
需要异步加载图标、控件类或主资产时,从 AsyncMixin进入资源加载与任务编排;软引用加载给出 C++ 组件示例,独立作用域说明多条任务怎样分别取消。
模块内的上一页与下一页遵循当前模块的功能目录。跨模块的协作通过正文链接与关联栏继续阅读。
围绕功能说明用法与机制
每项功能同时说明怎样使用、内部怎样运行,以及遇到问题时怎样排查。前置条件、配置入口、操作步骤与预期结果帮助动手,组件职责、数据流、执行顺序和生命周期帮助理解与扩展。参数或命令较多时,再补充明确的速查小节。
例如,组合与覆盖同时解释 Modifier 怎样编辑、后层怎样替换前层;Logic 生命周期围绕一次执行解释启动、取消与清理。内容按功能需要组织,不为不同阅读角度重复拆页。
工程分层与系统协作补充项目级的依赖方向与接入边界。具体系统的架构和使用方法从所属模块进入。
各功能页末尾给出实现入口,方便在工程中定位类型。示例资产名称需要自己创建;正文区分当前实现、操作示例与尚未接完的能力。
用目录查找,用图谱探索
左侧通过模块菜单切换系统,再按“子模块/功能分区 → 说明”展开,当前文章的完整路径显示在正文上方。手机通过“文档目录”展开同一棵目录树,右侧目录定位当前页的小节。按 Ctrl K 搜索标题、概念或正文中的 API 名称。
关系图谱根据文章里的实际阅读链接自动生成,节点颜色表示所属模块。全局图默认显示主模块,节点汇总文档数量,连线汇总跨模块阅读关联;也可以切换到“全部文章”。从模块节点或可搜索的模块菜单进入子图,再通过逐级展开的“分区”菜单选择整个功能或子分区。
选择文章节点后可以打开文章,或进入以它为中心的局部图。局部图保留相连的跨模块文章,返回时恢复原来的模块与功能范围。图谱的关联表示“这些文章可以一起读”,程序依赖和执行顺序由正文图表说明。
正文图表可以滚轮缩放、左键平移、适应画布或全屏查看。较长的流程先看完整图,再放大读分支,不需要把正文整页缩小。
查看真实蓝图节点
介绍蓝图用法的文章可以直接嵌入 UE 节点图,配合文字阅读执行连线、数据连接与参数。节点文本随文章保存,打开正文即可显示,支持平移与缩放。编写方式见在文档中说明蓝图用法。
自己修改内容
本地文章文件与网页编辑器修改同一份内容。日常只写正文、关系和必要图表,不为每一篇笔记重新做版式。具体操作与可复用模板见维护这本手册。