Phaser API Documentation

  Version: 
remove(tween)

Description:

Removes the given Tween from this Tween Manager, even if it hasn't started playback yet. If this method is called while the Tween Manager is processing an update loop, then the tween will be flagged for removal at the start of the next frame. Otherwise, it is removed immediately.

The removed tween is not destroyed. It is just removed from this Tween Manager.

Parameters:

name type description
tween Phaser.Tweens.Tween

The Tween to be removed.

Returns:
Description:

This Tween Manager instance.

Since: 3.17.0