wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-08-04 13:14:14 +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.StateManager.html
+211 -305
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>
@@ -546,7 +586,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-15">line 15</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-17">line 17</a>
</li></ul></dd>
@@ -596,10 +636,6 @@
</dt>
<dd>
<div class="description">
<p>The current active State object (defaults to null).</p>
</div>
@@ -649,7 +685,7 @@
<td class="description last"></td>
<td class="description last"><p>The current active State object (defaults to null).</p></td>
</tr>
@@ -678,7 +714,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-68">line 68</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-49">line 49</a>
</li></ul></dd>
@@ -702,10 +738,6 @@
</dt>
<dd>
<div class="description">
<p>A reference to the currently running game.</p>
</div>
@@ -739,7 +771,7 @@
<tr>
<td class="name"><code>game.</code></td>
<td class="name"><code>game</code></td>
<td class="type">
@@ -755,7 +787,7 @@
<td class="description last"></td>
<td class="description last"><p>A reference to the currently running game.</p></td>
</tr>
@@ -784,113 +816,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-21">line 21</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="game"><span class="type-signature"></span>game<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A reference to the currently running game.</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>game.</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-42">line 42</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-22">line 22</a>
</li></ul></dd>
@@ -914,10 +840,6 @@
</dt>
<dd>
<div class="description">
<p>This will be called when create states (setup states...).</p>
</div>
@@ -967,7 +889,7 @@
<td class="description last"></td>
<td class="description last"><p>This will be called when create states (setup states...).</p></td>
</tr>
@@ -996,7 +918,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-86">line 86</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-64">line 64</a>
</li></ul></dd>
@@ -1020,10 +942,6 @@
</dt>
<dd>
<div class="description">
<p>This will be called when the state is started (i.e. set as the current active state).</p>
</div>
@@ -1073,7 +991,7 @@
<td class="description last"></td>
<td class="description last"><p>This will be called when the state is started (i.e. set as the current active state).</p></td>
</tr>
@@ -1102,7 +1020,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-74">line 74</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-54">line 54</a>
</li></ul></dd>
@@ -1126,10 +1044,6 @@
</dt>
<dd>
<div class="description">
<p>This will be called when the State is rendered but only during the load process.</p>
</div>
@@ -1179,7 +1093,7 @@
<td class="description last"></td>
<td class="description last"><p>This will be called when the State is rendered but only during the load process.</p></td>
</tr>
@@ -1208,7 +1122,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-116">line 116</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-89">line 89</a>
</li></ul></dd>
@@ -1232,10 +1146,6 @@
</dt>
<dd>
<div class="description">
<p>This will be called when the State is updated but only during the load process.</p>
</div>
@@ -1285,7 +1195,7 @@
<td class="description last"></td>
<td class="description last"><p>This will be called when the State is updated but only during the load process.</p></td>
</tr>
@@ -1314,7 +1224,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-110">line 110</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-84">line 84</a>
</li></ul></dd>
@@ -1338,10 +1248,6 @@
</dt>
<dd>
<div class="description">
<p>This will be called when states paused.</p>
</div>
@@ -1391,7 +1297,7 @@
<td class="description last"></td>
<td class="description last"><p>This will be called when the state is paused.</p></td>
</tr>
@@ -1420,7 +1326,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-122">line 122</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-94">line 94</a>
</li></ul></dd>
@@ -1444,10 +1350,6 @@
</dt>
<dd>
<div class="description">
<p>This will be called when init states (loading assets...).</p>
</div>
@@ -1497,7 +1399,7 @@
<td class="description last"></td>
<td class="description last"><p>This will be called when init states (loading assets...).</p></td>
</tr>
@@ -1526,7 +1428,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-80">line 80</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-59">line 59</a>
</li></ul></dd>
@@ -1550,10 +1452,6 @@
</dt>
<dd>
<div class="description">
<p>This will be called before the State is rendered and before the stage is cleared.</p>
</div>
@@ -1603,7 +1501,7 @@
<td class="description last"></td>
<td class="description last"><p>This will be called before the State is rendered and before the stage is cleared.</p></td>
</tr>
@@ -1632,7 +1530,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-104">line 104</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-79">line 79</a>
</li></ul></dd>
@@ -1656,10 +1554,6 @@
</dt>
<dd>
<div class="description">
<p>This will be called when the State is rendered, this doesn't happen during load (see onLoadRenderCallback).</p>
</div>
@@ -1709,7 +1603,7 @@
<td class="description last"></td>
<td class="description last"><p>This will be called when the State is rendered, this doesn't happen during load (see onLoadRenderCallback).</p></td>
</tr>
@@ -1738,7 +1632,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-98">line 98</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-74">line 74</a>
</li></ul></dd>
@@ -1762,10 +1656,6 @@
</dt>
<dd>
<div class="description">
<p>This will be called when the state is shut down (i.e. swapped to another state).</p>
</div>
@@ -1815,7 +1705,7 @@
<td class="description last"></td>
<td class="description last"><p>This will be called when the state is shut down (i.e. swapped to another state).</p></td>
</tr>
@@ -1844,7 +1734,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-128">line 128</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-99">line 99</a>
</li></ul></dd>
@@ -1868,10 +1758,6 @@
</dt>
<dd>
<div class="description">
<p>This will be called when State is updated, this doesn't happen during load (@see onLoadUpdateCallback).</p>
</div>
@@ -1921,7 +1807,7 @@
<td class="description last"></td>
<td class="description last"><p>This will be called when State is updated, this doesn't happen during load (@see onLoadUpdateCallback).</p></td>
</tr>
@@ -1950,7 +1836,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-92">line 92</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-69">line 69</a>
</li></ul></dd>
@@ -1974,116 +1860,6 @@
</dt>
<dd>
<div class="description">
<p>Description.</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>states.</code></td>
<td class="type">
<span class="param-type">Description</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-27">line 27</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="states"><span class="type-signature"></span>states<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The state to be switched to in the next frame.</p>
</div>
@@ -2123,7 +1899,7 @@
<td class="type">
<span class="param-type">Description</span>
<span class="param-type">Object</span>
@@ -2133,7 +1909,7 @@
<td class="description last"></td>
<td class="description last"><p>The object containing Phaser.States.</p></td>
</tr>
@@ -2162,7 +1938,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-62">line 62</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-27">line 27</a>
</li></ul></dd>
@@ -2322,7 +2098,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-158">line 158</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-132">line 132</a>
</li></ul></dd>
@@ -2440,7 +2216,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-326">line 326</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-282">line 282</a>
</li></ul></dd>
@@ -2532,7 +2308,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-499">line 499</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-488">line 488</a>
</li></ul></dd>
@@ -2650,7 +2426,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-364">line 364</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-320">line 320</a>
</li></ul></dd>
@@ -2715,7 +2491,72 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-425">line 425</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-380">line 380</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pause"><span class="type-signature">&lt;protected> </span>pause<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-398">line 398</a>
</li></ul></dd>
@@ -2780,7 +2621,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-466">line 466</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-444">line 444</a>
</li></ul></dd>
@@ -2898,7 +2739,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-212">line 212</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-177">line 177</a>
</li></ul></dd>
@@ -2963,7 +2804,72 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-479">line 479</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-457">line 457</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="resume"><span class="type-signature">&lt;protected> </span>resume<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-411">line 411</a>
</li></ul></dd>
@@ -3081,7 +2987,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-391">line 391</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-346">line 346</a>
</li></ul></dd>
@@ -3275,7 +3181,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-240">line 240</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-205">line 205</a>
</li></ul></dd>
@@ -3340,7 +3246,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-446">line 446</a>
<a href="StateManager.js.html">core/StateManager.js</a>, <a href="StateManager.js.html#sunlight-1-line-424">line 424</a>
</li></ul></dd>
@@ -3391,7 +3297,7 @@
<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:41 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Nov 28 2013 15:56:34 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>