Class SwitchBooleanAction
Hierarchy
-
Action
- SwitchBooleanAction
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
-
Instantiate the action
Parameters
-
triggerOptions: any
defines the trigger options
-
target: any
defines the object containing the boolean
-
propertyPath: string
defines the path to the boolean property in the target object
-
Optional condition: Condition
defines the trigger related conditions
Returns SwitchBooleanAction
-
Properties
on Before Execute ObservableSearch playground for onBeforeExecuteObservable
An event triggered prior to action being executed.
property PathSearch playground for propertyPath
The path to the boolean property in the target object
triggerSearch playground for trigger
Trigger for the action
trigger OptionsSearch playground for triggerOptions
the trigger, with or without parameters, for the action
Methods
executeSearch playground for execute
-
Execute the action toggle the boolean value.
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 ToNext Active ActionSearch playground for skipToNextActiveAction
-
Skips to next active action
Returns void
This defines an action responsible to toggle a boolean once triggered.
https://doc.babylonjs.com/how_to/how_to_use_actions