Class InspectorAction

The InspectorAction class provides the UI representation for the InspectableAction.

Index

Constructors

Properties

Accessors

isActive isDisabled

Methods

Constructors

constructor

new InspectorAction(
    context: InspectorContext,
    name: string,
    action: InspectableAction<any>,
    content: UIContent,
    layout: InspectorFormLayoutSection,
    tooltip?: string,
): InspectorAction
Creates a new inspector action from a method and a content to be shown on the button.
Parameters
- context: InspectorContext
  Context shared by all inspectable fields and actions created by the same parent.
- name: string
  The action name.
- action: InspectableAction<any>
  The action method.
- content: UIContent
  A content to be shown on the button.
- layout: InspectorFormLayoutSection
  A layout to contain the button.
- Optionaltooltip: string
  A tooltip to be used on the button.
Returns InspectorAction

Properties

`Readonly`name

name: string

Name of the action.

Accessors

isActive

get isActive(): boolean

Activates or deactivates the underlying UI elements.

Returns boolean
set isActive(value: boolean): void
Parameters
- value: boolean
Returns void

isDisabled

get isDisabled(): boolean

Disables or enables the underlying UI elements. Disabled elements cannot be interacted with and have a faded out appearance.

Returns boolean
set isDisabled(value: boolean): void
Parameters
- value: boolean
Returns void

Methods

destroy

destroy(): void

Returns void