vs未能加载此自定义查看器_浅析创建自定义资源

引擎版本 4.22.0

前言

在实际的开发中我们可能需要创建自定义资源&＃xff0c;很遗憾的是官方文档中并没有提供相关教程。本文将以引擎的Editor Widget创建为例配合源码介绍如何创建自定义资源。

注意源码图片看不清楚的看这里&＃xff1a;http://note.youdao.com/noteshare?id&＃61;54fed93922a7fbeed459519437e30abe

Editor Widget简介

先上官方文档关于这方面的介绍&＃xff1a;

https://docs.unrealengine.com/zh-CN/Engine/UMG/UserGuide/EditorUtilityWidgets/index.html

简单来讲Editor Widget就是在编辑器环境下使用的Widget&＃xff0c;只不过该Widget可以显示在编辑器窗口中罢了。该资源为蓝图资源&＃xff0c;类型为UEditorUtilityWidgetBlueprint&＃xff0c;该蓝图资源的ParentClass为UEditorUtilityWidget。

我们常用的UserWidget同样也是蓝图资源&＃xff0c;类型为UWidgetBlueprint&＃xff0c;ParentClass为UUserWidget。

看一下类结构示意图&＃xff1a;

可以看出EditorWidget是从UserWidget扩展而来&＃xff0c;因为有自己的蓝图类&＃xff0c;所以是独立的资源。

自定义资源创建相关类

• AssetTypeActions

AssetTypeActions是用来创建资源的入口&＃xff0c;常见的是我们在内容浏览器中空白出右键出现的一系列将要创建的资源列表&＃xff1a;

以及右键一个资源出现与该资源相关的一些操作&＃xff1a;

该类中还会指定打开该资源的编辑器&＃xff0c;例如我们的EditorWidget双击后打开的编辑器就是专门设计的编辑器&＃xff1a;

看一下EditorWidget关于该类的源码&＃xff1a;

接下来挑几个重要的也是必须重写的方法介绍下&＃xff1a;

1. GetName是用来显示该资源的类型名&＃xff0c;由于被指定为EditorWidget

所以当我们将鼠标悬浮在该类型资源上时Tip中会显示对于的类型名&＃xff1a;

2. GetTypeColor是该资源的图标颜色&＃xff1a;

3. GetSupportedClass指定了资源对应的类&＃xff1a;

4. HasActions指定该资源是否有相应的右键操作选项&＃xff1a;

5. GetActions定义了右键操作选项&＃xff1a;

从图中可以看出EditorWidget中定义了一个右键操作选项&＃xff1a;Run Editor Utility Widget&＃xff0c;也就是在窗口中预览界面&＃xff1a;

6. OpenAssetEditor中指定了打开资源的编辑器&＃xff0c;具体查看源码

7. GetCategories中指定了创建资源的选项在右键菜单中的分组&＃xff1a;

• 资源类

EditorWidget的资源类为UEditorUtilityWidgetBlueprint:

同样地介绍下主要的方法&＃xff1a;

1. GetReparentingRules方法指定了更改蓝图资源ParentClass的规则:

从图中可见代码中定死了只能使用UEditorUtilityWidget及其子类&＃xff1a;

• Factory

每个自定义资源还需要有一个创建该资源的工厂&＃xff1a;

构造函数中需要进行一些设置&＃xff1a;

SupportClass就是资源类&＃xff0c;ParentClass就是蓝图父类。

同样我们需要重写FactoryCreateNew方法&＃xff0c;里面主要创建蓝图资源并指定其父类&＃xff0c;具体可参考源码。FactoryCreateNew方法的调用时机在资源命名完毕并提交的时候。

注册AssetCategory

自定义资源在右键创建入口需要有新的分组则需要注册&＃xff0c;例如EditorWidget就在BlutilityModule模块启动函数中注册了EditorUtilities组&＃xff1a;

注意不要忘记了在AssetTypeActions的GetCategories方法中指定自定义分组&＃xff1a;

源码中是将注册的资源分组存在模块的EditorUtilityCategory变量中&＃xff0c;AssetTypeActions类中就通过模块获得资源分组。

需要注意的是有一种更为方便的方法就是通过AssetTool的FindAdvancedAssetCategory方法获取&＃xff1a;

注册AssetTypeActions

为保证AssetTypeActions生效还得将其注册&＃xff0c;源码是在BlutilityModule模块启动时注册的&＃xff1a;

注销AssetTypeActions

BlutilityModule关闭时会注销AssetTypeActions:

实践

笔者需要创建一个默认父类为MyUserWidget的Widget资源&＃xff0c;所以就仿照Editor Widget实现了&＃xff0c;不妨看下效果&＃xff1a;

在实际操作中遇到两个问题&＃xff1a;

1.在Widget编辑器中嵌套使用UserWidget不显示的问题

发现是WidgetTree->RootWidget为空&＃xff0c;需要在模块启动时对自定义蓝图资源注册器。

2.在编辑器中以Mobile Preview模式启动崩溃问题

崩溃日志&＃xff1a;

原因是由于MyWidgetBlueprint定义在FrameworkEditor模块中&＃xff0c;而界面InforItemUI的蓝图资源为自定义的MyWidgetBlueprint。当以Mobile Preview模式启动时FrameworkEditor模块未加载导致未能正确找到MyWidgetBlueprint,从而在BlueprintGeneratedClass::GetAuthoritativeClass()中将ClassGeneratedBy转化为UBlueprint失败从而导致崩溃。解决方法为在运行时模块启动时手动载FrameworkEditor模块。

之前纳闷的地方在于我写的MyWidgetBlueprint是继承引擎的UWidgetBlueprint的&＃xff0c;而UWidgetBlueprint是属于UMGEditor模块的。它之所以没事是因为FEngineLoop::LoadStartupCoreModules()中手动加载了UMG模块&＃xff0c;而当UMG模块启动又加载了UMGEditor模块。

本文介绍的是蓝图类资源的创建流程&＃xff0c;了解了流程就可以很方便地自定义非蓝图类的资源&＃xff0c;这里就不再详细介绍了。