一次搞定unity编辑器常用功能

转载:https://yq.aliyun.com/articles/69190
这篇文章主要分享unity中与editor插件等相关的使用,比较基础,不过如果都掌握了就可以扩展写一些unity插件了,平时开发中也会提升工作效率。
editor相关脚本一定要放在Editor文件夹下,继承monobehaviour的文件不要放到Editor文件夹下。
monobehaviour相关的编辑器功能
首先常用的在继承monobehaviour类中写public变量可以在inspector中序列化可编辑一般人都知道了,下面是一些可以更有效率更酷的方法。
增强序列化属性

public bool isGood = false;
[Tooltip("hp")]//鼠标hover的时候显示一个tooltip
public int life = 0;
[Range(0f, 1f)]//float slider
public float CloudRange = 0.5f;
[Range(0, 15)]//int slider
public int CloudRangeInt = 1;
[Header("OtherAttr")]//可以将属性隔离开,形成分组的感觉
public float CloudHeader = 1f;
[Space(30)]//可以与上面形成一个空隙
public float CloudSpace = 1f;
[HideInInspector]//使属性在inspector中隐藏,但是还是可序列化,想赋值可以通过写程序赋值序列化
public float CloudHideInInspector = 1f;
[NonSerialized]//使public属性不能序列化
public float CloudNonSerialized = 1f;
[SerializeField]//使private属性可以被序列化,在面板上显示并且可以读取保存
private bool CloudSerializeField = true;

效果如下图,对于一些有范围的数值可以用range做个slider让策划来调节,可以用header和space来组织面板的外观,也可以针对不同的属性进行是否序列化的选择。


serialize

序列化类
也可以序列化一个类

[Serializable]//一个可序列化的类
public class SerializableClass { 
public int x = 0; 
public Vector2 pos; 
public Color color; 
public Sprite sprite;
}
public SerializableClass serializedObject;//一个可序列化的类的实例
serializedObject

组件面板的上下文菜单
有时在monobehaviour中写一些方法可以初始化一些值或者随机产生某个值这种需求,都可以在菜单中触发,只要简单的加一行即可。

[ContextMenu("Init")]//可以在组件的右键菜单及设置(那个小齿轮按钮)菜单看到,
void Init()
{ 
isGood = false;
 life = 0;
}
[ContextMenu("Random value")]
void RandomValue()
{
Debug.Log("TestContextMenu " + gameObject.name); 
isGood = true; 
life = UnityEngine.Random.Range(1, 100);
}

效果如下图,点击init就会赋一个初始的值,点击randomvalue可以随机产生一个life的值,这就是最简单的editor工具了


contextmenu

inspector相关的编辑器功能
如果要在inspector中加上一些更高级的功能就需要使用editor相关的方法了
这是要使用的TestInspector类代码

[CustomEditor(typeof(TestInspector))]
public class CloudTools : Editor {
    #region inspector
    TestInspector script;//所对应的脚本对象
    GameObject rootObject;//脚本的GameObject
    SerializedObject seriObject;//所对应的序列化对象
    SerializedProperty headColor;//一个[SerializeField][HideInInspector]且private的序列化的属性
    private static bool toggle = true;//toggle按钮的状态

    //初始化
    public void OnEnable()
    {
        seriObject = base.serializedObject;
        headColor = seriObject.FindProperty("headColor");
        var tscript = (TestInspector)(base.serializedObject.targetObject);
        if (tscript != null)
        {
            script = tscript;
            rootObject = script.gameObject;
        }else
        {
            Console.Error.WriteLine("tscript is null");
        }
    }

    //清理
    public void OnDisable()
    {
        var tscript = (TestInspector)(base.serializedObject.targetObject);
        if (tscript == null)
        {
            // 这种情况是脚本对象被移除了;  
            Debug.Log("tscript == null");
        }
        else
        {
            // 这种情况是编译脚本导致的重刷;  
            Debug.Log("tscript != null");
        }
        seriObject = null;
        script = null;
        rootObject = null;
    }

