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.
| Name | Type | Description |
|---|---|---|
game | Phaser.Game | A reference to the currently running game. |
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.
Local reference to game.
Add a new tween into the TweenManager.
| Name | Type | Description |
|---|---|---|
tween | Phaser.Tween | The tween object you want to add. |
The tween object you added to the manager.
Create a tween object for a specific object. The object can be any JavaScript object or Phaser object such as Sprite.
| Name | Type | Description |
|---|---|---|
object | object | Object the tween will be run on. |
The newly created tween object.
Get all the tween objects in an array.
Array with all tween objects.
Checks to see if a particular Sprite is currently being tweened.
| Name | Type | Description |
|---|---|---|
object | object | The object to check for tweens against. |
Returns true if the object is currently being tweened, false if not.
Pauses all currently running tweens.
Remove a tween from this manager.
| Name | Type | Description |
|---|---|---|
tween | Phaser.Tween | The tween object you want to remove. |
Remove all tweens running and in the queue. Doesn't call any of the tween onComplete events.
Remove all tweens from a specific object, array of objects or Group.
| 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. |
Resumes all currently paused tweens.
Update all the tween objects you added to this manager.
Return false if there's no tween to update, otherwise return true.
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.TweenManager.html