The Animation Restart Event.
This event is dispatched by a Sprite when an animation restarts playing on it.
This only happens when the
Sprite.anims.restart method is called.
Listen for it on the Sprite using
The animation event flow is as follows:
ANIMATION_UPDATE(repeated for however many frames the animation has)
ANIMATION_REPEAT(only if the animation is set to repeat, it then emits more update events after this)
ANIMATION_COMPLETE(only if there is a finite, or zero, repeat count)
ANIMATION_COMPLETE_KEY(only if there is a finite, or zero, repeat count)
If the animation is stopped directly, the
ANIMATION_STOP event is dispatched instead of
If the animation is restarted while it is already playing,
ANIMATION_RESTART is emitted.
A reference to the Animation that has restarted.
The current Animation Frame of the Animation.
A reference to the Game Object on which the animation restarted.
The unique key of the Animation Frame within the Animation.