    public override void OnInspectorGUI()
    {
        base.OnInspectorGUI();
        seriObject.Update();
        //将target转化为脚本对象
        script = target as TestInspector;
        //random按钮  
        if (GUILayout.Button("RandomNum"))
        {
            //注册undo,可以在edit菜单里看到undo,也可以通过ctrl+z来回退
            Undo.RecordObject(script, "revert random num");
            script.RandomNum(script.num);
        }

        //save scene和toggle这组按钮
        GUILayout.BeginHorizontal();
        {
            if (GUILayout.Button("SaveScene"))
            {
                EditorSceneManager.SaveCurrentModifiedScenesIfUserWantsTo();
            }
            if(GUILayout.Button(toggle ? "untoggle" : "toggle"))
            {
                toggle = !toggle;
            }
        }
        GUILayout.EndHorizontal();

        script.isAlive = EditorGUILayout.BeginToggleGroup("isAlive", script.isAlive);
        if (script.isAlive)//如果isAlive不勾选则不显示life
        {
            script.life = EditorGUILayout.Slider("life", script.life, 0, 100f);
        }
        EditorGUILayout.EndToggleGroup();

        //可以显示TestInspector中序列化但是不在inspector中显示的属性
        EditorGUILayout.PropertyField(headColor);
        seriObject.ApplyModifiedProperties();

        //展示普通信息
        EditorGUILayout.LabelField("life " + script.life, GUILayout.Width(200));
        Repaint();
    }

    #endregion
}

其中需要用OnEnable和OnDisable来做初始化和清理工作,OnInspectorGUI方法可以类比monobehaviour中的OnGUI,做ui渲染和ui事件处理。
里面还注册了UnDo,好处是可以通过ctrl+z来进行撤销操作,这样才更完美更像一个完善的unity插件。
代码也没什么难度,我也做了下简单的注释,执行一下看看效果大部分人就都理解了。效果如下图


inspector

inspector

各种上下文菜单
组件菜单
之前可以在monobehaviour中加入[ContextMenu("Random value")]
来生成对应脚本组件面板的上下文菜单,那么如果要生成一个在transform组件上的菜单怎么办

[MenuItem("CONTEXT/Transform/RandomPosition")]
static void ContextMenu_TransformRandomPosition()//随机改变transform组件的position
{
    Debug.Log("ContextMenu_Transform");
    Transform[] transforms = Selection.GetTransforms(SelectionMode.TopLevel | SelectionMode.OnlyUserModifiable);
    foreach (Transform transform in transforms)
    {
        transform.localPosition = new Vector3(UnityEngine.Random.Range(-10, 10),
            UnityEngine.Random.Range(-10, 10),
            UnityEngine.Random.Range(-10, 10));
        Debug.Log(transform.localPosition);
    }
}

效果如下图,如果策划或者美术需要对transform的position干这种随机的事,是不是就可以这么搞了?或者对collider、rigibody之类的组件加上一些属性模板的设置,会很方便吧


TransformMenu

带勾选的菜单

const string Menu_Checked = "Cloud/MenuChecked";//checked menu的名字
const string Key_MenuChecked = "MenuChecked";//checked menu状态存储的key

[MenuItem(Menu_Checked)]
static void MenuChecked()
{
    bool flag = Menu.GetChecked(Menu_Checked);
    if (flag)
    {
        Debug.Log("Key_MenuChecked to 0");
        PlayerPrefs.SetInt(Key_MenuChecked, 0);//通过存储0和1来判断是否check menu
    }
    else
    {
        Debug.Log("Key_MenuChecked to 1");
        PlayerPrefs.SetInt(Key_MenuChecked, 1);
    }
    Menu.SetChecked(Menu_Checked, !flag);
}

[MenuItem(Menu_Checked, true)]//判断menu是否check的函数
public static bool IsMenuChecked()
{
    Menu.SetChecked(Menu_Checked, PlayerPrefs.GetInt(Key_MenuChecked, 0) == 1);
    return true;
}

效果如下图,其中需要一个菜单的valid函数来判断菜单是否在勾选状态,这里用了playprefs,在windows上就写到注册表里了


checkedmenu

project面板中的菜单
这个菜单是加到了Assets下面,那么在project面板中右键也可以看到,这种菜单可以干什么呢,我也没想好,不过干些修改assetsimport属性或者修改一些资源等等还是挺好用的吧

[MenuItem("Assets/TestAssets")]
static void MenuAssets()
{
    if(Selection.activeObject == null)
    {
        Debug.Log("TestAssets choose null");
    }
    else
    {
        Debug.Log("TestAssets name = " + Selection.activeObject.name);
    }

}

一般这种菜单都可以通过Selection.activeObject/activeGameObject
等等来获取选中对象,当然也可以获取多选的多个对象,这个看下api就知道了


AssetsMenu

AssetsMenu

hierarchy面板菜单
这个菜单还是比较实用的,相对来说也不太一样

[MenuItem("GameObject/Create Other/TestGameObject")]//将菜单放到GameObject菜单中,可以在hierarchy中看到
static void MenuGameObject()
{
    Debug.Log("TestGameObject");
}

