wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-09-09 11:28:47 +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.Physics.Arcade.html
+236 -39
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>
@@ -1622,7 +1662,7 @@ Note: The display object doesn't stop moving once it reaches the destination coo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1178">line 1178</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1341">line 1341</a>
</li></ul></dd>
@@ -1936,7 +1976,7 @@ Note: The display object doesn't stop moving once it reaches the destination coo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1207">line 1207</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1370">line 1370</a>
</li></ul></dd>
@@ -2283,7 +2323,7 @@ Note: The display object doesn't stop moving once it reaches the destination coo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1237">line 1237</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1400">line 1400</a>
</li></ul></dd>
@@ -2520,7 +2560,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1159">line 1159</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1322">line 1322</a>
</li></ul></dd>
@@ -2686,7 +2726,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1325">line 1325</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1488">line 1488</a>
</li></ul></dd>
@@ -2870,7 +2910,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1360">line 1360</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1523">line 1523</a>
</li></ul></dd>
@@ -3057,7 +3097,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1342">line 1342</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1505">line 1505</a>
</li></ul></dd>
@@ -3177,7 +3217,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
<dt>
<h4 class="name" id="collide"><span class="type-signature"></span>collide<span class="signature">(object1, object2, <span class="optional">collideCallback</span>, <span class="optional">processCallback</span>, <span class="optional">callbackContext</span>)</span><span class="type-signature"> &rarr; {number}</span></h4>
<h4 class="name" id="collide"><span class="type-signature"></span>collide<span class="signature">(object1, object2, <span class="optional">collideCallback</span>, <span class="optional">processCallback</span>, <span class="optional">callbackContext</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
@@ -3185,8 +3225,8 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
<div class="description">
<p>Checks for collision between two game objects. The objects can be Sprites, Groups, Emitters or Tilemaps.
You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap or Group vs. Tilemap collisions.
<p>Checks for collision between two game objects. The objects can be Sprites, Groups, Emitters or Tilemap Layers.
You can perform Sprite vs. Sprite, Sprite vs. Group, Group vs. Group, Sprite vs. Tilemap Layer or Group vs. Tilemap Layer collisions.
The objects are also automatically separated.</p>
</div>
@@ -3240,7 +3280,7 @@ The objects are also automatically separated.</p>
<span class="param-type">Phaser.Particles.Emitter</span>
|
<span class="param-type">Phaser.Tilemap</span>
<span class="param-type"><a href="Phaser.Tilemap.html">Phaser.Tilemap</a></span>
@@ -3284,7 +3324,7 @@ The objects are also automatically separated.</p>
<span class="param-type">Phaser.Particles.Emitter</span>
|
<span class="param-type">Phaser.Tilemap</span>
<span class="param-type"><a href="Phaser.Tilemap.html">Phaser.Tilemap</a></span>
@@ -3345,7 +3385,7 @@ The objects are also automatically separated.</p>
</td>
<td class="description last"><p>An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you passed them to Collision.overlap.</p></td>
<td class="description last"><p>An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them.</p></td>
</tr>
@@ -3453,7 +3493,7 @@ The objects are also automatically separated.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-304">line 304</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-461">line 461</a>
</li></ul></dd>
@@ -3478,7 +3518,7 @@ The objects are also automatically separated.</p>
<div class="param-desc">
<p>The number of collisions that were processed.</p>
<p>True if a collision occured otherwise false.</p>
</div>
@@ -3489,7 +3529,7 @@ The objects are also automatically separated.</p>
</dt>
<dd>
<span class="param-type">number</span>
<span class="param-type">boolean</span>
</dd>
@@ -3873,7 +3913,7 @@ The objects are also automatically separated.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1267">line 1267</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1430">line 1430</a>
</li></ul></dd>
@@ -4059,7 +4099,7 @@ If you need to calculate from the center of a display object instead use the met
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1304">line 1304</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1467">line 1467</a>
</li></ul></dd>
@@ -4248,7 +4288,7 @@ If you need to calculate from the center of a display object instead use the met
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1284">line 1284</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1447">line 1447</a>
</li></ul></dd>
@@ -4523,7 +4563,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1015">line 1015</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1178">line 1178</a>
</li></ul></dd>
@@ -4799,7 +4839,7 @@ Note: The display object doesn't stop moving once it reaches the destination coo
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1050">line 1050</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1213">line 1213</a>
</li></ul></dd>
@@ -5109,7 +5149,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1085">line 1085</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1248">line 1248</a>
</li></ul></dd>
@@ -5160,7 +5200,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<dt>
<h4 class="name" id="overlap"><span class="type-signature"></span>overlap<span class="signature">(object1, object2)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<h4 class="name" id="overlap"><span class="type-signature"></span>overlap<span class="signature">(object1, object2, <span class="optional">overlapCallback</span>, <span class="optional">processCallback</span>, <span class="optional">callbackContext</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
@@ -5168,7 +5208,9 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<div class="description">
<p>Checks if two Sprite objects overlap.</p>
<p>Checks for overlaps between two game objects. The objects can be Sprites, Groups or Emitters.
You can perform Sprite vs. Sprite, Sprite vs. Group and Group vs. Group overlap checks.
Unlike collide the objects are NOT automatically separated or have any physics applied, they merely test for overlap results.</p>
</div>
@@ -5190,8 +5232,12 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
@@ -5209,16 +5255,34 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Group.html">Phaser.Group</a></span>
|
<span class="param-type">Phaser.Particles.Emitter</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The first object to check. Can be an instance of Phaser.Sprite or anything that extends it.</p></td>
<td class="default">
</td>
<td class="description last"><p>The first object to check. Can be an instance of Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.</p></td>
</tr>
@@ -5232,16 +5296,149 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Group.html">Phaser.Group</a></span>
|
<span class="param-type">Phaser.Particles.Emitter</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The second object to check. Can be an instance of Phaser.Sprite or anything that extends it.</p></td>
<td class="default">
</td>
<td class="description last"><p>The second object to check. Can be an instance of Phaser.Sprite, Phaser.Group or Phaser.Particles.Emitter.</p></td>
</tr>
<tr>
<td class="name"><code>overlapCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>An optional callback function that is called if the objects overlap. The two objects will be passed to this function in the same order in which you specified them.</p></td>
</tr>
<tr>
<td class="name"><code>processCallback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>A callback function that lets you perform additional checks against the two objects if they overlap. If this is set then overlapCallback will only be called if processCallback returns true.</p></td>
</tr>
<tr>
<td class="name"><code>callbackContext</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The context in which to run the callbacks.</p></td>
</tr>
@@ -5298,7 +5495,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<div class="param-desc">
<p>true if the two objects overlap.</p>
<p>True if an overlap occured otherwise false.</p>
</div>
@@ -5782,7 +5979,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-588">line 588</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-745">line 745</a>
</li></ul></dd>
@@ -5904,7 +6101,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<td class="type">
<span class="param-type">Phaser.Tile</span>
<span class="param-type"><a href="Phaser.Tile.html">Phaser.Tile</a></span>
@@ -5946,7 +6143,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-830">line 830</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-991">line 991</a>
</li></ul></dd>
@@ -6068,7 +6265,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<td class="type">
<span class="param-type">Phaser.Tile</span>
<span class="param-type"><a href="Phaser.Tile.html">Phaser.Tile</a></span>
@@ -6110,7 +6307,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-843">line 843</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1006">line 1006</a>
</li></ul></dd>
@@ -6232,7 +6429,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<td class="type">
<span class="param-type">Phaser.Tile</span>
<span class="param-type"><a href="Phaser.Tile.html">Phaser.Tile</a></span>
@@ -6274,7 +6471,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-929">line 929</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1092">line 1092</a>
</li></ul></dd>
@@ -6438,7 +6635,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-601">line 601</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-758">line 758</a>
</li></ul></dd>
@@ -6602,7 +6799,7 @@ Note: Doesn't take into account acceleration, maxVelocity or drag (if you've set
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-709">line 709</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-868">line 868</a>
</li></ul></dd>
@@ -7284,7 +7481,7 @@ One way to use this is: velocityFromAngle(angle, 200, sprite.velocity) which wil
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1121">line 1121</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1284">line 1284</a>
</li></ul></dd>
@@ -7523,7 +7720,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1140">line 1140</a>
<a href="ArcadePhysics.js.html">physics/arcade/ArcadePhysics.js</a>, <a href="ArcadePhysics.js.html#sunlight-1-line-1303">line 1303</a>
</li></ul></dd>
@@ -7599,7 +7796,7 @@ One way to use this is: velocityFromRotation(rotation, 200, sprite.velocity) whi
<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:39 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Nov 28 2013 15:56:32 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>