wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-09-10 12:29:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs for 1.1.2 release.

Browse Source
This commit is contained in:
photonstorm
2013-11-01 18:16:52 +00:00
parent eb95ce231b
commit 3e9777e6f4
150 changed files with 6188 additions and 2252 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Phaser.Particles.Arcade.Emitter.html
+520 -46
View File
@@ -58,10 +58,6 @@
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li>
<a href="Phaser.Bullet.html">Bullet</a>
</li>
<li>
<a href="Phaser.Button.html">Button</a>
</li>
@@ -871,7 +867,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-1188">line 1188</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1391">line 1391</a>
</li></ul></dd>
@@ -1197,6 +1193,118 @@ This will have no impact on the rotation value of its children, but it will upda
</dl>
</dd>
<dt>
<h4 class="name" id="cursor"><span class="type-signature"></span>cursor<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The cursor is a simple way to iterate through the objects in a Group using the Group.next and Group.previous functions.
The cursor is set to the first child added to the Group and doesn't change unless you call next, previous or set it directly with Group.cursor.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cursor</code></td>
<td class="type">
<span class="param-type">any</span>
</td>
<td class="description last"><p>The current display object that the Group cursor is pointing to.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Group.html#cursor">Phaser.Group#cursor</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-90">line 90</a>
</li></ul></dd>
</dl>
@@ -2152,7 +2260,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-1139">line 1139</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1342">line 1342</a>
</li></ul></dd>
@@ -3658,7 +3766,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-1206">line 1206</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1409">line 1409</a>
</li></ul></dd>
@@ -3974,7 +4082,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-1126">line 1126</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1329">line 1329</a>
</li></ul></dd>
@@ -4822,7 +4930,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-89">line 89</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-96">line 96</a>
</li></ul></dd>
@@ -5047,7 +5155,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-527">line 527</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-606">line 606</a>
</li></ul></dd>
@@ -5194,7 +5302,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-120">line 120</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-132">line 132</a>
</li></ul></dd>
@@ -5458,7 +5566,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-363">line 363</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-434">line 434</a>
</li></ul></dd>
@@ -5509,7 +5617,7 @@ The child is added to the Group at the location specified by the index value, th
<dt>
<h4 class="name" id="callAll"><span class="type-signature"></span>callAll<span class="signature">(callback, parameter)</span><span class="type-signature"></span></h4>
<h4 class="name" id="callAll"><span class="type-signature"></span>callAll<span class="signature">(method, <span class="optional">context</span>, parameter)</span><span class="type-signature"></span></h4>
</dt>
@@ -5518,7 +5626,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 callback parameter you can add as many extra parameters as you like, which will all be passed to the child.</p>
After the method parameter you can add as many extra parameters as you like, which will all be passed to the child.</p>
</div>
@@ -5544,6 +5652,8 @@ After the callback parameter you can add as many extra parameters as you like, w
<th>Default</th>
<th class="last">Description</th>
</tr>
@@ -5554,13 +5664,13 @@ After the callback parameter you can add as many extra parameters as you like, w
<tr>
<td class="name"><code>callback</code></td>
<td class="name"><code>method</code></td>
<td class="type">
<span class="param-type">function</span>
<span class="param-type">string</span>
@@ -5577,8 +5687,51 @@ After the callback parameter you can add as many extra parameters as you like, w
<td class="default">
</td>
<td class="description last"><p>The function that exists on the children that will be called.</p></td>
<td class="description last"><p>A string containing the name of the function that will be called. The function must exist on the child.</p></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
''
</td>
<td class="description last"><p>A string containing the context under which the method will be executed. Leave to '' to default to the child.</p></td>
</tr>
@@ -5610,8 +5763,12 @@ After the callback parameter you can add as many extra parameters as you like, w
<td class="default">
</td>
<td class="description last"><p>Additional parameters that will be passed to the callback.</p></td>
<td class="description last"><p>Additional parameters that will be passed to the method.</p></td>
</tr>
@@ -5648,7 +5805,7 @@ After the callback parameter you can add as many extra parameters as you like, w
<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-623">line 623</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-755">line 755</a>
</li></ul></dd>
@@ -5846,7 +6003,176 @@ 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-591">line 591</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-670">line 670</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="callbackFromArray"><span class="type-signature">&lt;protected> </span>callbackFromArray<span class="signature">(child, callback, length)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Calls a function on all of the children that have exists=true in this Group.</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>child</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The object to inspect.</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"><p>The array of function names.</p></td>
</tr>
<tr>
<td class="name"><code>length</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The size of the array (pre-calculated in callAll).</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#callbackFromArray">Phaser.Group#callbackFromArray</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-702">line 702</a>
</li></ul></dd>
@@ -5920,7 +6246,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-887">line 887</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1056">line 1056</a>
</li></ul></dd>
@@ -6017,7 +6343,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-853">line 853</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1022">line 1022</a>
</li></ul></dd>
@@ -6329,7 +6655,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-163">line 163</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-180">line 180</a>
</li></ul></dd>
@@ -6607,7 +6933,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-199">line 199</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-221">line 221</a>
</li></ul></dd>
@@ -6681,7 +7007,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-1015">line 1015</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1210">line 1210</a>
</li></ul></dd>
@@ -6874,7 +7200,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-575">line 575</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-654">line 654</a>
</li></ul></dd>
@@ -7017,7 +7343,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-1034">line 1034</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1231">line 1231</a>
</li></ul></dd>
@@ -7257,7 +7583,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-654">line 654</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-823">line 823</a>
</li></ul></dd>
@@ -7405,7 +7731,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-694">line 694</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-863">line 863</a>
</li></ul></dd>
@@ -7553,7 +7879,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-728">line 728</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-897">line 897</a>
</li></ul></dd>
@@ -7676,7 +8002,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-149">line 149</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-166">line 166</a>
</li></ul></dd>
@@ -7774,7 +8100,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-795">line 795</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-964">line 964</a>
</li></ul></dd>
@@ -7872,7 +8198,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-824">line 824</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-993">line 993</a>
</li></ul></dd>
@@ -8018,7 +8344,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-761">line 761</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-930">line 930</a>
</li></ul></dd>
@@ -8164,7 +8490,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-382">line 382</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-453">line 453</a>
</li></ul></dd>
@@ -8333,7 +8659,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-921">line 921</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1090">line 1090</a>
</li></ul></dd>
@@ -8839,7 +9165,155 @@ 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-559">line 559</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-638">line 638</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="next"><span class="type-signature"></span>next<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Advances the Group cursor to the next object in the Group. If it's at the end of the Group it wraps around to the first object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Group.html#next">Phaser.Group#next</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-262">line 262</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="previous"><span class="type-signature"></span>previous<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Moves the Group cursor to the previous object in the Group. If it's at the start of the Group it wraps around to the last object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Group.html#previous">Phaser.Group#previous</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-284">line 284</a>
</li></ul></dd>
@@ -8962,7 +9436,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-943">line 943</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1112">line 1112</a>
</li></ul></dd>
@@ -9037,7 +9511,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-962">line 962</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>
@@ -9183,7 +9657,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-987">line 987</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1170">line 1170</a>
</li></ul></dd>
@@ -9329,7 +9803,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-395">line 395</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>
@@ -9691,7 +10165,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-489">line 489</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-568">line 568</a>
</li></ul></dd>
@@ -9939,7 +10413,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-427">line 427</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-504">line 504</a>
</li></ul></dd>
@@ -10883,7 +11357,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-543">line 543</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-622">line 622</a>
</li></ul></dd>
@@ -11029,7 +11503,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-235">line 235</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-306">line 306</a>
</li></ul></dd>
@@ -11172,7 +11646,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 Oct 25 2013 17:05:29 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Fri Nov 01 2013 18:16:13 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>