Skip to content

SE UGC Lua 作者文档

面向新晋作者的 SE UGC Lua 系列教程。

面向用过蛋仔编辑器、准备第一次用 Lua 组织完整玩法的新晋作者。本目录是最终正文的 Markdown 交付版,只包含作者学习所需的章节。即使你还没有 Lua 基础,也可以先读第 0 章的最小语法词典,再按主线边做边学;不需要先完整学完一门语言才开始。

第一次打开时怎么做

如果你不知道从哪里开始,先只完成这四步:

  1. 阅读第 0 章,写出自己的 editor / server / client / data 分工草表。
  2. 按第 1 章生成工程,只保留最小 client/server 日志,确认两端都运行。
  3. 在测试地图放置并命名“球体”“方块”,按第 2–6 章跑通第一次碰撞反馈。
  4. 每一步先对照“期望结果”和“常见错误”;当前一步没有通过,不要继续叠加 UI、存档或平台服务。

完全没写过 Lua 时,遇到不认识的语法先回看第 0 章的词典;已经会 Lua 的作者可以直接从第 1 章开始。第 12 章以后是按需进阶,不是入门必做清单。

发布与兼容性

开始学习前请先阅读发布说明、适用版本与证据范围。该页记录本次 Meta/Editor 基线、四级验证口径、平台副作用限制、反馈模板和内容使用边界。

  • 下载完整 Capstone Lua 工程
  • 教程与 API 页面冲突时,以目标版本的正式 API 页面和 Meta 为准,并停止复制冲突片段。
  • “已编译”不等于“行为已验证”;各章期望效果仍需在自己的测试地图验收。

阅读路径

  • 先读第 0-11 章,完成脚本工程、碰撞、计分、UI 和存储闭环。
  • 再按项目需要阅读第 12-22 章,覆盖物理、角色、资产、Manager、平台服务、QA 和 Capstone。
  • 本目录只包含最终章节正文,适合离线阅读、二次排版或导入其他 Markdown 阅读工具。

代码块阅读约定

教程里的代码块分三类阅读:

  • 标题写成具体路径的代码块,例如 server/main.luaclient/hud.lua,表示建议放入该文件的完整示例或主体代码。
  • 没有文件路径标题的代码块,多数是局部片段,用来说明某个 API、判断条件或错误写法,不一定能单独复制运行。
  • data/*.luatestspec_*.mdevidence/* 这类代码块是配置、测试说明或验收记录模板,不是运行时脚本。

复制代码时先看代码块上方的小标题和上下文:完整文件按目录放置,局部片段合并到当前章节已有示例里,配置和证据模板则放到对应目录中维护。

最终文档目录

标题
00第 0 章:从可视化编辑器到状态同步 Lua 开发
01第 1 章:脚本工程、目录结构与运行入口
02第 2 章:编辑器对象、属性、坐标与枚举在 Lua 中的表达
03第 3 章:统一世界、双端模型与逻辑帧
04第 4 章:Game 与 Services
05第 5 章:Unit 与场景树
06第 6 章:事件、Timer 与 Task
07第 7 章:Players、输入与角色
08第 8 章:客户端与服务端通信
09第 9 章:UI / EUI 与 CoreGui
10第 10 章:数据脚本、配置与资产 URI
11第 11 章:数据存储与排行榜
12第 12 章:物理、碰撞、Raycast、约束与运动器
13第 13 章:角色系统——EggyUnit、HumanUnit 与外观
14第 14 章:角色控制与动画——Controller 与 Animator
15第 15 章:相机系统——CameraService 与 CameraUnit
16第 16 章:音效、特效与场景渲染
17第 17 章:资产加载——用 preset 创建模型
18第 18 章:自定义资产系统
19第 19 章:可复用系统——Manager、生命周期与依赖边界
20第 20 章:平台服务:聊天、跨服、社交、商业化、埋点
21第 21 章:测试、调试、日志与 QA
22第 22 章:Capstone 综合项目