Class SetStateAction
Hierarchy (View Summary)
- Action
- SetStateAction
Constructors
constructor
-
new SetStateAction(
triggerOptions: any,
target: any,
value: string,
condition?: Condition,
): SetStateActionInstantiate 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
Optionalcondition: Conditiondefines the trigger related conditions
Returns SetStateAction
- triggerOptions: any
Properties
on
An event triggered prior to action being executed.
trigger
trigger: number
Trigger for the action
trigger
triggerOptions: any
the trigger, with or without parameters, for the action
value
value: string
The value to store in the state field.
Methods
execute
-
Execute the action and store the value on the target state property.
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 set a the state field of the target to a desired value once triggered.
See
https://doc.babylonjs.com/features/featuresDeepDive/events/actions