Editor Scripting API
    Preparing search index...

    Class Action

    A UI action that can be triggered or toggled within a widget.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    checkable checked icon iconVisibleInMenu onToggle onTrigger text toolTip

    Methods

    blockSignals getTypeName isOfType isSame

    Constructors

    Properties

    checkable: boolean

    Whether this action can be checked or toggled.

    checked: boolean

    Current checked state of this action.

    icon: Editor.Icon

    Icon displayed for this action.

    iconVisibleInMenu: boolean

    Whether the icon is visible in menus.

    onToggle: signal1<boolean, void>

    Signal emitted when this action is toggled.

    onTrigger: signal1<boolean, void>

    Signal emitted when this action is triggered.

    text

    text: string

    Text label displayed for this action.

    toolTip: string

    Tooltip text shown when hovering over this action.

    Methods

    • Block or unblock signals from being emitted by this action.

      Parameters

      • blocked: boolean

      Returns void

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods