PropertyScope

class in UnityEditor

Other Versions

Suggest a change

Description

Create a Property wrapper, useful for making regular GUI controls work with SerializedProperty.

Most EditorGUI and EditorGUILayout GUI controls already have overloads that work with SerializedProperty. However, for GUI controls that don't handle SerializedProperty you can wrap them inside BeginProperty and EndProperty as shown in the example below. You can use this for your own custom GUI controls too.

BeginProperty and EndProperty automatically handle default labels, bold font for prefab overrides, revert to prefab right click menu, and setting showMixedValue to true if the values of the property are different when multi-object editing.

#pragma strict
// A slider function that takes a SerializedProperty
function Slider(position: Rect, prop: SerializedProperty, leftValue: float, rightValue: float, label: GUIContent) {
	var scope: var = new EditorGUI.PropertyScope(position, label, prop);
	 {
		label = scope.content;
		EditorGUI.BeginChangeCheck();
		var newValue: var = EditorGUI.Slider(position, label, prop.floatValue, leftValue, rightValue);
		// even when the user didn't touch the control.
		if (EditorGUI.EndChangeCheck())
			prop.floatValue = newValue;
	}
}

class ExampleClass
{
    // A slider function that takes a SerializedProperty
    void Slider(Rect position, SerializedProperty prop, float leftValue, float rightValue, GUIContent label)
    {
        using (var scope = new EditorGUI.PropertyScope(position, label, prop))
        {
            label = scope.content;
            EditorGUI.BeginChangeCheck();
            var newValue = EditorGUI.Slider(position, label, prop.floatValue, leftValue, rightValue);
            // Only assign the value back if it was actually changed by the user.
            // Otherwise a single value will be assigned to all objects when multi-object editing,
            // even when the user didn't touch the control.
            if (EditorGUI.EndChangeCheck())
                prop.floatValue = newValue;
        }
    }
}