Editor Extension

自动关联目录:Editor Extension

编辑器扩展的收益很直接:把重复的手动操作变成一键。判断标准与自动化一样——做第三次就该做工具。

本目录

笔记内容状态
Editor 工具与 UtilityEUW / EUB、批处理骨架、常用 API已补充(覆盖官方 EUW 条目)
Python 编辑器脚本六种运行方式、API 要点、四条官方最佳实践已补充(覆盖官方 21 条目)
Slate 编辑器界面窗口与 Tab、菜单扩展、样式、与运行时 UI 的区别已补充

阅读顺序

顺序笔记什么时候读
1Editor 工具与 Utility先读。默认方案,能不写 C++ 就不写
2Python 编辑器脚本跨 DCC 管线、批量资产处理
3Slate 编辑器界面EUW 做不到时(自定义停靠/菜单/复杂控件)

只有十分钟:Editor 工具与 Utility 的"批处理骨架"一节——事务 + 标脏是两条硬要求,缺一条工具就不可用。

扩展方式

方式适用成本
Editor Utility Widget / BlueprintUI 工具、批处理最低,首选
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编辑器操作应都在游戏线程
工具改了资源但不重新加载视图不同步,应触发刷新