wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-07-17 11:31:30 +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.GameObjectFactory.html
+509 -18
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>
@@ -742,7 +782,7 @@
<dl>
<dt>
<h4 class="name" id="audio"><span class="type-signature"></span>audio<span class="signature">(key, volume, loop)</span><span class="type-signature"> &rarr; {<a href="Phaser.Sound.html">Phaser.Sound</a>}</span></h4>
<h4 class="name" id="audio"><span class="type-signature"></span>audio<span class="signature">(key, <span class="optional">volume</span>, <span class="optional">loop</span>, <span class="optional">connect</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Sound.html">Phaser.Sound</a>}</span></h4>
</dt>
@@ -772,8 +812,12 @@
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
@@ -797,7 +841,19 @@
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Game.cache key of the sound that this object will use.</p></td>
@@ -820,7 +876,23 @@
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<td class="description last"><p>The volume at which the sound will be played.</p></td>
@@ -843,13 +915,68 @@
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Whether or not the sound will loop.</p></td>
</tr>
<tr>
<td class="name"><code>connect</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.</p></td>
</tr>
</tbody>
</table>
@@ -924,6 +1051,206 @@
</dd>
<dt>
<h4 class="name" id="bitmapData"><span class="type-signature"></span>bitmapData<span class="signature">(<span class="optional">width</span>, <span class="optional">height</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.BitmapData.html">Phaser.BitmapData</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>A BitmapData object which can be manipulated and drawn to like a traditional Canvas object and used to texture Sprites.</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>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
256
</td>
<td class="description last"><p>The width of the BitmapData in pixels.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
256
</td>
<td class="description last"><p>The height of the BitmapData in pixels.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-280">line 280</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The newly created BitmapData object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span>
</dd>
</dl>
</dd>
@@ -1090,7 +1417,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-202">line 202</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-203">line 203</a>
</li></ul></dd>
@@ -1483,7 +1810,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-151">line 151</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-152">line 152</a>
</li></ul></dd>
@@ -2009,7 +2336,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-185">line 185</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-186">line 186</a>
</li></ul></dd>
@@ -2196,6 +2523,170 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
</dd>
<dt>
<h4 class="name" id="filter"><span class="type-signature"></span>filter<span class="signature">(filter)</span><span class="type-signature"> &rarr; {<a href="Phaser.Filter.html">Phaser.Filter</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>A WebGL shader/filter that can be applied to Sprites.</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>filter</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the filter you wish to create, for example HueRotate or SineWave.</p></td>
</tr>
<tr>
<td class="name"><code></code></td>
<td class="type">
<span class="param-type">any</span>
</td>
<td class="description last"><p>Whatever parameters are needed to be passed to the filter init function.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-294">line 294</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The newly created Phaser.Filter object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Phaser.Filter.html">Phaser.Filter</a></span>
</dd>
</dl>
</dd>
@@ -2314,7 +2805,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-171">line 171</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-172">line 172</a>
</li></ul></dd>
@@ -2697,7 +3188,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-260">line 260</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-261">line 261</a>
</li></ul></dd>
@@ -3162,7 +3653,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-135">line 135</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-136">line 136</a>
</li></ul></dd>
@@ -3213,7 +3704,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt>
<h4 class="name" id="tilemap"><span class="type-signature"></span>tilemap<span class="signature">(key)</span><span class="type-signature"> &rarr; {Phaser.Tilemap}</span></h4>
<h4 class="name" id="tilemap"><span class="type-signature"></span>tilemap<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tilemap.html">Phaser.Tilemap</a>}</span></h4>
</dt>
@@ -3303,7 +3794,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-218">line 218</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-219">line 219</a>
</li></ul></dd>
@@ -3339,7 +3830,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
</dt>
<dd>
<span class="param-type">Phaser.Tilemap</span>
<span class="param-type"><a href="Phaser.Tilemap.html">Phaser.Tilemap</a></span>
</dd>
@@ -3354,7 +3845,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt>
<h4 class="name" id="tilemapLayer"><span class="type-signature"></span>tilemapLayer<span class="signature">(x, y, width, height)</span><span class="type-signature"> &rarr; {Phaser.TilemapLayer}</span></h4>
<h4 class="name" id="tilemapLayer"><span class="type-signature"></span>tilemapLayer<span class="signature">(x, y, width, height)</span><span class="type-signature"> &rarr; {<a href="Phaser.TilemapLayer.html">Phaser.TilemapLayer</a>}</span></h4>
</dt>
@@ -3513,7 +4004,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-244">line 244</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-245">line 245</a>
</li></ul></dd>
@@ -3549,7 +4040,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
</dt>
<dd>
<span class="param-type">Phaser.TilemapLayer</span>
<span class="param-type"><a href="Phaser.TilemapLayer.html">Phaser.TilemapLayer</a></span>
</dd>
@@ -3564,7 +4055,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt>
<h4 class="name" id="tileset"><span class="type-signature"></span>tileset<span class="signature">(key)</span><span class="type-signature"> &rarr; {Phaser.Tileset}</span></h4>
<h4 class="name" id="tileset"><span class="type-signature"></span>tileset<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.Tileset.html">Phaser.Tileset</a>}</span></h4>
</dt>
@@ -3654,7 +4145,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-231">line 231</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-232">line 232</a>
</li></ul></dd>
@@ -3690,7 +4181,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
</dt>
<dd>
<span class="param-type">Phaser.Tileset</span>
<span class="param-type"><a href="Phaser.Tileset.html">Phaser.Tileset</a></span>
</dd>
@@ -3919,7 +4410,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-117">line 117</a>
<a href="GameObjectFactory.js.html">gameobjects/GameObjectFactory.js</a>, <a href="GameObjectFactory.js.html#sunlight-1-line-118">line 118</a>
</li></ul></dd>
@@ -4134,7 +4625,7 @@ at set intervals, and fixes their positions and velocities accorindgly.</p>
<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:36 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Nov 28 2013 15:56:29 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>