在開發的過程中,往往會需要在組件中添加一些按鈕,用於執行一些自定義的操作。
例如你有一個組件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)
{
//如果屬性改變時調用
}
}
}
這樣顯示界面就會變爲
這樣我們就可以在不運行unity的情況下執行一些組件方法,方便使用。
一些需要注意的如[CanEditMultipleObjects],Undo.RecordObject,EditorUtility.SetDirty在代碼中註釋了,大家可以自己嘗試看看對應的作用。
若我們Inspector面板有很多參數,我們可以通過UnityEngine.HeaderAttribute標籤來新增Title,用UnityEngine.SpaceAttribute來添加空行,使其看起來更加清晰。例如:
[Header("Animation Setting")]
public string idle;
public string walk;
[Space]
public string skill;
Inspector面板的效果如下: