RSX Code Reference
    Preparing search index...
    • rsx
    • InspectableActionStyle

    Class InspectableActionStyle

    A class that contains all attributes declared on an InspectableAction.

    Index
    constructor
    category developerOnly displayName icon isIconOnly order tooltip
    isDeveloperOnly isIcon isInCategory isOrder isTooltip
    createForMethod
    category: CategoryAttribute

    Method contains information about a category, which is used for grouping fields and methods under a foldout in the inspector. Retrieve the category style for information about the category.

    developerOnly: DeveloperOnlyAttribute

    The method will be hidden on inspectors if the developer mode is not enabled.

    displayName: string

    The method is an action that can be triggered from the inspector UI.

    icon: IconAttribute

    The method has an icon associated with it. This icon can be used when showing on the UI.

    isIconOnly: boolean

    Specifies whether the action should only display an icon or include a label.

    order: OrderAttribute

    Method contains information about its order relative to other fields. Retrieve the order style for information about the order.

    tooltip: DescriptionAttribute

    Method contains information about its tooltip and how it should be displayed in the UI.

    • get isDeveloperOnly(): boolean

      Determines if the action has the developerOnly field set to a valid value.

      Returns boolean

    • get isIcon(): boolean

      Determines if the action has the icon field set to a valid value.

      Returns boolean

    • get isInCategory(): boolean

      Determines if the action has the InCategory field set to a valid value.

      Returns boolean

    • get isOrder(): boolean

      Determines if the action has the order field set to a valid value.

      Returns boolean

    • get isTooltip(): boolean

      Determines if the action has the tooltip field set to a valid value.

      Returns boolean

    • Creates a new InspectableActionStyle from the given method on type;

      Parameters

      • type: Type

        The type to fetch attributes from.

      • name: string

        The name of the method to get the style information from.

      Returns InspectableActionStyle

      The InspectableActionStyle instance for the given method, null if the method is not an action.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods