Unity 编辑器扩展（2）：菜单栏扩展

689 字

3 分钟

Unity 编辑器扩展（2）：菜单栏扩展

2024-12-16

Unity 编辑器扩展

Unity

/

C#

/

编辑器扩展

/

教程

顶部菜单栏扩展#

Unity 默认的顶部菜单栏如下图，我们可以在这里添加自定义工具。

使用 MenuItem 特性标记一个静态方法就可以在顶部栏添加自定义工具：

1
using UnityEditor;
2
using UnityEngine;
3

4
public class TopbarExtension
5
{
6
    [MenuItem("Tool/Custom_1")]
7
    public static void Custom_1()
8
    {
9
        Debug.Log("TopbarExtension : Custom_1");
10
    }
11
}

等待编译完成后就可以在顶部栏看到自定义工具，点击后就会执行 Custom_1 方法：

MenuItem 特性参数#

MenuItem 特性可以传入三个参数：

1
[MenuItem(string itemName, bool isValidateFunction, int priority)]

参数	类型	描述
`itemName`	string	工具在菜单中的路径
`isValidateFunction`	bool	是否用作相同 `itemName` 方法的验证方法
`priority`	int	工具在菜单中的优先级，默认值：1000

itemName 参数#

该参数接受一个 string 类型参数，用来表示工具在顶部栏中的路径，通过 ”/” 字符分割父子级。

isValidateFunction 参数#

该参数接受一个 bool 类型参数，传入 true 时表示该方法为验证方法：

验证方法会在具有相同 itemName 方法之前执行
验证方法必须返回 bool 才可以生效
返回 false 时，itemName 对应的菜单栏选项变为不可选状态

示例代码：

1
using UnityEditor;
2
using UnityEngine;
3

4
public class TopbarExtension
5
{
6
    [MenuItem("Tool/Custom_1", false)]
7
    public static void Custom_1()
8
    {
9
        Debug.Log("TopbarExtension : Custom_1");
10
    }
11

12
    [MenuItem("Tool/Custom_1", true)]
13
    public static bool Custom_2()
14
    {
15
        return false;
16
    }
17
}

通过验证方法可以对工具执行的条件进行判断，防止在非预期的情况下运行。

priority 参数#

该参数接受一个 int 类型参数，用来决定选项在菜单栏中的排列位置：

菜单列表中处于同一级的不同方法之间会比较 priority 的值
值较大的选项会排在值较小的选项下面
当两个选项的 priority 值相差超过 10（>=11）时，会在两个选项之间显示一条分割线

快捷键设置#

可以在 itemName 中设置方法的快捷键：

1
using UnityEditor;
2
using UnityEngine;
3

4
public class TopbarExtension
5
{
6
    [MenuItem("Tool/Custom_1 %#d", false)]
7
    public static void Custom_1()
8
    {
9
        Debug.Log("TopbarExtension : Custom_1");
10
    }
11

12
    [MenuItem("Tool/Custom_1 %#d", true)]
13
    public static bool Custom_2()
14
    {
15
        return false;
16
    }
17
}