Unity自定义编辑器界面（Inspector界面）

Z时代
2024-01-10
分类：综合

在开发的过程中，往往会需要在组件中添加一些按钮，用于执行一些自定义的操作。

例如你有一个组件A，里面有一个List<Collider>，你想在这个List中存放当前Scene中所有的碰撞体数据。那么你会在组件A中写一个方法Find去遍历获取，一种情况你可以运行Unity的时候在Start方法中去执行Find方法，如果你想不运行Unity的情况下就获取到，那么可以使用[ExecuteInEditMode]标签，然后依旧在Start方法中执行Find方法。再或者就是这篇要介绍的自定义编辑器界面来处理。

首先我们简单的写个组件如下：


using UnityEngine;
public class Test : MonoBehaviour
{
  public float speed;
  public int length;
  public void Reset()
  {
    speed = 0;
    length = 0;
  }
}

我们在一个GameObject上添加该组件后，Inspector界面的显示为

然后我们可以在Editor目录下建一个新的cs脚本，用于自定义该组件Inspector界面的显示，代码如下：


using UnityEditor;
using UnityEngine;
//添加这个标签，可以选择多个拥有Test组件的GameObject进行同时修改，否则会提示Multi-object editing not supported
[CanEditMultipleObjects]
//关联对应的MonoBehaviour类
[CustomEditor(typeof(Test))]
public class TestInspector : Editor
{
  public override void OnInspectorGUI()
  {
    Test test = target as Test;
    //添加了这句，当你选中一个带有Test组件的GameObject时，修改了属性，点击工具栏Edit，会显示Undo RecordTest和Redo RecordTest用于撤销和重做
    //同时如果是在prefab中，加上这句，在修改了属性之后prefab会知道属性的变化，你可以apply或revert，否则prefab无法检测出。（5.3版本之前使用EditorUtility.SetDirty(test);）
    Undo.RecordObject(test, "RecordTest");
    //显示默认视图（即Test的speed和length）
    base.OnInspectorGUI();
    //在默认视图下方添加一行
    EditorGUILayout.BeginHorizontal();
    if (GUILayout.Button("Button 1"))
    {
      //点击按钮触发
      Debug.Log("name:" + test.name);
      test.speed = 100;
      //通知Prefab属性变化，5.3版本前使用下面这句，之后使用Undo.RecordObject
      //EditorUtility.SetDirty(test);
    }
    if (GUILayout.Button("Button 2"))
    {
      //targets 表示选中的多个组件
      foreach (Object obj in targets)
      {
        Debug.Log("name:" + obj.name);
        Test item = obj as Test;
        item.Reset();
      }
    }
    EditorGUILayout.EndHorizontal();
    if (GUI.changed)
    {
      //如果属性改变时调用
    }
  }
}