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
+229 -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>
@@ -652,7 +772,7 @@
<dt class="tag-source">Source:</dt>
<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-282">line 282</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-295">line 295</a>
</li></ul></dd>
@@ -758,7 +878,7 @@
<dt class="tag-source">Source:</dt>
<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-303">line 303</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-316">line 316</a>
</li></ul></dd>
@@ -864,7 +984,7 @@
<dt class="tag-source">Source:</dt>
<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-392">line 392</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-405">line 405</a>
</li></ul></dd>
@@ -970,7 +1090,7 @@
<dt class="tag-source">Source:</dt>
<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-409">line 409</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-422">line 422</a>
</li></ul></dd>
@@ -1077,7 +1197,7 @@ If set to true then all of the Rectangle properties are set to 0.</p>
<dt class="tag-source">Source:</dt>
<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-467">line 467</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-480">line 480</a>
</li></ul></dd>
@@ -1179,7 +1299,7 @@ If set to true then all of the Rectangle properties are set to 0.</p>
<dt class="tag-source">Source:</dt>
<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-269">line 269</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-282">line 282</a>
</li></ul></dd>
@@ -1281,7 +1401,7 @@ If set to true then all of the Rectangle properties are set to 0.</p>
<dt class="tag-source">Source:</dt>
<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-256">line 256</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-269">line 269</a>
</li></ul></dd>
@@ -1489,7 +1609,7 @@ If set to true then all of the Rectangle properties are set to 0.</p>
<dt class="tag-source">Source:</dt>
<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-321">line 321</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-334">line 334</a>
</li></ul></dd>
@@ -1595,7 +1715,7 @@ If set to true then all of the Rectangle properties are set to 0.</p>
<dt class="tag-source">Source:</dt>
<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-378">line 378</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-391">line 391</a>
</li></ul></dd>
@@ -1701,7 +1821,7 @@ If set to true then all of the Rectangle properties are set to 0.</p>
<dt class="tag-source">Source:</dt>
<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-343">line 343</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-356">line 356</a>
</li></ul></dd>
@@ -1808,7 +1928,7 @@ However it does affect the height property, whereas changing the y value does no
<dt class="tag-source">Source:</dt>
<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-426">line 426</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-439">line 439</a>
</li></ul></dd>
@@ -1914,7 +2034,7 @@ However it does affect the height property, whereas changing the y value does no
<dt class="tag-source">Source:</dt>
<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-449">line 449</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-462">line 462</a>
</li></ul></dd>
@@ -2020,7 +2140,7 @@ However it does affect the height property, whereas changing the y value does no
<dt class="tag-source">Source:</dt>
<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-364">line 364</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-377">line 377</a>
</li></ul></dd>
@@ -2483,7 +2603,7 @@ However it does affect the height property, whereas changing the y value does no
<dt class="tag-source">Source:</dt>
<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-524">line 524</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-537">line 537</a>
</li></ul></dd>
@@ -2666,7 +2786,7 @@ However it does affect the height property, whereas changing the y value does no
<dt class="tag-source">Source:</dt>
<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-536">line 536</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-549">line 549</a>
</li></ul></dd>
@@ -2830,7 +2950,7 @@ However it does affect the height property, whereas changing the y value does no
<dt class="tag-source">Source:</dt>
<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-548">line 548</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-565">line 565</a>
</li></ul></dd>
@@ -2995,7 +3115,7 @@ A Rectangle object is said to contain another if the second Rectangle object fal
<dt class="tag-source">Source:</dt>
<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-559">line 559</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-576">line 576</a>
</li></ul></dd>
@@ -3160,7 +3280,7 @@ This method compares the x, y, width and height properties of each Rectangle.</p
<dt class="tag-source">Source:</dt>
<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-579">line 579</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-596">line 596</a>
</li></ul></dd>
@@ -3347,7 +3467,7 @@ This method compares the x, y, width and height properties of each Rectangle.</p
<dt class="tag-source">Source:</dt>
<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-485">line 485</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-498">line 498</a>
</li></ul></dd>
@@ -3511,7 +3631,7 @@ This method compares the x, y, width and height properties of each Rectangle.</p
<dt class="tag-source">Source:</dt>
<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-501">line 501</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-514">line 514</a>
</li></ul></dd>
@@ -3726,7 +3846,7 @@ This method compares the x, y, width and height properties of each Rectangle.</p
<dt class="tag-source">Source:</dt>
<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-591">line 591</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-608">line 608</a>
</li></ul></dd>
@@ -3891,7 +4011,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-615">line 615</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-632">line 632</a>
</li></ul></dd>
@@ -4124,7 +4244,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-634">line 634</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-651">line 651</a>
</li></ul></dd>
@@ -4308,7 +4428,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-512">line 512</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-525">line 525</a>
</li></ul></dd>
@@ -4523,7 +4643,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-652">line 652</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-669">line 669</a>
</li></ul></dd>
@@ -4676,7 +4796,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-154">line 154</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-167">line 167</a>
</li></ul></dd>
@@ -4836,7 +4956,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-164">line 164</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-177">line 177</a>
</li></ul></dd>
@@ -4978,7 +5098,7 @@ A Rectangle object is said to contain another if the second Rectangle object fal
<dt class="tag-source">Source:</dt>
<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-175">line 175</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-188">line 188</a>
</li></ul></dd>
@@ -5119,7 +5239,7 @@ A Rectangle object is said to contain another if the second Rectangle object fal
<dt class="tag-source">Source:</dt>
<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-106">line 106</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-119">line 119</a>
</li></ul></dd>
@@ -5260,7 +5380,7 @@ A Rectangle object is said to contain another if the second Rectangle object fal
<dt class="tag-source">Source:</dt>
<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-116">line 116</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-129">line 129</a>
</li></ul></dd>
@@ -5402,7 +5522,7 @@ This method compares the x, y, width and height properties of each Rectangle.</p
<dt class="tag-source">Source:</dt>
<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-186">line 186</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-199">line 199</a>
</li></ul></dd>
@@ -5517,6 +5637,75 @@ This method compares the x, y, width and height properties of each Rectangle.</p
</dd>
<dt>
<h4 class="name" id="floorAll"><span class="type-signature"></span>floorAll<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Runs Math.floor() on the x, y, width and height values of this Rectangle.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<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-106">line 106</a>
</li></ul></dd>
</dl>
</dd>
@@ -5635,7 +5824,7 @@ This method compares the x, y, width and height properties of each Rectangle.</p
<dt class="tag-source">Source:</dt>
<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-133">line 133</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-146">line 146</a>
</li></ul></dd>
@@ -5799,7 +5988,7 @@ This method compares the x, y, width and height properties of each Rectangle.</p
<dt class="tag-source">Source:</dt>
<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-197">line 197</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-210">line 210</a>
</li></ul></dd>
@@ -5964,7 +6153,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-208">line 208</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-221">line 221</a>
</li></ul></dd>
@@ -6197,7 +6386,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-220">line 220</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-233">line 233</a>
</li></ul></dd>
@@ -6865,7 +7054,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-144">line 144</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-157">line 157</a>
</li></ul></dd>
@@ -6957,7 +7146,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-245">line 245</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-258">line 258</a>
</li></ul></dd>
@@ -7141,7 +7330,7 @@ This method checks the x, y, width, and height properties of the Rectangles.</p>
<dt class="tag-source">Source:</dt>
<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-234">line 234</a>
<a href="Rectangle.js.html">geom/Rectangle.js</a>, <a href="Rectangle.js.html#sunlight-1-line-247">line 247</a>
</li></ul></dd>
@@ -7214,8 +7403,8 @@ This method checks the x, y, width, and height properties of the Rectangles.</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:03 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:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>