Class SetStateAction
Hierarchy
- Action
- SetStateAction
Index
Constructors
constructor
Instantiate the action
Parameters
triggerOptions: any
defines the trigger options
target: any
defines the object containing the state property
value: string
defines the value to store in the state field
Optional condition: Condition
defines the trigger related conditions
Returns SetStateAction
Properties
on Before Execute ObservableSearch playground for onBeforeExecuteObservable
An event triggered prior to action being executed.
triggerSearch playground for trigger
Trigger for the action
trigger OptionsSearch playground for triggerOptions
the trigger, with or without parameters, for the action
valueSearch playground for value
The value to store in the state field.
Methods
executeSearch playground for execute
Execute the action and store the value on the target state property.
Returns void
get Trigger ParameterSearch playground for getTriggerParameter
Gets the trigger parameter
Returns any
the trigger parameter
serializeSearch playground for serialize
Serializes the actions and its related information.
Parameters
parent: any
defines the object to serialize in
Returns any
the serialized object
set Trigger ParameterSearch playground for setTriggerParameter
Sets the trigger parameter
Parameters
value: any
defines the new trigger parameter
Returns void
skip To Next Active ActionSearch playground for skipToNextActiveAction
Skips to next active action
Returns void
This defines an action responsible to set a the state field of the target to a desired value once triggered.
https://doc.babylonjs.com/how_to/how_to_use_actions