2024-02-08 Unity 编辑器开发之编辑器拓展1 —— 自定义菜单栏

1 特殊文件夹 Editor

​ Editor 文件夹是 Unity 中的特殊文件夹，Unity 中所有编辑器相关的脚本都需要放置在其中，其相关的命名空间为 UnityEditor。

​ 使用命名空间 UnityEditor 的脚本最终不能被 Unity 打包，需要将这些脚本放置到 Editor 文件夹中，避免打包时报错。

2 在 Unity 菜单栏中添加自定义页签

• 命名空间：UnityEditor
• 特性：MenuItem
• 用法：在静态函数前加上 [MenuItem("页签/一级选项/二级选项/....")]
• 作用：当在菜单栏点击该页签时，将执行静态函数中逻辑。
• 注意：
  1. 不用在意继承对象。
  2. 斜杠必须是 /。

public class Lesson1
{
    [MenuItem("Unity编辑器拓展/Lesson1/TestFun")]
    private static void TestFun()
    {
        Debug.Log("TestFun");
    }
}
1
2
3
4
5
6
7
8

3 在 Hierarchy 窗口中添加自定义页签

• 命名空间：UnityEditor

• 特性：MenuItem

• 用法：在静态函数前加上，并且页签命名放入 GameObject 路径。

  [MenuItem("GameObject/页签/一级选项/二级选项/....")]

• 注意：

  1. 不用在意继承对象。
  2. 斜杠必须是 /。
  3. 在菜单栏的 GameObject 中也会出现对应选项。

[MenuItem("GameObject/Lesson1/TestFun2")]
private static void TestFun2()
{
    Debug.Log("TestFun2");
}
1
2
3
4
5

4 在 Project 窗口中添加自定义页签

• 命名空间：UnityEditor

• 特性：MenuItem

• 用法：在静态函数前加上，并且页签命名放入 Assets 路径。

  [MenuItem("Assets/页签/一级选项/二级选项/....")]

• 注意：

  1. 不用在意继承对象。
  2. 斜杠必须是 /。
  3. 在菜单栏的 GameObject 中也会出现对应选项。

5 在菜单栏的 Component 菜单添加脚本

• 命名空间：UnityEngine

• 特性：AddComponentMenu

• 用法：在想要通过 Component 菜单添加的脚本前加上。

  [AddComponentMenu("一级选项/二级选项/....")]

• 注意：

  1. 脚本需要继承 MonoBehaviour 对象，且不能放在 Editor 文件夹下。
  2. 斜杠必须是 /。
  3. 最后一级选项的名字可以和脚本名不一样，但是建议一致。
  4. 添加该特性的代码可以被 Unity 打包，与因为该特性所在的命名空间不为 UnityEditor。

using UnityEngine;

[AddComponentMenu("Unity编辑器拓展/添加脚本/Lesson1_Test")]
public class Lesson1_Test : MonoBehaviour
{ }
1
2
3
4
5

6 在 Inspector 为脚本右键添加菜单

• 命名空间：UnityEditor

• 特性：MenuItem

• 用法：在静态函数前加上
  [MenuItem("CONTEXT/脚本名/页签/一级选项/二级选项/....")]

• 注意：

  1. 不用在意继承对象。
  2. 斜杠必须是 /。

[MenuItem("CONTEXT/Lesson1_Test/Lesson1/自定义功能")]
private static void TestFun4()
{
    Debug.Log("TestFun4");
}
1
2
3
4
5

7 加入快捷键

• 单键：路径后 + 空格 + 下划线 + 想要的按键

• 组合键：下划线替换为

  1. %表示 Ctrl
  2. #表示 Shift
  3. &表示 Alt

• 其他支持的按键：

  1. LEFT、RIGHT：#LEFT 表示左 Shift 按键。
  2. UP、DOWN、F1..F12、HOME、END、PGUP、PGDN。

public class Lesson1
{
    [MenuItem("Unity编辑器拓展/Lesson1/TestFun #F1")]
    private static void TestFun()
    {
        Debug.Log("TestFun");
    }
}
1
2
3
4
5
6
7
8

8 小结

1. 使用 UnityEditor 命名空间的脚本必须放在 Editor 文件夹下，避免打包报错。
2. 添加自定义页签，需要用到特性 MenuItem。
3. 添加代码添加页签，需要用到特性 AddComponentMenu。