Phaser API Documentation



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 sprite.on('animationrestart', listener)

The animation event flow is as follows:

  2. ANIMATION_UPDATE (repeated for however many frames the animation has)
  3. ANIMATION_REPEAT (only if the animation is set to repeat, it then emits more update events after this)
  4. ANIMATION_COMPLETE (only if there is a finite, or zero, repeat count)
  5. 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 ANIMATION_COMPLETE.

If the animation is restarted while it is already playing, ANIMATION_RESTART is emitted.


name type description
animation Phaser.Animations.Animation

A reference to the Animation that has restarted.

frame Phaser.Animations.AnimationFrame

The current Animation Frame of the Animation.

gameObject Phaser.GameObjects.Sprite

A reference to the Game Object on which the animation restarted.

frameKey string

The unique key of the Animation Frame within the Animation.