OnInspectorInitAttribute class

Namespace:	Sirenix.OdinInspector
Assembly:	Sirenix.OdinInspector.Attributes

[AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Module | AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum | AttributeTargets.Constructor | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Event | AttributeTargets.Interface | AttributeTargets.Parameter | AttributeTargets.Delegate | AttributeTargets.ReturnValue | AttributeTargets.GenericParameter | AttributeTargets.All, AllowMultiple = true, Inherited = false)]
[Conditional("UNITY_EDITOR")]
[DontApplyToListElements]
[IncludeMyAttributes]
[HideInTables]
public class OnInspectorInitAttribute : ShowInInspectorAttribute, _Attribute

The OnInspectorInit attribute takes in an action string as an argument (typically the name of a method to be invoked, or an expression to be executed), and executes that action when the property's drawers are initialized in the inspector.

Initialization will happen at least once during the first drawn frame of any given property, but may also happen several times later, most often when the type of a polymorphic property changes and it refreshes its drawer setup and recreates all its children.

Inheritance

System.Object
System.Attribute
ShowInInspectorAttribute
OnInspectorInitAttribute

Example

The following example demonstrates how OnInspectorInit works.

public class MyComponent : MonoBehaviour
{
    // Display current time for reference.
    [ShowInInspector, DisplayAsString, PropertyOrder(-1)]
    public string CurrentTime { get { GUIHelper.RequestRepaint(); return DateTime.Now.ToString(); } }

    // OnInspectorInit executes the first time this string is about to be drawn in the inspector.
    // It will execute again when the example is reselected.
    [OnInspectorInit("@TimeWhenExampleWasOpened = DateTime.Now.ToString()")]
    public string TimeWhenExampleWasOpened;

    // OnInspectorInit will not execute before the property is actually "resolved" in the inspector.
    // Remember, Odin's property system is lazily evaluated, and so a property does not actually exist
    // and is not initialized before something is actually asking for it.
    // 
    // Therefore, this OnInspectorInit attribute won't execute until the foldout is expanded.
    [FoldoutGroup("Delayed Initialization", Expanded = false, HideWhenChildrenAreInvisible = false)]
    [OnInspectorInit("@TimeFoldoutWasOpened = DateTime.Now.ToString()")]
    public string TimeFoldoutWasOpened;
}

Constructors

OnInspectorInitAttribute()

This constructor should be used when the attribute is placed directly on a method.

public OnInspectorInitAttribute()

OnInspectorInitAttribute(String)

This constructor should be used when the attribute is placed on a non-method member.

public OnInspectorInitAttribute(string action)

Parameters

System.String

action

Fields

Action

public string Action