Phaser API Documentation



The Tween Loop Event.

This event is dispatched by a Tween when it loops.

This event will only be dispatched if the Tween has a loop count set.

If a Tween has a loopDelay set, this event will fire after that delay expires.

The difference between loop and repeat is that repeat is a property setting, where-as loop applies to the entire Tween.

Listen to it from a Tween instance using Tween.on('loop', listener), i.e.:

var tween = this.tweens.add({
    targets: image,
    x: 500,
    ease: 'Power1',
    duration: 3000,
    loop: 6
tween.on('loop', listener);


name type description
tween Phaser.Tweens.Tween

A reference to the Tween instance that emitted the event.

targets any | Array.<any>

The targets of the Tween. If this Tween has multiple targets this will be an array of the targets.

Since: 3.19.0