2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-26 21:13:41 +00:00
phaser/v2/docs/Phaser.Tween.html

6604 lines
121 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Tween</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
2014-11-15 20:01:46 +00:00
<link type="text/css" rel="stylesheet" href="styles/default.css">
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
2014-11-25 00:23:44 +00:00
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
2014-11-25 00:23:44 +00:00
<div style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div>
<div class="navbar-inner">
2014-11-25 00:23:44 +00:00
<a class="brand" href="index.html">Phaser API</a>
<ul class="nav">
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
2016-08-26 00:18:47 +00:00
<li class="class-depth-0">
<a href="Event.html">Event</a>
</li>
<li class="class-depth-0">
<a href="EventTarget.html">EventTarget</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
2016-06-17 00:11:24 +00:00
<li class="class-depth-1">
<a href="Phaser.Bullet.html">Bullet</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-2">
<a href="Phaser.Component.Angle.html">Angle</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Animation.html">Animation</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.AutoCull.html">AutoCull</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Bounds.html">Bounds</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.BringToTop.html">BringToTop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Core.html">Core</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Crop.html">Crop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Delta.html">Delta</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Destroy.html">Destroy</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Health.html">Health</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InCamera.html">InCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InputEnabled.html">InputEnabled</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InWorld.html">InWorld</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LifeSpan.html">LifeSpan</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LoadTexture.html">LoadTexture</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Overlap.html">Overlap</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Reset.html">Reset</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Smoothed.html">Smoothed</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.Create.html">Create</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Creature.html">Creature</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.DeviceButton.html">DeviceButton</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-1">
<a href="Phaser.Hermite.html">Hermite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.ImageCollection.html">ImageCollection</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-1">
<a href="Phaser.KeyCode.html">KeyCode</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.Matrix.html">Matrix</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-1">
<a href="Phaser.Path.html">Path</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PathFollower.html">PathFollower</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PathPoint.html">PathPoint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-3">
2015-08-24 14:43:45 +00:00
<a href="Phaser.Physics.Arcade.TilemapCollision.html">TilemapCollision</a>
2015-03-23 23:46:30 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-2">
<a href="Phaser.Plugin.PathManager.html">PathManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2015-10-15 11:06:38 +00:00
<li class="class-depth-1">
<a href="Phaser.PointerMode.html">PointerMode</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.RoundedRectangle.html">RoundedRectangle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="Phaser.Video.html">Video</a>
</li>
2016-06-17 00:11:24 +00:00
<li class="class-depth-1">
<a href="Phaser.Weapon.html">Weapon</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="Phaser.World.html">World</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="PIXI.BaseTexture.html">BaseTexture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasBuffer.html">CanvasBuffer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasGraphics.html">CanvasGraphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a>
</li>
2015-08-24 14:43:45 +00:00
<li class="class-depth-1">
<a href="PIXI.CanvasPool.html">CanvasPool</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
2016-02-08 17:01:36 +00:00
<li class="class-depth-1">
<a href="PIXI.EarCut.html">EarCut</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PIXI.html">PIXI</a>
2014-11-15 20:01:46 +00:00
</li>
2016-07-01 15:57:13 +00:00
<li class="class-depth-2">
<a href="PIXI.PIXI.DisplayObject.html">DisplayObject</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PixiShader.html">PixiShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.RenderTexture.html">RenderTexture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Rope.html">Rope</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Sprite.html">Sprite</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Strip.html">Strip</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.StripShader.html">StripShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Texture.html">Texture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.TilingSprite.html">TilingSprite</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-11-15 20:01:46 +00:00
2016-06-03 17:48:34 +00:00
<li class="class-depth-0">
<a href="global.html#ANGLE_DOWN">ANGLE_DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_LEFT">ANGLE_LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_NORTH_EAST">ANGLE_NORTH_EAST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_NORTH_WEST">ANGLE_NORTH_WEST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_RIGHT">ANGLE_RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_SOUTH_EAST">ANGLE_SOUTH_EAST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_SOUTH_WEST">ANGLE_SOUTH_WEST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_UP">ANGLE_UP</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#AUTO">AUTO</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#BITMAPDATA">BITMAPDATA</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#BITMAPTEXT">BITMAPTEXT</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
2014-11-15 20:01:46 +00:00
</li>
2016-06-17 00:11:24 +00:00
<li class="class-depth-0">
<a href="global.html#BOTTOM_CENTER">BOTTOM_CENTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#BOTTOM_LEFT">BOTTOM_LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#BOTTOM_RIGHT">BOTTOM_RIGHT</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#BUTTON">BUTTON</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS">CANVAS</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS_FILTER">CANVAS_FILTER</a>
</li>
2016-06-17 00:11:24 +00:00
<li class="class-depth-0">
<a href="global.html#CENTER">CENTER</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#CIRCLE">CIRCLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#CREATURE">CREATURE</a>
</li>
2016-06-09 16:13:31 +00:00
<li class="class-depth-0">
<a href="global.html#displayList">displayList</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#DOWN">DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ELLIPSE">ELLIPSE</a>
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-0">
<a href="global.html#emit">emit</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#EMITTER">EMITTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#GAMES">GAMES</a>
</li>
<li class="class-depth-0">
<a href="global.html#GRAPHICS">GRAPHICS</a>
</li>
<li class="class-depth-0">
<a href="global.html#GROUP">GROUP</a>
</li>
<li class="class-depth-0">
<a href="global.html#HEADLESS">HEADLESS</a>
</li>
2016-06-09 16:13:31 +00:00
<li class="class-depth-0">
<a href="global.html#HORIZONTAL">HORIZONTAL</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#IMAGE">IMAGE</a>
</li>
2016-06-09 16:13:31 +00:00
<li class="class-depth-0">
<a href="global.html#LANDSCAPE">LANDSCAPE</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#LEFT">LEFT</a>
</li>
2016-06-17 00:11:24 +00:00
<li class="class-depth-0">
<a href="global.html#LEFT_BOTTOM">LEFT_BOTTOM</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT_CENTER">LEFT_CENTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT_TOP">LEFT_TOP</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#LINE">LINE</a>
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-0">
<a href="global.html#listeners">listeners</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#MATRIX">MATRIX</a>
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-0">
<a href="global.html#mixin">mixin</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#NONE">NONE</a>
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-0">
<a href="global.html#off">off</a>
</li>
<li class="class-depth-0">
<a href="global.html#on">on</a>
</li>
<li class="class-depth-0">
<a href="global.html#once">once</a>
</li>
2016-02-08 17:01:36 +00:00
<li class="class-depth-0">
<a href="global.html#PENDING_ATLAS">PENDING_ATLAS</a>
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-2">
<a href="global.html#Phaser.Path#numPointsreturn%257Bnumber%257DThetotalnumberofPathPointsinthisPath.">Phaser.Path#numPoints
return {number} The total number of PathPoints in this Path.</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#POINT">POINT</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINTER">POINTER</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#POLYGON">POLYGON</a>
2014-11-15 20:01:46 +00:00
</li>
2016-06-09 16:13:31 +00:00
<li class="class-depth-0">
<a href="global.html#PORTRAIT">PORTRAIT</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#RECTANGLE">RECTANGLE</a>
2014-11-15 20:01:46 +00:00
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-0">
<a href="global.html#removeAllListeners">removeAllListeners</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#RENDERTEXTURE">RENDERTEXTURE</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#RETROFONT">RETROFONT</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#RIGHT">RIGHT</a>
</li>
2016-06-17 00:11:24 +00:00
<li class="class-depth-0">
<a href="global.html#RIGHT_BOTTOM">RIGHT_BOTTOM</a>
</li>
<li class="class-depth-0">
<a href="global.html#RIGHT_CENTER">RIGHT_CENTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#RIGHT_TOP">RIGHT_TOP</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#ROPE">ROPE</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROUNDEDRECTANGLE">ROUNDEDRECTANGLE</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#SPRITE">SPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITEBATCH">SPRITEBATCH</a>
</li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-0">
<a href="global.html#stopImmediatePropagation">stopImmediatePropagation</a>
</li>
<li class="class-depth-0">
<a href="global.html#stopPropagation">stopPropagation</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#TEXT">TEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAP">TILEMAP</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAPLAYER">TILEMAPLAYER</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILESPRITE">TILESPRITE</a>
</li>
2016-06-17 00:11:24 +00:00
<li class="class-depth-0">
<a href="global.html#TOP_CENTER">TOP_CENTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#TOP_LEFT">TOP_LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#TOP_RIGHT">TOP_RIGHT</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#UP">UP</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#VERSION">VERSION</a>
2014-11-15 20:01:46 +00:00
</li>
2016-06-09 16:13:31 +00:00
<li class="class-depth-0">
<a href="global.html#VERTICAL">VERTICAL</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#VIDEO">VIDEO</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL">WEBGL</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL_FILTER">WEBGL_FILTER</a>
2014-11-15 20:01:46 +00:00
</li>
</ul>
</li>
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
<li class="dropdown">
2014-11-25 00:23:44 +00:00
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li>
<li class="class-depth-1"><a href="Phaser.World.html">World</a></li>
<li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Cache.html">Cache</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li>
<li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li>
<li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li>
<li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li>
<li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li>
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
2014-11-15 20:01:46 +00:00
<ul class="dropdown-menu ">
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li>
<li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li>
<li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li>
<li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li>
<li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Video.html">Video</a></li>
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Matrix.html">Matrix</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.RoundedRectangle.html">Rounded Rectangle</a></li>
2014-11-15 20:01:46 +00:00
</ul>
</li>
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
2016-06-17 00:11:24 +00:00
<li class="class-depth-2"><a href="Phaser.Weapon.html">Weapon</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li>
<li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.DeviceButton.html">Device Button</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
2016-08-26 00:18:47 +00:00
<li class="class-depth-1"><a href="Phaser.KeyCode.html">Key Codes</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li>
<li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="http://phaser.io/learn">Tutorials</a></li>
2016-05-19 11:36:51 +00:00
<li class="class-depth-1"><a href="http://phaser.io/community/newsletter">Newsletter</a></li>
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li>
2016-06-17 00:11:24 +00:00
<li class="class-depth-1"><a href="http://phaser.io/community/slack">Slack</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/donate">Donate</a></li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
2014-11-25 00:23:44 +00:00
</ul>
</li>
2014-11-15 20:01:46 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
2014-11-25 00:23:44 +00:00
<!--<h1 class="page-title">Class: Tween</h1>-->
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
Tween
</h2>
</header>
<article>
<div class="container-overview">
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="Tween"><span class="type-signature"></span>new Tween<span class="signature">(target, game, manager)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>A Tween allows you to alter one or more properties of a target object over a defined period of time.<br>This can be used for things such as alpha fading Sprites, scaling them or motion.<br>Use <code>Tween.to</code> or <code>Tween.from</code> to set-up the tween values. You can create multiple tweens on the same object<br>by calling Tween.to multiple times on the same Tween. Additional tweens specified in this way become &quot;child&quot; tweens and<br>are played through in sequence. You can use Tween.timeScale and Tween.reverse to control the playback of this Tween and all of its children.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-11-25 00:23:44 +00:00
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
2014-11-25 00:23:44 +00:00
<td class="description last"><p>The target object, such as a Phaser.Sprite or Phaser.Sprite.scale.</p></td>
</tr>
<tr>
<td class="name"><code>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"><p>Current game instance.</p></td>
</tr>
<tr>
<td class="name"><code>manager</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.TweenManager.html">Phaser.TweenManager</a></span>
</td>
<td class="description last"><p>The TweenManager responsible for looking after this Tween.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-20">line 20</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="chainedTween"><span class="type-signature"></span>chainedTween<span class="type-signature"> :<a href="Phaser.Tween.html">Phaser.Tween</a></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +00:00
<p>If this Tween is chained to another this holds a reference to it.</p>
2014-11-15 20:01:46 +00:00
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-130">line 130</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="current"><span class="type-signature">&lt;readonly> </span>current<span class="type-signature"> :number</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +00:00
<p>The current Tween child being run.</p>
2014-11-15 20:01:46 +00:00
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-120">line 120</a>
2014-11-15 20:01:46 +00:00
</dt>
2015-08-24 14:43:45 +00:00
</dl>
</dd>
<dt>
<h4 class="name "
id="frameBased"><span class="type-signature"></span>frameBased<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Is this Tween frame or time based? A frame based tween will use the physics elapsed timer when updating. This means<br>it will retain the same consistent frame rate, regardless of the speed of the device. The duration value given should<br>be given in frames.</p>
<p>If the Tween uses a time based update (which is the default) then the duration is given in milliseconds.<br>In this situation a 2000ms tween will last exactly 2 seconds, regardless of the device and how many visual updates the tween<br>has actually been through. For very short tweens you may wish to experiment with a frame based update instead.</p>
2015-08-24 14:43:45 +00:00
<p>The default value is whatever you've set in TweenManager.frameBased.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-152">line 152</a>
2015-08-24 14:43:45 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +00:00
<p>A reference to the currently running Game.</p>
2014-11-15 20:01:46 +00:00
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-25">line 25</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="isPaused"><span class="type-signature"></span>isPaused<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +00:00
<p>Is this Tween paused or not?</p>
2014-11-15 20:01:46 +00:00
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-136">line 136</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="isRunning"><span class="type-signature"></span>isRunning<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +00:00
<p>If the tween is running this is set to true, otherwise false. Tweens that are in a delayed state or waiting to start are considered as being running.</p>
2014-11-15 20:01:46 +00:00
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-113">line 113</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="manager"><span class="type-signature"></span>manager<span class="type-signature"> :<a href="Phaser.TweenManager.html">Phaser.TweenManager</a></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +00:00
<p>Reference to the TweenManager responsible for updating this Tween.</p>
2014-11-15 20:01:46 +00:00
</div>
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-35">line 35</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-02-05 06:29:17 +00:00
</dd>
2014-11-25 00:23:44 +00:00
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="onChildComplete"><span class="type-signature"></span>onChildComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>The onChildComplete event is fired when the Tween or any of its children completes.<br>Fires every time a child completes unless a child is set to repeat forever.<br>It will be sent 2 parameters: the target object and this tween.</p>
</div>
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
<dl class="details">
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-100">line 100</a>
2014-11-25 00:23:44 +00:00
</dt>
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
</dl>
2014-11-25 00:23:44 +00:00
</dd>
2014-11-25 00:23:44 +00:00
<dt>
<h4 class="name "
id="onComplete"><span class="type-signature"></span>onComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
2014-11-25 00:23:44 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>The onComplete event is fired when the Tween and all of its children completes. Does not fire if the Tween is set to loop or repeatAll(-1).<br>It will be sent 2 parameters: the target object and this tween.</p>
2014-11-25 00:23:44 +00:00
</div>
2014-11-25 00:23:44 +00:00
<dl class="details">
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-107">line 107</a>
2014-11-25 00:23:44 +00:00
</dt>
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="onLoop"><span class="type-signature"></span>onLoop<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>The onLoop event is fired if the Tween, or any child tweens loop.<br>It will be sent 2 parameters: the target object and this tween.</p>
</div>
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
<dl class="details">
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-85">line 85</a>
2014-11-25 00:23:44 +00:00
</dt>
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
</dd>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<dt>
<h4 class="name "
id="onRepeat"><span class="type-signature"></span>onRepeat<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>The onRepeat event is fired if the Tween and all of its children repeats. If this tween has no children this will never be fired.<br>It will be sent 2 parameters: the target object and this tween.</p>
2014-11-15 20:01:46 +00:00
</div>
2014-11-25 00:23:44 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-92">line 92</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="onStart"><span class="type-signature"></span>onStart<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>The onStart event is fired when the Tween begins. If there is a delay before the tween starts then onStart fires after the delay is finished.<br>It will be sent 2 parameters: the target object and this tween.</p>
</div>
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
<dl class="details">
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-77">line 77</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="pendingDelete"><span class="type-signature">&lt;readonly> </span>pendingDelete<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>True if this Tween is ready to be deleted by the TweenManager.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-70">line 70</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2014-12-03 10:39:11 +00:00
id="properties"><span class="type-signature"></span>properties<span class="type-signature"> :object</span></h4>
2014-11-25 00:23:44 +00:00
</dt>
<dd>
<div class="description">
<p>Target property cache used when building the child data values.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-125">line 125</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="repeatCounter"><span class="type-signature"></span>repeatCounter<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>If the Tween and any child tweens are set to repeat this contains the current repeat count.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-63">line 63</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="reverse"><span class="type-signature"></span>reverse<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
2016-08-26 00:18:47 +00:00
<p>If set to <code>true</code> the current tween will play in reverse.<br>If the tween hasn't yet started this has no effect.<br>If there are child tweens then all child tweens will play in reverse from the current point.</p>
2014-11-25 00:23:44 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-49">line 49</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="target"><span class="type-signature"></span>target<span class="type-signature"> :object</span></h4>
</dt>
<dd>
<div class="description">
<p>The target object, such as a Phaser.Sprite or property like Phaser.Sprite.scale.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-30">line 30</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="timeline"><span class="type-signature"></span>timeline<span class="type-signature"> :Array</span></h4>
</dt>
<dd>
<div class="description">
<p>An Array of TweenData objects that comprise the different parts of this Tween.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-40">line 40</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="timeScale"><span class="type-signature"></span>timeScale<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
2016-08-26 00:18:47 +00:00
<p>The speed at which the tweens will run. A value of 1 means it will match the game frame rate. 0.5 will run at half the frame rate. 2 at double the frame rate, etc.<br>If a tweens duration is 1 second but timeScale is 0.5 then it will take 2 seconds to complete.</p>
2014-11-25 00:23:44 +00:00
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>1</li></ul></dd>
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-58">line 58</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="totalDuration"><span class="type-signature"></span>totalDuration<span class="type-signature"> :<a href="Phaser.TweenData.html">Phaser.TweenData</a></span></h4>
</dt>
<dd>
<div class="description">
<p>Gets the total duration of this Tween, including all child tweens, in milliseconds.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-893">line 893</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name "
id="chain"><span class="type-signature"></span>chain<span class="signature">(tweens)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
<div class="description">
2016-08-26 00:18:47 +00:00
<p>This method allows you to chain tweens together. Any tween chained to this tween will have its <code>Tween.start</code> method called<br>as soon as this tween completes. If this tween never completes (i.e. repeatAll or loop is set) then the chain will never progress.<br>Note that <code>Tween.onComplete</code> will fire when <em>this</em> tween completes, not when the whole chain completes.<br>For that you should listen to <code>onComplete</code> on the final tween in your chain.</p>
<p>If you pass multiple tweens to this method they will be joined into a single long chain.<br>For example if this is Tween A and you pass in B, C and D then B will be chained to A, C will be chained to B and D will be chained to C.<br>Any previously chained tweens that may have been set will be overwritten.</p>
2014-11-25 00:23:44 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tweens</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
</td>
<td class="attributes">
&lt;repeatable><br>
</td>
<td class="description last"><p>One or more tweens that will be chained to this one.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-566">line 566</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="delay"><span class="type-signature"></span>delay<span class="signature">(duration, <span class="optional">index</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Sets the delay in milliseconds before this tween will start. If there are child tweens it sets the delay before the first child starts.<br>The delay is invoked as soon as you call <code>Tween.start</code>. If the tween is already running this method doesn't do anything for the current active tween.<br>If you have not yet called <code>Tween.to</code> or <code>Tween.from</code> at least once then this method will do nothing, as there are no tweens to delay.<br>If you have child tweens and pass -1 as the index value it sets the delay across all of them.</p>
2014-11-25 00:23:44 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The amount of time in ms that the Tween should wait until it begins once started is called. Set to zero to remove any active delay.</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the delay on all the children.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-408">line 408</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="easing"><span class="type-signature"></span>easing<span class="signature">(ease, <span class="optional">index</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Set easing function this tween will use, i.e. Phaser.Easing.Linear.None.<br>The ease function allows you define the rate of change. You can pass either a function such as Phaser.Easing.Circular.Out or a string such as &quot;Circ&quot;.<br>&quot;.easeIn&quot;, &quot;.easeOut&quot; and &quot;easeInOut&quot; variants are all supported for all ease types.<br>If you have child tweens and pass -1 as the index value it sets the easing function defined here across all of them.</p>
2014-11-25 00:23:44 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ease</code></td>
<td class="type">
<span class="param-type">function</span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The easing function this tween will use, i.e. Phaser.Easing.Linear.None.</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the easing function on all children.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-504">line 504</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-07-22 14:31:30 +00:00
id="from"><span class="type-signature"></span>from<span class="signature">(properties, <span class="optional">duration</span>, <span class="optional">ease</span>, <span class="optional">autoStart</span>, <span class="optional">delay</span>, <span class="optional">repeat</span>, <span class="optional">yoyo</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
2014-11-25 00:23:44 +00:00
</dt>
<dd>
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Sets this tween to be a <code>from</code> tween on the properties given. A <code>from</code> tween sets the target to the destination value and tweens to its current value.<br>For example a Sprite with an <code>x</code> coordinate of 100 tweened from <code>x</code> 500 would be set to <code>x</code> 500 and then tweened to <code>x</code> 100 by giving a properties object of <code>{ x: 500 }</code>.<br>The ease function allows you define the rate of change. You can pass either a function such as Phaser.Easing.Circular.Out or a string such as &quot;Circ&quot;.<br>&quot;.easeIn&quot;, &quot;.easeOut&quot; and &quot;easeInOut&quot; variants are all supported for all ease types.</p>
2014-11-25 00:23:44 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>properties</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>An object containing the properties you want to tween., such as <code>Sprite.x</code> or <code>Sound.volume</code>. Given as a JavaScript object.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1000
</td>
2015-08-24 14:43:45 +00:00
<td class="description last"><p>Duration of this tween in ms. Or if <code>Tween.frameBased</code> is true this represents the number of frames that should elapse.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
<tr>
<td class="name"><code>ease</code></td>
<td class="type">
<span class="param-type">function</span>
2015-07-22 14:31:30 +00:00
|
<span class="param-type">string</span>
2014-11-25 00:23:44 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>Easing function. If not set it will default to Phaser.Easing.Default, which is Phaser.Easing.Linear.None by default but can be over-ridden.</p></td>
</tr>
<tr>
<td class="name"><code>autoStart</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Set to <code>true</code> to allow this tween to start automatically. Otherwise call Tween.start().</p></td>
2014-11-25 00:23:44 +00:00
</tr>
<tr>
<td class="name"><code>delay</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>Delay before this tween will start in milliseconds. Defaults to 0, no delay.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
<tr>
<td class="name"><code>repeat</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
2016-02-17 13:27:09 +00:00
<td class="description last"><p>Should the tween automatically restart once complete? If you want it to run forever set as -1. This only effects this individual tween, not any chained tweens.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
<tr>
<td class="name"><code>yoyo</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
2015-07-22 14:31:30 +00:00
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
2014-11-25 00:23:44 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>This Tween object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-237">line 237</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-07-22 14:31:30 +00:00
id="generateData"><span class="type-signature"></span>generateData<span class="signature">(<span class="optional">frameRate</span>, <span class="optional">data</span>)</span><span class="type-signature"> &rarr; {array}</span></h4>
2014-11-25 00:23:44 +00:00
</dt>
<dd>
<div class="description">
2016-08-26 00:18:47 +00:00
<p>This will generate an array populated with the tweened object values from start to end.<br>It works by running the tween simulation at the given frame rate based on the values set-up in Tween.to and Tween.from.<br>It ignores delay and repeat counts and any chained tweens, but does include child tweens.<br>Just one play through of the tween data is returned, including yoyo if set.</p>
2014-11-25 00:23:44 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>frameRate</code></td>
2014-11-25 00:23:44 +00:00
<td class="type">
2015-07-22 14:31:30 +00:00
<span class="param-type">number</span>
2014-11-25 00:23:44 +00:00
</td>
<td class="attributes">
2015-07-22 14:31:30 +00:00
&lt;optional><br>
2014-11-25 00:23:44 +00:00
</td>
<td class="default">
2015-07-22 14:31:30 +00:00
60
2014-11-25 00:23:44 +00:00
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>The speed in frames per second that the data should be generated at. The higher the value, the larger the array it creates.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>data</code></td>
2014-11-25 00:23:44 +00:00
<td class="type">
2015-07-22 14:31:30 +00:00
<span class="param-type">array</span>
2014-11-25 00:23:44 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>If given the generated data will be appended to this array, otherwise a new array will be returned.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
2015-07-22 14:31:30 +00:00
</tbody>
</table>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<h5>Returns:</h5>
<div class="returns">
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<div class="returns-type">
<span class="param-type">array</span>
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>An array of tweened values.</p>
</div>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
</div>
<dl class="details">
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-840">line 840</a>
2015-07-22 14:31:30 +00:00
</dt>
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
</dl>
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
</dd>
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
<dt>
<h4 class="name "
id="interpolation"><span class="type-signature"></span>interpolation<span class="signature">(interpolation, <span class="optional">context</span>, <span class="optional">index</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Sets the interpolation function the tween will use. By default it uses Phaser.Math.linearInterpolation.<br>Also available: Phaser.Math.bezierInterpolation and Phaser.Math.catmullRomInterpolation.<br>The interpolation function is only used if the target properties is an array.<br>If you have child tweens and pass -1 as the index value and it will set the interpolation function across all of them.</p>
2015-07-22 14:31:30 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<tbody>
2014-11-25 00:23:44 +00:00
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>interpolation</code></td>
2014-11-25 00:23:44 +00:00
<td class="type">
2015-07-22 14:31:30 +00:00
<span class="param-type">function</span>
2014-11-25 00:23:44 +00:00
</td>
<td class="attributes">
</td>
<td class="default">
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>The interpolation function to use (Phaser.Math.linearInterpolation by default)</p></td>
2014-11-25 00:23:44 +00:00
</tr>
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>context</code></td>
2014-11-25 00:23:44 +00:00
<td class="type">
2015-07-22 14:31:30 +00:00
<span class="param-type">object</span>
2014-11-25 00:23:44 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>The context under which the interpolation function will be run.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>index</code></td>
2014-11-25 00:23:44 +00:00
<td class="type">
2015-07-22 14:31:30 +00:00
<span class="param-type">number</span>
2014-11-25 00:23:44 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
2015-07-22 14:31:30 +00:00
0
2014-11-25 00:23:44 +00:00
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the interpolation function on all children.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
2015-03-23 23:46:30 +00:00
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
2014-11-25 00:23:44 +00:00
-
</div>
<div class="returns-desc param-desc">
2015-07-22 14:31:30 +00:00
<p>This tween. Useful for method chaining.</p>
2014-11-25 00:23:44 +00:00
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-526">line 526</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-07-22 14:31:30 +00:00
id="loop"><span class="type-signature"></span>loop<span class="signature">(<span class="optional">value</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
2014-11-25 00:23:44 +00:00
</dt>
<dd>
<div class="description">
2016-04-22 14:15:28 +00:00
<p>Enables the looping of this tween. The tween will loop forever, and onComplete will never fire.</p>
2016-08-26 00:18:47 +00:00
<p>If <code>value</code> is <code>true</code> then this is the same as setting <code>Tween.repeatAll(-1)</code>.<br>If <code>value</code> is <code>false</code> it is the same as setting <code>Tween.repeatAll(0)</code> and will reset the <code>repeatCounter</code> to zero.</p>
<p>Usage:<br>game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)<br>.to({ y: 300 }, 1000, Phaser.Easing.Linear.None)<br>.to({ x: 0 }, 1000, Phaser.Easing.Linear.None)<br>.to({ y: 0 }, 1000, Phaser.Easing.Linear.None)<br>.loop();</p>
2014-11-25 00:23:44 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>value</code></td>
2014-11-25 00:23:44 +00:00
<td class="type">
2015-07-22 14:31:30 +00:00
<span class="param-type">boolean</span>
2014-11-25 00:23:44 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
2015-07-22 14:31:30 +00:00
true
2014-11-25 00:23:44 +00:00
</td>
2016-04-22 14:15:28 +00:00
<td class="description last"><p>If <code>true</code> this tween will loop once it reaches the end. Set to <code>false</code> to remove an active loop.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
2015-07-22 14:31:30 +00:00
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
2014-11-25 00:23:44 +00:00
-
</div>
<div class="returns-desc param-desc">
2015-07-22 14:31:30 +00:00
<p>This tween. Useful for method chaining.</p>
2014-11-25 00:23:44 +00:00
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-02-08 17:01:36 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-600">line 600</a>
2014-11-25 00:23:44 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2015-07-22 14:31:30 +00:00
id="onUpdateCallback"><span class="type-signature"></span>onUpdateCallback<span class="signature">(callback, callbackContext)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
2014-11-25 00:23:44 +00:00
</dt>
<dd>
<div class="description">
2015-07-22 14:31:30 +00:00
<p>Sets a callback to be fired each time this tween updates.</p>
2014-11-25 00:23:44 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2014-11-25 00:23:44 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>callback</code></td>
2014-11-25 00:23:44 +00:00
<td class="type">
<span class="param-type">function</span>
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>The callback to invoke each time this tween is updated. Set to <code>null</code> to remove an already active callback.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
2015-03-23 23:46:30 +00:00
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>callbackContext</code></td>
2015-03-23 23:46:30 +00:00
<td class="type">
<span class="param-type">object</span>
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>The context in which to call the onUpdate callback.</p></td>
2015-03-23 23:46:30 +00:00
</tr>
2015-07-22 14:31:30 +00:00
</tbody>
</table>
2015-03-23 23:46:30 +00:00
2015-07-22 14:31:30 +00:00
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-626">line 626</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
2014-05-20 09:12:48 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2015-07-22 14:31:30 +00:00
id="pause"><span class="type-signature"></span>pause<span class="signature">()</span><span class="type-signature"></span></h4>
2014-05-20 09:12:48 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-05-20 09:12:48 +00:00
<div class="description">
2015-07-22 14:31:30 +00:00
<p>Pauses the tween. Resume playback with Tween.resume.</p>
2014-05-20 09:12:48 +00:00
</div>
2014-11-25 00:23:44 +00:00
<dl class="details">
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-643">line 643</a>
2014-11-25 00:23:44 +00:00
</dt>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
</dl>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
</dd>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
<dt>
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="repeat"><span class="type-signature"></span>repeat<span class="signature">(total, <span class="optional">repeat</span>, <span class="optional">index</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
2014-11-25 00:23:44 +00:00
</dt>
<dd>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Sets the number of times this tween will repeat.<br>If you have not yet called <code>Tween.to</code> or <code>Tween.from</code> at least once then this method will do nothing, as there are no tweens to repeat.<br>If you have child tweens and pass -1 as the index value it sets the number of times they'll repeat across all of them.<br>If you wish to define how many times this Tween and all children will repeat see Tween.repeatAll.</p>
2014-11-25 00:23:44 +00:00
</div>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
<h5>Parameters:</h5>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
<th>Type</th>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2016-04-22 14:15:28 +00:00
<th>Argument</th>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
2016-04-22 14:15:28 +00:00
<th>Default</th>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
<th class="last">Description</th>
</tr>
</thead>
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
<tbody>
2014-05-20 09:12:48 +00:00
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>total</code></td>
2014-05-20 09:12:48 +00:00
<td class="type">
2015-07-22 14:31:30 +00:00
<span class="param-type">number</span>
2014-11-25 00:23:44 +00:00
2014-05-20 09:12:48 +00:00
2014-11-25 00:23:44 +00:00
</td>
2014-05-20 09:12:48 +00:00
2016-04-22 14:15:28 +00:00
<td class="attributes">
2014-05-20 09:12:48 +00:00
2016-04-22 14:15:28 +00:00
</td>
2015-07-22 14:31:30 +00:00
2014-05-20 09:12:48 +00:00
2016-04-22 14:15:28 +00:00
<td class="default">
</td>
<td class="description last"><p>How many times a tween should repeat before completing. Set to zero to remove an active repeat. Set to -1 to repeat forever.</p></td>
</tr>
<tr>
<td class="name"><code>repeat</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>This is the amount of time to pause (in ms) before the repeat will start.</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the repeat value on all the children.</p></td>
2015-07-22 14:31:30 +00:00
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
<h5>Returns:</h5>
<div class="returns">
2015-07-22 14:31:30 +00:00
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
-
</div>
2015-07-22 14:31:30 +00:00
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-425">line 425</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="repeatAll"><span class="type-signature"></span>repeatAll<span class="signature">(<span class="optional">total</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Set how many times this tween and all of its children will repeat.<br>A tween (A) with 3 children (B,C,D) with a <code>repeatAll</code> value of 2 would play as: ABCDABCD before completing.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2015-10-15 11:06:38 +00:00
<th>Argument</th>
2015-10-15 11:06:38 +00:00
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>total</code></td>
<td class="type">
2014-11-25 00:23:44 +00:00
<span class="param-type">number</span>
2015-10-15 11:06:38 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
2016-04-22 14:15:28 +00:00
<td class="description last"><p>How many times this tween and all children should repeat before completing. Set to zero to remove an active repeat. Set to -1 to repeat forever.</p></td>
2014-07-10 19:31:11 +00:00
</tr>
2014-11-25 00:23:44 +00:00
</tbody>
</table>
2014-11-25 00:23:44 +00:00
<h5>Returns:</h5>
<div class="returns">
2014-11-25 00:23:44 +00:00
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
-
</div>
2014-11-25 00:23:44 +00:00
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-548">line 548</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2015-07-22 14:31:30 +00:00
id="repeatDelay"><span class="type-signature"></span>repeatDelay<span class="signature">(duration, <span class="optional">index</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Sets the delay in milliseconds before this tween will repeat itself.<br>The repeatDelay is invoked as soon as you call <code>Tween.start</code>. If the tween is already running this method doesn't do anything for the current active tween.<br>If you have not yet called <code>Tween.to</code> or <code>Tween.from</code> at least once then this method will do nothing, as there are no tweens to set repeatDelay on.<br>If you have child tweens and pass -1 as the index value it sets the repeatDelay across all of them.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2014-11-25 00:23:44 +00:00
<th>Argument</th>
2014-11-25 00:23:44 +00:00
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>duration</code></td>
<td class="type">
2015-07-22 14:31:30 +00:00
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The amount of time in ms that the Tween should wait until it repeats or yoyos once start is called. Set to zero to remove any active repeatDelay.</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
2014-11-25 00:23:44 +00:00
<td class="attributes">
&lt;optional><br>
</td>
2014-11-25 00:23:44 +00:00
<td class="default">
2015-07-22 14:31:30 +00:00
0
2014-11-25 00:23:44 +00:00
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the repeatDelay on all the children.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-447">line 447</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2015-07-22 14:31:30 +00:00
id="resume"><span class="type-signature"></span>resume<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2015-07-22 14:31:30 +00:00
<p>Resumes a paused tween.</p>
</div>
2015-07-22 14:31:30 +00:00
<dl class="details">
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-675">line 675</a>
2015-07-22 14:31:30 +00:00
</dt>
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
</dl>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
</dd>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<dt>
<h4 class="name "
id="start"><span class="type-signature"></span>start<span class="signature">(<span class="optional">index</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Starts the tween running. Can also be called by the autoStart parameter of <code>Tween.to</code> or <code>Tween.from</code>.<br>This sets the <code>Tween.isRunning</code> property to <code>true</code> and dispatches a <code>Tween.onStart</code> signal.<br>If the Tween has a delay set then nothing will start tweening until the delay has expired.</p>
2015-07-22 14:31:30 +00:00
</div>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<h5>Parameters:</h5>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<th>Type</th>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<tbody>
2014-11-25 00:23:44 +00:00
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>index</code></td>
2014-11-25 00:23:44 +00:00
<td class="type">
2015-07-22 14:31:30 +00:00
<span class="param-type">number</span>
2014-11-25 00:23:44 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
2015-07-22 14:31:30 +00:00
0
2014-11-25 00:23:44 +00:00
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>If this Tween contains child tweens you can specify which one to start from. The default is zero, i.e. the first tween created.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
2015-07-22 14:31:30 +00:00
</tbody>
</table>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<h5>Returns:</h5>
<div class="returns">
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
</div>
<dl class="details">
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-284">line 284</a>
2015-07-22 14:31:30 +00:00
</dt>
2015-07-22 14:31:30 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
2015-07-22 14:31:30 +00:00
</dd>
2015-07-22 14:31:30 +00:00
2014-11-25 00:23:44 +00:00
2015-07-22 14:31:30 +00:00
<dt>
<h4 class="name "
id="stop"><span class="type-signature"></span>stop<span class="signature">(<span class="optional">complete</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
2015-07-22 14:31:30 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Stops the tween if running and flags it for deletion from the TweenManager.<br>If called directly the <code>Tween.onComplete</code> signal is not dispatched and no chained tweens are started unless the complete parameter is set to <code>true</code>.<br>If you just wish to pause a tween then use Tween.pause instead.</p>
2015-07-22 14:31:30 +00:00
</div>
2015-07-22 14:31:30 +00:00
<h5>Parameters:</h5>
2015-07-22 14:31:30 +00:00
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
2015-07-22 14:31:30 +00:00
<th>Type</th>
2015-07-22 14:31:30 +00:00
<th>Argument</th>
2015-07-22 14:31:30 +00:00
<th>Default</th>
2015-07-22 14:31:30 +00:00
<th class="last">Description</th>
</tr>
</thead>
2015-07-22 14:31:30 +00:00
<tbody>
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
<tr>
2015-07-22 14:31:30 +00:00
<td class="name"><code>complete</code></td>
2014-11-25 00:23:44 +00:00
2014-11-25 00:23:44 +00:00
<td class="type">
<span class="param-type">boolean</span>
2014-11-25 00:23:44 +00:00
</td>
2014-11-25 00:23:44 +00:00
<td class="attributes">
&lt;optional><br>
2014-11-25 00:23:44 +00:00
</td>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<td class="default">
false
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>Set to <code>true</code> to dispatch the Tween.onComplete signal.</p></td>
2014-11-25 00:23:44 +00:00
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
-
</div>
<div class="returns-desc param-desc">
2015-07-22 14:31:30 +00:00
<p>This tween. Useful for method chaining.</p>
2014-11-15 20:01:46 +00:00
</div>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-340">line 340</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2015-07-22 14:31:30 +00:00
id="to"><span class="type-signature"></span>to<span class="signature">(properties, <span class="optional">duration</span>, <span class="optional">ease</span>, <span class="optional">autoStart</span>, <span class="optional">delay</span>, <span class="optional">repeat</span>, <span class="optional">yoyo</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Sets this tween to be a <code>to</code> tween on the properties given. A <code>to</code> tween starts at the current value and tweens to the destination value given.<br>For example a Sprite with an <code>x</code> coordinate of 100 could be tweened to <code>x</code> 200 by giving a properties object of <code>{ x: 200 }</code>.<br>The ease function allows you define the rate of change. You can pass either a function such as Phaser.Easing.Circular.Out or a string such as &quot;Circ&quot;.<br>&quot;.easeIn&quot;, &quot;.easeOut&quot; and &quot;easeInOut&quot; variants are all supported for all ease types.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2014-02-05 06:29:17 +00:00
<th>Argument</th>
2014-02-05 06:29:17 +00:00
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>properties</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
2014-02-05 06:29:17 +00:00
<td class="attributes">
</td>
2014-02-05 06:29:17 +00:00
<td class="default">
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>An object containing the properties you want to tween, such as <code>Sprite.x</code> or <code>Sound.volume</code>. Given as a JavaScript object.</p></td>
</tr>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
2014-02-05 06:29:17 +00:00
<td class="attributes">
&lt;optional><br>
</td>
2014-02-05 06:29:17 +00:00
<td class="default">
1000
</td>
2015-08-24 14:43:45 +00:00
<td class="description last"><p>Duration of this tween in ms. Or if <code>Tween.frameBased</code> is true this represents the number of frames that should elapse.</p></td>
</tr>
<tr>
<td class="name"><code>ease</code></td>
<td class="type">
<span class="param-type">function</span>
2015-07-22 14:31:30 +00:00
|
<span class="param-type">string</span>
</td>
2014-02-05 06:29:17 +00:00
<td class="attributes">
&lt;optional><br>
2014-02-05 06:29:17 +00:00
</td>
<td class="default">
null
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>Easing function. If not set it will default to Phaser.Easing.Default, which is Phaser.Easing.Linear.None by default but can be over-ridden.</p></td>
</tr>
<tr>
<td class="name"><code>autoStart</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Set to <code>true</code> to allow this tween to start automatically. Otherwise call Tween.start().</p></td>
</tr>
<tr>
<td class="name"><code>delay</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
2014-02-05 06:29:17 +00:00
<td class="attributes">
&lt;optional><br>
</td>
2014-02-05 06:29:17 +00:00
<td class="default">
0
</td>
2015-07-22 14:31:30 +00:00
<td class="description last"><p>Delay before this tween will start in milliseconds. Defaults to 0, no delay.</p></td>
</tr>
<tr>
<td class="name"><code>repeat</code></td>
<td class="type">
2014-03-24 12:41:45 +00:00
<span class="param-type">number</span>
</td>
2014-02-05 06:29:17 +00:00
<td class="attributes">
&lt;optional><br>
2014-02-05 06:29:17 +00:00
</td>
<td class="default">
0
</td>
2016-02-17 13:27:09 +00:00
<td class="description last"><p>Should the tween automatically restart once complete? If you want it to run forever set as -1. This only effects this individual tween, not any chained tweens.</p></td>
</tr>
<tr>
<td class="name"><code>yoyo</code></td>
<td class="type">
2014-02-05 06:29:17 +00:00
<span class="param-type">boolean</span>
</td>
2014-02-05 06:29:17 +00:00
<td class="attributes">
&lt;optional><br>
</td>
2014-02-05 06:29:17 +00:00
<td class="default">
false
</td>
2014-04-10 22:13:43 +00:00
<td class="description last"><p>A tween that yoyos will reverse itself and play backwards automatically. A yoyo'd tween doesn't fire the Tween.onComplete event, so listen for Tween.onLoop instead.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
2015-07-22 14:31:30 +00:00
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
2014-11-15 20:01:46 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>This Tween object.</p>
</div>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-190">line 190</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="update"><span class="type-signature"></span>update<span class="signature">(time)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Core tween update function called by the TweenManager. Does not need to be invoked directly.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A timestamp passed in by the TweenManager.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
2014-11-25 00:23:44 +00:00
<p>false if the tween and all child tweens have completed and should be deleted from the manager, otherwise true (still active).</p>
2014-11-15 20:01:46 +00:00
</div>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-717">line 717</a>
2015-03-23 23:46:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="updateTweenData"><span class="type-signature"></span>updateTweenData<span class="signature">(property, value, <span class="optional">index</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Updates either a single TweenData or all TweenData objects properties to the given value.<br>Used internally by methods like Tween.delay, Tween.yoyo, etc. but can also be called directly if you know which property you want to tweak.<br>The property is not checked, so if you pass an invalid one you'll generate a run-time error.</p>
2015-03-23 23:46:30 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>property</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The property to update.</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The value to set the property to.</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the delay on all the children.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-375">line 375</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2015-03-23 23:46:30 +00:00
id="yoyo"><span class="type-signature"></span>yoyo<span class="signature">(enable, <span class="optional">yoyoDelay</span>, <span class="optional">index</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-08-26 00:18:47 +00:00
<p>A Tween that has yoyo set to true will run through from its starting values to its end values and then play back in reverse from end to start.<br>Used in combination with repeat you can create endless loops.<br>If you have not yet called <code>Tween.to</code> or <code>Tween.from</code> at least once then this method will do nothing, as there are no tweens to yoyo.<br>If you have child tweens and pass -1 as the index value it sets the yoyo property across all of them.<br>If you wish to yoyo this Tween and all of its children then see Tween.yoyoAll.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2014-11-25 00:23:44 +00:00
<th>Argument</th>
2014-11-25 00:23:44 +00:00
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2014-11-25 00:23:44 +00:00
<td class="name"><code>enable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
2014-11-25 00:23:44 +00:00
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Set to true to yoyo this tween, or false to disable an already active yoyo.</p></td>
</tr>
2015-03-23 23:46:30 +00:00
<tr>
<td class="name"><code>yoyoDelay</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>This is the amount of time to pause (in ms) before the yoyo will start.</p></td>
</tr>
2014-11-25 00:23:44 +00:00
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
2014-11-25 00:23:44 +00:00
<td class="default">
0
</td>
2014-11-25 00:23:44 +00:00
<td class="description last"><p>If this tween has more than one child this allows you to target a specific child. If set to -1 it will set yoyo on all the children.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-464">line 464</a>
2015-03-23 23:46:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="yoyoDelay"><span class="type-signature"></span>yoyoDelay<span class="signature">(duration, <span class="optional">index</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt>
<dd>
<div class="description">
2016-08-26 00:18:47 +00:00
<p>Sets the delay in milliseconds before this tween will run a yoyo (only applies if yoyo is enabled).<br>The repeatDelay is invoked as soon as you call <code>Tween.start</code>. If the tween is already running this method doesn't do anything for the current active tween.<br>If you have not yet called <code>Tween.to</code> or <code>Tween.from</code> at least once then this method will do nothing, as there are no tweens to set repeatDelay on.<br>If you have child tweens and pass -1 as the index value it sets the repeatDelay across all of them.</p>
2015-03-23 23:46:30 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The amount of time in ms that the Tween should wait until it repeats or yoyos once start is called. Set to zero to remove any active yoyoDelay.</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If this tween has more than one child this allows you to target a specific child. If set to -1 it will set the yoyoDelay on all the children.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This tween. Useful for method chaining.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_tween_Tween.js.html">tween/Tween.js</a>, <a href="src_tween_Tween.js.html#sunlight-1-line-487">line 487</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
2016-04-22 14:15:28 +00:00
Phaser Copyright © 2012-2016 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
2016-08-26 00:18:47 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
on Fri Aug 26 2016 01:16:19 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>