Unity編輯器擴充套件-選單項

阿新 • • 發佈：2019-01-15

Unity編輯器允許你去新增像內建選單一樣外觀和行為的自定義選單。自定義選單對於那些經常使用的功能提供一種能從編輯器直接訪問的便捷方式。在這一課程中我將對每個描述的主題提供真實的使用示例，用於說明在unity中的選單項是如何建立和使用的。

新增選單項

為了要在頂層工具欄中建立一個新的選單項，你必須去建立一個編輯器指令碼（在專案Editor目錄下的一個指令碼）。此選單項需要是一個靜態的方法且必須使用MenuItem屬性來標識。例如，去新增一個你的團隊和公司經常使用的命令到“Tools”選單。
下面的示例，在Tools選單下添加了一個“Clear PlayerPrefs”選項：

using 
 UnityEngine;
using UnityEditor;

public class MenuItems
{
    [MenuItem("Tools/ClearPlayerPrefs")]
    private static void NewMenuOption()
    {
        PlayerPrefs.DeleteAll();
    }
}

這段程式碼建立了一個叫“Tools”的選單，並在下面放置了一個叫“Clear PlayerPrefs”的選單項。
這裡寫圖片描述
當然我們也可以在一個現成的選單項下面建立新的選單項（例如：在“Windows”選單下），也可以建立多級子選單便於更好的組織選單專案：

using UnityEngine;
using UnityEditor;

public class MenuItemsExample
{
    // Add a new menu item under an existing menu

    [MenuItem("Window/New Option")]
    private static void NewMenuOption()
    {
    }

    // Add a menu item with multiple levels of nesting

    [MenuItem("Tools/SubMenu/Option")]
    private 
 static void NewNestedOption()
    {
    }
}

上面的程式碼產生的結果如下：
這裡寫圖片描述

快捷鍵

為了使超級使用者和喜歡使用鍵盤的使用者工作的更快捷，我們可以為新的選單項關聯一個快捷鍵-使用快捷鍵的組合將自動的啟動他們選單項。
下面是被指定的鍵（它們也可以組合起來使用）：

%-CTRL 在Windows / CMD在OSX
# -Shift
& -Alt
LEFT/RIGHT/UP/DOWN-游標鍵
F1…F12
HOME,END,PGUP,PDDN

字母鍵不是key-sequence的一部分，要讓字母鍵被新增到key-sequence中必須在前面加上下劃線（例如：_g對應於快捷鍵”G”）。
快捷鍵的組合被新增在選單項的路徑後面，並以一個空格分隔。如下顯示的示例：

// Add a new menu item with hotkey CTRL-SHIFT-A

[MenuItem("Tools/New Option %#a")]
private static void NewMenuOption()
{
}

// Add a new menu item with hotkey CTRL-G

[MenuItem("Tools/Item %g")]
private static void NewNestedOption()
{
}

// Add a new menu item with hotkey G
[MenuItem("Tools/Item2 _g")]
private static void NewOptionWithHotkey()
{
}

使用了快捷鍵的選單項將顯示用於啟動它們的快捷鍵，示例如下：
這裡寫圖片描述
注意：這裡沒有驗證重複的快捷鍵，如果定義了多個相同的快捷鍵，那麼也只有一個選單項被呼叫。

特殊路徑

顯示，傳遞到MenuItem屬性上的路徑確定了新的選單項將被放置在哪個頂層選單下。Unity有些特殊的路徑作用於上下文選單（通過右鍵訪問的選單）：

Assets -選單項將被顯示在“Assets”選單下，同時也顯示在右鍵單擊專案檢視時彈出的選單中。
Asset/Create - 選單項將被列出在，當你在專案檢視中單了右鍵選單裡的“Create”子選單中（當你建立了能夠新增專案的新型別時，此功能是是非常有用的）。
CONTEXT/ComponentName - 選單項將出現在給定元件的上下文選單（右鍵單擊顯示的選單）中。

下面顯示了一些如何使用特殊路徑的示例：

// Add a new menu item that is accessed by right-clicking on an asset in the project view

[MenuItem("Assets/Load Additive Scene")]
private static void LoadAdditiveScene()
{
    var selected = Selection.activeObject;
    EditorApplication.OpenSceneAdditive(AssetDatabase.GetAssetPath(selected));
}

