wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-08-20 12:40:12 +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.Touch.html
+293 -155
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>
@@ -577,7 +617,7 @@
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
<span class="param-type">Object</span>
@@ -587,7 +627,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The context under which callbacks are called.</p></td>
</tr>
@@ -616,7 +656,211 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-32">line 32</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-31">line 31</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="disabled"><span class="type-signature"></span>disabled<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>disabled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>You can disable all Touch events by setting disabled = true. While set all new touch events will be ignored.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-26">line 26</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="event"><span class="type-signature"></span>event<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>event</code></td>
<td class="type">
<span class="param-type">TouchEvent</span>
</td>
<td class="description last"><p>The browser touch event.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-72">line 72</a>
</li></ul></dd>
@@ -689,7 +933,7 @@
<td class="description last"><p>Local reference to game.</p></td>
<td class="description last"><p>A reference to the currently running game.</p></td>
</tr>
@@ -791,7 +1035,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>If true the TouchEvent will have prevent.default called on it.</p></td>
</tr>
@@ -823,7 +1067,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-74">line 74</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-67">line 67</a>
</li></ul></dd>
@@ -886,7 +1130,7 @@
<td class="type">
<span class="param-type">Description</span>
<span class="param-type">function</span>
@@ -896,7 +1140,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>A callback that can be fired on a touchCancel event.</p></td>
</tr>
@@ -921,14 +1165,11 @@
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-68">line 68</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-61">line 61</a>
</li></ul></dd>
@@ -991,7 +1232,7 @@
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
<span class="param-type">function</span>
@@ -1001,7 +1242,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>A callback that can be fired on a touchEnd event.</p></td>
</tr>
@@ -1026,14 +1267,11 @@
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-50">line 50</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-46">line 46</a>
</li></ul></dd>
@@ -1096,7 +1334,7 @@
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
<span class="param-type">function</span>
@@ -1106,7 +1344,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>A callback that can be fired on a touchEnter event.</p></td>
</tr>
@@ -1131,14 +1369,11 @@
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-56">line 56</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-51">line 51</a>
</li></ul></dd>
@@ -1201,7 +1436,7 @@
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
<span class="param-type">function</span>
@@ -1211,7 +1446,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>A callback that can be fired on a touchLeave event.</p></td>
</tr>
@@ -1236,14 +1471,11 @@
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-62">line 62</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-56">line 56</a>
</li></ul></dd>
@@ -1306,7 +1538,7 @@
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
<span class="param-type">function</span>
@@ -1316,7 +1548,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>A callback that can be fired on a touchMove event.</p></td>
</tr>
@@ -1341,14 +1573,11 @@
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-44">line 44</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-41">line 41</a>
</li></ul></dd>
@@ -1411,7 +1640,7 @@
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
<span class="param-type">function</span>
@@ -1421,7 +1650,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>A callback that can be fired on a touchStart event.</p></td>
</tr>
@@ -1446,14 +1675,11 @@
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-38">line 38</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-36">line 36</a>
</li></ul></dd>
@@ -1518,7 +1744,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-132">line 132</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-164">line 164</a>
</li></ul></dd>
@@ -1541,94 +1767,6 @@
</dd>
<dt>
<h4 class="name" id="disabled"><span class="type-signature"></span>disabled<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>You can disable all Input by setting disabled = true. While set all new input related events will be ignored.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-22">line 22</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
@@ -1683,7 +1821,7 @@ Occurs for example on iOS when you put down 4 fingers and the app selector UI ap
<td class="type">
<span class="param-type">Any</span>
<span class="param-type">TouchEvent</span>
@@ -1693,7 +1831,7 @@ Occurs for example on iOS when you put down 4 fingers and the app selector UI ap
<td class="description last"></td>
<td class="description last"><p>The native event from the browser. This gets stored in Touch.event.</p></td>
</tr>
@@ -1725,7 +1863,7 @@ Occurs for example on iOS when you put down 4 fingers and the app selector UI ap
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-178">line 178</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-212">line 212</a>
</li></ul></dd>
@@ -1761,7 +1899,7 @@ Occurs for example on iOS when you put down 4 fingers and the app selector UI ap
<div class="description">
<p>Description.</p>
<p>The handler for the touchend events.</p>
</div>
@@ -1801,7 +1939,7 @@ Occurs for example on iOS when you put down 4 fingers and the app selector UI ap
<td class="type">
<span class="param-type">Any</span>
<span class="param-type">TouchEvent</span>
@@ -1811,7 +1949,7 @@ Occurs for example on iOS when you put down 4 fingers and the app selector UI ap
<td class="description last"></td>
<td class="description last"><p>The native event from the browser. This gets stored in Touch.event.</p></td>
</tr>
@@ -1843,7 +1981,7 @@ Occurs for example on iOS when you put down 4 fingers and the app selector UI ap
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-289">line 289</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-335">line 335</a>
</li></ul></dd>
@@ -1920,7 +2058,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<td class="type">
<span class="param-type">Any</span>
<span class="param-type">TouchEvent</span>
@@ -1930,7 +2068,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<td class="description last"></td>
<td class="description last"><p>The native event from the browser. This gets stored in Touch.event.</p></td>
</tr>
@@ -1962,7 +2100,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-210">line 210</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-246">line 246</a>
</li></ul></dd>
@@ -2039,7 +2177,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<td class="type">
<span class="param-type">Any</span>
<span class="param-type">TouchEvent</span>
@@ -2049,7 +2187,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<td class="description last"></td>
<td class="description last"><p>The native event from the browser. This gets stored in Touch.event.</p></td>
</tr>
@@ -2081,7 +2219,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-240">line 240</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-280">line 280</a>
</li></ul></dd>
@@ -2117,7 +2255,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<div class="description">
<p>Description.</p>
<p>The handler for the touchmove events.</p>
</div>
@@ -2157,7 +2295,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<td class="type">
<span class="param-type">Any</span>
<span class="param-type">TouchEvent</span>
@@ -2167,7 +2305,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<td class="description last"></td>
<td class="description last"><p>The native event from the browser. This gets stored in Touch.event.</p></td>
</tr>
@@ -2199,7 +2337,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-265">line 265</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-309">line 309</a>
</li></ul></dd>
@@ -2235,7 +2373,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<div class="description">
<p>Description.</p>
<p>The internal method that handles the touchstart event from the browser.</p>
</div>
@@ -2275,7 +2413,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<td class="type">
<span class="param-type">Any</span>
<span class="param-type">TouchEvent</span>
@@ -2285,7 +2423,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<td class="description last"></td>
<td class="description last"><p>The native event from the browser. This gets stored in Touch.event.</p></td>
</tr>
@@ -2317,7 +2455,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-146">line 146</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-178">line 178</a>
</li></ul></dd>
@@ -2386,7 +2524,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-88">line 88</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-120">line 120</a>
</li></ul></dd>
@@ -2455,7 +2593,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-316">line 316</a>
<a href="Touch.js.html">input/Touch.js</a>, <a href="Touch.js.html#sunlight-1-line-364">line 364</a>
</li></ul></dd>
@@ -2506,7 +2644,7 @@ Doesn't appear to be supported by most browsers on a canvas element yet.</p>
<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:35 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>