Editor Extension
自动关联目录:Editor Extension
编辑器扩展的收益很直接:把重复的手动操作变成一键。判断标准与自动化一样——做第三次就该做工具。
本目录
| 笔记 | 内容 | 状态 |
|---|---|---|
| Editor 工具与 Utility | EUW / EUB、批处理骨架、常用 API | 已补充(覆盖官方 EUW 条目) |
| Python 编辑器脚本 | 六种运行方式、API 要点、四条官方最佳实践 | 已补充(覆盖官方 21 条目) |
| Slate 编辑器界面 | 窗口与 Tab、菜单扩展、样式、与运行时 UI 的区别 | 已补充 |
阅读顺序
| 顺序 | 笔记 | 什么时候读 |
|---|---|---|
| 1 | Editor 工具与 Utility | 先读。默认方案,能不写 C++ 就不写 |
| 2 | Python 编辑器脚本 | 跨 DCC 管线、批量资产处理 |
| 3 | Slate 编辑器界面 | EUW 做不到时(自定义停靠/菜单/复杂控件) |
只有十分钟:Editor 工具与 Utility 的"批处理骨架"一节——事务 + 标脏是两条硬要求,缺一条工具就不可用。
扩展方式
| 方式 | 适用 | 成本 |
|---|---|---|
| Editor Utility Widget / Blueprint | UI 工具、批处理 | 最低,首选 |
| Python 编辑器脚本 | 跨 DCC 管线、批量资产 | 低(但只在编辑器) |
| Editor Utility Actor / 资产动作 | 场景/资源批处理 | 低 |
| Detail 面板自定义 | 改组件的编辑体验 | 中 |
| C++ 模块(Editor-only) | 菜单、命令、自定义窗口 | 较高 |
| Slate 自定义窗口 | 复杂工具界面 | 高 |
| 自定义资源类型/工厂 | 新资源类型 | 高 |
优先用 Editor Utility Widget:能覆盖八成需求,且不用 C++ 编译,改起来快。EUW 做不到(停靠受限、需原生级 UI)再上 Slate。
常见扩展点
| 需求 | 做法 |
|---|---|
| 菜单/工具栏按钮 | UToolMenu(UE5)或 FExtender |
| 右键菜单(资产/Actor) | FContentBrowserMenuExtender / UToolMenu |
| 控制台命令 | IConsoleManager::RegisterConsoleCommand |
| 自定义 Detail 面板 | IDetailCustomization + FPropertyEditorModule |
| 自定义窗口 | SWindow / FTabManager 注册 Tab |
| 资源校验(保存/加载时) | UObject::PostEditChangeProperty、数据校验器 |
| 导入导出 | UFactory / UExporter |
| 批处理 | Editor Utility + AssetRegistry 遍历 |
关键 API
| API | 用途 |
|---|---|
FAssetRegistryModule | 查询与遍历资产 |
UEditorAssetLibrary | 加载/保存/复制/删除资产 |
FEditorFileUtils | 文件与包操作 |
GEditor->GetEditorSubsystem<U...>() | 各编辑器子系统 |
FScopedTransaction | 支持 Undo/Redo |
FMessageDialog / FNotificationInfo | 提示与通知 |
UWorld->Modify() / MarkPackageDirty | 标记修改以便保存 |
写编辑器工具必须记得两件事:用 FScopedTransaction 让操作可撤销,用 MarkPackageDirty 让改动能被保存。少了前者用户不敢用,少了后者改动会丢。
模块划分
| 类型 | 说明 |
|---|---|
Editor 模块(Type = ModuleType.Editor) | 只在编辑器加载,不会被打包进游戏 |
| 运行时模块 | 会被打包 |
所有编辑器代码必须放 Editor 模块,否则打包时会引用到不存在的编辑器 API,或在 Shipping 里留下无用代码。
判断技巧:代码里用到 UnrealEd、Slate、EditorStyle 这类只在编辑器存在的模块时,必须在 Editor 模块里。
实践建议
| 建议 | 说明 |
|---|---|
| 先做成 Editor Utility Widget | 快,且策划自己能改 |
| 工具要有"预览/干跑" | 批量操作前先看会改哪些 |
| 操作要可撤销 | FScopedTransaction |
| 不要在工具里写死路径 | 用配置或选择对话框 |
| 处理失败要给出明确提示 | 静默失败最可怕 |
常见坑
| 坑 | 说明 |
|---|---|
| 编辑器代码放进运行时模块 | 打包失败或引入无用依赖 |
| 批量操作没有事务 | 无法撤销 |
忘了 MarkPackageDirty | 改动不提示保存,重启丢失 |
| 在非游戏线程操作 UObject | 编辑器操作应都在游戏线程 |
| 工具改了资源但不重新加载 | 视图不同步,应触发刷新 |
许可协议:CC BY
作者:Davids
本文链接:https://hustjjd.github.io/608296a3.html
更新于:2026年11月16日