Editor

Description

Base class to derive custom Editors from. Use this to create your own custom inspectors and editors for your objects.

Consider a script MyPlayer with variables for armor, damage, and a reference to a gun GameObject:

#pragma strict
// This is not an editor script.
public var armor: int = 75;
public var damage: int = 25;
public var gun: GameObject;
function Update() {
	// Update logic here...
}

using UnityEngine;
using System.Collections;

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

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

Using a custom Editor, the apperance of the script in the Inspector can be changed, for example to look like this:


Custom editor in the Inspector.

You can attach the Editor to a custom component by using the CustomEditor attribute.

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.

#pragma strict
// Custom Editor using SerializedProperties.
// Automatic handling of multi-object editing, undo, and prefab overrides.
@CustomEditor(MyPlayer)
@CanEditMultipleObjects
public class MyPlayerEditor extends Editor {
	var damageProp: SerializedProperty;
	var armorProp: SerializedProperty;
	var gunProp: SerializedProperty;
	function OnEnable() {
		// Setup the SerializedProperties.
		damageProp = serializedObject.FindProperty("damage");
		armorProp = serializedObject.FindProperty("armor");
		gunProp = serializedObject.FindProperty("gun");
	}
	public override function 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.
	function ProgressBar(value: float, label: String) {
		// Get a rect for the progress bar using the same margins as a textfield:
		var rect: Rect = GUILayoutUtility.GetRect(18, 18, "TextField");
		EditorGUI.ProgressBar(rect, value, label);
		EditorGUILayout.Space();
	}
}

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 ();
	}
}

Alternatively, if automatic handling of multi-object editing, undo, and prefab overrides is not needed, the script variables can be modified directly by the editor without using the SerializedObject and SerializedProperty system, as in the example below.

#pragma strict
// Example script with properties.
public class MyPlayer extends MonoBehaviour {
	public var damage: int;
	public var armor: int;
	public var gun: GameObject;
	// ...other code...
}
// Custom Editor the "old" way by modifying the script variables directly.
// No handling of multi-object editing, undo, and prefab overrides!
@CustomEditor(MyPlayer)
public class MyPlayerEditor extends Editor {
	public override function OnInspectorGUI() {
		var mp: MyPlayer = MyPlayertarget;
		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");
		var allowSceneObjects: boolean = !EditorUtility.IsPersistent(target);
		mp.gun = GameObjectEditorGUILayout.ObjectField("Gun Object", mp.gun, GameObject, allowSceneObjects);
	}
	// Custom GUILayout progress bar.
	function ProgressBar(value: float, label: String) {
		// Get a rect for the progress bar using the same margins as a textfield:
		var rect: Rect = GUILayoutUtility.GetRect(18, 18, "TextField");
		EditorGUI.ProgressBar(rect, value, label);
		EditorGUILayout.Space();
	}
}

using UnityEditor;
using UnityEngine;
using System.Collections;


// Example script with properties.
public class MyPlayer : 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(MyPlayer))]
public class MyPlayerEditor : 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 ();
	}
}

Variables

Public Functions

Static Functions

Messages

Inherited members