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

Tilemap had the wrong @method signatures so most were missing from the docs.

Browse Source
This commit is contained in:
photonstorm
2014-02-08 07:24:40 +00:00
parent 67bd653eb4
commit ee3f6d8e7f
175 changed files with 44668 additions and 10218 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/global.html
+263 -318
View File
@@ -182,6 +182,10 @@
<a href="Phaser.Group.html">Group</a>
</li>
<li>
<a href="Phaser.Image.html">Image</a>
</li>
<li>
<a href="Phaser.Input.html">Input</a>
</li>
@@ -404,20 +408,24 @@
<ul class="dropdown-menu ">
<li>
<a href="global.html#canUseNewCanvasBlendModes">canUseNewCanvasBlendModes</a>
</li>
<li>
<a href="global.html#getNextPowerOfTwo">getNextPowerOfTwo</a>
</li>
<li>
<a href="global.html#hex2rgb">hex2rgb</a>
</li>
<li>
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
<a href="global.html#hitTest">hitTest</a>
</li>
<li>
<a href="global.html#x">x</a>
</li>
<li>
<a href="global.html#y">y</a>
<a href="global.html#rgb2hex">rgb2hex</a>
</li>
@@ -505,6 +513,240 @@
<dl>
<dt>
<h4 class="name" id="canUseNewCanvasBlendModes"><span class="type-signature"></span>canUseNewCanvasBlendModes<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks whether the Canvas BlendModes are supported by the current browser</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-220">line 220</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>whether they are supported</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getNextPowerOfTwo"><span class="type-signature"></span>getNextPowerOfTwo<span class="signature">(number)</span><span class="type-signature"> &rarr; {Number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Given a number, this function returns the closest number that is a power of two
this function is taken from Starling Framework as its pretty neat ;)</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>number</code></td>
<td class="type">
<span class="param-type">Number</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="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-240">line 240</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>the closest number that is a power of two</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="hex2rgb"><span class="type-signature"></span>hex2rgb<span class="signature">(hex)</span><span class="type-signature"></span></h4>
@@ -596,7 +838,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-222">line 222</a>
<a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-200">line 200</a>
</li></ul></dd>
@@ -624,7 +866,7 @@
<dt>
<h4 class="name" id="HEXtoRGB"><span class="type-signature"></span>HEXtoRGB<span class="signature">(hex)</span><span class="type-signature"> &rarr; {array}</span></h4>
<h4 class="name" id="hitTest"><span class="type-signature"></span>hitTest<span class="signature">(displayObject)</span><span class="type-signature"></span></h4>
</dt>
@@ -632,7 +874,7 @@
<div class="description">
<p>Converts a hex color number to an [R, G, B] array</p>
<p>Tests if the current mouse coordinates hit a sprite</p>
</div>
@@ -666,13 +908,13 @@
<tr>
<td class="name"><code>hex</code></td>
<td class="name"><code>displayObject</code></td>
<td class="type">
<span class="param-type">number</span>
<span class="param-type">DisplayObject</span>
@@ -682,7 +924,7 @@
<td class="description last"></td>
<td class="description last"><p>The displayObject to test for a hit</p></td>
</tr>
@@ -714,7 +956,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-218">line 218</a>
<a href="Input.js.html">input/Input.js</a>, <a href="Input.js.html#sunlight-1-line-707">line 707</a>
</li></ul></dd>
@@ -735,25 +977,6 @@
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">array</span>
</dd>
</dl>
</dd>
@@ -761,96 +984,16 @@
<dt>
<h4 class="name" id="x"><span class="type-signature"></span>x<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<h4 class="name" id="rgb2hex"><span class="type-signature"></span>rgb2hex<span class="signature">(rgb)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Body.js.html">physics/arcade/Body.js</a>, <a href="Body.js.html#sunlight-1-line-1458">line 1458</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="x"><span class="type-signature"></span>x<span class="signature">(value)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Converts a color as an [R, G, B] array to a hex number</p>
</div>
@@ -883,13 +1026,13 @@
<tr>
<td class="name"><code>value</code></td>
<td class="name"><code>rgb</code></td>
<td class="type">
<span class="param-type">number</span>
<span class="param-type"><a href="Array.html">Array</a></span>
@@ -931,205 +1074,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Body.js.html">physics/arcade/Body.js</a>, <a href="Body.js.html#sunlight-1-line-1475">line 1475</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="y"><span class="type-signature"></span>y<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Body.js.html">physics/arcade/Body.js</a>, <a href="Body.js.html#sunlight-1-line-1500">line 1500</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="y"><span class="type-signature"></span>y<span class="signature">(value)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>value</code></td>
<td class="type">
<span class="param-type">number</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="Body.js.html">physics/arcade/Body.js</a>, <a href="Body.js.html#sunlight-1-line-1517">line 1517</a>
<a href="Utils.js.html">utils/Utils.js</a>, <a href="Utils.js.html#sunlight-1-line-210">line 210</a>
</li></ul></dd>
@@ -1180,7 +1125,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Wed Feb 05 2014 06:20:17 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Sat Feb 08 2014 07:19:41 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>