wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-08-17 11:23:42 +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.Mouse.html
+281 -58
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>
@@ -387,7 +427,7 @@
Mouse
</h2>
<div class="class-description"><p>The Mouse class</p></div>
<div class="class-description"><p>Phaser.Mouse</p></div>
</header>
@@ -406,7 +446,7 @@
<div class="description">
<p>Phaser - Mouse constructor.</p>
<p>Phaser.Mouse is responsible for handling all aspects of mouse interaction with the browser. It captures and processes mouse events.</p>
</div>
@@ -488,7 +528,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-15">line 15</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-14">line 14</a>
</li></ul></dd>
@@ -574,7 +614,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-83">line 83</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-105">line 105</a>
</li></ul></dd>
@@ -634,7 +674,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-89">line 89</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-111">line 111</a>
</li></ul></dd>
@@ -694,7 +734,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-78">line 78</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-99">line 99</a>
</li></ul></dd>
@@ -754,7 +794,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-95">line 95</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-117">line 117</a>
</li></ul></dd>
@@ -856,7 +896,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-49">line 49</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-50">line 50</a>
</li></ul></dd>
@@ -929,7 +969,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The context under which callbacks are called.</p></td>
</tr>
@@ -958,7 +998,109 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-25">line 25</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-24">line 24</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="capture"><span class="type-signature"></span>capture<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>capture</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>If true the DOM mouse events will have event.preventDefault applied to them, if false they will propogate fully.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-44">line 44</a>
</li></ul></dd>
@@ -982,10 +1124,6 @@
</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>
@@ -1035,7 +1173,7 @@
<td class="description last"></td>
<td class="description last"><p>You can disable all Input by setting disabled = true. While set all new input related events will be ignored.</p></td>
</tr>
@@ -1076,6 +1214,108 @@
</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">MouseEvent</span>
</td>
<td class="description last"><p>The browser mouse event.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-73">line 73</a>
</li></ul></dd>
</dl>
@@ -1140,7 +1380,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>
@@ -1169,7 +1409,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-20">line 20</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-19">line 19</a>
</li></ul></dd>
@@ -1193,10 +1433,6 @@
</dt>
<dd>
<div class="description">
<p>If the mouse has been Pointer Locked successfully this will be set to true.</p>
</div>
@@ -1246,7 +1482,7 @@
<td class="description last"></td>
<td class="description last"><p>If the mouse has been Pointer Locked successfully this will be set to true.</p></td>
</tr>
@@ -1278,7 +1514,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-63">line 63</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-62">line 62</a>
</li></ul></dd>
@@ -1351,7 +1587,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>A callback that can be fired when the mouse is pressed down.</p></td>
</tr>
@@ -1376,14 +1612,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="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-31">line 31</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-29">line 29</a>
</li></ul></dd>
@@ -1456,7 +1689,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>A callback that can be fired when the mouse is moved while pressed down.</p></td>
</tr>
@@ -1481,14 +1714,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="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-37">line 37</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-34">line 34</a>
</li></ul></dd>
@@ -1561,7 +1791,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>A callback that can be fired when the mouse is released from a pressed down state.</p></td>
</tr>
@@ -1586,14 +1816,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="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-43">line 43</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-39">line 39</a>
</li></ul></dd>
@@ -1617,10 +1844,6 @@
</dt>
<dd>
<div class="description">
<p>This event is dispatched when the browser enters or leaves pointer lock state.</p>
</div>
@@ -1670,7 +1893,7 @@
<td class="description last"></td>
<td class="description last"><p>This event is dispatched when the browser enters or leaves pointer lock state.</p></td>
</tr>
@@ -1699,7 +1922,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-70">line 70</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-68">line 68</a>
</li></ul></dd>
@@ -1781,7 +2004,7 @@
<td class="description last"></td>
<td class="description last"><p>The native event from the browser. This gets stored in Mouse.event.</p></td>
</tr>
@@ -1813,7 +2036,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-131">line 131</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-153">line 153</a>
</li></ul></dd>
@@ -1899,7 +2122,7 @@
<td class="description last"></td>
<td class="description last"><p>The native event from the browser. This gets stored in Mouse.event.</p></td>
</tr>
@@ -1931,7 +2154,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-169">line 169</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-185">line 185</a>
</li></ul></dd>
@@ -2017,7 +2240,7 @@
<td class="description last"></td>
<td class="description last"><p>The native event from the browser. This gets stored in Mouse.event.</p></td>
</tr>
@@ -2049,7 +2272,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-194">line 194</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-215">line 215</a>
</li></ul></dd>
@@ -2125,7 +2348,7 @@
<td class="type">
<span class="param-type">MouseEvent</span>
<span class="param-type">pointerlockchange</span>
@@ -2135,7 +2358,7 @@
<td class="description last"></td>
<td class="description last"><p>The native event from the browser. This gets stored in Mouse.event.</p></td>
</tr>
@@ -2167,7 +2390,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-250">line 250</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-276">line 276</a>
</li></ul></dd>
@@ -2236,7 +2459,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-274">line 274</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-300">line 300</a>
</li></ul></dd>
@@ -2307,7 +2530,7 @@ If the browser successfully enters a locked state the event Phaser.Mouse.pointer
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-221">line 221</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-247">line 247</a>
</li></ul></dd>
@@ -2376,7 +2599,7 @@ If the browser successfully enters a locked state the event Phaser.Mouse.pointer
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-99">line 99</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-121">line 121</a>
</li></ul></dd>
@@ -2445,7 +2668,7 @@ If the browser successfully enters a locked state the event Phaser.Mouse.pointer
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-290">line 290</a>
<a href="Mouse.js.html">input/Mouse.js</a>, <a href="Mouse.js.html#sunlight-1-line-316">line 316</a>
</li></ul></dd>
@@ -2496,7 +2719,7 @@ If the browser successfully enters a locked state the event Phaser.Mouse.pointer
<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>