// Adding a new menu item under Assets/Create

[MenuItem("Assets/Create/Add Configuration")]
private static void AddConfig()
{
    // Create and add a new ScriptableObject for storing configuration
}

// Add a new menu item that is accessed by right-clicking inside the RigidBody component

[MenuItem("CONTEXT/Rigidbody/New Option")]
private static void NewOpenForRigidBody()
{
}

上面程式碼片段產生的結果如下圖：

這裡寫圖片描述

有效性驗證

有些選單項僅在指定的情況下才可用，否則就應該被禁用。根據它的上下文新增一個驗證方法來啟用/禁用一個選單項。
驗證方法是一個靜態的，並使用MenuItem屬性標記的一個方法，且此屬性傳遞true作為一個驗證引數。
這個驗證方法應該和選單的命令方法有相同的路徑，並且要有一個boolean的返回值，用以確認選單是否被啟用或者禁用。
例如，驗證方法能夠被用於在專案視圖裡一個紋理上的右鍵選單：

[MenuItem("Assets/ProcessTexture")]
private static void DoSomethingWithTexture()
{
}

// Note that we pass the same path, and also pass "true" to the second argument.
[MenuItem("Assets/ProcessTexture", true)]
private static bool NewMenuOptionValidation()
{
    // This returns true when the selected object is a Texture2D (the menu item will be disabled otherwise).
    return Selection.activeObject.GetType() == typeof(Texture2D);
}

當在非任意紋理上單擊右鍵時，此選單項將會被顯示成灰色：
這裡寫圖片描述

控制選單的優先順序

優先順序是個被賦值到選單項一個數字（傳遞給MenuItemde的第3個引數），它控制了選單的顯示順序。
選單項也能夠自動的分組，每50個一個組：

[MenuItem("NewMenu/Option1", false, 1)]
private static void NewMenuOption()
{
}

[MenuItem("NewMenu/Option2", false, 2)]
private static void NewMenuOption2()
{
}

[MenuItem("NewMenu/Option3", false, 3)]
private static void NewMenuOption3()
{
}

[MenuItem("NewMenu/Option4", false, 51)]
private static void NewMenuOption4()
{
}

[MenuItem("NewMenu/Option5", false, 52)]
private static void NewMenuOption5()
{
}

上面的程式碼示例顯示如下的結構，選單項被分為了兩個組：

這裡寫圖片描述

其他相關的類

下面列出了對於新增選單項一些相關的類。

MenuCommand

當新增一個新的選單項到Inspector中（使用 “CONTEXT/Component”）,有時候獲取一個真實元件的引用也是有必要的（例如：修改它的資料）。
這可以通過給新選單項的靜態方法新增一個MenuCommand引數。

[MenuItem("CONTEXT/RigidBody/New Option")]
private static void NewMenuOption(MenuCommand menuCommand)
{
    // The RigidBody component can be extracted from the menu command using the context field.
    var rigid = menuCommand.context as RigidBody;
}

ContextMenu

這個屬性允許你去定義上下文選單。它和使用MenuItem並以“CONTEXT/…”作為路徑定義選單項一樣。
這個屬性不同的是，你能給指定的元件定義預設的上下文選單項，然而使用MeneItem只是為了擴充套件現有的元件選單，比如引擎預設的元件。
示例-元件將顯示一個用於清除資料的選單項：

public class NameBehaviour : MonoBehaviour
{
    public string Name;

    [ContextMenu("Reset Name")]
    private static void ResetName()
    {
        Name = string.Empty;
    }
}

ContextMenuItem

這個屬性被新增到元件類的欄位上，上面顯示了ContextMenu屬性在元件上下文選單中添加了一個選單項，然後ContextMenuItem屬性將在欄位的上下文選單中新增一個選單項。
由於這個屬性被新增到了一個欄位上沒有方法，所有它接受兩個引數：一個用於顯示選單項的名字，一個用於指定一個當選單被選中時要呼叫的例項方法。
例項-新增一個隨機初始化欄位的方法：

public class NameBehaviour : MonoBehaviour
{
    [ContextMenuItem("Randomize Name", "Randomize")]
    public string Name;

