轻松玩转Unity编辑器菜单扩展
Unity 具有强大的可扩展性,利用这一特性,开发者能够创建各种各样的工具,并直接整合到 Unity 中使用。本文将全面介绍扩展 Unity 中所有菜单项的方法,以及各菜单项的适用场景。
一、介绍
Unity 编辑器中可扩展的菜单总览如下,这些菜单分别是:
- 编辑器顶部的内置菜单(A、B、C、D)
- 层级视图右键弹出菜单(B)
- 项目视图右键弹出菜单(A)
- 检视面板中点击 Add Component 按钮弹出的菜单(C)
- 编辑器顶部的新菜单项(E)
扩展菜单项时,只需在静态方法前添加 [MenuItem] 属性声明,使用该属性需要引用 UnityEditor 命名空间。该方法的访问修饰符(是否公有)、返回类型及方法名称均无关紧要。
例如,在静态方法前添加 [MenuItem("Window/Custom SubMenu/Custom Window")] 即可实现相应效果。
关于 MenuItem 路径参数的说明
- 如果根目录已存在于菜单项中(如“Asset”、“Window”等),自定义菜单项将被添加到这些菜单下(“Component”除外)。
- 必须要指定根目录及菜单项名称。
- 菜单及菜单项名称均支持包含空格。
- 可以在菜单项名称后添加某个按键代码来指定该菜单项的快捷键。
- 子菜单没有层级限制。
示例代码如下:
[MenuItem("GameObject/Create RedBlue GameObject")]
private static void CreateRedBlueGameObject ()
{
new GameObject ("RedBlue GameObject");
}
依次点击菜单项 GameObject > Create RedBlue GameObject,会在场景中新建名为“RedBlue GameObject”的游戏对象。
另外,MenuItem 还支持多个参数:
MenuItem(string path, bool isValidateFunction, int priority)
其中,参数 isValidateFunction 决定是否启用菜单项。当设为 true 时,如果函数返回值为真,则菜单项启用;函数返回值为假则禁用菜单项。参数 priority 决定了菜单项在菜单中显示的优先级。
二、何时使用哪种菜单
由于对菜单的使用没有严格的限制,开发者需要了解各项菜单原本的目的。下面介绍不同菜单的适用场景。
A - Assets 菜单
Assets 菜单用于在项目中创建或修改资源。在项目视图中右键点击会弹出 Assets 菜单。此外,如果将自定义菜单项放在“Assets/Create”目录下,点击项目视图的“Create”按钮时也会出现该自定义的菜单项。
适合使用 Assets 菜单的情况如下:
- 新建
ScriptableObject:所有自定义的ScriptableObject都可以通过Assets > Create子菜单来创建。 - 重命名精灵图集:右键点击包含多个精灵图片的纹理,使用菜单项可帮助快速重命名所有精灵图片。
B - GameObject 菜单
GameObject 菜单用于场景中与游戏对象相关的操作,如新建游戏对象或编辑已有对象等。右键单击项目视图会显示 GameObject 子菜单,在层级视图点击 Create 按钮同样会显示该子菜单。
如果希望自定义菜单项同时出现在右键弹出菜单和层级视图的 Create 按钮弹出的菜单中,就必须将该自定义菜单项放置在已有的菜单项中,如 2D Object 或 UI 等。如果没有合适的已有菜单项,也可以自己新建一个并将优先级设为 50 以下。
适合使用 GameObject 菜单的情况如下:
- 新建预定义的游戏对象:例如预设体实例,可使用菜单项在新场景中设置好自定义相机。
- 将选中的游戏对象存为预设体:该工具功能与
GameObject下的Break Prefab Instance正好相反。
C - Component 菜单
Component 菜单下的所有菜单项都是用于为选中的游戏对象添加组件。为了加强该功能,Unity 并不允许通过 MenuItem 向该菜单增加菜单项,而是使用 [AddComponentMenu] 属性,该属性直接用于自定义的 MonoBehaviour 类。点击菜单项会自动添加该脚本。
在脚本的类声明前添加 [AddComponentMenu] 属性,该脚本会同时出现在 Component 菜单以及在检视面板中查看游戏对象时点击 Add Component 弹出的菜单中。该属性带有与 MenuItem 相同含义的路径参数,但不支持对自定义菜单项进行排序。
D - Unity、File、Edit、Window 以及 Help 菜单
这几个菜单相对简单,其中的菜单项不会出现在 Unity 编辑器的其它地方。需要打开新窗口的功能可以放在 Window 菜单中。需要同时修改游戏对象及资源的工具,如自定义的重复创建或重命名等,则放在 Editor 菜单中。Unity 对此没有具体要求,开发者可以按照自己的习惯来布置。
E - 新建菜单项
如果已有菜单项均不适合自定义工具的功能,也可以自己新建一个菜单项。但 Unity 并不推荐在多人合作或共享资源的项目中新建菜单项,因为这可能会导致工具栏异常混乱。
关于 Unity 编辑器上方工具栏各菜单的扩展就介绍到这里,后续我们将为大家介绍各个菜单项的优先级如何设置。
来源:unity 官方平台