wassname/phaser-plugin-isometric
1
0
Fork 0
mirror of https://github.com/wassname/phaser-plugin-isometric.git synced 2026-08-27 12:20:52 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
6bc0073df7ee69ef5a64bb3dfbdc6da5dfb22f60
phaser-plugin-isometric/doc/Phaser.Plugin.Isometric.Body.html
T

9692 lines
108 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Isometric Class: Body</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser Isometric</a>
<ul class="nav">
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="Phaser.Plugin.Isometric.html">Phaser.Plugin.Isometric</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Arcade.html">Phaser.Plugin.Isometric.Arcade</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Body.html">Phaser.Plugin.Isometric.Body</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Cube.html">Phaser.Plugin.Isometric.Cube</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.IsoSprite.html">Phaser.Plugin.Isometric.IsoSprite</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Octree.html">Phaser.Plugin.Isometric.Octree</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a>
</li>
<li>
<a href="Phaser.Plugin.Isometric.Projector.html">Phaser.Plugin.Isometric.Projector</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: Body</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.Plugin.Isometric.html">.Isometric</a>.</span>
Body
</h2>
<div class="class-description"><p>IsoArcade Physics Body Constructor</p></div>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Body"><span class="type-signature"></span>new Body<span class="signature">(sprite)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The Physics Body is linked to a single IsoSprite. All physics operations should be performed against the body rather than
the IsoSprite itself. For example you can set the velocity, acceleration, bounce values etc all on the Body.</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>sprite</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.IsoSprite.html">Phaser.Plugin.Isometric.IsoSprite</a></span>
</td>
<td class="description last"><p>The IsoSprite object this physics body belongs to.</p></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/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-10">line 10</a>
</li>
</ul>
</dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt class="name" id="acceleration">
<h4><span class="type-signature"></span>acceleration<span class="type-signature"></span></h4>
</dt>
<dd>
<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>acceleration</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>The velocity in pixels per second sq. of the Body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-139">line 139</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="allowGravity">
<h4><span class="type-signature"></span>allowGravity<span class="type-signature"></span></h4>
</dt>
<dd>
<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>allowGravity</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Allow this Body to be influenced by gravity? Either world or local.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>true</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-150">line 150</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="allowRotation">
<h4><span class="type-signature"></span>allowRotation<span class="type-signature"></span></h4>
</dt>
<dd>
<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>allowRotation</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Allow this Body to be rotated? (via angularVelocity, etc)</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>true</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-54">line 54</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="angle">
<h4><span class="type-signature">&lt;readonly> </span>angle<span class="type-signature"></span></h4>
</dt>
<dd>
<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>angle</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The angle of the Body in radians as calculated by its velocity, rather than its visual angle.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-202">line 202</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="angularAcceleration">
<h4><span class="type-signature"></span>angularAcceleration<span class="type-signature"></span></h4>
</dt>
<dd>
<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>angularAcceleration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The angular acceleration in pixels per second sq. of the Body.</p></td>
</tr>
</tbody>
</table>
</dl>
<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="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-178">line 178</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="angularDrag">
<h4><span class="type-signature"></span>angularDrag<span class="type-signature"></span></h4>
</dt>
<dd>
<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>angularDrag</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The angular drag applied to the rotation of the Body.</p></td>
</tr>
</tbody>
</table>
</dl>
<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="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-184">line 184</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="angularVelocity">
<h4><span class="type-signature"></span>angularVelocity<span class="type-signature"></span></h4>
</dt>
<dd>
<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>angularVelocity</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The angular velocity in pixels per second sq. of the Body.</p></td>
</tr>
</tbody>
</table>
</dl>
<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="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-172">line 172</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="blocked">
<h4><span class="type-signature"></span>blocked<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This object is populated with boolean values when the Body collides with the World bounds or a Tile.
For example if blocked.up is true then the Body cannot move up.</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>blocked</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>An object containing on which faces this Body is blocked from moving, if any.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-335">line 335</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="bottom">
<h4><span class="type-signature">&lt;readonly> </span>bottom<span class="type-signature"></span></h4>
</dt>
<dd>
<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>right</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The front Y value of this Body (same as Body.y + Body.widthY) - alias used for QuadTree</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-928">line 928</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="bounce">
<h4><span class="type-signature"></span>bounce<span class="type-signature"></span></h4>
</dt>
<dd>
<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>bounce</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>The elasticitiy of the Body when colliding. bounce.x/y/z = 1 means full rebound, bounce.x/y/z = 0.5 means 50% rebound velocity.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-160">line 160</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="center">
<h4><span class="type-signature"></span>center<span class="type-signature"></span></h4>
</dt>
<dd>
<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>center</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>The center coordinate of the physics body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-118">line 118</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="checkCollision">
<h4><span class="type-signature"></span>checkCollision<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set the checkCollision properties to control which directions collision is processed for this Body.
For example checkCollision.up = false means it won't collide when the collision happened while moving up.</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>checkCollision</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>An object containing allowed collision.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-290">line 290</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="collideWorldBounds">
<h4><span class="type-signature"></span>collideWorldBounds<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A Body can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World.</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>collideWorldBounds</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Should the Body collide with the World bounds?</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-283">line 283</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="customSeparateX">
<h4><span class="type-signature"></span>customSeparateX<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This flag allows you to disable the custom x separation that takes place by Physics.IsoArcade.separate.
Used in combination with your own collision processHandler you can create whatever type of collision response you need.</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>customSeparateX</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Use a custom separation system or the built-in one?</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>false</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-237">line 237</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="customSeparateY">
<h4><span class="type-signature"></span>customSeparateY<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This flag allows you to disable the custom y separation that takes place by Physics.IsoArcade.separate.
Used in combination with your own collision processHandler you can create whatever type of collision response you need.</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>customSeparateY</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Use a custom separation system or the built-in one?</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>false</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-245">line 245</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="customSeparateZ">
<h4><span class="type-signature"></span>customSeparateZ<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This flag allows you to disable the custom z separation that takes place by Physics.IsoArcade.separate.
Used in combination with your own collision processHandler you can create whatever type of collision response you need.</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>customSeparateZ</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Use a custom separation system or the built-in one?</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>false</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-253">line 253</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="deltaMax">
<h4><span class="type-signature"></span>deltaMax<span class="type-signature"></span></h4>
</dt>
<dd>
<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>deltaMax</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>The Sprite position is updated based on the delta x/y values. You can set a cap on those (both +-) using deltaMax.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-134">line 134</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="drag">
<h4><span class="type-signature"></span>drag<span class="type-signature"></span></h4>
</dt>
<dd>
<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>drag</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>The drag applied to the motion of the Body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-144">line 144</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="embedded">
<h4><span class="type-signature"></span>embedded<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>If a body is overlapping with another body, but neither of them are moving (maybe they spawned on-top of each other?) this is set to true.</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>embedded</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Body embed value.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-277">line 277</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="enable">
<h4><span class="type-signature"></span>enable<span class="type-signature"></span></h4>
</dt>
<dd>
<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>enable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>A disabled body won't be checked for any form of collision or overlap or have its pre/post updates run.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>true</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-31">line 31</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="facing">
<h4><span class="type-signature"></span>facing<span class="type-signature"></span></h4>
</dt>
<dd>
<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>facing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A const reference to the direction the Body is traveling or facing.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-214">line 214</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="frontX">
<h4><span class="type-signature">&lt;readonly> </span>frontX<span class="type-signature"></span></h4>
</dt>
<dd>
<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>right</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The front X value of this Body (same as Body.x + Body.widthX)</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-889">line 889</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="frontY">
<h4><span class="type-signature">&lt;readonly> </span>frontY<span class="type-signature"></span></h4>
</dt>
<dd>
<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>right</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The front Y value of this Body (same as Body.y + Body.widthY)</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-915">line 915</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="game">
<h4><span class="type-signature"></span>game<span class="type-signature"></span></h4>
</dt>
<dd>
<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>game</code></td>
<td class="type">
<span class="param-type">Phaser.Game</span>
</td>
<td class="description last"><p>Local reference to game.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-20">line 20</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="gravity">
<h4><span class="type-signature"></span>gravity<span class="type-signature"></span></h4>
</dt>
<dd>
<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>gravity</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>A local gravity applied to this Body. If non-zero this over rides any world gravity, unless Body.allowGravity is set to false.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-155">line 155</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="halfHeight">
<h4><span class="type-signature"></span>halfHeight<span class="type-signature"></span></h4>
</dt>
<dd>
<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>halfHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The calculated height / 2 of the physics body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-113">line 113</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="halfWidthX">
<h4><span class="type-signature"></span>halfWidthX<span class="type-signature"></span></h4>
</dt>
<dd>
<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>halfWidthX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The calculated X width / 2 of the physics body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-103">line 103</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="halfWidthY">
<h4><span class="type-signature"></span>halfWidthY<span class="type-signature"></span></h4>
</dt>
<dd>
<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>halfWidthX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The calculated X width / 2 of the physics body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-108">line 108</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="height">
<h4><span class="type-signature"></span>height<span class="type-signature"></span></h4>
</dt>
<dd>
<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>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The calculated height of the physics body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-98">line 98</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="immovable">
<h4><span class="type-signature"></span>immovable<span class="type-signature"></span></h4>
</dt>
<dd>
<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>immovable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>An immovable Body will not receive any impacts from other bodies.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>false</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-220">line 220</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="mass">
<h4><span class="type-signature"></span>mass<span class="type-signature"></span></h4>
</dt>
<dd>
<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>mass</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The mass of the Body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>1</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-196">line 196</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="maxAngular">
<h4><span class="type-signature"></span>maxAngular<span class="type-signature"></span></h4>
</dt>
<dd>
<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>maxAngular</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The maximum angular velocity in pixels per second sq. that the Body can reach.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>1000</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-190">line 190</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="maxVelocity">
<h4><span class="type-signature"></span>maxVelocity<span class="type-signature"></span></h4>
</dt>
<dd>
<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>maxVelocity</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>The maximum velocity in pixels per second sq. that the Body can reach.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-166">line 166</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="moves">
<h4><span class="type-signature"></span>moves<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>If you have a Body that is being moved around the world via a tween or a Group motion, but its local x/y position never
actually changes, then you should set Body.moves = false. Otherwise it will most likely fly off the screen.
If you want the physics system to move the body around, then set moves to true.</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>moves</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Set to true to allow the Physics system to move this Body, other false to move it manually.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>true</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-229">line 229</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="newVelocity">
<h4><span class="type-signature">&lt;readonly> </span>newVelocity<span class="type-signature"></span></h4>
</dt>
<dd>
<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>newVelocity</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>New velocity.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-129">line 129</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="offset">
<h4><span class="type-signature"></span>offset<span class="type-signature"></span></h4>
</dt>
<dd>
<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>offset</code></td>
<td class="type">
<span class="param-type">Phaser.Point</span>
</td>
<td class="description last"><p>The offset of the Physics Body from the IsoSprite x/y/z position.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-36">line 36</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="overlapX">
<h4><span class="type-signature"></span>overlapX<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>When this body collides with another, the amount of overlap is stored here.</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>overlapX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The amount of horizontal overlap during the collision.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-259">line 259</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="overlapY">
<h4><span class="type-signature"></span>overlapY<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>When this body collides with another, the amount of overlap is stored here.</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>overlapY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The amount of vertical overlap during the collision.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-265">line 265</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="overlapZ">
<h4><span class="type-signature"></span>overlapZ<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>When this body collides with another, the amount of overlap is stored here.</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>overlapY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The amount of vertical overlap during the collision.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-271">line 271</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="phase">
<h4><span class="type-signature"></span>phase<span class="type-signature"></span></h4>
</dt>
<dd>
<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>phase</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Is this Body in a preUpdate (1) or postUpdate (2) state?</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-347">line 347</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="position">
<h4><span class="type-signature">&lt;readonly> </span>position<span class="type-signature"></span></h4>
</dt>
<dd>
<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>position</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>The position of the physics body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-42">line 42</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="preRotation">
<h4><span class="type-signature">&lt;readonly> </span>preRotation<span class="type-signature"></span></h4>
</dt>
<dd>
<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>preRotation</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The previous rotation of the physics body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-65">line 65</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="prev">
<h4><span class="type-signature">&lt;readonly> </span>prev<span class="type-signature"></span></h4>
</dt>
<dd>
<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>prev</code></td>
<td class="type">
<span class="param-type">Phaser.Point</span>
</td>
<td class="description last"><p>The previous position of the physics body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-48">line 48</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="right">
<h4><span class="type-signature">&lt;readonly> </span>right<span class="type-signature"></span></h4>
</dt>
<dd>
<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>right</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The front X value of this Body (same as Body.x + Body.widthX) - alias used for QuadTree</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-902">line 902</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="rotation">
<h4><span class="type-signature"></span>rotation<span class="type-signature"></span></h4>
</dt>
<dd>
<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>rotation</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The amount the Body is rotated.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-59">line 59</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="skipTree">
<h4><span class="type-signature"></span>skipTree<span class="type-signature"></span></h4>
</dt>
<dd>
<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>skipTree</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>If true and you collide this IsoSprite against a Group, it will disable the collision check from using a QuadTree/Octree.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-352">line 352</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="sourceHeight">
<h4><span class="type-signature">&lt;readonly> </span>sourceHeight<span class="type-signature"></span></h4>
</dt>
<dd>
<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>sourceHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The un-scaled original size.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-83">line 83</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="sourceWidthX">
<h4><span class="type-signature">&lt;readonly> </span>sourceWidthX<span class="type-signature"></span></h4>
</dt>
<dd>
<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>sourceWidthX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The un-scaled original size.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-71">line 71</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="sourceWidthY">
<h4><span class="type-signature">&lt;readonly> </span>sourceWidthY<span class="type-signature"></span></h4>
</dt>
<dd>
<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>sourceWidthY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The un-scaled original size.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-77">line 77</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="speed">
<h4><span class="type-signature">&lt;readonly> </span>speed<span class="type-signature"></span></h4>
</dt>
<dd>
<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>speed</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The speed of the Body as calculated by its velocity.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-208">line 208</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="sprite">
<h4><span class="type-signature"></span>sprite<span class="type-signature"></span></h4>
</dt>
<dd>
<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>sprite</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.IsoSprite.html">Phaser.Plugin.Isometric.IsoSprite</a></span>
</td>
<td class="description last"><p>Reference to the parent IsoSprite.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-15">line 15</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="top">
<h4><span class="type-signature">&lt;readonly> </span>top<span class="type-signature"></span></h4>
</dt>
<dd>
<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>bottom</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The top value of this Body (same as Body.z + Body.height)</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-876">line 876</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="touching">
<h4><span class="type-signature"></span>touching<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This object is populated with boolean values when the Body collides with another.
touching.up = true means the collision happened to the top of this Body for example.</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>touching</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>An object containing touching results.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-306">line 306</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="type">
<h4><span class="type-signature"></span>type<span class="type-signature"></span></h4>
</dt>
<dd>
<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>type</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The type of physics system this body belongs to.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-25">line 25</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="velocity">
<h4><span class="type-signature"></span>velocity<span class="type-signature"></span></h4>
</dt>
<dd>
<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>velocity</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a></span>
</td>
<td class="description last"><p>The velocity in pixels per second sq. of the Body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-123">line 123</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="wasTouching">
<h4><span class="type-signature"></span>wasTouching<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This object is populated with previous touching values from the bodies previous collision.</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>wasTouching</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>An object containing previous touching results.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-320">line 320</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="widthX">
<h4><span class="type-signature"></span>widthX<span class="type-signature"></span></h4>
</dt>
<dd>
<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>widthX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The calculated X width (breadth) of the physics body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-88">line 88</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="widthY">
<h4><span class="type-signature"></span>widthY<span class="type-signature"></span></h4>
</dt>
<dd>
<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>widthY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The calculated Y width (depth) of the physics body.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-93">line 93</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="x">
<h4><span class="type-signature"></span>x<span class="type-signature"></span></h4>
</dt>
<dd>
<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>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The x position.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-942">line 942</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="y">
<h4><span class="type-signature"></span>y<span class="type-signature"></span></h4>
</dt>
<dd>
<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>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The y position.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-959">line 959</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt class="name" id="z">
<h4><span class="type-signature"></span>z<span class="type-signature"></span></h4>
</dt>
<dd>
<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>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The z position.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-977">line 977</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="checkWorldBounds"><span class="type-signature">&lt;protected> </span>checkWorldBounds<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Internal method.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-617">line 617</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="deltaAbsX"><span class="type-signature"></span>deltaAbsX<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the absolute delta x value.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-770">line 770</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The absolute delta value.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="deltaAbsY"><span class="type-signature"></span>deltaAbsY<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the absolute delta y value.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-782">line 782</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The absolute delta value.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="deltaAbsZ"><span class="type-signature"></span>deltaAbsZ<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the absolute delta z value.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-794">line 794</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The absolute delta value.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="deltaR"><span class="type-signature"></span>deltaR<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the delta r value. The difference between Body.rotation now and in the previous step.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-842">line 842</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The delta value. Positive if the motion was clockwise, negative if anti-clockwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="deltaX"><span class="type-signature"></span>deltaX<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the delta x value. The difference between Body.x now and in the previous step.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-806">line 806</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The delta value. Positive if the motion was to the right, negative if to the left.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="deltaY"><span class="type-signature"></span>deltaY<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the delta y value. The difference between Body.y now and in the previous step.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-818">line 818</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The delta value. Positive if the motion was downwards, negative if upwards.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="deltaZ"><span class="type-signature"></span>deltaZ<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the delta z value. The difference between Body.z now and in the previous step.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-830">line 830</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The delta value. Positive if the motion was downwards, negative if upwards.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes this body's reference to its parent sprite, freeing it up for gc.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-606">line 606</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCorners"><span class="type-signature"></span>getCorners<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a>>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the 8 corners that make up the body's bounding cube.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-854">line 854</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An array of Phaser.Plugin.Isometric.Point3 values specifying each corner co-ordinate.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="Phaser.Plugin.Isometric.Point3.html">Phaser.Plugin.Isometric.Point3</a>></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="hitTest"><span class="type-signature"></span>hitTest<span class="signature">(x, y, z)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Tests if a world point lies within this Body.</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>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The world x coordinate to test.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The world y coordinate to test.</p></td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The world z coordinate to test.</p></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/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-731">line 731</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if the given coordinates are inside this Body, otherwise false.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onFloor"><span class="type-signature"></span>onFloor<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if the bottom of this Body is in contact with either the world bounds.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-746">line 746</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if in contact with either the world bounds.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onWall"><span class="type-signature"></span>onWall<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns true if either side of this Body is in contact with either the world bounds.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-758">line 758</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if in contact with world bounds.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="postUpdate"><span class="type-signature">&lt;protected> </span>postUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Internal method.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-523">line 523</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="preUpdate"><span class="type-signature">&lt;protected> </span>preUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Internal method.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-435">line 435</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="render"><span class="type-signature"></span>render<span class="signature">(context, body, <span class="optional">color</span>, <span class="optional">filled</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Render IsoSprite Body.</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>context</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The context to render to.</p></td>
</tr>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Body.html">Phaser.Plugin.Isometric.Body</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Body to render the info of.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgba(0,255,0,0.4)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></td>
</tr>
<tr>
<td class="name"><code>filled</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>Render the objected as a filled (default, true) or a stroked (false)</p></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/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-995">line 995</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="renderBodyInfo"><span class="type-signature"></span>renderBodyInfo<span class="signature">(body, x, y, <span class="optional">color</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Render IsoSprite Body Physics Data as text.</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>body</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Plugin.Isometric.Body.html">Phaser.Plugin.Isometric.Body</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The Body to render the info of.</p></td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>X position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Y position of the debug info to be rendered.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgb(255,255,255)'
</td>
<td class="description last"><p>color of the debug info to be rendered. (format is css color string).</p></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/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-1070">line 1070</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">(x, y, z)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Resets all Body values (velocity, acceleration, rotation, etc)</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>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The new x position of the Body.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The new y position of the Body.</p></td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The new z position of the Body.</p></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/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-697">line 697</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setSize"><span class="type-signature"></span>setSize<span class="signature">(widthX, widthY, height, <span class="optional">offsetX</span>, <span class="optional">offsetY</span>, <span class="optional">offsetY</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>You can modify the size of the physics Body to be any dimension you need.
So it could be smaller or larger than the parent Sprite. You can also control the x, y and z offset, which
is the position of the Body relative to the center of the Sprite.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>widthX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The X width (breadth) of the Body.</p></td>
</tr>
<tr>
<td class="name"><code>widthY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The Y width (depth) of the Body.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The height of the Body.</p></td>
</tr>
<tr>
<td class="name"><code>offsetX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The X offset of the Body from the Sprite position.</p></td>
</tr>
<tr>
<td class="name"><code>offsetY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The Y offset of the Body from the Sprite position.</p></td>
</tr>
<tr>
<td class="name"><code>offsetY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The Z offset of the Body from the Sprite position.</p></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/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-657">line 657</a>
</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="updateBounds"><span class="type-signature">&lt;protected> </span>updateBounds<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Internal method.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="Body.js.html">physics/Body.js</a>,
<a href="Body.js.html#sunlight-1-line-408">line 408</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Copyright © 2014 Lewis Lane - Rotates.org
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a>
on Wed Aug 6th 2014 using the <a
href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<!--<script src="scripts/sunlight.js"></script>-->
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : "100px"
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
// $( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" );
$( ".tutorial-section pre, .readme-section pre" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
lang = "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink