Phaser API Documentation

restart([includeDelay], [resetRepeats])


Restarts the current animation from its beginning.

You can optionally reset the delay and repeat counters as well.

Calling this will fire the ANIMATION_RESTART event immediately.

If you includeDelay then it will also fire the ANIMATION_START event once the delay has expired, otherwise, playback will just begin immediately.


name type arguments Default description
includeDelay boolean <optional> false

Whether to include the delay value of the animation when restarting.

resetRepeats boolean <optional> false

Whether to reset the repeat counter or not?


The Game Object that owns this Animation Component.

Since: 3.0.0