Unity3D插件開發教程

一、插件開發的起因

1.日常開發過程中會碰到許多重復且復雜的操作過程，比如數據的存儲，資源文件的管理等等，我們在做這些事情的時候會浪貴很多的時間以及精力。

2.人為操作一些事情的時候，或多或少會出現一些問題。

二、插件的作用

1.提高項目開發的效率

2.增加項目開發的質里

3.增加團隊合作的方便

三、菜單項相關操作

1.菜單項（MenuItem）

一般會在 Project-->Assets底下創建一個Editor文件夾，此文件夾里面主要存放編輯的關於插件相關的內容（腳本），此文件夾里面的腳本，打包項目的時候不會存放到包里面，所以一般插件都會存放到這里面。

第一步：在Editor文件夾里面創建C#腳本：如：MenuTest

第二步：編寫MenuTest插件腳本

引入命名空間：using UnityEditor;

定義的方法前面，必須使用static修飾，且方法上面需要添加：[MenuItem("Menu/Test")]

 

注明：[MenuItem("Menu/Test")] 里面的不同參數，分別代表着使用什么方式打開

//[MenuItem("Menu/Test")]：這種寫法意味着沒有快捷鍵，需要鼠標點擊
    [MenuItem("Menu/Test")]
    public static void Test()
    {
        Debug.Log("Test");
    }

    //_w：表示沒有組合鍵，直接按住鍵盤"w"使用
    [MenuItem("Menu/Test1 _w")]
    public static void Test1()
    {
        Debug.Log("Test1");
    }

    //#w：表示按住 Shift + w 使用
    [MenuItem("Menu/Test2 #w")]
    public static void Test2()
    {
        Debug.Log("Test2");
    }

    //%w：表示按住 Ctrl + w 使用
    [MenuItem("Menu/Test3 %w")]
    public static void Test3()
    {
        Debug.Log("Test3");
    }

    //&w：表示按住 Alt + w 使用
    [MenuItem("Menu/Test4 &w")]
    public static void Test4()
    {
        Debug.Log("Test4");
    }

在Unity3D中效果展示：多出了一個"Menu"菜單，和"MenuTest"腳本中定義的5個方法

2.組件菜單（AddComponentMenu）

目的：方便添加組件相關的操作

第一步：組件菜單的文件存放目錄不存放在Editor下面，在新建一個"Scripts"目錄，並創建"ComponentDemo"腳本

 第二步：在創建的腳本類名上面添加：[AddComponentMenu("Demo/Demo1")]，其中"Demo/Demo1"為開發者自定義的路徑

效果如下：

 除此之外，自定義的組建，在菜單“Component”里面也有

 

3.上下文菜單（ContextMenu）

上下文菜單是定義在組件類里面的方法。

第一步：我們在上文創建的“ComponentDemo”類里面定義一個"ContextMenuDemo()"方法，注意：不能使用static修飾，並用：[ContextMenu("ContextDemo")]標注上下文菜單的名字為：“ContextDemo”

第二步：回到Unity面板中，創建一個游戲物體，並添加“Demo1”組件，然后鼠標在此組件上右擊，就可以看到多了一個“ContextDemo”選項

 

4.必要組件菜單（RequireComponent）

比如：我們要求給游戲物體添加“Demo1”組件的時候，必須帶上“Rigidbody”組件。

 效果：當你給游戲物體添加“Demo1”組件的時候，會自動添加“Rigidbody”組件。

 如果想要移除組件，必須先移除“Demo1”，再移除“Rigidbody”。

 四、自定義Inspector界面

1.屬性相關標識

a.隱藏屬性顯示（HideInInspector）：單純的隱藏變量

b.不顯示屬性（NonSerialized）：不但隱藏變量，並且還會防止該變量的序列化保存，（無論在Inspector面板中設置Int3的值是多少，只要在C#中設置Int3的屬性為“NonSerialized”並且假如設置的值為 3，那么Unity編譯后，Inspector面板中的Int3的值就是3）

c.系列化域（SerializeField）：將私有變量強制顯示在Inspector面板里面

d.關鍵字系列化（Serializable）：可以讓自定義的類（不繼承自：MonoBehaviour的類）顯示在Inspector面板里面

    

  

2.自定義界面屬性

Editor：自定義屬性面板的基類

CustomEditor：類上面的標識

第一步：創建兩個類，EditorDemo，Test1。EditorDemo需要放在Assets-->Editor里面，Test1類放入Scripts里面即可。