    private void Randomize()
    {
        Name = "Some Random Name";
    }
}

上面程式碼的結果顯示了當在欄位上單擊右鍵時彈出的選單項：

這裡寫圖片描述

AddComponentMenu

此屬性允許你去放置指令碼到“Component”選單下的任意位置，而不只是在“Component->Scripts”選單下。你能使用它去更好的組織你的指令碼。這個屬效能夠改善新增指令碼的工作流程。重要提示：你需要重啟才生效。

using UnityEngine;

[AddComponentMenu("Transform/Follow Transform")]
public class FollowTransform : MonoBehaviour
{
}

GenericMenu

GenericMenu讓你可以建立一個自定義的上下文選單和下拉選單，下面這個示例開啟一個帶有綠色區域的視窗，在綠色區域上單擊右鍵將顯示一個選單，當觸發了選單中選中的項時將觸發一個回撥。

using UnityEngine;
using UnityEditor;
using System.Collections;

// This example shows how to create a context menu inside a custom EditorWindow.
// context-click the green area to show the menu

public class GenericMenuExample : EditorWindow
{

    [MenuItem("Example/Open Window")]
    static void Init()
    {
        var window = GetWindow<GenericMenuExample>();
        window.position = new Rect(50, 50, 250, 60);
        window.Show();
    }

    void Callback(object obj)
    {
        Debug.Log("Selected: " + obj);
    }

    void OnGUI()
    {
        Event currentEvent = Event.current;
        Rect contextRect = new Rect(10, 10, 100, 100);
        EditorGUI.DrawRect(contextRect, Color.green);

        if (currentEvent.type == EventType.ContextClick)
        {
            Vector2 mousePos = currentEvent.mousePosition;
            if (contextRect.Contains(mousePos))
            {
                // Now create the menu, add items and show it
                GenericMenu menu = new GenericMenu();
                menu.AddItem(new GUIContent("MenuItem1"), false, Callback, "item 1");
                menu.AddItem(new GUIContent("MenuItem2"), false, Callback, "item 2");
                menu.AddSeparator("");
                menu.AddItem(new GUIContent("SubMenu/MenuItem3"), false, Callback, "item 3");
                menu.ShowAsContext();
                currentEvent.Use();
            }
        }
    }
}

總結

這篇文章說展示的，在Unity編輯器中去擴充套件一個選單項是非常簡單的。
在編輯器中為常用功能建立選單項。可以為規範團隊開發並且能夠節約很多時間。

Unity編輯器擴充套件-選單項

新增選單項

快捷鍵

特殊路徑

有效性驗證

控制選單的優先順序

其他相關的類

MenuCommand

ContextMenu

ContextMenuItem

AddComponentMenu

GenericMenu

總結

原文地址

Unity編輯器擴充套件-選單項

Unity 編輯器擴充套件總結一：編輯器開發入門

unity編輯器擴充套件#2 GUILayout、EditorGUILayout 控制元件整理

unity編輯器擴充套件#1 自定義視窗、面板、和屬性

Unity編輯器擴充套件：如何把asset 格式的資源轉成png

Unity編輯器擴充套件：如何把圖集(Atlas)拆分成單個圖片

Unity編輯器擴充套件

unity編輯器擴充套件之快捷鍵寫法與意義

Unity編輯器擴充套件學習筆記（一）——新增選單選項

Unity 編輯器擴充套件場景檢視內控制物件

Unity 編輯器擴充套件

Unity 編輯器擴充套件，讓開發更加快捷

Unity 編輯器擴充套件教程

【Unity編輯器擴充套件簡介】儲存資料

Unity編輯器擴充套件(音效控制面板，路徑增刪)

unity-編輯器擴充套件

Unity - 編輯器擴充套件

unity編輯器擴充套件學習

Unity 3D編輯器擴充套件介紹、教程（一） —— 建立選單項

unity 編輯器 ---獲取unity編輯器中的所有視窗，並開啟顯示，以備後面編輯器擴充套件

Unity編輯器擴充套件-選單項

新增選單項

快捷鍵

特殊路徑

有效性驗證

控制選單的優先順序

其他相關的類

MenuCommand

ContextMenu

ContextMenuItem

AddComponentMenu

GenericMenu

總結

原文地址

相關推薦