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

Updated doc files.

Browse Source
This commit is contained in:
photonstorm
2014-02-05 16:55:02 +00:00
parent 0896c2fac7
commit 02b75b9e23
182 changed files with 72763 additions and 19286 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Phaser.Time.html
+449 -58
View File
@@ -90,6 +90,10 @@
<a href="Phaser.Device.html">Device</a>
</li>
<li>
<a href="Phaser.DOMSprite.html">DOMSprite</a>
</li>
<li>
<a href="Phaser.Easing.html">Easing</a>
</li>
@@ -162,6 +166,14 @@
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li>
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li>
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
<li>
<a href="Phaser.Graphics.html">Graphics</a>
</li>
@@ -186,6 +198,10 @@
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li>
<a href="Phaser.Line.html">Line</a>
</li>
<li>
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
@@ -278,6 +294,10 @@
<a href="Phaser.Signal.html">Signal</a>
</li>
<li>
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li>
<a href="Phaser.Sound.html">Sound</a>
</li>
@@ -342,6 +362,10 @@
<a href="Phaser.Timer.html">Timer</a>
</li>
<li>
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li>
<a href="Phaser.Touch.html">Touch</a>
</li>
@@ -374,36 +398,6 @@
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="global.html#bottom">bottom</a>
</li>
<li>
<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>
</ul>
</li>
</ul>
</div>
</div>
@@ -572,7 +566,7 @@
<dl>
<dt>
<h4 class="name" id="elapsed"><span class="type-signature"></span>elapsed<span class="type-signature"></span></h4>
<h4 class="name" id="elapsed"><span class="type-signature">&lt;protected> </span>elapsed<span class="type-signature"></span></h4>
</dt>
@@ -627,7 +621,7 @@
<td class="description last"><p>Elapsed time since the last frame.</p></td>
<td class="description last"><p>Elapsed time since the last frame (in ms).</p></td>
</tr>
@@ -656,7 +650,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-63">line 63</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-38">line 38</a>
</li></ul></dd>
@@ -674,7 +668,109 @@
<dt>
<h4 class="name" id="fps"><span class="type-signature"></span>fps<span class="type-signature"></span></h4>
<h4 class="name" id="events"><span class="type-signature"></span>events<span class="type-signature"></span></h4>
</dt>
<dd>
<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>events</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Timer.html">Phaser.Timer</a></span>
</td>
<td class="description last"><p>This is a Phaser.Timer object bound to the master clock to which you can add timed events.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-101">line 101</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="fps"><span class="type-signature">&lt;protected> </span>fps<span class="type-signature"></span></h4>
</dt>
@@ -758,7 +854,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-68">line 68</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-50">line 50</a>
</li></ul></dd>
@@ -860,7 +956,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-78">line 78</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-60">line 60</a>
</li></ul></dd>
@@ -962,7 +1058,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-73">line 73</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-55">line 55</a>
</li></ul></dd>
@@ -1064,7 +1160,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-94">line 94</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-81">line 81</a>
</li></ul></dd>
@@ -1268,7 +1364,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-109">line 109</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-96">line 96</a>
</li></ul></dd>
@@ -1370,7 +1466,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-89">line 89</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-71">line 71</a>
</li></ul></dd>
@@ -1475,7 +1571,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-84">line 84</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-66">line 66</a>
</li></ul></dd>
@@ -1493,7 +1589,7 @@
<dt>
<h4 class="name" id="now"><span class="type-signature"></span>now<span class="type-signature"></span></h4>
<h4 class="name" id="now"><span class="type-signature">&lt;protected> </span>now<span class="type-signature"></span></h4>
</dt>
@@ -1577,7 +1673,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-58">line 58</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-32">line 32</a>
</li></ul></dd>
@@ -1595,7 +1691,7 @@
<dt>
<h4 class="name" id="pausedTime"><span class="type-signature"></span>pausedTime<span class="type-signature"></span></h4>
<h4 class="name" id="pausedTime"><span class="type-signature">&lt;protected> </span>pausedTime<span class="type-signature"></span></h4>
</dt>
@@ -1679,7 +1775,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-53">line 53</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-44">line 44</a>
</li></ul></dd>
@@ -1781,7 +1877,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-99">line 99</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-86">line 86</a>
</li></ul></dd>
@@ -1883,7 +1979,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-43">line 43</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-76">line 76</a>
</li></ul></dd>
@@ -1901,7 +1997,7 @@
<dt>
<h4 class="name" id="time"><span class="type-signature"></span>time<span class="type-signature"></span></h4>
<h4 class="name" id="time"><span class="type-signature">&lt;protected> </span>time<span class="type-signature"></span></h4>
</dt>
@@ -1956,7 +2052,7 @@
<td class="description last"><p>Game time counter.</p></td>
<td class="description last"><p>Game time counter. If you need a value for in-game calculation please use Phaser.Time.now instead.</p></td>
</tr>
@@ -1985,7 +2081,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-48">line 48</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-26">line 26</a>
</li></ul></dd>
@@ -2087,7 +2183,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-104">line 104</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-91">line 91</a>
</li></ul></dd>
@@ -2110,6 +2206,232 @@
<dl>
<dt>
<h4 class="name" id="boot"><span class="type-signature"></span>boot<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="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-153">line 153</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(<span class="optional">autoDestroy</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Timer.html">Phaser.Timer</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a new stand-alone Phaser.Timer object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>autoDestroy</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>A Timer that is set to automatically destroy itself will do so after all of its events have been dispatched (assuming no looping events).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-162">line 162</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The Timer object that was created.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Timer.html">Phaser.Timer</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="elapsedSecondsSince"><span class="type-signature"></span>elapsedSecondsSince<span class="signature">(since)</span><span class="type-signature"> &rarr; {number}</span></h4>
@@ -2201,7 +2523,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-220">line 220</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-327">line 327</a>
</li></ul></dd>
@@ -2342,7 +2664,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-210">line 210</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-317">line 317</a>
</li></ul></dd>
@@ -2388,6 +2710,75 @@
</dd>
<dt>
<h4 class="name" id="removeAll"><span class="type-signature"></span>removeAll<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Remove all Timer objects, regardless of their state.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-180">line 180</a>
</li></ul></dd>
</dl>
</dd>
@@ -2434,7 +2825,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-230">line 230</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-337">line 337</a>
</li></ul></dd>
@@ -2503,7 +2894,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-201">line 201</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-308">line 308</a>
</li></ul></dd>
@@ -2640,7 +3031,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-125">line 125</a>
<a href="Time.js.html">time/Time.js</a>, <a href="Time.js.html#sunlight-1-line-195">line 195</a>
</li></ul></dd>
@@ -2685,13 +3076,13 @@
<span class="copyright">
Phaser Copyright © 2012-2013 Photon Storm Ltd.
Phaser Copyright © 2012-2014 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Thu Nov 28 2013 15:56:35 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Wed Feb 05 2014 06:28:36 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>