mirror of
https://github.com/wassname/phaser.git
synced 2026-07-11 00:40:20 +08:00
Lots of doc updates!
This commit is contained in:
photonstorm
+141
-280
@@ -54,6 +54,18 @@
|
||||
<a href="Phaser.AnimationParser.html">AnimationParser</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.BitmapText.html">BitmapText</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Bullet.html">Bullet</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Button.html">Button</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Cache.html">Cache</a>
|
||||
</li>
|
||||
@@ -126,6 +138,10 @@
|
||||
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Events.html">Events</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Frame.html">Frame</a>
|
||||
</li>
|
||||
@@ -138,6 +154,14 @@
|
||||
<a href="Phaser.Game.html">Game</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Graphics.html">Graphics</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Group.html">Group</a>
|
||||
</li>
|
||||
@@ -194,6 +218,14 @@
|
||||
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Physics.html">Physics</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Physics.Arcade.html">Arcade</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Plugin.html">Plugin</a>
|
||||
</li>
|
||||
@@ -222,6 +254,10 @@
|
||||
<a href="Phaser.Rectangle.html">Rectangle</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.RenderTexture.html">RenderTexture</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
|
||||
</li>
|
||||
@@ -238,6 +274,10 @@
|
||||
<a href="Phaser.SoundManager.html">SoundManager</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Sprite.html">Sprite</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Stage.html">Stage</a>
|
||||
</li>
|
||||
@@ -254,6 +294,14 @@
|
||||
<a href="Phaser.StateManager.html">StateManager</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Text.html">Text</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.TileSprite.html">TileSprite</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="Phaser.Time.html">Time</a>
|
||||
</li>
|
||||
@@ -296,10 +344,82 @@
|
||||
|
||||
<ul class="dropdown-menu ">
|
||||
|
||||
<li>
|
||||
<a href="global.html#audio">audio</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#bitmapText">bitmapText</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#bottom">bottom</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#button">button</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#child">child</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#emitter">emitter</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#existing.">existing.</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#graphics">graphics</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#group">group</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#renderTexture">renderTexture</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#right">right</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#sprite">sprite</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#text">text</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#tilemap">tilemap</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#tilemaplayer">tilemaplayer</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#tileset">tileset</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#tileSprite">tileSprite</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="global.html#tween">tween</a>
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
@@ -4280,7 +4400,7 @@ For lots of games it's useful to set this to 1.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-744">line 744</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-735">line 735</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5264,7 +5384,7 @@ otherwise see the Pointer objects directly.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-771">line 771</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-762">line 762</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5370,7 +5490,7 @@ otherwise see the Pointer objects directly.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-757">line 757</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-748">line 748</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5585,7 +5705,7 @@ otherwise see the Pointer objects directly.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-797">line 797</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-788">line 788</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5691,7 +5811,7 @@ otherwise see the Pointer objects directly.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-810">line 810</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-801">line 801</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5797,7 +5917,7 @@ otherwise see the Pointer objects directly.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-710">line 710</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-701">line 701</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5903,7 +6023,7 @@ otherwise see the Pointer objects directly.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-727">line 727</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-718">line 718</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -5969,7 +6089,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-400">line 400</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-413">line 413</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6089,7 +6209,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
|
||||
<dt>
|
||||
<h4 class="name" id="getAngle"><span class="type-signature"></span>getAngle<span class="signature">(pointer1, pointer2)</span><span class="type-signature"> → {Description}</span></h4>
|
||||
<h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
|
||||
|
||||
|
||||
</dt>
|
||||
@@ -6097,7 +6217,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
|
||||
<div class="description">
|
||||
<p>Get the angle between two Pointer objects.</p>
|
||||
<p>Stops all of the Input Managers from running.</p>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -6106,78 +6226,6 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
|
||||
|
||||
<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>pointer1</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Pointer</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>pointer2</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Pointer</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"></td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
@@ -6202,7 +6250,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-697">line 697</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-400">line 400</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6223,193 +6271,6 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
<p>Description.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">Description</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<h4 class="name" id="getDistance"><span class="type-signature"></span>getDistance<span class="signature">(pointer1, pointer2)</span><span class="type-signature"> → {Description}</span></h4>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<div class="description">
|
||||
<p>Get the distance between two Pointer objects.</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>pointer1</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Pointer</span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last"></td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>pointer2</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type">Pointer</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="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-686">line 686</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
<p>Description.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<dl>
|
||||
<dt>
|
||||
Type
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type">Description</span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
@@ -6507,7 +6368,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-622">line 622</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-635">line 635</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6648,7 +6509,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-655">line 655</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-668">line 668</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6789,7 +6650,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-465">line 465</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-478">line 478</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -6930,7 +6791,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-511">line 511</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-524">line 524</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7048,7 +6909,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-524">line 524</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-537">line 537</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7189,7 +7050,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-591">line 591</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-604">line 604</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7281,7 +7142,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-431">line 431</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-444">line 444</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7399,7 +7260,7 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-560">line 560</a>
|
||||
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-573">line 573</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@@ -7472,8 +7333,8 @@ If you need more then use this to create a new one, up to a maximum of 10.</p>
|
||||
<br />
|
||||
|
||||
<span class="jsdoc-message">
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a>
|
||||
on Wed Oct 23 2013 13:52:01 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
|
||||
on Fri Oct 25 2013 16:16:46 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
||||
</span>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user