Class: UIActionsComponent

Common component classes hoisted to the top level too.

Extends

• Component

Indexable

[field: string]: unknown

Constructors

Constructor

new UIActionsComponent(): UIActionsComponent;

Returns

UIActionsComponent

Inherited from

Component.constructor

Properties

Property	Modifier	Type	Default value	Inherited from
dirty	public	boolean	true	Component.dirty
enabled	public	boolean	true	Component.enabled

Methods

Add()

Add(
   on, 
   action, 
   target?, 
   value?
): boolean;

Sets the first free slot; false when all are used.

Parameters

Parameter	Type	Default value
on	| "hidden" | "none" | "start" | "click" | "press" | "release" | "enter" | "leave" | "toggle-on" | "toggle-off" | "value-changed" | "page-changed" | "submit" | "shown"	undefined
action	| "show" | "hide" | "toggle" | "activate" | "deactivate" | "toggle-active" | "next-page" | "previous-page" | "set-page" | "play-audio" | "stop-audio" | "play-animation" | "load-scene" | "load-scene-additive" | "open-store" | "send-event"	undefined
target	number | null	null
value	string	''

Returns

boolean

---

GetSlot()

GetSlot(i): UIActionSlot;

Slot i's fields: on{i}, target{i}, do{i}, value{i}.

Parameters

Parameter	Type
i	number

Returns

UIActionSlot