Tsuの雑記¯\_(ツ)_/¯

主に製作メモ・備忘録として使用。製作したアプリのリンクもあります。

【Unity】複数選択式プルダウンメニューを動的に変化させる【エディター拡張】

Unity Editor の拡張機能には,ドロップダウンメニューの作成方法が複数用意されています。

その中には,メニューの内容を動的に変更できる物があります。

本稿では,その使い方について御説明いたします。

(Unity 2018.3.0f2)

EditorGUILayout.MaskField

配列string[]の要素を項目として、プルダウンメニューを作成する関数です。

docs.unity3d.com

まずは,完成したメニューをお見せします。

UnityEditor の Inspector ウィンドウで編集したリストがプルダウンメニューに反映されている画像
メニューが動的に生成されている

コードは,下記のようになっております。

using UnityEngine;
// LINQ の使用
using System.Linq;

// ここからエディター上でのみ有効
#if UNITY_EDITOR
using UnityEditor;

// エディター拡張クラス
[CustomEditor(typeof(Extend))]
public class ExtendedEditor : Editor
{// Editor クラスを継承
    // Extend クラスの変数を扱うために宣言
    Extend extend;

    void OnEnable()
    {// 最初に実行
        // Extend クラスに target を代入
        extend = (Extend)target;
    }

    public override void OnInspectorGUI()
    {// Inspector に表示
        // これ以降の要素に関してエディタによる変更を記録
        EditorGUI.BeginChangeCheck();

        // SerializedObject の内容を更新
        serializedObject.Update();
        // Inspector のコンポーネントに表示する項目名
        var text = "List";
        // ツールチップのテキスト
        var tooltip = "Popup list \"Item\" will be made out of this.";
        // ツールチップ入りラベルの作成
        var label = new GUIContent(text, tooltip);
        // 配列の中身も表示する
        var includeChildren = true;
        // リストを取得
        var property = serializedObject.FindProperty(nameof(extend.list));
        // 配列フィールドの作成
        EditorGUILayout.PropertyField(property, label, includeChildren);

        // SerializedObject の変更を適用
        serializedObject.ApplyModifiedProperties();

        // Inspector のコンポーネントに表示する項目名
        text = "Item";
        // ツールチップのテキスト
        tooltip = "Select some items.";
        // ツールチップ入りラベルの作成
        label = new GUIContent(text, tooltip);
        // 初期値として表示する項目のインデックス番号
        var selectedIndex = extend.index;
        // ドロップダウンの項目にインデックス番号を付与
        System.Func<string, int, string> selector = (string name, int number) => $"{number}: \r{name}";
        // プルダウンメニューに登録する文字列配列
        var displayOptions = extend.list.Select(selector).ToArray();
        // プルダウンメニューの作成
        var index = extend.list.Length > 0 ? EditorGUILayout.MaskField(label, selectedIndex, displayOptions)
            : 0;

        for (var i = 0; i < displayOptions.Count; i++)
        {// ビット演算で選択状態を判定
            if ((index & 1 << i) != 0)
            {// 選択状態の要素をログ出力
                Debug.Log($"{displayOptions[i]} is on!");
            }
        }

        if (EditorGUI.EndChangeCheck())
        {// 操作を Undo に登録
            // Extend クラスの変更を記録
            var objectToUndo = extend;
            // Undo メニューに表示する項目名
            var name = "Extend";
            // 記録準備
            Undo.RecordObject(objectToUndo, name);
            // Undo に記録したい変数を登録
            extend.index = index;
        }
    }
}
// ここまでエディター上でのみ有効
#endif

// 同一オブジェクトへの複数追加を禁止
[DisallowMultipleComponent]
public class Extend : MonoBehaviour
{// エディター拡張の中身
    // リスト
    public string[] list = { };
    // 初期値は“Nothing”
    public int index = 0;
}

ラベルのツールチップは,個人的な好みとして追加しております。

文字列配列string[]にインデックス番号を付与する方法として,今回はLINQSelect関数を使用しました。

docs.microsoft.com

SerializedObject の代入に関しては,nameof演算子を使用しています。

C# のバージョンが 5 以下であれば,次のように記述してください。

// リストを取得
var property = serializedObject.FindProperty("list");

docs.microsoft.com

またインデックス番号を付与する場面に関しては,文字列補間機能を使用しています。

C# のバージョンが 5 以下であれば,次のように記述してください。

// ドロップダウンの項目にインデックス番号を付与
System.Func<string, int, string> selector = (string name, int number) => (number + ": \r" + name);

docs.microsoft.com

以上,複数選択式プルダウンメニューを動的に変化させる方法でした。

択一選択式プルダウンメニューの場合は,こちらの記事をお読みください。

tsu-games.hatenablog.com