Updated documentation.

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
+170 -445
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>
@@ -579,7 +619,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
<span class="param-type">Object</span>
@@ -589,7 +629,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The context under which callbacks are called (defaults to game).</p></td>
</tr>
@@ -724,7 +764,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-51">line 51</a>
<a href="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-33">line 33</a>
</li></ul></dd>
@@ -797,7 +837,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<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>
@@ -835,321 +875,6 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
</dl>
</dd>
<dt>
<h4 class="name" id="mouseDownCallback"><span class="type-signature"></span>mouseDownCallback<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>mouseDownCallback</code></td>
<td class="type">
<span class="param-type">Description</span>
</td>
<td class="description last"><p>Description.</p></td>
</tr>
</tbody>
</table>
</dl>
<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="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-33">line 33</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="mouseMoveCallback"><span class="type-signature"></span>mouseMoveCallback<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>mouseMoveCallback</code></td>
<td class="type">
<span class="param-type">Description</span>
</td>
<td class="description last"><p>Description.</p></td>
</tr>
</tbody>
</table>
</dl>
<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="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-39">line 39</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="mouseUpCallback"><span class="type-signature"></span>mouseUpCallback<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>mouseUpCallback</code></td>
<td class="type">
<span class="param-type">Description</span>
</td>
<td class="description last"><p>Description.</p></td>
</tr>
</tbody>
</table>
</dl>
<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="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-45">line 45</a>
</li></ul></dd>
</dl>
@@ -1173,7 +898,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<div class="description">
<p>Description.</p>
<p>The function that handles the PointerDown event.</p>
</div>
@@ -1213,7 +938,125 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<td class="type">
<span class="param-type">Any</span>
<span class="param-type">PointerEvent</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-95">line 95</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onPointerMove"><span class="type-signature"></span>onPointerMove<span class="signature">(event)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The function that handles the PointerMove event.</p>
</div>
<h5>Parameters:</h5>
<table class="params 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">PointerEvent</span>
@@ -1283,7 +1126,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<dt>
<h4 class="name" id="onPointerMove"><span class="type-signature"></span>onPointerMove<span class="signature">(event)</span><span class="type-signature"></span></h4>
<h4 class="name" id="onPointerUp"><span class="type-signature"></span>onPointerUp<span class="signature">(event)</span><span class="type-signature"></span></h4>
</dt>
@@ -1291,7 +1134,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<div class="description">
<p>Description.</p>
<p>The function that handles the PointerUp event.</p>
</div>
@@ -1331,7 +1174,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<td class="type">
<span class="param-type">Any</span>
<span class="param-type">PointerEvent</span>
@@ -1396,124 +1239,6 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
</dd>
<dt>
<h4 class="name" id="onPointerUp"><span class="type-signature"></span>onPointerUp<span class="signature">(event)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Description.</p>
</div>
<h5>Parameters:</h5>
<table class="params 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">Any</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-152">line 152</a>
</li></ul></dd>
</dl>
</dd>
@@ -1560,7 +1285,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-81">line 81</a>
<a href="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-57">line 57</a>
</li></ul></dd>
@@ -1629,7 +1354,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-171">line 171</a>
<a href="MSPointer.js.html">input/MSPointer.js</a>, <a href="MSPointer.js.html#sunlight-1-line-152">line 152</a>
</li></ul></dd>
@@ -1680,7 +1405,7 @@ It will work only in Internet Explorer 10 and Windows Store or Windows Phone 8 a
<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>