ButtonAttribute Class

Summary

[Pro-Only] Editor.Editor<T> uses this attribute to add a button at the bottom of the default inspector to run the marked method.
Assembly
Kybernetik.InspectorGadgets.dll
Namespace
InspectorGadgets.Attributes
Interfaces
Base Types
graph BT Type-->Base0["BaseInspectableAttribute"] click Base0 "/inspector-gadgets/api/InspectorGadgets.Attributes/BaseInspectableAttribute" Base0-->Base1["Attribute"] Type-.->Interface0["IComparable<BaseInspectableAttribute>"] Type["ButtonAttribute"] class Type type-node

Syntax

[AttributeUsage(AttributeTargets.Method)]
public sealed class ButtonAttribute : BaseInspectableAttribute, 
    IComparable<BaseInspectableAttribute>

Attributes

Type Description
AttributeUsageAttribute

Properties

Name Value Summary
DisplayIndex int
If set, this inspectable will be drawn at the specified index amongst the regular serialized fields instead of after them.
Label string
The label to use as a prefix before the value. If not set, it will use the name of the attributed member.
LabelContent GUIContent
The UnityEngine.GUIContent used for this inspectable's label, creates from the InspectorGadgets.Attributes.BaseInspectableAttribute.Label and InspectorGadgets.Attributes.BaseInspectableAttribute.Tooltip.
SetDirty bool
If true, clicking the button will automatically call UnityEditor.EditorUtility.SetDirty(UnityEngine.Object) after invoking the method.
Tooltip string
The tooltip to use as for the label. If not set, it will use the full name of the attributed member.
When EditorState
Determines when this attribute should be active.
WhenNullable Nullable<EditorState>
Determines when this attribute should be active.

Methods

Name Value Summary
CompareTo(BaseInspectableAttribute) int
Compares the InspectorGadgets.Attributes.BaseInspectableAttribute.DisplayIndex of this inspectable to the specified `other`.