Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-27 15:12:18 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.Loader.html

9280 lines
142 KiB
HTML
Raw Normal View History

Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Loader</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
2.2 doc files.
2014-11-15 20:01:46 +00:00
<link type="text/css" rel="stylesheet" href="styles/default.css">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<div style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="navbar-inner">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<a class="brand" href="index.html">Phaser API</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<ul class="nav">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li class="dropdown">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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>
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.AnimationParser.html">AnimationParser</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
Docs update.
2014-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Cache.html">Cache</a>
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.Camera.html">Camera</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.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>
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.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>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.html">Easing</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-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">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.html">P2</a>
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.Body.html">Body</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.BodyDebug.html">BodyDebug</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.CollisionGroup.html">CollisionGroup</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.ContactMaterial.html">ContactMaterial</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.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>
</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>
</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>
</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>
</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>
</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">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Time.html">Time</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated documentation.
2013-11-28 15:57:09 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Tween.html">Tween</a>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Utils.html">Utils</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<a href="Phaser.World.html">World</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AjaxRequest.html">AjaxRequest</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AlphaMaskFilter.html">AlphaMaskFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AsciiFilter.html">AsciiFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AssetLoader.html">AssetLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AtlasLoader.html">AtlasLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapFontLoader.html">BitmapFontLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurFilter.html">BlurFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurXFilter.html">BlurXFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurYFilter.html">BlurYFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasBuffer.html">CanvasBuffer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasGraphics.html">CanvasGraphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ColorMatrixFilter.html">ColorMatrixFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ColorStepFilter.html">ColorStepFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ConvolutionFilter.html">ConvolutionFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CrossHatchFilter.html">CrossHatchFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplacementFilter.html">DisplacementFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DotScreenFilter.html">DotScreenFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterBlock.html">FilterBlock</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GrayFilter.html">GrayFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ImageLoader.html">ImageLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InteractionData.html">InteractionData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InteractionManager.html">InteractionManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InvertFilter.html">InvertFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.JsonLoader.html">JsonLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="PIXI.MovieClip.html">MovieClip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.NoiseFilter.html">NoiseFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.NormalMapFilter.html">NormalMapFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixelateFilter.html">PixelateFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PolyK.html">PolyK</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RGBSplitFilter.html">RGBSplitFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RoundedRectangle.html">RoundedRectangle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SepiaFilter.html">SepiaFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SmartBlurFilter.html">SmartBlurFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Spine.html">Spine</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpineLoader.html">SpineLoader</a>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="PIXI.SpineTextureLoader.html">SpineTextureLoader</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteSheetLoader.html">SpriteSheetLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Strip.html">Strip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.StripShader.html">StripShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Texture.html">Texture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TilingSprite.html">TilingSprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftFilter.html">TiltShiftFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftXFilter.html">TiltShiftXFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftYFilter.html">TiltShiftYFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TwistFilter.html">TwistFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.VideoTexture.html">VideoTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</ul>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="dropdown">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li>
<li class="class-depth-1"><a href="Phaser.World.html">World</a></li>
<li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li>
<li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li>
<li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li>
<li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li>
<li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li>
<li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li>
<li class="class-depth-1"><a href="Phaser.InputManager.html">Input Manager</a></li>
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<ul class="dropdown-menu ">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li>
<li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li>
<li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li>
<li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li>
<li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li>
<li class="class-depth-1"><a href="Phaser.Emitter.html">Emitter</a></li>
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li>
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
</ul>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</ul>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li>
<li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li>
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://examples.phaser.io">Phaser Examples</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li>
<li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li>
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
<li class="class-depth-1"><a href="https://twitter.com/photonstorm">Twitter</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/">IRC</a></li>
<li class="class-depth-1"><a href="https://www.gittip.com/photonstorm/">GitTip</a></li>
</ul>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="span8">
<div id="main">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<!--<h1 class="page-title">Class: Loader</h1>-->
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<section>
<header>
<h2>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Loader
</h2>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<div class="class-description"><p>Phaser.Loader</p></div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</header>
<article>
<div class="container-overview">
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="Loader"><span class="type-signature"></span>new Loader<span class="signature">(game)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<p>The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
It uses a combination of Image() loading and xhr and provides progress and completion callbacks.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"><p>A reference to the currently running game.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-16">line 16</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<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>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="PHYSICS_LIME_CORONA_JSON"><span class="type-signature">&lt;static, constant> </span>PHYSICS_LIME_CORONA_JSON<span class="type-signature"> :number</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>
2.2 doc files.
2014-11-15 20:01:46 +00:00
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 class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-173">line 173</a>
</dt>
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
re-generated documentation
2014-04-10 22:13:43 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="PHYSICS_PHASER_JSON"><span class="type-signature">&lt;static, constant> </span>PHYSICS_PHASER_JSON<span class="type-signature"> :number</span></h4>
re-generated documentation
2014-04-10 22:13:43 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
re-generated documentation
2014-04-10 22:13:43 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-179">line 179</a>
</dt>
re-generated documentation
2014-04-10 22:13:43 +00:00
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>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="TEXTURE_ATLAS_JSON_ARRAY"><span class="type-signature">&lt;static, constant> </span>TEXTURE_ATLAS_JSON_ARRAY<span class="type-signature"> :number</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-155">line 155</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="TEXTURE_ATLAS_JSON_HASH"><span class="type-signature">&lt;static, constant> </span>TEXTURE_ATLAS_JSON_HASH<span class="type-signature"> :number</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-161">line 161</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="TEXTURE_ATLAS_XML_STARLING"><span class="type-signature">&lt;static, constant> </span>TEXTURE_ATLAS_XML_STARLING<span class="type-signature"> :number</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-167">line 167</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="baseURL"><span class="type-signature"></span>baseURL<span class="type-signature"> :string</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>If you want to append a URL before the path of any asset you can set this here.
Useful if you need to allow an asset url to be configured outside of the game code.
MUST have / on the end of it!</p>
</div>
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-69">line 69</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="crossOrigin"><span class="type-signature"></span>crossOrigin<span class="type-signature"> :boolean|string</span></h4>
</dt>
<dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The crossOrigin value applied to loaded images. Very often this needs to be set to 'anonymous'.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
|
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<span class="param-type">string</span>
</li>
</ul>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-60">line 60</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Local reference to game.</p>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-21">line 21</a>
</dt>
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
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="hasLoaded"><span class="type-signature"></span>hasLoaded<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>True if all assets in the queue have finished loading.</p>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
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-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-33">line 33</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="isLoading"><span class="type-signature"></span>isLoading<span class="type-signature"> :boolean</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>True if the Loader is in the process of loading the queue.</p>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Build files + docs update.
2014-04-15 14:39:23 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Build files + docs update.
2014-04-15 14:39:23 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
Build files + docs update.
2014-04-15 14:39:23 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-27">line 27</a>
</dt>
Build files + docs update.
2014-04-15 14:39:23 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="onFileComplete"><span class="type-signature"></span>onFileComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
Build files + docs update.
2014-04-15 14:39:23 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Build files + docs update.
2014-04-15 14:39:23 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>This event is dispatched when a file completes loading successfully.</p>
</div>
Build files + docs update.
2014-04-15 14:39:23 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-84">line 84</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="onFileError"><span class="type-signature"></span>onFileError<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>This event is dispatched when a file errors as a result of the load request.</p>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-89">line 89</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="onFileStart"><span class="type-signature"></span>onFileStart<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>This event is dispatched immediately before a file starts loading. It's possible the file may still error (404, etc) after this event is sent.</p>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-79">line 79</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="onLoadComplete"><span class="type-signature"></span>onLoadComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
New docs generated.
2014-07-18 11:45:51 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>This event is dispatched when the final file in the load queue has either loaded or failed.</p>
</div>
New docs generated.
2014-07-18 11:45:51 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-94">line 94</a>
</dt>
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="onLoadStart"><span class="type-signature"></span>onLoadStart<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>This event is dispatched when the loading process starts, before the first file has been requested.</p>
</div>
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
New docs generated.
2014-07-18 11:45:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-74">line 74</a>
</dt>
New docs generated.
2014-07-18 11:45:51 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="onPackComplete"><span class="type-signature"></span>onPackComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<p>This event is dispatched when an asset pack has either loaded or failed.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</div>
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-99">line 99</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="preloadSprite"><span class="type-signature"></span>preloadSprite<span class="type-signature"> :object</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>You can optionally link a sprite to the preloader.
If you do so the Sprites width or height will be cropped based on the percentage loaded.
This property is an object containing: sprite, rect, direction, width and height</p>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-54">line 54</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="progress"><span class="type-signature"></span>progress<span class="type-signature"> :number</span></h4>
</dt>
<dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The rounded load progress percentage value (from 0 to 100)</p>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-39">line 39</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="progressFloat"><span class="type-signature"></span>progressFloat<span class="type-signature"> :number</span></h4>
Updated doc files.
2014-02-05 06:29:17 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The non-rounded load progress value (from 0.0 to 100.0)</p>
</div>
Updated doc files.
2014-02-05 06:29:17 +00:00
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-45">line 45</a>
</dt>
Updated doc files.
2014-02-05 06:29:17 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="useXDomainRequest"><span class="type-signature"></span>useXDomainRequest<span class="type-signature"> :boolean</span></h4>
Docs updates.
2014-09-09 14:36:56 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>If true and if the browser supports XDomainRequest, it will be used in preference for xhr when loading json files. This is only relevant for IE9 when you know your server/CDN requires it.</p>
</div>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-104">line 104</a>
</dt>
Docs updates.
2014-09-09 14:36:56 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="addToFileList"><span class="type-signature">&lt;internal> </span>addToFileList<span class="signature">(type, key, url, properties)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Internal function that adds a new entry to the file list. Do not call directly.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">string</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The type of resource to add to the list (image, audio, xml, etc).</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The unique Cache ID key of this resource.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The URL the asset will be loaded from.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>properties</code></td>
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">object</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Any additional properties needed to load the file.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-326">line 326</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="atlas"><span class="type-signature"></span>atlas<span class="signature">(key, textureURL, <span class="optional">atlasURL</span>, <span class="optional">atlasData</span>, <span class="optional">format</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Add a new texture atlas to the loader.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Unique asset key of the texture atlas file.</p></td>
</tr>
<tr>
<td class="name"><code>textureURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The url of the texture atlas image file.</p></td>
</tr>
<tr>
<td class="name"><code>atlasURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.</p></td>
</tr>
<tr>
<td class="name"><code>atlasData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>A JSON or XML data object. You don't need this if the data is being loaded from a URL.</p></td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>A value describing the format of the data, the default is Phaser.Loader.TEXTURE_ATLAS_JSON_ARRAY.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-862">line 862</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="atlasJSONArray"><span class="type-signature"></span>atlasJSONArray<span class="signature">(key, textureURL, <span class="optional">atlasURL</span>, <span class="optional">atlasData</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Add a new texture atlas to the loader. This atlas uses the JSON Array data format.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Updated documentation.
2013-11-28 15:57:09 +00:00
<th>Argument</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Unique asset key of the texture atlas file.</p></td>
</tr>
<tr>
<td class="name"><code>textureURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The url of the texture atlas image file.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>atlasURL</code></td>
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">string</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>atlasData</code></td>
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">object</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>A JSON or XML data object. You don't need this if the data is being loaded from a URL.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-814">line 814</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="atlasJSONHash"><span class="type-signature"></span>atlasJSONHash<span class="signature">(key, textureURL, <span class="optional">atlasURL</span>, <span class="optional">atlasData</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Add a new texture atlas to the loader. This atlas uses the JSON Hash data format.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Updated documentation.
2013-11-28 15:57:09 +00:00
<th>Argument</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Unique asset key of the texture atlas file.</p></td>
</tr>
<tr>
<td class="name"><code>textureURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The url of the texture atlas image file.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>atlasURL</code></td>
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">string</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>atlasData</code></td>
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">object</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>A JSON or XML data object. You don't need this if the data is being loaded from a URL.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-830">line 830</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="atlasXML"><span class="type-signature"></span>atlasXML<span class="signature">(key, textureURL, <span class="optional">atlasURL</span>, <span class="optional">atlasData</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Add a new texture atlas to the loader. This atlas uses the Starling XML data format.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Updated documentation.
2013-11-28 15:57:09 +00:00
<th>Argument</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Unique asset key of the texture atlas file.</p></td>
</tr>
<tr>
<td class="name"><code>textureURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The url of the texture atlas image file.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>atlasURL</code></td>
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">string</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The url of the texture atlas data file (json/xml). You don't need this if you are passing an atlasData object instead.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>atlasData</code></td>
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">object</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>A JSON or XML data object. You don't need this if the data is being loaded from a URL.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-846">line 846</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="audio"><span class="type-signature"></span>audio<span class="signature">(key, urls, autoDecode)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Add a new audio file to the loader.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Unique asset key of the audio file.</p></td>
</tr>
<tr>
<td class="name"><code>urls</code></td>
<td class="type">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<span class="param-type">Array</span>
Updated documentation.
2013-11-28 15:57:09 +00:00
|
<span class="param-type">string</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>An array containing the URLs of the audio files, i.e.: [ 'jump.mp3', 'jump.ogg', 'jump.m4a' ] or a single string containing just one URL.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>autoDecode</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>When using Web Audio the audio files can either be decoded at load time or run-time. They can't be played until they are decoded, but this let's you control when that happens. Decoding is a non-blocking async process.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-615">line 615</a>
</dt>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated readme and docs.
2014-10-09 15:12:53 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="audiosprite"><span class="type-signature"></span>audiosprite<span class="signature">(key, urls, atlasURL)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<div class="description">
<p>Add a new audiosprite file to the loader. Audio Sprites are a combination of audio files and a JSON configuration.
The JSON follows the format of that created by <a href="https://github.com/tonistiigi/audiosprite">https://github.com/tonistiigi/audiosprite</a></p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Unique asset key of the audio file.</p></td>
</tr>
<tr>
<td class="name"><code>urls</code></td>
<td class="type">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<span class="param-type">Array</span>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
|
<span class="param-type">string</span>
</td>
<td class="description last"><p>An array containing the URLs of the audio files, i.e.: [ 'audiosprite.mp3', 'audiosprite.ogg', 'audiosprite.m4a' ] or a single string containing just one URL.</p></td>
</tr>
<tr>
<td class="name"><code>atlasURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The URL of the audiosprite configuration json.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-634">line 634</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="binary"><span class="type-signature"></span>binary<span class="signature">(key, url, <span class="optional">callback</span>, <span class="optional">callbackContext</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
Updated doc files.
2014-02-05 06:29:17 +00:00
<p>Add a binary file to the Loader. It will be loaded via xhr with a responseType of &quot;arraybuffer&quot;. You can specify an optional callback to process the file after load.
When the callback is called it will be passed 2 parameters: the key of the file and the file data.
WARNING: If you specify a callback, the file data will be set to whatever your callback returns. So always return the data object, even if you didn't modify it.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>Unique asset key of the binary file.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="name"><code>url</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>URL of the binary file.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="name"><code>callback</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated doc files.
2014-02-05 06:29:17 +00:00
<span class="param-type">function</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>Optional callback that will be passed the file after loading, so you can perform additional processing on it.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="name"><code>callbackContext</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated doc files.
2014-02-05 06:29:17 +00:00
<span class="param-type">function</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The context under which the callback will be applied. If not specified it will use the callback itself as the context.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-567">line 567</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="bitmapFont"><span class="type-signature"></span>bitmapFont<span class="signature">(key, textureURL, <span class="optional">xmlURL</span>, <span class="optional">xmlData</span>, <span class="optional">xSpacing</span>, <span class="optional">ySpacing</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
Updated doc files.
2014-02-05 06:29:17 +00:00
<p>Add a new bitmap font loading request.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Updated doc files.
2014-02-05 06:29:17 +00:00
<th>Argument</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
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
<th>Default</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
Updated documentation.
2013-11-28 15:57:09 +00:00
<tr>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="name"><code>key</code></td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="type">
<span class="param-type">string</span>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="attributes">
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
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="default">
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>Unique asset key of the bitmap font.</p></td>
Updated documentation.
2013-11-28 15:57:09 +00:00
</tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<tr>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="name"><code>textureURL</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">string</span>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="attributes">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
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="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The url of the font image file.</p></td>
</tr>
<tr>
<td class="name"><code>xmlURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</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="default">
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The url of the font data file (xml/fnt)</p></td>
</tr>
<tr>
<td class="name"><code>xmlData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</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="default">
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>An optional XML data object.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
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>
<td class="name"><code>xSpacing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If you'd like to add additional horizontal spacing between the characters then set the pixel value here.</p></td>
</tr>
<tr>
<td class="name"><code>ySpacing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If you'd like to add additional vertical spacing between the lines then set the pixel value here.</p></td>
</tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
-
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-750">line 750</a>
</dt>
Updated doc files.
2014-02-05 06:29:17 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="checkKeyExists"><span class="type-signature"></span>checkKeyExists<span class="signature">(type, key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
Updated doc files.
2014-02-05 06:29:17 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<div class="description">
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
<p>Check whether asset exists with a specific key.
Use Phaser.Cache to access loaded assets, e.g. Phaser.Cache#checkImageKey</p>
Updated doc files.
2014-02-05 06:29:17 +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>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type asset you want to check.</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to check.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>Return true if exists, otherwise return false.</p>
</div>
</div>
Updated doc files.
2014-02-05 06:29:17 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-232">line 232</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="csvLoadComplete"><span class="type-signature"></span>csvLoadComplete<span class="signature">(index)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Successfully loaded a CSV file.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>index</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The index of the file in the file queue that loaded.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1636">line 1636</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="dataLoadError"><span class="type-signature"></span>dataLoadError<span class="signature">(index)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Error occured when load a JSON.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>index</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The index of the file in the file queue that errored.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1661">line 1661</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="fileComplete"><span class="type-signature"></span>fileComplete<span class="signature">(index)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Called when a file is successfully loaded.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>index</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The index of the file in the file queue that loaded.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1445">line 1445</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="fileError"><span class="type-signature"></span>fileError<span class="signature">(index)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
Updated documentation.
2013-11-28 15:57:09 +00:00
<p>Error occured when loading a file.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>index</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The index of the file in the file queue that errored.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1426">line 1426</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="getAsset"><span class="type-signature"></span>getAsset<span class="signature">(type, key)</span><span class="type-signature"> &rarr; {any}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
Updated documentation.
2013-11-28 15:57:09 +00:00
<p>Gets the asset that is queued for load.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>type</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">string</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The type asset you want to check.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>key</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">string</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Key of the asset you want to check.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">any</span>
-
</div>
<div class="returns-desc param-desc">
<p>Returns an object if found that has 2 properties: index and file. Otherwise false.</p>
</div>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-283">line 283</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="getAssetIndex"><span class="type-signature"></span>getAssetIndex<span class="signature">(type, key)</span><span class="type-signature"> &rarr; {number}</span></h4>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<div class="description">
<p>Gets the fileList index for the given key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type asset you want to check.</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to check.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The index of this key in the filelist, or -1 if not found.</p>
</div>
</div>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-258">line 258</a>
</dt>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="image"><span class="type-signature"></span>image<span class="signature">(key, url, <span class="optional">overwrite</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
Updated documentation.
2013-11-28 15:57:09 +00:00
<p>Add an image to the Loader.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Updated documentation.
2013-11-28 15:57:09 +00:00
<th>Argument</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<th>Default</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Unique asset key of this image file.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
Updated documentation.
2013-11-28 15:57:09 +00:00
<tr>
<td class="name"><code>url</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="type">
<span class="param-type">string</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>URL of image file.</p></td>
</tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<tr>
<td class="name"><code>overwrite</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="type">
<span class="param-type">boolean</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
&lt;optional><br>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="default">
false
</td>
<td class="description last"><p>If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.</p></td>
</tr>
</tbody>
</table>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-441">line 441</a>
</dt>
Tidying up the repo, moving old wip stuff out, clearing up the docs.
2014-02-24 12:14:30 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tidying up the repo, moving old wip stuff out, clearing up the docs.
2014-02-24 12:14:30 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="json"><span class="type-signature"></span>json<span class="signature">(key, url, <span class="optional">overwrite</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Tidying up the repo, moving old wip stuff out, clearing up the docs.
2014-02-24 12:14:30 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tidying up the repo, moving old wip stuff out, clearing up the docs.
2014-02-24 12:14:30 +00:00
<div class="description">
<p>Add a json file to the Loader.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Unique asset key of the json file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the json file.</p></td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Tidying up the repo, moving old wip stuff out, clearing up the docs.
2014-02-24 12:14:30 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-493">line 493</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="jsonLoadComplete"><span class="type-signature"></span>jsonLoadComplete<span class="signature">(index)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
Updated documentation.
2013-11-28 15:57:09 +00:00
<p>Successfully loaded a JSON file.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>index</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The index of the file in the file queue that loaded.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1592">line 1592</a>
</dt>
Republished docs.
2014-07-10 19:31:11 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="pack"><span class="type-signature"></span>pack<span class="signature">(key, <span class="optional">url</span>, <span class="optional">data</span>, <span class="optional">callbackContext</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Republished docs.
2014-07-10 19:31:11 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
<div class="description">
<p>Add an image to the Loader.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Unique asset key of this image file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>URL of the Asset Pack JSON file. If you wish to pass a json object instead set this to null and pass the object as the data parameter.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The Asset Pack JSON data. Use this to pass in a json data object rather than loading it from a URL. TODO</p></td>
</tr>
<tr>
<td class="name"><code>callbackContext</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Some Loader operations, like Binary and Script require a context for their callbacks. Pass the context here.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Republished docs.
2014-07-10 19:31:11 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-404">line 404</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
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
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="physics"><span class="type-signature"></span>physics<span class="signature">(key, <span class="optional">url</span>, <span class="optional">data</span>, <span class="optional">format</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</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>
2.2 doc files.
2014-11-15 20:01:46 +00:00
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
<div class="description">
<p>Add a new physics data object loading request.
The data must be in Lime + Corona JSON format. Physics Editor by code'n'web exports in this format natively.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Unique asset key of the physics json data.</p></td>
</tr>
<tr>
Republished docs.
2014-07-10 19:31:11 +00:00
<td class="name"><code>url</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">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The url of the map data file (csv/json)</p></td>
</tr>
<tr>
Republished docs.
2014-07-10 19:31:11 +00:00
<td class="name"><code>data</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">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
Republished docs.
2014-07-10 19:31:11 +00:00
<td class="description last"><p>An optional JSON data object. If given then the url is ignored and this JSON object is used for physics data instead.</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>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Phaser.Physics.LIME_CORONA_JSON
</td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<td class="description last"><p>The format of the physics data.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
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
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
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 class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-707">line 707</a>
</dt>
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>
2.2 doc files.
2014-11-15 20:01:46 +00:00
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
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="removeAll"><span class="type-signature"></span>removeAll<span class="signature">()</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
Updated documentation.
2013-11-28 15:57:09 +00:00
<p>Remove all file loading requests.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-960">line 960</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="removeFile"><span class="type-signature"></span>removeFile<span class="signature">(type, key)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
Updated documentation.
2013-11-28 15:57:09 +00:00
<p>Remove loading request of a file.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>type</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">string</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The type of resource to add to the list (image, audio, xml, etc).</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>key</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">string</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Key of the file you want to remove.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-942">line 942</a>
</dt>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="replaceInFileList"><span class="type-signature">&lt;internal> </span>replaceInFileList<span class="signature">(type, key, url, properties)</span><span class="type-signature"></span></h4>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<div class="description">
<p>Internal function that replaces an existing entry in the file list with a new one. Do not call directly.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type of resource to add to the list (image, audio, xml, etc).</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The unique Cache ID key of this resource.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The URL the asset will be loaded from.</p></td>
</tr>
<tr>
<td class="name"><code>properties</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Any additional properties needed to load the file.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
Updated documentation.
2013-11-28 15:57:09 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-362">line 362</a>
</dt>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<div class="description">
<p>Reset loader, this will remove the load queue.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-308">line 308</a>
</dt>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
<dt>
<h4 class="name "
id="resize"><span class="type-signature"></span>resize<span class="signature">(width, height)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Called automatically by ScaleManager when the game resizes in RESIZE scalemode.
We use this to adjust the height of the preloading sprite, if set.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The new width of the game in pixels.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The new height of the game in pixels.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-215">line 215</a>
</dt>
</dl>
Updated documentation.
2013-11-28 15:57:09 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="script"><span class="type-signature"></span>script<span class="signature">(key, url, <span class="optional">callback</span>, <span class="optional">callbackContext</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<div class="description">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<p>Add a JavaScript file to the Loader. Once loaded the JavaScript file will be automatically turned into a script tag (and executed), so be careful what you load!
You can also specify a callback. This will be executed as soon as the script tag has been created.</p>
Updated documentation.
2013-11-28 15:57:09 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<th>Argument</th>
Updated documentation.
2013-11-28 15:57:09 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="attributes">
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Unique asset key of the script file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<td class="attributes">
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>URL of the JavaScript file.</p></td>
</tr>
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Optional callback that will be called after the script tag has loaded, so you can perform additional processing.</p></td>
</tr>
<tr>
<td class="name"><code>callbackContext</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The context under which the callback will be applied. If not specified it will use the callback itself as the context.</p></td>
</tr>
Updated documentation.
2013-11-28 15:57:09 +00:00
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Updated documentation.
2013-11-28 15:57:09 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-545">line 545</a>
</dt>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="setPreloadSprite"><span class="type-signature"></span>setPreloadSprite<span class="signature">(sprite, <span class="optional">direction</span>)</span><span class="type-signature"></span></h4>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<div class="description">
<p>You can set a Sprite to be a &quot;preload&quot; sprite by passing it to this method.
A &quot;preload&quot; sprite will have its width or height crop adjusted based on the percentage of the loader in real-time.
Docs updates.
2014-09-09 14:36:56 +00:00
This allows you to easily make loading bars for games. Note that Sprite.visible = true will be set when calling this.</p>
Updated documentation.
2013-11-28 15:57:09 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sprite</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
Tidying up the repo, moving old wip stuff out, clearing up the docs.
2014-02-24 12:14:30 +00:00
|
<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
Updated documentation.
2013-11-28 15:57:09 +00:00
</td>
<td class="attributes">
</td>
<td class="default">
</td>
Updated docs to 2.0.1.
2014-03-24 12:41:45 +00:00
<td class="description last"><p>The sprite or image that will be cropped during the load.</p></td>
Updated documentation.
2013-11-28 15:57:09 +00:00
</tr>
<tr>
<td class="name"><code>direction</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated docs to 2.0.1.
2014-03-24 12:41:45 +00:00
<td class="description last"><p>A value of zero means the sprite will be cropped horizontally, a value of 1 means its will be cropped vertically.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-183">line 183</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="spritesheet"><span class="type-signature"></span>spritesheet<span class="signature">(key, url, frameWidth, frameHeight, <span class="optional">frameMax</span>, <span class="optional">margin</span>, <span class="optional">spacing</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Add a new sprite sheet to the loader.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<th>Argument</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<th>Default</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<td class="attributes">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
</td>
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>Unique asset key of the sheet file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<td class="attributes">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
</td>
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>URL of the sheet file.</p></td>
</tr>
<tr>
<td class="name"><code>frameWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<td class="attributes">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
</td>
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>Width of each single frame.</p></td>
</tr>
<tr>
<td class="name"><code>frameHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<td class="attributes">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>Height of each single frame.</p></td>
</tr>
<tr>
<td class="name"><code>frameMax</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<td class="attributes">
&lt;optional><br>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
</td>
<td class="default">
-1
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Tidying up the repo and adding in new documentation.
2013-10-23 13:00:28 +00:00
<td class="description last"><p>How many frames in this sprite sheet. If not specified it will divide the whole image into frames.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
Updated doc files.
2014-02-05 06:29:17 +00:00
<tr>
<td class="name"><code>margin</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If the frames have been drawn with a margin, specify the amount here.</p></td>
</tr>
<tr>
<td class="name"><code>spacing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If the frames have been drawn with spacing between them, specify the amount here.</p></td>
</tr>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
-
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-590">line 590</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="start"><span class="type-signature"></span>start<span class="signature">()</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Start loading the assets. Normally you don't need to call this yourself as the StateManager will do so.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-971">line 971</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="text"><span class="type-signature"></span>text<span class="signature">(key, url, <span class="optional">overwrite</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Add a text file to the Loader.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Updated documentation.
2013-11-28 15:57:09 +00:00
<th>Argument</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<th>Default</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>Unique asset key of the text file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>URL of the text file.</p></td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="default">
false
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-467">line 467</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="tilemap"><span class="type-signature"></span>tilemap<span class="signature">(key, <span class="optional">url</span>, <span class="optional">data</span>, <span class="optional">format</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Add a new tilemap loading request.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Updated documentation.
2013-11-28 15:57:09 +00:00
<th>Argument</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<th>Default</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<th class="last">Description</th>
</tr>
</thead>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<tbody>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<tr>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>key</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>Unique asset key of the tilemap data.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
Republished docs.
2014-07-10 19:31:11 +00:00
<td class="name"><code>url</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="description last"><p>The url of the map data file (csv/json)</p></td>
</tr>
<tr>
Republished docs.
2014-07-10 19:31:11 +00:00
<td class="name"><code>data</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
<td class="description last"><p>An optional JSON data object. If given then the url is ignored and this JSON object is used for map data instead.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>format</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">number</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="default">
Phaser.Tilemap.CSV
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The format of the map data. Either Phaser.Tilemap.CSV or Phaser.Tilemap.TILED_JSON.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-654">line 654</a>
</dt>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="totalLoadedFiles"><span class="type-signature"></span>totalLoadedFiles<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<div class="description">
<p>Returns the number of files that have already been loaded, even if they errored.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The number of files that have already been loaded (even if they errored)</p>
</div>
</div>
Updated documentation.
2013-11-28 15:57:09 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1792">line 1792</a>
</dt>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="totalLoadedPacks"><span class="type-signature"></span>totalLoadedPacks<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
Republished docs.
2014-07-10 19:31:11 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
<div class="description">
<p>Returns the number of asset packs that have already been loaded, even if they errored.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The number of asset packs that have already been loaded (even if they errored)</p>
</div>
</div>
Republished docs.
2014-07-10 19:31:11 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1836">line 1836</a>
</dt>
Republished docs.
2014-07-10 19:31:11 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="totalQueuedFiles"><span class="type-signature"></span>totalQueuedFiles<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
Updated documentation.
2013-11-28 15:57:09 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated documentation.
2013-11-28 15:57:09 +00:00
<div class="description">
Republished docs.
2014-07-10 19:31:11 +00:00
<p>Returns the number of files still waiting to be processed in the load queue. This value decreases as each file in the queue is loaded.</p>
Updated documentation.
2013-11-28 15:57:09 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The number of files that still remain in the load queue.</p>
</div>
</div>
Updated documentation.
2013-11-28 15:57:09 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1814">line 1814</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="totalQueuedPacks"><span class="type-signature"></span>totalQueuedPacks<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
Republished docs.
2014-07-10 19:31:11 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
<div class="description">
<p>Returns the number of asset packs still waiting to be processed in the load queue. This value decreases as each pack in the queue is loaded.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The number of asset packs that still remain in the load queue.</p>
</div>
</div>
Republished docs.
2014-07-10 19:31:11 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1858">line 1858</a>
</dt>
Republished docs.
2014-07-10 19:31:11 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
Updated readme and docs.
2014-10-09 15:12:53 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="xml"><span class="type-signature"></span>xml<span class="signature">(key, url, <span class="optional">overwrite</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<div class="description">
<p>Add an XML file to the Loader.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Unique asset key of the xml file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the xml file.</p></td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-519">line 519</a>
</dt>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Updated readme and docs.
2014-10-09 15:12:53 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="xmlLoadComplete"><span class="type-signature"></span>xmlLoadComplete<span class="signature">(index)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<div class="description">
<p>Successfully loaded an XML file.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="name"><code>index</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated documentation.
2013-11-28 15:57:09 +00:00
<span class="param-type">number</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated documentation.
2013-11-28 15:57:09 +00:00
<td class="description last"><p>The index of the file in the file queue that loaded.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1680">line 1680</a>
</dt>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Updated doc files.
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
on Tue Nov 25 2014 00:17:38 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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 );
},
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +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>
</html>
Reference in a new issue Copy permalink