Class IncrementValueAction
Hierarchy (View Summary)
- Action
- IncrementValueAction
Constructors
constructor
-
new IncrementValueAction(
triggerOptions: any,
target: any,
propertyPath: string,
value: any,
condition?: Condition,
): IncrementValueActionInstantiate 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
Optionalcondition: Conditiondefines the trigger related conditions
Returns IncrementValueAction
- triggerOptions: any
Properties
on
An event triggered prior to action being executed.
property
The path of the property to increment in the target.
trigger
Trigger for the action
trigger
the trigger, with or without parameters, for the action
value
The value we should increment the property by.
Methods
execute
-
Execute the action and increment the target of the value amount.
Returns void
get
-
Gets the trigger parameter
Returns any
the trigger parameter
serialize
-
Serializes the actions and its related information.
Parameters
- parent: any
defines the object to serialize in
Returns any
the serialized object
- parent: any
set
-
Sets the trigger parameter
Parameters
- value: any
defines the new trigger parameter
Returns void
- value: any
skip
-
Skips to next active action
Returns void
This defines an action responsible to increment the target value to a desired value once triggered.
See
https://doc.babylonjs.com/features/featuresDeepDive/events/actions