Version 2.1.0.0

OdinAttributeDrawer<TAttribute> class

Namespace: Sirenix.OdinInspector.Editor
Assembly: Sirenix.OdinInspector.Editor
public abstract class OdinAttributeDrawer<TAttribute> : OdinDrawer where TAttribute : Attribute

Base class for attribute drawers. Use this class to create your own custom attribute drawers that will work for all types. Alternatively you can derive from OdinAttributeDrawer<TAttribute, TValue> if you want to only support specific types.

Remember to provide your custom drawer with an Sirenix.OdinInspector.Editor.OdinDrawerAttribute in order for it to be located by the Sirenix.OdinInspector.Editor.DrawerLocator.

Odin supports the use of GUILayout and takes care of undo for you. It also takes care of multi-selection in many simple cases. Checkout the manual for more information on handling multi-selection.

Also note that Odin does not require that your custom attribute inherits from Unity's PropertyAttribute.

Inheritance
  • System.Object
  • OdinDrawer
  • OdinAttributeDrawer<TAttribute>
Remarks

Checkout the manual for more information.

Example

Example using the OdinAttributeDrawer<TAttribute, TValue>.

[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false)]
public class CustomRangeAttribute : System.Attribute
{
    public float Min;
    public float Max;

    public CustomRangeAttribute(float min, float max)
    {
        this.Min = min;
        this.Max = max;
    }
}

// Remember to wrap your custom attribute drawer within a #if UNITY_EDITOR condition, or locate the file inside an Editor folder.

public sealed class CustomRangeAttributeDrawer : OdinAttributeDrawer<CustomRangeAttribute, float>
{
    protected override void DrawPropertyLayout(IPropertyValueEntry<float> entry, CustomRangeAttribute attribute, GUIContent label)
    {
        entry.SmartValue = EditorGUILayout.Slider(label, entry.SmartValue, attribute.Min, attribute.Max);
    }
}

// Usage:
public class MyComponent : MonoBehaviour
{
    [CustomRangeAttribute(0, 1)]
    public float MyFloat;
}
Example

Example using the OdinAttributeDrawer<TAttribute>.

[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false)]
public class GUITintColorAttribute : System.Attribute
{
    public Color Color;

    public GUITintColorAttribute(float r, float g, float b, float a = 1)
    {
        this.Color = new Color(r, g, b, a);
    }
}

// Remember to wrap your custom attribute drawer within a #if UNITY_EDITOR condition, or locate the file inside an Editor folder.

public sealed class GUITintColorAttributeDrawer : OdinAttributeDrawer<GUITintColorAttribute>
{
    protected override void DrawPropertyLayout(InspectorProperty property, GUITintColorAttribute attribute, GUIContent label)
    {
       Color prevColor = GUI.color;
       GUI.color *= attribute.Color;
       this.CallNextDrawer(label);
       GUI.color = prevColor;
    }
}

// Usage:
public class MyComponent : MonoBehaviour
{
    [GUITintColor(0, 1, 0)]
    public float MyFloat;
}
Example

Odin uses multiple drawers to draw any given property, and the order in which these drawers are called are defined using the DrawerPriorityAttribute. Your custom drawer injects itself into this chain of drawers based on its DrawerPriorityAttribute. If no DrawerPriorityAttribute is defined, a priority is generated automatically based on the type of the drawer. Each drawer can ether choose to draw the property or not, or pass on the responsibility to the next drawer by calling CallNextDrawer(), as the f attribute does in the example above.

This means that there is no guarantee that your drawer will be called, sins other drawers could have a higher priority than yours and choose not to call CallNextDrawer().

Note that Odin's DefaultDrawerChainResolver have full support for generic class constraints, and if that is not enough, you can also add additional type constraints by overriding CanDrawTypeFilter

Also note that all custom property drawers needs to handle cases where the label provided by the DrawPropertyLayout is null, otherwise exceptions will be thrown when in cases where the label is hidden. For instance when [HideLabel] is used, or the property is drawn within a list where labels are also not shown.

[DrawerPriority(DrawerPriorityLevel.AttributePriority)]
public sealed class MyCustomAttributeDrawer<T> : OdinAttributeDrawer<MyCustomAttribute, T> where T : class
{
    public override bool CanDrawTypeFilter(Type type)
    {
        return type != typeof(string);
    }

    protected override void DrawPropertyLayout(GUIContent label)
    {
        // Draw property here.
    }
}
See Also

Type Parameters

TAttribute

The attribute that this drawer should be applied to.

Constructors

OdinAttributeDrawer()
protected OdinAttributeDrawer()

Fields

AllowsMultipleAttributes
Tells whether or not multiple attributes are allowed.
protected static bool AllowsMultipleAttributes

Properties

Attribute
Gets the attribute that the OdinAttributeDrawer draws for.
public TAttribute Attribute { get; }

Methods

CanDrawAttributeProperty(InspectorProperty)
Tests if the attribute drawer can draw for the specified property.
protected virtual bool CanDrawAttributeProperty(InspectorProperty property)
Parameters
InspectorProperty property

The property to test.

Returns
System.Boolean

true if the drawer can drawn the property. Otherwise false.

CanDrawProperty(InspectorProperty)
Tests if the drawer can draw for the specified property.
public override sealed bool CanDrawProperty(InspectorProperty property)
Parameters
InspectorProperty property

The property to test.

Returns
System.Boolean

true if the drawer can drawn the property. Otherwise false.

DrawPropertyLayout(GUIContent)
Draws the property with the given label. Override this to implement your custom OdinAttributeDrawer.
protected override void DrawPropertyLayout(GUIContent label)
Parameters
UnityEngine.GUIContent label

Optional label for the property.

Extension Methods
Derived Classes