mirror of
https://github.com/wassname/phaser.git
synced 2026-07-04 17:20:31 +08:00
Updated docs - they now actually list the new body methods :)
This commit is contained in:
+245
-206
@@ -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>
|
||||
@@ -561,6 +597,9 @@
|
||||
|
|
||||
|
||||
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
||||
|
|
||||
|
||||
<span class="param-type">null</span>
|
||||
|
||||
|
||||
|
||||
@@ -582,7 +621,7 @@
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last"><p>The parent Group, DisplayObject or DisplayObjectContainer that this Group will be added to. If undefined or null it will use game.world.</p></td>
|
||||
<td class="description last"><p>The parent Group, DisplayObject or DisplayObjectContainer that this Group will be added to. If undefined it will use game.world. If null it won't be added to anything.</p></td>
|
||||
</tr>
|
||||
|
||||
|
||||
@@ -778,7 +817,7 @@
|
||||
|
||||
<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-133">line 133</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-131">line 131</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -838,7 +877,7 @@
|
||||
|
||||
<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-121">line 121</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-119">line 119</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -898,7 +937,7 @@
|
||||
|
||||
<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-127">line 127</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-125">line 125</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -958,7 +997,7 @@
|
||||
|
||||
<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-139">line 139</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-137">line 137</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -1018,7 +1057,7 @@
|
||||
|
||||
<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-145">line 145</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-143">line 143</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -1123,7 +1162,7 @@
|
||||
|
||||
<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-62">line 62</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-60">line 60</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -1225,7 +1264,7 @@
|
||||
|
||||
<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-1262">line 1262</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1260">line 1260</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -1332,7 +1371,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-1203">line 1203</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1201">line 1201</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -1434,7 +1473,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-95">line 95</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-93">line 93</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -1541,7 +1580,7 @@ The cursor is set to the first child added to the Group and doesn't change unles
|
||||
|
||||
<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-88">line 88</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-86">line 86</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -1646,7 +1685,7 @@ The cursor is set to the first child added to the Group and doesn't change unles
|
||||
|
||||
<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-68">line 68</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-66">line 66</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -1754,7 +1793,7 @@ So if this Group was in a Group that has x: 200, then this will be added to the
|
||||
|
||||
<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-1221">line 1221</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1219">line 1219</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -1856,7 +1895,7 @@ So if this Group was in a Group that has x: 200, then this will be added to the
|
||||
|
||||
<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-22">line 22</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-24">line 24</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -1958,7 +1997,7 @@ So if this Group was in a Group that has x: 200, then this will be added to the
|
||||
|
||||
<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-1188">line 1188</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1186">line 1186</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -2060,7 +2099,7 @@ So if this Group was in a Group that has x: 200, then this will be added to the
|
||||
|
||||
<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-32">line 32</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-34">line 34</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -2167,7 +2206,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-1258">line 1258</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1256">line 1256</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -2269,7 +2308,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-77">line 77</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-75">line 75</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -2371,7 +2410,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-1173">line 1173</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1171">line 1171</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -2473,7 +2512,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-56">line 56</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-54">line 54</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -2575,7 +2614,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-1260">line 1260</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1258">line 1258</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -2682,7 +2721,7 @@ This will have no impact on the x/y coordinates of its children, but it will upd
|
||||
|
||||
<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-1254">line 1254</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1252">line 1252</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -2789,7 +2828,7 @@ This will have no impact on the x/y coordinates of its children, but it will upd
|
||||
|
||||
<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-1256">line 1256</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1254">line 1254</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -2905,7 +2944,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-147">line 147</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-145">line 145</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -3125,7 +3164,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-524">line 524</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>
|
||||
|
||||
|
||||
@@ -3267,7 +3306,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-179">line 179</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-177">line 177</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -3408,7 +3447,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-344">line 344</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-342">line 342</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -3642,7 +3681,7 @@ After the method parameter and context you can add as many extra parameters as y
|
||||
|
||||
<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-664">line 664</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-662">line 662</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -3835,7 +3874,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-588">line 588</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-586">line 586</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -3999,7 +4038,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-611">line 611</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-609">line 609</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -4068,7 +4107,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-1006">line 1006</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1004">line 1004</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -4160,7 +4199,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-994">line 994</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-992">line 992</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -4467,7 +4506,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-222">line 222</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-220">line 220</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -4740,7 +4779,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-260">line 260</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-258">line 258</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -4878,7 +4917,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-1134">line 1134</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1132">line 1132</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5066,7 +5105,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-572">line 572</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-570">line 570</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5233,7 +5272,7 @@ Note: Currently this will skip any children which are Groups themselves.</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-787">line 787</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-785">line 785</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5376,150 +5415,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-819">line 819</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="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-837">line 837</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-835">line 835</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5662,7 +5558,150 @@ 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-855">line 855</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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<h4 class="name" id="forEachExists"><span class="type-signature"></span>forEachExists<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 member of this Group where child.exists=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.forEachExists(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="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-817">line 817</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5780,7 +5819,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-209">line 209</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-207">line 207</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5873,7 +5912,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-968">line 968</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-966">line 966</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5966,7 +6005,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-981">line 981</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-979">line 979</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6107,7 +6146,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-950">line 950</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-948">line 948</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6248,7 +6287,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-363">line 363</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-361">line 361</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6412,7 +6451,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-1018">line 1018</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1016">line 1016</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6717,7 +6756,7 @@ You can add as many callback parameters as you like, which will all be passed to
|
||||
|
||||
<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-893">line 893</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-891">line 891</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6928,7 +6967,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-556">line 556</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-554">line 554</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6997,7 +7036,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-282">line 282</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-280">line 280</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7066,7 +7105,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-764">line 764</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-762">line 762</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7135,7 +7174,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-724">line 724</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-722">line 722</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7204,7 +7243,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-306">line 306</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-304">line 304</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7322,7 +7361,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-1040">line 1040</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1038">line 1038</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7415,7 +7454,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-1070">line 1070</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1068">line 1068</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7556,7 +7595,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-1098">line 1098</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1096">line 1096</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7697,7 +7736,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-376">line 376</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-374">line 374</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8019,7 +8058,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-468">line 468</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-466">line 466</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8306,7 +8345,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-494">line 494</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-492">line 492</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8549,7 +8588,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-408">line 408</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-406">line 406</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8727,7 +8766,7 @@ For example to depth sort Sprites for Zelda-style game you might call <code>grou
|
||||
|
||||
<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-873">line 873</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-871">line 871</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -8915,7 +8954,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-540">line 540</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-538">line 538</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -9057,7 +9096,7 @@ You cannot swap a child with itself, or swap un-parented children, doing so will
|
||||
|
||||
<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-330">line 330</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-328">line 328</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -9126,7 +9165,7 @@ You cannot swap a child with itself, or swap un-parented children, doing so will
|
||||
|
||||
<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-748">line 748</a>
|
||||
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-746">line 746</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -9177,7 +9216,7 @@ You cannot swap a child with itself, or swap un-parented children, doing so will
|
||||
|
||||
<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:26 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
||||
on Fri Feb 21 2014 15:36:27 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