Class PlayAnimationAction
Hierarchy
-
Action
- PlayAnimationAction
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
-
Instantiate the action
Parameters
-
triggerOptions: any
defines the trigger options
-
target: any
defines the target animation or animation name
-
from: number
defines from where the animation should start (animation frame)
-
to: number
-
Optional loop: boolean
defines if the animation should loop or stop after the first play
-
Optional condition: Condition
defines the trigger related conditions
Returns PlayAnimationAction
-
Properties
fromSearch playground for from
Where the animation should start (animation frame)
Optional loopSearch playground for loop
Define if the animation should loop or stop after the first play.
on Before Execute ObservableSearch playground for onBeforeExecuteObservable
An event triggered prior to action being executed.
toSearch playground for to
Where the animation should stop (animation frame)
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 and play the animation.
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 start an animation once triggered.
https://doc.babylonjs.com/how_to/how_to_use_actions