wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-08-14 12:40:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Tidying up the repo, moving old wip stuff out, clearing up the docs.

Browse Source
This commit is contained in:
photonstorm
2014-02-24 12:14:31 +00:00
parent 46e85c8394
commit 9d9fd06392
774 changed files with 1717 additions and 123045 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Phaser.Loader.html
+265 -31
View File
@@ -2307,7 +2307,7 @@ If you do so the Sprites width or height will be cropped based on the percentage
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-238">line 238</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-240">line 240</a>
</li></ul></dd>
@@ -2565,7 +2565,7 @@ If you do so the Sprites width or height will be cropped based on the percentage
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-653">line 653</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-681">line 681</a>
</li></ul></dd>
@@ -2813,7 +2813,7 @@ If you do so the Sprites width or height will be cropped based on the percentage
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-605">line 605</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-633">line 633</a>
</li></ul></dd>
@@ -3061,7 +3061,7 @@ If you do so the Sprites width or height will be cropped based on the percentage
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-621">line 621</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-649">line 649</a>
</li></ul></dd>
@@ -3309,7 +3309,7 @@ If you do so the Sprites width or height will be cropped based on the percentage
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-637">line 637</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-665">line 665</a>
</li></ul></dd>
@@ -3499,7 +3499,7 @@ If you do so the Sprites width or height will be cropped based on the percentage
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-426">line 426</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-454">line 454</a>
</li></ul></dd>
@@ -3749,7 +3749,7 @@ WARNING: If you specify a callback, the file data will be set to whatever your c
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-378">line 378</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-406">line 406</a>
</li></ul></dd>
@@ -4093,7 +4093,7 @@ WARNING: If you specify a callback, the file data will be set to whatever your c
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-541">line 541</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-569">line 569</a>
</li></ul></dd>
@@ -4257,7 +4257,7 @@ WARNING: If you specify a callback, the file data will be set to whatever your c
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-174">line 174</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-176">line 176</a>
</li></ul></dd>
@@ -4398,7 +4398,7 @@ WARNING: If you specify a callback, the file data will be set to whatever your c
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1186">line 1186</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1227">line 1227</a>
</li></ul></dd>
@@ -4516,7 +4516,7 @@ WARNING: If you specify a callback, the file data will be set to whatever your c
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1211">line 1211</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1252">line 1252</a>
</li></ul></dd>
@@ -4634,7 +4634,7 @@ WARNING: If you specify a callback, the file data will be set to whatever your c
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-989">line 989</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1026">line 1026</a>
</li></ul></dd>
@@ -4752,7 +4752,7 @@ WARNING: If you specify a callback, the file data will be set to whatever your c
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-970">line 970</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1007">line 1007</a>
</li></ul></dd>
@@ -4893,7 +4893,7 @@ WARNING: If you specify a callback, the file data will be set to whatever your c
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-199">line 199</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-201">line 201</a>
</li></ul></dd>
@@ -5124,7 +5124,238 @@ WARNING: If you specify a callback, the file data will be set to whatever your c
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-310">line 310</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-312">line 312</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>This Loader instance.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="json"><span class="type-signature"></span>json<span class="signature">(key, url, <span class="optional">overwrite</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Add a json file to the Loader.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Unique asset key of the json file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the json file.</p></td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-364">line 364</a>
</li></ul></dd>
@@ -5265,7 +5496,7 @@ WARNING: If you specify a callback, the file data will be set to whatever your c
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1154">line 1154</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1191">line 1191</a>
</li></ul></dd>
@@ -5513,7 +5744,7 @@ The data must be in Lime + Corona JSON format. Physics Editor by code'n'web expo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-498">line 498</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-526">line 526</a>
</li></ul></dd>
@@ -5605,7 +5836,7 @@ The data must be in Lime + Corona JSON format. Physics Editor by code'n'web expo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-751">line 751</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-779">line 779</a>
</li></ul></dd>
@@ -5746,7 +5977,7 @@ The data must be in Lime + Corona JSON format. Physics Editor by code'n'web expo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-733">line 733</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-761">line 761</a>
</li></ul></dd>
@@ -5933,7 +6164,7 @@ The data must be in Lime + Corona JSON format. Physics Editor by code'n'web expo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-274">line 274</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-276">line 276</a>
</li></ul></dd>
@@ -6002,7 +6233,7 @@ The data must be in Lime + Corona JSON format. Physics Editor by code'n'web expo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-224">line 224</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-226">line 226</a>
</li></ul></dd>
@@ -6143,7 +6374,7 @@ The data must be in Lime + Corona JSON format. Physics Editor by code'n'web expo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-362">line 362</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-390">line 390</a>
</li></ul></dd>
@@ -6204,7 +6435,7 @@ The data must be in Lime + Corona JSON format. Physics Editor by code'n'web expo
<div class="description">
<p>You can set a Sprite to be a &quot;preload&quot; sprite by passing it to this method.
A &quot;preload&quot; sprite will have its width or height crop adjusted based on the percentage of the loader in real-time.
This allows you to easily make loading bars for games.</p>
This allows you to easily make loading bars for games. Note that Sprite.visible = true will be set when calling this.</p>
</div>
@@ -6249,6 +6480,9 @@ This allows you to easily make loading bars for games.</p>
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
@@ -6697,7 +6931,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-401">line 401</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-429">line 429</a>
</li></ul></dd>
@@ -6789,7 +7023,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-762">line 762</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-790">line 790</a>
</li></ul></dd>
@@ -6997,7 +7231,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-336">line 336</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-338">line 338</a>
</li></ul></dd>
@@ -7267,7 +7501,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-445">line 445</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-473">line 473</a>
</li></ul></dd>
@@ -7359,7 +7593,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1336">line 1336</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1375">line 1375</a>
</li></ul></dd>
@@ -7451,7 +7685,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1357">line 1357</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1396">line 1396</a>
</li></ul></dd>
@@ -7592,7 +7826,7 @@ This allows you to easily make loading bars for games.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1230">line 1230</a>
<a href="Loader.js.html">loader/Loader.js</a>, <a href="Loader.js.html#sunlight-1-line-1271">line 1271</a>
</li></ul></dd>
@@ -7643,7 +7877,7 @@ This allows you to easily make loading bars for games.</p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Fri Feb 21 2014 15:36:29 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Mon Feb 24 2014 12:11:41 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>