Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-22 20:53:39 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated readme and docs.

Browse source
This commit is contained in:
photonstorm 2014-10-09 16:12:53 +01:00
parent 1661cdddb9
commit 9f24c08216
238 changed files with 17472 additions and 11904 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
CHANGELOG.md
View file

@ -1,5 +1,61 @@
# Change Log
## Version 2.1.2 - "Whitebridge" - 9th October 2014
### New Features
* StateManager.unlink will null all State-level Phaser properties, such as `game`, `add`, etc. Useful if you never need to return to the State again.
* Cache.removeImage has a new parameter: `removeFromPixi` which is `true` by default. It will remove the image from the Pixi BaseTextureCache as well as from the Phaser Cache. Set to false if you don't want the Pixi cache touched.
* Group.ignoreDestroy boolean will bail out early from any call to `Group.destroy`. Handy if you need to create a global Group that persists across States.
* Loader can now natively load XML files via `load.xml`. Once the XML file has loaded it is parsed via either DOMParser or ActiveXObject and then added to the Cache, where it can be retrieved via `cache.getXML(key)`.
* Cache now has support for XML files stored in their own container. You can add them with `cache.addXML` (typically this is done from the Loader automatically for you) and get them with `cache.getXML(key)`. There is also `cache.checkXMLKey(key)`, `cache.checkKeys` and `cache.removeXML(key)`.
* Rectangle.aabb is a new method that will take an array of Points and return a Rectangle that matches the AABB (bounding area) of the Points (thanks @codevinsky #1199)
* AudioSprite support is now built into the Loader and SoundManager. AudioSprites are like sprite sheets, only they consist of a selection of audio files and markers in a json configuration. You can find more details at https://github.com/tonistiigi/audiosprite (thanks @codevinsky #1205)
* Point.parse will return a new Point object based on the x and y properties of the object given to Point.parse (thanks @codevinsky #1198)
* Sound.fadeOut(duration) will fade the Sound to a volume of zero over the duration given. At the end of the fade the Sound will be stopped and Sound.onFadeComplete dispatched.
* Sound.fadeIn(duration, loop) will start the Sound playing, or restart it if already playing, set its volume to zero and then increase the volume over the duration given until it reaches 1. At the end of the fade the Sound.onFadeComplete event is dispatched.
* Text.addColor allows you to set specific colors within the Text. It works by taking a color value, which is a typical HTML string such as `#ff0000` or `rgb(255,0,0)` and a position. The position value is the index of the character in the Text string to start applying this color to. Once set the color remains in use until either another color or the end of the string is encountered. For example if the Text was `Photon Storm` and you did `Text.addColor('#ffff00', 6)` it would color in the word `Storm` in yellow.
* Text.clearColors resets any previously set colors from `Text.addColor`.
* If you pass a tinted Sprite to `BitmapData.draw` or `BitmapData.copy` it will now draw the tinted version of the Sprite to the BitmapData and not the original texture.
* BitmapData.shadow(color, blur, x, y) provides a quick way to set all the relevant shadow settings, which are then be used in future draw calls.
* Cache.addBitmapData has a new parameter: `frameData` allowing you to pass a `Phaser.FrameData` object along with the BitmapData.
* Cache.getFrameData has a new parameter: `map` which allows you to specify which cache to get the FrameData from, i.e. `Phaser.Cache.IMAGE` or `Phaser.Cache.BITMAPDATA`.
* Sprite.loadTexture if given a BitmapData as the texture will now query the cache to see if it has any associated FrameData, and if so it will load that into the AnimationManager.
* BitmapData.textureLine takes a Phaser.Line object and an image in the image cache. It then accurately draws the image as a repeating texture for the full length of the line.
* AnimationManager.name will now return the `name` property of the currently playing animation, if any.
* Group.filter takes a predicate function and passes child, index, and the entire child array to it. It then returns an ArrayList containing all children that the predicate returns true for (thanks @codevinsky #1187)
* Cache.checkUrl allows you to check if a resource is in the cache based on an absolute URL (thanks @englercj #1221)
* Cache.getUrl gets a resource from the cache based on the absolute URL it was loaded from (thanks @englercj #1221)
* Sound.allowMultiple allows you to have multiple instances of a single Sound playing at once. This is only useful when running under Web Audio, and we recommend you implement a local pooling system to not flood the sound channels. But it allows for one Sound object to play overlapping times, useful for gun effects and similar (#1220)
### Updates
* TypeScript definitions fixes and updates (thanks @clark-stevenson @englercj @benjamindulau)
* Added the `sourceRect` and `maskRect` parameters back into `BitmapData.alphaMask` as they were accidentally removed in 2.1 (thanks seejay92)
* jsdoc fixes (thanks @danxexe #1209)
* AnimationParser is now using `value` instead of `nodeValue` when parsing atlas XML files, avoiding Chrome deprecation warnings (thanks @valtterip #1189)
* Color.webToColor restored. Converts a CSS rgba color into a native color value.
* Color.createColor now populates the `color` property of the returned object with the results of `Phaser.Color.getColor`.
* Color.createColor now has a `color32` property with the results of `Phaser.Color.getColor32`.
* Color.hexToColor has been optimised to inline the regex and has moved the createColor call so it now populates the color object fully, not just setting the r,g,b properties.
* Keyboard.PLUS and Keyboard.MINUS have been added to the list of key codes (thanks @VictorBjelkholm #1281)
### Bug Fixes
* If Game Objects change their frame, such as with an animated Sprite, and the change goes from a previously trimmed frame to a non-trimmed (full size) one, then the previous trim values were still left active, causing it to glitch (thanks stupot)
* If you called StateManager.start from within a states `init` method which also had a `preload` method it would fail to start the next State.
* StateManager.boot would call start on a State twice if it was added to the game and started before the DOM load had completed. This didn't cause an error but was duplicating function calls needlessly.
* Changing any of the Text properties such as font, lineSpacing and fontSize on a Text object that wasn't already on the display list would cause an updateTransform error. Parent is now checked first in all setters.
* A Timer with a delay value that was a float and not an integer would not loop correctly. Timer delay values are now passed through Math.round to avoid this (thanks @osmanzeki #1196)
* The Loader would incorrectly call `fileComplete` for legacy audio files instead of setting it as a callback, throwing up errors if the audio file failed to load (thanks @spayton #1212)
* The Uint32Array check used in Utils was incorrectly replacing Uint32Array on Safari, causing errors like BitmapData.getPixel32 to fail and other related issues (fixes #1043 and #1197)
* Camera.follow would break if the parent of the Sprite being followed was scaled in any way (thanks @englercj #1222)
* Fixed the 4fv uniform in the Pixelate filter.
## Version 2.1.1 - "Eianrod" - 11th September 2014
Version 2.1.1. of Phaser is an emergency point release. It addresses a potential race condition that could happen in States that tried to change state from the create method but had an empty preloader or pre-cached assets.
## Version 2.1.0 - "Cairhien" - 9th September 2014
### New Features

23
README.md
View file

@ -25,7 +25,7 @@
Phaser is a fast, free and fun open source game framework for making desktop and mobile browser HTML5 games. It uses [Pixi.js](https://github.com/GoodBoyDigital/pixi.js/) internally for fast 2D Canvas and WebGL rendering.
Version: 2.1.2 "Whitebridge" - Released: in development
Version: 2.1.2 "Whitebridge" - Released: 9th October 2014
By Richard Davey, [Photon Storm](http://www.photonstorm.com)
@ -45,6 +45,22 @@ By Richard Davey, [Photon Storm](http://www.photonstorm.com)
<a name="whats-new"></a>
## Welcome to Phaser and What's new in 2.1.2?
Phaser 2.1.2 carries on with our latest round of new features, updates and fixes, demonstrating our commitment to continuously improving our framework and responding to feedback.
This release adds in a number of new features including Audio Sprite json format support, native loading of XML files, Sound fades, per character Text colours, further updates to BitmapData, the ability to use BitmapData with frames as Sprite textures, Group filter, search the Cache by URL and plenty of updates and bug fixes too - including the death of the pesky getPixel issue on Safari / iOS.
Internally we are using Phaser in ever larger client based projects. Thousands of lines of code spread across many States and classes, and we're paying close attention to how best to adapt the API to make life easier for those building apps of the size we are. If there are any features you would like to see then now is the time to suggest them, either by email, the forum or github.
We're also pleased to announce that we have 3 new premium plugins gearing up for launch. They are:
Phaser Box2D - Adds complete Box2D support directly into Phaser, with lots of help methods, over 50 examples and 5 demo games.
Phaser Path Manager - Create complex motion paths for Sprites with a lovely visual editor and this new plugin. No longer rely on tweens for motion :) Instead draw a path, with full branch support, path orientation, segment speeds, path events and more.
Advanced Particle System - The particles included with Phaser are flexible and can create attractive effects. But Advanced Particles is a complete replacement offering professional level particle effects for your games. From multiple render targets, to bitmap caching to all kinds of events, emitters and properties.
Each plugin will come in a range of versions to suit all budgets and there are more on the way. Please visit the [launch page](http://phaserplugins.launchrock.com) to sign-up for notification as soon as they're ready.
Until then happy coding everyone! And we hope to see you on the forums.
![boogie](http://www.phaser.io/images/spacedancer.gif)
@ -69,9 +85,7 @@ Finally the list of [community authored Phaser Tutorials](http://www.lessmilk.co
<a name="change-log"></a>
## Change Log
Version 2.1.2 - "Whitebridge" - in development
Version 2.1.2 - "Whitebridge" - October 9th 2014
### New Features
@ -123,7 +137,6 @@ Version 2.1.2 - "Whitebridge" - in development
* Camera.follow would break if the parent of the Sprite being followed was scaled in any way (thanks @englercj #1222)
* Fixed the 4fv uniform in the Pixelate filter.
For details about changes made in previous versions of Phaser see the full Change Log at https://github.com/photonstorm/phaser/blob/master/CHANGELOG.md
![div](http://phaser.io/images/div3.png)

12
docs/AABB.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -518,7 +526,6 @@
</ul>
</li>
</ul>
</div>
</div>
@ -548,7 +555,6 @@
* Note: This class could be massively optimised and reduced in size. I leave that challenge up to you.
*
* @class Phaser.Physics.Ninja.AABB
* @classdesc Arcade Physics Constructor
* @constructor
* @param {Phaser.Physics.Ninja.Body} body - The body that owns this shape.
* @param {number} x - The x coordinate to create this shape at.
@ -1590,7 +1596,7 @@ Phaser.Physics.Ninja.AABB.prototype = {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

13
docs/Animation.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -552,7 +560,7 @@
* @param {Phaser.Sprite} parent - A reference to the owner of this Animation.
* @param {string} name - The unique name for this animation, used in playback commands.
* @param {Phaser.FrameData} frameData - The FrameData object that contains all frames used by this Animation.
* @param {(Array.&lt;number>|Array.&lt;string>)} frames - An array of numbers or strings indicating which frames to play in which order.
* @param {number[]|string[]} frames - An array of numbers or strings indicating which frames to play in which order.
* @param {number} delay - The time between each frame of the animation, given in ms.
* @param {boolean} loop - Should this animation loop when it reaches the end or play through once.
*/
@ -1270,6 +1278,7 @@ Object.defineProperty(Phaser.Animation.prototype, 'enableUpdate', {
* You could use this function to generate those by doing: Phaser.Animation.generateFrameNames('explosion_', 1, 30, '-large', 4);
*
* @method Phaser.Animation.generateFrameNames
* @static
* @param {string} prefix - The start of the filename. If the filename was 'explosion_0001-large' the prefix would be 'explosion_'.
* @param {number} start - The number to start sequentially counting from. If your frames are named 'explosion_0001' to 'explosion_0034' the start is 1.
* @param {number} stop - The number to count to. If your frames are named 'explosion_0001' to 'explosion_0034' the stop value is 34.
@ -1347,7 +1356,7 @@ Phaser.Animation.generateFrameNames = function (prefix, start, stop, suffix, zer
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

32
docs/AnimationManager.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -621,6 +629,11 @@ Phaser.AnimationManager.prototype = {
*/
loadFrameData: function (frameData, frame) {
if (typeof frameData === 'undefined')
{
return false;
}
if (this.isLoaded)
{
// We need to update the frameData that the animations are using
@ -1035,6 +1048,23 @@ Object.defineProperty(Phaser.AnimationManager.prototype, 'paused', {
});
/**
* @name Phaser.AnimationManager#name
* @property {string} name - Gets the current animation name, if set.
*/
Object.defineProperty(Phaser.AnimationManager.prototype, 'name', {
get: function () {
if (this.currentAnim)
{
return this.currentAnim.name;
}
}
});
/**
* @name Phaser.AnimationManager#frame
* @property {number} frame - Gets or sets the current frame index and updates the Texture Cache for display.
@ -1136,7 +1166,7 @@ Object.defineProperty(Phaser.AnimationManager.prototype, 'frameName', {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

30
docs/AnimationParser.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -806,22 +814,22 @@ Phaser.AnimationParser = {
uuid = game.rnd.uuid();
frame = frames[i].attributes;
name = frame.name.nodeValue;
x = parseInt(frame.x.nodeValue, 10);
y = parseInt(frame.y.nodeValue, 10);
width = parseInt(frame.width.nodeValue, 10);
height = parseInt(frame.height.nodeValue, 10);
name = frame.name.value;
x = parseInt(frame.x.value, 10);
y = parseInt(frame.y.value, 10);
width = parseInt(frame.width.value, 10);
height = parseInt(frame.height.value, 10);
frameX = null;
frameY = null;
if (frame.frameX)
{
frameX = Math.abs(parseInt(frame.frameX.nodeValue, 10));
frameY = Math.abs(parseInt(frame.frameY.nodeValue, 10));
frameWidth = parseInt(frame.frameWidth.nodeValue, 10);
frameHeight = parseInt(frame.frameHeight.nodeValue, 10);
frameX = Math.abs(parseInt(frame.frameX.value, 10));
frameY = Math.abs(parseInt(frame.frameY.value, 10));
frameWidth = parseInt(frame.frameWidth.value, 10);
frameHeight = parseInt(frame.frameHeight.value, 10);
}
newFrame = data.addFrame(new Phaser.Frame(i, x, y, width, height, name, uuid));
@ -865,7 +873,7 @@ Phaser.AnimationParser = {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

622
docs/ArcadeParticles.js.html Normal file
View file

@ -0,0 +1,622 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Source: particles/arcade/ArcadeParticles.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Button.html">Button</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Events.html">Events</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Filter.html">Filter</a>
</li>
<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>
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Line.html">Line</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Physics.html">Physics</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tile.html">Tile</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Timer.html">Timer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
<li class="class-depth-1">
<a href="Phaser.World.html">World</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: particles/arcade/ArcadeParticles.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* @author Richard Davey &lt;rich@photonstorm.com>
* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* Arcade Particles is a Particle System integrated with Arcade Physics.
*
* @class Phaser.Particles.Arcade
*/
Phaser.Particles.Arcade = {};</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2014 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</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( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>

10
docs/ArrayList.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -767,7 +775,7 @@ Phaser.ArrayList.prototype.constructor = Phaser.ArrayList;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

748
docs/AudioSprite.js.html Normal file
View file

@ -0,0 +1,748 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Source: sound/AudioSprite.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Button.html">Button</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Events.html">Events</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Filter.html">Filter</a>
</li>
<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>
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Line.html">Line</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Physics.html">Physics</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tile.html">Tile</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Timer.html">Timer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
<li class="class-depth-1">
<a href="Phaser.World.html">World</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: sound/AudioSprite.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* @author Jeremy Dowell &lt;jeremy@codevinsky.com>
* @author Richard Davey &lt;rich@photonstorm.com>
* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* Audio Sprites are a combination of audio files and a JSON configuration.
* The JSON follows the format of that created by https://github.com/tonistiigi/audiosprite
*
* @class Phaser.AudioSprite
* @constructor
* @param {Phaser.Game} game - Reference to the current game instance.
* @param {string} key - Asset key for the sound.
*/
Phaser.AudioSprite = function (game, key) {
/**
* A reference to the currently running Game.
* @property {Phaser.Game} game
*/
this.game = game;
/**
* Asset key for the Audio Sprite.
* @property {string} key
*/
this.key = key;
/**
* JSON audio atlas object.
* @property {object} config
*/
this.config = this.game.cache.getJSON(key + '-audioatlas');
/**
* If a sound is set to auto play, this holds the marker key of it.
* @property {string} autoplayKey
*/
this.autoplayKey = null;
/**
* Is a sound set to autoplay or not?
* @property {boolean} autoplay
* @default
*/
this.autoplay = false;
/**
* An object containing the Phaser.Sound objects for the Audio Sprite.
* @property {object} sounds
*/
this.sounds = {};
for (var k in this.config.spritemap)
{
var marker = this.config.spritemap[k];
var sound = this.game.add.sound(this.key);
if (marker.loop)
{
sound.addMarker(k, marker.start, (marker.end - marker.start), null, true);
}
else
{
sound.addMarker(k, marker.start, (marker.end - marker.start), null, false);
}
this.sounds[k] = sound;
}
if (this.config.autoplay)
{
this.autoplayKey = this.config.autoplay;
this.play(this.autoplayKey);
this.autoplay = this.sounds[this.autoplayKey];
}
};
Phaser.AudioSprite.prototype = {
/**
* Play a sound with the given name.
*
* @method Phaser.AudioSprite#play
* @param {string} [marker] - The name of sound to play
* @param {number} [volume=1] - Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified).
* @return {Phaser.Sound} This sound instance.
*/
play: function (marker, volume) {
if (typeof volume === 'undefined') { volume = 1; }
return this.sounds[marker].play(marker, null, volume);
},
/**
* Stop a sound with the given name.
*
* @method Phaser.AudioSprite#stop
* @param {string} [marker=''] - The name of sound to stop. If none is given it will stop all sounds in the audio sprite.
*/
stop: function (marker) {
if (!marker)
{
for (var key in this.sounds)
{
this.sounds[key].stop();
}
}
else
{
this.sounds[marker].stop();
}
},
/**
* Get a sound with the given name.
*
* @method Phaser.AudioSprite#get
* @param {string} marker - The name of sound to get.
* @return {Phaser.Sound} The sound instance.
*/
get: function(marker) {
return this.sounds[marker];
}
};
Phaser.AudioSprite.prototype.constructor = Phaser.AudioSprite;
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2014 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</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( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>

135
docs/BitmapData.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,13 +551,11 @@
*/
/**
* Creates a new BitmapData object.
* A BitmapData object contains a Canvas element to which you can draw anything you like via normal Canvas context operations.
* A single BitmapData can be used as the texture for one or many Images/Sprites.
* So if you need to dynamically create a Sprite texture then they are a good choice.
*
* @class Phaser.BitmapData
*
* @classdesc A BitmapData object contains a Canvas element to which you can draw anything you like via normal Canvas context operations.
* A single BitmapData can be used as the texture for one or many Images/Sprites. So if you need to dynamically create a Sprite texture then they are a good choice.
*
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
* @param {string} key - Internal Phaser reference key for the render texture.
@ -733,6 +739,12 @@ Phaser.BitmapData = function (game, key, width, height) {
*/
this._tempB = 0;
/**
* @property {Phaser.Circle} _circle - Internal cache var.
* @private
*/
this._circle = new Phaser.Circle();
};
Phaser.BitmapData.prototype = {
@ -1429,6 +1441,17 @@ Phaser.BitmapData.prototype = {
tx += source.texture.trim.x - source.anchor.x * source.texture.trim.width;
ty += source.texture.trim.y - source.anchor.y * source.texture.trim.height;
}
if (source.tint !== 0xFFFFFF)
{
if (source.cachedTint !== source.tint)
{
source.cachedTint = source.tint;
source.tintedTexture = PIXI.CanvasTinter.getTintedTexture(source, source.tint);
}
this._image = source.tintedTexture;
}
}
else
{
@ -1600,17 +1623,65 @@ Phaser.BitmapData.prototype = {
},
/**
* Sets the shadow properties of this BitmapDatas context which will affect all draw operations made to it.
* You can cancel an existing shadow by calling this method and passing no parameters.
* Note: At the time of writing (October 2014) Chrome still doesn't support shadowBlur used with drawImage.
*
* @method Phaser.BitmapData#shadow
* @param {string} color - The color of the shadow, given in a CSS format, i.e. `#000000` or `rgba(0,0,0,1)`. If `null` or `undefined` the shadow will be reset.
* @param {number} [blur=5] - The amount the shadow will be blurred by. Low values = a crisp shadow, high values = a softer shadow.
* @param {number} [x=10] - The horizontal offset of the shadow in pixels.
* @param {number} [y=10] - The vertical offset of the shadow in pixels.
* @return {Phaser.BitmapData} This BitmapData object for method chaining.
*/
shadow: function (color, blur, x, y) {
if (typeof color === 'undefined' || color === null)
{
this.context.shadowColor = 'rgba(0,0,0,0)';
}
else
{
this.context.shadowColor = color;
this.context.shadowBlur = blur || 5;
this.context.shadowOffsetX = x || 10;
this.context.shadowOffsetY = y || 10;
}
},
/**
* Draws the image onto this BitmapData using an image as an alpha mask.
*
* @method Phaser.BitmapData#alphaMask
* @param {Phaser.Sprite|Phaser.Image|Phaser.Text|Phaser.BitmapData|HTMLImage|HTMLCanvasElement|string} source - The source to copy from. If you give a string it will try and find the Image in the Game.Cache first. This is quite expensive so try to provide the image itself.
* @param {Phaser.Sprite|Phaser.Image|Phaser.Text|Phaser.BitmapData|HTMLImage|HTMLCanvasElement|string} [mask] - The object to be used as the mask. If you give a string it will try and find the Image in the Game.Cache first. This is quite expensive so try to provide the image itself. If you don't provide a mask it will use this BitmapData as the mask.
* @param {Phaser.Rectangle} [sourceRect] - A Rectangle where x/y define the coordinates to draw the Source image to and width/height define the size.
* @param {Phaser.Rectangle} [maskRect] - A Rectangle where x/y define the coordinates to draw the Mask image to and width/height define the size.
* @return {Phaser.BitmapData} This BitmapData object for method chaining.
*/
alphaMask: function (source, mask) {
alphaMask: function (source, mask, sourceRect, maskRect) {
return this.draw(mask).blendSourceAtop().draw(source).blendReset();
if (typeof maskRect === 'undefined' || maskRect === null)
{
this.draw(mask).blendSourceAtop();
}
else
{
this.draw(mask, maskRect.x, maskRect.y, maskRect.width, maskRect.height).blendSourceAtop();
}
if (typeof sourceRect === 'undefined' || sourceRect === null)
{
this.draw(source).blendReset();
}
else
{
this.draw(source, sourceRect.x, sourceRect.y, sourceRect.width, sourceRect.height).blendReset();
}
return this;
},
@ -1718,6 +1789,54 @@ Phaser.BitmapData.prototype = {
},
/**
* Takes the given Line object and image and renders it to this BitmapData as a repeating texture line.
*
* @method Phaser.BitmapData#textureLine
* @param {Phaser.Line} line - A Phaser.Line object that will be used to plot the start and end of the line.
* @param {string|HTMLImage} image - The key of an image in the Phaser.Cache to use as the texture for this line, or an actual Image.
* @param {string} [repeat='repeat-x'] - The pattern repeat mode to use when drawing the line. Either `repeat`, `repeat-x` or `no-repeat`.
* @return {Phaser.BitmapData} This BitmapData object for method chaining.
*/
textureLine: function (line, image, repeat) {
if (typeof repeat === 'undefined') { repeat = 'repeat-x'; }
if (typeof image === 'string')
{
image = this.game.cache.getImage(image);
if (!image)
{
return;
}
}
var width = line.length;
if (repeat === 'no-repeat' && width > image.width)
{
width = image.width;
}
this.context.fillStyle = this.context.createPattern(image, repeat);
this._circle = new Phaser.Circle(line.start.x, line.start.y, image.height);
this._circle.circumferencePoint(line.angle - 1.5707963267948966, false, this._pos);
this.context.save();
this.context.translate(this._pos.x, this._pos.y);
this.context.rotate(line.angle);
this.context.fillRect(0, 0, width, image.height);
this.context.restore();
this.dirty = true;
return this;
},
/**
* If the game is running in WebGL this will push the texture up to the GPU if it's dirty.
* This is called automatically if the BitmapData is being used by a Sprite, otherwise you need to remember to call it in your render function.
@ -2148,7 +2267,7 @@ Phaser.BitmapData.prototype.constructor = Phaser.BitmapData;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

18
docs/BitmapText.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,17 +551,15 @@
*/
/**
* Creates a new BitmapText object.
*
* @class Phaser.BitmapText
*
* @classdesc BitmapText objects work by taking a texture file and an XML file that describes the font layout.
* BitmapText objects work by taking a texture file and an XML file that describes the font layout.
*
* On Windows you can use the free app BMFont: http://www.angelcode.com/products/bmfont/
* On OS X we recommend Glyph Designer: http://www.71squared.com/en/glyphdesigner
* For Web there is the great Littera: http://kvazars.com/littera/
*
* @class Phaser.BitmapText
* @constructor
* @extends PIXI.BitmapText
* @param {Phaser.Game} game - A reference to the currently running game.
* @param {number} x - X position of the new bitmapText object.
* @param {number} y - Y position of the new bitmapText object.
@ -1042,7 +1048,7 @@ Object.defineProperty(Phaser.BitmapText.prototype, "destroyPhase", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/Body.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -547,7 +555,6 @@
* the Sprite itself. For example you can set the velocity, acceleration, bounce values etc all on the Body.
*
* @class Phaser.Physics.Arcade.Body
* @classdesc Arcade Physics Body Constructor
* @constructor
* @param {Phaser.Sprite} sprite - The Sprite object this physics body belongs to.
*/
@ -1388,7 +1395,7 @@ Phaser.Physics.Arcade.Body.prototype.constructor = Phaser.Physics.Arcade.Body;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/Body.js_.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -547,7 +555,6 @@
* the Sprite itself. For example you can set the velocity, bounce values etc all on the Body.
*
* @class Phaser.Physics.Ninja.Body
* @classdesc Ninja Physics Body Constructor
* @constructor
* @param {Phaser.Physics.Ninja} system - The physics system this Body belongs to.
* @param {Phaser.Sprite} sprite - The Sprite object this physics body belongs to.
@ -1127,7 +1134,7 @@ Phaser.Physics.Ninja.Body.render = function(context, body, color, filled) {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/Body.js__.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -551,7 +559,6 @@
* Note: When a game object is given a P2 body it has its anchor x/y set to 0.5, so it becomes centered.
*
* @class Phaser.Physics.P2.Body
* @classdesc Physics Body Constructor
* @constructor
* @param {Phaser.Game} game - Game reference to the currently running game.
* @param {Phaser.Sprite} [sprite] - The Sprite object this physics body belongs to.
@ -2333,7 +2340,7 @@ Object.defineProperty(Phaser.Physics.P2.Body.prototype, "collideWorldBounds", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/BodyDebug.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -549,7 +557,6 @@
* So use sparingly and rarely (if ever) in production code.
*
* @class Phaser.Physics.P2.BodyDebug
* @classdesc Physics Body Debug Constructor
* @constructor
* @extends Phaser.Group
* @param {Phaser.Game} game - Game reference to the currently running game.
@ -984,7 +991,7 @@ Phaser.Utils.extend(Phaser.Physics.P2.BodyDebug.prototype, {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

16
docs/Button.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,9 +551,7 @@
*/
/**
* @class Phaser.Button
*
* @classdesc Create a new `Button` object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically. The four states a Button responds to are:
* Create a new `Button` object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically. The four states a Button responds to are:
*
* * 'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'.
* * 'Out' - when the Pointer that was previously over the Button moves out of it.
@ -554,9 +560,9 @@
*
* You can set a unique texture frame and Sound for any of these states.
*
* @class Phaser.Button
* @constructor
* @extends Phaser.Image
*
* @param {Phaser.Game} game Current game instance.
* @param {number} [x=0] - X position of the Button.
* @param {number} [y=0] - Y position of the Button.
@ -1206,7 +1212,7 @@ Phaser.Button.prototype.setState = function (newState) {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

251
docs/Cache.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,10 +551,10 @@
*/
/**
* Phaser.Cache constructor.
* A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds
* and data files as a result of Loader calls. Cached items use string based keys for look-up.
*
* @class Phaser.Cache
* @classdesc A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds and data files as a result of Loader calls. Cached items use string based keys for look-up.
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
*/
@ -558,7 +566,7 @@ Phaser.Cache = function (game) {
this.game = game;
/**
* @property {object} game - Canvas key-value container.
* @property {object} _canvases - Canvas key-value container.
* @private
*/
this._canvases = {};
@ -588,11 +596,17 @@ Phaser.Cache = function (game) {
this._text = {};
/**
* @property {object} _text - Text key-value container.
* @property {object} _json - JSOIN key-value container.
* @private
*/
this._json = {};
/**
* @property {object} _xml - XML key-value container.
* @private
*/
this._xml = {};
/**
* @property {object} _physics - Physics data key-value container.
* @private
@ -623,6 +637,24 @@ Phaser.Cache = function (game) {
*/
this._bitmapFont = {};
/**
* @property {object} _urlMap - Maps URLs to resources.
* @private
*/
this._urlMap = {};
/**
* @property {Image} _urlResolver - Used to resolve URLs to the absolute path.
* @private
*/
this._urlResolver = new Image();
/**
* @property {string} _urlTemp - Temporary variable to hold a resolved url.
* @private
*/
this._urlTemp = null;
this.addDefaultImage();
this.addMissingImage();
@ -647,6 +679,7 @@ Phaser.Cache = function (game) {
this._cacheMap[Phaser.Cache.BITMAPDATA] = this._bitmapDatas;
this._cacheMap[Phaser.Cache.BITMAPFONT] = this._bitmapFont;
this._cacheMap[Phaser.Cache.JSON] = this._json;
this._cacheMap[Phaser.Cache.XML] = this._xml;
};
@ -716,6 +749,12 @@ Phaser.Cache.BITMAPFONT = 10;
*/
Phaser.Cache.JSON = 11;
/**
* @constant
* @type {number}
*/
Phaser.Cache.XML = 12;
Phaser.Cache.prototype = {
/**
@ -751,11 +790,14 @@ Phaser.Cache.prototype = {
* @method Phaser.Cache#addBitmapData
* @param {string} key - Asset key for this BitmapData.
* @param {Phaser.BitmapData} bitmapData - The BitmapData object to be addded to the cache.
* @param {Phaser.FrameData} [frameData] - Optional FrameData set associated with the given BitmapData.
* @return {Phaser.BitmapData} The BitmapData object to be addded to the cache.
*/
addBitmapData: function (key, bitmapData) {
addBitmapData: function (key, bitmapData, frameData) {
this._bitmapDatas[key] = bitmapData;
bitmapData.key = key;
this._bitmapDatas[key] = { data: bitmapData, frameData: frameData };
return bitmapData;
@ -798,6 +840,8 @@ Phaser.Cache.prototype = {
this._images[key].frameData = Phaser.AnimationParser.spriteSheet(this.game, key, frameWidth, frameHeight, frameMax, margin, spacing);
this._urlMap[this._resolveUrl(url)] = this._images[key];
},
/**
@ -813,6 +857,8 @@ Phaser.Cache.prototype = {
this._tilemaps[key] = { url: url, data: mapData, format: format };
this._urlMap[this._resolveUrl(url)] = this._tilemaps[key];
},
/**
@ -845,6 +891,8 @@ Phaser.Cache.prototype = {
this._images[key].frameData = Phaser.AnimationParser.XMLData(this.game, atlasData, key);
}
this._urlMap[this._resolveUrl(url)] = this._images[key];
},
/**
@ -869,6 +917,8 @@ Phaser.Cache.prototype = {
this._bitmapFont[key] = PIXI.BitmapText.fonts[key];
this._urlMap[this._resolveUrl(url)] = this._bitmapFont[key];
},
/**
@ -884,6 +934,8 @@ Phaser.Cache.prototype = {
this._physics[key] = { url: url, data: JSONData, format: format };
this._urlMap[this._resolveUrl(url)] = this._physics[key];
},
/**
@ -940,20 +992,38 @@ Phaser.Cache.prototype = {
this._text[key] = { url: url, data: data };
this._urlMap[this._resolveUrl(url)] = this._text[key];
},
/**
* Add a new json object into the cache.
*
* @method Phaser.Cache#addJSON
* @param {string} key - Asset key for the text data.
* @param {string} url - URL of this text data file.
* @param {object} data - Extra text data.
* @param {string} key - Asset key for the json data.
* @param {string} url - URL of this json data file.
* @param {object} data - Extra json data.
*/
addJSON: function (key, url, data) {
this._json[key] = { url: url, data: data };
this._urlMap[this._resolveUrl(url)] = this._json[key];
},
/**
* Add a new xml object into the cache.
*
* @method Phaser.Cache#addXML
* @param {string} key - Asset key for the xml file.
* @param {string} url - URL of this xml file.
* @param {object} data - Extra text data.
*/
addXML: function (key, url, data) {
this._xml[key] = { url: url, data: data };
},
/**
@ -975,6 +1045,8 @@ Phaser.Cache.prototype = {
PIXI.BaseTextureCache[key] = new PIXI.BaseTexture(data);
PIXI.TextureCache[key] = new PIXI.Texture(PIXI.BaseTextureCache[key]);
this._urlMap[this._resolveUrl(url)] = this._images[key];
},
/**
@ -1001,6 +1073,8 @@ Phaser.Cache.prototype = {
this._sounds[key] = { url: url, data: data, isDecoding: false, decoded: decoded, webAudio: webAudio, audioTag: audioTag, locked: this.game.sound.touchLocked };
this._urlMap[this._resolveUrl(url)] = this._sounds[key];
},
/**
@ -1102,7 +1176,7 @@ Phaser.Cache.prototype = {
if (this._bitmapDatas[key])
{
return this._bitmapDatas[key];
return this._bitmapDatas[key].data;
}
else
{
@ -1175,7 +1249,7 @@ Phaser.Cache.prototype = {
}
}
// We did not find the requested fixture
console.warn('Phaser.Cache.getPhysicsData: Could not find given fixtureKey: "' + fixtureKey + ' in ' + key + '"');
}
@ -1217,7 +1291,7 @@ Phaser.Cache.prototype = {
* Checks if the given key exists in the Canvas Cache.
*
* @method Phaser.Cache#checkCanvasKey
* @param {string} key - Asset key of the image to check is in the Cache.
* @param {string} key - Asset key of the canvas to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkCanvasKey: function (key) {
@ -1256,7 +1330,7 @@ Phaser.Cache.prototype = {
* Checks if the given key exists in the Sound Cache.
*
* @method Phaser.Cache#checkSoundKey
* @param {string} key - Asset key of the image to check is in the Cache.
* @param {string} key - Asset key of the sound file to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkSoundKey: function (key) {
@ -1269,7 +1343,7 @@ Phaser.Cache.prototype = {
* Checks if the given key exists in the Text Cache.
*
* @method Phaser.Cache#checkTextKey
* @param {string} key - Asset key of the image to check is in the Cache.
* @param {string} key - Asset key of the text file to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkTextKey: function (key) {
@ -1282,7 +1356,7 @@ Phaser.Cache.prototype = {
* Checks if the given key exists in the Physics Cache.
*
* @method Phaser.Cache#checkPhysicsKey
* @param {string} key - Asset key of the image to check is in the Cache.
* @param {string} key - Asset key of the physics data file to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkPhysicsKey: function (key) {
@ -1295,7 +1369,7 @@ Phaser.Cache.prototype = {
* Checks if the given key exists in the Tilemap Cache.
*
* @method Phaser.Cache#checkTilemapKey
* @param {string} key - Asset key of the image to check is in the Cache.
* @param {string} key - Asset key of the Tilemap to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkTilemapKey: function (key) {
@ -1308,7 +1382,7 @@ Phaser.Cache.prototype = {
* Checks if the given key exists in the Binary Cache.
*
* @method Phaser.Cache#checkBinaryKey
* @param {string} key - Asset key of the image to check is in the Cache.
* @param {string} key - Asset key of the binary file to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkBinaryKey: function (key) {
@ -1321,7 +1395,7 @@ Phaser.Cache.prototype = {
* Checks if the given key exists in the BitmapData Cache.
*
* @method Phaser.Cache#checkBitmapDataKey
* @param {string} key - Asset key of the image to check is in the Cache.
* @param {string} key - Asset key of the BitmapData to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkBitmapDataKey: function (key) {
@ -1334,7 +1408,7 @@ Phaser.Cache.prototype = {
* Checks if the given key exists in the BitmapFont Cache.
*
* @method Phaser.Cache#checkBitmapFontKey
* @param {string} key - Asset key of the image to check is in the Cache.
* @param {string} key - Asset key of the BitmapFont to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkBitmapFontKey: function (key) {
@ -1347,7 +1421,7 @@ Phaser.Cache.prototype = {
* Checks if the given key exists in the JSON Cache.
*
* @method Phaser.Cache#checkJSONKey
* @param {string} key - Asset key of the image to check is in the Cache.
* @param {string} key - Asset key of the JSON file to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkJSONKey: function (key) {
@ -1356,6 +1430,37 @@ Phaser.Cache.prototype = {
},
/**
* Checks if the given key exists in the XML Cache.
*
* @method Phaser.Cache#checkXMLKey
* @param {string} key - Asset key of the XML file to check is in the Cache.
* @return {boolean} True if the key exists, otherwise false.
*/
checkXMLKey: function (key) {
return this.checkKey(Phaser.Cache.XML, key);
},
/**
* Checks if the given URL has been loaded into the Cache.
*
* @method Phaser.Cache#checkUrl
* @param {string} url - The url to check for in the cache.
* @return {boolean} True if the url exists, otherwise false.
*/
checkUrl: function (url) {
if (this._urlMap[this._resolveUrl(url)])
{
return true;
}
return false;
},
/**
* Get image data by key.
*
@ -1402,13 +1507,16 @@ Phaser.Cache.prototype = {
*
* @method Phaser.Cache#getFrameData
* @param {string} key - Asset key of the frame data to retrieve from the Cache.
* @param {string} [map=Phaser.Cache.IMAGE] - The asset map to get the frameData from, for example `Phaser.Cache.IMAGE`.
* @return {Phaser.FrameData} The frame data.
*/
getFrameData: function (key) {
getFrameData: function (key, map) {
if (this._images[key])
if (typeof map === 'undefined') { map = Phaser.Cache.IMAGE; }
if (this._cacheMap[map][key])
{
return this._images[key].frameData;
return this._cacheMap[map][key].frameData;
}
return null;
@ -1645,6 +1753,26 @@ Phaser.Cache.prototype = {
},
/**
* Get a XML object by key from the cache.
*
* @method Phaser.Cache#getXML
* @param {string} key - Asset key of the XML object to retrieve from the Cache.
* @return {object} The XML object.
*/
getXML: function (key) {
if (this._xml[key])
{
return this._xml[key].data;
}
else
{
console.warn('Phaser.Cache.getXML: Invalid key: "' + key + '"');
}
},
/**
* Get binary data by key.
*
@ -1665,6 +1793,26 @@ Phaser.Cache.prototype = {
},
/**
* Get a cached object by the URL.
*
* @method Phaser.Cache#getUrl
* @param {string} url - The url for the object loaded to get from the cache.
* @return {object} The cached object.
*/
getUrl: function (url) {
if (this._urlMap[this._resolveUrl(url)])
{
return this._urlMap[this._resolveUrl(url)];
}
else
{
console.warn('Phaser.Cache.getUrl: Invalid url: "' + url + '"');
}
},
/**
* Gets all keys used by the Cache for the given data type.
*
@ -1721,6 +1869,10 @@ Phaser.Cache.prototype = {
case Phaser.Cache.JSON:
array = this._json;
break;
case Phaser.Cache.XML:
array = this._xml;
break;
}
if (!array)
@ -1753,13 +1905,23 @@ Phaser.Cache.prototype = {
},
/**
* Removes an image from the cache.
* Removes an image from the cache and optionally from the Pixi.BaseTextureCache as well.
*
* @method Phaser.Cache#removeImage
* @param {string} key - Key of the asset you want to remove.
* @param {boolean} [removeFromPixi=true] - Should this image also be removed from the Pixi BaseTextureCache?
*/
removeImage: function (key) {
removeImage: function (key, removeFromPixi) {
if (typeof removeFromPixi === 'undefined') { removeFromPixi = true; }
delete this._images[key];
if (removeFromPixi)
{
PIXI.BaseTextureCache[key].destroy();
}
},
/**
@ -1792,6 +1954,16 @@ Phaser.Cache.prototype = {
delete this._json[key];
},
/**
* Removes a xml object from the cache.
*
* @method Phaser.Cache#removeXML
* @param {string} key - Key of the asset you want to remove.
*/
removeXML: function (key) {
delete this._xml[key];
},
/**
* Removes a physics data file from the cache.
*
@ -1842,6 +2014,24 @@ Phaser.Cache.prototype = {
delete this._bitmapFont[key];
},
/**
* Resolves a url its absolute form.
*
* @method Phaser.Cache#_resolveUrl
* @param {string} url - The url to resolve.
* @private
*/
_resolveUrl: function (url) {
this._urlResolver.src = this.game.load.baseUrl + url;
this._urlTemp = this._urlResolver.src;
// ensure no request is actually made
this._urlResolver.src = '';
return this._urlTemp;
},
/**
* Clears the cache. Removes every local cache object reference.
*
@ -1877,6 +2067,11 @@ Phaser.Cache.prototype = {
delete this._json[item];
}
for (var item in this._xml)
{
delete this._xml[item];
}
for (var item in this._textures)
{
delete this._textures[item];
@ -1907,6 +2102,10 @@ Phaser.Cache.prototype = {
delete this._bitmapFont[item];
}
this._urlMap = null;
this._urlResolver = null;
this._urlTemp = null;
}
};
@ -1933,7 +2132,7 @@ Phaser.Cache.prototype.constructor = Phaser.Cache;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

38
docs/Camera.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -647,6 +655,11 @@ Phaser.Camera = function (game, id, x, y, width, height) {
*/
this.scale = null;
/**
* @property {Phaser.Point} _targetPosition - Internal point used to calculate target position
*/
this._targetPosition = new Phaser.Point();
};
/**
@ -785,34 +798,41 @@ Phaser.Camera.prototype = {
*/
updateTarget: function () {
this._targetPosition
.copyFrom(this.target)
.multiply(
this.target.parent ? this.target.parent.worldTransform.a : 1,
this.target.parent ? this.target.parent.worldTransform.d : 1
);
if (this.deadzone)
{
this._edge = this.target.x - this.view.x;
this._edge = this._targetPosition.x - this.view.x;
if (this._edge &lt; this.deadzone.left)
{
this.view.x = this.target.x - this.deadzone.left;
this.view.x = this._targetPosition.x - this.deadzone.left;
}
else if (this._edge > this.deadzone.right)
{
this.view.x = this.target.x - this.deadzone.right;
this.view.x = this._targetPosition.x - this.deadzone.right;
}
this._edge = this.target.y - this.view.y;
this._edge = this._targetPosition.y - this.view.y;
if (this._edge &lt; this.deadzone.top)
{
this.view.y = this.target.y - this.deadzone.top;
this.view.y = this._targetPosition.y - this.deadzone.top;
}
else if (this._edge > this.deadzone.bottom)
{
this.view.y = this.target.y - this.deadzone.bottom;
this.view.y = this._targetPosition.y - this.deadzone.bottom;
}
}
else
{
this.view.x = this.target.x - this.view.halfWidth;
this.view.y = this.target.y - this.view.halfHeight;
this.view.x = this._targetPosition.x - this.view.halfWidth;
this.view.y = this._targetPosition.y - this.view.halfHeight;
}
},
@ -1042,7 +1062,7 @@ Object.defineProperty(Phaser.Camera.prototype, "height", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Canvas.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -872,7 +880,7 @@ Phaser.Canvas = {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

20
docs/Circle.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,14 +551,14 @@
*/
/**
* Creates a new Circle object with the center coordinate specified by the x and y parameters and the diameter specified by the diameter parameter. If you call this function without parameters, a circle with x, y, diameter and radius properties set to 0 is created.
* @class Circle
* @classdesc Phaser - Circle
* Creates a new Circle object with the center coordinate specified by the x and y parameters and the diameter specified by the diameter parameter.
* If you call this function without parameters, a circle with x, y, diameter and radius properties set to 0 is created.
*
* @class Phaser.Circle
* @constructor
* @param {number} [x=0] - The x coordinate of the center of the circle.
* @param {number} [y=0] - The y coordinate of the center of the circle.
* @param {number} [diameter=0] - The diameter of the circle.
* @return {Phaser.Circle} This circle object
*/
Phaser.Circle = function (x, y, diameter) {
@ -605,7 +613,7 @@ Phaser.Circle.prototype = {
* @method Phaser.Circle#setTo
* @param {number} x - The x coordinate of the center of the circle.
* @param {number} y - The y coordinate of the center of the circle.
* @param {number} diameter - The diameter of the circle in pixels.
* @param {number} diameter - The diameter of the circle.
* @return {Circle} This circle object.
*/
setTo: function (x, y, diameter) {
@ -1093,7 +1101,7 @@ PIXI.Circle = Phaser.Circle;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/Circle.js_.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -548,7 +556,6 @@
* Note: This class could be massively optimised and reduced in size. I leave that challenge up to you.
*
* @class Phaser.Physics.Ninja.Circle
* @classdesc Arcade Physics Constructor
* @constructor
* @param {Phaser.Physics.Ninja.Body} body - The body that owns this shape.
* @param {number} x - The x coordinate to create this shape at.
@ -3208,7 +3215,7 @@ Phaser.Physics.Ninja.Circle.prototype = {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

12
docs/CollisionGroup.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -546,8 +554,8 @@
* Collision Group
*
* @class Phaser.Physics.P2.CollisionGroup
* @classdesc Physics Collision Group Constructor
* @constructor
* @param {number} bitmask - The CollisionGroup bitmask.
*/
Phaser.Physics.P2.CollisionGroup = function (bitmask) {
@ -578,7 +586,7 @@ Phaser.Physics.P2.CollisionGroup = function (bitmask) {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

77
docs/Color.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -977,11 +985,12 @@ Phaser.Color = {
*/
createColor: function (r, g, b, a, h, s, l, v) {
var out = { r: r || 0, g: g || 0, b: b || 0, a: a || 1, h: h || 0, s: s || 0, l: l || 0, v: v || 0, color: 0 };
var out = { r: r || 0, g: g || 0, b: b || 0, a: a || 1, h: h || 0, s: s || 0, l: l || 0, v: v || 0, color: 0, color32: 0, rgba: '' };
out.rgba = 'rgba(' + out.r + ',' + out.g + ',' + out.b + ',' + out.a + ')';
out.color = Phaser.Color.getColor(out.r, out.g, out.b);
out.color32 = Phaser.Color.getColor32(out.a, out.r, out.g, out.b);
return out;
return Phaser.Color.updateColor(out);
},
@ -995,7 +1004,7 @@ Phaser.Color = {
*/
updateColor: function (out) {
out.rgba = 'rgba(' + out.r + ',' + out.g + ',' + out.b + ',' + out.a + ')';
out.rgba = 'rgba(' + out.r.toString() + ',' + out.g.toString() + ',' + out.b.toString() + ',' + out.a.toString() + ')';
return out;
@ -1088,20 +1097,13 @@ Phaser.Color = {
* @method Phaser.Color.hexToColor
* @static
* @param {string} hex - The hex string to convert. Can be in the short-hand format `#03f` or `#0033ff`.
* @param {object} [out] - An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.
* @param {object} [out] - An object into which 3 properties will be created or set: r, g and b. If not provided a new object will be created.
* @return {object} An object with the red, green and blue values set in the r, g and b properties.
*/
hexToColor: function (hex, out) {
if (!out)
{
out = Phaser.Color.createColor();
}
// Expand shorthand form (e.g. "03F") to full form (e.g. "0033FF")
var shorthandRegex = /^#?([a-f\d])([a-f\d])([a-f\d])$/i;
hex = hex.replace(shorthandRegex, function(m, r, g, b) {
hex = hex.replace(/^#?([a-f\d])([a-f\d])([a-f\d])$/i, function(m, r, g, b) {
return r + r + g + g + b + b;
});
@ -1109,15 +1111,56 @@ Phaser.Color = {
if (result)
{
out.r = parseInt(result[1], 16);
out.g = parseInt(result[2], 16);
out.b = parseInt(result[3], 16);
var r = parseInt(result[1], 16);
var g = parseInt(result[2], 16);
var b = parseInt(result[3], 16);
if (!out)
{
out = Phaser.Color.createColor(r, g, b);
}
else
{
out.r = r;
out.g = g;
out.b = b;
}
}
return out;
},
/**
* Converts a CSS 'web' string into a Phaser Color object.
*
* @method Phaser.Color.webToColor
* @static
* @param {string} web - The web string in the format: 'rgba(r,g,b,a)'
* @param {object} [out] - An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.
* @return {object} An object with the red, green and blue values set in the r, g and b properties.
*/
webToColor: function (web, out) {
if (!out)
{
out = Phaser.Color.createColor();
}
var result = /^rgba?\((\d+),\s*(\d+),\s*(\d+)(?:,\s*(\d+(?:\.\d+)?))?\)$/.exec(web);
if (result)
{
out.r = parseInt(result[1], 10);
out.g = parseInt(result[2], 10);
out.b = parseInt(result[3], 10);
}
return out;
},
/**
* Return a string containing a hex representation of the given color component.
*
@ -1435,7 +1478,7 @@ Phaser.Color = {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

19
docs/ContactMaterial.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -546,11 +554,10 @@
* Defines a physics material
*
* @class Phaser.Physics.P2.ContactMaterial
* @classdesc Physics ContactMaterial Constructor
* @constructor
* @param {Phaser.Physics.P2.Material} materialA
* @param {Phaser.Physics.P2.Material} materialB
* @param {object} [options]
* @param {Phaser.Physics.P2.Material} materialA - First material participating in the contact material.
* @param {Phaser.Physics.P2.Material} materialB - Second material participating in the contact material.
* @param {object} [options] - Additional configuration options.
*/
Phaser.Physics.P2.ContactMaterial = function (materialA, materialB, options) {
@ -563,7 +570,7 @@ Phaser.Physics.P2.ContactMaterial = function (materialA, materialB, options) {
*/
/**
* @property {Phaser.Physics.P2.Material} materialB - First second participating in the contact material.
* @property {Phaser.Physics.P2.Material} materialB - Second material participating in the contact material.
*/
/**
@ -621,7 +628,7 @@ Phaser.Physics.P2.ContactMaterial.prototype.constructor = Phaser.Physics.P2.Cont
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

66
docs/Debug.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1278,18 +1286,22 @@ Phaser.Utils.Debug.prototype = {
if (sprite.body)
{
this.start();
if (sprite.body.type === Phaser.Physics.ARCADE)
{
this.start();
Phaser.Physics.Arcade.Body.render(this.context, sprite.body, color, filled);
this.stop();
}
else if (sprite.body.type === Phaser.Physics.NINJA)
{
this.start();
Phaser.Physics.Ninja.Body.render(this.context, sprite.body, color, filled);
this.stop();
}
else if (sprite.body.type === Phaser.Physics.BOX2D)
{
Phaser.Physics.Box2D.renderBody(this.context, sprite.body, color);
}
this.stop();
}
},
@ -1307,14 +1319,54 @@ Phaser.Utils.Debug.prototype = {
if (sprite.body)
{
this.start(x, y, color, 210);
if (sprite.body.type === Phaser.Physics.ARCADE)
{
this.start(x, y, color, 210);
Phaser.Physics.Arcade.Body.renderBodyInfo(this, sprite.body);
this.stop();
}
else if (sprite.body.type === Phaser.Physics.BOX2D)
{
this.game.physics.box2d.renderBodyInfo(this, sprite.body);
}
this.stop();
}
},
/**
* Renders 'debug draw' data for the Box2D world if it exists.
* This uses the standard debug drawing feature of Box2D, so colors will be decided by
* the Box2D engine.
*
* @method Phaser.Utils.Debug#box2dWorld
*/
box2dWorld: function () {
this.start();
this.context.translate(-this.game.camera.view.x, -this.game.camera.view.y, 0);
this.game.physics.box2d.renderDebugDraw(this.context);
this.stop();
},
/**
* Renders 'debug draw' data for the given Box2D body.
* This uses the standard debug drawing feature of Box2D, so colors will be decided by the Box2D engine.
*
* @method Phaser.Utils.Debug#box2dBody
* @param {Phaser.Sprite} sprite - The sprite whos body will be rendered.
* @param {string} [color='rgb(0,255,0)'] - color of the debug info to be rendered. (format is css color string).
*/
box2dBody: function (body, color) {
this.start();
Phaser.Physics.Box2D.renderBody(this.context, body, color);
this.stop();
}
};
@ -1341,7 +1393,7 @@ Phaser.Utils.Debug.prototype.constructor = Phaser.Utils.Debug;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:18 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/Device.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -548,7 +556,6 @@
* @class Phaser.Device
* @constructor
*/
Phaser.Device = function (game) {
/**
@ -1517,7 +1524,7 @@ Phaser.Device.isAndroidStockBrowser = function()
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/DistanceConstraint.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -546,7 +554,6 @@
* A constraint that tries to keep the distance between two bodies constant.
*
* @class Phaser.Physics.P2.DistanceConstraint
* @classdesc Physics DistanceConstraint Constructor
* @constructor
* @param {Phaser.Physics.P2} world - A reference to the P2 World.
* @param {p2.Body} bodyA - First connected body.
@ -607,7 +614,7 @@ Phaser.Physics.P2.DistanceConstraint.prototype.constructor = Phaser.Physics.P2.D
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Easing.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1122,7 +1130,7 @@ Phaser.Easing.Default = Phaser.Easing.Linear.None;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

17
docs/Ellipse.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -545,14 +553,13 @@
/**
* Creates a Ellipse object. A curve on a plane surrounding two focal points.
* @class Ellipse
* @classdesc Phaser - Ellipse
*
* @class Phaser.Ellipse
* @constructor
* @param {number} [x=0] - The X coordinate of the upper-left corner of the framing rectangle of this ellipse.
* @param {number} [y=0] - The Y coordinate of the upper-left corner of the framing rectangle of this ellipse.
* @param {number} [width=0] - The overall width of this ellipse.
* @param {number} [height=0] - The overall height of this ellipse.
* @return {Phaser.Ellipse} This Ellipse object
*/
Phaser.Ellipse = function (x, y, width, height) {
@ -620,7 +627,7 @@ Phaser.Ellipse.prototype = {
},
/**
* Copies the x, y and diameter properties from this Circle to any given object.
* Copies the x, y, width and height properties from this Ellipse to any given object.
* @method Phaser.Ellipse#copyTo
* @param {any} dest - The object to copy to.
* @return {Object} This dest object.
@ -853,7 +860,7 @@ PIXI.Ellipse = Phaser.Ellipse;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

18
docs/Emitter.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,12 +551,11 @@
*/
/**
* @class Phaser.Particles.Arcade.Emitter
*
* @classdesc Emitter is a lightweight particle emitter that uses Arcade Physics.
* Emitter is a lightweight particle emitter that uses Arcade Physics.
* It can be used for one-time explosions or for continuous effects like rain and fire.
* All it really does is launch Particle objects out at set intervals, and fixes their positions and velocities accorindgly.
* All it really does is launch Particle objects out at set intervals, and fixes their positions and velocities accordingly.
*
* @class Phaser.Particles.Arcade.Emitter
* @constructor
* @extends Phaser.Group
* @param {Phaser.Game} game - Current game instance.
@ -556,7 +563,6 @@
* @param {number} [y=0] - The y coordinate within the Emitter that the particles are emitted from.
* @param {number} [maxParticles=50] - The total number of particles in this emitter.
*/
Phaser.Particles.Arcade.Emitter = function (game, x, y, maxParticles) {
/**
@ -1393,7 +1399,7 @@ Object.defineProperty(Phaser.Particles.Arcade.Emitter.prototype, "bottom", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

16
docs/Events.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,9 +551,7 @@
*/
/**
* @class Phaser.Events
*
* @classdesc The Events component is a collection of events fired by the parent game object.
* The Events component is a collection of events fired by the parent game object.
*
* For example to tell when a Sprite has been added to a new group:
*
@ -555,8 +561,8 @@
*
* Note that the Input related events only exist if the Sprite has had `inputEnabled` set to `true`.
*
* @class Phaser.Events
* @constructor
*
* @param {Phaser.Sprite} sprite - A reference to Description.
*/
Phaser.Events = function (sprite) {
@ -718,7 +724,7 @@ Phaser.Events.prototype.constructor = Phaser.Events;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/Filter.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -546,7 +554,6 @@
* This is a base Filter template to use for any Phaser filter development.
*
* @class Phaser.Filter
* @classdesc Phaser - Filter
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
* @param {Object} uniforms - Uniform mappings object
@ -722,7 +729,7 @@ Object.defineProperty(Phaser.Filter.prototype, 'height', {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/FixtureList.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -555,7 +563,6 @@
* during runtime (to remove parts, set masks, categories & sensor properties)
*
* @class Phaser.Physics.P2.FixtureList
* @classdesc Collection for generated P2 fixtures
* @constructor
* @param {Array} list - A list of fixtures (from Phaser.Physics.P2.Body#addPhaserPolygon)
*/
@ -789,7 +796,7 @@ Phaser.Physics.P2.FixtureList.prototype = {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

113
docs/FlexGrid.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -572,6 +580,7 @@ Phaser.FlexGrid = function (manager, width, height) {
this.width = width;
this.height = height;
this.boundsCustom = new Phaser.Rectangle(0, 0, width, height);
this.boundsFluid = new Phaser.Rectangle(0, 0, width, height);
this.boundsFull = new Phaser.Rectangle(0, 0, width, height);
this.boundsNone = new Phaser.Rectangle(0, 0, width, height);
@ -580,6 +589,7 @@ Phaser.FlexGrid = function (manager, width, height) {
* @property {Phaser.Point} position -
* @readonly
*/
this.positionCustom = new Phaser.Point(0, 0);
this.positionFluid = new Phaser.Point(0, 0);
this.positionFull = new Phaser.Point(0, 0);
this.positionNone = new Phaser.Point(0, 0);
@ -588,11 +598,17 @@ Phaser.FlexGrid = function (manager, width, height) {
* @property {Phaser.Point} scaleFactor - The scale factor based on the game dimensions vs. the scaled dimensions.
* @readonly
*/
this.scaleCustom = new Phaser.Point(1, 1);
this.scaleFluid = new Phaser.Point(1, 1);
this.scaleFluidInversed = new Phaser.Point(1, 1);
this.scaleFull = new Phaser.Point(1, 1);
this.scaleNone = new Phaser.Point(1, 1);
this.customWidth = 0;
this.customHeight = 0;
this.customOffsetX = 0;
this.customOffsetY = 0;
this.ratioH = width / height;
this.ratioV = height / width;
@ -631,6 +647,43 @@ Phaser.FlexGrid.prototype = {
// Need ability to create your own layers with custom scaling, etc.
/**
* A custom layer is centered on the game and maintains its aspect ratio as it scales up and down.
*
* @method createCustomLayer
* @param {number} width - Width of this layer in pixels.
* @param {number} height - Height of this layer in pixels.
* @param {array} [children] - An array of children that are used to populate the FlexLayer.
* @return {Phaser.FlexLayer} The Layer object.
*/
createCustomLayer: function (width, height, children, addToWorld) {
if (typeof addToWorld === 'undefined') { addToWorld = true; }
this.customWidth = width;
this.customHeight = height;
this.boundsCustom.width = width;
this.boundsCustom.height = height;
var layer = new Phaser.FlexLayer(this, this.positionCustom, this.boundsCustom, this.scaleCustom);
if (addToWorld)
{
this.game.world.add(layer);
}
this.layers.push(layer);
if (typeof children !== 'undefined' && typeof children !== null)
{
layer.addMultiple(children);
}
return layer;
},
/**
* A fluid layer is centered on the game and maintains its aspect ratio as it scales up and down.
*
@ -638,15 +691,20 @@ Phaser.FlexGrid.prototype = {
* @param {array} [children] - An array of children that are used to populate the FlexLayer.
* @return {Phaser.FlexLayer} The Layer object.
*/
createFluidLayer: function (children) {
createFluidLayer: function (children, addToWorld) {
if (typeof addToWorld === 'undefined') { addToWorld = true; }
var layer = new Phaser.FlexLayer(this, this.positionFluid, this.boundsFluid, this.scaleFluid);
this.game.world.add(layer);
if (addToWorld)
{
this.game.world.add(layer);
}
this.layers.push(layer);
if (typeof children !== 'undefined')
if (typeof children !== 'undefined' && typeof children !== null)
{
layer.addMultiple(children);
}
@ -710,14 +768,18 @@ Phaser.FlexGrid.prototype = {
*/
reset: function () {
for (var i = 0; i &lt; this.layers.length; i++)
{
// Remove references to this class
this.layers[i].position = null;
this.layers[i].scale = null;
}
var i = this.layers.length;
this.layers.length = 0;
while (i--)
{
if (!this.layers[i].persist)
{
// Remove references to this class
this.layers[i].position = null;
this.layers[i].scale = null;
this.layers.slice(i, 1);
}
}
},
@ -760,6 +822,24 @@ Phaser.FlexGrid.prototype = {
this.positionFluid.set(this.boundsFluid.x, this.boundsFluid.y);
this.positionNone.set(this.boundsNone.x, this.boundsNone.y);
// Custom Layer
/*
if (this.customWidth > 0)
{
var customMultiplier = Math.min((this.manager.height / this.customHeight), (this.manager.width / this.customWidth));
this.boundsCustom.width = Math.round(this.customWidth * customMultiplier);
this.boundsCustom.height = Math.round(this.customHeight * customMultiplier);
this.boundsCustom.centerOn(this.manager.bounds.centerX, this.manager.bounds.centerY);
this.scaleCustom.set(this.boundsCustom.width / this.width, this.boundsCustom.height / this.height);
this.positionCustom.set(this.boundsCustom.x, this.boundsCustom.y);
}
*/
},
/**
@ -774,14 +854,17 @@ Phaser.FlexGrid.prototype = {
// this.layers[i].debug();
// }
this.game.debug.text(this.boundsFull.width + ' x ' + this.boundsFull.height, this.boundsFull.x + 4, this.boundsFull.y + 16);
this.game.debug.geom(this.boundsFull, 'rgba(0,0,255,0.9', false);
// this.game.debug.text(this.boundsFull.width + ' x ' + this.boundsFull.height, this.boundsFull.x + 4, this.boundsFull.y + 16);
// this.game.debug.geom(this.boundsFull, 'rgba(0,0,255,0.9', false);
this.game.debug.text(this.boundsFluid.width + ' x ' + this.boundsFluid.height, this.boundsFluid.x + 4, this.boundsFluid.y + 16);
this.game.debug.geom(this.boundsFluid, 'rgba(255,0,0,0.9', false);
this.game.debug.text(this.boundsNone.width + ' x ' + this.boundsNone.height, this.boundsNone.x + 4, this.boundsNone.y + 16);
this.game.debug.geom(this.boundsNone, 'rgba(0,255,0,0.9', false);
// this.game.debug.text(this.boundsNone.width + ' x ' + this.boundsNone.height, this.boundsNone.x + 4, this.boundsNone.y + 16);
// this.game.debug.geom(this.boundsNone, 'rgba(0,255,0,0.9', false);
// this.game.debug.text(this.boundsCustom.width + ' x ' + this.boundsCustom.height, this.boundsCustom.x + 4, this.boundsCustom.y + 16);
// this.game.debug.geom(this.boundsCustom, 'rgba(255,255,0,0.9', false);
}
@ -809,7 +892,7 @@ Phaser.FlexGrid.prototype.constructor = Phaser.FlexGrid;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

21
docs/FlexLayer.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -564,12 +572,19 @@ Phaser.FlexLayer = function (manager, position, bounds, scale) {
/**
* @property {Phaser.ScaleManager} scale - A reference to the ScaleManager.
*/
this.manager = manager;
this.manager = manager.manager;
/**
* @property {Phaser.FlexGrid} grid - A reference to the FlexGrid that owns this layer.
*/
this.grid = manager.grid;
this.grid = manager;
/**
* Should the FlexLayer remain through a State swap?
*
* @type {boolean}
*/
this.persist = false;
// Bound to the grid
this.position = position;
@ -624,7 +639,7 @@ Phaser.FlexLayer.prototype.debug = function () {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Frame.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -772,7 +780,7 @@ Phaser.Frame.prototype.constructor = Phaser.Frame;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/FrameData.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -821,7 +829,7 @@ Object.defineProperty(Phaser.FrameData.prototype, "total", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

20
docs/Game.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,14 +551,12 @@
*/
/**
* Game constructor
*
* Instantiate a new &lt;code>Phaser.Game&lt;/code> object.
* @class Phaser.Game
* @classdesc This is where the magic happens. The Game object is the heart of your game,
* This is where the magic happens. The Game object is the heart of your game,
* providing quick access to common functions and handling the boot process.
* "Hell, there are no rules here - we're trying to accomplish something."
* Thomas A. Edison
*
* @class Phaser.Game
* @constructor
* @param {number|string} [width=800] - The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given.
* @param {number|string} [height=600] - The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given.
@ -558,7 +564,7 @@
* @param {string|HTMLElement} [parent=''] - The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.
* @param {object} [state=null] - The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.
* @param {boolean} [transparent=false] - Use a transparent canvas background or not.
* @param {boolean} [antialias=true] - Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.
* @param {boolean} [antialias=true] - Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.
* @param {object} [physicsConfig=null] - A physics configuration object to pass to the Physics world on creation.
*/
Phaser.Game = function (width, height, renderer, parent, state, transparent, antialias, physicsConfig) {
@ -1468,7 +1474,7 @@ Object.defineProperty(Phaser.Game.prototype, "paused", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

23
docs/GameObjectCreator.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -663,6 +671,19 @@ Phaser.GameObjectCreator.prototype = {
},
/**
* Creates a new AudioSprite object.
*
* @method Phaser.GameObjectCreator#audioSprite
* @param {string} key - The Game.cache key of the sound that this object will use.
* @return {Phaser.AudioSprite} The newly created AudioSprite object.
*/
audioSprite: function (key) {
return this.game.sound.addSprite(key);
},
/**
* Creates a new Sound object.
*
@ -942,7 +963,7 @@ Phaser.GameObjectCreator.prototype.constructor = Phaser.GameObjectCreator;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

23
docs/GameObjectFactory.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -714,6 +722,19 @@ Phaser.GameObjectFactory.prototype = {
sound: function (key, volume, loop, connect) {
return this.game.sound.add(key, volume, loop, connect);
},
/**
* Creates a new AudioSprite object.
*
* @method Phaser.GameObjectFactory#audioSprite
* @param {string} key - The Game.cache key of the sound that this object will use.
* @return {Phaser.AudioSprite} The newly created AudioSprite object.
*/
audioSprite: function (key) {
return this.game.sound.addSprite(key);
},
@ -1016,7 +1037,7 @@ Phaser.GameObjectFactory.prototype.constructor = Phaser.GameObjectFactory;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Gamepad.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1215,7 +1223,7 @@ Phaser.Gamepad.PS3XC_STICK_RIGHT_Y = 3; // analog stick, range -1..1
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

13
docs/GamepadButton.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -544,8 +552,9 @@
*/
/**
* If you need more fine-grained control over the handling of specific buttons you can create and use Phaser.GamepadButton objects.
*
* @class Phaser.GamepadButton
* @classdesc If you need more fine-grained control over the handling of specific buttons you can create and use Phaser.GamepadButton objects.
* @constructor
* @param {Phaser.SinglePad} pad - A reference to the gamepad that owns this button.
* @param {number} buttonCode - The button code this GamepadButton is responsible for.
@ -768,7 +777,7 @@ Phaser.GamepadButton.prototype.constructor = Phaser.GamepadButton;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/GearConstraint.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -546,7 +554,6 @@
* Connects two bodies at given offset points, letting them rotate relative to each other around this point.
*
* @class Phaser.Physics.P2.GearConstraint
* @classdesc Physics GearConstraint Constructor
* @constructor
* @param {Phaser.Physics.P2} world - A reference to the P2 World.
* @param {p2.Body} bodyA - First connected body.
@ -598,7 +605,7 @@ Phaser.Physics.P2.GearConstraint.prototype.constructor = Phaser.Physics.P2.GearC
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

12
docs/Graphics.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -547,7 +555,7 @@
*
* @class Phaser.Graphics
* @constructor
*
* @extends PIXI.Graphics
* @param {Phaser.Game} game Current game instance.
* @param {number} x - X position of the new graphics object.
* @param {number} y - Y position of the new graphics object.
@ -943,7 +951,7 @@ Object.defineProperty(Phaser.Graphics.prototype, "destroyPhase", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

55
docs/Group.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,9 +551,10 @@
*/
/**
* Phaser Group constructor.
* A Group is a container for display objects that allows for fast pooling and object recycling.
* Groups can be nested within other Groups and have their own local transforms.
*
* @class Phaser.Group
* @classdesc A Group is a container for display objects that allows for fast pooling and object recycling. Groups can be nested within other Groups and have their own local transforms.
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
* @param {Phaser.Group|Phaser.Sprite|null} parent - The parent Group, DisplayObject or DisplayObjectContainer that this Group will be added to. If `undefined` it will use game.world. If null it won't be added to anything.
@ -612,6 +621,12 @@ Phaser.Group = function (game, parent, name, addToStage, enableBody, physicsBody
*/
this.exists = true;
/**
* @property {boolean} ignoreDestroy - A Group with `ignoreDestroy` set to `true` ignores all calls to its `destroy` method.
* @default
*/
this.ignoreDestroy = false;
/**
* The type of objects that will be created when you use Group.create or Group.createMultiple. Defaults to Phaser.Sprite.
* When a new object is created it is passed the following parameters to its constructor: game, x, y, key, frame.
@ -1326,7 +1341,7 @@ Phaser.Group.prototype.checkProperty = function (child, key, value, force) {
{
return false;
}
if (Phaser.Utils.getProperty(child, key) !== value)
{
return false;
@ -1736,6 +1751,36 @@ Phaser.Group.prototype.postUpdate = function () {
};
/**
* Allows you to obtain a Phaser.ArrayList of children that return true for the given predicate
* For example:
* var healthyList = Group.filter(function(child, index, children) {
* return child.health > 10 ? true : false;
* }, true);
* healthyList.callAll('attack');
* Note: Currently this will skip any children which are Groups themselves.
* @method Phaser.Group#filter
* @param {function} predicate - The function that each child will be evaluated against. Each child of the Group will be passed to it as its first parameter, the index as the second, and the entire child array as the third
* @param {boolean} [checkExists=false] - If set only children with exists=true will be passed to the callback, otherwise all children will be passed.
* @return {Phaser.ArrayList} Returns an array list containing all the children that the predicate returned true for
*/
Phaser.Group.prototype.filter = function(predicate, checkExists) {
var index = -1,
length = this.children.length,
result = new Phaser.ArrayList();
while(++index &lt; length) {
var child = this.children[index];
if(!checkExists || (checkExists && child.exists)) {
if(predicate(child, index, this.children)) {
result.add(child);
}
}
}
return result;
};
/**
* Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run.
* After the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child.
@ -2250,7 +2295,7 @@ Phaser.Group.prototype.removeBetween = function (startIndex, endIndex, destroy,
*/
Phaser.Group.prototype.destroy = function (destroyChildren, soft) {
if (this.game === null) { return; }
if (this.game === null || this.ignoreDestroy) { return; }
if (typeof destroyChildren === 'undefined') { destroyChildren = true; }
if (typeof soft === 'undefined') { soft = false; }
@ -2407,7 +2452,7 @@ Object.defineProperty(Phaser.Group.prototype, "fixedToCamera", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

26
docs/Image.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,11 +551,11 @@
*/
/**
* @class Phaser.Image
*
* @classdesc Create a new `Image` object. An Image is a light-weight object you can use to display anything that doesn't need physics or animation.
* An Image is a light-weight object you can use to display anything that doesn't need physics or animation.
* It can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics.
*
* @class Phaser.Image
* @extends PIXI.Sprite
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
* @param {number} x - The x coordinate of the Image. The coordinate is relative to any parent container this Image may be in.
@ -799,7 +807,13 @@ Phaser.Image.prototype.loadTexture = function (key, frame) {
}
else if (key instanceof Phaser.BitmapData)
{
// This works from a reference, which probably isn't what we need here
this.setTexture(key.texture);
if (this.game.cache.getFrameData(key.key, Phaser.Cache.BITMAPDATA))
{
setFrame = !this.animations.loadFrameData(this.game.cache.getFrameData(key.key, Phaser.Cache.BITMAPDATA), frame);
}
}
else if (key instanceof PIXI.Texture)
{
@ -879,6 +893,10 @@ Phaser.Image.prototype.setFrame = function(frame) {
this.texture.frame.width = frame.sourceSizeW;
this.texture.frame.height = frame.sourceSizeH;
}
else if (!frame.trimmed && this.texture.trim)
{
this.texture.trim = null;
}
if (this.cropRect)
{
@ -1482,7 +1500,7 @@ Object.defineProperty(Phaser.Image.prototype, "destroyPhase", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Input.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1529,7 +1537,7 @@ Object.defineProperty(Phaser.Input.prototype, "worldY", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

73
docs/InputHandler.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -544,6 +552,7 @@
/**
* The Input Handler is bound to a specific Sprite and is responsible for managing all Input events on that Sprite.
*
* @class Phaser.InputHandler
* @constructor
* @param {Phaser.Sprite} sprite - The Sprite object to which this Input Handler belongs.
@ -709,6 +718,11 @@ Phaser.InputHandler = function (sprite) {
*/
this.consumePointerEvent = false;
/**
* @property {boolean} scaleLayer - EXPERIMENTAL: Please do not use this property unless you know what it does. Likely to change in the future.
*/
this.scaleLayer = false;
/**
* @property {boolean} _dragPhase - Internal cache var.
* @private
@ -1546,16 +1560,19 @@ Phaser.InputHandler.prototype = {
return false;
}
var px = this.globalToLocalX(pointer.x) + this._dragPoint.x + this.dragOffset.x;
var py = this.globalToLocalY(pointer.y) + this._dragPoint.y + this.dragOffset.y;
if (this.sprite.fixedToCamera)
{
if (this.allowHorizontalDrag)
{
this.sprite.cameraOffset.x = pointer.x + this._dragPoint.x + this.dragOffset.x;
this.sprite.cameraOffset.x = px;
}
if (this.allowVerticalDrag)
{
this.sprite.cameraOffset.y = pointer.y + this._dragPoint.y + this.dragOffset.y;
this.sprite.cameraOffset.y = py;
}
if (this.boundsRect)
@ -1578,12 +1595,12 @@ Phaser.InputHandler.prototype = {
{
if (this.allowHorizontalDrag)
{
this.sprite.x = pointer.x + this._dragPoint.x + this.dragOffset.x;
this.sprite.x = px;
}
if (this.allowVerticalDrag)
{
this.sprite.y = pointer.y + this._dragPoint.y + this.dragOffset.y;
this.sprite.y = py;
}
if (this.boundsRect)
@ -1797,14 +1814,12 @@ Phaser.InputHandler.prototype = {
if (this.dragFromCenter)
{
var bounds = this.sprite.getBounds();
this.sprite.x = pointer.x + (this.sprite.x - bounds.centerX);
this.sprite.y = pointer.y + (this.sprite.y - bounds.centerY);
this._dragPoint.setTo(this.sprite.x - pointer.x, this.sprite.y - pointer.y);
}
else
{
this._dragPoint.setTo(this.sprite.x - pointer.x, this.sprite.y - pointer.y);
this.sprite.x = this.globalToLocalX(pointer.x) + (this.sprite.x - bounds.centerX);
this.sprite.y = this.globalToLocalY(pointer.y) + (this.sprite.y - bounds.centerY);
}
this._dragPoint.setTo(this.sprite.x - this.globalToLocalX(pointer.x), this.sprite.y - this.globalToLocalY(pointer.y));
}
this.updateDrag(pointer);
@ -1819,6 +1834,40 @@ Phaser.InputHandler.prototype = {
},
/**
* Warning: EXPERIMENTAL
* @method Phaser.InputHandler#globalToLocalX
* @param {number} x
*/
globalToLocalX: function (x) {
if (this.scaleLayer)
{
x -= this.game.scale.grid.boundsFluid.x;
x *= this.game.scale.grid.scaleFluidInversed.x;
}
return x;
},
/**
* Warning: EXPERIMENTAL
* @method Phaser.InputHandler#globalToLocalY
* @param {number} y
*/
globalToLocalY: function (y) {
if (this.scaleLayer)
{
y -= this.game.scale.grid.boundsFluid.y;
y *= this.game.scale.grid.scaleFluidInversed.y;
}
return y;
},
/**
* Called by Pointer when drag is stopped on this Sprite. Should not usually be called directly.
* @method Phaser.InputHandler#stopDrag
@ -2030,7 +2079,7 @@ Phaser.InputHandler.prototype.constructor = Phaser.InputHandler;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/InversePointProxy.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -546,7 +554,6 @@
* A InversePointProxy is an internal class that allows for direct getter/setter style property access to Arrays and TypedArrays but inverses the values on set.
*
* @class Phaser.Physics.P2.InversePointProxy
* @classdesc InversePointProxy
* @constructor
* @param {Phaser.Physics.P2} world - A reference to the P2 World.
* @param {any} destination - The object to bind to.
@ -660,7 +667,7 @@ Object.defineProperty(Phaser.Physics.P2.InversePointProxy.prototype, "my", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

13
docs/Key.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,8 +551,9 @@
*/
/**
* If you need more fine-grained control over the handling of specific keys you can create and use Phaser.Key objects.
*
* @class Phaser.Key
* @classdesc If you need more fine-grained control over the handling of specific keys you can create and use Phaser.Key objects.
* @constructor
* @param {Phaser.Game} game - Current game instance.
* @param {number} keycode - The key code this Key is responsible for.
@ -805,7 +814,7 @@ Phaser.Key.prototype.constructor = Phaser.Key;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

12
docs/Keyboard.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1194,6 +1202,8 @@ Phaser.Keyboard.INSERT = 45;
Phaser.Keyboard.DELETE = 46;
Phaser.Keyboard.HELP = 47;
Phaser.Keyboard.NUM_LOCK = 144;
Phaser.Keyboard.PLUS = 43;
Phaser.Keyboard.MINUS = 45;
</pre>
</article>
</section>
@ -1215,7 +1225,7 @@ Phaser.Keyboard.NUM_LOCK = 144;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

21
docs/Line.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -544,14 +552,13 @@
/**
* Creates a new Line object with a start and an end point.
* @class Line
* @classdesc Phaser - Line
*
* @class Phaser.Line
* @constructor
* @param {number} [x1=0] - The x coordinate of the start of the line.
* @param {number} [y1=0] - The y coordinate of the start of the line.
* @param {number} [x2=0] - The x coordinate of the end of the line.
* @param {number} [y2=0] - The y coordinate of the end of the line.
* @return {Phaser.Line} This line object
*/
Phaser.Line = function (x1, y1, x2, y2) {
@ -609,10 +616,8 @@ Phaser.Line.prototype = {
{
return this.setTo(startSprite.center.x, startSprite.center.y, endSprite.center.x, endSprite.center.y);
}
else
{
return this.setTo(startSprite.x, startSprite.y, endSprite.x, endSprite.y);
}
return this.setTo(startSprite.x, startSprite.y, endSprite.x, endSprite.y);
},
@ -993,7 +998,7 @@ Phaser.Line.intersects = function (a, b, asSegment, result) {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/LinkedList.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -735,7 +743,7 @@ Phaser.LinkedList.prototype.constructor = Phaser.LinkedList;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

107
docs/Loader.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -544,12 +552,10 @@
*/
/**
* Phaser loader constructor.
* The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.
* It uses a combination of Image() loading and xhr and provides progress and completion callbacks.
*
* @class Phaser.Loader
* @classdesc The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.
* It uses a combination of Image() loading and xhr and provides progress and completion callbacks.
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
*/
@ -588,7 +594,7 @@ Phaser.Loader = function (game) {
* 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
*
*
* @property {object} preloadSprite
*/
this.preloadSprite = null;
@ -634,10 +640,10 @@ Phaser.Loader = function (game) {
this.onLoadComplete = new Phaser.Signal();
/**
* @property {Phaser.Signal} onPackComplete - This event is dispatched when an asset pack has either loaded or failed.
* @property {Phaser.Signal} onPackComplete - This event is dispatched when an asset pack has either loaded or failed.
*/
this.onPackComplete = new Phaser.Signal();
/**
* @property {boolean} useXDomainRequest - If true and if the browser supports XDomainRequest, it will be used in preference for xhr when loading json files. It is enabled automatically if the browser is IE9, but you can disable it as required.
*/
@ -755,7 +761,7 @@ Phaser.Loader.prototype = {
/**
* Check whether asset exists with a specific key.
* Use Phaser.Cache to access loaded assets, e.g. Phaser.Cache#checkImageKey
*
*
* @method Phaser.Loader#checkKeyExists
* @param {string} type - The type asset you want to check.
* @param {string} key - Key of the asset you want to check.
@ -1039,6 +1045,32 @@ Phaser.Loader.prototype = {
},
/**
* Add an XML file to the Loader.
*
* @method Phaser.Loader#xml
* @param {string} key - Unique asset key of the xml file.
* @param {string} url - URL of the xml file.
* @param {boolean} [overwrite=false] - If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.
* @return {Phaser.Loader} This Loader instance.
*/
xml: function (key, url, overwrite) {
if (typeof overwrite === "undefined") { overwrite = false; }
if (overwrite)
{
this.replaceInFileList('xml', key, url);
}
else
{
this.addToFileList('xml', key, url);
}
return this;
},
/**
* 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.
@ -1128,6 +1160,26 @@ Phaser.Loader.prototype = {
},
/**
* 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 https://github.com/tonistiigi/audiosprite
*
* @method Phaser.Loader#audiosprite
* @param {string} key - Unique asset key of the audio file.
* @param {Array|string} urls - 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.
* @param {string} atlasURL - The URL of the audiosprite configuration json.
* @return {Phaser.Loader} This Loader instance.
*/
audiosprite: function(key, urls, atlasURL) {
this.audio(key, urls);
this.json(key + '-audioatlas', atlasURL);
return this;
},
/**
* Add a new tilemap loading request.
*
@ -1514,7 +1566,7 @@ Phaser.Loader.prototype = {
console.warn('Phaser.Loader loadPackList invalid index ' + this._packIndex);
return;
}
var pack = this._packList[this._packIndex];
if (pack.data !== null)
@ -1582,6 +1634,10 @@ Phaser.Loader.prototype = {
this.json(file.key, file.url, file.overwrite);
break;
case "xml":
this.xml(file.key, file.url, file.overwrite);
break;
case "script":
this.script(file.key, file.url, file.callback, pack.callbackContext);
break;
@ -1689,11 +1745,11 @@ Phaser.Loader.prototype = {
console.warn('Phaser.Loader loadFile invalid index ' + this._fileIndex);
return;
}
var file = this._fileList[this._fileIndex];
var _this = this;
this.onFileStart.dispatch(this.progress, file.key);
this.onFileStart.dispatch(this.progress, file.key, file.url);
// Image or Data?
switch (file.type)
@ -1747,7 +1803,7 @@ Phaser.Loader.prototype = {
};
file.data.preload = 'auto';
file.data.src = this.baseURL + file.url;
file.data.addEventListener('canplaythrough', Phaser.GAMES[this.game.id].load.fileComplete(this._fileIndex), false);
file.data.addEventListener('canplaythrough', function () { Phaser.GAMES[_this.game.id].load.fileComplete(_this._fileIndex); }, false);
file.data.load();
}
}
@ -1773,7 +1829,7 @@ Phaser.Loader.prototype = {
this._ajax.onerror = function () {
return _this.dataLoadError(_this._fileIndex);
};
this._ajax.ontimeout = function () {
return _this.dataLoadError(_this._fileIndex);
};
@ -1786,7 +1842,7 @@ Phaser.Loader.prototype = {
this._ajax.open('GET', this.baseURL + file.url, true);
// Note: The xdr.send() call is wrapped in a timeout to prevent an issue with the interface where some requests are lost
// Note: The xdr.send() call is wrapped in a timeout to prevent an issue with the interface where some requests are lost
// if multiple XDomainRequests are being sent at the same time.
setTimeout(function () {
this._ajax.send();
@ -1799,6 +1855,11 @@ Phaser.Loader.prototype = {
break;
case 'xml':
this.xhrLoad(this._fileIndex, this.baseURL + file.url, 'text', 'xmlLoadComplete', 'dataLoadError');
break;
case 'tilemap':
if (file.format === Phaser.Tilemap.TILED_JSON)
@ -1830,7 +1891,7 @@ Phaser.Loader.prototype = {
/**
* Starts the xhr loader.
*
*
* @method Phaser.Loader#xhrLoad
* @private
* @param {number} index - The index of the file to load from the file list.
@ -1860,7 +1921,7 @@ Phaser.Loader.prototype = {
/**
* Private method ONLY used by loader.
*
*
* @method Phaser.Loader#getAudioURL
* @private
* @param {array|string} urls - Either an array of audio file URLs or a string containing a single URL path.
@ -2149,6 +2210,12 @@ Phaser.Loader.prototype = {
*/
xmlLoadComplete: function (index) {
if (this._xhr.responseType !== '' && this._xhr.responseType !== 'text')
{
console.warn('Invalid XML Response Type', this._fileList[index]);
console.warn(this._xhr);
}
var data = this._xhr.responseText;
var xml;
@ -2179,14 +2246,18 @@ Phaser.Loader.prototype = {
var file = this._fileList[index];
file.loaded = true;
if (file.type == 'bitmapfont')
if (file.type === 'bitmapfont')
{
this.game.cache.addBitmapFont(file.key, file.url, file.data, xml, file.xSpacing, file.ySpacing);
}
else if (file.type == 'textureatlas')
else if (file.type === 'textureatlas')
{
this.game.cache.addTextureAtlas(file.key, file.url, file.data, xml, file.format);
}
else if (file.type === 'xml')
{
this.game.cache.addXML(file.key, file.url, xml);
}
this.nextFile(index, true);
@ -2355,7 +2426,7 @@ Phaser.Loader.prototype.constructor = Phaser.Loader;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/LoaderParser.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -629,7 +637,7 @@ Phaser.LoaderParser = {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/LockConstraint.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -546,7 +554,6 @@
* Locks the relative position between two bodies.
*
* @class Phaser.Physics.P2.LockConstraint
* @classdesc Physics LockConstraint Constructor
* @constructor
* @param {Phaser.Physics.P2} world - A reference to the P2 World.
* @param {p2.Body} bodyA - First connected body.
@ -602,7 +609,7 @@ Phaser.Physics.P2.LockConstraint.prototype.constructor = Phaser.Physics.P2.LockC
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

24
docs/MSPointer.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,12 +551,11 @@
*/
/**
* Phaser - MSPointer constructor.
*
* @class Phaser.MSPointer
* @classdesc The MSPointer class handles touch interactions with the game and the resulting Pointer objects.
* The MSPointer class handles touch interactions with the game and the resulting Pointer objects.
* It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 apps using JavaScript.
* http://msdn.microsoft.com/en-us/library/ie/hh673557(v=vs.85).aspx
*
* @class Phaser.MSPointer
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
*/
@ -637,8 +644,9 @@ Phaser.MSPointer.prototype = {
/**
* The function that handles the PointerDown event.
*
* @method Phaser.MSPointer#onPointerDown
* @param {PointerEvent} event
* @param {PointerEvent} event - The native DOM event.
*/
onPointerDown: function (event) {
@ -657,7 +665,7 @@ Phaser.MSPointer.prototype = {
/**
* The function that handles the PointerMove event.
* @method Phaser.MSPointer#onPointerMove
* @param {PointerEvent } event
* @param {PointerEvent} event - The native DOM event.
*/
onPointerMove: function (event) {
@ -676,7 +684,7 @@ Phaser.MSPointer.prototype = {
/**
* The function that handles the PointerUp event.
* @method Phaser.MSPointer#onPointerUp
* @param {PointerEvent} event
* @param {PointerEvent} event - The native DOM event.
*/
onPointerUp: function (event) {
@ -732,7 +740,7 @@ Phaser.MSPointer.prototype.constructor = Phaser.MSPointer;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

14
docs/Material.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,11 +551,13 @@
*/
/**
* A P2 Material.
*
* \o/ ~ "Because I'm a Material girl"
*
* @class Phaser.Physics.P2.Material
* @classdesc Physics Material Constructor
* @constructor
* @param {string} name - The user defined name given to this Material.
*/
Phaser.Physics.P2.Material = function (name) {
@ -584,7 +594,7 @@ Phaser.Physics.P2.Material.prototype.constructor = Phaser.Physics.P2.Material;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

12
docs/Math.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1427,7 +1435,7 @@ Phaser.Math = {
*
* @method Phaser.Math#wrapAngle
* @param {number} angle - The angle value to check
* @param {boolean} radians - True if angle is given in radians.
* @param {boolean} radians - Set to `true` if the angle is given in radians, otherwise degrees is expected.
* @return {number} The new angle value, returns the same as the input angle if it was within bounds.
*/
wrapAngle: function (angle, radians) {
@ -2045,7 +2053,7 @@ Phaser.Math = {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Mouse.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1101,7 +1109,7 @@ Phaser.Mouse.prototype.constructor = Phaser.Mouse;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Net.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -723,7 +731,7 @@ Phaser.Net.prototype.constructor = Phaser.Net;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

15
docs/Particle.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -543,10 +551,9 @@
*/
/**
* Create a new `Particle` object. Particles are extended Sprites that are emitted by a particle emitter such as Phaser.Particles.Arcade.Emitter.
*
* @class Phaser.Particle
*
* @classdesc Create a new `Particle` object. Particles are extended Sprites that are emitted by a particle emitter such as Phaser.Particles.Arcade.Emitter.
*
* @constructor
* @extends Phaser.Sprite
* @param {Phaser.Game} game - A reference to the currently running game.
@ -741,7 +748,7 @@ Phaser.Particle.prototype.reset = function(x, y, health) {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

11
docs/Particles.js.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -546,7 +554,6 @@
* Phaser.Particles is the Particle Manager for the game. It is called during the game update loop and in turn updates any Emitters attached to it.
*
* @class Phaser.Particles
* @classdesc Phaser Particles
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
*/
@ -638,7 +645,7 @@ Phaser.Particles.prototype.constructor = Phaser.Particles;
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:17 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Animation.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -4527,7 +4535,7 @@ If <code>dispatchComplete</code> is true it will dispatch the complete events, o
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:18 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

142
docs/Phaser.AnimationManager.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -982,7 +990,7 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-500">line 500</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-522">line 522</a>
</li></ul></dd>
@ -1084,7 +1092,7 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-453">line 453</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-458">line 458</a>
</li></ul></dd>
@ -1186,7 +1194,7 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-539">line 539</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-561">line 561</a>
</li></ul></dd>
@ -1288,7 +1296,7 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-466">line 466</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-471">line 471</a>
</li></ul></dd>
@ -1504,6 +1512,108 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
</dl>
</dd>
<dt>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Gets the current animation name, if set.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-505">line 505</a>
</li></ul></dd>
</dl>
@ -1597,7 +1707,7 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-480">line 480</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-485">line 485</a>
</li></ul></dd>
@ -2091,7 +2201,7 @@ Animations added in this way are played back with the play function.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-162">line 162</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-167">line 167</a>
</li></ul></dd>
@ -2184,7 +2294,7 @@ Iterates through the list of animations stored in this manager and calls destroy
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-423">line 423</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-428">line 428</a>
</li></ul></dd>
@ -2302,7 +2412,7 @@ Iterates through the list of animations stored in this manager and calls destroy
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-385">line 385</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-390">line 390</a>
</li></ul></dd>
@ -2463,7 +2573,7 @@ Iterates through the list of animations stored in this manager and calls destroy
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-353">line 353</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-358">line 358</a>
</li></ul></dd>
@ -2715,7 +2825,7 @@ If the requested animation is already playing this request will be ignored. If y
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-259">line 259</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-264">line 264</a>
</li></ul></dd>
@ -2876,7 +2986,7 @@ If the requested animation is already playing this request will be ignored. If y
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-369">line 369</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-374">line 374</a>
</li></ul></dd>
@ -2945,7 +3055,7 @@ If the requested animation is already playing this request will be ignored. If y
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-406">line 406</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-411">line 411</a>
</li></ul></dd>
@ -3123,7 +3233,7 @@ The currentAnim property of the AnimationManager is automatically set to the ani
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-299">line 299</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-304">line 304</a>
</li></ul></dd>
@ -3192,7 +3302,7 @@ The currentAnim property of the AnimationManager is automatically set to the ani
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-329">line 329</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-334">line 334</a>
</li></ul></dd>
@ -3388,7 +3498,7 @@ The currentAnim property of the AnimationManager is automatically set to the ani
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-225">line 225</a>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-230">line 230</a>
</li></ul></dd>
@ -3462,7 +3572,7 @@ The currentAnim property of the AnimationManager is automatically set to the ani
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:19 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.AnimationParser.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1601,7 +1609,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:19 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.ArrayList.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -2127,7 +2135,7 @@ The function must exist on the member.</p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:19 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:47 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

1914
docs/Phaser.AudioSprite.html Normal file
View file

File diff suppressed because it is too large Load diff

739
docs/Phaser.BitmapData.html
View file

File diff suppressed because it is too large Load diff

76
docs/Phaser.BitmapText.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -542,10 +550,7 @@
BitmapText
</h2>
<div class="class-description"><p>BitmapText objects work by taking a texture file and an XML file that describes the font layout.</p>
<p>On Windows you can use the free app BMFont: <a href="http://www.angelcode.com/products/bmfont/">http://www.angelcode.com/products/bmfont/</a>
On OS X we recommend Glyph Designer: <a href="http://www.71squared.com/en/glyphdesigner">http://www.71squared.com/en/glyphdesigner</a>
For Web there is the great Littera: <a href="http://kvazars.com/littera/">http://kvazars.com/littera/</a></p></div>
<div class="class-description"><p>Phaser.BitmapText</p></div>
</header>
@ -564,7 +569,10 @@ For Web there is the great Littera: <a href="http://kvazars.com/littera/">http:/
<div class="description">
<p>Creates a new BitmapText object.</p>
<p>BitmapText objects work by taking a texture file and an XML file that describes the font layout.</p>
<p>On Windows you can use the free app BMFont: <a href="http://www.angelcode.com/products/bmfont/">http://www.angelcode.com/products/bmfont/</a>
On OS X we recommend Glyph Designer: <a href="http://www.71squared.com/en/glyphdesigner">http://www.71squared.com/en/glyphdesigner</a>
For Web there is the great Littera: <a href="http://kvazars.com/littera/">http://kvazars.com/littera/</a></p>
</div>
@ -845,7 +853,7 @@ For Web there is the great Littera: <a href="http://kvazars.com/littera/">http:/
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-26">line 26</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-24">line 24</a>
</li></ul></dd>
@ -874,6 +882,12 @@ For Web there is the great Littera: <a href="http://kvazars.com/littera/">http:/
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>PIXI.BitmapText</li>
</ul>
@ -973,7 +987,7 @@ For Web there is the great Littera: <a href="http://kvazars.com/littera/">http:/
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-267">line 267</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-265">line 265</a>
</li></ul></dd>
@ -1081,7 +1095,7 @@ If you wish to work in radians instead of degrees use the property Sprite.rotati
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-311">line 311</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-309">line 309</a>
</li></ul></dd>
@ -1183,7 +1197,7 @@ If you wish to work in radians instead of degrees use the property Sprite.rotati
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-110">line 110</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-108">line 108</a>
</li></ul></dd>
@ -1285,7 +1299,7 @@ If you wish to work in radians instead of degrees use the property Sprite.rotati
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-473">line 473</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-471">line 471</a>
</li></ul></dd>
@ -1387,7 +1401,7 @@ If you wish to work in radians instead of degrees use the property Sprite.rotati
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-100">line 100</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-98">line 98</a>
</li></ul></dd>
@ -1492,7 +1506,7 @@ If you wish to work in radians instead of degrees use the property Sprite.rotati
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-43">line 43</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-41">line 41</a>
</li></ul></dd>
@ -1600,7 +1614,7 @@ So if this BitmapText was in a Group that has x: 200, then this will be added to
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-442">line 442</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-440">line 440</a>
</li></ul></dd>
@ -1702,7 +1716,7 @@ So if this BitmapText was in a Group that has x: 200, then this will be added to
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-330">line 330</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-328">line 328</a>
</li></ul></dd>
@ -1804,7 +1818,7 @@ So if this BitmapText was in a Group that has x: 200, then this will be added to
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-353">line 353</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-351">line 351</a>
</li></ul></dd>
@ -1906,7 +1920,7 @@ So if this BitmapText was in a Group that has x: 200, then this will be added to
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-37">line 37</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-35">line 35</a>
</li></ul></dd>
@ -2011,7 +2025,7 @@ So if this BitmapText was in a Group that has x: 200, then this will be added to
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-105">line 105</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-103">line 103</a>
</li></ul></dd>
@ -2118,7 +2132,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-401">line 401</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-399">line 399</a>
</li></ul></dd>
@ -2220,7 +2234,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-49">line 49</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-47">line 47</a>
</li></ul></dd>
@ -2322,7 +2336,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-595">line 595</a>
<a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-598">line 598</a>
</li></ul></dd>
@ -2428,7 +2442,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-378">line 378</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-376">line 376</a>
</li></ul></dd>
@ -2530,7 +2544,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-557">line 557</a>
<a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-560">line 560</a>
</li></ul></dd>
@ -2632,7 +2646,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-289">line 289</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-287">line 287</a>
</li></ul></dd>
@ -2734,7 +2748,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-55">line 55</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-53">line 53</a>
</li></ul></dd>
@ -2836,7 +2850,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-65">line 65</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-63">line 63</a>
</li></ul></dd>
@ -2938,7 +2952,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-60">line 60</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-58">line 58</a>
</li></ul></dd>
@ -3072,7 +3086,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-207">line 207</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-205">line 205</a>
</li></ul></dd>
@ -3141,7 +3155,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-192">line 192</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-190">line 190</a>
</li></ul></dd>
@ -3210,7 +3224,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-150">line 150</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-148">line 148</a>
</li></ul></dd>
@ -3279,7 +3293,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-183">line 183</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-181">line 181</a>
</li></ul></dd>
@ -3330,7 +3344,7 @@ activated for this object and it will then start to process click/touch events a
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:20 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:47 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

132
docs/Phaser.Button.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -542,14 +550,7 @@
Button
</h2>
<div class="class-description"><p>Create a new <code>Button</code> object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically. The four states a Button responds to are:</p>
<ul>
<li>'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'.</li>
<li>'Out' - when the Pointer that was previously over the Button moves out of it.</li>
<li>'Down' - when the Pointer is pressed down on the Button. I.e. touched on a touch enabled device or clicked with the mouse.</li>
<li>'Up' - when the Pointer that was pressed down on the Button is released again.</li>
</ul>
<p>You can set a unique texture frame and Sound for any of these states.</p></div>
<div class="class-description"><p>Phaser.Button</p></div>
</header>
@ -567,6 +568,17 @@
<dd>
<div class="description">
<p>Create a new <code>Button</code> object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically. The four states a Button responds to are:</p>
<ul>
<li>'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'.</li>
<li>'Out' - when the Pointer that was previously over the Button moves out of it.</li>
<li>'Down' - when the Pointer is pressed down on the Button. I.e. touched on a touch enabled device or clicked with the mouse.</li>
<li>'Up' - when the Pointer that was pressed down on the Button is released again.</li>
</ul>
<p>You can set a unique texture frame and Sound for any of these states.</p>
</div>
@ -1011,7 +1023,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-33">line 33</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-31">line 31</a>
</li></ul></dd>
@ -1266,7 +1278,7 @@ If you wish to work in radians instead of degrees use the property Image.rotatio
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-626">line 626</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-636">line 636</a>
</li></ul></dd>
@ -1927,7 +1939,7 @@ Be advised this is quite an expensive operation, as it has to calculate the boun
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-650">line 650</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-660">line 660</a>
</li></ul></dd>
@ -2038,7 +2050,7 @@ Be advised this is quite an expensive operation, as it has to calculate the boun
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-667">line 667</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-677">line 677</a>
</li></ul></dd>
@ -2149,7 +2161,7 @@ Be advised this is quite an expensive operation, as it has to calculate the boun
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-684">line 684</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-694">line 694</a>
</li></ul></dd>
@ -2256,7 +2268,7 @@ Be advised this is quite an expensive operation, as it has to calculate the boun
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-913">line 913</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-923">line 923</a>
</li></ul></dd>
@ -2586,7 +2598,7 @@ So if this Image was in a Group that has x: 200, then this will be added to the
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-848">line 848</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-858">line 858</a>
</li></ul></dd>
@ -2695,7 +2707,7 @@ So if this Image was in a Group that has x: 200, then this will be added to the
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-188">line 188</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-186">line 186</a>
</li></ul></dd>
@ -2802,7 +2814,7 @@ So if this Image was in a Group that has x: 200, then this will be added to the
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-735">line 735</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-745">line 745</a>
</li></ul></dd>
@ -2909,7 +2921,7 @@ So if this Image was in a Group that has x: 200, then this will be added to the
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-764">line 764</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-774">line 774</a>
</li></ul></dd>
@ -3011,7 +3023,7 @@ So if this Image was in a Group that has x: 200, then this will be added to the
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-181">line 181</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-179">line 179</a>
</li></ul></dd>
@ -3229,7 +3241,7 @@ So if this Image was in a Group that has x: 200, then this will be added to the
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-718">line 718</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-728">line 728</a>
</li></ul></dd>
@ -3451,7 +3463,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-808">line 808</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-818">line 818</a>
</li></ul></dd>
@ -3562,7 +3574,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-701">line 701</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-711">line 711</a>
</li></ul></dd>
@ -3890,7 +3902,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-126">line 126</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-124">line 124</a>
</li></ul></dd>
@ -3992,7 +4004,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-150">line 150</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-148">line 148</a>
</li></ul></dd>
@ -4094,7 +4106,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-171">line 171</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-169">line 169</a>
</li></ul></dd>
@ -4196,7 +4208,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-166">line 166</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-164">line 164</a>
</li></ul></dd>
@ -4298,7 +4310,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-161">line 161</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-159">line 159</a>
</li></ul></dd>
@ -4400,7 +4412,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-176">line 176</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-174">line 174</a>
</li></ul></dd>
@ -4505,7 +4517,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-120">line 120</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-118">line 118</a>
</li></ul></dd>
@ -4607,7 +4619,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-144">line 144</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-142">line 142</a>
</li></ul></dd>
@ -4712,7 +4724,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-108">line 108</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-106">line 106</a>
</li></ul></dd>
@ -4817,7 +4829,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-114">line 114</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-112">line 112</a>
</li></ul></dd>
@ -4919,7 +4931,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-138">line 138</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-136">line 136</a>
</li></ul></dd>
@ -5024,7 +5036,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-132">line 132</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-130">line 130</a>
</li></ul></dd>
@ -5126,7 +5138,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-156">line 156</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-154">line 154</a>
</li></ul></dd>
@ -5233,7 +5245,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-793">line 793</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-803">line 803</a>
</li></ul></dd>
@ -5344,7 +5356,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-879">line 879</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-889">line 889</a>
</li></ul></dd>
@ -5446,7 +5458,7 @@ activated for this object and it will then start to process click/touch events a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-46">line 46</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-44">line 44</a>
</li></ul></dd>
@ -5731,7 +5743,7 @@ bought to the top of that Group, not the entire display list.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-607">line 607</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-617">line 617</a>
</li></ul></dd>
@ -5823,7 +5835,7 @@ bought to the top of that Group, not the entire display list.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-212">line 212</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-210">line 210</a>
</li></ul></dd>
@ -6005,7 +6017,7 @@ Keep this in mind if assigning a rectangle in a for-loop, or when cleaning up fo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-374">line 374</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-384">line 384</a>
</li></ul></dd>
@ -6149,7 +6161,7 @@ and nulls its reference to game, freeing it up for garbage collection.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-507">line 507</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-517">line 517</a>
</li></ul></dd>
@ -6226,7 +6238,7 @@ If you don't need this Image any more you should call Image.destroy instead.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-482">line 482</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-492">line 492</a>
</li></ul></dd>
@ -6549,7 +6561,7 @@ This causes a WebGL texture update, so use sparingly or in low-intensity portion
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-514">line 514</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-512">line 512</a>
</li></ul></dd>
@ -6690,7 +6702,7 @@ This causes a WebGL texture update, so use sparingly or in low-intensity portion
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-488">line 488</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-486">line 486</a>
</li></ul></dd>
@ -6831,7 +6843,7 @@ This causes a WebGL texture update, so use sparingly or in low-intensity portion
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-456">line 456</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-454">line 454</a>
</li></ul></dd>
@ -6972,7 +6984,7 @@ This causes a WebGL texture update, so use sparingly or in low-intensity portion
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-540">line 540</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-538">line 538</a>
</li></ul></dd>
@ -7266,7 +7278,7 @@ This causes a WebGL texture update, so use sparingly or in low-intensity portion
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-584">line 584</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-594">line 594</a>
</li></ul></dd>
@ -7363,7 +7375,7 @@ This causes a WebGL texture update, so use sparingly or in low-intensity portion
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-359">line 359</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-369">line 369</a>
</li></ul></dd>
@ -7439,7 +7451,7 @@ It will dispatch the onRevived event, you can listen to Image.events.onRevived f
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-458">line 458</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-468">line 468</a>
</li></ul></dd>
@ -7623,7 +7635,7 @@ It will dispatch the onRevived event, you can listen to Image.events.onRevived f
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-408">line 408</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-406">line 406</a>
</li></ul></dd>
@ -7747,7 +7759,7 @@ This is primarily an internal method used by Image.loadTexture, although you may
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-303">line 303</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-309">line 309</a>
</li></ul></dd>
@ -7988,7 +8000,7 @@ This is primarily an internal method used by Image.loadTexture, although you may
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-233">line 233</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-231">line 231</a>
</li></ul></dd>
@ -8149,7 +8161,7 @@ This is primarily an internal method used by Image.loadTexture, although you may
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-384">line 384</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-382">line 382</a>
</li></ul></dd>
@ -8310,7 +8322,7 @@ This is primarily an internal method used by Image.loadTexture, although you may
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-360">line 360</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-358">line 358</a>
</li></ul></dd>
@ -8673,7 +8685,7 @@ Call this function with no parameters at all to reset all sounds on this Button.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-336">line 336</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-334">line 334</a>
</li></ul></dd>
@ -8791,7 +8803,7 @@ Call this function with no parameters at all to reset all sounds on this Button.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-591">line 591</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-589">line 589</a>
</li></ul></dd>
@ -8952,7 +8964,7 @@ Call this function with no parameters at all to reset all sounds on this Button.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-432">line 432</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-430">line 430</a>
</li></ul></dd>
@ -9101,7 +9113,7 @@ then you need to update the crop frame by calling this method.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-417">line 417</a>
<a href="Image.js.html">gameobjects/Image.js</a>, <a href="Image.js.html#sunlight-1-line-427">line 427</a>
</li></ul></dd>
@ -9152,7 +9164,7 @@ then you need to update the crop frame by calling this method.</p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:20 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

1268
docs/Phaser.Cache.html
View file

File diff suppressed because it is too large Load diff

150
docs/Phaser.Camera.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -845,7 +853,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-118">line 118</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-123">line 123</a>
</li></ul></dd>
@ -905,7 +913,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-124">line 124</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-129">line 129</a>
</li></ul></dd>
@ -965,7 +973,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-130">line 130</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-135">line 135</a>
</li></ul></dd>
@ -1025,7 +1033,109 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-136">line 136</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-141">line 141</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="_targetPosition"><span class="type-signature"></span>_targetPosition<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>_targetPosition</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
</td>
<td class="description last"><p>Internal point used to calculate target position</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-115">line 115</a>
</li></ul></dd>
@ -1647,7 +1757,7 @@ at all then set this to null. The values can be anything and are in World coordi
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-470">line 470</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-482">line 482</a>
</li></ul></dd>
@ -1858,7 +1968,7 @@ at all then set this to null. The values can be anything and are in World coordi
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-428">line 428</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-440">line 440</a>
</li></ul></dd>
@ -2592,7 +2702,7 @@ Objects outside of this view are not rendered if set to camera cull.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-453">line 453</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-465">line 465</a>
</li></ul></dd>
@ -2800,7 +2910,7 @@ Objects outside of this view are not rendered if set to camera cull.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-382">line 382</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-394">line 394</a>
</li></ul></dd>
@ -2906,7 +3016,7 @@ Objects outside of this view are not rendered if set to camera cull.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-405">line 405</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-417">line 417</a>
</li></ul></dd>
@ -2971,7 +3081,7 @@ Objects outside of this view are not rendered if set to camera cull.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-295">line 295</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-307">line 307</a>
</li></ul></dd>
@ -3089,7 +3199,7 @@ Objects outside of this view are not rendered if set to camera cull.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-194">line 194</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-199">line 199</a>
</li></ul></dd>
@ -3230,7 +3340,7 @@ Objects outside of this view are not rendered if set to camera cull.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-205">line 205</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-210">line 210</a>
</li></ul></dd>
@ -3397,7 +3507,7 @@ Objects outside of this view are not rendered if set to camera cull.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-140">line 140</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-145">line 145</a>
</li></ul></dd>
@ -3466,7 +3576,7 @@ Objects outside of this view are not rendered if set to camera cull.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-365">line 365</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-377">line 377</a>
</li></ul></dd>
@ -3535,7 +3645,7 @@ Objects outside of this view are not rendered if set to camera cull.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-282">line 282</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-294">line 294</a>
</li></ul></dd>
@ -3677,7 +3787,7 @@ without having to use game.camera.x and game.camera.y.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-331">line 331</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-343">line 343</a>
</li></ul></dd>
@ -3818,7 +3928,7 @@ without having to use game.camera.x and game.camera.y.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-351">line 351</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-363">line 363</a>
</li></ul></dd>
@ -3887,7 +3997,7 @@ without having to use game.camera.x and game.camera.y.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-183">line 183</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-188">line 188</a>
</li></ul></dd>
@ -3956,7 +4066,7 @@ without having to use game.camera.x and game.camera.y.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-217">line 217</a>
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-222">line 222</a>
</li></ul></dd>
@ -4007,7 +4117,7 @@ without having to use game.camera.x and game.camera.y.</p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:21 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Canvas.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -3004,7 +3012,7 @@ patchy on earlier browsers, especially on mobile.</p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:21 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

44
docs/Phaser.Circle.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -542,7 +550,7 @@
Circle
</h2>
<div class="class-description"><p>Phaser - Circle</p></div>
<div class="class-description"><p>Phaser.Circle</p></div>
</header>
@ -553,7 +561,7 @@
<dt>
<h4 class="name" id="Circle"><span class="type-signature"></span>new Circle<span class="signature">(<span class="optional">x</span>, <span class="optional">y</span>, <span class="optional">diameter</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Circle.html">Phaser.Circle</a>}</span></h4>
<h4 class="name" id="Circle"><span class="type-signature"></span>new Circle<span class="signature">(<span class="optional">x</span>, <span class="optional">y</span>, <span class="optional">diameter</span>)</span><span class="type-signature"></span></h4>
</dt>
@ -561,7 +569,8 @@
<div class="description">
<p>Creates a new Circle object with the center coordinate specified by the x and y parameters and the diameter specified by the diameter parameter. If you call this function without parameters, a circle with x, y, diameter and radius properties set to 0 is created.</p>
<p>Creates a new Circle object with the center coordinate specified by the x and y parameters and the diameter specified by the diameter parameter.
If you call this function without parameters, a circle with x, y, diameter and radius properties set to 0 is created.</p>
</div>
@ -762,29 +771,6 @@
<h5>Returns:</h5>
<div class="param-desc">
<p>This circle object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Circle.html">Phaser.Circle</a></span>
</dd>
</dl>
</dd>
@ -1535,7 +1521,7 @@ If set to true it will reset all of the Circle objects properties to 0. A Circle
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Polygon.js.html">geom/Polygon.js</a>, <a href="Polygon.js.html#sunlight-1-line-143">line 143</a>
<a href="Polygon.js.html">geom/Polygon.js</a>, <a href="Polygon.js.html#sunlight-1-line-142">line 142</a>
</li></ul></dd>
@ -4319,7 +4305,7 @@ This method checks the radius distances between the two Circle objects to see if
<td class="description last"><p>The diameter of the circle in pixels.</p></td>
<td class="description last"><p>The diameter of the circle.</p></td>
</tr>
@ -4517,7 +4503,7 @@ This method checks the radius distances between the two Circle objects to see if
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:21 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

236
docs/Phaser.Color.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -728,7 +736,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-583">line 583</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-618">line 618</a>
</li></ul></dd>
@ -1504,7 +1512,7 @@ This does not rely on endianness.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-818">line 818</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-853">line 853</a>
</li></ul></dd>
@ -1645,7 +1653,7 @@ This does not rely on endianness.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-830">line 830</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-865">line 865</a>
</li></ul></dd>
@ -1786,7 +1794,7 @@ This does not rely on endianness.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-866">line 866</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-901">line 901</a>
</li></ul></dd>
@ -1973,7 +1981,7 @@ This does not rely on endianness.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-483">line 483</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-484">line 484</a>
</li></ul></dd>
@ -2183,7 +2191,7 @@ This does not rely on endianness.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-466">line 466</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-467">line 467</a>
</li></ul></dd>
@ -2324,7 +2332,7 @@ This does not rely on endianness.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-854">line 854</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-889">line 889</a>
</li></ul></dd>
@ -2513,7 +2521,7 @@ Set the max value to restrict the maximum color used per channel.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-722">line 722</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-757">line 757</a>
</li></ul></dd>
@ -2654,7 +2662,7 @@ Set the max value to restrict the maximum color used per channel.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-842">line 842</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-877">line 877</a>
</li></ul></dd>
@ -2796,7 +2804,7 @@ Set the max value to restrict the maximum color used per channel.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-754">line 754</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-789">line 789</a>
</li></ul></dd>
@ -2940,7 +2948,7 @@ Set the max value to restrict the maximum color used per channel.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-796">line 796</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-831">line 831</a>
</li></ul></dd>
@ -3092,7 +3100,7 @@ Set the max value to restrict the maximum color used per channel.</p>
<td class="description last"><p>An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.</p></td>
<td class="description last"><p>An object into which 3 properties will be created or set: r, g and b. If not provided a new object will be created.</p></td>
</tr>
@ -3124,7 +3132,7 @@ Set the max value to restrict the maximum color used per channel.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-547">line 547</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-548">line 548</a>
</li></ul></dd>
@ -3265,7 +3273,7 @@ Set the max value to restrict the maximum color used per channel.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-528">line 528</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-529">line 529</a>
</li></ul></dd>
@ -3465,7 +3473,7 @@ Set the max value to restrict the maximum color used per channel.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-623">line 623</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-658">line 658</a>
</li></ul></dd>
@ -3914,7 +3922,7 @@ Based on code by Michael Jackson (<a href="https://github.com/mjijackson">https:
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-598">line 598</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-633">line 633</a>
</li></ul></dd>
@ -4584,7 +4592,7 @@ Based on code by Michael Jackson (<a href="https://github.com/mjijackson">https:
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-648">line 648</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-683">line 683</a>
</li></ul></dd>
@ -4840,7 +4848,7 @@ Based on code by Michael Jackson (<a href="https://github.com/mjijackson">https:
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-674">line 674</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-709">line 709</a>
</li></ul></dd>
@ -5142,7 +5150,7 @@ Based on code by Michael Jackson (<a href="https://github.com/mjijackson">https:
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-698">line 698</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-733">line 733</a>
</li></ul></dd>
@ -6164,7 +6172,7 @@ If prefix was '#' it will be in the format <code>#RRGGBB</code> otherwise <code>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-499">line 499</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-500">line 500</a>
</li></ul></dd>
@ -6807,7 +6815,7 @@ endian-independent method, use fromRGBA(rgba) and toRGBA(r, g, b, a).</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-450">line 450</a>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-451">line 451</a>
</li></ul></dd>
@ -6853,6 +6861,190 @@ endian-independent method, use fromRGBA(rgba) and toRGBA(r, g, b, a).</p>
</dd>
<dt>
<h4 class="name" id="webToColor"><span class="type-signature">&lt;static> </span>webToColor<span class="signature">(web, <span class="optional">out</span>)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Converts a CSS 'web' string into a Phaser Color object.</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>web</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The web string in the format: 'rgba(r,g,b,a)'</p></td>
</tr>
<tr>
<td class="name"><code>out</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>An object into which 3 properties will be created: r, g and b. If not provided a new object will be created.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Color.js.html">utils/Color.js</a>, <a href="Color.js.html#sunlight-1-line-588">line 588</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An object with the red, green and blue values set in the r, g and b properties.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd>
</dl>
@ -6881,7 +7073,7 @@ endian-independent method, use fromRGBA(rgba) and toRGBA(r, g, b, a).</p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:21 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

144
docs/Phaser.Device.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -594,7 +602,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-14">line 14</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-13">line 13</a>
</li></ul></dd>
@ -725,7 +733,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-81">line 81</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-80">line 80</a>
</li></ul></dd>
@ -830,7 +838,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-205">line 205</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-204">line 204</a>
</li></ul></dd>
@ -935,7 +943,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-291">line 291</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-290">line 290</a>
</li></ul></dd>
@ -1037,7 +1045,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-390">line 390</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-389">line 389</a>
</li></ul></dd>
@ -1142,7 +1150,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-119">line 119</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-118">line 118</a>
</li></ul></dd>
@ -1247,7 +1255,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-211">line 211</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-210">line 210</a>
</li></ul></dd>
@ -1352,7 +1360,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-87">line 87</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-86">line 86</a>
</li></ul></dd>
@ -1457,7 +1465,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-39">line 39</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-38">line 38</a>
</li></ul></dd>
@ -1562,7 +1570,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-45">line 45</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-44">line 44</a>
</li></ul></dd>
@ -1667,7 +1675,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-51">line 51</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-50">line 50</a>
</li></ul></dd>
@ -1772,7 +1780,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-75">line 75</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-74">line 74</a>
</li></ul></dd>
@ -1877,7 +1885,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-167">line 167</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-166">line 166</a>
</li></ul></dd>
@ -1982,7 +1990,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-27">line 27</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-26">line 26</a>
</li></ul></dd>
@ -2087,7 +2095,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-69">line 69</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-68">line 68</a>
</li></ul></dd>
@ -2192,7 +2200,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-217">line 217</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-216">line 216</a>
</li></ul></dd>
@ -2297,7 +2305,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-125">line 125</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-124">line 124</a>
</li></ul></dd>
@ -2402,7 +2410,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-131">line 131</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-130">line 130</a>
</li></ul></dd>
@ -2507,7 +2515,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-223">line 223</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-222">line 222</a>
</li></ul></dd>
@ -2612,7 +2620,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-378">line 378</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-377">line 377</a>
</li></ul></dd>
@ -2717,7 +2725,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-396">line 396</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-395">line 395</a>
</li></ul></dd>
@ -2819,7 +2827,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-19">line 19</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-18">line 18</a>
</li></ul></dd>
@ -2924,7 +2932,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-191">line 191</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-190">line 190</a>
</li></ul></dd>
@ -3029,7 +3037,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-229">line 229</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-228">line 228</a>
</li></ul></dd>
@ -3134,7 +3142,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-235">line 235</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-234">line 234</a>
</li></ul></dd>
@ -3239,7 +3247,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-33">line 33</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-32">line 32</a>
</li></ul></dd>
@ -3344,7 +3352,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-354">line 354</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-353">line 353</a>
</li></ul></dd>
@ -3449,7 +3457,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-342">line 342</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-341">line 341</a>
</li></ul></dd>
@ -3554,7 +3562,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-348">line 348</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-347">line 347</a>
</li></ul></dd>
@ -3659,7 +3667,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-93">line 93</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-92">line 92</a>
</li></ul></dd>
@ -3764,7 +3772,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-366">line 366</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-365">line 365</a>
</li></ul></dd>
@ -3869,7 +3877,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-137">line 137</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-136">line 136</a>
</li></ul></dd>
@ -3978,7 +3986,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-328">line 328</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-327">line 327</a>
</li></ul></dd>
@ -4083,7 +4091,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-99">line 99</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-98">line 98</a>
</li></ul></dd>
@ -4188,7 +4196,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-259">line 259</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-258">line 258</a>
</li></ul></dd>
@ -4293,7 +4301,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-253">line 253</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-252">line 252</a>
</li></ul></dd>
@ -4398,7 +4406,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-315">line 315</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-314">line 314</a>
</li></ul></dd>
@ -4503,7 +4511,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-161">line 161</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-160">line 160</a>
</li></ul></dd>
@ -4608,7 +4616,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-57">line 57</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-56">line 56</a>
</li></ul></dd>
@ -4713,7 +4721,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-63">line 63</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-62">line 62</a>
</li></ul></dd>
@ -4818,7 +4826,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-303">line 303</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-302">line 302</a>
</li></ul></dd>
@ -4923,7 +4931,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-265">line 265</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-264">line 264</a>
</li></ul></dd>
@ -5028,7 +5036,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-309">line 309</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-308">line 308</a>
</li></ul></dd>
@ -5133,7 +5141,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-360">line 360</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-359">line 359</a>
</li></ul></dd>
@ -5238,7 +5246,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-173">line 173</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-172">line 172</a>
</li></ul></dd>
@ -5343,7 +5351,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-197">line 197</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-196">line 196</a>
</li></ul></dd>
@ -5445,7 +5453,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-384">line 384</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-383">line 383</a>
</li></ul></dd>
@ -5550,7 +5558,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-271">line 271</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-270">line 270</a>
</li></ul></dd>
@ -5655,7 +5663,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-283">line 283</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-282">line 282</a>
</li></ul></dd>
@ -5760,7 +5768,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-372">line 372</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-371">line 371</a>
</li></ul></dd>
@ -5865,7 +5873,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-155">line 155</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-154">line 154</a>
</li></ul></dd>
@ -5970,7 +5978,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-241">line 241</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-240">line 240</a>
</li></ul></dd>
@ -6075,7 +6083,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-247">line 247</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-246">line 246</a>
</li></ul></dd>
@ -6180,7 +6188,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-179">line 179</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-178">line 178</a>
</li></ul></dd>
@ -6285,7 +6293,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-185">line 185</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-184">line 184</a>
</li></ul></dd>
@ -6390,7 +6398,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-321">line 321</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-320">line 320</a>
</li></ul></dd>
@ -6495,7 +6503,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-277">line 277</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-276">line 276</a>
</li></ul></dd>
@ -6600,7 +6608,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-297">line 297</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-296">line 296</a>
</li></ul></dd>
@ -6705,7 +6713,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-143">line 143</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-142">line 142</a>
</li></ul></dd>
@ -6810,7 +6818,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-334">line 334</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-333">line 333</a>
</li></ul></dd>
@ -6915,7 +6923,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-105">line 105</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-104">line 104</a>
</li></ul></dd>
@ -7020,7 +7028,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-111">line 111</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-110">line 110</a>
</li></ul></dd>
@ -7125,7 +7133,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-149">line 149</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-148">line 148</a>
</li></ul></dd>
@ -7239,7 +7247,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-877">line 877</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-876">line 876</a>
</li></ul></dd>
@ -7331,7 +7339,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-522">line 522</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-521">line 521</a>
</li></ul></dd>
@ -7402,7 +7410,7 @@ Usage: var defaultRenderingMode = Phaser.Device.isAndroidStockBrowser() ? Phaser
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-949">line 949</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-948">line 948</a>
</li></ul></dd>
@ -7473,7 +7481,7 @@ It used to work in Chrome, but then they removed the ability: <a href="http://sr
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-910">line 910</a>
<a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-909">line 909</a>
</li></ul></dd>
@ -7547,7 +7555,7 @@ It used to work in Chrome, but then they removed the ability: <a href="http://sr
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:22 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Back.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1084,7 +1092,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:22 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Bounce.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1084,7 +1092,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:22 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Circular.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1084,7 +1092,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:23 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Cubic.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1084,7 +1092,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:23 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Elastic.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1084,7 +1092,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:23 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Exponential.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1084,7 +1092,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:23 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:51 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Linear.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -802,7 +810,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:23 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:51 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Quadratic.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1084,7 +1092,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:23 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:51 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Quartic.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1084,7 +1092,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:23 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:51 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Quintic.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1084,7 +1092,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:24 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:51 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.Sinusoidal.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1084,7 +1092,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:24 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:51 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Easing.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -751,7 +759,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:22 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

75
docs/Phaser.Ellipse.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -542,7 +550,7 @@
Ellipse
</h2>
<div class="class-description"><p>Phaser - Ellipse</p></div>
<div class="class-description"><p>Phaser.Ellipse</p></div>
</header>
@ -553,7 +561,7 @@
<dt>
<h4 class="name" id="Ellipse"><span class="type-signature"></span>new Ellipse<span class="signature">(<span class="optional">x</span>, <span class="optional">y</span>, <span class="optional">width</span>, <span class="optional">height</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Ellipse.html">Phaser.Ellipse</a>}</span></h4>
<h4 class="name" id="Ellipse"><span class="type-signature"></span>new Ellipse<span class="signature">(<span class="optional">x</span>, <span class="optional">y</span>, <span class="optional">width</span>, <span class="optional">height</span>)</span><span class="type-signature"></span></h4>
</dt>
@ -780,7 +788,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-19">line 19</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-18">line 18</a>
</li></ul></dd>
@ -801,29 +809,6 @@
<h5>Returns:</h5>
<div class="param-desc">
<p>This Ellipse object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Ellipse.html">Phaser.Ellipse</a></span>
</dd>
</dl>
</dd>
@ -935,7 +920,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-209">line 209</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-208">line 208</a>
</li></ul></dd>
@ -1042,7 +1027,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-234">line 234</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-233">line 233</a>
</li></ul></dd>
@ -1144,7 +1129,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-46">line 46</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-45">line 45</a>
</li></ul></dd>
@ -1198,7 +1183,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-148">line 148</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-147">line 147</a>
</li></ul></dd>
@ -1304,7 +1289,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-167">line 167</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-166">line 166</a>
</li></ul></dd>
@ -1410,7 +1395,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-192">line 192</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-191">line 191</a>
</li></ul></dd>
@ -1512,7 +1497,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-41">line 41</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-40">line 40</a>
</li></ul></dd>
@ -1614,7 +1599,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-31">line 31</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-30">line 30</a>
</li></ul></dd>
@ -1716,7 +1701,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-36">line 36</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-35">line 35</a>
</li></ul></dd>
@ -1876,7 +1861,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-257">line 257</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-256">line 256</a>
</li></ul></dd>
@ -1968,7 +1953,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-283">line 283</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-282">line 282</a>
</li></ul></dd>
@ -2109,7 +2094,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-101">line 101</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-100">line 100</a>
</li></ul></dd>
@ -2273,7 +2258,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-122">line 122</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-121">line 121</a>
</li></ul></dd>
@ -2414,7 +2399,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-72">line 72</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-71">line 71</a>
</li></ul></dd>
@ -2473,7 +2458,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<div class="description">
<p>Copies the x, y and diameter properties from this Circle to any given object.</p>
<p>Copies the x, y, width and height properties from this Ellipse to any given object.</p>
</div>
@ -2555,7 +2540,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-84">line 84</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-83">line 83</a>
</li></ul></dd>
@ -2765,7 +2750,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-52">line 52</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-51">line 51</a>
</li></ul></dd>
@ -2857,7 +2842,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-135">line 135</a>
<a href="Ellipse.js.html">geom/Ellipse.js</a>, <a href="Ellipse.js.html#sunlight-1-line-134">line 134</a>
</li></ul></dd>
@ -2931,7 +2916,7 @@ If set to true it will reset all of the Ellipse objects properties to 0. An Elli
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:24 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:52 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

60
docs/Phaser.Events.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -542,11 +550,7 @@
Events
</h2>
<div class="class-description"><p>The Events component is a collection of events fired by the parent game object.</p>
<p>For example to tell when a Sprite has been added to a new group:</p>
<p><code>sprite.events.onAddedToGroup.add(yourFunction, this);</code></p>
<p>Where <code>yourFunction</code> is the function you want called when this event occurs.</p>
<p>Note that the Input related events only exist if the Sprite has had <code>inputEnabled</code> set to <code>true</code>.</p></div>
<div class="class-description"><p>Phaser.Events</p></div>
</header>
@ -564,6 +568,14 @@
<dd>
<div class="description">
<p>The Events component is a collection of events fired by the parent game object.</p>
<p>For example to tell when a Sprite has been added to a new group:</p>
<p><code>sprite.events.onAddedToGroup.add(yourFunction, this);</code></p>
<p>Where <code>yourFunction</code> is the function you want called when this event occurs.</p>
<p>Note that the Input related events only exist if the Sprite has had <code>inputEnabled</code> set to <code>true</code>.</p>
</div>
@ -643,7 +655,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-24">line 24</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-22">line 22</a>
</li></ul></dd>
@ -771,7 +783,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-34">line 34</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-32">line 32</a>
</li></ul></dd>
@ -876,7 +888,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-112">line 112</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-110">line 110</a>
</li></ul></dd>
@ -981,7 +993,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-118">line 118</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-116">line 116</a>
</li></ul></dd>
@ -1086,7 +1098,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-106">line 106</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-104">line 104</a>
</li></ul></dd>
@ -1188,7 +1200,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-44">line 44</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-42">line 42</a>
</li></ul></dd>
@ -1293,7 +1305,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-94">line 94</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-92">line 92</a>
</li></ul></dd>
@ -1398,7 +1410,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-100">line 100</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-98">line 98</a>
</li></ul></dd>
@ -1500,7 +1512,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-64">line 64</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-62">line 62</a>
</li></ul></dd>
@ -1605,7 +1617,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-82">line 82</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-80">line 80</a>
</li></ul></dd>
@ -1710,7 +1722,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-76">line 76</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-74">line 74</a>
</li></ul></dd>
@ -1815,7 +1827,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-70">line 70</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-68">line 68</a>
</li></ul></dd>
@ -1920,7 +1932,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-88">line 88</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-86">line 86</a>
</li></ul></dd>
@ -2022,7 +2034,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-49">line 49</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-47">line 47</a>
</li></ul></dd>
@ -2124,7 +2136,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-59">line 59</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-57">line 57</a>
</li></ul></dd>
@ -2226,7 +2238,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-39">line 39</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-37">line 37</a>
</li></ul></dd>
@ -2328,7 +2340,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-54">line 54</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-52">line 52</a>
</li></ul></dd>
@ -2430,7 +2442,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-29">line 29</a>
<a href="Events.js.html">gameobjects/Events.js</a>, <a href="Events.js.html#sunlight-1-line-27">line 27</a>
</li></ul></dd>
@ -2473,7 +2485,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:24 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:52 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

38
docs/Phaser.Filter.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -542,7 +550,7 @@
Filter
</h2>
<div class="class-description"><p>Phaser - Filter</p></div>
<div class="class-description"><p>Phaser.Filter</p></div>
</header>
@ -689,7 +697,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-17">line 17</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-16">line 16</a>
</li></ul></dd>
@ -820,7 +828,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-48">line 48</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-47">line 47</a>
</li></ul></dd>
@ -922,7 +930,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-70">line 70</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-69">line 69</a>
</li></ul></dd>
@ -1024,7 +1032,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-22">line 22</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-21">line 21</a>
</li></ul></dd>
@ -1126,7 +1134,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-151">line 151</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-150">line 150</a>
</li></ul></dd>
@ -1231,7 +1239,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-54">line 54</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-53">line 53</a>
</li></ul></dd>
@ -1333,7 +1341,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-28">line 28</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-27">line 27</a>
</li></ul></dd>
@ -1435,7 +1443,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-59">line 59</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-58">line 58</a>
</li></ul></dd>
@ -1537,7 +1545,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-135">line 135</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-134">line 134</a>
</li></ul></dd>
@ -1602,7 +1610,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-121">line 121</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-120">line 120</a>
</li></ul></dd>
@ -1671,7 +1679,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-76">line 76</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-75">line 75</a>
</li></ul></dd>
@ -1812,7 +1820,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-84">line 84</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-83">line 83</a>
</li></ul></dd>
@ -1942,7 +1950,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-97">line 97</a>
<a href="Filter.js.html">core/Filter.js</a>, <a href="Filter.js.html#sunlight-1-line-96">line 96</a>
</li></ul></dd>
@ -1993,7 +2001,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:24 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:52 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

18
docs/Phaser.FlexGrid.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -941,7 +949,7 @@ to provide for game object positioning in a responsive manner.</p>
<dt>
<h4 class="name" id="positionFluid"><span class="type-signature">&lt;readonly> </span>positionFluid<span class="type-signature"></span></h4>
<h4 class="name" id="positionCustom"><span class="type-signature">&lt;readonly> </span>positionCustom<span class="type-signature"></span></h4>
</dt>
@ -1025,7 +1033,7 @@ to provide for game object positioning in a responsive manner.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="FlexGrid.js.html">core/FlexGrid.js</a>, <a href="FlexGrid.js.html#sunlight-1-line-45">line 45</a>
<a href="FlexGrid.js.html">core/FlexGrid.js</a>, <a href="FlexGrid.js.html#sunlight-1-line-46">line 46</a>
</li></ul></dd>
@ -1043,7 +1051,7 @@ to provide for game object positioning in a responsive manner.</p>
<dt>
<h4 class="name" id="scaleFluid"><span class="type-signature">&lt;readonly> </span>scaleFluid<span class="type-signature"></span></h4>
<h4 class="name" id="scaleCustom"><span class="type-signature">&lt;readonly> </span>scaleCustom<span class="type-signature"></span></h4>
</dt>
@ -1127,7 +1135,7 @@ to provide for game object positioning in a responsive manner.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="FlexGrid.js.html">core/FlexGrid.js</a>, <a href="FlexGrid.js.html#sunlight-1-line-53">line 53</a>
<a href="FlexGrid.js.html">core/FlexGrid.js</a>, <a href="FlexGrid.js.html#sunlight-1-line-55">line 55</a>
</li></ul></dd>
@ -1170,7 +1178,7 @@ to provide for game object positioning in a responsive manner.</p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:24 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:52 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

551
docs/Phaser.FlexLayer.html
View file

File diff suppressed because it is too large Load diff

10
docs/Phaser.Frame.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -3426,7 +3434,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:25 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:53 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.FrameData.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -2016,7 +2024,7 @@ The frames are returned in the output array, or if none is provided in a new Arr
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:25 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:53 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

137
docs/Phaser.Game.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -542,10 +550,7 @@
Game
</h2>
<div class="class-description"><p>This is where the magic happens. The Game object is the heart of your game,
providing quick access to common functions and handling the boot process.
&quot;Hell, there are no rules here - we're trying to accomplish something.&quot;
Thomas A. Edison</p></div>
<div class="class-description"><p>Phaser.Game</p></div>
</header>
@ -564,8 +569,10 @@ providing quick access to common functions and handling the boot process.
<div class="description">
<p>Game constructor</p>
<p>Instantiate a new &lt;code&gt;Phaser.Game&lt;/code&gt; object.</p>
<p>This is where the magic happens. The Game object is the heart of your game,
providing quick access to common functions and handling the boot process.
&quot;Hell, there are no rules here - we're trying to accomplish something.&quot;
Thomas A. Edison</p>
</div>
@ -949,7 +956,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-26">line 26</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-24">line 24</a>
</li></ul></dd>
@ -1077,7 +1084,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-114">line 114</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-112">line 112</a>
</li></ul></dd>
@ -1182,7 +1189,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-71">line 71</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-69">line 69</a>
</li></ul></dd>
@ -1284,7 +1291,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-124">line 124</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-122">line 122</a>
</li></ul></dd>
@ -1386,7 +1393,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-194">line 194</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-192">line 192</a>
</li></ul></dd>
@ -1488,7 +1495,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-199">line 199</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-197">line 197</a>
</li></ul></dd>
@ -1590,7 +1597,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-36">line 36</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-34">line 34</a>
</li></ul></dd>
@ -1692,7 +1699,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-204">line 204</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-202">line 202</a>
</li></ul></dd>
@ -1794,7 +1801,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-209">line 209</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-207">line 207</a>
</li></ul></dd>
@ -1896,7 +1903,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-189">line 189</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-187">line 187</a>
</li></ul></dd>
@ -2001,7 +2008,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-59">line 59</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-57">line 57</a>
</li></ul></dd>
@ -2103,7 +2110,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-31">line 31</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-29">line 29</a>
</li></ul></dd>
@ -2205,7 +2212,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-129">line 129</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-127">line 127</a>
</li></ul></dd>
@ -2310,7 +2317,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-98">line 98</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-96">line 96</a>
</li></ul></dd>
@ -2415,7 +2422,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-104">line 104</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-102">line 102</a>
</li></ul></dd>
@ -2517,7 +2524,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-134">line 134</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-132">line 132</a>
</li></ul></dd>
@ -2619,7 +2626,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-119">line 119</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-117">line 117</a>
</li></ul></dd>
@ -2721,7 +2728,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-139">line 139</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-137">line 137</a>
</li></ul></dd>
@ -2823,7 +2830,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-144">line 144</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-142">line 142</a>
</li></ul></dd>
@ -2925,7 +2932,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-250">line 250</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-248">line 248</a>
</li></ul></dd>
@ -3027,7 +3034,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-255">line 255</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-253">line 253</a>
</li></ul></dd>
@ -3129,7 +3136,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-240">line 240</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-238">line 238</a>
</li></ul></dd>
@ -3231,7 +3238,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-245">line 245</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-243">line 243</a>
</li></ul></dd>
@ -3336,7 +3343,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-47">line 47</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-45">line 45</a>
</li></ul></dd>
@ -3438,7 +3445,7 @@ providing quick access to common functions and handling the boot process.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-214">line 214</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-212">line 212</a>
</li></ul></dd>
@ -3545,7 +3552,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-867">line 867</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-865">line 865</a>
</li></ul></dd>
@ -3650,7 +3657,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-228">line 228</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-226">line 226</a>
</li></ul></dd>
@ -3752,7 +3759,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-179">line 179</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-177">line 177</a>
</li></ul></dd>
@ -3854,7 +3861,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-41">line 41</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-39">line 39</a>
</li></ul></dd>
@ -3959,7 +3966,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-77">line 77</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-75">line 75</a>
</li></ul></dd>
@ -4061,7 +4068,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-109">line 109</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-107">line 107</a>
</li></ul></dd>
@ -4166,7 +4173,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-82">line 82</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-80">line 80</a>
</li></ul></dd>
@ -4268,7 +4275,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-87">line 87</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-85">line 85</a>
</li></ul></dd>
@ -4370,7 +4377,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-184">line 184</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-182">line 182</a>
</li></ul></dd>
@ -4472,7 +4479,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-149">line 149</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-147">line 147</a>
</li></ul></dd>
@ -4574,7 +4581,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-154">line 154</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-152">line 152</a>
</li></ul></dd>
@ -4676,7 +4683,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-159">line 159</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-157">line 157</a>
</li></ul></dd>
@ -4778,7 +4785,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-92">line 92</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-90">line 90</a>
</li></ul></dd>
@ -4883,7 +4890,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-235">line 235</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-233">line 233</a>
</li></ul></dd>
@ -4988,7 +4995,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-221">line 221</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-219">line 219</a>
</li></ul></dd>
@ -5090,7 +5097,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-164">line 164</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-162">line 162</a>
</li></ul></dd>
@ -5195,7 +5202,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-65">line 65</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-63">line 63</a>
</li></ul></dd>
@ -5297,7 +5304,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-169">line 169</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-167">line 167</a>
</li></ul></dd>
@ -5402,7 +5409,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-53">line 53</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-51">line 51</a>
</li></ul></dd>
@ -5504,7 +5511,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-174">line 174</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-172">line 172</a>
</li></ul></dd>
@ -5569,7 +5576,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-417">line 417</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-415">line 415</a>
</li></ul></dd>
@ -5638,7 +5645,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-755">line 755</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-753">line 753</a>
</li></ul></dd>
@ -5707,7 +5714,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-730">line 730</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-728">line 728</a>
</li></ul></dd>
@ -5777,7 +5784,7 @@ Calling step will advance the game loop by one frame. This is extremely useful f
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-716">line 716</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-714">line 714</a>
</li></ul></dd>
@ -5895,7 +5902,7 @@ Calling step will advance the game loop by one frame. This is extremely useful f
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-845">line 845</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-843">line 843</a>
</li></ul></dd>
@ -6013,7 +6020,7 @@ Calling step will advance the game loop by one frame. This is extremely useful f
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-827">line 827</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-825">line 825</a>
</li></ul></dd>
@ -6131,7 +6138,7 @@ Calling step will advance the game loop by one frame. This is extremely useful f
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-786">line 786</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-784">line 784</a>
</li></ul></dd>
@ -6249,7 +6256,7 @@ Calling step will advance the game loop by one frame. This is extremely useful f
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-806">line 806</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-804">line 804</a>
</li></ul></dd>
@ -6318,7 +6325,7 @@ Calling step will advance the game loop by one frame. This is extremely useful f
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-342">line 342</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-340">line 340</a>
</li></ul></dd>
@ -6387,7 +6394,7 @@ Calling step will advance the game loop by one frame. This is extremely useful f
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-565">line 565</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-563">line 563</a>
</li></ul></dd>
@ -6456,7 +6463,7 @@ Calling step will advance the game loop by one frame. This is extremely useful f
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-503">line 503</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-501">line 501</a>
</li></ul></dd>
@ -6526,7 +6533,7 @@ This is extremely useful to hard to track down errors! Use the internal stepCoun
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-742">line 742</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-740">line 740</a>
</li></ul></dd>
@ -6644,7 +6651,7 @@ This is extremely useful to hard to track down errors! Use the internal stepCoun
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-646">line 646</a>
<a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-644">line 644</a>
</li></ul></dd>
@ -6695,7 +6702,7 @@ This is extremely useful to hard to track down errors! Use the internal stepCoun
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:25 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:53 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

177
docs/Phaser.GameObjectCreator.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1167,6 +1175,147 @@ Use the GameObjectFactory to create and add the objects into the world.</p>
</dd>
<dt>
<h4 class="name" id="audioSprite"><span class="type-signature"></span>audioSprite<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a new AudioSprite object.</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>The Game.cache key of the sound that this object will use.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-128">line 128</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The newly created AudioSprite object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>
</dd>
</dl>
</dd>
@ -1399,7 +1548,7 @@ Use the GameObjectFactory to create and add the objects into the world.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-337">line 337</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-350">line 350</a>
</li></ul></dd>
@ -1678,7 +1827,7 @@ Use the GameObjectFactory to create and add the objects into the world.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-274">line 274</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-287">line 287</a>
</li></ul></dd>
@ -2107,7 +2256,7 @@ Use the GameObjectFactory to create and add the objects into the world.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-196">line 196</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-209">line 209</a>
</li></ul></dd>
@ -2348,7 +2497,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-231">line 231</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-244">line 244</a>
</li></ul></dd>
@ -2512,7 +2661,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-363">line 363</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-376">line 376</a>
</li></ul></dd>
@ -2676,7 +2825,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-217">line 217</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-230">line 230</a>
</li></ul></dd>
@ -3523,7 +3672,7 @@ It can still rotate, scale, crop and receive input events. This makes it perfect
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-311">line 311</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-324">line 324</a>
</li></ul></dd>
@ -3981,7 +4130,7 @@ i.e. if you need each Image to have different text in it, then you need to creat
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-248">line 248</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-261">line 261</a>
</li></ul></dd>
@ -4249,7 +4398,7 @@ i.e. if you need each Image to have different text in it, then you need to creat
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-162">line 162</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-175">line 175</a>
</li></ul></dd>
@ -4523,7 +4672,7 @@ i.e. if you need each Image to have different text in it, then you need to creat
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-128">line 128</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-141">line 141</a>
</li></ul></dd>
@ -5223,7 +5372,7 @@ i.e. if you need each Image to have different text in it, then you need to creat
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-180">line 180</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-193">line 193</a>
</li></ul></dd>
@ -5542,7 +5691,7 @@ Note that all Tilemaps use a base tile size to calculate dimensions from, but th
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-291">line 291</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-304">line 304</a>
</li></ul></dd>
@ -5787,7 +5936,7 @@ Note that all Tilemaps use a base tile size to calculate dimensions from, but th
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-144">line 144</a>
<a href="GameObjectCreator.js.html">gameobjects/GameObjectCreator.js</a>, <a href="GameObjectCreator.js.html#sunlight-1-line-157">line 157</a>
</li></ul></dd>
@ -6002,7 +6151,7 @@ Note that all Tilemaps use a base tile size to calculate dimensions from, but th
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:26 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:53 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

177
docs/Phaser.GameObjectFactory.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -1166,6 +1174,147 @@
</dd>
<dt>
<h4 class="name" id="audioSprite"><span class="type-signature"></span>audioSprite<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a new AudioSprite object.</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>The Game.cache key of the sound that this object will use.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-182">line 182</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The newly created AudioSprite object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></span>
</dd>
</dl>
</dd>
@ -1398,7 +1547,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-394">line 394</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-407">line 407</a>
</li></ul></dd>
@ -1710,7 +1859,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-327">line 327</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-340">line 340</a>
</li></ul></dd>
@ -2172,7 +2321,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-243">line 243</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-256">line 256</a>
</li></ul></dd>
@ -2413,7 +2562,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-284">line 284</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-297">line 297</a>
</li></ul></dd>
@ -2718,7 +2867,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-420">line 420</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-433">line 433</a>
</li></ul></dd>
@ -2933,7 +3082,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-267">line 267</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-280">line 280</a>
</li></ul></dd>
@ -4003,7 +4152,7 @@ The Plugin must have 2 properties: game and parent. Plugin.game is set to the ga
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-440">line 440</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-453">line 453</a>
</li></ul></dd>
@ -4281,7 +4430,7 @@ The Plugin must have 2 properties: game and parent. Plugin.game is set to the ga
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-368">line 368</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-381">line 381</a>
</li></ul></dd>
@ -4739,7 +4888,7 @@ i.e. if you need each Image to have different text in it, then you need to creat
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-301">line 301</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-314">line 314</a>
</li></ul></dd>
@ -5090,7 +5239,7 @@ i.e. if you need each Image to have different text in it, then you need to creat
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-203">line 203</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-216">line 216</a>
</li></ul></dd>
@ -6169,7 +6318,7 @@ The speed gains are specifically for WebGL. In Canvas mode you won't see any rea
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-224">line 224</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-237">line 237</a>
</li></ul></dd>
@ -6488,7 +6637,7 @@ Note that all Tilemaps use a base tile size to calculate dimensions from, but th
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-347">line 347</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-360">line 360</a>
</li></ul></dd>
@ -6839,7 +6988,7 @@ Note that all Tilemaps use a base tile size to calculate dimensions from, but th
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-182">line 182</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-195">line 195</a>
</li></ul></dd>
@ -7054,7 +7203,7 @@ Note that all Tilemaps use a base tile size to calculate dimensions from, but th
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:26 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:54 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

10
docs/Phaser.Gamepad.html
View file

@ -58,6 +58,10 @@
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
@ -258,6 +262,10 @@
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
@ -3409,7 +3417,7 @@ This MUST be called manually before Phaser will start polling the Gamepad API.</
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Tue Sep 09 2014 15:29:26 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Oct 09 2014 16:09:54 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>

Some files were not shown because too many files have changed in this diff Show more