Tidying up the repo and adding in new documentation.

This commit is contained in:
photonstorm 2013-10-23 14:00:28 +01:00
parent 4a51ac4671
commit ffd5ddc534
375 changed files with 4617 additions and 32924 deletions

View file

@ -382,6 +382,11 @@ Phaser.Animation = function (game, parent, name, frameData, frames, delay, loope
*/ */
this.looped = looped; this.looped = looped;
/**
* @property {boolean} looped - The loop state of the Animation.
*/
this.killOnComplete = false;
/** /**
* @property {boolean} isFinished - The finished state of the Animation. Set to true once playback completes, false during playback. * @property {boolean} isFinished - The finished state of the Animation. Set to true once playback completes, false during playback.
* @default * @default
@ -443,10 +448,11 @@ Phaser.Animation.prototype = {
* @method Phaser.Animation#play * @method Phaser.Animation#play
* @memberof Phaser.Animation * @memberof Phaser.Animation
* @param {number} [frameRate=null] - The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used. * @param {number} [frameRate=null] - The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.
* @param {boolean} [loop=null] - Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used. * @param {boolean} [loop=false] - Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.
* @param {boolean} [killOnComplete=false] - If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.
* @return {Phaser.Animation} - A reference to this Animation instance. * @return {Phaser.Animation} - A reference to this Animation instance.
*/ */
play: function (frameRate, loop) { play: function (frameRate, loop, killOnComplete) {
if (typeof frameRate === 'number') if (typeof frameRate === 'number')
{ {
@ -460,6 +466,12 @@ Phaser.Animation.prototype = {
this.looped = loop; this.looped = loop;
} }
if (typeof killOnComplete !== 'undefined')
{
// Remove the parent sprite once the animation has finished?
this.killOnComplete = killOnComplete;
}
this.isPlaying = true; this.isPlaying = true;
this.isFinished = false; this.isFinished = false;
@ -621,6 +633,11 @@ Phaser.Animation.prototype = {
this._parent.events.onAnimationComplete.dispatch(this._parent, this); this._parent.events.onAnimationComplete.dispatch(this._parent, this);
} }
if (this.killOnComplete)
{
this._parent.kill();
}
} }
}; };
@ -765,7 +782,7 @@ Phaser.Animation.generateFrameNames = function (prefix, min, max, suffix, zeroPa
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -359,6 +359,12 @@ Phaser.AnimationManager = function (sprite) {
*/ */
this.updateIfVisible = true; this.updateIfVisible = true;
/**
* @property {boolean} isLoaded - Set to true once animation data has been loaded.
* @default
*/
this.isLoaded = false;
/** /**
* @property {Phaser.FrameData} _frameData - A temp. var for holding the currently playing Animations FrameData. * @property {Phaser.FrameData} _frameData - A temp. var for holding the currently playing Animations FrameData.
* @private * @private
@ -394,6 +400,7 @@ Phaser.AnimationManager.prototype = {
this._frameData = frameData; this._frameData = frameData;
this.frame = 0; this.frame = 0;
this.isLoaded = true;
}, },
@ -420,7 +427,19 @@ Phaser.AnimationManager.prototype = {
frameRate = frameRate || 60; frameRate = frameRate || 60;
if (typeof loop === 'undefined') { loop = false; } if (typeof loop === 'undefined') { loop = false; }
if (typeof useNumericIndex === 'undefined') { useNumericIndex = true; }
// If they didn't set the useNumericIndex then let's at least try and guess it
if (typeof useNumericIndex === 'undefined')
{
if (frames && typeof frames[0] === 'number')
{
useNumericIndex = true;
}
else
{
useNumericIndex = false;
}
}
// Create the signals the AnimationManager will emit // Create the signals the AnimationManager will emit
if (this.sprite.events.onAnimationStart == null) if (this.sprite.events.onAnimationStart == null)
@ -484,10 +503,11 @@ Phaser.AnimationManager.prototype = {
* @method Phaser.AnimationManager#play * @method Phaser.AnimationManager#play
* @param {string} name - The name of the animation to be played, e.g. "fire", "walk", "jump". * @param {string} name - The name of the animation to be played, e.g. "fire", "walk", "jump".
* @param {number} [frameRate=null] - The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used. * @param {number} [frameRate=null] - The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.
* @param {boolean} [loop=null] - Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used. * @param {boolean} [loop=false] - Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.
* @param {boolean} [killOnComplete=false] - If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.
* @return {Phaser.Animation} A reference to playing Animation instance. * @return {Phaser.Animation} A reference to playing Animation instance.
*/ */
play: function (name, frameRate, loop) { play: function (name, frameRate, loop, killOnComplete) {
if (this._anims[name]) if (this._anims[name])
{ {
@ -495,13 +515,13 @@ Phaser.AnimationManager.prototype = {
{ {
if (this.currentAnim.isPlaying == false) if (this.currentAnim.isPlaying == false)
{ {
return this.currentAnim.play(frameRate, loop); return this.currentAnim.play(frameRate, loop, killOnComplete);
} }
} }
else else
{ {
this.currentAnim = this._anims[name]; this.currentAnim = this._anims[name];
return this.currentAnim.play(frameRate, loop); return this.currentAnim.play(frameRate, loop, killOnComplete);
} }
} }
@ -562,6 +582,18 @@ Phaser.AnimationManager.prototype = {
}, },
/**
* Refreshes the current frame data back to the parent Sprite and also resets the texture data.
*
* @method Phaser.AnimationManager#refreshFrame
*/
refreshFrame: function () {
this.sprite.currentFrame = this.currentFrame;
this.sprite.setTexture(PIXI.TextureCache[this.currentFrame.uuid]);
},
/** /**
* Destroys all references this AnimationManager contains. Sets the _anims to a new object and nulls the current animation. * Destroys all references this AnimationManager contains. Sets the _anims to a new object and nulls the current animation.
* *
@ -650,7 +682,7 @@ Object.defineProperty(Phaser.AnimationManager.prototype, "frame", {
set: function (value) { set: function (value) {
if (this._frameData && this._frameData.getFrame(value) !== null) if (typeof value === 'number' && this._frameData && this._frameData.getFrame(value) !== null)
{ {
this.currentFrame = this._frameData.getFrame(value); this.currentFrame = this._frameData.getFrame(value);
this._frameIndex = value; this._frameIndex = value;
@ -679,7 +711,7 @@ Object.defineProperty(Phaser.AnimationManager.prototype, "frameName", {
set: function (value) { set: function (value) {
if (this._frameData && this._frameData.getFrameByName(value) !== null) if (typeof value === 'string' && this._frameData && this._frameData.getFrameByName(value) !== null)
{ {
this.currentFrame = this._frameData.getFrameByName(value); this.currentFrame = this._frameData.getFrameByName(value);
this._frameIndex = this.currentFrame.index; this._frameIndex = this.currentFrame.index;
@ -714,7 +746,7 @@ Object.defineProperty(Phaser.AnimationManager.prototype, "frameName", {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -660,7 +660,7 @@ Phaser.AnimationParser = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -379,6 +379,11 @@ Phaser.Cache = function (game) {
*/ */
this._tilemaps = {}; this._tilemaps = {};
/**
* @property {object} _tilesets - Tileset key-value container.
* @private
*/
this._tilesets = {};
this.addDefaultImage(); this.addDefaultImage();
@ -441,22 +446,44 @@ Phaser.Cache.prototype = {
}, },
/**
* Add a new tile set in to the cache.
*
* @method Phaser.Cache#addTileset
* @param {string} key - The unique key by which you will reference this object.
* @param {string} url - URL of this tile set file.
* @param {object} data - Extra tile set data.
* @param {number} tileWidth - Width of the sprite sheet.
* @param {number} tileHeight - Height of the sprite sheet.
* @param {number} tileMax - How many tiles stored in the sprite sheet.
* @param {number} [tileMargin=0] - If the tiles have been drawn with a margin, specify the amount here.
* @param {number} [tileSpacing=0] - If the tiles have been drawn with spacing between them, specify the amount here.
*/
addTileset: function (key, url, data, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing) {
this._tilesets[key] = { url: url, data: data, tileWidth: tileWidth, tileHeight: tileHeight, tileMargin: tileMargin, tileSpacing: tileSpacing };
PIXI.BaseTextureCache[key] = new PIXI.BaseTexture(data);
PIXI.TextureCache[key] = new PIXI.Texture(PIXI.BaseTextureCache[key]);
this._tilesets[key].tileData = Phaser.TilemapParser.tileset(this.game, key, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing);
},
/** /**
* Add a new tilemap. * Add a new tilemap.
* *
* @method Phaser.Cache#addTilemap * @method Phaser.Cache#addTilemap
* @param {string} key - The unique key by which you will reference this object. * @param {string} key - The unique key by which you will reference this object.
* @param {string} url - URL of the tilemap image. * @param {string} url - URL of the tilemap image.
* @param {object} data - Tilemap data.
* @param {object} mapData - The tilemap data object. * @param {object} mapData - The tilemap data object.
* @param {number} format - The format of the tilemap data. * @param {number} format - The format of the tilemap data.
*/ */
addTilemap: function (key, url, data, mapData, format) { addTilemap: function (key, url, mapData, format) {
this._tilemaps[key] = { url: url, data: data, spriteSheet: true, mapData: mapData, format: format }; this._tilemaps[key] = { url: url, data: mapData, format: format };
PIXI.BaseTextureCache[key] = new PIXI.BaseTexture(data); this._tilemaps[key].layers = Phaser.TilemapParser.parse(this.game, mapData, format);
PIXI.TextureCache[key] = new PIXI.Texture(PIXI.BaseTextureCache[key]);
}, },
@ -520,16 +547,31 @@ Phaser.Cache.prototype = {
*/ */
addDefaultImage: function () { addDefaultImage: function () {
this._images['__default'] = { url: null, data: null, spriteSheet: false }; var img = new Image();
img.src = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAIAAAD8GO2jAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAJ9JREFUeNq01ssOwyAMRFG46v//Mt1ESmgh+DFmE2GPOBARKb2NVjo+17PXLD8a1+pl5+A+wSgFygymWYHBb0FtsKhJDdZlncG2IzJ4ayoMDv20wTmSMzClEgbWYNTAkQ0Z+OJ+A/eWnAaR9+oxCF4Os0H8htsMUp+pwcgBBiMNnAwF8GqIgL2hAzaGFFgZauDPKABmowZ4GL369/0rwACp2yA/ttmvsQAAAABJRU5ErkJggg==";
this._images['__default'] = { url: null, data: img, spriteSheet: false };
this._images['__default'].frame = new Phaser.Frame(0, 0, 0, 32, 32, '', ''); this._images['__default'].frame = new Phaser.Frame(0, 0, 0, 32, 32, '', '');
var base = new PIXI.BaseTexture(); PIXI.BaseTextureCache['__default'] = new PIXI.BaseTexture(img);
base.width = 32; PIXI.TextureCache['__default'] = new PIXI.Texture(PIXI.BaseTextureCache['__default']);
base.height = 32;
base.hasLoaded = true; // avoids a hanging event listener
PIXI.BaseTextureCache['__default'] = base; },
PIXI.TextureCache['__default'] = new PIXI.Texture(base);
/**
* Add a new text data.
*
* @method Phaser.Cache#addText
* @param {string} key - Asset key for the text data.
* @param {string} url - URL of this text data file.
* @param {object} data - Extra text data.
*/
addText: function (key, url, data) {
this._text[key] = {
url: url,
data: data
};
}, },
@ -641,23 +683,6 @@ Phaser.Cache.prototype = {
this._sounds[key].decoded = true; this._sounds[key].decoded = true;
this._sounds[key].isDecoding = false; this._sounds[key].isDecoding = false;
},
/**
* Add a new text data.
*
* @method Phaser.Cache#addText
* @param {string} key - Asset key for the text data.
* @param {string} url - URL of this text data file.
* @param {object} data - Extra text data.
*/
addText: function (key, url, data) {
this._text[key] = {
url: url,
data: data
};
}, },
/** /**
@ -712,14 +737,50 @@ Phaser.Cache.prototype = {
return null; return null;
}, },
/**
* Get tile set image data by key.
*
* @method Phaser.Cache#getTileSetImage
* @param {string} key - Asset key of the image you want.
* @return {object} The image data you want.
*/
getTilesetImage: function (key) {
if (this._tilesets[key])
{
return this._tilesets[key].data;
}
return null;
},
/**
* Get tile set image data by key.
*
* @method Phaser.Cache#getTileset
* @param {string} key - Asset key of the image you want.
* @return {Phaser.Tileset} The tileset data. The tileset image is in the data property, the tile data in tileData.
*/
getTileset: function (key) {
if (this._tilesets[key])
{
return this._tilesets[key].tileData;
}
return null;
},
/** /**
* Get tilemap data by key. * Get tilemap data by key.
* *
* @method Phaser.Cache#getTilemap * @method Phaser.Cache#getTilemap
* @param {string} key - Asset key of the tilemap you want. * @param {string} key - Asset key of the tilemap you want.
* @return {Phaser.Tilemap} The tilemap data. The tileset image is in the data property, the map data in mapData. * @return {Object} The tilemap data. The tileset image is in the data property, the map data in mapData.
*/ */
getTilemap: function (key) { getTilemapData: function (key) {
if (this._tilemaps[key]) if (this._tilemaps[key])
{ {
@ -1077,7 +1138,7 @@ Phaser.Cache.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -340,7 +340,6 @@
* @param {number} width - The width of the view rectangle * @param {number} width - The width of the view rectangle
* @param {number} height - The height of the view rectangle * @param {number} height - The height of the view rectangle
*/ */
Phaser.Camera = function (game, id, x, y, width, height) { Phaser.Camera = function (game, id, x, y, width, height) {
/** /**
@ -373,6 +372,14 @@ Phaser.Camera = function (game, id, x, y, width, height) {
*/ */
this.screenView = new Phaser.Rectangle(x, y, width, height); this.screenView = new Phaser.Rectangle(x, y, width, height);
/**
* The Camera is bound to this Rectangle and cannot move outside of it. By default it is enabled and set to the size of the World.
* The Rectangle can be located anywhere in the world and updated as often as you like. If you don't wish the Camera to be bound
* at all then set this to null. The values can be anything and are in World coordinates, with 0,0 being the center of the world.
* @property {Phaser.Rectangle} bounds - The Rectangle in which the Camera is bounded. Set to null to allow for movement anywhere.
*/
this.bounds = new Phaser.Rectangle(x, y, width, height);
/** /**
* @property {Phaser.Rectangle} deadzone - Moving inside this Rectangle will not cause camera moving. * @property {Phaser.Rectangle} deadzone - Moving inside this Rectangle will not cause camera moving.
*/ */
@ -401,6 +408,8 @@ Phaser.Camera = function (game, id, x, y, width, height) {
* @default * @default
*/ */
this._edge = 0; this._edge = 0;
this.displayObject = null;
}; };
@ -468,18 +477,28 @@ Phaser.Camera.prototype = {
break; break;
} }
},
/**
* Move the camera focus on a display object instantly.
* @method Phaser.Camera#focusOn
* @param {any} displayObject - The display object to focus the camera on. Must have visible x/y properties.
*/
focusOn: function (displayObject) {
this.setPosition(Math.round(displayObject.x - this.view.halfWidth), Math.round(displayObject.y - this.view.halfHeight));
}, },
/** /**
* Move the camera focus to a location instantly. * Move the camera focus on a location instantly.
* @method Phaser.Camera#focusOnXY * @method Phaser.Camera#focusOnXY
* @param {number} x - X position. * @param {number} x - X position.
* @param {number} y - Y position. * @param {number} y - Y position.
*/ */
focusOnXY: function (x, y) { focusOnXY: function (x, y) {
this.view.x = Math.round(x - this.view.halfWidth); this.setPosition(Math.round(x - this.view.halfWidth), Math.round(y - this.view.halfHeight));
this.view.y = Math.round(y - this.view.halfHeight);
}, },
@ -489,47 +508,70 @@ Phaser.Camera.prototype = {
*/ */
update: function () { update: function () {
// Add dirty flag if (this.target)
if (this.target !== null)
{ {
if (this.deadzone) this.updateTarget();
{
this._edge = this.target.x - this.deadzone.x;
if (this.view.x > this._edge)
{
this.view.x = this._edge;
}
this._edge = this.target.x + this.target.width - this.deadzone.x - this.deadzone.width;
if (this.view.x &lt; this._edge)
{
this.view.x = this._edge;
}
this._edge = this.target.y - this.deadzone.y;
if (this.view.y > this._edge)
{
this.view.y = this._edge;
}
this._edge = this.target.y + this.target.height - this.deadzone.y - this.deadzone.height;
if (this.view.y &lt; this._edge)
{
this.view.y = this._edge;
}
}
else
{
this.focusOnXY(this.target.x, this.target.y);
}
} }
this.checkWorldBounds(); if (this.bounds)
{
this.checkBounds();
}
if (this.view.x !== -this.displayObject.position.x)
{
this.displayObject.position.x = -this.view.x;
}
if (this.view.y !== -this.displayObject.position.y)
{
this.displayObject.position.y = -this.view.y;
}
},
updateTarget: function () {
if (this.deadzone)
{
this._edge = this.target.x - this.deadzone.x;
if (this.view.x > this._edge)
{
this.view.x = this._edge;
}
this._edge = this.target.x + this.target.width - this.deadzone.x - this.deadzone.width;
if (this.view.x &lt; this._edge)
{
this.view.x = this._edge;
}
this._edge = this.target.y - this.deadzone.y;
if (this.view.y > this._edge)
{
this.view.y = this._edge;
}
this._edge = this.target.y + this.target.height - this.deadzone.y - this.deadzone.height;
if (this.view.y &lt; this._edge)
{
this.view.y = this._edge;
}
}
else
{
this.focusOnXY(this.target.x, this.target.y);
}
},
setBoundsToWorld: function () {
this.bounds.setTo(this.game.world.x, this.game.world.y, this.game.world.width, this.game.world.height);
}, },
@ -537,34 +579,34 @@ Phaser.Camera.prototype = {
* Method called to ensure the camera doesn't venture outside of the game world. * Method called to ensure the camera doesn't venture outside of the game world.
* @method Phaser.Camera#checkWorldBounds * @method Phaser.Camera#checkWorldBounds
*/ */
checkWorldBounds: function () { checkBounds: function () {
this.atLimit.x = false; this.atLimit.x = false;
this.atLimit.y = false; this.atLimit.y = false;
// Make sure we didn't go outside the cameras worldBounds // Make sure we didn't go outside the cameras bounds
if (this.view.x &lt; this.world.bounds.left) if (this.view.x &lt; this.bounds.x)
{ {
this.atLimit.x = true; this.atLimit.x = true;
this.view.x = this.world.bounds.left; this.view.x = this.bounds.x;
} }
if (this.view.x > this.world.bounds.right - this.width) if (this.view.x > this.bounds.right - this.width)
{ {
this.atLimit.x = true; this.atLimit.x = true;
this.view.x = (this.world.bounds.right - this.width) + 1; this.view.x = (this.bounds.right - this.width) + 1;
} }
if (this.view.y &lt; this.world.bounds.top) if (this.view.y &lt; this.bounds.top)
{ {
this.atLimit.y = true; this.atLimit.y = true;
this.view.y = this.world.bounds.top; this.view.y = this.bounds.top;
} }
if (this.view.y > this.world.bounds.bottom - this.height) if (this.view.y > this.bounds.bottom - this.height)
{ {
this.atLimit.y = true; this.atLimit.y = true;
this.view.y = (this.world.bounds.bottom - this.height) + 1; this.view.y = (this.bounds.bottom - this.height) + 1;
} }
this.view.floor(); this.view.floor();
@ -583,7 +625,11 @@ Phaser.Camera.prototype = {
this.view.x = x; this.view.x = x;
this.view.y = y; this.view.y = y;
this.checkWorldBounds();
if (this.bounds)
{
this.checkBounds();
}
}, },
@ -615,8 +661,13 @@ Object.defineProperty(Phaser.Camera.prototype, "x", {
}, },
set: function (value) { set: function (value) {
this.view.x = value; this.view.x = value;
this.checkWorldBounds();
if (this.bounds)
{
this.checkBounds();
}
} }
}); });
@ -633,8 +684,13 @@ Object.defineProperty(Phaser.Camera.prototype, "y", {
}, },
set: function (value) { set: function (value) {
this.view.y = value; this.view.y = value;
this.checkWorldBounds();
if (this.bounds)
{
this.checkBounds();
}
} }
}); });
@ -693,7 +749,7 @@ Object.defineProperty(Phaser.Camera.prototype, "height", {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -344,6 +344,7 @@ Phaser.Canvas = {
* @return {HTMLCanvasElement} The newly created &lt;canvas&gt; tag. * @return {HTMLCanvasElement} The newly created &lt;canvas&gt; tag.
*/ */
create: function (width, height) { create: function (width, height) {
width = width || 256; width = width || 256;
height = height || 256; height = height || 256;
@ -597,7 +598,7 @@ Phaser.Canvas = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -812,7 +812,7 @@ Phaser.Circle.intersectsRectangle = function (c, r) {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -669,7 +669,7 @@ Phaser.Color = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -399,17 +399,14 @@ Phaser.Utils.Debug.prototype = {
return; return;
} }
x = x || null; if (typeof x !== 'number') { x = 0; }
y = y || null; if (typeof y !== 'number') { y = 0; }
color = color || 'rgb(255,255,255)'; color = color || 'rgb(255,255,255)';
if (x && y) this.currentX = x;
{ this.currentY = y;
this.currentX = x; this.currentColor = color;
this.currentY = y;
this.currentColor = color;
}
this.currentAlpha = this.context.globalAlpha; this.currentAlpha = this.context.globalAlpha;
this.context.save(); this.context.save();
@ -426,6 +423,7 @@ Phaser.Utils.Debug.prototype = {
*/ */
stop: function () { stop: function () {
this.context.restore(); this.context.restore();
this.context.globalAlpha = this.currentAlpha; this.context.globalAlpha = this.currentAlpha;
@ -621,6 +619,8 @@ Phaser.Utils.Debug.prototype = {
this.start(x, y, color); this.start(x, y, color);
this.line('Camera (' + camera.width + ' x ' + camera.height + ')'); this.line('Camera (' + camera.width + ' x ' + camera.height + ')');
this.line('X: ' + camera.x + ' Y: ' + camera.y); this.line('X: ' + camera.x + ' Y: ' + camera.y);
this.line('Bounds x: ' + camera.bounds.x + ' Y: ' + camera.bounds.y + ' w: ' + camera.bounds.width + ' h: ' + camera.bounds.height);
this.line('View x: ' + camera.view.x + ' Y: ' + camera.view.y + ' w: ' + camera.view.width + ' h: ' + camera.view.height);
this.stop(); this.stop();
}, },
@ -777,9 +777,9 @@ Phaser.Utils.Debug.prototype = {
this.start(x, y, color); this.start(x, y, color);
this.line('Sprite: ' + ' (' + sprite.width + ' x ' + sprite.height + ') anchor: ' + sprite.anchor.x + ' x ' + sprite.anchor.y); this.line('Sprite: ' + ' (' + sprite.width + ' x ' + sprite.height + ') anchor: ' + sprite.anchor.x + ' x ' + sprite.anchor.y);
this.line('x: ' + sprite.x.toFixed(1) + ' y: ' + sprite.y.toFixed(1) + ' rotation: ' + sprite.rotation.toFixed(1)); this.line('x: ' + sprite.x.toFixed(1) + ' y: ' + sprite.y.toFixed(1));
this.line('visible: ' + sprite.visible); this.line('angle: ' + sprite.angle.toFixed(1) + ' rotation: ' + sprite.rotation.toFixed(1));
this.line('in camera: ' + sprite.inCamera); this.line('visible: ' + sprite.visible + ' in camera: ' + sprite.inCamera);
this.line('body x: ' + sprite.body.x.toFixed(1) + ' y: ' + sprite.body.y.toFixed(1)); this.line('body x: ' + sprite.body.x.toFixed(1) + ' y: ' + sprite.body.y.toFixed(1));
// 0 = scaleX // 0 = scaleX
@ -789,7 +789,6 @@ Phaser.Utils.Debug.prototype = {
// 4 = scaleY // 4 = scaleY
// 5 = translateY // 5 = translateY
// this.line('id: ' + sprite._id); // this.line('id: ' + sprite._id);
// this.line('scale x: ' + sprite.worldTransform[0]); // this.line('scale x: ' + sprite.worldTransform[0]);
// this.line('scale y: ' + sprite.worldTransform[4]); // this.line('scale y: ' + sprite.worldTransform[4]);
@ -797,12 +796,13 @@ Phaser.Utils.Debug.prototype = {
// this.line('ty: ' + sprite.worldTransform[5]); // this.line('ty: ' + sprite.worldTransform[5]);
// this.line('skew x: ' + sprite.worldTransform[3]); // this.line('skew x: ' + sprite.worldTransform[3]);
// this.line('skew y: ' + sprite.worldTransform[1]); // this.line('skew y: ' + sprite.worldTransform[1]);
this.line('dx: ' + sprite.body.deltaX()); this.line('deltaX: ' + sprite.body.deltaX());
this.line('dy: ' + sprite.body.deltaY()); this.line('deltaY: ' + sprite.body.deltaY());
this.line('sdx: ' + sprite.deltaX()); // this.line('sdx: ' + sprite.deltaX());
this.line('sdy: ' + sprite.deltaY()); // this.line('sdy: ' + sprite.deltaY());
// this.line('inCamera: ' + this.game.renderer.spriteRenderer.inCamera(this.game.camera, sprite)); // this.line('inCamera: ' + this.game.renderer.spriteRenderer.inCamera(this.game.camera, sprite));
this.stop();
}, },
@ -832,6 +832,7 @@ Phaser.Utils.Debug.prototype = {
this.line('scaleY: ' + sprite.worldTransform[4]); this.line('scaleY: ' + sprite.worldTransform[4]);
this.line('transX: ' + sprite.worldTransform[2]); this.line('transX: ' + sprite.worldTransform[2]);
this.line('transY: ' + sprite.worldTransform[5]); this.line('transY: ' + sprite.worldTransform[5]);
this.stop();
}, },
@ -861,8 +862,49 @@ Phaser.Utils.Debug.prototype = {
this.line('scaleY: ' + sprite.localTransform[4]); this.line('scaleY: ' + sprite.localTransform[4]);
this.line('transX: ' + sprite.localTransform[2]); this.line('transX: ' + sprite.localTransform[2]);
this.line('transY: ' + sprite.localTransform[5]); this.line('transY: ' + sprite.localTransform[5]);
this.line('sX: ' + sprite._sx); this.stop();
this.line('sY: ' + sprite._sy);
},
renderSpriteCoords: function (sprite, x, y, color) {
if (this.context == null)
{
return;
}
color = color || 'rgb(255, 255, 255)';
this.start(x, y, color);
this.line(sprite.name);
this.line('x: ' + sprite.x);
this.line('y: ' + sprite.y);
this.line('local x: ' + sprite.localTransform[2]);
this.line('local y: ' + sprite.localTransform[5]);
this.line('world x: ' + sprite.worldTransform[2]);
this.line('world y: ' + sprite.worldTransform[5]);
this.stop();
},
renderGroupInfo: function (group, x, y, color) {
if (this.context == null)
{
return;
}
color = color || 'rgb(255, 255, 255)';
this.start(x, y, color);
this.line('Group (size: ' + group.length + ')');
this.line('x: ' + group.x);
this.line('y: ' + group.y);
this.stop();
}, },
@ -907,8 +949,7 @@ Phaser.Utils.Debug.prototype = {
this.start(0, 0, color); this.start(0, 0, color);
this.context.fillStyle = color; this.context.fillStyle = color;
// this.context.fillRect(sprite.body.x - sprite.body.deltaX(), sprite.body.y - sprite.body.deltaY(), sprite.body.width, sprite.body.height); this.context.fillRect(sprite.body.screenX, sprite.body.screenY, sprite.body.width, sprite.body.height);
this.context.fillRect(sprite.body.x, sprite.body.y, sprite.body.width, sprite.body.height);
this.stop(); this.stop();
@ -1171,7 +1212,7 @@ Phaser.Utils.Debug.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -646,8 +646,7 @@ Phaser.Device.prototype = {
this.file = !!window['File'] && !!window['FileReader'] && !!window['FileList'] && !!window['Blob']; this.file = !!window['File'] && !!window['FileReader'] && !!window['FileList'] && !!window['Blob'];
this.fileSystem = !!window['requestFileSystem']; this.fileSystem = !!window['requestFileSystem'];
this.webGL = ( function () { try { return !! window.WebGLRenderingContext && !! document.createElement( 'canvas' ).getContext( 'experimental-webgl' ); } catch( e ) { return false; } } )(); this.webGL = ( function () { try { var canvas = document.createElement( 'canvas' ); return !! window.WebGLRenderingContext && ( canvas.getContext( 'webgl' ) || canvas.getContext( 'experimental-webgl' ) ); } catch( e ) { return false; } } )();
// this.webGL = !!window['WebGLRenderingContext'];
this.worker = !!window['Worker']; this.worker = !!window['Worker'];
if ('ontouchstart' in document.documentElement || window.navigator.msPointerEnabled) { if ('ontouchstart' in document.documentElement || window.navigator.msPointerEnabled) {
@ -876,7 +875,7 @@ Phaser.Device.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -903,7 +903,7 @@ Phaser.Easing = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1017,7 +1017,7 @@ Object.defineProperty(Phaser.Particles.Arcade.Emitter.prototype, "bottom", {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -502,7 +502,7 @@ Phaser.Frame.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -383,7 +383,7 @@ Phaser.FrameData.prototype = {
*/ */
getFrame: function (index) { getFrame: function (index) {
if (this._frames[index]) if (this._frames.length > index)
{ {
return this._frames[index]; return this._frames[index];
} }
@ -532,7 +532,10 @@ Phaser.FrameData.prototype = {
} }
else else
{ {
output.push(this.getFrameByName(frames[i]).index); if (this.getFrameByName(frames[i]))
{
output.push(this.getFrameByName(frames[i]).index);
}
} }
} }
} }
@ -576,7 +579,7 @@ Object.defineProperty(Phaser.FrameData.prototype, "total", {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -352,8 +352,9 @@ Phaser.Game = function (width, height, renderer, parent, state, transparent, ant
renderer = renderer || Phaser.AUTO; renderer = renderer || Phaser.AUTO;
parent = parent || ''; parent = parent || '';
state = state || null; state = state || null;
if (typeof transparent == 'undefined') { transparent = false; } if (typeof transparent == 'undefined') { transparent = false; }
if (typeof antialias == 'undefined') { antialias = false; } if (typeof antialias == 'undefined') { antialias = true; }
/** /**
* @property {number} id - Phaser Game ID (for when Pixi supports multiple instances). * @property {number} id - Phaser Game ID (for when Pixi supports multiple instances).
@ -620,14 +621,14 @@ Phaser.Game.prototype = {
this.net = new Phaser.Net(this); this.net = new Phaser.Net(this);
this.debug = new Phaser.Utils.Debug(this); this.debug = new Phaser.Utils.Debug(this);
this.load.onLoadComplete.add(this.loadComplete, this);
this.stage.boot(); this.stage.boot();
this.world.boot(); this.world.boot();
this.input.boot(); this.input.boot();
this.sound.boot(); this.sound.boot();
this.state.boot(); this.state.boot();
this.load.onLoadComplete.add(this.loadComplete, this);
if (this.renderType == Phaser.CANVAS) if (this.renderType == Phaser.CANVAS)
{ {
console.log('%cPhaser ' + Phaser.VERSION + ' initialized. Rendering to Canvas', 'color: #ffff33; background: #000000'); console.log('%cPhaser ' + Phaser.VERSION + ' initialized. Rendering to Canvas', 'color: #ffff33; background: #000000');
@ -796,6 +797,9 @@ Object.defineProperty(Phaser.Game.prototype, "paused", {
}); });
/**
* "Deleted code is debugged code." - Jeff Sickel
*/
</pre> </pre>
</article> </article>
</section> </section>
@ -817,7 +821,7 @@ Object.defineProperty(Phaser.Game.prototype, "paused", {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -335,13 +335,16 @@
* @param {Phaser.Game} game - A reference to the currently running game. * @param {Phaser.Game} game - A reference to the currently running game.
* @param {*} parent - The parent Group or DisplayObjectContainer that will hold this group, if any. * @param {*} parent - The parent Group or DisplayObjectContainer that will hold this group, if any.
* @param {string} [name=group] - A name for this Group. Not used internally but useful for debugging. * @param {string} [name=group] - A name for this Group. Not used internally but useful for debugging.
* @param {boolean} [useStage=false] - Only the root World Group should use this value. * @param {boolean} [useStage=false] - Should the DisplayObjectContainer this Group creates be added to the World (default, false) or direct to the Stage (true).
*/ */
Phaser.Group = function (game, parent, name, useStage) { Phaser.Group = function (game, parent, name, useStage) {
parent = parent || null; if (typeof parent === 'undefined')
{
parent = game.world;
}
if (typeof useStage == 'undefined') if (typeof useStage === 'undefined')
{ {
useStage = false; useStage = false;
} }
@ -393,7 +396,12 @@ Phaser.Group = function (game, parent, name, useStage) {
* @default * @default
*/ */
this.exists = true; this.exists = true;
/**
* @property {Phaser.Point} scale - Replaces the PIXI.Point with a slightly more flexible one.
*/
this.scale = new Phaser.Point(1, 1);
}; };
Phaser.Group.prototype = { Phaser.Group.prototype = {
@ -477,7 +485,7 @@ Phaser.Group.prototype = {
* @param {number} y - The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point. * @param {number} y - The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.
* @param {string} key - The Game.cache key of the image that this Sprite will use. * @param {string} key - The Game.cache key of the image that this Sprite will use.
* @param {number|string} [frame] - If the Sprite image contains multiple frames you can specify which one to use here. * @param {number|string} [frame] - If the Sprite image contains multiple frames you can specify which one to use here.
* @param {boolean} [exists] - The default exists state of the Sprite. * @param {boolean} [exists=true] - The default exists state of the Sprite.
* @return {Phaser.Sprite} The child that was created. * @return {Phaser.Sprite} The child that was created.
*/ */
create: function (x, y, key, frame, exists) { create: function (x, y, key, frame, exists) {
@ -488,6 +496,8 @@ Phaser.Group.prototype = {
child.group = this; child.group = this;
child.exists = exists; child.exists = exists;
child.visible = exists;
child.alive = exists;
if (child.events) if (child.events)
{ {
@ -500,6 +510,40 @@ Phaser.Group.prototype = {
}, },
/**
* Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group.
* Useful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist
* and will be positioned at 0, 0 (relative to the Group.x/y)
*
* @method Phaser.Group#createMultiple
* @param {number} quantity - The number of Sprites to create.
* @param {string} key - The Game.cache key of the image that this Sprite will use.
* @param {number|string} [frame] - If the Sprite image contains multiple frames you can specify which one to use here.
* @param {boolean} [exists=false] - The default exists state of the Sprite.
*/
createMultiple: function (quantity, key, frame, exists) {
if (typeof exists == 'undefined') { exists = false; }
for (var i = 0; i &lt; quantity; i++)
{
var child = new Phaser.Sprite(this.game, 0, 0, key, frame);
child.group = this;
child.exists = exists;
child.visible = exists;
child.alive = exists;
if (child.events)
{
child.events.onAddedToGroup.dispatch(child, this);
}
this._container.addChild(child);
}
},
/** /**
* Swaps the position of two children in this Group. * Swaps the position of two children in this Group.
* *
@ -1125,7 +1169,7 @@ Phaser.Group.prototype = {
*/ */
countLiving: function () { countLiving: function () {
var total = -1; var total = 0;
if (this._container.children.length > 0 && this._container.first._iNext) if (this._container.children.length > 0 && this._container.first._iNext)
{ {
@ -1142,6 +1186,10 @@ Phaser.Group.prototype = {
} }
while (currentNode != this._container.last._iNext); while (currentNode != this._container.last._iNext);
} }
else
{
total = -1;
}
return total; return total;
@ -1155,7 +1203,7 @@ Phaser.Group.prototype = {
*/ */
countDead: function () { countDead: function () {
var total = -1; var total = 0;
if (this._container.children.length > 0 && this._container.first._iNext) if (this._container.children.length > 0 && this._container.first._iNext)
{ {
@ -1172,6 +1220,10 @@ Phaser.Group.prototype = {
} }
while (currentNode != this._container.last._iNext); while (currentNode != this._container.last._iNext);
} }
else
{
total = -1;
}
return total; return total;
@ -1207,8 +1259,13 @@ Phaser.Group.prototype = {
*/ */
remove: function (child) { remove: function (child) {
child.events.onRemovedFromGroup.dispatch(child, this); if (child.events)
{
child.events.onRemovedFromGroup.dispatch(child, this);
}
this._container.removeChild(child); this._container.removeChild(child);
child.group = null; child.group = null;
}, },
@ -1377,6 +1434,19 @@ Phaser.Group.prototype = {
}; };
/**
* @name Phaser.Group#total
* @property {number} total - The total number of children in this Group, regardless of their alive state.
* @readonly
*/
Object.defineProperty(Phaser.Group.prototype, "total", {
get: function () {
return this._container.children.length;
}
});
/** /**
* @name Phaser.Group#length * @name Phaser.Group#length
* @property {number} length - The number of children in this Group. * @property {number} length - The number of children in this Group.
@ -1476,6 +1546,22 @@ Object.defineProperty(Phaser.Group.prototype, "visible", {
this._container.visible = value; this._container.visible = value;
} }
});
/**
* @name Phaser.Group#alpha
* @property {number} alpha - The alpha value of the Group container.
*/
Object.defineProperty(Phaser.Group.prototype, "alpha", {
get: function () {
return this._container.alpha;
},
set: function (value) {
this._container.alpha = value;
}
}); });
</pre> </pre>
</article> </article>
@ -1498,7 +1584,7 @@ Object.defineProperty(Phaser.Group.prototype, "visible", {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1163,7 +1163,7 @@ Object.defineProperty(Phaser.Input.prototype, "worldY", {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1050,8 +1050,8 @@ Phaser.InputHandler.prototype = {
if (this.snapOnDrag) if (this.snapOnDrag)
{ {
this.sprite.x = Math.floor(this.sprite.x / this.snapX) * this.snapX; this.sprite.x = Math.round(this.sprite.x / this.snapX) * this.snapX;
this.sprite.y = Math.floor(this.sprite.y / this.snapY) * this.snapY; this.sprite.y = Math.round(this.sprite.y / this.snapY) * this.snapY;
} }
return true; return true;
@ -1264,8 +1264,8 @@ Phaser.InputHandler.prototype = {
if (this.snapOnRelease) if (this.snapOnRelease)
{ {
this.sprite.x = Math.floor(this.sprite.x / this.snapX) * this.snapX; this.sprite.x = Math.round(this.sprite.x / this.snapX) * this.snapX;
this.sprite.y = Math.floor(this.sprite.y / this.snapY) * this.snapY; this.sprite.y = Math.round(this.sprite.y / this.snapY) * this.snapY;
} }
this.sprite.events.onDragStop.dispatch(this.sprite, pointer); this.sprite.events.onDragStop.dispatch(this.sprite, pointer);
@ -1394,7 +1394,7 @@ Phaser.InputHandler.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -371,7 +371,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -513,7 +513,7 @@ Phaser.Key.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -446,6 +446,23 @@ Phaser.Keyboard.prototype = {
}, },
/**
* Creates and returns an object containing 4 hotkeys for Up, Down, Left and Right.
*
* @method Phaser.Keyboard#createCursorKeys
* @return {object} An object containing properties: up, down, left and right. Which can be polled like any other Phaser.Key object.
*/
createCursorKeys: function () {
return {
up: this.addKey(Phaser.Keyboard.UP),
down: this.addKey(Phaser.Keyboard.DOWN),
left: this.addKey(Phaser.Keyboard.LEFT),
right: this.addKey(Phaser.Keyboard.RIGHT)
}
},
/** /**
* Starts the Keyboard event listeners running (keydown and keyup). They are attached to the document.body. * Starts the Keyboard event listeners running (keydown and keyup). They are attached to the document.body.
* This is called automatically by Phaser.Input and should not normally be invoked directly. * This is called automatically by Phaser.Input and should not normally be invoked directly.
@ -609,8 +626,21 @@ Phaser.Keyboard.prototype = {
this._hotkeys[event.keyCode].processKeyUp(event); this._hotkeys[event.keyCode].processKeyUp(event);
} }
this._keys[event.keyCode].isDown = false; if (this._keys[event.keyCode])
this._keys[event.keyCode].timeUp = this.game.time.now; {
this._keys[event.keyCode].isDown = false;
this._keys[event.keyCode].timeUp = this.game.time.now;
}
else
{
// Not used this key before, so register it
this._keys[event.keyCode] = {
isDown: false,
timeDown: this.game.time.now,
timeUp: this.game.time.now,
duration: 0
};
}
}, },
@ -805,7 +835,7 @@ Phaser.Keyboard.NUM_LOCK = 144;
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -495,7 +495,7 @@ Phaser.LinkedList.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -574,6 +574,8 @@ Phaser.Loader.prototype = {
this.addToFileList('image', key, url); this.addToFileList('image', key, url);
} }
return this;
}, },
/** /**
@ -593,6 +595,8 @@ Phaser.Loader.prototype = {
this.addToFileList('text', key, url); this.addToFileList('text', key, url);
} }
return this;
}, },
/** /**
@ -603,7 +607,7 @@ Phaser.Loader.prototype = {
* @param {string} url - URL of the sheet file. * @param {string} url - URL of the sheet file.
* @param {number} frameWidth - Width of each single frame. * @param {number} frameWidth - Width of each single frame.
* @param {number} frameHeight - Height of each single frame. * @param {number} frameHeight - Height of each single frame.
* @param {number} frameMax - How many frames in this sprite sheet. * @param {number} [frameMax=-1] - How many frames in this sprite sheet. If not specified it will divide the whole image into frames.
*/ */
spritesheet: function (key, url, frameWidth, frameHeight, frameMax) { spritesheet: function (key, url, frameWidth, frameHeight, frameMax) {
@ -614,6 +618,35 @@ Phaser.Loader.prototype = {
this.addToFileList('spritesheet', key, url, { frameWidth: frameWidth, frameHeight: frameHeight, frameMax: frameMax }); this.addToFileList('spritesheet', key, url, { frameWidth: frameWidth, frameHeight: frameHeight, frameMax: frameMax });
} }
return this;
},
/**
* Add a new tile set to the loader. These are used in the rendering of tile maps.
*
* @method Phaser.Loader#tileset
* @param {string} key - Unique asset key of the tileset file.
* @param {string} url - URL of the tileset.
* @param {number} tileWidth - Width of each single tile in pixels.
* @param {number} tileHeight - Height of each single tile in pixels.
* @param {number} [tileMax=-1] - How many tiles in this tileset. If not specified it will divide the whole image into tiles.
* @param {number} [tileMargin=0] - If the tiles have been drawn with a margin, specify the amount here.
* @param {number} [tileSpacing=0] - If the tiles have been drawn with spacing between them, specify the amount here.
*/
tileset: function (key, url, tileWidth, tileHeight, tileMax, tileMargin, tileSpacing) {
if (typeof tileMax === "undefined") { tileMax = -1; }
if (typeof tileMargin === "undefined") { tileMargin = 0; }
if (typeof tileSpacing === "undefined") { tileSpacing = 0; }
if (this.checkKeyExists(key) === false)
{
this.addToFileList('tileset', key, url, { tileWidth: tileWidth, tileHeight: tileHeight, tileMax: tileMax, tileMargin: tileMargin, tileSpacing: tileSpacing });
}
return this;
}, },
/** /**
@ -633,6 +666,8 @@ Phaser.Loader.prototype = {
this.addToFileList('audio', key, urls, { buffer: null, autoDecode: autoDecode }); this.addToFileList('audio', key, urls, { buffer: null, autoDecode: autoDecode });
} }
return this;
}, },
/** /**
@ -645,18 +680,25 @@ Phaser.Loader.prototype = {
* @param {object} [mapData] - An optional JSON data object (can be given in place of a URL). * @param {object} [mapData] - An optional JSON data object (can be given in place of a URL).
* @param {string} [format] - The format of the map data. * @param {string} [format] - The format of the map data.
*/ */
tilemap: function (key, tilesetURL, mapDataURL, mapData, format) { tilemap: function (key, mapDataURL, mapData, format) {
if (typeof mapDataURL === "undefined") { mapDataURL = null; } if (typeof mapDataURL === "undefined") { mapDataURL = null; }
if (typeof mapData === "undefined") { mapData = null; } if (typeof mapData === "undefined") { mapData = null; }
if (typeof format === "undefined") { format = Phaser.Tilemap.CSV; } if (typeof format === "undefined") { format = Phaser.Tilemap.CSV; }
if (mapDataURL == null && mapData == null)
{
console.warn('Phaser.Loader.tilemap - Both mapDataURL and mapData are null. One must be set.');
return this;
}
if (this.checkKeyExists(key) === false) if (this.checkKeyExists(key) === false)
{ {
// A URL to a json/csv file has been given // A URL to a json/csv file has been given
if (mapDataURL) if (mapDataURL)
{ {
this.addToFileList('tilemap', key, tilesetURL, { mapDataURL: mapDataURL, format: format }); this.addToFileList('tilemap', key, mapDataURL, { format: format });
} }
else else
{ {
@ -667,7 +709,7 @@ Phaser.Loader.prototype = {
break; break;
// An xml string or object has been given // An xml string or object has been given
case Phaser.Tilemap.JSON: case Phaser.Tilemap.TILED_JSON:
if (typeof mapData === 'string') if (typeof mapData === 'string')
{ {
@ -676,11 +718,13 @@ Phaser.Loader.prototype = {
break; break;
} }
this.addToFileList('tilemap', key, tilesetURL, { mapDataURL: null, mapData: mapData, format: format }); this.game.cache.addTilemap(key, null, mapData, format);
} }
} }
return this;
}, },
/** /**
@ -741,6 +785,8 @@ Phaser.Loader.prototype = {
} }
} }
return this;
}, },
/** /**
@ -753,7 +799,7 @@ Phaser.Loader.prototype = {
*/ */
atlasJSONArray: function (key, textureURL, atlasURL, atlasData) { atlasJSONArray: function (key, textureURL, atlasURL, atlasData) {
this.atlas(key, textureURL, atlasURL, atlasData, Phaser.Loader.TEXTURE_ATLAS_JSON_ARRAY); return this.atlas(key, textureURL, atlasURL, atlasData, Phaser.Loader.TEXTURE_ATLAS_JSON_ARRAY);
}, },
@ -767,7 +813,7 @@ Phaser.Loader.prototype = {
*/ */
atlasJSONHash: function (key, textureURL, atlasURL, atlasData) { atlasJSONHash: function (key, textureURL, atlasURL, atlasData) {
this.atlas(key, textureURL, atlasURL, atlasData, Phaser.Loader.TEXTURE_ATLAS_JSON_HASH); return this.atlas(key, textureURL, atlasURL, atlasData, Phaser.Loader.TEXTURE_ATLAS_JSON_HASH);
}, },
@ -781,7 +827,7 @@ Phaser.Loader.prototype = {
*/ */
atlasXML: function (key, textureURL, atlasURL, atlasData) { atlasXML: function (key, textureURL, atlasURL, atlasData) {
this.atlas(key, textureURL, atlasURL, atlasData, Phaser.Loader.TEXTURE_ATLAS_XML_STARLING); return this.atlas(key, textureURL, atlasURL, atlasData, Phaser.Loader.TEXTURE_ATLAS_XML_STARLING);
}, },
@ -864,6 +910,8 @@ Phaser.Loader.prototype = {
} }
return this;
}, },
/** /**
@ -939,7 +987,7 @@ Phaser.Loader.prototype = {
case 'spritesheet': case 'spritesheet':
case 'textureatlas': case 'textureatlas':
case 'bitmapfont': case 'bitmapfont':
case 'tilemap': case 'tileset':
file.data = new Image(); file.data = new Image();
file.data.name = file.key; file.data.name = file.key;
file.data.onload = function () { file.data.onload = function () {
@ -1002,6 +1050,29 @@ Phaser.Loader.prototype = {
break; break;
case 'tilemap':
this._xhr.open("GET", this.baseURL + file.url, true);
this._xhr.responseType = "text";
if (file.format == Phaser.Tilemap.TILED_JSON)
{
this._xhr.onload = function () {
return _this.jsonLoadComplete(file.key);
};
}
else if (file.format == Phaser.Tilemap.CSV)
{
this._xhr.onload = function () {
return _this.csvLoadComplete(file.key);
};
}
this._xhr.onerror = function () {
return _this.dataLoadError(file.key);
};
this._xhr.send();
break;
case 'text': case 'text':
this._xhr.open("GET", this.baseURL + file.url, true); this._xhr.open("GET", this.baseURL + file.url, true);
this._xhr.responseType = "text"; this._xhr.responseType = "text";
@ -1056,7 +1127,7 @@ Phaser.Loader.prototype = {
this.onFileError.dispatch(key); this.onFileError.dispatch(key);
console.warn("Phaser.Loader error loading file: " + key); console.warn("Phaser.Loader error loading file: " + key + ' from URL ' + this._fileList[key].url);
this.nextFile(key, false); this.nextFile(key, false);
@ -1094,37 +1165,9 @@ Phaser.Loader.prototype = {
this.game.cache.addSpriteSheet(file.key, file.url, file.data, file.frameWidth, file.frameHeight, file.frameMax); this.game.cache.addSpriteSheet(file.key, file.url, file.data, file.frameWidth, file.frameHeight, file.frameMax);
break; break;
case 'tilemap': case 'tileset':
if (file.mapDataURL == null) this.game.cache.addTileset(file.key, file.url, file.data, file.tileWidth, file.tileHeight, file.tileMax, file.tileMargin, file.tileSpacing);
{
this.game.cache.addTilemap(file.key, file.url, file.data, file.mapData, file.format);
}
else
{
// Load the JSON or CSV before carrying on with the next file
loadNext = false;
this._xhr.open("GET", this.baseURL + file.mapDataURL, true);
this._xhr.responseType = "text";
if (file.format == Phaser.Tilemap.JSON)
{
this._xhr.onload = function () {
return _this.jsonLoadComplete(file.key);
};
}
else if (file.format == Phaser.Tilemap.CSV)
{
this._xhr.onload = function () {
return _this.csvLoadComplete(file.key);
};
}
this._xhr.onerror = function () {
return _this.dataLoadError(file.key);
};
this._xhr.send();
}
break; break;
case 'textureatlas': case 'textureatlas':
@ -1240,7 +1283,7 @@ Phaser.Loader.prototype = {
if (file.type == 'tilemap') if (file.type == 'tilemap')
{ {
this.game.cache.addTilemap(file.key, file.url, file.data, data, file.format); this.game.cache.addTilemap(file.key, file.url, data, file.format);
} }
else else
{ {
@ -1262,7 +1305,7 @@ Phaser.Loader.prototype = {
var data = this._xhr.response; var data = this._xhr.response;
var file = this._fileList[key]; var file = this._fileList[key];
this.game.cache.addTilemap(file.key, file.url, file.data, data, file.format); this.game.cache.addTilemap(file.key, file.url, data, file.format);
this.nextFile(key, true); this.nextFile(key, true);
@ -1405,7 +1448,7 @@ Phaser.Loader.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -424,7 +424,7 @@ Phaser.LoaderParser = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -524,7 +524,7 @@ Phaser.MSPointer.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -845,16 +845,21 @@ Phaser.Math = {
wrap: function (value, min, max) { wrap: function (value, min, max) {
var range = max - min; var range = max - min;
if (range &lt;= 0) if (range &lt;= 0)
{ {
return 0; return 0;
} }
var result = (value - min) % range; var result = (value - min) % range;
if (result &lt; 0) if (result &lt; 0)
{ {
result += range; result += range;
} }
return result + min; return result + min;
}, },
/** /**
@ -1005,13 +1010,20 @@ Phaser.Math = {
* @return {number} The new angle value, returns the same as the input angle if it was within bounds * @return {number} The new angle value, returns the same as the input angle if it was within bounds
*/ */
angleLimit: function (angle, min, max) { angleLimit: function (angle, min, max) {
var result = angle; var result = angle;
if (angle > max) {
if (angle > max)
{
result = max; result = max;
} else if (angle &lt; min) { }
else if (angle &lt; min)
{
result = min; result = min;
} }
return result; return result;
}, },
/** /**
@ -1022,16 +1034,23 @@ Phaser.Math = {
* @return {number} * @return {number}
*/ */
linearInterpolation: function (v, k) { linearInterpolation: function (v, k) {
var m = v.length - 1; var m = v.length - 1;
var f = m * k; var f = m * k;
var i = Math.floor(f); var i = Math.floor(f);
if (k &lt; 0) {
if (k &lt; 0)
{
return this.linear(v[0], v[1], f); return this.linear(v[0], v[1], f);
} }
if (k > 1) {
if (k > 1)
{
return this.linear(v[m], v[m - 1], m - f); return this.linear(v[m], v[m - 1], m - f);
} }
return this.linear(v[i], v[i + 1 > m ? m : i + 1], f - i); return this.linear(v[i], v[i + 1 > m ? m : i + 1], f - i);
}, },
/** /**
@ -1042,12 +1061,17 @@ Phaser.Math = {
* @return {number} * @return {number}
*/ */
bezierInterpolation: function (v, k) { bezierInterpolation: function (v, k) {
var b = 0; var b = 0;
var n = v.length - 1; var n = v.length - 1;
for (var i = 0; i &lt;= n; i++) {
for (var i = 0; i &lt;= n; i++)
{
b += Math.pow(1 - k, n - i) * Math.pow(k, i) * v[i] * this.bernstein(n, i); b += Math.pow(1 - k, n - i) * Math.pow(k, i) * v[i] * this.bernstein(n, i);
} }
return b; return b;
}, },
/** /**
@ -1063,20 +1087,31 @@ Phaser.Math = {
var f = m * k; var f = m * k;
var i = Math.floor(f); var i = Math.floor(f);
if (v[0] === v[m]) { if (v[0] === v[m])
if (k &lt; 0) { {
if (k &lt; 0)
{
i = Math.floor(f = m * (1 + k)); i = Math.floor(f = m * (1 + k));
} }
return this.catmullRom(v[(i - 1 + m) % m], v[i], v[(i + 1) % m], v[(i + 2) % m], f - i); return this.catmullRom(v[(i - 1 + m) % m], v[i], v[(i + 1) % m], v[(i + 2) % m], f - i);
} else {
if (k &lt; 0) { }
else
{
if (k &lt; 0)
{
return v[0] - (this.catmullRom(v[0], v[0], v[1], v[1], -f) - v[0]); return v[0] - (this.catmullRom(v[0], v[0], v[1], v[1], -f) - v[0]);
} }
if (k > 1) {
if (k > 1)
{
return v[m] - (this.catmullRom(v[m], v[m], v[m - 1], v[m - 1], f - m) - v[m]); return v[m] - (this.catmullRom(v[m], v[m], v[m - 1], v[m - 1], f - m) - v[m]);
} }
return this.catmullRom(v[i ? i - 1 : 0], v[i], v[m &lt; i + 1 ? m : i + 1], v[m &lt; i + 2 ? m : i + 2], f - i); return this.catmullRom(v[i ? i - 1 : 0], v[i], v[m &lt; i + 1 ? m : i + 1], v[m &lt; i + 2 ? m : i + 2], f - i);
} }
}, },
/** /**
@ -1112,8 +1147,11 @@ Phaser.Math = {
* @return {number} * @return {number}
*/ */
catmullRom: function (p0, p1, p2, p3, t) { catmullRom: function (p0, p1, p2, p3, t) {
var v0 = (p2 - p0) * 0.5, v1 = (p3 - p1) * 0.5, t2 = t * t, t3 = t * t2; var v0 = (p2 - p0) * 0.5, v1 = (p3 - p1) * 0.5, t2 = t * t, t3 = t * t2;
return (2 * p1 - 2 * p2 + v0 + v1) * t3 + (-3 * p1 + 3 * p2 - 2 * v0 - v1) * t2 + v0 * t + p1; return (2 * p1 - 2 * p2 + v0 + v1) * t3 + (-3 * p1 + 3 * p2 - 2 * v0 - v1) * t2 + v0 * t + p1;
}, },
/** /**
@ -1328,6 +1366,21 @@ Phaser.Math = {
return x &lt; a ? a : x; return x &lt; a ? a : x;
}, },
/**
* Checks if two values are within the given tolerance of each other.
*
* @method Phaser.Math#within
* @param {number} a - The first number to check
* @param {number} b - The second number to check
* @param {number} tolerance - The tolerance. Anything equal to or less than this is considered within the range.
* @return {boolean} True if a is &lt;= tolerance of b.
*/
within: function ( a, b, tolerance ) {
return (Math.abs(a - b) &lt;= tolerance);
},
/** /**
* Linear mapping from range &lt;a1, a2> to range &lt;b1, b2> * Linear mapping from range &lt;a1, a2> to range &lt;b1, b2>
@ -1459,7 +1512,7 @@ Phaser.Math = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -600,7 +600,7 @@ Phaser.Mouse.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -510,7 +510,7 @@ Phaser.Net.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -415,7 +415,7 @@ Phaser.Particles.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -698,7 +698,7 @@ It is created by the AnimationManager, consists of Animation.Frame objects and b
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-111">line 111</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-116">line 116</a>
</li></ul></dd> </li></ul></dd>
@ -902,7 +902,7 @@ It is created by the AnimationManager, consists of Animation.Frame objects and b
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-352">line 352</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-369">line 369</a>
</li></ul></dd> </li></ul></dd>
@ -1004,7 +1004,7 @@ It is created by the AnimationManager, consists of Animation.Frame objects and b
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-339">line 339</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-356">line 356</a>
</li></ul></dd> </li></ul></dd>
@ -1211,7 +1211,7 @@ It is created by the AnimationManager, consists of Animation.Frame objects and b
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-66">line 66</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-71">line 71</a>
</li></ul></dd> </li></ul></dd>
@ -1316,7 +1316,7 @@ It is created by the AnimationManager, consists of Animation.Frame objects and b
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-78">line 78</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-83">line 83</a>
</li></ul></dd> </li></ul></dd>
@ -1421,7 +1421,109 @@ It is created by the AnimationManager, consists of Animation.Frame objects and b
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-72">line 72</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-77">line 77</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="killOnComplete"><span class="type-signature"></span>killOnComplete<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>looped</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>The loop state of the Animation.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-65">line 65</a>
</li></ul></dd> </li></ul></dd>
@ -1727,7 +1829,7 @@ It is created by the AnimationManager, consists of Animation.Frame objects and b
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-305">line 305</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-322">line 322</a>
</li></ul></dd> </li></ul></dd>
@ -2007,7 +2109,7 @@ You could use this function to generate those by doing: Phaser.Animation.generat
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-385">line 385</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-402">line 402</a>
</li></ul></dd> </li></ul></dd>
@ -2076,7 +2178,7 @@ You could use this function to generate those by doing: Phaser.Animation.generat
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-268">line 268</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-280">line 280</a>
</li></ul></dd> </li></ul></dd>
@ -2145,7 +2247,7 @@ You could use this function to generate those by doing: Phaser.Animation.generat
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-285">line 285</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-297">line 297</a>
</li></ul></dd> </li></ul></dd>
@ -2173,7 +2275,7 @@ You could use this function to generate those by doing: Phaser.Animation.generat
<dt> <dt>
<h4 class="name" id="play"><span class="type-signature"></span>play<span class="signature">(<span class="optional">frameRate</span>, <span class="optional">loop</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Animation.html">Phaser.Animation</a>}</span></h4> <h4 class="name" id="play"><span class="type-signature"></span>play<span class="signature">(<span class="optional">frameRate</span>, <span class="optional">loop</span>, <span class="optional">killOnComplete</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Animation.html">Phaser.Animation</a>}</span></h4>
</dt> </dt>
@ -2285,7 +2387,7 @@ You could use this function to generate those by doing: Phaser.Animation.generat
<td class="default"> <td class="default">
null false
</td> </td>
@ -2294,6 +2396,45 @@ You could use this function to generate those by doing: Phaser.Animation.generat
</tr> </tr>
<tr>
<td class="name"><code>killOnComplete</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.</p></td>
</tr>
</tbody> </tbody>
</table> </table>
@ -2322,7 +2463,7 @@ You could use this function to generate those by doing: Phaser.Animation.generat
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-117">line 117</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-122">line 122</a>
</li></ul></dd> </li></ul></dd>
@ -2416,7 +2557,7 @@ You could use this function to generate those by doing: Phaser.Animation.generat
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-160">line 160</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-172">line 172</a>
</li></ul></dd> </li></ul></dd>
@ -2554,7 +2695,7 @@ You could use this function to generate those by doing: Phaser.Animation.generat
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-180">line 180</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-192">line 192</a>
</li></ul></dd> </li></ul></dd>
@ -2623,7 +2764,7 @@ You could use this function to generate those by doing: Phaser.Animation.generat
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-201">line 201</a> <a href="Animation.js.html">animation/Animation.js</a>, <a href="Animation.js.html#sunlight-1-line-213">line 213</a>
</li></ul></dd> </li></ul></dd>
@ -2674,7 +2815,7 @@ You could use this function to generate those by doing: Phaser.Animation.generat
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -662,7 +662,7 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-313">line 313</a> <a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-345">line 345</a>
</li></ul></dd> </li></ul></dd>
@ -764,7 +764,7 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-291">line 291</a>
</li></ul></dd> </li></ul></dd>
@ -866,7 +866,7 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-342">line 342</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> </li></ul></dd>
@ -968,7 +968,7 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-272">line 272</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> </li></ul></dd>
@ -1079,6 +1079,111 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
</dl>
</dd>
<dt>
<h4 class="name" id="isLoaded"><span class="type-signature"></span>isLoaded<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>isLoaded</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Set to true once animation data has been loaded.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-43">line 43</a>
</li></ul></dd>
</dl> </dl>
@ -1172,7 +1277,7 @@ Any Game Object such as Phaser.Sprite that supports animation contains a single
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-293">line 293</a> <a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-325">line 325</a>
</li></ul></dd> </li></ul></dd>
@ -1666,7 +1771,7 @@ Animations added in this way are played back with the play function.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-77">line 77</a> <a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-84">line 84</a>
</li></ul></dd> </li></ul></dd>
@ -1758,7 +1863,7 @@ Animations added in this way are played back with the play function.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-242">line 242</a> <a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-274">line 274</a>
</li></ul></dd> </li></ul></dd>
@ -1786,7 +1891,7 @@ Animations added in this way are played back with the play function.</p>
<dt> <dt>
<h4 class="name" id="play"><span class="type-signature"></span>play<span class="signature">(name, <span class="optional">frameRate</span>, <span class="optional">loop</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Animation.html">Phaser.Animation</a>}</span></h4> <h4 class="name" id="play"><span class="type-signature"></span>play<span class="signature">(name, <span class="optional">frameRate</span>, <span class="optional">loop</span>, <span class="optional">killOnComplete</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Animation.html">Phaser.Animation</a>}</span></h4>
</dt> </dt>
@ -1934,7 +2039,7 @@ If the requested animation is already playing this request will be ignored. If y
<td class="default"> <td class="default">
null false
</td> </td>
@ -1943,6 +2048,45 @@ If the requested animation is already playing this request will be ignored. If y
</tr> </tr>
<tr>
<td class="name"><code>killOnComplete</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.</p></td>
</tr>
</tbody> </tbody>
</table> </table>
@ -1971,7 +2115,7 @@ If the requested animation is already playing this request will be ignored. If y
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-157">line 157</a> <a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-176">line 176</a>
</li></ul></dd> </li></ul></dd>
@ -2017,6 +2161,75 @@ If the requested animation is already playing this request will be ignored. If y
</dd>
<dt>
<h4 class="name" id="refreshFrame"><span class="type-signature"></span>refreshFrame<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Refreshes the current frame data back to the parent Sprite and also resets the texture data.</p>
</div>
<dl class="details">
<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-262">line 262</a>
</li></ul></dd>
</dl>
</dd> </dd>
@ -2172,7 +2385,7 @@ The currentAnim property of the AnimationManager is automatically set to the ani
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-187">line 187</a> <a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-207">line 207</a>
</li></ul></dd> </li></ul></dd>
@ -2241,7 +2454,7 @@ The currentAnim property of the AnimationManager is automatically set to the ani
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-217">line 217</a> <a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-237">line 237</a>
</li></ul></dd> </li></ul></dd>
@ -2437,7 +2650,7 @@ The currentAnim property of the AnimationManager is automatically set to the ani
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-123">line 123</a> <a href="AnimationManager.js.html">animation/AnimationManager.js</a>, <a href="AnimationManager.js.html#sunlight-1-line-142">line 142</a>
</li></ul></dd> </li></ul></dd>
@ -2511,7 +2724,7 @@ The currentAnim property of the AnimationManager is automatically set to the ani
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1308,7 +1308,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:59 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

File diff suppressed because it is too large Load diff

View file

@ -544,7 +544,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-21">line 21</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-20">line 20</a>
</li></ul></dd> </li></ul></dd>
@ -630,7 +630,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-88">line 88</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-97">line 97</a>
</li></ul></dd> </li></ul></dd>
@ -690,7 +690,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-94">line 94</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-103">line 103</a>
</li></ul></dd> </li></ul></dd>
@ -750,7 +750,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-100">line 100</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-109">line 109</a>
</li></ul></dd> </li></ul></dd>
@ -810,7 +810,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-106">line 106</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-115">line 115</a>
</li></ul></dd> </li></ul></dd>
@ -912,7 +912,115 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-67">line 67</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-74">line 74</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="bounds"><span class="type-signature"></span>bounds<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The Camera is bound to this Rectangle and cannot move outside of it. By default it is enabled and set to the size of the World.
The Rectangle can be located anywhere in the world and updated as often as you like. If you don't wish the Camera to be bound
at all then set this to null. The values can be anything and are in World coordinates, with 0,0 being the center of the world.</p>
</div>
<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>bounds</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
</td>
<td class="description last"><p>The Rectangle in which the Camera is bounded. Set to null to allow for movement anywhere.</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-58">line 58</a>
</li></ul></dd> </li></ul></dd>
@ -1014,7 +1122,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-56">line 56</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-63">line 63</a>
</li></ul></dd> </li></ul></dd>
@ -1116,7 +1224,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-26">line 26</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-25">line 25</a>
</li></ul></dd> </li></ul></dd>
@ -1222,7 +1330,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-336">line 336</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-392">line 392</a>
</li></ul></dd> </li></ul></dd>
@ -1327,7 +1435,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-37">line 37</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-36">line 36</a>
</li></ul></dd> </li></ul></dd>
@ -1429,7 +1537,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-51">line 51</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-50">line 50</a>
</li></ul></dd> </li></ul></dd>
@ -1534,7 +1642,7 @@ The game automatically creates a single Stage sized camera on boot. Move the cam
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-73">line 73</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-80">line 80</a>
</li></ul></dd> </li></ul></dd>
@ -1643,7 +1751,7 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-46">line 46</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-45">line 45</a>
</li></ul></dd> </li></ul></dd>
@ -1748,7 +1856,7 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-62">line 62</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-69">line 69</a>
</li></ul></dd> </li></ul></dd>
@ -1854,7 +1962,7 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-319">line 319</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-375">line 375</a>
</li></ul></dd> </li></ul></dd>
@ -1956,7 +2064,7 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-31">line 31</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-30">line 30</a>
</li></ul></dd> </li></ul></dd>
@ -2062,7 +2170,7 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-283">line 283</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-329">line 329</a>
</li></ul></dd> </li></ul></dd>
@ -2168,7 +2276,7 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-301">line 301</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-352">line 352</a>
</li></ul></dd> </li></ul></dd>
@ -2233,7 +2341,125 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-213">line 213</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-255">line 255</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="focusOn"><span class="type-signature"></span>focusOn<span class="signature">(displayObject)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Move the camera focus on a display object instantly.</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>displayObject</code></td>
<td class="type">
<span class="param-type">any</span>
</td>
<td class="description last"><p>The display object to focus the camera on. Must have visible x/y properties.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<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-159">line 159</a>
</li></ul></dd> </li></ul></dd>
@ -2269,7 +2495,7 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,
<div class="description"> <div class="description">
<p>Move the camera focus to a location instantly.</p> <p>Move the camera focus on a location instantly.</p>
</div> </div>
@ -2374,7 +2600,7 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-150">line 150</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-170">line 170</a>
</li></ul></dd> </li></ul></dd>
@ -2535,7 +2761,7 @@ Objects outside of this view are not rendered (unless set to ignore the Camera,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-110">line 110</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-119">line 119</a>
</li></ul></dd> </li></ul></dd>
@ -2677,7 +2903,7 @@ without having to use game.camera.x and game.camera.y.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-251">line 251</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-293">line 293</a>
</li></ul></dd> </li></ul></dd>
@ -2818,7 +3044,7 @@ without having to use game.camera.x and game.camera.y.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-267">line 267</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-313">line 313</a>
</li></ul></dd> </li></ul></dd>
@ -2887,7 +3113,7 @@ without having to use game.camera.x and game.camera.y.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-163">line 163</a> <a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-182">line 182</a>
</li></ul></dd> </li></ul></dd>
@ -2938,7 +3164,7 @@ without having to use game.camera.x and game.camera.y.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:59 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -560,7 +560,7 @@ If no parent is given it will be added as a child of the document.body.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-133">line 133</a> <a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-134">line 134</a>
</li></ul></dd> </li></ul></dd>
@ -865,7 +865,7 @@ If no parent is given it will be added as a child of the document.body.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-60">line 60</a> <a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-61">line 61</a>
</li></ul></dd> </li></ul></dd>
@ -1049,7 +1049,7 @@ If no parent is given it will be added as a child of the document.body.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-36">line 36</a> <a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-37">line 37</a>
</li></ul></dd> </li></ul></dd>
@ -1235,7 +1235,7 @@ If no parent is given it will be added as a child of the document.body.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-71">line 71</a> <a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-72">line 72</a>
</li></ul></dd> </li></ul></dd>
@ -1377,7 +1377,7 @@ Note that if this doesn't given the desired result then see the CanvasUtils.setS
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-238">line 238</a> <a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-239">line 239</a>
</li></ul></dd> </li></ul></dd>
@ -1519,7 +1519,7 @@ Note that if this doesn't given the desired result then see the setSmoothingEnab
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-219">line 219</a> <a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-220">line 220</a>
</li></ul></dd> </li></ul></dd>
@ -1687,7 +1687,7 @@ patchy on earlier browsers, especially on mobile.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-195">line 195</a> <a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-196">line 196</a>
</li></ul></dd> </li></ul></dd>
@ -1871,7 +1871,7 @@ patchy on earlier browsers, especially on mobile.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-89">line 89</a> <a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-90">line 90</a>
</li></ul></dd> </li></ul></dd>
@ -2150,7 +2150,7 @@ patchy on earlier browsers, especially on mobile.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-174">line 174</a> <a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-175">line 175</a>
</li></ul></dd> </li></ul></dd>
@ -2334,7 +2334,7 @@ patchy on earlier browsers, especially on mobile.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-109">line 109</a> <a href="Canvas.js.html">system/Canvas.js</a>, <a href="Canvas.js.html#sunlight-1-line-110">line 110</a>
</li></ul></dd> </li></ul></dd>
@ -2408,7 +2408,7 @@ patchy on earlier browsers, especially on mobile.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:59 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -4188,7 +4188,7 @@ This method checks the radius distances between the two Circle objects to see if
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:59 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -3517,7 +3517,7 @@ RGB format information and HSL information. Each section starts on a newline, 3
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:59 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -4727,7 +4727,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-472">line 472</a> <a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-471">line 471</a>
</li></ul></dd> </li></ul></dd>
@ -4819,7 +4819,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-505">line 505</a> <a href="Device.js.html">system/Device.js</a>, <a href="Device.js.html#sunlight-1-line-504">line 504</a>
</li></ul></dd> </li></ul></dd>
@ -4893,7 +4893,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:59 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:59 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:59 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:59 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -587,7 +587,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -479,7 +479,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:59 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -2854,7 +2854,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -507,7 +507,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="FrameData.js.html">animation/FrameData.js</a>, <a href="FrameData.js.html#sunlight-1-line-223">line 223</a> <a href="FrameData.js.html">animation/FrameData.js</a>, <a href="FrameData.js.html#sunlight-1-line-226">line 226</a>
</li></ul></dd> </li></ul></dd>
@ -1801,7 +1801,7 @@ The frames are returned in the output array, or if none is provided in a new Arr
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:47 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -701,7 +701,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-120">line 120</a>
</li></ul></dd> </li></ul></dd>
@ -803,7 +803,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-66">line 66</a>
</li></ul></dd> </li></ul></dd>
@ -908,7 +908,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-125">line 125</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-126">line 126</a>
</li></ul></dd> </li></ul></dd>
@ -1013,7 +1013,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-203">line 203</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-204">line 204</a>
</li></ul></dd> </li></ul></dd>
@ -1118,7 +1118,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-210">line 210</a>
</li></ul></dd> </li></ul></dd>
@ -1223,7 +1223,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-215">line 215</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-216">line 216</a>
</li></ul></dd> </li></ul></dd>
@ -1328,7 +1328,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-222">line 222</a>
</li></ul></dd> </li></ul></dd>
@ -1433,7 +1433,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-197">line 197</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-198">line 198</a>
</li></ul></dd> </li></ul></dd>
@ -1535,7 +1535,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-55">line 55</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-56">line 56</a>
</li></ul></dd> </li></ul></dd>
@ -1637,7 +1637,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-38">line 38</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> </li></ul></dd>
@ -1742,7 +1742,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-131">line 131</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> </li></ul></dd>
@ -1847,7 +1847,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-101">line 101</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> </li></ul></dd>
@ -1952,7 +1952,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-107">line 107</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-108">line 108</a>
</li></ul></dd> </li></ul></dd>
@ -2057,7 +2057,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-137">line 137</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-138">line 138</a>
</li></ul></dd> </li></ul></dd>
@ -2162,7 +2162,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-143">line 143</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-144">line 144</a>
</li></ul></dd> </li></ul></dd>
@ -2267,7 +2267,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-150">line 150</a>
</li></ul></dd> </li></ul></dd>
@ -2369,7 +2369,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-43">line 43</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-44">line 44</a>
</li></ul></dd> </li></ul></dd>
@ -2474,7 +2474,7 @@ providing quick access to common functions and handling the boot process.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-227">line 227</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-228">line 228</a>
</li></ul></dd> </li></ul></dd>
@ -2581,7 +2581,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-441">line 441</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-442">line 442</a>
</li></ul></dd> </li></ul></dd>
@ -2686,7 +2686,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-185">line 185</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-186">line 186</a>
</li></ul></dd> </li></ul></dd>
@ -2791,7 +2791,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-113">line 113</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-114">line 114</a>
</li></ul></dd> </li></ul></dd>
@ -2896,7 +2896,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-72">line 72</a>
</li></ul></dd> </li></ul></dd>
@ -2998,7 +2998,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-88">line 88</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-89">line 89</a>
</li></ul></dd> </li></ul></dd>
@ -3103,7 +3103,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-191">line 191</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> </li></ul></dd>
@ -3208,7 +3208,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-155">line 155</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-156">line 156</a>
</li></ul></dd> </li></ul></dd>
@ -3313,7 +3313,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-161">line 161</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> </li></ul></dd>
@ -3415,7 +3415,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-76">line 76</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-77">line 77</a>
</li></ul></dd> </li></ul></dd>
@ -3520,7 +3520,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-167">line 167</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-168">line 168</a>
</li></ul></dd> </li></ul></dd>
@ -3622,7 +3622,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-60">line 60</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-61">line 61</a>
</li></ul></dd> </li></ul></dd>
@ -3727,7 +3727,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-173">line 173</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-174">line 174</a>
</li></ul></dd> </li></ul></dd>
@ -3829,7 +3829,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-50">line 50</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> </li></ul></dd>
@ -3934,7 +3934,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-180">line 180</a>
</li></ul></dd> </li></ul></dd>
@ -3999,7 +3999,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-251">line 251</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-252">line 252</a>
</li></ul></dd> </li></ul></dd>
@ -4068,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> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-418">line 418</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-419">line 419</a>
</li></ul></dd> </li></ul></dd>
@ -4137,7 +4137,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-369">line 369</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-370">line 370</a>
</li></ul></dd> </li></ul></dd>
@ -4206,7 +4206,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-332">line 332</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-333">line 333</a>
</li></ul></dd> </li></ul></dd>
@ -4324,7 +4324,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <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-383">line 383</a> <a href="Game.js.html">core/Game.js</a>, <a href="Game.js.html#sunlight-1-line-384">line 384</a>
</li></ul></dd> </li></ul></dd>
@ -4375,7 +4375,7 @@ When a game is paused the onPause event is dispatched. When it is resumed the on
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:47 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -525,7 +525,7 @@
</td> </td>
<td class="description last"><p>Only the root World Group should use this value.</p></td> <td class="description last"><p>Should the DisplayObjectContainer this Group creates be added to the World (default, false) or direct to the Stage (true).</p></td>
</tr> </tr>
@ -600,6 +600,108 @@
<dl> <dl>
<dt>
<h4 class="name" id="alpha"><span class="type-signature"></span>alpha<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>alpha</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The alpha value of the Group container.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1228">line 1228</a>
</li></ul></dd>
</dl>
</dd>
<dt> <dt>
<h4 class="name" id="angle"><span class="type-signature"></span>angle<span class="type-signature"></span></h4> <h4 class="name" id="angle"><span class="type-signature"></span>angle<span class="type-signature"></span></h4>
@ -690,7 +792,7 @@ This will have no impact on the rotation value of its children, but it will upda
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1106">line 1106</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1176">line 1176</a>
</li></ul></dd> </li></ul></dd>
@ -795,7 +897,7 @@ This will have no impact on the rotation value of its children, but it will upda
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-72">line 72</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-75">line 75</a>
</li></ul></dd> </li></ul></dd>
@ -897,7 +999,7 @@ This will have no impact on the rotation value of its children, but it will upda
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-29">line 29</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-32">line 32</a>
</li></ul></dd> </li></ul></dd>
@ -999,7 +1101,7 @@ This will have no impact on the rotation value of its children, but it will upda
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1057">line 1057</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1127">line 1127</a>
</li></ul></dd> </li></ul></dd>
@ -1101,7 +1203,7 @@ This will have no impact on the rotation value of its children, but it will upda
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-34">line 34</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-37">line 37</a>
</li></ul></dd> </li></ul></dd>
@ -1208,7 +1310,211 @@ This will have no impact on the rotation value of its children, but it will upda
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1124">line 1124</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1194">line 1194</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="scale"><span class="type-signature"></span>scale<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>scale</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
</td>
<td class="description last"><p>Replaces the PIXI.Point with a slightly more flexible one.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-80">line 80</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="total"><span class="type-signature">&lt;readonly> </span>total<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>total</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The total number of children in this Group, regardless of their alive state.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1114">line 1114</a>
</li></ul></dd> </li></ul></dd>
@ -1310,7 +1616,7 @@ This will have no impact on the rotation value of its children, but it will upda
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-66">line 66</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-69">line 69</a>
</li></ul></dd> </li></ul></dd>
@ -1412,7 +1718,7 @@ This will have no impact on the rotation value of its children, but it will upda
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1142">line 1142</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1212">line 1212</a>
</li></ul></dd> </li></ul></dd>
@ -1519,7 +1825,7 @@ This will have no impact on the x/y coordinates of its children, but it will upd
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1070">line 1070</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1140">line 1140</a>
</li></ul></dd> </li></ul></dd>
@ -1626,7 +1932,7 @@ This will have no impact on the x/y coordinates of its children, but it will upd
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1088">line 1088</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1158">line 1158</a>
</li></ul></dd> </li></ul></dd>
@ -1742,7 +2048,7 @@ that then see the addAt method.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-78">line 78</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-86">line 86</a>
</li></ul></dd> </li></ul></dd>
@ -1962,7 +2268,7 @@ Group.addAll('x', 10) will add 10 to the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-471">line 471</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-515">line 515</a>
</li></ul></dd> </li></ul></dd>
@ -2104,7 +2410,7 @@ The child is added to the Group at the location specified by the index value, th
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-107">line 107</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-115">line 115</a>
</li></ul></dd> </li></ul></dd>
@ -2245,7 +2551,7 @@ The child is added to the Group at the location specified by the index value, th
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-308">line 308</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-352">line 352</a>
</li></ul></dd> </li></ul></dd>
@ -2430,7 +2736,7 @@ After the callback parameter you can add as many extra parameters as you like, w
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-567">line 567</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-611">line 611</a>
</li></ul></dd> </li></ul></dd>
@ -2623,7 +2929,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-535">line 535</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-579">line 579</a>
</li></ul></dd> </li></ul></dd>
@ -2692,7 +2998,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-827">line 827</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-875">line 875</a>
</li></ul></dd> </li></ul></dd>
@ -2784,7 +3090,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-797">line 797</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-841">line 841</a>
</li></ul></dd> </li></ul></dd>
@ -2870,6 +3176,8 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<th>Default</th>
<th class="last">Description</th> <th class="last">Description</th>
</tr> </tr>
@ -2903,6 +3211,10 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<td class="default">
</td>
<td class="description last"><p>The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.</p></td> <td class="description last"><p>The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.</p></td>
</tr> </tr>
@ -2934,6 +3246,10 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<td class="default">
</td>
<td class="description last"><p>The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.</p></td> <td class="description last"><p>The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.</p></td>
</tr> </tr>
@ -2965,6 +3281,10 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<td class="default">
</td>
<td class="description last"><p>The Game.cache key of the image that this Sprite will use.</p></td> <td class="description last"><p>The Game.cache key of the image that this Sprite will use.</p></td>
</tr> </tr>
@ -3001,6 +3321,10 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<td class="default">
</td>
<td class="description last"><p>If the Sprite image contains multiple frames you can specify which one to use here.</p></td> <td class="description last"><p>If the Sprite image contains multiple frames you can specify which one to use here.</p></td>
</tr> </tr>
@ -3034,6 +3358,12 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<td class="default">
true
</td>
<td class="description last"><p>The default exists state of the Sprite.</p></td> <td class="description last"><p>The default exists state of the Sprite.</p></td>
</tr> </tr>
@ -3067,7 +3397,7 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-148">line 148</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-156">line 156</a>
</li></ul></dd> </li></ul></dd>
@ -3113,6 +3443,256 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
</dd>
<dt>
<h4 class="name" id="createMultiple"><span class="type-signature"></span>createMultiple<span class="signature">(quantity, key, <span class="optional">frame</span>, <span class="optional">exists</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group.
Useful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist
and will be positioned at 0, 0 (relative to the Group.x/y)</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>quantity</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The number of Sprites to create.</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Game.cache key of the image that this Sprite will use.</p></td>
</tr>
<tr>
<td class="name"><code>frame</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>If the Sprite image contains multiple frames you can specify which one to use here.</p></td>
</tr>
<tr>
<td class="name"><code>exists</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>The default exists state of the Sprite.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-190">line 190</a>
</li></ul></dd>
</dl>
</dd> </dd>
@ -3159,7 +3739,7 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-946">line 946</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1003">line 1003</a>
</li></ul></dd> </li></ul></dd>
@ -3347,7 +3927,7 @@ Group.divideAll('x', 2) will half the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-519">line 519</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-563">line 563</a>
</li></ul></dd> </li></ul></dd>
@ -3485,7 +4065,7 @@ Group.divideAll('x', 2) will half the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-965">line 965</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1022">line 1022</a>
</li></ul></dd> </li></ul></dd>
@ -3651,7 +4231,7 @@ For example: Group.forEach(awardBonusGold, this, true, 100, 500)</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-598">line 598</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-642">line 642</a>
</li></ul></dd> </li></ul></dd>
@ -3794,7 +4374,7 @@ For example: Group.forEachAlive(causeDamage, this, 500)</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-638">line 638</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-682">line 682</a>
</li></ul></dd> </li></ul></dd>
@ -3937,7 +4517,7 @@ For example: Group.forEachDead(bringToLife, this)</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-672">line 672</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-716">line 716</a>
</li></ul></dd> </li></ul></dd>
@ -4055,7 +4635,7 @@ For example: Group.forEachDead(bringToLife, this)</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-134">line 134</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-142">line 142</a>
</li></ul></dd> </li></ul></dd>
@ -4148,7 +4728,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-739">line 739</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-783">line 783</a>
</li></ul></dd> </li></ul></dd>
@ -4241,7 +4821,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-768">line 768</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-812">line 812</a>
</li></ul></dd> </li></ul></dd>
@ -4382,7 +4962,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-705">line 705</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-749">line 749</a>
</li></ul></dd> </li></ul></dd>
@ -4523,7 +5103,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-327">line 327</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-371">line 371</a>
</li></ul></dd> </li></ul></dd>
@ -4687,7 +5267,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-857">line 857</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-909">line 909</a>
</li></ul></dd> </li></ul></dd>
@ -4898,7 +5478,7 @@ Group.multiplyAll('x', 2) will x2 the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-503">line 503</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-547">line 547</a>
</li></ul></dd> </li></ul></dd>
@ -5016,7 +5596,7 @@ Group.multiplyAll('x', 2) will x2 the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-879">line 879</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-931">line 931</a>
</li></ul></dd> </li></ul></dd>
@ -5086,7 +5666,7 @@ The Group container remains on the display list.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-893">line 893</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-950">line 950</a>
</li></ul></dd> </li></ul></dd>
@ -5227,7 +5807,7 @@ The Group container remains on the display list.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-918">line 918</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-975">line 975</a>
</li></ul></dd> </li></ul></dd>
@ -5368,7 +5948,7 @@ The Group container remains on the display list.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-340">line 340</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-384">line 384</a>
</li></ul></dd> </li></ul></dd>
@ -5655,7 +6235,7 @@ The operation parameter controls how the new value is assigned to the property,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-433">line 433</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-477">line 477</a>
</li></ul></dd> </li></ul></dd>
@ -5898,7 +6478,7 @@ The operation parameter controls how the new value is assigned to the property,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-371">line 371</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-415">line 415</a>
</li></ul></dd> </li></ul></dd>
@ -6086,7 +6666,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-487">line 487</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-531">line 531</a>
</li></ul></dd> </li></ul></dd>
@ -6227,7 +6807,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-180">line 180</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-224">line 224</a>
</li></ul></dd> </li></ul></dd>
@ -6301,7 +6881,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:47 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:00 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -7473,7 +7473,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:47 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:01 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -7389,7 +7389,7 @@ This value is only set when the pointer is over this Sprite.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:47 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:01 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -2436,7 +2436,7 @@ If the key is up it holds the duration of the previous down session.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:47 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:01 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1438,7 +1438,7 @@ Pass in either a single keycode or an array/hash of keycodes.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-161">line 161</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-178">line 178</a>
</li></ul></dd> </li></ul></dd>
@ -1507,7 +1507,7 @@ Pass in either a single keycode or an array/hash of keycodes.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-195">line 195</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-212">line 212</a>
</li></ul></dd> </li></ul></dd>
@ -1530,6 +1530,98 @@ Pass in either a single keycode or an array/hash of keycodes.</p>
</dd>
<dt>
<h4 class="name" id="createCursorKeys"><span class="type-signature"></span>createCursorKeys<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Creates and returns an object containing 4 hotkeys for Up, Down, Left and Right.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-126">line 126</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An object containing properties: up, down, left and right. Which can be polled like any other Phaser.Key object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
</dd> </dd>
@ -1625,7 +1717,7 @@ Pass in either a single keycode or an array/hash of keycodes.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-347">line 347</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-377">line 377</a>
</li></ul></dd> </li></ul></dd>
@ -1821,7 +1913,7 @@ Pass in either a single keycode or an array/hash of keycodes.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-307">line 307</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-337">line 337</a>
</li></ul></dd> </li></ul></dd>
@ -2017,7 +2109,7 @@ Pass in either a single keycode or an array/hash of keycodes.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-327">line 327</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-357">line 357</a>
</li></ul></dd> </li></ul></dd>
@ -2158,7 +2250,7 @@ Pass in either a single keycode or an array/hash of keycodes.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-205">line 205</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-222">line 222</a>
</li></ul></dd> </li></ul></dd>
@ -2276,7 +2368,7 @@ Pass in either a single keycode or an array/hash of keycodes.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-261">line 261</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-278">line 278</a>
</li></ul></dd> </li></ul></dd>
@ -2512,7 +2604,7 @@ Pass in either a single keycode or an array/hash of keycodes.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-184">line 184</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-201">line 201</a>
</li></ul></dd> </li></ul></dd>
@ -2581,7 +2673,7 @@ Pass in either a single keycode or an array/hash of keycodes.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-294">line 294</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-324">line 324</a>
</li></ul></dd> </li></ul></dd>
@ -2651,7 +2743,7 @@ This is called automatically by Phaser.Input and should not normally be invoked
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-126">line 126</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-143">line 143</a>
</li></ul></dd> </li></ul></dd>
@ -2720,7 +2812,7 @@ This is called automatically by Phaser.Input and should not normally be invoked
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-149">line 149</a> <a href="Keyboard.js.html">input/Keyboard.js</a>, <a href="Keyboard.js.html#sunlight-1-line-166">line 166</a>
</li></ul></dd> </li></ul></dd>
@ -2771,7 +2863,7 @@ This is called automatically by Phaser.Input and should not normally be invoked
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:47 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:01 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1355,7 +1355,7 @@ The function must exist on the member.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:01 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -2324,7 +2324,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-465">line 465</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-511">line 511</a>
</li></ul></dd> </li></ul></dd>
@ -2488,7 +2488,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-423">line 423</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-469">line 469</a>
</li></ul></dd> </li></ul></dd>
@ -2652,7 +2652,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-437">line 437</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-483">line 483</a>
</li></ul></dd> </li></ul></dd>
@ -2816,7 +2816,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-451">line 451</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-497">line 497</a>
</li></ul></dd> </li></ul></dd>
@ -2980,7 +2980,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-296">line 296</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-329">line 329</a>
</li></ul></dd> </li></ul></dd>
@ -3205,7 +3205,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-363">line 363</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-407">line 407</a>
</li></ul></dd> </li></ul></dd>
@ -3464,7 +3464,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-931">line 931</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-974">line 974</a>
</li></ul></dd> </li></ul></dd>
@ -3582,7 +3582,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-948">line 948</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-991">line 991</a>
</li></ul></dd> </li></ul></dd>
@ -3700,7 +3700,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-742">line 742</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-813">line 813</a>
</li></ul></dd> </li></ul></dd>
@ -3818,7 +3818,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-723">line 723</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-794">line 794</a>
</li></ul></dd> </li></ul></dd>
@ -4100,7 +4100,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-907">line 907</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-950">line 950</a>
</li></ul></dd> </li></ul></dd>
@ -4169,7 +4169,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-558">line 558</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-606">line 606</a>
</li></ul></dd> </li></ul></dd>
@ -4287,7 +4287,7 @@ If you do so the Sprite's width or height will be cropped based on the percentag
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-546">line 546</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-594">line 594</a>
</li></ul></dd> </li></ul></dd>
@ -4559,7 +4559,7 @@ This allows you to easily make loading bars for games.</p>
<dt> <dt>
<h4 class="name" id="spritesheet"><span class="type-signature"></span>spritesheet<span class="signature">(key, url, frameWidth, frameHeight, frameMax)</span><span class="type-signature"></span></h4> <h4 class="name" id="spritesheet"><span class="type-signature"></span>spritesheet<span class="signature">(key, url, frameWidth, frameHeight, <span class="optional">frameMax</span>)</span><span class="type-signature"></span></h4>
</dt> </dt>
@ -4589,8 +4589,12 @@ This allows you to easily make loading bars for games.</p>
<th>Type</th> <th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th> <th class="last">Description</th>
</tr> </tr>
@ -4614,7 +4618,19 @@ This allows you to easily make loading bars for games.</p>
</td> </td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Unique asset key of the sheet file.</p></td> <td class="description last"><p>Unique asset key of the sheet file.</p></td>
@ -4637,7 +4653,19 @@ This allows you to easily make loading bars for games.</p>
</td> </td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the sheet file.</p></td> <td class="description last"><p>URL of the sheet file.</p></td>
@ -4660,7 +4688,19 @@ This allows you to easily make loading bars for games.</p>
</td> </td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Width of each single frame.</p></td> <td class="description last"><p>Width of each single frame.</p></td>
@ -4683,7 +4723,19 @@ This allows you to easily make loading bars for games.</p>
</td> </td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Height of each single frame.</p></td> <td class="description last"><p>Height of each single frame.</p></td>
@ -4706,10 +4758,26 @@ This allows you to easily make loading bars for games.</p>
</td> </td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>How many frames in this sprite sheet.</p></td>
<td class="default">
-1
</td>
<td class="description last"><p>How many frames in this sprite sheet. If not specified it will divide the whole image into frames.</p></td>
</tr> </tr>
@ -4741,7 +4809,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-275">line 275</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-279">line 279</a>
</li></ul></dd> </li></ul></dd>
@ -4810,7 +4878,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-569">line 569</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-617">line 617</a>
</li></ul></dd> </li></ul></dd>
@ -4974,7 +5042,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-256">line 256</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-258">line 258</a>
</li></ul></dd> </li></ul></dd>
@ -5232,7 +5300,363 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-315">line 315</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-350">line 350</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="tileset"><span class="type-signature"></span>tileset<span class="signature">(key, url, tileWidth, tileHeight, <span class="optional">tileMax</span>, <span class="optional">tileMargin</span>, <span class="optional">tileSpacing</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new tile set to the loader. These are used in the rendering of tile maps.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Unique asset key of the tileset file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the tileset.</p></td>
</tr>
<tr>
<td class="name"><code>tileWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Width of each single tile in pixels.</p></td>
</tr>
<tr>
<td class="name"><code>tileHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Height of each single tile in pixels.</p></td>
</tr>
<tr>
<td class="name"><code>tileMax</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
-1
</td>
<td class="description last"><p>How many tiles in this tileset. If not specified it will divide the whole image into tiles.</p></td>
</tr>
<tr>
<td class="name"><code>tileMargin</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If the tiles have been drawn with a margin, specify the amount here.</p></td>
</tr>
<tr>
<td class="name"><code>tileSpacing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If the tiles have been drawn with spacing between them, specify the amount here.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-302">line 302</a>
</li></ul></dd> </li></ul></dd>
@ -5350,7 +5774,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-966">line 966</a> <a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1009">line 1009</a>
</li></ul></dd> </li></ul></dd>
@ -5401,7 +5825,7 @@ This allows you to easily make loading bars for games.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:01 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -587,7 +587,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:01 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1620,7 +1620,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -765,7 +765,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-674">line 674</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-679">line 679</a>
</li></ul></dd> </li></ul></dd>
@ -1017,7 +1017,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-771">line 771</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-806">line 806</a>
</li></ul></dd> </li></ul></dd>
@ -1177,7 +1177,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-714">line 714</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-733">line 733</a>
</li></ul></dd> </li></ul></dd>
@ -1406,7 +1406,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-781">line 781</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-816">line 816</a>
</li></ul></dd> </li></ul></dd>
@ -1566,7 +1566,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-730">line 730</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-754">line 754</a>
</li></ul></dd> </li></ul></dd>
@ -1703,7 +1703,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-855">line 855</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-893">line 893</a>
</li></ul></dd> </li></ul></dd>
@ -2215,7 +2215,7 @@ Clamp value to range &lt;a, b&gt;</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-979">line 979</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1017">line 1017</a>
</li></ul></dd> </li></ul></dd>
@ -2375,7 +2375,7 @@ Clamp value to range &lt;a, b&gt;</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-995">line 995</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1033">line 1033</a>
</li></ul></dd> </li></ul></dd>
@ -2463,7 +2463,7 @@ Clamp value to range &lt;a, b&gt;</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1081">line 1081</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1134">line 1134</a>
</li></ul></dd> </li></ul></dd>
@ -2619,7 +2619,7 @@ Clamp value to range &lt;a, b&gt;</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-796">line 796</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-834">line 834</a>
</li></ul></dd> </li></ul></dd>
@ -2825,7 +2825,7 @@ Clamp value to range &lt;a, b&gt;</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-944">line 944</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-982">line 982</a>
</li></ul></dd> </li></ul></dd>
@ -3035,7 +3035,7 @@ Clamp value to range &lt;a, b&gt;</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-963">line 963</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1001">line 1001</a>
</li></ul></dd> </li></ul></dd>
@ -3176,7 +3176,7 @@ Clamp value to range &lt;a, b&gt;</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-840">line 840</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-878">line 878</a>
</li></ul></dd> </li></ul></dd>
@ -4424,7 +4424,7 @@ Will return null if random selection is missing, or array has no entries.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-806">line 806</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-844">line 844</a>
</li></ul></dd> </li></ul></dd>
@ -4977,7 +4977,7 @@ Will return null if random selection is missing, or array has no entries.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-582">line 582</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-587">line 587</a>
</li></ul></dd> </li></ul></dd>
@ -5118,7 +5118,7 @@ Will return null if random selection is missing, or array has no entries.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-569">line 569</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-574">line 574</a>
</li></ul></dd> </li></ul></dd>
@ -5305,7 +5305,7 @@ Will return null if random selection is missing, or array has no entries.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-759">line 759</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-794">line 794</a>
</li></ul></dd> </li></ul></dd>
@ -5465,7 +5465,7 @@ Will return null if random selection is missing, or array has no entries.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-694">line 694</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-706">line 706</a>
</li></ul></dd> </li></ul></dd>
@ -5717,7 +5717,7 @@ Will return null if random selection is missing, or array has no entries.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1009">line 1009</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1062">line 1062</a>
</li></ul></dd> </li></ul></dd>
@ -5806,7 +5806,7 @@ See <a href="http://jsperf.com/math-s-min-max-vs-homemade/5">http://jsperf.com/m
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-602">line 602</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-607">line 607</a>
</li></ul></dd> </li></ul></dd>
@ -6082,7 +6082,7 @@ See <a href="http://jsperf.com/math-s-min-max-vs-homemade/5">http://jsperf.com/m
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-623">line 623</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-628">line 628</a>
</li></ul></dd> </li></ul></dd>
@ -6938,7 +6938,7 @@ absolute value the return for exact angle</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1099">line 1099</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1152">line 1152</a>
</li></ul></dd> </li></ul></dd>
@ -7026,7 +7026,7 @@ absolute value the return for exact angle</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-559">line 559</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-564">line 564</a>
</li></ul></dd> </li></ul></dd>
@ -7511,7 +7511,7 @@ The original stack is modified in the process. This effectively moves the positi
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-907">line 907</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-945">line 945</a>
</li></ul></dd> </li></ul></dd>
@ -7652,7 +7652,7 @@ The original stack is modified in the process. This effectively moves the positi
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-924">line 924</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-962">line 962</a>
</li></ul></dd> </li></ul></dd>
@ -7794,7 +7794,7 @@ The original stack is modified in the process. This effectively moves the positi
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1067">line 1067</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1120">line 1120</a>
</li></ul></dd> </li></ul></dd>
@ -8004,7 +8004,7 @@ you should get the results via getSinTable() and getCosTable(). This generator i
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-867">line 867</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-905">line 905</a>
</li></ul></dd> </li></ul></dd>
@ -8191,7 +8191,7 @@ you should get the results via getSinTable() and getCosTable(). This generator i
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1047">line 1047</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1100">line 1100</a>
</li></ul></dd> </li></ul></dd>
@ -8374,7 +8374,7 @@ you should get the results via getSinTable() and getCosTable(). This generator i
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1027">line 1027</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1080">line 1080</a>
</li></ul></dd> </li></ul></dd>
@ -9368,6 +9368,193 @@ you should get the results via getSinTable() and getCosTable(). This generator i
</dd>
<dt>
<h4 class="name" id="within"><span class="type-signature"></span>within<span class="signature">(a, b, tolerance)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if two values are within the given tolerance of each other.</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>a</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The first number to check</p></td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The second number to check</p></td>
</tr>
<tr>
<td class="name"><code>tolerance</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The tolerance. Anything equal to or less than this is considered within the range.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1047">line 1047</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if a is &lt;= tolerance of b.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd> </dd>
@ -9637,7 +9824,7 @@ Should be called whenever the angle is updated on the Sprite to stop it from goi
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-644">line 644</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-649">line 649</a>
</li></ul></dd> </li></ul></dd>
@ -9825,7 +10012,7 @@ Should be called whenever the angle is updated on the Sprite to stop it from goi
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-537">line 537</a> <a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-542">line 542</a>
</li></ul></dd> </li></ul></dd>
@ -9899,7 +10086,7 @@ Should be called whenever the angle is updated on the Sprite to stop it from goi
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:01 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -2166,7 +2166,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1245,7 +1245,7 @@ Optionally you can redirect to the new url, or just return it as a string.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -811,7 +811,7 @@ This will have no impact on the rotation value of its children, but it will upda
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1106">line 1106</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1176">line 1176</a>
</li></ul></dd> </li></ul></dd>
@ -1669,7 +1669,7 @@ Emitter.emitX and Emitter.emitY control the emission location relative to the x/
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-29">line 29</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-32">line 32</a>
</li></ul></dd> </li></ul></dd>
@ -2092,7 +2092,7 @@ Emitter.emitX and Emitter.emitY control the emission location relative to the x/
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1057">line 1057</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1127">line 1127</a>
</li></ul></dd> </li></ul></dd>
@ -3598,7 +3598,114 @@ This will have no impact on the rotation value of its children, but it will upda
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1124">line 1124</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1194">line 1194</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="scale"><span class="type-signature"></span>scale<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>scale</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
</td>
<td class="description last"><p>Replaces the PIXI.Point with a slightly more flexible one.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Group.html#scale">Phaser.Group#scale</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-80">line 80</a>
</li></ul></dd> </li></ul></dd>
@ -3709,6 +3816,113 @@ This will have no impact on the rotation value of its children, but it will upda
</dl>
</dd>
<dt>
<h4 class="name" id="total"><span class="type-signature">&lt;readonly> </span>total<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>total</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The total number of children in this Group, regardless of their alive state.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Group.html#total">Phaser.Group#total</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1114">line 1114</a>
</li></ul></dd>
</dl> </dl>
@ -4548,7 +4762,7 @@ that then see the addAt method.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-78">line 78</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-86">line 86</a>
</li></ul></dd> </li></ul></dd>
@ -4773,7 +4987,7 @@ Group.addAll('x', 10) will add 10 to the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-471">line 471</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-515">line 515</a>
</li></ul></dd> </li></ul></dd>
@ -4920,7 +5134,7 @@ The child is added to the Group at the location specified by the index value, th
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-107">line 107</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-115">line 115</a>
</li></ul></dd> </li></ul></dd>
@ -5184,7 +5398,7 @@ The child is added to the Group at the location specified by the index value, th
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-308">line 308</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-352">line 352</a>
</li></ul></dd> </li></ul></dd>
@ -5374,7 +5588,7 @@ After the callback parameter you can add as many extra parameters as you like, w
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-567">line 567</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-611">line 611</a>
</li></ul></dd> </li></ul></dd>
@ -5572,7 +5786,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-535">line 535</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-579">line 579</a>
</li></ul></dd> </li></ul></dd>
@ -5646,7 +5860,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-827">line 827</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-875">line 875</a>
</li></ul></dd> </li></ul></dd>
@ -5743,7 +5957,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-797">line 797</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-841">line 841</a>
</li></ul></dd> </li></ul></dd>
@ -5829,6 +6043,8 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<th>Default</th>
<th class="last">Description</th> <th class="last">Description</th>
</tr> </tr>
@ -5862,6 +6078,10 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<td class="default">
</td>
<td class="description last"><p>The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.</p></td> <td class="description last"><p>The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.</p></td>
</tr> </tr>
@ -5893,6 +6113,10 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<td class="default">
</td>
<td class="description last"><p>The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.</p></td> <td class="description last"><p>The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.</p></td>
</tr> </tr>
@ -5924,6 +6148,10 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<td class="default">
</td>
<td class="description last"><p>The Game.cache key of the image that this Sprite will use.</p></td> <td class="description last"><p>The Game.cache key of the image that this Sprite will use.</p></td>
</tr> </tr>
@ -5960,6 +6188,10 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<td class="default">
</td>
<td class="description last"><p>If the Sprite image contains multiple frames you can specify which one to use here.</p></td> <td class="description last"><p>If the Sprite image contains multiple frames you can specify which one to use here.</p></td>
</tr> </tr>
@ -5993,6 +6225,12 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<td class="default">
true
</td>
<td class="description last"><p>The default exists state of the Sprite.</p></td> <td class="description last"><p>The default exists state of the Sprite.</p></td>
</tr> </tr>
@ -6031,7 +6269,7 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-148">line 148</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-156">line 156</a>
</li></ul></dd> </li></ul></dd>
@ -6077,6 +6315,261 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
</dd>
<dt>
<h4 class="name" id="createMultiple"><span class="type-signature"></span>createMultiple<span class="signature">(quantity, key, <span class="optional">frame</span>, <span class="optional">exists</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group.
Useful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist
and will be positioned at 0, 0 (relative to the Group.x/y)</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>quantity</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The number of Sprites to create.</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Game.cache key of the image that this Sprite will use.</p></td>
</tr>
<tr>
<td class="name"><code>frame</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>If the Sprite image contains multiple frames you can specify which one to use here.</p></td>
</tr>
<tr>
<td class="name"><code>exists</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>The default exists state of the Sprite.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Group.html#createMultiple">Phaser.Group#createMultiple</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-190">line 190</a>
</li></ul></dd>
</dl>
</dd> </dd>
@ -6128,7 +6621,7 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-946">line 946</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1003">line 1003</a>
</li></ul></dd> </li></ul></dd>
@ -6321,7 +6814,7 @@ Group.divideAll('x', 2) will half the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-519">line 519</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-563">line 563</a>
</li></ul></dd> </li></ul></dd>
@ -6464,7 +6957,7 @@ Group.divideAll('x', 2) will half the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-965">line 965</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1022">line 1022</a>
</li></ul></dd> </li></ul></dd>
@ -6704,7 +7197,7 @@ For example: Group.forEach(awardBonusGold, this, true, 100, 500)</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-598">line 598</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-642">line 642</a>
</li></ul></dd> </li></ul></dd>
@ -6852,7 +7345,7 @@ For example: Group.forEachAlive(causeDamage, this, 500)</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-638">line 638</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-682">line 682</a>
</li></ul></dd> </li></ul></dd>
@ -7000,7 +7493,7 @@ For example: Group.forEachDead(bringToLife, this)</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-672">line 672</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-716">line 716</a>
</li></ul></dd> </li></ul></dd>
@ -7123,7 +7616,7 @@ For example: Group.forEachDead(bringToLife, this)</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-134">line 134</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-142">line 142</a>
</li></ul></dd> </li></ul></dd>
@ -7221,7 +7714,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-739">line 739</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-783">line 783</a>
</li></ul></dd> </li></ul></dd>
@ -7319,7 +7812,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-768">line 768</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-812">line 812</a>
</li></ul></dd> </li></ul></dd>
@ -7465,7 +7958,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-705">line 705</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-749">line 749</a>
</li></ul></dd> </li></ul></dd>
@ -7611,7 +8104,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-327">line 327</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-371">line 371</a>
</li></ul></dd> </li></ul></dd>
@ -7780,7 +8273,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-857">line 857</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-909">line 909</a>
</li></ul></dd> </li></ul></dd>
@ -8286,7 +8779,7 @@ Group.multiplyAll('x', 2) will x2 the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-503">line 503</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-547">line 547</a>
</li></ul></dd> </li></ul></dd>
@ -8409,7 +8902,7 @@ Group.multiplyAll('x', 2) will x2 the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-879">line 879</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-931">line 931</a>
</li></ul></dd> </li></ul></dd>
@ -8484,7 +8977,7 @@ The Group container remains on the display list.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-893">line 893</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-950">line 950</a>
</li></ul></dd> </li></ul></dd>
@ -8630,7 +9123,7 @@ The Group container remains on the display list.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-918">line 918</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-975">line 975</a>
</li></ul></dd> </li></ul></dd>
@ -8776,7 +9269,7 @@ The Group container remains on the display list.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-340">line 340</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-384">line 384</a>
</li></ul></dd> </li></ul></dd>
@ -9138,7 +9631,7 @@ The operation parameter controls how the new value is assigned to the property,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-433">line 433</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-477">line 477</a>
</li></ul></dd> </li></ul></dd>
@ -9386,7 +9879,7 @@ The operation parameter controls how the new value is assigned to the property,
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-371">line 371</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-415">line 415</a>
</li></ul></dd> </li></ul></dd>
@ -10330,7 +10823,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-487">line 487</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-531">line 531</a>
</li></ul></dd> </li></ul></dd>
@ -10476,7 +10969,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-180">line 180</a> <a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-224">line 224</a>
</li></ul></dd> </li></ul></dd>
@ -10619,7 +11112,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1036,7 +1036,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1707,7 +1707,7 @@ It is only called if active is set to true.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1337,7 +1337,7 @@ It only calls plugins who have active=true.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -869,7 +869,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-256">line 256</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-258">line 258</a>
</li></ul></dd> </li></ul></dd>
@ -1084,7 +1084,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-343">line 343</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-345">line 345</a>
</li></ul></dd> </li></ul></dd>
@ -1299,7 +1299,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-313">line 313</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-315">line 315</a>
</li></ul></dd> </li></ul></dd>
@ -1463,7 +1463,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-332">line 332</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-334">line 334</a>
</li></ul></dd> </li></ul></dd>
@ -1678,7 +1678,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-294">line 294</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-296">line 296</a>
</li></ul></dd> </li></ul></dd>
@ -1934,7 +1934,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-366">line 366</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-368">line 368</a>
</li></ul></dd> </li></ul></dd>
@ -2149,7 +2149,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-275">line 275</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-277">line 277</a>
</li></ul></dd> </li></ul></dd>
@ -2313,7 +2313,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-66">line 66</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-68">line 68</a>
</li></ul></dd> </li></ul></dd>
@ -2477,7 +2477,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-154">line 154</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-156">line 156</a>
</li></ul></dd> </li></ul></dd>
@ -2641,7 +2641,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-126">line 126</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-128">line 128</a>
</li></ul></dd> </li></ul></dd>
@ -2805,7 +2805,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-140">line 140</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-142">line 142</a>
</li></ul></dd> </li></ul></dd>
@ -2958,7 +2958,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-169">line 169</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-171">line 171</a>
</li></ul></dd> </li></ul></dd>
@ -3240,7 +3240,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-183">line 183</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-185">line 185</a>
</li></ul></dd> </li></ul></dd>
@ -3381,7 +3381,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-193">line 193</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-195">line 195</a>
</li></ul></dd> </li></ul></dd>
@ -3565,7 +3565,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-208">line 208</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-210">line 210</a>
</li></ul></dd> </li></ul></dd>
@ -3729,7 +3729,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-111">line 111</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-113">line 113</a>
</li></ul></dd> </li></ul></dd>
@ -3870,7 +3870,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-221">line 221</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-223">line 223</a>
</li></ul></dd> </li></ul></dd>
@ -4126,7 +4126,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-96">line 96</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-98">line 98</a>
</li></ul></dd> </li></ul></dd>
@ -4403,7 +4403,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-231">line 231</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-233">line 233</a>
</li></ul></dd> </li></ul></dd>
@ -4731,7 +4731,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-81">line 81</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-83">line 83</a>
</li></ul></dd> </li></ul></dd>
@ -4823,7 +4823,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-245">line 245</a> <a href="Point.js.html">geom/Point.js</a>, <a href="Point.js.html#sunlight-1-line-247">line 247</a>
</li></ul></dd> </li></ul></dd>
@ -4897,7 +4897,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1120,7 +1120,7 @@ Default size of 44px (Apple's recommended &quot;finger tip&quot; size).</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-640">line 640</a> <a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-638">line 638</a>
</li></ul></dd> </li></ul></dd>
@ -3375,7 +3375,7 @@ Default size of 44px (Apple's recommended &quot;finger tip&quot; size).</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-661">line 661</a> <a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-659">line 659</a>
</li></ul></dd> </li></ul></dd>
@ -3481,7 +3481,7 @@ Default size of 44px (Apple's recommended &quot;finger tip&quot; size).</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-677">line 677</a> <a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-675">line 675</a>
</li></ul></dd> </li></ul></dd>
@ -3819,7 +3819,7 @@ Default size of 44px (Apple's recommended &quot;finger tip&quot; size).</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-573">line 573</a> <a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-571">line 571</a>
</li></ul></dd> </li></ul></dd>
@ -3968,7 +3968,7 @@ Default size of 44px (Apple's recommended &quot;finger tip&quot; size).</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-587">line 587</a> <a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-585">line 585</a>
</li></ul></dd> </li></ul></dd>
@ -4105,7 +4105,7 @@ Default size of 44px (Apple's recommended &quot;finger tip&quot; size).</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-482">line 482</a> <a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-480">line 480</a>
</li></ul></dd> </li></ul></dd>
@ -4292,7 +4292,7 @@ Default size of 44px (Apple's recommended &quot;finger tip&quot; size).</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-601">line 601</a> <a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-599">line 599</a>
</li></ul></dd> </li></ul></dd>
@ -4528,7 +4528,7 @@ Default size of 44px (Apple's recommended &quot;finger tip&quot; size).</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-494">line 494</a> <a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-492">line 492</a>
</li></ul></dd> </li></ul></dd>
@ -4597,7 +4597,7 @@ Default size of 44px (Apple's recommended &quot;finger tip&quot; size).</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-629">line 629</a> <a href="Pointer.js.html">input/Pointer.js</a>, <a href="Pointer.js.html#sunlight-1-line-627">line 627</a>
</li></ul></dd> </li></ul></dd>
@ -4740,7 +4740,7 @@ Default size of 44px (Apple's recommended &quot;finger tip&quot; size).</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1206,7 +1206,7 @@ Split the node into 4 subnodes</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -517,7 +517,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-238">line 238</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-237">line 237</a>
</li></ul></dd> </li></ul></dd>
@ -605,7 +605,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-134">line 134</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-136">line 136</a>
</li></ul></dd> </li></ul></dd>
@ -693,7 +693,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-125">line 125</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-127">line 127</a>
</li></ul></dd> </li></ul></dd>
@ -853,7 +853,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-152">line 152</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-154">line 154</a>
</li></ul></dd> </li></ul></dd>
@ -941,7 +941,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-179">line 179</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-178">line 178</a>
</li></ul></dd> </li></ul></dd>
@ -1078,7 +1078,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-207">line 207</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-206">line 206</a>
</li></ul></dd> </li></ul></dd>
@ -1166,7 +1166,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-143">line 143</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-145">line 145</a>
</li></ul></dd> </li></ul></dd>
@ -1326,7 +1326,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-163">line 163</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-165">line 165</a>
</li></ul></dd> </li></ul></dd>
@ -1604,7 +1604,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-227">line 227</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-226">line 226</a>
</li></ul></dd> </li></ul></dd>
@ -1692,7 +1692,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-188">line 188</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-187">line 187</a>
</li></ul></dd> </li></ul></dd>
@ -1829,7 +1829,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-217">line 217</a> <a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-216">line 216</a>
</li></ul></dd> </li></ul></dd>
@ -1899,7 +1899,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:03 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -3777,7 +3777,7 @@ This method compares the x, y, width and height properties of each Rectangle.</p
<dt> <dt>
<h4 class="name" id="intersects"><span class="type-signature">&lt;static> </span>intersects<span class="signature">(a, b, tolerance)</span><span class="type-signature"> &rarr; {boolean}</span></h4> <h4 class="name" id="intersects"><span class="type-signature">&lt;static> </span>intersects<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt> </dt>
@ -3863,29 +3863,6 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
</tr> </tr>
<tr>
<td class="name"><code>tolerance</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A tolerance value to allow for an intersection test with padding, default to 0</p></td>
</tr>
</tbody> </tbody>
</table> </table>
@ -4147,7 +4124,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-632">line 632</a> <a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-634">line 634</a>
</li></ul></dd> </li></ul></dd>
@ -4546,7 +4523,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-650">line 650</a> <a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-652">line 652</a>
</li></ul></dd> </li></ul></dd>
@ -7238,7 +7215,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:03 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1209,7 +1209,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:03 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -2194,7 +2194,7 @@ already dispatched before.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:03 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -5418,7 +5418,7 @@ This allows you to bundle multiple sounds together into a single audio file and
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:03 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -2326,7 +2326,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:49 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:03 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1383,7 +1383,7 @@ focus handling, game resizing, scaling and the pause, boot and orientation scree
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:03 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -2470,7 +2470,7 @@ If null it will scale to whatever width the browser can handle.</p></td>
<dt> <dt>
<h4 class="name" id="pageAlignVeritcally"><span class="type-signature"></span>pageAlignVeritcally<span class="type-signature"></span></h4> <h4 class="name" id="pageAlignVertically"><span class="type-signature"></span>pageAlignVertically<span class="type-signature"></span></h4>
</dt> </dt>
@ -2509,7 +2509,7 @@ If null it will scale to whatever width the browser can handle.</p></td>
<tr> <tr>
<td class="name"><code>pageAlignVeritcally</code></td> <td class="name"><code>pageAlignVertically</code></td>
<td class="type"> <td class="type">
@ -3720,7 +3720,7 @@ Please note that this needs to be supported by the web browser and isn't the sam
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:03 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -2474,7 +2474,7 @@ If you need to use the loader, you may need to use them here.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:03 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -3331,7 +3331,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:03 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -2795,7 +2795,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:04 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -2446,7 +2446,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:04 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1060,7 +1060,7 @@ You can pass as many tweens as you like to this function, they will each be chai
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-378">line 378</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-379">line 379</a>
</li></ul></dd> </li></ul></dd>
@ -1201,7 +1201,7 @@ You can pass as many tweens as you like to this function, they will each be chai
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-307">line 307</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-308">line 308</a>
</li></ul></dd> </li></ul></dd>
@ -1342,7 +1342,7 @@ You can pass as many tweens as you like to this function, they will each be chai
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-350">line 350</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-351">line 351</a>
</li></ul></dd> </li></ul></dd>
@ -1483,7 +1483,7 @@ You can pass as many tweens as you like to this function, they will each be chai
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-364">line 364</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-365">line 365</a>
</li></ul></dd> </li></ul></dd>
@ -1534,7 +1534,7 @@ You can pass as many tweens as you like to this function, they will each be chai
<dt> <dt>
<h4 class="name" id="loop"><span class="type-signature"></span>loop<span class="signature">()</span><span class="type-signature"> &rarr; {Tween}</span></h4> <h4 class="name" id="loop"><span class="type-signature"></span>loop<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Phaser.Tween.html">Phaser.Tween</a>}</span></h4>
</dt> </dt>
@ -1581,7 +1581,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-392">line 392</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-393">line 393</a>
</li></ul></dd> </li></ul></dd>
@ -1617,7 +1617,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
</dt> </dt>
<dd> <dd>
<span class="param-type">Tween</span> <span class="param-type"><a href="Phaser.Tween.html">Phaser.Tween</a></span>
</dd> </dd>
@ -1722,7 +1722,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-439">line 439</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-440">line 440</a>
</li></ul></dd> </li></ul></dd>
@ -1863,7 +1863,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-411">line 411</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-412">line 412</a>
</li></ul></dd> </li></ul></dd>
@ -2004,7 +2004,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-425">line 425</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-426">line 426</a>
</li></ul></dd> </li></ul></dd>
@ -2096,7 +2096,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-453">line 453</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-454">line 454</a>
</li></ul></dd> </li></ul></dd>
@ -2214,7 +2214,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-321">line 321</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-322">line 322</a>
</li></ul></dd> </li></ul></dd>
@ -2306,7 +2306,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-462">line 462</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-464">line 464</a>
</li></ul></dd> </li></ul></dd>
@ -2424,7 +2424,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-239">line 239</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-240">line 240</a>
</li></ul></dd> </li></ul></dd>
@ -2516,7 +2516,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-292">line 292</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-293">line 293</a>
</li></ul></dd> </li></ul></dd>
@ -2936,7 +2936,7 @@ game.add.tween(p).to({ x: 700 }, 1000, Phaser.Easing.Linear.None, true)
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-472">line 472</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-474">line 474</a>
</li></ul></dd> </li></ul></dd>
@ -3078,7 +3078,7 @@ Used in combination with repeat you can create endless loops.</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-335">line 335</a> <a href="Tween.js.html">tween/Tween.js</a>, <a href="Tween.js.html#sunlight-1-line-336">line 336</a>
</li></ul></dd> </li></ul></dd>
@ -3152,7 +3152,7 @@ Used in combination with repeat you can create endless loops.</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:04 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1508,7 +1508,7 @@ Please see <a href="https://github.com/sole/tween.js">https://github.com/sole/tw
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:04 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -1443,7 +1443,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-111">line 111</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-109">line 109</a>
</li></ul></dd> </li></ul></dd>
@ -1686,7 +1686,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-281">line 281</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-279">line 279</a>
</li></ul></dd> </li></ul></dd>
@ -1847,7 +1847,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-697">line 697</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-738">line 738</a>
</li></ul></dd> </li></ul></dd>
@ -2588,7 +2588,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-515">line 515</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-516">line 516</a>
</li></ul></dd> </li></ul></dd>
@ -2780,7 +2780,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-630">line 630</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-671">line 671</a>
</li></ul></dd> </li></ul></dd>
@ -2941,7 +2941,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-653">line 653</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-694">line 694</a>
</li></ul></dd> </li></ul></dd>
@ -3184,7 +3184,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-546">line 546</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-588">line 588</a>
</li></ul></dd> </li></ul></dd>
@ -3325,7 +3325,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-148">line 148</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-146">line 146</a>
</li></ul></dd> </li></ul></dd>
@ -3486,7 +3486,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-675">line 675</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-716">line 716</a>
</li></ul></dd> </li></ul></dd>
@ -3729,7 +3729,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-244">line 244</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-242">line 242</a>
</li></ul></dd> </li></ul></dd>
@ -3890,7 +3890,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-569">line 569</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-611">line 611</a>
</li></ul></dd> </li></ul></dd>
@ -4100,7 +4100,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-594">line 594</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-635">line 635</a>
</li></ul></dd> </li></ul></dd>
@ -4594,7 +4594,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-188">line 188</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-186">line 186</a>
</li></ul></dd> </li></ul></dd>
@ -5334,7 +5334,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-722">line 722</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-763">line 763</a>
</li></ul></dd> </li></ul></dd>
@ -5810,7 +5810,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-100">line 100</a> <a href="Debug.js.html">utils/Debug.js</a>, <a href="Debug.js.html#sunlight-1-line-97">line 97</a>
</li></ul></dd> </li></ul></dd>
@ -5861,7 +5861,7 @@ your game set to use Phaser.AUTO then swap it for Phaser.CANVAS to ensure WebGL
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:04 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -426,7 +426,7 @@
<dl> <dl>
<dt> <dt>
<h4 class="name" id="extend"><span class="type-signature">&lt;static> </span>extend<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4> <h4 class="name" id="extend"><span class="type-signature">&lt;static> </span>extend<span class="signature">(deep, target)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt> </dt>
@ -443,6 +443,78 @@
<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>deep</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Perform a deep copy?</p></td>
</tr>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The target object to copy to.</p></td>
</tr>
</tbody>
</table>
<dl class="details"> <dl class="details">
@ -467,7 +539,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-96">line 96</a> <a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-110">line 110</a>
</li></ul></dd> </li></ul></dd>
@ -608,7 +680,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-54">line 54</a> <a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-68">line 68</a>
</li></ul></dd> </li></ul></dd>
@ -878,7 +950,7 @@ dir = 1 (left), 2 (right), 3 (both)</p>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-13">line 13</a> <a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-27">line 27</a>
</li></ul></dd> </li></ul></dd>
@ -948,7 +1020,7 @@ dir = 1 (left), 2 (right), 3 (both)</p>
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:04 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -347,8 +347,7 @@
<div class="description"> <div class="description">
<p>&quot;This world is but a canvas to our imagination.&quot; - Henry David Thoreau</p> <p>&quot;This world is but a canvas to our imagination.&quot; - Henry David Thoreau</p>
<p>&lt;p&gt; <p>A game has only one world. The world is an abstract place in which all game objects live. It is not bound
A game has only one world. The world is an abstract place in which all game objects live. It is not bound
by stage limits and can be any size. You look into the world via cameras. All game objects live within by stage limits and can be any size. You look into the world via cameras. All game objects live within
the world at world-based coordinates. By default a world is created the same size as your Stage.</p> the world at world-based coordinates. By default a world is created the same size as your Stage.</p>
</div> </div>
@ -482,6 +481,13 @@ the world at world-based coordinates. By default a world is created the same siz
</dt> </dt>
<dd> <dd>
<div class="description">
<p>The World has no fixed size, but it does have a bounds outside of which objects are no longer considered as being &quot;in world&quot; and you should use this to clean-up the display list and purge dead objects.
By default we set the Bounds to be from 0,0 to Game.width,Game.height. I.e. it will match the size given to the game constructor with 0,0 representing the top-left of the display.
However 0,0 is actually the center of the world, and if you rotate or scale the world all of that will happen from 0,0.
So if you want to make a game in which the world itself will rotate you should adjust the bounds so that 0,0 is the center point, i.e. set them to -1000,-1000,2000,2000 for a 2000x2000 sized world centered around 0,0.</p>
</div>
@ -560,7 +566,7 @@ the world at world-based coordinates. By default a world is created the same siz
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-28">line 28</a> <a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-34">line 34</a>
</li></ul></dd> </li></ul></dd>
@ -662,7 +668,7 @@ the world at world-based coordinates. By default a world is created the same siz
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-33">line 33</a> <a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-39">line 39</a>
</li></ul></dd> </li></ul></dd>
@ -968,211 +974,7 @@ the world at world-based coordinates. By default a world is created the same siz
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-38">line 38</a> <a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-44">line 44</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="game"><span class="type-signature"></span>game<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>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"><p>A reference to the currently running Game.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-23">line 23</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="group"><span class="type-signature"></span>group<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>group</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Group.html">Phaser.Group</a></span>
</td>
<td class="description last"><p>Object container stores every object created with <code>create*</code> methods.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-43">line 43</a>
</li></ul></dd> </li></ul></dd>
@ -1478,7 +1280,109 @@ the world at world-based coordinates. By default a world is created the same siz
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-231">line 231</a> <a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-240">line 240</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="scale"><span class="type-signature"></span>scale<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>scale</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>
</td>
<td class="description last"><p>Replaces the PIXI.Point with a slightly more flexible one.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-25">line 25</a>
</li></ul></dd> </li></ul></dd>
@ -1645,7 +1549,7 @@ the world at world-based coordinates. By default a world is created the same siz
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-49">line 49</a> <a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-51">line 51</a>
</li></ul></dd> </li></ul></dd>
@ -1714,7 +1618,7 @@ the world at world-based coordinates. By default a world is created the same siz
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-143">line 143</a> <a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-145">line 145</a>
</li></ul></dd> </li></ul></dd>
@ -1811,7 +1715,7 @@ the world at world-based coordinates. By default a world is created the same siz
<dt> <dt>
<h4 class="name" id="setSize"><span class="type-signature"></span>setSize<span class="signature">(width, height)</span><span class="type-signature"></span></h4> <h4 class="name" id="setBounds"><span class="type-signature"></span>setBounds<span class="signature">(x, y, width, height)</span><span class="type-signature"></span></h4>
</dt> </dt>
@ -1819,7 +1723,8 @@ the world at world-based coordinates. By default a world is created the same siz
<div class="description"> <div class="description">
<p>Updates the size of this world.</p> <p>Updates the size of this world. Note that this doesn't modify the world x/y coordinates, just the width and height.
If you need to adjust the bounds of the world</p>
</div> </div>
@ -1851,6 +1756,52 @@ the world at world-based coordinates. By default a world is created the same siz
<tbody> <tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Top left most corner of the world.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Top left most corner of the world.</p></td>
</tr>
<tr> <tr>
<td class="name"><code>width</code></td> <td class="name"><code>width</code></td>
@ -1924,7 +1875,7 @@ the world at world-based coordinates. By default a world is created the same siz
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-123">line 123</a> <a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-125">line 125</a>
</li></ul></dd> </li></ul></dd>
@ -1993,7 +1944,7 @@ the world at world-based coordinates. By default a world is created the same siz
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-65">line 65</a> <a href="World.js.html">core/World.js</a>, <a href="World.js.html#sunlight-1-line-67">line 67</a>
</li></ul></dd> </li></ul></dd>
@ -2044,7 +1995,7 @@ the world at world-based coordinates. By default a world is created the same siz
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:50 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:52:04 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -555,7 +555,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:45 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -332,7 +332,7 @@
*/ */
var Phaser = Phaser || { var Phaser = Phaser || {
VERSION: '1.0.7-beta', VERSION: '1.1.0',
GAMES: [], GAMES: [],
AUTO: 0, AUTO: 0,
CANVAS: 1, CANVAS: 1,
@ -383,7 +383,7 @@ PIXI.InteractionManager = function (dummy) {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -457,7 +457,7 @@ Phaser.Plugin.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -574,7 +574,7 @@ Phaser.PluginManager.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -381,9 +381,11 @@ Phaser.Point.prototype = {
* @return {Point} This Point object. Useful for chaining method calls. * @return {Point} This Point object. Useful for chaining method calls.
**/ **/
setTo: function (x, y) { setTo: function (x, y) {
this.x = x; this.x = x;
this.y = y; this.y = y;
return this; return this;
}, },
/** /**
@ -737,7 +739,7 @@ Phaser.Point.rotate = function (a, x, y, angle, asDegrees, distance) {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -570,7 +570,7 @@ Phaser.Pointer.prototype = {
this.identifier = event.identifier; this.identifier = event.identifier;
this.target = event.target; this.target = event.target;
if (event.button) if (typeof event.button !== 'undefined')
{ {
this.button = event.button; this.button = event.button;
} }
@ -674,7 +674,7 @@ Phaser.Pointer.prototype = {
return; return;
} }
if (event.button) if (typeof event.button !== 'undefined')
{ {
this.button = event.button; this.button = event.button;
} }
@ -753,8 +753,6 @@ Phaser.Pointer.prototype = {
if (this._highestRenderObject == null) if (this._highestRenderObject == null)
{ {
// console.log("HRO null");
// The pointer isn't currently over anything, check if we've got a lingering previous target // The pointer isn't currently over anything, check if we've got a lingering previous target
if (this.targetObject) if (this.targetObject)
{ {
@ -1033,7 +1031,7 @@ Object.defineProperty(Phaser.Pointer.prototype, "worldY", {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -606,7 +606,7 @@ Phaser.QuadTree.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -403,10 +403,12 @@ Phaser.RandomDataGenerator.prototype = {
this.s0 = this.hash(' '); this.s0 = this.hash(' ');
this.s1 = this.hash(this.s0); this.s1 = this.hash(this.s0);
this.s2 = this.hash(this.s1); this.s2 = this.hash(this.s1);
this.c = 1;
var seed; var seed;
for (var i = 0; seed = seeds[i++]; ) { for (var i = 0; seed = seeds[i++]; )
{
this.s0 -= this.hash(seed); this.s0 -= this.hash(seed);
this.s0 += ~~(this.s0 &lt; 0); this.s0 += ~~(this.s0 &lt; 0);
this.s1 -= this.hash(seed); this.s1 -= this.hash(seed);
@ -492,9 +494,6 @@ Phaser.RandomDataGenerator.prototype = {
*/ */
realInRange: function (min, max) { realInRange: function (min, max) {
min = min || 0;
max = max || 0;
return this.frac() * (max - min) + min; return this.frac() * (max - min) + min;
}, },
@ -589,7 +588,7 @@ Phaser.RandomDataGenerator.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -941,14 +941,16 @@ Phaser.Rectangle.intersection = function (a, b, out) {
* @method Phaser.Rectangle.intersects * @method Phaser.Rectangle.intersects
* @param {Phaser.Rectangle} a - The first Rectangle object. * @param {Phaser.Rectangle} a - The first Rectangle object.
* @param {Phaser.Rectangle} b - The second Rectangle object. * @param {Phaser.Rectangle} b - The second Rectangle object.
* @param {number} tolerance - A tolerance value to allow for an intersection test with padding, default to 0
* @return {boolean} A value of true if the specified object intersects with this Rectangle object; otherwise false. * @return {boolean} A value of true if the specified object intersects with this Rectangle object; otherwise false.
*/ */
Phaser.Rectangle.intersects = function (a, b, tolerance) { Phaser.Rectangle.intersects = function (a, b) {
tolerance = tolerance || 0; return (a.x &lt; b.right && b.x &lt; a.right && a.y &lt; b.bottom && b.y &lt; a.bottom);
return !(a.x > b.right + tolerance || a.right &lt; b.x - tolerance || a.y > b.bottom + tolerance || a.bottom &lt; b.y - tolerance); // return (a.x &lt;= b.right && b.x &lt;= a.right && a.y &lt;= b.bottom && b.y &lt;= a.bottom);
// return (a.left &lt;= b.right && b.left &lt;= a.right && a.top &lt;= b.bottom && b.top &lt;= a.bottom);
// return !(a.x > b.right + tolerance || a.right &lt; b.x - tolerance || a.y > b.bottom + tolerance || a.bottom &lt; b.y - tolerance);
}; };
@ -982,7 +984,7 @@ Phaser.Rectangle.union = function (a, b, out) {
if (typeof out === "undefined") { out = new Phaser.Rectangle(); } if (typeof out === "undefined") { out = new Phaser.Rectangle(); }
return out.setTo(Math.min(a.x, b.x), Math.min(a.y, b.y), Math.max(a.right, b.right), Math.max(a.bottom, b.bottom)); return out.setTo(Math.min(a.x, b.x), Math.min(a.y, b.y), Math.max(a.right, b.right) - Math.min(a.left, b.left), Math.max(a.bottom, b.bottom) - Math.min(a.top, b.top));
}; };
</pre> </pre>
@ -1006,7 +1008,7 @@ Phaser.Rectangle.union = function (a, b, out) {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -494,7 +494,7 @@ Phaser.RequestAnimationFrame.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

View file

@ -639,7 +639,7 @@ Phaser.Signal.prototype = {
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Thu Oct 03 2013 02:35:44 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. on Wed Oct 23 2013 13:51:58 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span> </span>
</footer> </footer>
</div> </div>

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