Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-27 23:20:59 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.Animation.html

4255 lines
73 KiB
HTML
Raw Normal View History

Preparing more documentation.
2013-10-02 00:16:40 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Animation</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
2.2 doc files.
2014-11-15 20:01:46 +00:00
<link type="text/css" rel="stylesheet" href="styles/default.css">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
2.2.0 RC11 Docs Export.
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>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<div class="navbar-inner">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<a class="brand" href="index.html">Phaser API</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<ul class="nav">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<li class="dropdown">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
Preparing more documentation.
2013-10-02 00:16:40 +00:00
class="caret"></b></a>
<ul class="dropdown-menu ">
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.html">Phaser</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</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 ">
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.AnimationManager.html">AnimationManager</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.AnimationParser.html">AnimationParser</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li>
Docs update.
2014-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Cache.html">Cache</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Camera.html">Camera</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Canvas.html">Canvas</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Circle.html">Circle</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Color.html">Color</a>
More Docs!
2013-10-03 00:21:08 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Device.html">Device</a>
More docs.
2013-10-02 11:11:22 +00:00
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.html">Easing</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
Docs updates.
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>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Frame.html">Frame</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.FrameData.html">FrameData</a>
More Docs!
2013-10-03 00:21:08 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Image.html">Image</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More docs.
2013-10-02 11:11:22 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.LoaderParser.html">LoaderParser</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
More docs.
2013-10-02 11:11:22 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
re-generated documentation
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">
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.html">P2</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Material.html">Material</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
Docs updates.
2014-09-09 14:36:56 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More docs.
2013-10-02 11:11:22 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More docs.
2013-10-02 11:11:22 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Added in a Group.sort demo, also updated the documentation and build files.
2013-11-07 06:10:15 +00:00
<a href="Phaser.Polygon.html">Polygon</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More docs.
2013-10-02 11:11:22 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More Docs!
2013-10-03 00:21:08 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
Docs updates.
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More docs.
2013-10-02 11:11:22 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More Docs!
2013-10-03 00:21:08 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More Docs!
2013-10-03 00:21:08 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More docs.
2013-10-02 11:11:22 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More docs.
2013-10-02 11:11:22 +00:00
<a href="Phaser.State.html">State</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More docs.
2013-10-02 11:11:22 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Time.html">Time</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Tween.html">Tween</a>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Utils.html">Utils</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
More docs.
2013-10-02 11:11:22 +00:00
<a href="Phaser.World.html">World</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AjaxRequest.html">AjaxRequest</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AlphaMaskFilter.html">AlphaMaskFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AsciiFilter.html">AsciiFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AssetLoader.html">AssetLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AtlasLoader.html">AtlasLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapFontLoader.html">BitmapFontLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurFilter.html">BlurFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurXFilter.html">BlurXFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurYFilter.html">BlurYFilter</a>
</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>
<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.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ColorMatrixFilter.html">ColorMatrixFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ColorStepFilter.html">ColorStepFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ConvolutionFilter.html">ConvolutionFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CrossHatchFilter.html">CrossHatchFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplacementFilter.html">DisplacementFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DotScreenFilter.html">DotScreenFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Ellipse.html">Ellipse</a>
</li>
<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.FilterBlock.html">FilterBlock</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">
<a href="PIXI.GrayFilter.html">GrayFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ImageLoader.html">ImageLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InteractionData.html">InteractionData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InteractionManager.html">InteractionManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InvertFilter.html">InvertFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.JsonLoader.html">JsonLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="PIXI.MovieClip.html">MovieClip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.NoiseFilter.html">NoiseFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.NormalMapFilter.html">NormalMapFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixelateFilter.html">PixelateFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PolyK.html">PolyK</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RGBSplitFilter.html">RGBSplitFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RoundedRectangle.html">RoundedRectangle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SepiaFilter.html">SepiaFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SmartBlurFilter.html">SmartBlurFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Spine.html">Spine</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpineLoader.html">SpineLoader</a>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="PIXI.SpineTextureLoader.html">SpineTextureLoader</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteSheetLoader.html">SpriteSheetLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Strip.html">Strip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.StripShader.html">StripShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Texture.html">Texture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TilingSprite.html">TilingSprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftFilter.html">TiltShiftFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftXFilter.html">TiltShiftXFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftYFilter.html">TiltShiftYFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TwistFilter.html">TwistFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.VideoTexture.html">VideoTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
</li>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</ul>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="dropdown">
2.2.0 RC11 Docs Export.
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 ">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
2.2.0 RC11 Docs Export.
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>
<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>
<li class="class-depth-1"><a href="Phaser.InputManager.html">Input Manager</a></li>
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
2.2.0 RC11 Docs Export.
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>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<ul class="dropdown-menu ">
2.2.0 RC11 Docs Export.
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>
<li class="class-depth-1"><a href="Phaser.Emitter.html">Emitter</a></li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
2.2.0 RC11 Docs Export.
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>
<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.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
</ul>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
2.2.0 RC11 Docs Export.
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>
<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>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</ul>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<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>
<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>
<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 ">
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://examples.phaser.io">Phaser Examples</a></li>
<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>
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
<li class="class-depth-1"><a href="https://twitter.com/photonstorm">Twitter</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/">IRC</a></li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="https://leanpub.com/u/photonstorm">Phaser Books</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://www.gittip.com/photonstorm/">GitTip</a></li>
</ul>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<div class="span8">
<div id="main">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<!--<h1 class="page-title">Class: Animation</h1>-->
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<section>
<header>
<h2>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Animation
</h2>
</header>
<article>
<div class="container-overview">
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="Animation"><span class="type-signature"></span>new Animation<span class="signature">(game, parent, name, frameData, frames, <span class="optional">frameRate</span>, <span class="optional">loop</span>, loop)</span><span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<div class="description">
<p>An Animation instance contains a single animation and the controls to play it.
It is created by the AnimationManager, consists of Animation.Frame objects and belongs to a single Game Object such as a Sprite.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<th>Argument</th>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<th>Default</th>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<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>
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="attributes">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
</td>
<td class="default">
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="description last"><p>A reference to the currently running game.</p></td>
</tr>
<tr>
<td class="name"><code>parent</code></td>
<td class="type">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="attributes">
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="default">
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="description last"><p>A reference to the owner of this Animation.</p></td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="attributes">
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="default">
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="description last"><p>The unique name for this animation, used in playback commands.</p></td>
</tr>
<tr>
<td class="name"><code>frameData</code></td>
<td class="type">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<span class="param-type"><a href="Phaser.FrameData.html">Phaser.FrameData</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="attributes">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
</td>
<td class="default">
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="description last"><p>The FrameData object that contains all frames used by this Animation.</p></td>
</tr>
<tr>
<td class="name"><code>frames</code></td>
<td class="type">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<span class="param-type">Array.&lt;number></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
|
2.2 doc files.
2014-11-15 20:01:46 +00:00
<span class="param-type">Array.&lt;string></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="attributes">
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="default">
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="description last"><p>An array of numbers or strings indicating which frames to play in which order.</p></td>
</tr>
<tr>
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="name"><code>frameRate</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="attributes">
&lt;optional><br>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="default">
60
</td>
<td class="description last"><p>The speed at which the animation should play. The speed is given in frames per second.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>loop</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
<span class="param-type">boolean</span>
</td>
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.1.3 documentation updates.
2014-10-22 20:49:44 +00:00
<td class="description last"><p>Whether or not the animation is looped or just plays once.</p></td>
</tr>
<tr>
<td class="name"><code>loop</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>Should this animation loop when it reaches the end or play through once.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-22">line 22</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="currentFrame"><span class="type-signature"></span>currentFrame<span class="type-signature"> :<a href="Phaser.Frame.html">Phaser.Frame</a></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The currently displayed frame of the Animation.</p>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-125">line 125</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="delay"><span class="type-signature"></span>delay<span class="type-signature"> :number</span></h4>
</dt>
<dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The delay in ms between each frame of the Animation, based on the given frameRate.</p>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-58">line 58</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="enableUpdate"><span class="type-signature"></span>enableUpdate<span class="type-signature"> :boolean</span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Gets or sets if this animation will dispatch the onUpdate events upon changing frame.</p>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-704">line 704</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="frame"><span class="type-signature"></span>frame<span class="type-signature"> :number</span></h4>
</dt>
<dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Gets or sets the current frame index and updates the Texture Cache for display.</p>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-643">line 643</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="frameTotal"><span class="type-signature">&lt;readonly> </span>frameTotal<span class="type-signature"> :number</span></h4>
Docs updates.
2014-09-09 14:36:56 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The total number of frames in the currently loaded FrameData, or -1 if no FrameData is loaded.</p>
</div>
Docs updates.
2014-09-09 14:36:56 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-630">line 630</a>
</dt>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
</dt>
<dd>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>A reference to the currently running Game.</p>
</div>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-29">line 29</a>
</dt>
Docs updates.
2014-09-09 14:36:56 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="isFinished"><span class="type-signature"></span>isFinished<span class="type-signature"> :boolean</span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The finished state of the Animation. Set to true once playback completes, false during playback.</p>
</div>
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<dl class="details">
Updated doc files.
2014-02-05 06:29:17 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-80">line 80</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="isPaused"><span class="type-signature"></span>isPaused<span class="type-signature"> :boolean</span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The paused state of the Animation.</p>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-92">line 92</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="isPlaying"><span class="type-signature"></span>isPlaying<span class="type-signature"> :boolean</span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The playing state of the Animation. Set to false once playback completes, true during playback.</p>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-86">line 86</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="killOnComplete"><span class="type-signature"></span>killOnComplete<span class="type-signature"> :boolean</span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Should the parent of this Animation be killed when the animation completes?</p>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-74">line 74</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
</dd>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="loop"><span class="type-signature"></span>loop<span class="type-signature"> :boolean</span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The loop state of the Animation.</p>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<dl class="details">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-63">line 63</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="loopCount"><span class="type-signature"></span>loopCount<span class="type-signature"> :number</span></h4>
</dt>
<dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The number of times the animation has looped since it was last started.</p>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-68">line 68</a>
</dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dl>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The user defined name given to this Animation.</p>
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<dl class="details">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-46">line 46</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +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>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>This event is dispatched when this Animation completes playback. If the animation is set to loop this is never fired, listen for onAnimationLoop instead.</p>
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-141">line 141</a>
</dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="onLoop"><span class="type-signature"></span>onLoop<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>This event is dispatched when this Animation loops.</p>
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-146">line 146</a>
</dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="onStart"><span class="type-signature"></span>onStart<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>This event is dispatched when this Animation starts playback.</p>
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-130">line 130</a>
</dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="onUpdate"><span class="type-signature"></span>onUpdate<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a>|null</span></h4>
Docs updates.
2014-09-09 14:36:56 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>This event is dispatched when the Animation changes frame. By default this event is disabled due to its intensive nature. Enable it with: <code>Animation.enableUpdate = true</code>.</p>
</div>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Type:</h5>
<ul>
<li>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
|
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<span class="param-type">null</span>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
</ul>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Docs updates.
2014-09-09 14:36:56 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-136">line 136</a>
</dt>
Docs updates.
2014-09-09 14:36:56 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="paused"><span class="type-signature"></span>paused<span class="type-signature"> :boolean</span></h4>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Gets and sets the paused state of this Animation.</p>
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-596">line 596</a>
</dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="speed"><span class="type-signature"></span>speed<span class="type-signature"> :number</span></h4>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Gets or sets the current speed of the animation in frames per second. Changing this in a playing animation will take effect from the next frame. Minimum value is 1.</p>
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-681">line 681</a>
</dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
id="generateFrameNames"><span class="type-signature">&lt;static> </span>generateFrameNames<span class="signature">(prefix, start, stop, <span class="optional">suffix</span>, <span class="optional">zeroPad</span>)</span><span class="type-signature"> &rarr; {string[]}</span></h4>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<div class="description">
<p>Really handy function for when you are creating arrays of animation data but it's using frame names and not numbers.
For example imagine you've got 30 frames named: 'explosion<em>0001-large' to 'explosion_0030-large'
You could use this function to generate those by doing: Phaser.Animation.generateFrameNames('explosion</em>', 1, 30, '-large', 4);</p>
</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>prefix</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 start of the filename. If the filename was 'explosion<em>0001-large' the prefix would be 'explosion</em>'.</p></td>
</tr>
<tr>
<td class="name"><code>start</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 number to start sequentially counting from. If your frames are named 'explosion_0001' to 'explosion_0034' the start is 1.</p></td>
</tr>
<tr>
<td class="name"><code>stop</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 number to count to. If your frames are named 'explosion_0001' to 'explosion_0034' the stop value is 34.</p></td>
</tr>
<tr>
<td class="name"><code>suffix</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Preparing more documentation.
2013-10-02 00:16:40 +00:00
''
</td>
<td class="description last"><p>The end of the filename. If the filename was 'explosion_0001-large' the prefix would be '-large'.</p></td>
</tr>
<tr>
<td class="name"><code>zeroPad</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>The number of zeroes to pad the min and max values with. If your frames are named 'explosion_0001' to 'explosion_0034' then the zeroPad is 4.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<span class="param-type">string[]</span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>An array of framenames.</p>
</div>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-732">line 732</a>
</dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="complete"><span class="type-signature"></span>complete<span class="signature">()</span><span class="type-signature"></span></h4>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<div class="description">
<p>Called internally when the animation finishes playback.
Sets the isPlaying and isFinished states and dispatches the onAnimationComplete event if it exists on the parent and local onComplete event.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-569">line 569</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<div class="description">
<p>Cleans up this animation ready for deletion. Nulls all values and references.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-541">line 541</a>
</dt>
Republished docs.
2014-07-10 19:31:11 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="next"><span class="type-signature"></span>next<span class="signature">(<span class="optional">quantity</span>)</span><span class="type-signature"></span></h4>
Republished docs.
2014-07-10 19:31:11 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
<div class="description">
<p>Advances by the given number of frames in the Animation, taking the loop value into consideration.</p>
</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>quantity</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<td class="description last"><p>The number of frames to advance.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-430">line 430</a>
</dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="onPause"><span class="type-signature"></span>onPause<span class="signature">()</span><span class="type-signature"></span></h4>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<div class="description">
<p>Called when the Game enters a paused state.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-328">line 328</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="onResume"><span class="type-signature"></span>onResume<span class="signature">()</span><span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<div class="description">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<p>Called when the Game resumes from a paused state.</p>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-342">line 342</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="play"><span class="type-signature"></span>play<span class="signature">(<span class="optional">frameRate</span>, <span class="optional">loop</span>, <span class="optional">killOnComplete</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Animation.html">Phaser.Animation</a>}</span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<div class="description">
<p>Plays this animation.</p>
</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>frameRate</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.</p></td>
</tr>
<tr>
<td class="name"><code>loop</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
false
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
<td class="description last"><p>Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.</p></td>
</tr>
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<tr>
<td class="name"><code>killOnComplete</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>If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.</p></td>
</tr>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tbody>
</table>
2.2 doc files.
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.Animation.html">Phaser.Animation</a></span>
-
</div>
<div class="returns-desc param-desc">
<ul>
<li>A reference to this Animation instance.</li>
</ul>
</div>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-156">line 156</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="previous"><span class="type-signature"></span>previous<span class="signature">(<span class="optional">quantity</span>)</span><span class="type-signature"></span></h4>
Republished docs.
2014-07-10 19:31:11 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
<div class="description">
<p>Moves backwards the given number of frames in the Animation, taking the loop value into consideration.</p>
</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>quantity</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<td class="description last"><p>The number of frames to move back.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-479">line 479</a>
</dt>
Republished docs.
2014-07-10 19:31:11 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="restart"><span class="type-signature"></span>restart<span class="signature">()</span><span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<div class="description">
<p>Sets this animation back to the first frame and restarts the animation.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-214">line 214</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Docs update.
2014-04-29 14:39:02 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="setFrame"><span class="type-signature"></span>setFrame<span class="signature">(<span class="optional">frameId</span>, <span class="optional">useLocalFrameIndex</span>)</span><span class="type-signature"></span></h4>
Docs update.
2014-04-29 14:39:02 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs update.
2014-04-29 14:39:02 +00:00
<div class="description">
<p>Sets this animations playback to a given frame with the given ID.</p>
</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>frameId</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The identifier of the frame to set. Can be the name of the frame, the sprite index of the frame, or the animation-local frame index.</p></td>
</tr>
<tr>
<td class="name"><code>useLocalFrameIndex</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>If you provide a number for frameId, should it use the numeric indexes of the frameData, or the 0-indexed frame index local to the animation.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs update.
2014-04-29 14:39:02 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-239">line 239</a>
</dt>
Docs update.
2014-04-29 14:39:02 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs update.
2014-04-29 14:39:02 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="stop"><span class="type-signature"></span>stop<span class="signature">(<span class="optional">resetFrame</span>, <span class="optional">dispatchComplete</span>)</span><span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<div class="description">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<p>Stops playback of this animation and set it to a finished state. If a resetFrame is provided it will stop playback and set frame to the first in the animation.
If <code>dispatchComplete</code> is true it will dispatch the complete events, otherwise they'll be ignored.</p>
Preparing more documentation.
2013-10-02 00:16:40 +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>resetFrame</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>If true after the animation stops the currentFrame value will be set to the first frame in this animation.</p></td>
</tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<tr>
<td class="name"><code>dispatchComplete</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>Dispatch the Animation.onComplete and parent.onAnimationComplete events?</p></td>
</tr>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-297">line 297</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<div class="description">
<p>Updates this animation. Called automatically by the AnimationManager.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-356">line 356</a>
</dt>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="updateFrameData"><span class="type-signature"></span>updateFrameData<span class="signature">(frameData)</span><span class="type-signature"></span></h4>
New docs generated.
2014-07-18 11:45:51 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
<div class="description">
<p>Changes the FrameData object this Animation is using.</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>frameData</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.FrameData.html">Phaser.FrameData</a></span>
</td>
<td class="description last"><p>The FrameData object that contains all frames used by this Animation.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-528">line 528</a>
</dt>
New docs generated.
2014-07-18 11:45:51 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Updated doc files.
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</span>
<br />
<span class="jsdoc-message">
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
API Docs update.
2014-12-04 11:33:42 +00:00
on Thu Dec 04 2014 11:32:26 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</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( {
re-generated documentation
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
return $(heading).attr("id") || ( prefix + i );
},
Preparing more documentation.
2013-10-02 00:16:40 +00:00
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>
Working through building the docs.
2013-10-01 15:15:45 +00:00
</html>
Reference in a new issue Copy permalink