Phaser Class: Tween

new Tween(object, game)

Tween constructor Create a new <code>Tween</code>.

Parameters:

Name	Type	Description
`object`	object	Target object will be affected by this tween.
`game`	Phaser.Game	Current game instance.

Source:

tween/Tween.js, line 16

Members

game

Properties:

Name	Type	Description
`game`	Phaser.Game	A reference to the currently running Game.

Source:

tween/Tween.js, line 28

isRunning

Properties:

Name	Type	Description
`isRunning`	boolean	Description.

Default Value:

false

Source:

tween/Tween.js, line 174

onComplete

Properties:

Name	Type	Description
`onComplete`	Phaser.Signal	Description.

Source:

tween/Tween.js, line 168

onStart

Properties:

Name	Type	Description
`onStart`	Phaser.Signal	Description.

Source:

tween/Tween.js, line 163

pendingDelete

Properties:

Name	Type	Description
`pendingDelete`	boolean	If this tween is ready to be deleted by the TweenManager.

Default Value:

false

Source:

tween/Tween.js, line 153

Methods

chain() → {Phaser.Tween}

You can chain tweens together by passing a reference to the chain function. This enables one tween to call another on completion. You can pass as many tweens as you like to this function, they will each be chained in sequence.

Source:

tween/Tween.js, line 380

Returns:

Itself.

Type: Phaser.Tween

delay(amount) → {Phaser.Tween}

Sets a delay time before this tween will start.

Parameters:

Name	Type	Description
`amount`	number	The amount of the delay in ms.

Source:

tween/Tween.js, line 309

Returns:

Itself.

Type: Phaser.Tween

easing(easing) → {Phaser.Tween}

Set easing function this tween will use, i.e. Phaser.Easing.Linear.None.

Parameters:

Name	Type	Description
`easing`	function	The easing function this tween will use, i.e. Phaser.Easing.Linear.None.

Source:

tween/Tween.js, line 352

Returns:

Itself.

Type: Phaser.Tween

interpolation(interpolation) → {Phaser.Tween}

Set interpolation function the tween will use, by default it uses Phaser.Math.linearInterpolation.

Parameters:

Name	Type	Description
`interpolation`	function	The interpolation function to use (Phaser.Math.linearInterpolation by default)

Source:

tween/Tween.js, line 366

Returns:

Itself.

Type: Phaser.Tween

loop() → {Phaser.Tween}

Loop a chain of tweens

Usage: game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true) .to({ y: 300 }, 1000, Phaser.Easing.Linear.None) .to({ x: 0 }, 1000, Phaser.Easing.Linear.None) .to({ y: 0 }, 1000, Phaser.Easing.Linear.None) .loop();

Source:

tween/Tween.js, line 394

Returns:

Itself.

Type: Phaser.Tween

onCompleteCallback(callback) → {Phaser.Tween}

Sets a callback to be fired when the tween completes. Note: callback will be called in the context of the global scope.

Parameters:

Name	Type	Description
`callback`	function	The callback to invoke on completion.

Source:

tween/Tween.js, line 441

Returns:

Itself.

Type: Phaser.Tween

onStartCallback(callback) → {Phaser.Tween}

Sets a callback to be fired when the tween starts. Note: callback will be called in the context of the global scope.

Parameters:

Name	Type	Description
`callback`	function	The callback to invoke on start.

Source:

tween/Tween.js, line 413

Returns:

Itself.

Type: Phaser.Tween

onUpdateCallback(callback) → {Phaser.Tween}

Sets a callback to be fired each time this tween updates. Note: callback will be called in the context of the global scope.

Parameters:

Name	Type	Description
`callback`	function	The callback to invoke each time this tween is updated.

Source:

tween/Tween.js, line 427

Returns:

Itself.

Type: Phaser.Tween

pause()

Pauses the tween.

Source:

tween/Tween.js, line 455

repeat(times) → {Phaser.Tween}

Sets the number of times this tween will repeat.

Parameters:

Name	Type	Description
`times`	number	How many times to repeat.

Source:

tween/Tween.js, line 323

Returns:

Itself.

Type: Phaser.Tween

resume()

Resumes a paused tween.

Source:

tween/Tween.js, line 465

start(time) → {Phaser.Tween}

Starts the tween running. Can also be called by the autoStart parameter of Tween.to.

Parameters:

Name	Type	Description
`time`	number	Description.

Source:

tween/Tween.js, line 240

Returns:

Itself.

Type: Phaser.Tween

stop() → {Phaser.Tween}

Stops the tween if running and removes it from the TweenManager. If there are any onComplete callbacks or events they are not dispatched.

Source:

tween/Tween.js, line 293

Returns:

Itself.

Type: Phaser.Tween

to(properties, duration, ease, autoStart, delay, repeat, yoyo) → {Phaser.Tween}

Configure the Tween

Parameters:

Name	Type	Description
`properties`	object	Properties you want to tween.
`duration`	number	Duration of this tween.
`ease`	function	Easing function.
`autoStart`	boolean	Whether this tween will start automatically or not.
`delay`	number	Delay before this tween will start, defaults to 0 (no delay).
`repeat`	boolean	Should the tween automatically restart once complete? (ignores any chained tweens).
`yoyo`	Phaser.Tween	Description.

Source:

tween/Tween.js, line 180

Returns:

Itself.

Type: Phaser.Tween

update(time) → {boolean}

Core tween update function called by the TweenManager. Does not need to be invoked directly.

Parameters:

Name	Type	Description
`time`	number	A timestamp passed in by the TweenManager.

Source:

tween/Tween.js, line 475

Returns:

false if the tween has completed and should be deleted from the manager, otherwise true (still active).

Type: boolean

yoyo(yoyo) → {Phaser.Tween}

A tween that has yoyo set to true will run through from start to finish, then reverse from finish to start. Used in combination with repeat you can create endless loops.

Parameters:

Name	Type	Description
`yoyo`	boolean	Set to true to yoyo this tween.

Source:

tween/Tween.js, line 337

Returns:

Itself.

Type: Phaser.Tween