编辑器扩展基础2——自定义MenuItem

Unity编辑器允许添加外观和行为与内置菜单相似的自定义菜单。这对于添加常用的功能非常有用,这些功能通常需要通过编辑器UI直接访问。在本文中,我将介绍如何创建Unity编辑器中的新菜单项,并尝试为每个描述的主题提供真实的示例用法。

Menu item得一般创建流程

1.引用UnityEditor命名空间
2.添加[MenuItem(XXX路径)]
3.创建静态方法(当点击menu item 后这个方法就会被调用)

长这样:

using UnityEngine;
using UnityEditor;
 
public class MenuItems
{
    [MenuItem("Tools/Clear PlayerPrefs")]   //会在菜单栏增加Tools选项卡
    private static void NewMenuOption()
    {
        PlayerPrefs.DeleteAll();
    }
}

当然了这里的MenuItem特性路径有几个内置好的情况

  • Assets – item将会在 “Assets” 菜单下被找到, 或者在项目视图右击
  • Assets/Create – items将被在“Assets/Create”下被找到
  • CONTEXT/ComponentName – items 将在组建面板上右击时被找到

添加热键

  • ’%‘ – CTRL
  • ‘#’ – Shift
  • ‘&’ – Alt
  • ‘LEFT/RIGHT/UP/DOWN’ – 方向箭
  • ’F1…F2‘ – F 键
  • ‘HOME, END, PGUP, PGDN’
  • 注意:使用热键如果重叠将只能执行第一个调用
    长这样:
[MenuItem("Tools/New Option %#a")]
    private static void NewMenuOption()
    {
        Debug.Log(1111);
    }

    // Add a new menu item with hotkey CTRL-G

    [MenuItem("Tools/Item %g")]
    private static void NewNestedOption()
    {
        Debug.Log(2222);
    }

menu item 第二个参数:验证

有些情况下,我们希望menu item 只在特定情况下能交互,这时我们需要enable/disable menu item。
这种情况下,要用validation,即验证。
validation方法是一种静态方法,需要满足如下条件:

  • 1.用menu attribute 修饰
    1. menu路径 必须和他要验证的menu相同
    1. 必须返回一个bool值来决定是否要激活 menu item
      长这样:
[MenuItem("Assets/ProcessTexture")]
    private static void DoSomethingWithTexture()
    {
        Debug.Log(" validation");
    }

    // 跟上第二个参数true,将静态方法设置成验证函数
    [MenuItem("Assets/ProcessTexture", true)]
    private static bool NewMenuOptionValidation()
    {
        // 设置什么情况下消失/显现(the menu item will be disabled otherwise).
        return Selection.activeObject.GetType() == typeof(Texture2D);
    }

menu item 第三个参数:优先级

可以给自定义的menu item设置优先级,让他显示在醒目的位置

[MenuItem("Assets/PriorityItem", false,100)]  //值越大越靠后

相关类

MenuCommand
这个类可以传递上下文信息,可以用来修改组件数据

    [MenuItem("CONTEXT/Rigidbody/MassSet")]
    static void MassSet(MenuCommand command)
    {
        //这一句就是具体含义
        Rigidbody body = (Rigidbody)command.context;
        body.mass = 5;
        Debug.Log("Changed Rigidbody's Mass to " + body.mass + " from Context Menu...");
    }

ContextMenuItem
给自定义组件下的变量设置menu item,函数必须是非静态的

[ContextMenuItem("Randomize Name", "Randomize")]     //在面板属性条目上右击调出menu item
    public string Scenename;
private void Randomize()
    {
        Scenename = "Some Random Name";
    }

ContextMenu
自定义上下文菜单,函数是非静态的,用来设置组件变量是极好的

[ContextMenu("ContextMenu Func")]
    void DoSomething()
    {
        experience = 10000;
    }

详细参考官方文档

前文链接
1.//www.greatytc.com/p/b7a59bdd9c9b

注:配套案例可在EditorExtensionDemo仓库中查看。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,923评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,154评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,775评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,960评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,976评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,972评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,893评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,709评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,159评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,400评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,552评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,265评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,876评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,528评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,701评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,552评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,451评论 2 352

推荐阅读更多精彩内容