Phaser.TweenManager - 2.6.2

new TweenManager(game)

Phaser.Game has a single instance of the TweenManager through which all Tween objects are created and updated.
Tweens are hooked into the game clock and pause system, adjusting based on the game state.

TweenManager is based heavily on tween.js by http://soledadpenades.com.
The difference being that tweens belong to a games instance of TweenManager, rather than to a global TWEEN object.
It also has callbacks swapped for Signals and a few issues patched with regard to properties and completion errors.
Please see https://github.com/sole/tween.js for a full list of contributors.

Parameters

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

Source code: tween/TweenManager.js (Line 20)

Public Properties

frameBased : boolean

Are all newly created Tweens frame or time based? A frame based tween will use the physics elapsed timer when updating. This means
it will retain the same consistent frame rate, regardless of the speed of the device. The duration value given should
be given in frames.

If the Tween uses a time based update (which is the default) then the duration is given in milliseconds.
In this situation a 2000ms tween will last exactly 2 seconds, regardless of the device and how many visual updates the tween
has actually been through. For very short tweens you may wish to experiment with a frame based update instead.

Source code: tween/TweenManager.js (Line 38)

game : Phaser.Game

Local reference to game.

Source code: tween/TweenManager.js (Line 25)

Public Methods

add(tween) → {Phaser.Tween}

Add a new tween into the TweenManager.

Parameters

Name	Type	Description
`tween`	Phaser.Tween	The tween object you want to add.

Returns

Phaser.Tween -

The tween object you added to the manager.

Source code: tween/TweenManager.js (Line 189)

create(object) → {Phaser.Tween}

Create a tween object for a specific object. The object can be any JavaScript object or Phaser object such as Sprite.

Parameters

Name	Type	Description
`object`	object	Object the tween will be run on.

Returns

Phaser.Tween -

The newly created tween object.

Source code: tween/TweenManager.js (Line 203)

getAll() → {Array.<Phaser.Tween>}

Get all the tween objects in an array.

Returns

Array.<Phaser.Tween> -

Array with all tween objects.

Source code: tween/TweenManager.js (Line 114)

isTweening(object) → {boolean}

Checks to see if a particular Sprite is currently being tweened.

Parameters

Name	Type	Description
`object`	object	The object to check for tweens against.

Returns

boolean -

Returns true if the object is currently being tweened, false if not.

Source code: tween/TweenManager.js (Line 285)

pauseAll()

Pauses all currently running tweens.

Source code: tween/TweenManager.js (Line 330)

remove(tween)

Remove a tween from this manager.

Parameters

Name	Type	Description
`tween`	Phaser.Tween	The tween object you want to remove.

Source code: tween/TweenManager.js (Line 216)

removeAll()

Remove all tweens running and in the queue. Doesn't call any of the tween onComplete events.

Source code: tween/TweenManager.js (Line 125)

removeFrom(obj, children)

Remove all tweens from a specific object, array of objects or Group.

Parameters

Name	Type	Argument	Default	Description
`obj`	object \| Array.<object> \| Phaser.Group			The object you want to remove the tweens from.
`children`	boolean	<optional>	true	If passing a group, setting this to true will remove the tweens from all of its children instead of the group itself.

Source code: tween/TweenManager.js (Line 140)

resumeAll()

Resumes all currently paused tweens.

Source code: tween/TweenManager.js (Line 344)

update() → {boolean}

Update all the tween objects you added to this manager.

Returns

boolean -

Return false if there's no tween to update, otherwise return true.

Source code: tween/TweenManager.js (Line 242)

Navigation

Constructor