Phaser API Documentation

  Version: 

Member of: Phaser.Tweens.Tween

remove()

Description:

Immediately removes this Tween from the TweenManager and all of its internal arrays, no matter what stage it as it. Then sets the tween state to REMOVED.

You should dispose of your reference to this tween after calling this method, to free it from memory.

Returns:
Description:

This Tween instance.

Since: 3.17.0