Babylon.js API documentation|

Class Action

The action to be carried out following a trigger

see: https://doc.babylonjs.com/features/featuresDeepDive/events/actions#available-actions

Hierarchy

Action

Implements

IAction

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Action(triggerOptions: any, condition?: Condition): Action

- Defined in .temp/docdirectory/doc.d.ts:1640
Creates a new Action

Parameters
- triggerOptions: any
  
  the trigger, with or without parameters, for the action
- Optional condition: Condition
  
  an optional determinant of action
Returns Action

Properties

onBeforeExecuteObservable Search playground for onBeforeExecuteObservable

onBeforeExecuteObservable: Observable<Action>

An event triggered prior to action being executed.

trigger Search playground for trigger

trigger: number

Trigger for the action

triggerOptions Search playground for triggerOptions

triggerOptions: any

the trigger, with or without parameters, for the action

Methods

execute Search playground for execute

execute(evt?: ActionEvent): void

- Defined in .temp/docdirectory/doc.d.ts:1672
Execute placeholder for child classes

Parameters
- Optional evt: ActionEvent
  
  optional action event
Returns void

getTriggerParameter Search playground for getTriggerParameter

getTriggerParameter(): any

Implementation of IAction.getTriggerParameter
- Defined in .temp/docdirectory/doc.d.ts:1652
Gets the trigger parameter

Returns any
the trigger parameter

serialize Search playground for serialize

serialize(parent: any): any

Implementation of IAction.serialize
- Defined in .temp/docdirectory/doc.d.ts:1698
Serialize placeholder for child classes

Parameters
- parent: any
  
  of child
Returns any
the serialized object

setTriggerParameter Search playground for setTriggerParameter

setTriggerParameter(value: any): void

- Defined in .temp/docdirectory/doc.d.ts:1657
Sets the trigger parameter

Parameters
- value: any
  
  defines the new trigger parameter
Returns void

skipToNextActiveAction Search playground for skipToNextActiveAction

skipToNextActiveAction(): void

- Defined in .temp/docdirectory/doc.d.ts:1676
Skips to next active action

Returns void

then Search playground for then

then(action: Action): Action

Implementation of IAction.then
- Defined in .temp/docdirectory/doc.d.ts:1683
Adds action to chain of actions, may be a DoNothingAction

see
https://www.babylonjs-playground.com/#1T30HR#0

Parameters
- action: Action
  
  defines the next action to execute
Returns Action
The action passed in