Updated documentation.

This commit is contained in:
photonstorm
2013-11-28 15:57:09 +00:00
parent 8da9b67c18
commit f22159e257
193 changed files with 68905 additions and 93104 deletions
+112 -28
View File
@@ -54,6 +54,10 @@
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li>
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li>
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
@@ -138,6 +142,10 @@
<a href="Phaser.Events.html">Events</a>
</li>
<li>
<a href="Phaser.Filter.html">Filter</a>
</li>
<li>
<a href="Phaser.Frame.html">Frame</a>
</li>
@@ -302,6 +310,26 @@
<a href="Phaser.Text.html">Text</a>
</li>
<li>
<a href="Phaser.Tile.html">Tile</a>
</li>
<li>
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li>
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li>
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li>
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
@@ -310,6 +338,10 @@
<a href="Phaser.Time.html">Time</a>
</li>
<li>
<a href="Phaser.Timer.html">Timer</a>
</li>
<li>
<a href="Phaser.Touch.html">Touch</a>
</li>
@@ -356,6 +388,14 @@
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
</li>
<li>
<a href="global.html#render">render</a>
</li>
<li>
<a href="global.html#renderXY">renderXY</a>
</li>
<li>
<a href="global.html#right">right</a>
</li>
@@ -490,7 +530,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-18">line 18</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-20">line 20</a>
</li></ul></dd>
@@ -577,7 +617,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-237">line 237</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-238">line 238</a>
</li></ul></dd>
@@ -601,6 +641,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A random number between -180 and 180.</p>
</div>
<dl>
@@ -665,7 +709,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-136">line 136</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-138">line 138</a>
</li></ul></dd>
@@ -689,6 +733,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A random real number between 0 and 1.</p>
</div>
<dl>
@@ -753,7 +801,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-127">line 127</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-129">line 129</a>
</li></ul></dd>
@@ -777,6 +825,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A random integer between 0 and 2^32.</p>
</div>
<dl>
@@ -858,7 +910,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<td class="description last"></td>
<td class="description last"><p>The minimum value in the range.</p></td>
</tr>
@@ -881,7 +933,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<td class="description last"></td>
<td class="description last"><p>The maximum value in the range.</p></td>
</tr>
@@ -913,7 +965,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-154">line 154</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-156">line 156</a>
</li></ul></dd>
@@ -937,6 +989,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A random number between min and max.</p>
</div>
<dl>
@@ -1001,7 +1057,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-178">line 178</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-180">line 180</a>
</li></ul></dd>
@@ -1025,6 +1081,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A random real number between -1 and 1.</p>
</div>
<dl>
@@ -1048,7 +1108,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt>
<h4 class="name" id="pick"><span class="type-signature"></span>pick<span class="signature">(ary)</span><span class="type-signature"> &rarr; {number}</span></h4>
<h4 class="name" id="pick"><span class="type-signature"></span>pick<span class="signature">(ary)</span><span class="type-signature"> &rarr; {any}</span></h4>
</dt>
@@ -1096,7 +1156,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<td class="type">
<span class="param-type">Any</span>
<span class="param-type">Array</span>
@@ -1106,7 +1166,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<td class="description last"></td>
<td class="description last"><p>An Array to pick a random member of.</p></td>
</tr>
@@ -1138,7 +1198,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-206">line 206</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-207">line 207</a>
</li></ul></dd>
@@ -1162,6 +1222,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A random member of the array.</p>
</div>
<dl>
@@ -1170,7 +1234,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
</dt>
<dd>
<span class="param-type">number</span>
<span class="param-type">any</span>
</dd>
@@ -1226,7 +1290,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-145">line 145</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-147">line 147</a>
</li></ul></dd>
@@ -1250,6 +1314,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A random real number between 0 and 2^32.</p>
</div>
<dl>
@@ -1331,7 +1399,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<td class="description last"></td>
<td class="description last"><p>The minimum value in the range.</p></td>
</tr>
@@ -1354,7 +1422,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<td class="description last"></td>
<td class="description last"><p>The maximum value in the range.</p></td>
</tr>
@@ -1386,7 +1454,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-165">line 165</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-167">line 167</a>
</li></ul></dd>
@@ -1410,6 +1478,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A random number between min and max.</p>
</div>
<dl>
@@ -1523,7 +1595,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-70">line 70</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-72">line 72</a>
</li></ul></dd>
@@ -1609,7 +1681,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<td class="description last"></td>
<td class="description last"><p>The minimum value in the range.</p></td>
</tr>
@@ -1632,7 +1704,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<td class="description last"></td>
<td class="description last"><p>The maximum value in the range.</p></td>
</tr>
@@ -1664,7 +1736,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-226">line 226</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-227">line 227</a>
</li></ul></dd>
@@ -1688,6 +1760,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A random timestamp between min and max.</p>
</div>
<dl>
@@ -1752,7 +1828,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-187">line 187</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-189">line 189</a>
</li></ul></dd>
@@ -1776,6 +1852,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A valid RFC4122 version4 ID hex string</p>
</div>
<dl>
@@ -1799,7 +1879,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt>
<h4 class="name" id="weightedPick"><span class="type-signature"></span>weightedPick<span class="signature">(ary)</span><span class="type-signature"> &rarr; {number}</span></h4>
<h4 class="name" id="weightedPick"><span class="type-signature"></span>weightedPick<span class="signature">(ary)</span><span class="type-signature"> &rarr; {any}</span></h4>
</dt>
@@ -1847,7 +1927,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<td class="type">
<span class="param-type">Any</span>
<span class="param-type">Array</span>
@@ -1857,7 +1937,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<td class="description last"></td>
<td class="description last"><p>An Array to pick a random member of.</p></td>
</tr>
@@ -1889,7 +1969,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<dt class="tag-source">Source:</dt>
<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-216">line 216</a>
<a href="RandomDataGenerator.js.html">math/RandomDataGenerator.js</a>, <a href="RandomDataGenerator.js.html#sunlight-1-line-217">line 217</a>
</li></ul></dd>
@@ -1913,6 +1993,10 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<h5>Returns:</h5>
<div class="param-desc">
<p>A random member of the array.</p>
</div>
<dl>
@@ -1921,7 +2005,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
</dt>
<dd>
<span class="param-type">number</span>
<span class="param-type">any</span>
</dd>
@@ -1959,7 +2043,7 @@ Random number generator from <a href="http://baagoe.org/en/wiki/Better_random_nu
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Thu Nov 07 2013 06:07:39 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Nov 28 2013 15:56:33 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>