Phaser API Documentation

  Version: 

Member of: Phaser.Tweens.Tween

play([resetFromTimeline])

Description:

Starts a Tween playing.

You only need to call this method if you have configured the tween to be paused on creation.

If the Tween is already playing, calling this method again will have no effect. If you wish to restart the Tween, use Tween.restart instead.

Calling this method after the Tween has completed will start the Tween playing again from the start. This is the same as calling Tween.seek(0) and then Tween.play().

Parameters:

name type arguments Default description
resetFromTimeline boolean <optional> false

Is this Tween being played as part of a Timeline?

Returns:
Description:

This Tween instance.

Since: 3.0.0