Class IncrementValueAction
Hierarchy
- Action
- IncrementValueAction
Index
Constructors
constructor
Instantiate the action
Parameters
triggerOptions: any
defines the trigger options
target: any
defines the object containing the property
propertyPath: string
defines the path of the property to increment in the target
value: any
defines the value value we should increment the property by
Optional condition: Condition
defines the trigger related conditions
Returns IncrementValueAction
Properties
on Before Execute ObservableSearch playground for onBeforeExecuteObservable
An event triggered prior to action being executed.
property PathSearch playground for propertyPath
The path of the property to increment in the target.
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 we should increment the property by.
Methods
executeSearch playground for execute
Execute the action and increment the target of the value amount.
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 increment the target value to a desired value once triggered.
https://doc.babylonjs.com/how_to/how_to_use_actions