mirror of
https://github.com/wassname/phaser.git
synced 2026-08-11 11:23:06 +08:00
Added in a Group.sort demo, also updated the documentation and build files.
This commit is contained in:
photonstorm
@@ -242,6 +242,10 @@
|
||||
<a href="Phaser.Pointer.html">Pointer</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Polygon.html">Polygon</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.QuadTree.html">QuadTree</a>
|
||||
</li>
|
||||
@@ -867,7 +871,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-1391">line 1391</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1512">line 1512</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -2260,7 +2264,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-1342">line 1342</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1462">line 1462</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -3766,7 +3770,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-1409">line 1409</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1530">line 1530</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -4082,7 +4086,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-1329">line 1329</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1448">line 1448</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -4930,7 +4934,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-96">line 96</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-126">line 126</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5155,7 +5159,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-606">line 606</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-675">line 675</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5302,7 +5306,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-132">line 132</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-162">line 162</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5566,7 +5570,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-434">line 434</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-503">line 503</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5626,7 +5630,7 @@ The child is added to the Group at the location specified by the index value, th
|
||||
|
||||
<div class="description">
|
||||
<p>Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that)
|
||||
After the method parameter you can add as many extra parameters as you like, which will all be passed to the child.</p>
|
||||
After the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.</p>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -5805,7 +5809,7 @@ After the method parameter you can add as many extra parameters as you like, whi
|
||||
|
||||
<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-755">line 755</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>
|
||||
|
||||
|
||||
@@ -6003,7 +6007,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-670">line 670</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-739">line 739</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6172,7 +6176,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-702">line 702</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-771">line 771</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6246,7 +6250,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-1056">line 1056</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1155">line 1155</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6343,7 +6347,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-1022">line 1022</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1143">line 1143</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6655,7 +6659,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-180">line 180</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-210">line 210</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6933,7 +6937,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-221">line 221</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-251">line 251</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7007,7 +7011,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-1210">line 1210</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1287">line 1287</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7200,7 +7204,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-654">line 654</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-723">line 723</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7343,7 +7347,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-1231">line 1231</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1350">line 1350</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7583,7 +7587,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-823">line 823</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-892">line 892</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7731,7 +7735,155 @@ 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-863">line 863</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-932">line 932</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<h4 class="name" id="forEachAlive"><span class="type-signature"></span>forEachAlive<span class="signature">(callback, callbackContext)</span><span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<div class="description">
|
||||
<p>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.
|
||||
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)</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>callback</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">function</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The function that will be called. Each child of the Group will be passed to it as its first parameter.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>callbackContext</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Object</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"><p>The context in which the function should be called (usually 'this').</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="inherited-from">Inherited From:</dt>
|
||||
<dd class="inherited-from"><ul class="dummy"><li>
|
||||
<a href="Phaser.Group.html#forEachAlive">Phaser.Group#forEachAlive</a>
|
||||
</li></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7879,7 +8031,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-897">line 897</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-968">line 968</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8002,7 +8154,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-166">line 166</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-196">line 196</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8100,7 +8252,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-964">line 964</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1117">line 1117</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8198,7 +8350,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-993">line 993</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1130">line 1130</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8344,7 +8496,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-930">line 930</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1099">line 1099</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8490,7 +8642,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-453">line 453</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-522">line 522</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8659,7 +8811,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-1090">line 1090</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1167">line 1167</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8705,6 +8857,293 @@ This is handy for checking if everything has been wiped out, or choosing a squad
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<h4 class="name" id="iterate"><span class="type-signature"></span>iterate<span class="signature">(key, value, returnType, <span class="optional">callback</span>, <span class="optional">callbackContext</span>)</span><span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<div class="description">
|
||||
<p>Iterates over the children of the Group. When a child has a property matching key that equals the given value, it is considered as a match.
|
||||
Matched children can be sent to the optional callback, or simply returned or counted.
|
||||
You can add as many callback parameters as you like, which will all be passed to the callback along with the child, after the callbackContext parameter.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params table table-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
<th>Argument</th>
|
||||
|
||||
|
||||
|
||||
<th>Default</th>
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>key</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>The child property to check, i.e. 'exists', 'alive', 'health'</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>value</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">any</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>If child.key === this value it will be considered a match. Note that a strict comparison is used.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>returnType</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">number</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>callback</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">function</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
null
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>Optional function that will be called on each matching child. Each child of the Group will be passed to it as its first parameter.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>callbackContext</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Object</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>The context in which the function should be called (usually 'this').</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="inherited-from">Inherited From:</dt>
|
||||
<dd class="inherited-from"><ul class="dummy"><li>
|
||||
<a href="Phaser.Group.html#iterate">Phaser.Group#iterate</a>
|
||||
</li></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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-1035">line 1035</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
@@ -9165,7 +9604,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-638">line 638</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-707">line 707</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -9239,7 +9678,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-262">line 262</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-292">line 292</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -9313,7 +9752,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-284">line 284</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-314">line 314</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -9436,7 +9875,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-1112">line 1112</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1189">line 1189</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -9511,7 +9950,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-1143">line 1143</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1220">line 1220</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -9657,7 +10096,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-1170">line 1170</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1247">line 1247</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -9803,7 +10242,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-466">line 466</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-535">line 535</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -10165,7 +10604,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-568">line 568</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-637">line 637</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -10413,7 +10852,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-504">line 504</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-573">line 573</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -11000,6 +11439,189 @@ The operation parameter controls how the new value is assigned to the property,
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<h4 class="name" id="sort"><span class="type-signature"></span>sort<span class="signature">(<span class="optional">index</span>, <span class="optional">order</span>)</span><span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<div class="description">
|
||||
<p>Call this function to sort the group according to a particular value and order.
|
||||
For example to depth sort Sprites for Zelda-style game you might call <code>group.sort('y', Phaser.Group.SORT_ASCENDING)</code> at the bottom of your <code>State.update()</code>.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params table table-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
<th>Argument</th>
|
||||
|
||||
|
||||
|
||||
<th>Default</th>
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>index</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">string</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
'y'
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>The <code>string</code> name of the property you want to sort on.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>order</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">number</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="attributes">
|
||||
|
||||
<optional><br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
<td class="default">
|
||||
|
||||
Phaser.Group.SORT_ASCENDING
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>The <code>Group</code> constant that defines the sort order. Possible values are Phaser.Group.SORT_ASCENDING and Phaser.Group.SORT_DESCENDING.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="inherited-from">Inherited From:</dt>
|
||||
<dd class="inherited-from"><ul class="dummy"><li>
|
||||
<a href="Phaser.Group.html#sort">Phaser.Group#sort</a>
|
||||
</li></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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-986">line 986</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
@@ -11357,7 +11979,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-622">line 622</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-691">line 691</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -11393,7 +12015,8 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
|
||||
|
||||
|
||||
<div class="description">
|
||||
<p>Swaps the position of two children in this Group.</p>
|
||||
<p>Swaps the position of two children in this Group. Both children must be in this Group.
|
||||
You cannot swap a child with itself, or swap un-parented children, doing so will return false.</p>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -11503,7 +12126,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-306">line 306</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-375">line 375</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -11646,7 +12269,7 @@ Group.subAll('x', 10) will minus 10 from the child.x value.</p>
|
||||
|
||||
<span class="jsdoc-message">
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
|
||||
on Fri Nov 01 2013 18:16:13 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
||||
on Thu Nov 07 2013 06:07:38 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
||||
</span>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user