第二步：編寫Test1代碼，設置一些屬性，並在里面引入新創建的類TypeDemo

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class Test1 : MonoBehaviour
{
    public int mIntVal;

    public float mFloatVal;

    public string mStrVal;

    public TypeDemo mTypeDemo;
}

[Serializable]//不添加序列化設置，屬性值不會顯示在Inspector面板里
public class TypeDemo
{
    public int tIntVal;
    public string tStrVal;
    public float tFloatVal;
}

第三步：EditorDemo需要繼承自Editor，並聲明：[CustomEditor(typeof(Test1))]

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

//是一個窗口腳本，所以要放在Assets-->Editor下面
[CustomEditor(typeof(Test1))]
public class EditorDemo : Editor
{
    public SerializedObject mObj;//定義序列化目標對象
    //序列化出來幾個屬性，屬性對應的是[CustomEditor(typeof(Test1))]中，Test1類里面的屬性
    public SerializedProperty mIntVal;
    public SerializedProperty mFloatVal;
    public SerializedProperty mStrVal;
    public SerializedProperty mTypeDemo;

    //選擇當前游戲對象
    private void OnEnable()
    {
        //初始化
        this.mObj = new SerializedObject(target);
        //通過字符串名字，查找Test1類里面的屬性，並進行初始化
        this.mIntVal = this.mObj.FindProperty("mIntVal");
        this.mFloatVal = this.mObj.FindProperty("mFloatVal");
        this.mStrVal = this.mObj.FindProperty("mStrVal");

        this.mTypeDemo = this.mObj.FindProperty("mTypeDemo");
    }

    //繪制
    public override void OnInspectorGUI()
    {
        this.mObj.Update();

        EditorGUILayout.PropertyField(this.mIntVal);
        EditorGUILayout.PropertyField(this.mFloatVal);
        EditorGUILayout.PropertyField(this.mStrVal);

        EditorGUILayout.PropertyField(this.mTypeDemo, true);//true屬性意思是設置顯示子節點，也就是顯示TypeDemo里面的屬性

        this.mObj.ApplyModifiedProperties();
    }
}

效果展示：

3.自定義序列化屬性字段

創建一個類Test2

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class Test2 : MonoBehaviour
{
    public EnumDemo mEnumDemo;
    public bool mBool;
    public int mInt;
    public float mFloat;
    public string mStr;
    public Color mColor;
}

[Serializable]
public enum EnumDemo
{
    None,
    BoolVal,
    IntVal,
    FloatVal,
    StrVal,
    Color
}

創建一個類EditorInspectorDemo，放在Assets-->Editor下面

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

[CustomEditor(typeof(Test2))]
public class EditorInspectorDemo : Editor
{
    public SerializedObject mObj;
    public SerializedProperty mEnumDemo;
    public SerializedProperty mBool;
    public SerializedProperty mInt;
    public SerializedProperty mFloat;
    public SerializedProperty mStr;
    public SerializedProperty mColor;
    private void OnEnable()
    {
        this.mObj = new SerializedObject(target);
        this.mEnumDemo = this.mObj.FindProperty("mEnumDemo");
        this.mBool = this.mObj.FindProperty("mBool");
        this.mInt = this.mObj.FindProperty("mInt");
        this.mFloat = this.mObj.FindProperty("mFloat");
        this.mStr = this.mObj.FindProperty("mStr");
        this.mColor = this.mObj.FindProperty("mColor");
    }

    public override void OnInspectorGUI()
    {
        this.mObj.Update();
        EditorGUILayout.PropertyField(this.mEnumDemo);
        //使用switch做條件篩選，this.mEnumDemo.enumValueIndex作為篩選條件，index從0開始，由於我設置枚舉類型的第一個屬性為None，所以case的值從1開始。
        switch (this.mEnumDemo.enumValueIndex)
        {
            case 1:
                EditorGUILayout.PropertyField(this.mBool);
                break;
            case 2:
                EditorGUILayout.PropertyField(this.mInt);
                break;
            case 3:
                EditorGUILayout.PropertyField(this.mFloat);
                break;
            case 4:
                EditorGUILayout.PropertyField(this.mStr);
                break;
            case 5:
                EditorGUILayout.PropertyField(this.mColor);
                break;

        }

        this.mObj.ApplyModifiedProperties();
    }
}

 可以實現：選擇不同的下拉框屬性，下面會出現相對應的設置，步驟和上面“自定義界面屬性”一樣，代碼類似，實現效果如下：

五、自定義操作界面

1.界面的啟動關閉

