Unity 编辑器(UnityEditor)

<small>前几天开始准备看源码,结合自己工作使用Lua,想看sLua框架源码,但是Lua确实不太熟悉,于是还是选择C#,打算看NGUI的源码(因为工作中也有用到)。
自己看源码经验不是很多,有些感觉无从下手,因为里面的代码跳转太多了,打算先看看NGUI的编辑器是怎么做出来的,于是开始研究Unity的编辑器制作。</small>

一、引言

Unity允许开发者自己制定编辑器,这也给了我们很多的方便,例如:要打包AssetBundle的时候,我们可以自己写一个菜单项点击进行我们所想要的打包。还有一些时候我们可以创建一个窗口完成Unity并没有提供支持的编辑。

二、UnityEditor相关类
  • Editor:编辑器
  • EditorWindow :编辑窗口(类似Console就是一个编辑窗口),其中初始化方法应为static,否则在Unity编辑过程中不能找到匹配的选项
  • GenericMenu :编辑窗口中菜单
  • EditorGUILayout :编辑窗口中的界面布局类
  • MenuItem属性:添加菜单项在控制面板主菜单和检视面板上下文菜单
  • GUILayout : 可以在编辑窗口用
  • MenuCommand :用于提取上下文菜单项。MenuCommand对象被传递给自定义菜单项功能使用菜单项定义的属性。
  • Event : 事件,Event.current.可以获取到当前的系统处理的事件
    <strong>注:编辑器脚本需要放在Editor文件夹下,在进行Unity编辑的时候生效,Unity会把Editor下的脚本认为是Editor脚本,不允许挂载在游戏物体上。</strong>

三、制作菜单

3.1创建主菜单下的菜单项(MenuItem)

终于到了令人期待的动手时刻啦,现来个简单的


主菜单下的编辑菜单
    /*
     * static void MenuItem (itemName : string, isValidateFunction : bool,  priority : int) : MenuItem
     * itemName : 菜单名,以"/"分级,第一个是和主菜单同级的位置,该级菜单不能以中文命名,后面的都可以用中文
     * isValidateFunction : 这个参数标志是否是验证函数
     * priority : 优先级,值越小,在菜单中越靠上
     */

    //主菜单下的一级菜单menu1
    [MenuItem("Menu/menu1" , false, 1)]
    static public void Menu1()
    {
        Debug.Log("menu1");
    }

    //主菜单下的二级菜单menu2
    [MenuItem("Menu/menu2/menu2", false, 2)]
    static public void Menu2()
    {
        Debug.Log("menu2/menu2");
    }

<strong>在写编辑器脚本的时候记得要using UnityEditor</strong>

3.2 特定情况下可以使用的菜单

弄完上面这菜单,只有一句话可以说:“这也真是够烂的”。不过毕竟是最简单的菜单,接下来,我们慢慢优化,学习嘛,总有个循序渐进的过程。
下面,我们来给菜单添加一个特定情况下使用的功能,例如,我们让它只在我们选中了某种特定游戏物体的时候才让他显示,让它可以被点击。

不能点击
//主菜单下的一级菜单menu1
    [MenuItem("Menu/menu1" , false, 1)]
    static public void Menu1()
    {
        Debug.Log("menu1");
    }

    //这是Menu/menu1的验证函数,当返回true时,menu1显示可点,否则不能点
    [MenuItem("Menu/menu1", true)]
    [MenuItem("Menu/menu1", true)]
    static public bool ShowMenu1()
    {
        GameObject selectObj = Selection.activeGameObject;
        return selectObj != null && selectObj.tag == "Display";
    }
3.3 给自定义MenuItem绑定快捷键

老感觉MenuItem就前面这一点东西不好用,还是有快捷键的好,方便多了。
这可能是学习MenuItem最简单的一个步骤了,一行代码都不需要,只需要几个字符,我刚找到方法的时候都不敢相信!!!

绑定快捷键

解释和代码都在下面了:

    //主菜单下的二级菜单menu2
    /*
     * _%H 表示快捷键为ctrl + H
     * 创建快捷键方式 : 在对应的MenuItem后面以" _"开头,后面添加快捷键标志
     * 快捷键标志规则 : 
     *      % = ctrl 
     *      # = Shift
     *      & = Alt 
     *      F1…F2 = F... 
     *      LEFT/RIGHT/UP/DOWN = 上下左右 
     *      HOME, END, PGUP, PGDN = 键盘上的特殊功能键
     */
    [MenuItem("Menu/menu2/menu2 _%H", false, 2)]
    static public void Menu2()
    {
        Debug.Log("menu2/menu2");
    }
