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
+533 -215
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>
@@ -1309,7 +1345,7 @@
<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-933">line 933</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-932">line 932</a>
</li></ul></dd>
@@ -1469,7 +1505,7 @@
<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-860">line 860</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-859">line 859</a>
</li></ul></dd>
@@ -1698,7 +1734,7 @@
<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-943">line 943</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-942">line 942</a>
</li></ul></dd>
@@ -1858,7 +1894,7 @@
<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-881">line 881</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-880">line 880</a>
</li></ul></dd>
@@ -1995,7 +2031,7 @@
<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-1020">line 1020</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1019">line 1019</a>
</li></ul></dd>
@@ -2507,7 +2543,7 @@ Clamp value to range &lt;a, b&gt;</p>
<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-1163">line 1163</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1162">line 1162</a>
</li></ul></dd>
@@ -2667,7 +2703,7 @@ Clamp value to range &lt;a, b&gt;</p>
<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-1179">line 1179</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1178">line 1178</a>
</li></ul></dd>
@@ -2755,7 +2791,7 @@ Clamp value to range &lt;a, b&gt;</p>
<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-1316">line 1316</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1345">line 1345</a>
</li></ul></dd>
@@ -2911,7 +2947,7 @@ Clamp value to range &lt;a, b&gt;</p>
<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-961">line 961</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-960">line 960</a>
</li></ul></dd>
@@ -3117,7 +3153,7 @@ Clamp value to range &lt;a, b&gt;</p>
<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-1109">line 1109</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1108">line 1108</a>
</li></ul></dd>
@@ -3418,7 +3454,7 @@ Clamp value to range &lt;a, b&gt;</p>
<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-1128">line 1128</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1127">line 1127</a>
</li></ul></dd>
@@ -3628,7 +3664,7 @@ Clamp value to range &lt;a, b&gt;</p>
<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-1147">line 1147</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1146">line 1146</a>
</li></ul></dd>
@@ -3769,7 +3805,7 @@ Clamp value to range &lt;a, b&gt;</p>
<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-1005">line 1005</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1004">line 1004</a>
</li></ul></dd>
@@ -4341,193 +4377,6 @@ Clamp value to range &lt;a, b&gt;</p>
</dd>
<dt>
<h4 class="name" id="fuzzyEqual"><span class="type-signature"></span>fuzzyEqual<span class="signature">(a, b, epsilon)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>a is fuzzyLessThan b if it is less than b + &epsilon;.</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"></td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>epsilon</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></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-33">line 33</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if a&lt;b+&epsilon;</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
@@ -4875,6 +4724,193 @@ Clamp value to range &lt;a, b&gt;</p>
</dd>
<dt>
<h4 class="name" id="fuzzyLessThan"><span class="type-signature"></span>fuzzyLessThan<span class="signature">(a, b, epsilon)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>a is fuzzyLessThan b if it is less than b + &epsilon;.</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"></td>
</tr>
<tr>
<td class="name"><code>b</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>epsilon</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></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-33">line 33</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if a&lt;b+&epsilon;</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
@@ -5017,7 +5053,7 @@ Will return null if random selection is missing, or array has no entries.</p>
<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-971">line 971</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-970">line 970</a>
</li></ul></dd>
@@ -5898,7 +5934,7 @@ Will return null if random selection is missing, or array has no entries.</p>
<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-921">line 921</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-920">line 920</a>
</li></ul></dd>
@@ -6058,7 +6094,7 @@ Will return null if random selection is missing, or array has no entries.</p>
<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-833">line 833</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-832">line 832</a>
</li></ul></dd>
@@ -6310,7 +6346,7 @@ Will return null if random selection is missing, or array has no entries.</p>
<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-1208">line 1208</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1207">line 1207</a>
</li></ul></dd>
@@ -8051,7 +8087,148 @@ It will find the lowest matching property value from the given objects.</p>
<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-1294">line 1294</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1293">line 1293</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The scaled value.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="p2pxi"><span class="type-signature"></span>p2pxi<span class="signature">(v)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Convert p2 physics value (meters) to pixel scale and inverses it.</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>v</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The value to convert.</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-1319">line 1319</a>
</li></ul></dd>
@@ -8261,7 +8438,148 @@ It will find the lowest matching property value from the given objects.</p>
<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-1305">line 1305</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1306">line 1306</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The scaled value.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="px2pi"><span class="type-signature"></span>px2pi<span class="signature">(v)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Convert pixel value to p2 physics scale (meters) and inverses it.</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>v</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The value to convert.</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-1332">line 1332</a>
</li></ul></dd>
@@ -8353,7 +8671,7 @@ It will find the lowest matching property value from the given objects.</p>
<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-1334">line 1334</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1363">line 1363</a>
</li></ul></dd>
@@ -9067,7 +9385,7 @@ The original stack is modified in the process. This effectively moves the positi
<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-1072">line 1072</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1071">line 1071</a>
</li></ul></dd>
@@ -9208,7 +9526,7 @@ The original stack is modified in the process. This effectively moves the positi
<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-1089">line 1089</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1088">line 1088</a>
</li></ul></dd>
@@ -9350,7 +9668,7 @@ The original stack is modified in the process. This effectively moves the positi
<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-1280">line 1280</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1279">line 1279</a>
</li></ul></dd>
@@ -9560,7 +9878,7 @@ you should get the results via getSinTable() and getCosTable(). This generator i
<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-1032">line 1032</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1031">line 1031</a>
</li></ul></dd>
@@ -9747,7 +10065,7 @@ you should get the results via getSinTable() and getCosTable(). This generator i
<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-1253">line 1253</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1252">line 1252</a>
</li></ul></dd>
@@ -9930,7 +10248,7 @@ you should get the results via getSinTable() and getCosTable(). This generator i
<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-1226">line 1226</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1225">line 1225</a>
</li></ul></dd>
@@ -11065,7 +11383,7 @@ you should get the results via getSinTable() and getCosTable(). This generator i
<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-1193">line 1193</a>
<a href="Math.js.html">math/Math.js</a>, <a href="Math.js.html#sunlight-1-line-1192">line 1192</a>
</li></ul></dd>
@@ -11657,7 +11975,7 @@ Should be called whenever the angle is updated on the Sprite to stop it from goi
<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:28 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Fri Feb 21 2014 15:36:29 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>