創建一個ShowWindow類，存放在Assets-->Editor里面，並繼承自EditorWindow

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class WindowDemo : EditorWindow
{
    [MenuItem("Menu/ShowWindow")]
    public static void ShowWindow()
    {
        //使用官方提供的實例化窗口方法調用
        WindowDemo.CreateInstance<WindowDemo>().Show();

        //浮動型的窗口，跟點擊Building Setting出現的窗口效果一樣
        WindowDemo.CreateInstance<WindowDemo>().ShowUtility();

        //彈出窗口時的效果
        WindowDemo.CreateInstance<WindowDemo>().ShowPopup();//此方Y法和下面的OnGUI配合着使用，否則會出現頁面關不掉的情況
    }
    public void OnGUI()
    {
        if (GUILayout.Button("關閉"))
        {
            this.Close();
        }
    }
}

效果展示：

 

 

2.頁面的相關事件機制

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class EditorDemo2 : EditorWindow
{
    [MenuItem("Menu/NewWindow")]
    public static void ShowWindow()
    {
        //使用系統提供的單例模式，在unity面板中打開窗口時，只會出現一個
        EditorWindow.GetWindow<EditorDemo2>().Show();
    }

    //繪制操作面板
    public void OnGUI()
    {
        if (GUILayout.Button("關閉"))
        {
            this.Close();
        }
    }

    public int index_1 = 0;
    //刷新方法，每秒鍾100次
    public void Update()
    {
        index_1++;
        Debug.Log("index_1：" + index_1);
    }

    public int index_2 = 0;
    //刷新方法，刷新周期比Update小
    public void OnInspectorUpdate()
    {
        index_2++;
        Debug.Log("index_2：" + index_2);
    }
    //視圖被刪除的時候觸發
    public void OnDestroy()
    {
        Debug.Log("OnDestroy：觸發");
    }
    //選擇一個對象的時候觸發
    public void OnSelectionChange()
    {
        //獲取選擇Hierarchy里面游戲物體的時候的名字
        for (int i = 0; i < Selection.gameObjects.Length; i++)
        {
            Debug.Log("OnSelectionChange：觸發" + Selection.gameObjects[i].name);
        }

        //獲取選擇Project里面的文件的名字
        for (int i = 0; i < Selection.objects.Length; i++)
        {
            Debug.Log("OnSelectionChange：觸發" + Selection.objects[i].name);
        }
    }
    //獲得焦點的時候觸發
    public void OnFocus()
    {
        Debug.Log("OnFocus：觸發");
    }
    //失去焦點的時候觸發
    public void OnLostFocus()
    {
        Debug.Log("OnLostFocus：觸發");
    }
    //Hierarchy更改的時候觸發
    public void OnHierarchyChange()
    {
        Debug.Log("OnHierarchyChange：觸發");
    }
    //Project更改的時候觸發
    public void OnProjectChange()
    {
        Debug.Log("OnProjectChange：觸發");
    }

}

效果展示：

 

 3.文本/顏色字段

在Assets-->Editor文件夾里面創建TextEditorWindow類，並繼承自EditorWindow，代碼如下：

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class TextEditorWindow : EditorWindow
{
    [MenuItem("Menu/TextEditorWindow")]
    public static void ShowWindow()
    {
        EditorWindow.GetWindow<TextEditorWindow>().Show();
    }
    //為了更方便練習演示，就定義了一個字符串
    public string mText = "默認文字";
    public Color mColor = Color.white;
    public void OnGUI()
    {
        //一行文本，單行輸入框
        this.mText = EditorGUILayout.TextField(this.mText);
        //多行輸入框
        this.mText = EditorGUILayout.TextArea(this.mText);
        //密碼輸入框
        this.mText = EditorGUILayout.PasswordField(this.mText);
        //顏色選擇框
        this.mColor = EditorGUILayout.ColorField(this.mColor);
    }
}

效果展示：

 4.標簽字段

在Assets-->Editor文件夾里面創建TagEditorWindow類，並繼承自EditorWindow，代碼如下：

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class TagEditorWindow : EditorWindow
{
    [MenuItem("Menu/TagEditorWindow")]
    public static void ShowWindow()
    {
        EditorWindow.GetWindow<TagEditorWindow>().Show();
    }

    //為了更方便練習演示，就定義了一個字符串
    public string mText = "默認文字";
    public void OnGUI()
    {
        //標簽
        EditorGUILayout.PrefixLabel(this.mText);//只寫這么一行代碼，窗口里面不出現任何內容
        EditorGUILayout.Space();//換行

        //標簽（下拉框）
        this.mText = EditorGUILayout.TagField(this.mText);
        EditorGUILayout.Space();

        //標簽（非可選擇標簽提示）
        EditorGUILayout.LabelField(this.mText);
        EditorGUILayout.Space();

        //標簽（可選擇標簽提示）
        EditorGUILayout.SelectableLabel(this.mText);
        EditorGUILayout.Space();
    }
}

