Editor

説明

カスタムエディターを派生する基本クラス。これを使用して独自のインスペクターとオブジェクト用のエディターを作成します。

鎧や、ダメージ、銃の GameObject へ参照する変数のスクリプト MyPlayer があるとします。

using UnityEngine;
using System.Collections;

// This is not an editor script.
public class MyPlayer : MonoBehaviour {
    public int armor = 75;
    public int damage = 25;
    public GameObject gun;

    void Update () {
    // Update logic here...
    }
}

カスタムエディターを使用して、インスペクター上のスクリプトの表示を例えば次のように変更することができます。


Custom editor in the Inspector.

エディターをカスタムのコンポーネントにアタッチするために CustomEditor 属性を使用できます。

There are multiple ways to design custom Editors. If you want the Editor to support multi-object editing, you can use the CanEditMultipleObjects attribute. Instead of modifying script variables directly, it's advantageous to use the SerializedObject and SerializedProperty system to edit them, since this automatically handles multi-object editing, undo, and prefab overrides. If this approach is used a user can select multiple assets in the hierarchy window and change the values for all of them at once.

using UnityEditor;
using UnityEngine;
using System.Collections;

// Custom Editor using SerializedProperties.
// Automatic handling of multi-object editing, undo, and prefab overrides.
[CustomEditor(typeof(MyPlayer))]
[CanEditMultipleObjects]
public class MyPlayerEditor : Editor {
    SerializedProperty damageProp;
    SerializedProperty armorProp;
    SerializedProperty gunProp;

    void OnEnable () {
        // Setup the SerializedProperties.
        damageProp = serializedObject.FindProperty ("damage");
        armorProp = serializedObject.FindProperty ("armor");
        gunProp = serializedObject.FindProperty ("gun");
    }

    public override void OnInspectorGUI() {
        // Update the serializedProperty - always do this in the beginning of OnInspectorGUI.
        serializedObject.Update ();

        // Show the custom GUI controls.
        EditorGUILayout.IntSlider (damageProp, 0, 100, new GUIContent ("Damage"));

        // Only show the damage progress bar if all the objects have the same damage value:
        if (!damageProp.hasMultipleDifferentValues)
            ProgressBar (damageProp.intValue / 100.0f, "Damage");

        EditorGUILayout.IntSlider (armorProp, 0, 100, new GUIContent ("Armor"));

        // Only show the armor progress bar if all the objects have the same armor value:
        if (!armorProp.hasMultipleDifferentValues)
            ProgressBar (armorProp.intValue / 100.0f, "Armor");

        EditorGUILayout.PropertyField (gunProp, new GUIContent ("Gun Object"));

        // Apply changes to the serializedProperty - always do this in the end of OnInspectorGUI.
        serializedObject.ApplyModifiedProperties ();
    }

    // Custom GUILayout progress bar.
    void ProgressBar (float value, string label) {
        // Get a rect for the progress bar using the same margins as a textfield:
        Rect rect = GUILayoutUtility.GetRect (18, 18, "TextField");
        EditorGUI.ProgressBar (rect, value, label);
        EditorGUILayout.Space ();
    }
}

代わりに、もしマルチオブジェクト編集のハンドリングや取り消し、 プレハブの上書きを必要としない場合、スクリプト変数は SerializedObject や SerializedProperty を使用せずに 次のサンプルのようにエディター上で直接編集できます。

using UnityEditor;
using UnityEngine;
using System.Collections;


// Example script with properties.
public class MyPlayerAlternative : MonoBehaviour {
    public int damage;
    public int armor;
    public GameObject gun;

    // ...other code...
}


// Custom Editor the "old" way by modifying the script variables directly.
// No handling of multi-object editing, undo, and prefab overrides!
[CustomEditor (typeof(MyPlayerAlternative))]
public class MyPlayerEditorAlternative : Editor {

    public override void OnInspectorGUI () {
        MyPlayer mp = (MyPlayer)target;

        mp.damage = EditorGUILayout.IntSlider ("Damage", mp.damage, 0, 100);
        ProgressBar (mp.damage / 100.0f, "Damage");

        mp.armor = EditorGUILayout.IntSlider ("Armor", mp.armor, 0, 100);
        ProgressBar (mp.armor / 100.0f, "Armor");

        bool allowSceneObjects = !EditorUtility.IsPersistent (target);
        mp.gun = (GameObject)EditorGUILayout.ObjectField ("Gun Object", mp.gun, typeof(GameObject), allowSceneObjects);
    }

    // Custom GUILayout progress bar.
    void ProgressBar (float value, string label) {
        // Get a rect for the progress bar using the same margins as a textfield:
        Rect rect = GUILayoutUtility.GetRect (18, 18, "TextField");
        EditorGUI.ProgressBar (rect, value, label);
        EditorGUILayout.Space ();
    }
}

変数

Public 関数

Protected 関数

Static 関数

メッセージ

継承メンバー