Updated docs - they now actually list the new body methods :)

This commit is contained in:
photonstorm
2014-02-21 15:37:26 +00:00
parent 7ee0c20bb3
commit e9e5bf9436
192 changed files with 51286 additions and 4396 deletions
+50 -16
View File
@@ -166,6 +166,10 @@
<a href="Phaser.Game.html">Game</a>
</li>
<li>
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li>
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
@@ -254,6 +258,38 @@
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li>
<a href="Phaser.Physics.Body.html">Body</a>
</li>
<li>
<a href="Phaser.Physics.CollisionGroup.html">CollisionGroup</a>
</li>
<li>
<a href="Phaser.Physics.ContactMaterial.html">ContactMaterial</a>
</li>
<li>
<a href="Phaser.Physics.InversePointProxy.html">InversePointProxy</a>
</li>
<li>
<a href="Phaser.Physics.Material.html">Material</a>
</li>
<li>
<a href="Phaser.Physics.PointProxy.html">PointProxy</a>
</li>
<li>
<a href="Phaser.Physics.Spring.html">Spring</a>
</li>
<li>
<a href="Phaser.Physics.World.html">World</a>
</li>
<li>
<a href="Phaser.Plugin.html">Plugin</a>
</li>
@@ -465,18 +501,20 @@
* @classdesc A Group is a container for display objects that allows for fast pooling and object recycling. Groups can be nested within other Groups and have their own local transforms.
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
* @param {Phaser.Group|Phaser.Sprite} parent - The parent Group, DisplayObject or DisplayObjectContainer that this Group will be added to. If undefined or null it will use game.world.
* @param {Phaser.Group|Phaser.Sprite|null} parent - The parent Group, DisplayObject or DisplayObjectContainer that this Group will be added to. If undefined it will use game.world. If null it won't be added to anything.
* @param {string} [name=group] - A name for this Group. Not used internally but useful for debugging.
* @param {boolean} [addToStage=false] - If set to true this Group will be added directly to the Game.Stage instead of Game.World.
*/
Phaser.Group = function (game, parent, name, addToStage) {
if (typeof addToStage === 'undefined') { addToStage = false; }
/**
* @property {Phaser.Game} game - A reference to the currently running Game.
*/
this.game = game;
if (typeof parent === 'undefined' || parent === null)
if (typeof parent === 'undefined')
{
parent = game.world;
}
@@ -488,20 +526,16 @@ Phaser.Group = function (game, parent, name, addToStage) {
PIXI.DisplayObjectContainer.call(this);
if (typeof addToStage === 'undefined' || addToStage === false)
if (addToStage)
{
this.game.stage.addChild(this);
}
else
{
if (parent)
{
parent.addChild(this);
}
else
{
this.game.stage.addChild(this);
}
}
else
{
this.game.stage.addChild(this);
}
/**
@@ -1272,11 +1306,11 @@ Phaser.Group.prototype.forEach = function (callback, callbackContext, checkExist
}
/**
* Allows you to call your own function on each alive member of this Group (where child.alive=true). You must pass the callback and context in which it will run.
* Allows you to call your own function on each member of this Group where child.exists=true. You must pass the callback and context in which it will run.
* You can add as many parameters as you like, which will all be passed to the callback along with the child.
* For example: Group.forEachAlive(causeDamage, this, 500)
* For example: Group.forEachExists(causeDamage, this, 500)
*
* @method Phaser.Group#forEachAlive
* @method Phaser.Group#forEachExists
* @param {function} callback - The function that will be called. Each child of the Group will be passed to it as its first parameter.
* @param {Object} callbackContext - The context in which the function should be called (usually 'this').
*/
@@ -1602,7 +1636,7 @@ Phaser.Group.prototype.destroy = function (destroyChildren) {
{
do
{
if (this.children[0].group)
if (this.children[0].parent)
{
this.children[0].destroy();
}
@@ -1757,7 +1791,7 @@ Object.defineProperty(Phaser.Group.prototype, "fixedToCamera", {
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Wed Feb 19 2014 05:26:20 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Fri Feb 21 2014 15:36:21 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>