效果展示：

 5.數字輸入字段

在Assets-->Editor文件夾里面創建NumberEditorWindow類，並繼承自EditorWindow，代碼如下：

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class NumberEditorWindow : EditorWindow
{
    [MenuItem("Menu/NumberEditorWindow")]
    public static void ShowWindow()
    {
        EditorWindow.GetWindow<NumberEditorWindow>().Show();
    }

    public int mInt;
    public float mFloat;
    public void OnGUI()
    {
        EditorGUILayout.LabelField("輸入整形數字");
        this.mInt = EditorGUILayout.IntField(this.mInt);
        EditorGUILayout.LabelField("輸入浮點型數字");
        this.mFloat = EditorGUILayout.FloatField(this.mFloat);
    }
}

效果展示：

 6.滑動條

在Assets-->Editor文件夾里面創建NumberEditorWindow類，並繼承自EditorWindow，代碼如下：

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class SliderEditorWindow : EditorWindow
{
    [MenuItem("Menu/SliderEditorWindow")]
    public static void ShowWindow()
    {
        EditorWindow.GetWindow<SliderEditorWindow>().Show();
    }

    public float mFloat;

    public int mInt;

    public float mMinVal;
    public float mMaxVal;
    public void OnGUI()
    {
        //滑動條  參數1：默認值，參數2：最小值，參數3：最大值
        this.mFloat = EditorGUILayout.Slider(this.mFloat, 0, 100);//取值區間有小數

        this.mInt = EditorGUILayout.IntSlider(this.mInt, 0, 100);//取值區間為整數

        //最小值到最大值的取值范圍，為0-100
        EditorGUILayout.MinMaxSlider(ref mMinVal, ref mMaxVal, 0, 100);
    }
}

效果展示：

 7.位置/大小輸入字段

在Assets-->Editor文件夾里面創建VectorEditorWindow類，並繼承自EditorWindow，代碼如下：

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class VectorEditorWindow : EditorWindow
{
    [MenuItem("Menu/VectorEditorWindow")]
    public static void ShowWindow()
    {
        EditorWindow.GetWindow<VectorEditorWindow>().Show();
    }

    public Vector2 mPos2;
    public Vector3 mPos3;
    public Vector4 mPos4;
    public Rect mRect;
    public Bounds mBounds;
    public void OnGUI()
    {
        this.mPos2 = EditorGUILayout.Vector2Field("二維坐標", this.mPos2);
        this.mPos3 = EditorGUILayout.Vector3Field("三維坐標", this.mPos3);
        this.mPos4 = EditorGUILayout.Vector4Field("四維坐標", this.mPos4);

        EditorGUILayout.Space();
        EditorGUILayout.LabelField("矩陣");
        this.mRect = EditorGUILayout.RectField(this.mRect);
        EditorGUILayout.Space();
        EditorGUILayout.LabelField("間距");
        this.mBounds = EditorGUILayout.BoundsField(this.mBounds);
    }
}

效果展示：

8.選擇字段

在Assets-->Editor文件夾里面創建ChooseEditorWindow類，並繼承自EditorWindow，代碼如下：

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class ChooseEditorWindow : EditorWindow
{
    [MenuItem("Menu/ChooseEditorWindow")]
    public static void ShowWindow()
    {
        EditorWindow.GetWindow<ChooseEditorWindow>().Show();
    }
    public int mIndex;
    public int mIndex2;
    public EnumDemo mEnumDemo;
    public void OnGUI()
    {
        string[] strs = new string[] { "aaa", "bbb", "ccc", "ddd", "eee" };
        int[] ints = new int[] { 111, 222, 333, 444, 555 };

        //選擇
        this.mIndex = EditorGUILayout.Popup(this.mIndex, strs);
        //和上面的方法類似
        this.mIndex2 = EditorGUILayout.IntPopup(this.mIndex2, strs, ints);
        //枚舉
        this.mEnumDemo = (EnumDemo)EditorGUILayout.EnumPopup(this.mEnumDemo);
    }

    public enum EnumDemo
    {
        mString, mInt, mFloat, mDouble, mColor
    }
}

效果展示：

 

 

 9.標簽層對象選擇字段

