wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-08-11 11:23:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation.

Browse Source
This commit is contained in:
photonstorm
2013-11-28 15:57:09 +00:00
parent 8da9b67c18
commit f22159e257
193 changed files with 68905 additions and 93104 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Phaser.Particles.Arcade.Emitter.html
+106 -43
View File
@@ -54,6 +54,10 @@
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li>
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li>
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
@@ -138,6 +142,10 @@
<a href="Phaser.Events.html">Events</a>
</li>
<li>
<a href="Phaser.Filter.html">Filter</a>
</li>
<li>
<a href="Phaser.Frame.html">Frame</a>
</li>
@@ -302,6 +310,26 @@
<a href="Phaser.Text.html">Text</a>
</li>
<li>
<a href="Phaser.Tile.html">Tile</a>
</li>
<li>
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li>
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li>
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li>
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
@@ -310,6 +338,10 @@
<a href="Phaser.Time.html">Time</a>
</li>
<li>
<a href="Phaser.Timer.html">Timer</a>
</li>
<li>
<a href="Phaser.Touch.html">Touch</a>
</li>
@@ -356,6 +388,14 @@
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
</li>
<li>
<a href="global.html#render">render</a>
</li>
<li>
<a href="global.html#renderXY">renderXY</a>
</li>
<li>
<a href="global.html#right">right</a>
</li>
@@ -871,7 +911,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-1512">line 1512</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1522">line 1522</a>
</li></ul></dd>
@@ -1650,7 +1690,7 @@ Emitter.emitX and Emitter.emitY control the emission location relative to the x/
<dd>
<div class="description">
<p>How often a particle is emitted in ms (if emitter is started with Explode == false).</p>
<p>How often a particle is emitted in ms (if emitter is started with Explode === false).</p>
</div>
@@ -2264,7 +2304,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-1462">line 1462</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1472">line 1472</a>
</li></ul></dd>
@@ -3770,7 +3810,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-1530">line 1530</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1540">line 1540</a>
</li></ul></dd>
@@ -4086,7 +4126,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-1448">line 1448</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1458">line 1458</a>
</li></ul></dd>
@@ -5159,7 +5199,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-675">line 675</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-672">line 672</a>
</li></ul></dd>
@@ -5570,7 +5610,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-503">line 503</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-502">line 502</a>
</li></ul></dd>
@@ -5809,7 +5849,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-824">line 824</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-821">line 821</a>
</li></ul></dd>
@@ -6007,7 +6047,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-739">line 739</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-736">line 736</a>
</li></ul></dd>
@@ -6176,7 +6216,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-771">line 771</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-768">line 768</a>
</li></ul></dd>
@@ -6250,7 +6290,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-1155">line 1155</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1153">line 1153</a>
</li></ul></dd>
@@ -6347,7 +6387,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-1143">line 1143</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1141">line 1141</a>
</li></ul></dd>
@@ -6659,7 +6699,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-210">line 210</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-209">line 209</a>
</li></ul></dd>
@@ -6937,7 +6977,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-251">line 251</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-250">line 250</a>
</li></ul></dd>
@@ -7011,7 +7051,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-1287">line 1287</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1297">line 1297</a>
</li></ul></dd>
@@ -7204,7 +7244,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-723">line 723</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-720">line 720</a>
</li></ul></dd>
@@ -7347,7 +7387,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-1350">line 1350</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1360">line 1360</a>
</li></ul></dd>
@@ -7587,7 +7627,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-892">line 892</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-890">line 890</a>
</li></ul></dd>
@@ -7735,7 +7775,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-932">line 932</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>
@@ -7883,7 +7923,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-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>
@@ -8031,7 +8071,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-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>
@@ -8213,7 +8253,7 @@ For example: Group.forEachDead(bringToLife, this)</p>
<div class="description">
<p>Call this function to retrieve the first object with alive == true in the group.
<p>Call this function to retrieve the first object with alive === true in the group.
This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.</p>
</div>
@@ -8252,7 +8292,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-1117">line 1117</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1115">line 1115</a>
</li></ul></dd>
@@ -8311,7 +8351,7 @@ This is handy for checking if everything has been wiped out, or choosing a squad
<div class="description">
<p>Call this function to retrieve the first object with alive == false in the group.
<p>Call this function to retrieve the first object with alive === false in the group.
This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.</p>
</div>
@@ -8350,7 +8390,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-1130">line 1130</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1128">line 1128</a>
</li></ul></dd>
@@ -8496,7 +8536,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-1099">line 1099</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1097">line 1097</a>
</li></ul></dd>
@@ -8642,7 +8682,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-522">line 522</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-521">line 521</a>
</li></ul></dd>
@@ -8811,7 +8851,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-1167">line 1167</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1165">line 1165</a>
</li></ul></dd>
@@ -9121,7 +9161,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-1035">line 1035</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1033">line 1033</a>
</li></ul></dd>
@@ -9604,7 +9644,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-707">line 707</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-704">line 704</a>
</li></ul></dd>
@@ -9678,7 +9718,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-292">line 292</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-291">line 291</a>
</li></ul></dd>
@@ -9752,7 +9792,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-314">line 314</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-313">line 313</a>
</li></ul></dd>
@@ -9780,7 +9820,7 @@ Group.multiplyAll('x', 2) will x2 the child.x value.</p>
<dt>
<h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(child)</span><span class="type-signature"></span></h4>
<h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">(child)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
@@ -9875,7 +9915,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-1189">line 1189</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1187">line 1187</a>
</li></ul></dd>
@@ -9896,6 +9936,29 @@ Group.multiplyAll('x', 2) will x2 the child.x value.</p>
<h5>Returns:</h5>
<div class="param-desc">
<p>true if the child was removed from this Group, otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
@@ -9950,7 +10013,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-1220">line 1220</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1230">line 1230</a>
</li></ul></dd>
@@ -10096,7 +10159,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-1247">line 1247</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-1257">line 1257</a>
</li></ul></dd>
@@ -10242,7 +10305,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-535">line 535</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-534">line 534</a>
</li></ul></dd>
@@ -10604,7 +10667,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-637">line 637</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-634">line 634</a>
</li></ul></dd>
@@ -10852,7 +10915,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-573">line 573</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-572">line 572</a>
</li></ul></dd>
@@ -11599,7 +11662,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-986">line 986</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-984">line 984</a>
</li></ul></dd>
@@ -11979,7 +12042,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-691">line 691</a>
<a href="Group.js.html">core/Group.js</a>, <a href="Group.js.html#sunlight-1-line-688">line 688</a>
</li></ul></dd>
@@ -12126,7 +12189,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-375">line 375</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>
@@ -12269,7 +12332,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 Thu Nov 07 2013 06:07:38 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Nov 28 2013 15:56:31 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>