3.4 添加MenuItem到对应Insecptor面板
Insecptor中的Camera上添加菜单
    /*
     * 在Inspector中对应的组件中右键中添加菜单
     * MenuItem("CONTEXT/[ComponentName]/[DisplayName]")
     * static void FunctionName(MenuCommand command) { //function body code }
     */
    [MenuItem("CONTEXT/Camera/Item")]
    static public void Item(MenuCommand command)
    {
        //command.context获取对应Object
        Camera camera = command.context as Camera;
        Debug.Log(string.Format("light info : name = {0}", camera.name));
    }

四、创建编辑窗口

前面了解了编辑菜单的制作,现在,我们来学习下编辑窗口怎么做。
其实,一个编辑窗口就是一个EditorWindow,翻译过来也就是编辑窗口啦。
首先,创建一个脚本,继承EditorWindow,也就是创建了一个编辑窗口了,只不过没有显示罢了。
<strong>再次声明:我们这些脚本都是放在Editor文件夹下的,我们的脚本也都是继using UnityEditor才能有效编译的。</strong>

using UnityEngine;
using System.Collections;
using UnityEditor;
using UnityEngine.Tizen;

public class EditWindow : EditorWindow
{
    static string myString = "Hello World";
    bool groupEnabled;
    bool myBool = true;
    float myFloat = 1.23f;
    static GenericMenu menu;
    
    //初始化,也就是一个MenuItem,当点击时调用Init()
    [MenuItem("Window/EditWindow _%&#B")]
    static void Init()
    {
        Debug.Log("init");
        // Get existing open window or if none, make a new one:
        GetWindow(typeof(EditWindow));   //获取到窗口,并且显示
        //实例化并且设置menu
        menu = new GenericMenu();   //初始化menu,但是没有显示
        menu.AddItem(new GUIContent("MenuItem1"), false, Callback, "item 1");
        menu.AddItem(new GUIContent("MenuItem2"), false, Callback, "item 2");
        menu.AddSeparator("");
        menu.AddItem(new GUIContent("SubMenu/MenuItem3"), false, Callback, "item 3");
    }
    
    //通过GUI渲染,每帧调用
    void OnGUI()
    {
        //创建要显示在编辑窗口的内容
        GUILayout.Label("Base Settings", EditorStyles.boldLabel);
        myString = EditorGUILayout.TextField("Text Field", myString);
        EditorGUILayout.Space();    //空行:间隙
        //ToggleGroup
        groupEnabled = EditorGUILayout.BeginToggleGroup("Optional Settings", groupEnabled);
        myBool = EditorGUILayout.Toggle("Toggle", myBool);
        myFloat = EditorGUILayout.Slider("Slider", myFloat, -3, 3);
        myString = EditorGUILayout.TextField("Field", myString);
        EditorGUILayout.EndToggleGroup();

        EditorGUILayout.BeginVertical("Button");
        GUILayout.Label("I'm inside the button");
        GUILayout.Label("So am I");
        EditorGUILayout.EndVertical();

        Event currentEvent = Event.current;
        Rect contextRect = new Rect(0, 200, 100, 100);
        //EditorGUI.DrawRect(contextRect, Color.green);
        EditorGUI.LabelField(contextRect, "Hello World Text");

        if (currentEvent.type == EventType.MouseDown)   //点击事件发生在当前EditorWindow上
        {
            Vector2 mousePos = currentEvent.mousePosition;
            if (contextRect.Contains(mousePos)) //点在矩形范围内
            {
                menu.ShowAsContext();   //显示menu
                currentEvent.Use();
            }
        }
    }

    //回调
    static void Callback(object obj)
    {
        Debug.Log("Selected: " + obj.ToString());
    }
}

这就是创建一个面板的代码了,可以直接复制到自己的工程中,创建如下窗口


MenuItem

窗口

对于里面的OnGUI代码,就是用到UnityEditor相关类中的一些类了,大家可以研究下。
<strong>最后,文章就到这了,文笔有限,望大家见谅。
欢迎各路英雄互相讨论学习。</strong>

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

推荐阅读更多精彩内容