将菜单加到GameObject下面,就可以在hierarchy里右键看到了


GameObjectMenu

那么基于这个菜单我们可以做个比较实用的功能,例如右键hierarchy中场景的一个GameObject并且对它进行SetActive为true or false的操作,代码如下:

//快捷键可以为%=ctrl/cmd #=shift &=alt LEFT/RIGHT/UP/DOWN F1-F12,HOME END PGUP PGDN _a~_z
[MenuItem("GameObject/SetActive _a", false, 11)] //11及以后可以在Camera之后显示
static void MenuGameObjectSetActive()//通过按a键来设置所选择GameObject的active状态
{
    Debug.Log("MenuGameObjectSetActive");
    if(Selection.activeGameObject != null)
    {
        Undo.RecordObject(Selection.activeGameObject, "SetActive" + Selection.activeGameObject.activeSelf + " " + Selection.activeGameObject.name);
        Selection.activeGameObject.SetActive(!Selection.activeGameObject.activeSelf);//就算锁定了inpector,也是处理当前选中的
    }
    Debug.Log(Selection.activeObject.name);
}

[MenuItem("GameObject/SetActive", true, 11)]
static bool CheckIsGameObject()//判断是否显示该菜单的校验方法,如果没选择GameObject为灰
{
    UnityEngine.Object selectedObject = Selection.activeObject;
    if(selectedObject != null && selectedObject.GetType() == typeof(GameObject))
    {
        Debug.Log(selectedObject.name);
        return true;
    }
    return false;
}

其中做校验的方法是为了在不选中GameObject的时候能够将菜单灰掉。另外这种菜单可以绑定一个快捷键,这个例子是绑定了a键,菜单中也可以看出来。
最终效果就成了:我选中一个GameObject,只要按下a键就可以SetActive(false),再按下变成true,还是比较实用的吧,基于此可以做很多实用的东西。效果如下图


SetActiveMenu

SetActiveMenu

对话框
对话框比较简单,就是一些内置的api,具体可以查看api,支持了例如简单和复杂对话框、打开保存文件对话框、进度条等等功能
EditorUtility.DisplayCancelableProgressBar("ok", "done", 0.7f)
EditorUtility.ClearProgressBar();
EditorUtility.OpenFilePanel("open", "d:/", ".txt");

progress

Dialog

新窗口
如果要做的事情可能不是与某个GameObject相关,inspector不能满足要求,那么可以创建一个新的窗口,创建新的editor窗口需要继承EditorWindow,代码如下

[CustomEditor(typeof(CloudWindow))]
public class CloudWindow : EditorWindow {

    #region 对话框
    //通过MenuItem按钮来创建这样的一个对话框  
    [MenuItem("Cloud/ShowEditorTestPanel")]
    public static void ConfigDialog()
    {
        EditorWindow.GetWindow(typeof(CloudWindow));
    }

    public UnityEngine.Object go = null;
    string goName= "default";
    float life = 100f;
    bool isAlive = true;
    bool toggleEnabled;
    void OnGUI()
    {
        //Label  
        GUILayout.Label("Label Test", EditorStyles.boldLabel);
        //通过EditorGUILayout.ObjectField可以接受Object类型的参数进行相关操作  
        go = EditorGUILayout.ObjectField(go, typeof(UnityEngine.Object), true);
        //Button  
        if (GUILayout.Button("Button Test"))
        {
            if (go == null)
            {
                Debug.Log("go == null");
            }
            else
            {
                Debug.Log(go.name);
            }
        }
        goName = EditorGUILayout.TextField("textfield", goName);

        toggleEnabled = EditorGUILayout.BeginToggleGroup("optional settings", toggleEnabled);
        if (toggleEnabled)
        {
            isAlive = EditorGUILayout.Toggle("isalive", isAlive);
            life = EditorGUILayout.Slider("life", life, 0, 100);
        }
        EditorGUILayout.EndToggleGroup();
    }


    #endregion

}

好像代码也不复杂,也没什么难度就是常见的ui绘制,效果如下:

newwindow

newwindow

后续
如果有更高的需求可能需要更深入的研究一下unity中editor的相关api和文档
unity还提供了可以在scene窗口中做一些操作,例如画一些辅助线、显示label、操作handler等,具体可以参考http://blog.csdn.net/kun1234567/article/details/19421471
结语
如果把这些代码执行一遍,改改调试一下,理解基本流程,那么已经可以写一些提高工作效率的unity插件了

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

推荐阅读更多精彩内容