开发unity插件——一次搞定unity编辑器常用功能

转载自：https://yq.aliyun.com/articles/69190

unity
这篇文章主要分享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来组织面板的外观，也可以针对不同的属性进行是否序列化的选择。

序列化类

也可以序列化一个类

[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工具了

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