Lots of doc updates!

This commit is contained in:
photonstorm
2013-10-25 16:54:40 +01:00
parent 0463bb4333
commit 9f9e6a2a57
147 changed files with 60434 additions and 972 deletions
+160 -40
View File
@@ -54,6 +54,18 @@
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li>
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li>
<a href="Phaser.Bullet.html">Bullet</a>
</li>
<li>
<a href="Phaser.Button.html">Button</a>
</li>
<li>
<a href="Phaser.Cache.html">Cache</a>
</li>
@@ -126,6 +138,10 @@
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
<li>
<a href="Phaser.Events.html">Events</a>
</li>
<li>
<a href="Phaser.Frame.html">Frame</a>
</li>
@@ -138,6 +154,14 @@
<a href="Phaser.Game.html">Game</a>
</li>
<li>
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li>
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li>
<a href="Phaser.Group.html">Group</a>
</li>
@@ -194,6 +218,14 @@
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li>
<a href="Phaser.Physics.html">Physics</a>
</li>
<li>
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li>
<a href="Phaser.Plugin.html">Plugin</a>
</li>
@@ -222,6 +254,10 @@
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li>
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li>
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
@@ -238,6 +274,10 @@
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li>
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li>
<a href="Phaser.Stage.html">Stage</a>
</li>
@@ -254,6 +294,14 @@
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li>
<a href="Phaser.Text.html">Text</a>
</li>
<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li>
<a href="Phaser.Time.html">Time</a>
</li>
@@ -296,10 +344,82 @@
<ul class="dropdown-menu ">
<li>
<a href="global.html#audio">audio</a>
</li>
<li>
<a href="global.html#bitmapText">bitmapText</a>
</li>
<li>
<a href="global.html#bottom">bottom</a>
</li>
<li>
<a href="global.html#button">button</a>
</li>
<li>
<a href="global.html#child">child</a>
</li>
<li>
<a href="global.html#emitter">emitter</a>
</li>
<li>
<a href="global.html#existing.">existing.</a>
</li>
<li>
<a href="global.html#graphics">graphics</a>
</li>
<li>
<a href="global.html#group">group</a>
</li>
<li>
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
</li>
<li>
<a href="global.html#renderTexture">renderTexture</a>
</li>
<li>
<a href="global.html#right">right</a>
</li>
<li>
<a href="global.html#sprite">sprite</a>
</li>
<li>
<a href="global.html#text">text</a>
</li>
<li>
<a href="global.html#tilemap">tilemap</a>
</li>
<li>
<a href="global.html#tilemaplayer">tilemaplayer</a>
</li>
<li>
<a href="global.html#tileset">tileset</a>
</li>
<li>
<a href="global.html#tileSprite">tileSprite</a>
</li>
<li>
<a href="global.html#tween">tween</a>
</li>
</ul>
</li>
@@ -811,7 +931,7 @@ This will have no impact on the rotation value of its children, but it will upda
<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-1176">line 1176</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1188">line 1188</a>
</li></ul></dd>
@@ -2092,7 +2212,7 @@ Emitter.emitX and Emitter.emitY control the emission location relative to the x/
<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-1127">line 1127</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1139">line 1139</a>
</li></ul></dd>
@@ -3598,7 +3718,7 @@ This will have no impact on the rotation value of its children, but it will upda
<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-1194">line 1194</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1206">line 1206</a>
</li></ul></dd>
@@ -3705,7 +3825,7 @@ This will have no impact on the rotation value of its children, but it will upda
<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>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-83">line 83</a>
</li></ul></dd>
@@ -3914,7 +4034,7 @@ This will have no impact on the rotation value of its children, but it will upda
<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>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1126">line 1126</a>
</li></ul></dd>
@@ -4762,7 +4882,7 @@ that then see the addAt method.</p>
<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-86">line 86</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-89">line 89</a>
</li></ul></dd>
@@ -4987,7 +5107,7 @@ Group.addAll('x', 10) will add 10 to the child.x value.</p>
<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-515">line 515</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-527">line 527</a>
</li></ul></dd>
@@ -5134,7 +5254,7 @@ The child is added to the Group at the location specified by the index value, th
<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-115">line 115</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-120">line 120</a>
</li></ul></dd>
@@ -5398,7 +5518,7 @@ The child is added to the Group at the location specified by the index value, th
<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-352">line 352</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-363">line 363</a>
</li></ul></dd>
@@ -5588,7 +5708,7 @@ After the callback parameter you can add as many extra parameters as you like, w
<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-611">line 611</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-623">line 623</a>
</li></ul></dd>
@@ -5786,7 +5906,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
<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-579">line 579</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-591">line 591</a>
</li></ul></dd>
@@ -5860,7 +5980,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
<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-875">line 875</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-887">line 887</a>
</li></ul></dd>
@@ -5957,7 +6077,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
<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-841">line 841</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-853">line 853</a>
</li></ul></dd>
@@ -6008,7 +6128,7 @@ After the existsValue parameter you can add as many parameters as you like, whic
<dt>
<h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(x, y, key, <span class="optional">frame</span>, <span class="optional">exists</span>)</span><span class="type-signature"> &rarr; {Phaser.Sprite}</span></h4>
<h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(x, y, key, <span class="optional">frame</span>, <span class="optional">exists</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Sprite.html">Phaser.Sprite</a>}</span></h4>
</dt>
@@ -6269,7 +6389,7 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
<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-156">line 156</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-163">line 163</a>
</li></ul></dd>
@@ -6305,7 +6425,7 @@ Useful if you don't need to create the Sprite instances before-hand.</p>
</dt>
<dd>
<span class="param-type">Phaser.Sprite</span>
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
</dd>
@@ -6547,7 +6667,7 @@ and will be positioned at 0, 0 (relative to the Group.x/y)</p>
<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>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-199">line 199</a>
</li></ul></dd>
@@ -6621,7 +6741,7 @@ and will be positioned at 0, 0 (relative to the Group.x/y)</p>
<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-1003">line 1003</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1015">line 1015</a>
</li></ul></dd>
@@ -6814,7 +6934,7 @@ Group.divideAll('x', 2) will half the child.x value.</p>
<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-563">line 563</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-575">line 575</a>
</li></ul></dd>
@@ -6957,7 +7077,7 @@ Group.divideAll('x', 2) will half the child.x value.</p>
<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-1022">line 1022</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1034">line 1034</a>
</li></ul></dd>
@@ -7197,7 +7317,7 @@ For example: Group.forEach(awardBonusGold, this, true, 100, 500)</p>
<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-642">line 642</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-654">line 654</a>
</li></ul></dd>
@@ -7345,7 +7465,7 @@ For example: Group.forEachAlive(causeDamage, this, 500)</p>
<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-682">line 682</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-694">line 694</a>
</li></ul></dd>
@@ -7493,7 +7613,7 @@ For example: Group.forEachDead(bringToLife, this)</p>
<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-716">line 716</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-728">line 728</a>
</li></ul></dd>
@@ -7616,7 +7736,7 @@ For example: Group.forEachDead(bringToLife, this)</p>
<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-142">line 142</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-149">line 149</a>
</li></ul></dd>
@@ -7714,7 +7834,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<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-783">line 783</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-795">line 795</a>
</li></ul></dd>
@@ -7812,7 +7932,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<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-812">line 812</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-824">line 824</a>
</li></ul></dd>
@@ -7958,7 +8078,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<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-749">line 749</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-761">line 761</a>
</li></ul></dd>
@@ -8104,7 +8224,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<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-371">line 371</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-382">line 382</a>
</li></ul></dd>
@@ -8273,7 +8393,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<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-909">line 909</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-921">line 921</a>
</li></ul></dd>
@@ -8779,7 +8899,7 @@ Group.multiplyAll('x', 2) will x2 the child.x value.</p>
<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-547">line 547</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-559">line 559</a>
</li></ul></dd>
@@ -8902,7 +9022,7 @@ Group.multiplyAll('x', 2) will x2 the child.x value.</p>
<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-931">line 931</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-943">line 943</a>
</li></ul></dd>
@@ -8977,7 +9097,7 @@ The Group container remains on the display list.</p>
<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-950">line 950</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-962">line 962</a>
</li></ul></dd>
@@ -9123,7 +9243,7 @@ The Group container remains on the display list.</p>
<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-975">line 975</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-987">line 987</a>
</li></ul></dd>
@@ -9269,7 +9389,7 @@ The Group container remains on the display list.</p>
<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-384">line 384</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-395">line 395</a>
</li></ul></dd>
@@ -9631,7 +9751,7 @@ The operation parameter controls how the new value is assigned to the property,
<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-477">line 477</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-489">line 489</a>
</li></ul></dd>
@@ -9879,7 +9999,7 @@ The operation parameter controls how the new value is assigned to the property,
<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-415">line 415</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-427">line 427</a>
</li></ul></dd>
@@ -10823,7 +10943,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
<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-531">line 531</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-543">line 543</a>
</li></ul></dd>
@@ -10969,7 +11089,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
<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-224">line 224</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-235">line 235</a>
</li></ul></dd>
@@ -11111,8 +11231,8 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
on Wed Oct 23 2013 13:52:02 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Fri Oct 25 2013 16:16:47 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>