在Assets-->Editor文件夾里面創建ObjectChooseEditor類，並繼承自EditorWindow，代碼如下：

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class ObjectChooseEditor : EditorWindow
{
    [MenuItem("Menu/ObjectChooseEditor")]
    public static void ShowWindow()
    {
        EditorWindow.GetWindow<ObjectChooseEditor>().Show();
    }

    public string mTag;
    public int mLayer;
    public Object mObject;
    public void OnGUI()
    {
        //標簽，下面兩種寫法，哪個都可以
        //this.mTag = EditorGUILayout.TagField(this.mTag);
        this.mTag = EditorGUILayout.TagField("Tag");
        EditorGUILayout.Space();
        //層
        this.mLayer = EditorGUILayout.LayerField(this.mLayer);
        EditorGUILayout.Space();
        //對象選擇，如果想要存放所有的元素，那么參數就寫為Object： typeof(Object)
        this.mObject = EditorGUILayout.ObjectField("對象選擇器", this.mObject, typeof(Camera), true);
    }
}

效果展示：

 

 

 10.單選字段

在Assets-->Editor文件夾里面創建SingleChoiceEditor類，並繼承自EditorWindow，代碼如下：

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class SingleChoiceEditor : EditorWindow
{
    [MenuItem("Menu/SingleChoiceEditor")]
    public static void ShowWindow()
    {
        EditorWindow.GetWindow<SingleChoiceEditor>().Show();
    }

    public bool mBool;
    public bool mFoldout;
    public void OnGUI()
    {
        //單選字段
        this.mBool = EditorGUILayout.Toggle(this.mBool);
        //單選字段，也可以在bool參數前面加個標簽
        this.mBool = EditorGUILayout.Toggle("是", this.mBool);
        //折疊
        this.mFoldout = EditorGUILayout.Foldout(this.mFoldout, "折疊");
        Debug.Log(this.mFoldout);
        if (this.mFoldout)
        {
            EditorGUILayout.LabelField("A");
            EditorGUILayout.LabelField("B");
            EditorGUILayout.LabelField("C");
        }
    }
}

效果如下：

 

 11.字段分組
在Assets-->Editor文件夾里面創建GroupEditorWindow類，並繼承自EditorWindow，代碼如下：

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class GroupEditorWindow : EditorWindow
{
    [MenuItem("Menu/GroupEditorWindow")]
    public static void ShowWindow()
    {
        EditorWindow.GetWindow<GroupEditorWindow>().Show();
    }

    public bool mBool;

    public Vector2 mVector2;

    public void OnGUI()
    {
        //如果窗口內容過多，可以使用滾動區域，出現滑條
        EditorGUILayout.BeginScrollView(this.mVector2);

        //分組：有開始和結束
        this.mBool = EditorGUILayout.BeginToggleGroup("選擇分組", mBool);
        EditorGUILayout.LabelField("練習分組:ToggleGroup");
        EditorGUILayout.TextField("練習分組:ToggleGroup");
        EditorGUILayout.EndToggleGroup();
        EditorGUILayout.Space();

        //矩陣,水平分組
        Rect mHorizontal = EditorGUILayout.BeginHorizontal();
        EditorGUILayout.LabelField("練習分組:Horizontal");
        EditorGUILayout.TextField("練習分組:Horizontal");
        EditorGUILayout.EndHorizontal();
        EditorGUILayout.Space();

        //矩陣，垂直分組
        Rect mVertical = EditorGUILayout.BeginVertical();
        EditorGUILayout.LabelField("練習分組3");
        EditorGUILayout.TextField("練習分組3");
        EditorGUILayout.EndVertical();
        EditorGUILayout.Space();

        EditorGUILayout.LabelField("聯系分組");
        EditorGUILayout.TextField("聯系分組");

        //結束滾動
        EditorGUILayout.EndScrollView();
    }
}

效果展示：

 

 

 

 12.其他字段

在Assets-->Editor文件夾里面創建OtherEditorWindow類，並繼承自EditorWindow，代碼如下：

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;

public class OtherEditorWindow : EditorWindow
{
    [MenuItem("Menu/OtherEditorWindow")]
    public static void ShowWindow()
    {
        EditorWindow.GetWindow<OtherEditorWindow>().Show();
    }
    public AnimationCurve mAC = new AnimationCurve();
    public Object mObj;
    public bool mSelect;
    public void OnGUI()
    {
        //動畫標簽
        this.mAC = EditorGUILayout.CurveField("動畫片段", this.mAC);
        EditorGUILayout.Space();

        this.mObj = EditorGUILayout.ObjectField("標題", this.mObj, typeof(Transform), true);
        if (this.mObj != null)
        {
            this.mSelect = EditorGUILayout.InspectorTitlebar(this.mSelect, this.mObj);
        }
    }
}

效果展示：