wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-07-19 11:26:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Lots of doc updates!

Browse Source
This commit is contained in:
photonstorm
2013-10-25 16:54:40 +01:00
parent 0463bb4333
commit 9f9e6a2a57
147 changed files with 60434 additions and 972 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Phaser.Sound.html
+365 -36
View File
@@ -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>
@@ -798,7 +918,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-145">line 145</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-156">line 156</a>
</li></ul></dd>
@@ -1224,7 +1344,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-715">line 715</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-736">line 736</a>
</li></ul></dd>
@@ -1326,7 +1446,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-702">line 702</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-723">line 723</a>
</li></ul></dd>
@@ -1435,7 +1555,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-138">line 138</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-149">line 149</a>
</li></ul></dd>
@@ -1855,7 +1975,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-728">line 728</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-749">line 749</a>
</li></ul></dd>
@@ -2070,7 +2190,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-212">line 212</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-223">line 223</a>
</li></ul></dd>
@@ -2176,7 +2296,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-236">line 236</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-247">line 247</a>
</li></ul></dd>
@@ -2282,7 +2402,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-254">line 254</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-265">line 265</a>
</li></ul></dd>
@@ -2388,7 +2508,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-248">line 248</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-259">line 259</a>
</li></ul></dd>
@@ -2494,7 +2614,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-224">line 224</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-235">line 235</a>
</li></ul></dd>
@@ -2600,7 +2720,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-218">line 218</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-229">line 229</a>
</li></ul></dd>
@@ -2706,7 +2826,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-230">line 230</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-241">line 241</a>
</li></ul></dd>
@@ -2812,7 +2932,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-242">line 242</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-253">line 253</a>
</li></ul></dd>
@@ -2921,7 +3041,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-159">line 159</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-170">line 170</a>
</li></ul></dd>
@@ -3030,7 +3150,219 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-131">line 131</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-130">line 130</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pausedPosition"><span class="type-signature"></span>pausedPosition<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Description.</p>
</div>
<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>pausedPosition</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-136">line 136</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pausedTime"><span class="type-signature"></span>pausedTime<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Description.</p>
</div>
<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>pausedTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-142">line 142</a>
</li></ul></dd>
@@ -3139,7 +3471,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-152">line 152</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-163">line 163</a>
</li></ul></dd>
@@ -3309,7 +3641,7 @@
<tr>
<td class="name"><code>autoplay</code></td>
<td class="name"><code>stopTime</code></td>
<td class="type">
@@ -3350,14 +3682,11 @@
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-124">line 124</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-123">line 123</a>
</li></ul></dd>
@@ -3572,7 +3901,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-171">line 171</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-182">line 182</a>
</li></ul></dd>
@@ -3678,7 +4007,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-165">line 165</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-176">line 176</a>
</li></ul></dd>
@@ -3780,7 +4109,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-777">line 777</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-798">line 798</a>
</li></ul></dd>
@@ -4000,7 +4329,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-277">line 277</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-288">line 288</a>
</li></ul></dd>
@@ -4283,7 +4612,7 @@ This allows you to bundle multiple sounds together into a single audio file and
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-279">line 279</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-290">line 290</a>
</li></ul></dd>
@@ -4352,7 +4681,7 @@ This allows you to bundle multiple sounds together into a single audio file and
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-619">line 619</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-630">line 630</a>
</li></ul></dd>
@@ -4646,7 +4975,7 @@ This allows you to bundle multiple sounds together into a single audio file and
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-403">line 403</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-414">line 414</a>
</li></ul></dd>
@@ -4787,7 +5116,7 @@ This allows you to bundle multiple sounds together into a single audio file and
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-330">line 330</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-341">line 341</a>
</li></ul></dd>
@@ -5042,7 +5371,7 @@ This allows you to bundle multiple sounds together into a single audio file and
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-600">line 600</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-611">line 611</a>
</li></ul></dd>
@@ -5111,7 +5440,7 @@ This allows you to bundle multiple sounds together into a single audio file and
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-634">line 634</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-648">line 648</a>
</li></ul></dd>
@@ -5229,7 +5558,7 @@ This allows you to bundle multiple sounds together into a single audio file and
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-260">line 260</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-271">line 271</a>
</li></ul></dd>
@@ -5298,7 +5627,7 @@ This allows you to bundle multiple sounds together into a single audio file and
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-666">line 666</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-687">line 687</a>
</li></ul></dd>
@@ -5367,7 +5696,7 @@ This allows you to bundle multiple sounds together into a single audio file and
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-341">line 341</a>
<a href="Sound.js.html">sound/Sound.js</a>, <a href="Sound.js.html#sunlight-1-line-352">line 352</a>
</li></ul></dd>
@@ -5417,8 +5746,8 @@ This allows you to bundle multiple sounds together into a single audio file and
<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:03 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:48 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>