Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-23 21:24:09 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.Game.html

6745 lines
90 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: Game</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser</a>
<ul class="nav">
<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>
</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>
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>
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-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.Easing.Back.html">Back</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.Easing.Bounce.html">Bounce</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.Easing.Circular.html">Circular</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.Easing.Cubic.html">Cubic</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.Easing.Elastic.html">Elastic</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.Easing.Exponential.html">Exponential</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.Easing.Linear.html">Linear</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.Easing.Quadratic.html">Quadratic</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.Easing.Quartic.html">Quartic</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.Easing.Quintic.html">Quintic</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.Easing.Sinusoidal.html">Sinusoidal</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>
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>
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>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</ul>
</li>
Docs updates.
2014-09-09 14:36:56 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: Game</h1>
<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
Game
</h2>
<div class="class-description"><p>This is where the magic happens. The Game object is the heart of your game,
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
providing quick access to common functions and handling the boot process.
&quot;Hell, there are no rules here - we're trying to accomplish something.&quot;
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Thomas A. Edison</p></div>
</header>
<article>
<div class="container-overview">
<dt>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
<h4 class="name" id="Game"><span class="type-signature"></span>new Game<span class="signature">(<span class="optional">width</span>, <span class="optional">height</span>, <span class="optional">renderer</span>, <span class="optional">parent</span>, <span class="optional">state</span>, <span class="optional">transparent</span>, <span class="optional">antialias</span>, <span class="optional">physicsConfig</span>)</span><span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<div class="description">
<p>Game constructor</p>
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
<p>Instantiate a new &lt;code&gt;Phaser.Game&lt;/code&gt; object.</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>
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<th>Argument</th>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +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>width</code></td>
<td class="type">
<span class="param-type">number</span>
Docs updates.
2014-09-09 14:36:56 +00:00
|
<span class="param-type">string</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="default">
800
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
Docs updates.
2014-09-09 14:36:56 +00:00
|
<span class="param-type">string</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="default">
600
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
<tr>
<td class="name"><code>renderer</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="default">
Phaser.AUTO
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all).</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
<tr>
<td class="name"><code>parent</code></td>
<td class="type">
Updated doc files.
2014-02-05 06:29:17 +00:00
<span class="param-type">string</span>
|
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<span class="param-type">HTMLElement</span>
</td>
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="default">
''
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
<tr>
<td class="name"><code>state</code></td>
<td class="type">
Updated doc files.
2014-02-05 06:29:17 +00:00
<span class="param-type">object</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="attributes">
&lt;optional><br>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
</td>
<td class="default">
null
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
<tr>
<td class="name"><code>transparent</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="attributes">
&lt;optional><br>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
</td>
<td class="default">
false
</td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="description last"><p>Use a transparent canvas background or not.</p></td>
</tr>
<tr>
<td class="name"><code>antialias</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
<td class="attributes">
&lt;optional><br>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
</td>
<td class="default">
true
</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>Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
<tr>
<td class="name"><code>physicsConfig</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>A physics configuration object to pass to the Physics world on creation.</p></td>
</tr>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-26">line 26</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="add"><span class="type-signature"></span>add<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>add</code></td>
<td class="type">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<span class="param-type"><a href="Phaser.GameObjectFactory.html">Phaser.GameObjectFactory</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
<td class="description last"><p>Reference to the Phaser.GameObjectFactory.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-114">line 114</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="antialias"><span class="type-signature"></span>antialias<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>antialias</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>Anti-alias graphics. By default scaled images are smoothed in Canvas and WebGL, set anti-alias to false to disable this globally.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
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>true</li></ul></dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-71">line 71</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="cache"><span class="type-signature"></span>cache<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cache</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Cache.html">Phaser.Cache</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
<td class="description last"><p>Reference to the assets cache.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-124">line 124</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="camera"><span class="type-signature"></span>camera<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>camera</code></td>
<td class="type">
re-generated documentation
2014-04-10 22:13:43 +00:00
<span class="param-type"><a href="Phaser.Camera.html">Phaser.Camera</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
<td class="description last"><p>A handy reference to world.camera.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-194">line 194</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="canvas"><span class="type-signature"></span>canvas<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>canvas</code></td>
<td class="type">
<span class="param-type">HTMLCanvasElement</span>
</td>
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
<td class="description last"><p>A handy reference to renderer.view, the canvas that the game is being rendered in to.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-199">line 199</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="config"><span class="type-signature"></span>config<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The Phaser.Game configuration object.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-36">line 36</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="context"><span class="type-signature"></span>context<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type">CanvasRenderingContext2D</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
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
<td class="description last"><p>A handy reference to renderer.context (only set for CANVAS games, not WebGL)</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-204">line 204</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="debug"><span class="type-signature"></span>debug<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>debug</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.Utils.Debug.html">Phaser.Utils.Debug</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
<td class="description last"><p>A set of useful debug utilitie.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-209">line 209</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="device"><span class="type-signature"></span>device<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>device</code></td>
<td class="type">
More Docs!
2013-10-03 00:21:08 +00:00
<span class="param-type"><a href="Phaser.Device.html">Phaser.Device</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
<td class="description last"><p>Contains device information and capabilities.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-189">line 189</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="height"><span class="type-signature"></span>height<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Docs updates.
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The calculated game height in pixels.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
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>600</li></ul></dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-59">line 59</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Phaser Game ID (for when Pixi supports multiple instances).</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-31">line 31</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="input"><span class="type-signature"></span>input<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
Input and keyboard docs.
2013-10-02 12:18:58 +00:00
<span class="param-type"><a href="Phaser.Input.html">Phaser.Input</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
<td class="description last"><p>Reference to the input manager</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-129">line 129</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isBooted"><span class="type-signature"></span>isBooted<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>isBooted</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Whether the game engine is booted, aka available.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-98">line 98</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isRunning"><span class="type-signature"></span>isRunning<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Is game running or paused?</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-104">line 104</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="load"><span class="type-signature"></span>load<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>load</code></td>
<td class="type">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
<td class="description last"><p>Reference to the assets loader.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-134">line 134</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="make"><span class="type-signature"></span>make<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>make</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.GameObjectCreator.html">Phaser.GameObjectCreator</a></span>
</td>
<td class="description last"><p>Reference to the GameObject Creator.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-119">line 119</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="math"><span class="type-signature"></span>math<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>math</code></td>
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type"><a href="Phaser.Math.html">Phaser.Math</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
<td class="description last"><p>Reference to the math helper.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-139">line 139</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="net"><span class="type-signature"></span>net<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>net</code></td>
<td class="type">
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<span class="param-type"><a href="Phaser.Net.html">Phaser.Net</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
<td class="description last"><p>Reference to the network class.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-144">line 144</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="onBlur"><span class="type-signature"></span>onBlur<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>onBlur</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>This event is fired when the game no longer has focus (typically on page hide).</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-250">line 250</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="onFocus"><span class="type-signature"></span>onFocus<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>onFocus</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>This event is fired when the game has focus (typically on page show).</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-255">line 255</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="onPause"><span class="type-signature"></span>onPause<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>onPause</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>This event is fired when the game pauses.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-240">line 240</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="onResume"><span class="type-signature"></span>onResume<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>onResume</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>This event is fired when the game resumes from a paused state.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-245">line 245</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="parent"><span class="type-signature"></span>parent<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>parent</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
re-generated documentation
2014-04-10 22:13:43 +00:00
<span class="param-type">string</span>
|
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type">HTMLElement</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>The Games DOM parent.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-47">line 47</a>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="particles"><span class="type-signature"></span>particles<span class="type-signature"></span></h4>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>particles</code></td>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.Particles.html">Phaser.Particles</a></span>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>The Particle Manager.</p></td>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-214">line 214</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="paused"><span class="type-signature"></span>paused<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<div class="description">
<p>The paused state of the Game. A paused game doesn't update any of its subsystems.
When a game is paused the onPause event is dispatched. When it is resumed the onResume event is dispatched.</p>
</div>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>paused</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type">boolean</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>Gets and sets the paused state of the Game.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-867">line 867</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="pendingStep"><span class="type-signature">&lt;readonly> </span>pendingStep<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
re-generated documentation
2014-04-10 22:13:43 +00:00
<td class="name"><code>pendingStep</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type">boolean</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>An internal property used by enableStep, but also useful to query from your own game objects.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +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
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-228">line 228</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="physics"><span class="type-signature"></span>physics<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>physics</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.Physics.html">Phaser.Physics</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>Reference to the physics manager.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-179">line 179</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="physicsConfig"><span class="type-signature"></span>physicsConfig<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>physicsConfig</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type">object</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>The Phaser.Physics.World configuration object.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
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
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-41">line 41</a>
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
</li></ul></dd>
Republished docs.
2014-07-10 19:31:11 +00:00
</dl>
</dd>
<dt>
<h4 class="name" id="preserveDrawingBuffer"><span class="type-signature"></span>preserveDrawingBuffer<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>preserveDrawingBuffer</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-77">line 77</a>
</li></ul></dd>
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
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="raf"><span class="type-signature"></span>raf<span class="type-signature"></span></h4>
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
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>raf</code></td>
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
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.RequestAnimationFrame.html">Phaser.RequestAnimationFrame</a></span>
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
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>Automatically handles the core game loop via requestAnimationFrame or setTimeout</p></td>
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
</tr>
</tbody>
</table>
</dl>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-109">line 109</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="renderer"><span class="type-signature"></span>renderer<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>renderer</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
re-generated documentation
2014-04-10 22:13:43 +00:00
<span class="param-type">PIXI.CanvasRenderer</span>
|
<span class="param-type">PIXI.WebGLRenderer</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
re-generated documentation
2014-04-10 22:13:43 +00:00
<td class="description last"><p>The Pixi Renderer.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-82">line 82</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="renderType"><span class="type-signature"></span>renderType<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>renderType</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type">number</span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>The Renderer this game will use. Either Phaser.AUTO, Phaser.CANVAS or Phaser.WEBGL.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-87">line 87</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="rnd"><span class="type-signature"></span>rnd<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>rnd</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.RandomDataGenerator.html">Phaser.RandomDataGenerator</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>Instance of repeatable random data generator helper.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-184">line 184</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="scale"><span class="type-signature"></span>scale<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>scale</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.ScaleManager.html">Phaser.ScaleManager</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>The game scale manager.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-149">line 149</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="sound"><span class="type-signature"></span>sound<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>sound</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.SoundManager.html">Phaser.SoundManager</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>Reference to the sound manager.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-154">line 154</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="stage"><span class="type-signature"></span>stage<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>stage</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type"><a href="Phaser.Stage.html">Phaser.Stage</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>Reference to the stage.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-159">line 159</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="state"><span class="type-signature"></span>state<span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>state</code></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<td class="type">
re-generated documentation
2014-04-10 22:13:43 +00:00
<span class="param-type"><a href="Phaser.StateManager.html">Phaser.StateManager</a></span>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>The StateManager.</p></td>
Updated doc files.
2014-02-05 06:29:17 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-92">line 92</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="stepCount"><span class="type-signature">&lt;readonly> </span>stepCount<span class="type-signature"></span></h4>
Updated doc files.
2014-02-05 06:29:17 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>stepCount</code></td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type">number</span>
Updated doc files.
2014-02-05 06:29:17 +00:00
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>When stepping is enabled this contains the current step cycle.</p></td>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
</dl>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-235">line 235</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="stepping"><span class="type-signature">&lt;readonly> </span>stepping<span class="type-signature"></span></h4>
Updated doc files.
2014-02-05 06:29:17 +00:00
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="name"><code>stepping</code></td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="type">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Enable core loop stepping with Game.enableStep().</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-221">line 221</a>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="time"><span class="type-signature"></span>time<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
re-generated documentation
2014-04-10 22:13:43 +00:00
<span class="param-type"><a href="Phaser.Time.html">Phaser.Time</a></span>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</td>
re-generated documentation
2014-04-10 22:13:43 +00:00
<td class="description last"><p>Reference to the core game clock.</p></td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-164">line 164</a>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="transparent"><span class="type-signature"></span>transparent<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>transparent</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Use a transparent canvas background or not.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-65">line 65</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="tweens"><span class="type-signature"></span>tweens<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tweens</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.TweenManager.html">Phaser.TweenManager</a></span>
</td>
<td class="description last"><p>Reference to the tween manager.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-169">line 169</a>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="width"><span class="type-signature"></span>width<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
Updated doc files.
2014-02-05 06:29:17 +00:00
</td>
Docs updates.
2014-09-09 14:36:56 +00:00
<td class="description last"><p>The calculated game width in pixels.</p></td>
Updated doc files.
2014-02-05 06:29:17 +00:00
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>800</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Fresh build. Updated docs and re-built phaser.js.
2014-02-19 05:28:19 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-53">line 53</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="world"><span class="type-signature"></span>world<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>world</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.World.html">Phaser.World</a></span>
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="description last"><p>Reference to the world.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Republished docs.
2014-07-10 19:31:11 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-174">line 174</a>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="boot"><span class="type-signature">&lt;protected> </span>boot<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Initialize engine sub modules and start the game.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-417">line 417</a>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</li></ul></dd>
</dl>
Updated doc files.
2014-02-05 06:29:17 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dd>
Updated doc files.
2014-02-05 06:29:17 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<dt>
<h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Docs updates.
2014-09-09 14:36:56 +00:00
<p>Nukes the entire game from orbit.</p>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</div>
Updated doc files.
2014-02-05 06:29:17 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<dl class="details">
Updated doc files.
2014-02-05 06:29:17 +00:00
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-755">line 755</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dd>
Updated doc files.
2014-02-05 06:29:17 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="disableStep"><span class="type-signature"></span>disableStep<span class="signature">()</span><span class="type-signature"></span></h4>
Updated doc files.
2014-02-05 06:29:17 +00:00
</dt>
<dd>
<div class="description">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<p>Disables core game loop stepping.</p>
Updated doc files.
2014-02-05 06:29:17 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-730">line 730</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="enableStep"><span class="type-signature"></span>enableStep<span class="signature">()</span><span class="type-signature"></span></h4>
Updated doc files.
2014-02-05 06:29:17 +00:00
</dt>
<dd>
<div class="description">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<p>Enable core game loop stepping. When enabled you must call game.step() directly (perhaps via a DOM button?)
Calling step will advance the game loop by one frame. This is extremely useful for hard to track down errors!</p>
Updated doc files.
2014-02-05 06:29:17 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-716">line 716</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
Updated doc files.
2014-02-05 06:29:17 +00:00
</dd>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="focusGain"><span class="type-signature">&lt;protected> </span>focusGain<span class="signature">(event)</span><span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<div class="description">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<p>Called by the Stage visibility handler.</p>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<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>event</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The DOM event that caused the game to pause, if any.</p></td>
</tr>
</tbody>
</table>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-845">line 845</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="focusLoss"><span class="type-signature">&lt;protected> </span>focusLoss<span class="signature">(event)</span><span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<div class="description">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<p>Called by the Stage visibility handler.</p>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<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>event</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The DOM event that caused the game to pause, if any.</p></td>
</tr>
</tbody>
</table>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-827">line 827</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="gamePaused"><span class="type-signature">&lt;protected> </span>gamePaused<span class="signature">(event)</span><span class="type-signature"></span></h4>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</dt>
<dd>
<div class="description">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<p>Called by the Stage visibility handler.</p>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<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>event</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The DOM event that caused the game to pause, if any.</p></td>
</tr>
</tbody>
</table>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-786">line 786</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="gameResumed"><span class="type-signature">&lt;protected> </span>gameResumed<span class="signature">(event)</span><span class="type-signature"></span></h4>
Updated doc files.
2014-02-05 06:29:17 +00:00
</dt>
<dd>
<div class="description">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<p>Called by the Stage visibility handler.</p>
Updated doc files.
2014-02-05 06:29:17 +00:00
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<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>event</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The DOM event that caused the game to pause, if any.</p></td>
</tr>
</tbody>
</table>
Updated doc files.
2014-02-05 06:29:17 +00:00
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-806">line 806</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<h4 class="name" id="parseConfig"><span class="type-signature">&lt;protected> </span>parseConfig<span class="signature">()</span><span class="type-signature"></span></h4>
Updated doc files.
2014-02-05 06:29:17 +00:00
</dt>
<dd>
<div class="description">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<p>Parses a Game configuration object.</p>
Updated doc files.
2014-02-05 06:29:17 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-342">line 342</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setUpRenderer"><span class="type-signature">&lt;protected> </span>setUpRenderer<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the device is capable of using the requested renderer and sets it up or an alternative if not.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-565">line 565</a>
Updated docs for 1.1.2 release.
2013-11-01 18:16:52 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="showDebugHeader"><span class="type-signature">&lt;protected> </span>showDebugHeader<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Displays a Phaser version debug header in the console.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-503">line 503</a>
Updated doc files.
2014-02-05 06:29:17 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="step"><span class="type-signature"></span>step<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>When stepping is enabled you must call this function directly (perhaps via a DOM button?) to advance the game loop by one frame.
This is extremely useful to hard to track down errors! Use the internal stepCount property to monitor progress.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-742">line 742</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="update"><span class="type-signature">&lt;protected> </span>update<span class="signature">(time)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Republished docs.
2014-07-10 19:31:11 +00:00
<p>The core game loop.</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 class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The current time as provided by RequestAnimationFrame.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Docs updates.
2014-09-09 14:36:56 +00:00
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-646">line 646</a>
Preparing more documentation.
2013-10-02 00:16:40 +00:00
</li></ul></dd>
</dl>
</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>
Docs updates.
2014-09-09 14:36:56 +00:00
on Tue Sep 09 2014 15:29:25 GMT+0100 (BST) 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>
More docs coming on.
2013-10-01 15:39:39 +00:00
</html>
Reference in a new issue Copy permalink