<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Phaser Class: Tile</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</a> <ul class="nav"> <li class="dropdown"> <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a> <ul class="dropdown-menu "> <li> <a href="Phaser.html">Phaser</a> </li> </ul> </li> <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.Animation.html">Animation</a> </li> <li> <a href="Phaser.AnimationManager.html">AnimationManager</a> </li> <li> <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> <li> <a href="Phaser.Button.html">Button</a> </li> <li> <a href="Phaser.Cache.html">Cache</a> </li> <li> <a href="Phaser.Camera.html">Camera</a> </li> <li> <a href="Phaser.Canvas.html">Canvas</a> </li> <li> <a href="Phaser.Circle.html">Circle</a> </li> <li> <a href="Phaser.Color.html">Color</a> </li> <li> <a href="Phaser.Device.html">Device</a> </li> <li> <a href="Phaser.Easing.html">Easing</a> </li> <li> <a href="Phaser.Easing.Back.html">Back</a> </li> <li> <a href="Phaser.Easing.Bounce.html">Bounce</a> </li> <li> <a href="Phaser.Easing.Circular.html">Circular</a> </li> <li> <a href="Phaser.Easing.Cubic.html">Cubic</a> </li> <li> <a href="Phaser.Easing.Elastic.html">Elastic</a> </li> <li> <a href="Phaser.Easing.Exponential.html">Exponential</a> </li> <li> <a href="Phaser.Easing.Linear.html">Linear</a> </li> <li> <a href="Phaser.Easing.Quadratic.html">Quadratic</a> </li> <li> <a href="Phaser.Easing.Quartic.html">Quartic</a> </li> <li> <a href="Phaser.Easing.Quintic.html">Quintic</a> </li> <li> <a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a> </li> <li> <a href="Phaser.Ellipse.html">Ellipse</a> </li> <li> <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> <li> <a href="Phaser.FrameData.html">FrameData</a> </li> <li> <a href="Phaser.Game.html">Game</a> </li> <li> <a href="Phaser.GameObjectCreator.html">GameObjectCreator</a> </li> <li> <a href="Phaser.GameObjectFactory.html">GameObjectFactory</a> </li> <li> <a href="Phaser.Gamepad.html">Gamepad</a> </li> <li> <a href="Phaser.GamepadButton.html">GamepadButton</a> </li> <li> <a href="Phaser.Graphics.html">Graphics</a> </li> <li> <a href="Phaser.Group.html">Group</a> </li> <li> <a href="Phaser.Image.html">Image</a> </li> <li> <a href="Phaser.Input.html">Input</a> </li> <li> <a href="Phaser.InputHandler.html">InputHandler</a> </li> <li> <a href="Phaser.Key.html">Key</a> </li> <li> <a href="Phaser.Keyboard.html">Keyboard</a> </li> <li> <a href="Phaser.Line.html">Line</a> </li> <li> <a href="Phaser.LinkedList.html">LinkedList</a> </li> <li> <a href="Phaser.Loader.html">Loader</a> </li> <li> <a href="Phaser.LoaderParser.html">LoaderParser</a> </li> <li> <a href="Phaser.Math.html">Math</a> </li> <li> <a href="Phaser.Mouse.html">Mouse</a> </li> <li> <a href="Phaser.MSPointer.html">MSPointer</a> </li> <li> <a href="Phaser.Net.html">Net</a> </li> <li> <a href="Phaser.Particles.html">Particles</a> </li> <li> <a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a> </li> <li> <a href="Phaser.Physics.html">Physics</a> </li> <li> <a href="Phaser.Physics.Arcade.html">Arcade</a> </li> <li> <a href="Phaser.Physics.Arcade.Body.html">Body</a> </li> <li> <a href="Phaser.Physics.Ninja.html">Ninja</a> </li> <li> <a href="Phaser.Physics.Ninja.AABB.html">AABB</a> </li> <li> <a href="Phaser.Physics.Ninja.Body.html">Body</a> </li> <li> <a href="Phaser.Physics.Ninja.Circle.html">Circle</a> </li> <li> <a href="Phaser.Physics.Ninja.Tile.html">Tile</a> </li> <li> <a href="Phaser.Physics.P2.html">P2</a> </li> <li> <a href="Phaser.Physics.P2.Body.html">Body</a> </li> <li> <a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a> </li> <li> <a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a> </li> <li> <a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a> </li> <li> <a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a> </li> <li> <a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a> </li> <li> <a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a> </li> <li> <a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a> </li> <li> <a href="Phaser.Physics.P2.Material.html">Material</a> </li> <li> <a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a> </li> <li> <a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a> </li> <li> <a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a> </li> <li> <a href="Phaser.Physics.P2.Spring.html">Spring</a> </li> <li> <a href="Phaser.Plugin.html">Plugin</a> </li> <li> <a href="Phaser.PluginManager.html">PluginManager</a> </li> <li> <a href="Phaser.Point.html">Point</a> </li> <li> <a href="Phaser.Pointer.html">Pointer</a> </li> <li> <a href="Phaser.Polygon.html">Polygon</a> </li> <li> <a href="Phaser.QuadTree.html">QuadTree</a> </li> <li> <a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a> </li> <li> <a href="Phaser.Rectangle.html">Rectangle</a> </li> <li> <a href="Phaser.RenderTexture.html">RenderTexture</a> </li> <li> <a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a> </li> <li> <a href="Phaser.RetroFont.html">RetroFont</a> </li> <li> <a href="Phaser.ScaleManager.html">ScaleManager</a> </li> <li> <a href="Phaser.Signal.html">Signal</a> </li> <li> <a href="Phaser.SinglePad.html">SinglePad</a> </li> <li> <a href="Phaser.Sound.html">Sound</a> </li> <li> <a href="Phaser.SoundManager.html">SoundManager</a> </li> <li> <a href="Phaser.Sprite.html">Sprite</a> </li> <li> <a href="Phaser.SpriteBatch.html">SpriteBatch</a> </li> <li> <a href="Phaser.Stage.html">Stage</a> </li> <li> <a href="Phaser.State.html">State</a> </li> <li> <a href="Phaser.StateManager.html">StateManager</a> </li> <li> <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> <li> <a href="Phaser.Time.html">Time</a> </li> <li> <a href="Phaser.Timer.html">Timer</a> </li> <li> <a href="Phaser.TimerEvent.html">TimerEvent</a> </li> <li> <a href="Phaser.Touch.html">Touch</a> </li> <li> <a href="Phaser.Tween.html">Tween</a> </li> <li> <a href="Phaser.TweenManager.html">TweenManager</a> </li> <li> <a href="Phaser.Utils.html">Utils</a> </li> <li> <a href="Phaser.Utils.Debug.html">Debug</a> </li> <li> <a href="Phaser.World.html">World</a> </li> <li> <a href="SignalBinding.html">SignalBinding</a> </li> </ul> </li> </ul> </div> </div> <div class="row-fluid"> <div class="span8"> <div id="main"> <h1 class="page-title">Class: Tile</h1> <section> <header> <h2> <span class="ancestors"><a href="Phaser.html">Phaser</a>.</span> Tile </h2> <div class="class-description"><p>A Tile is a representation of a single tile within the Tilemap.</p></div> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="Tile"><span class="type-signature"></span>new Tile<span class="signature">(layer, index, x, y, width, height)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Create a new <code>Tile</code> object.</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>layer</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The layer in the Tilemap data that this tile belongs to.</p></td> </tr> <tr> <td class="name"><code>index</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The index of this tile type in the core map data.</p></td> </tr> <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 coordinate of this tile.</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 y coordinate of this tile.</p></td> </tr> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>Width of the tile.</p></td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>Height of the tile.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-20">line 20</a> </li></ul></dd> </dl> </dd> </div> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name" id="alpha"><span class="type-signature"></span>alpha<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>alpha</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The alpha value at which this tile is drawn to the canvas.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-75">line 75</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="bottom"><span class="type-signature"><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>bottom</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The sum of the y and height properties.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-382">line 382</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="canCollide"><span class="type-signature"><readonly> </span>canCollide<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>canCollide</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>True if this tile can collide or has a collision callback.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-317">line 317</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="canCollide"><span class="type-signature"><readonly> </span>canCollide<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>canCollide</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>True if this tile can collide or has a collision callback.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-330">line 330</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="centerX"><span class="type-signature"></span>centerX<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>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The width of the tile in pixels.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-65">line 65</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="centerY"><span class="type-signature"></span>centerY<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 height of the tile in pixels.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-70">line 70</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="collideDown"><span class="type-signature"></span>collideDown<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>collideDown</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Indicating collide with any object on the bottom.</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="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-129">line 129</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="collideLeft"><span class="type-signature"></span>collideLeft<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>collideLeft</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Indicating collide with any object on the left.</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="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-111">line 111</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="collideRight"><span class="type-signature"></span>collideRight<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>collideRight</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Indicating collide with any object on the right.</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="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-117">line 117</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="collideUp"><span class="type-signature"></span>collideUp<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>collideUp</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Indicating collide with any object on the top.</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="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-123">line 123</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="collisionCallback"><span class="type-signature"></span>collisionCallback<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>collisionCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>Tile collision callback.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-135">line 135</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="collisionCallbackContext"><span class="type-signature"></span>collisionCallbackContext<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>collisionCallbackContext</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The context in which the collision callback will be called.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-141">line 141</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="faceBottom"><span class="type-signature"></span>faceBottom<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>faceBottom</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Is the bottom of this tile an interesting edge?</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-95">line 95</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="faceLeft"><span class="type-signature"></span>faceLeft<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>faceLeft</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Is the left of this tile an interesting edge?</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-100">line 100</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="faceRight"><span class="type-signature"></span>faceRight<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>faceRight</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Is the right of this tile an interesting edge?</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-105">line 105</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="faceTop"><span class="type-signature"></span>faceTop<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>faceTop</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Is the top of this tile an interesting edge?</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-90">line 90</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="height"><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 height of the tile in pixels.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-60">line 60</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="index"><span class="type-signature"></span>index<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>index</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The index of this tile within the map data corresponding to the tileset.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-30">line 30</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="layer"><span class="type-signature"></span>layer<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>layer</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The layer in the Tilemap data that this tile belongs to.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-25">line 25</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="left"><span class="type-signature"><readonly> </span>left<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>left</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The x value in pixels.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-343">line 343</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="properties"><span class="type-signature"></span>properties<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>properties</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>Tile specific properties.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-80">line 80</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="right"><span class="type-signature"><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 sum of the x and width properties.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-356">line 356</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="scanned"><span class="type-signature"></span>scanned<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>scanned</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Has this tile been walked / turned into a poly?</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-85">line 85</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="top"><span class="type-signature"><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>top</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The y value.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-369">line 369</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="width"><span class="type-signature"></span>width<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>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The width of the tile in pixels.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-55">line 55</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="worldX"><span class="type-signature"></span>worldX<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 map coordinate of this tile.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-45">line 45</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="worldY"><span class="type-signature"></span>worldY<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 map coordinate of this tile.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-50">line 50</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="x"><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 map coordinate of this tile.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-35">line 35</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="y"><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 map coordinate of this tile.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-40">line 40</a> </li></ul></dd> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="containsPoint"><span class="type-signature"></span>containsPoint<span class="signature">(x, y)</span><span class="type-signature"> → {boolean}</span></h4> </dt> <dd> <div class="description"> <p>Check if the given x and y world coordinates are within this Tile.</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 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 y 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="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-147">line 147</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>True if the coordinates are within this Tile, otherwise false.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> </dd> <dt> <h4 class="name" id="copy"><span class="type-signature"></span>copy<span class="signature">(tile)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Copies the tile data and properties from the given tile to this tile.</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>tile</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Tile.html">Phaser.Tile</a></span> </td> <td class="description last"><p>The tile to copy from.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-291">line 291</a> </li></ul></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>Clean up memory.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-211">line 211</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="intersects"><span class="type-signature"></span>intersects<span class="signature">(x, y, right, bottom)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Check for intersection with this tile.</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 x axis in pixels.</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 y axis in pixels.</p></td> </tr> <tr> <td class="name"><code>right</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The right point.</p></td> </tr> <tr> <td class="name"><code>bottom</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The bottom point.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-161">line 161</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="isInteresting"><span class="type-signature"></span>isInteresting<span class="signature">(collides, faces)</span><span class="type-signature"> → {boolean}</span></h4> </dt> <dd> <div class="description"> <p>Is this tile interesting?</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>collides</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>If true will check any collides value.</p></td> </tr> <tr> <td class="name"><code>faces</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>If true will check any face value.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-261">line 261</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>True if the Tile is interesting, otherwise false.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> </dd> <dt> <h4 class="name" id="resetCollision"><span class="type-signature"></span>resetCollision<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Reset collision status flags.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-242">line 242</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="setCollision"><span class="type-signature"></span>setCollision<span class="signature">(left, right, up, down)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Set collision settings on this tile.</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>left</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Indicating collide with any object on the left.</p></td> </tr> <tr> <td class="name"><code>right</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Indicating collide with any object on the right.</p></td> </tr> <tr> <td class="name"><code>up</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Indicating collide with any object on the top.</p></td> </tr> <tr> <td class="name"><code>down</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Indicating collide with any object on the bottom.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-224">line 224</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="setCollisionCallback"><span class="type-signature"></span>setCollisionCallback<span class="signature">(callback, context)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Set a callback to be called when this tile is hit by an object. The callback must true true for collision processing to take place.</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>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>Callback function.</p></td> </tr> <tr> <td class="name"><code>context</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>Callback will be called within this context.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Tile.js_.html">tilemap/Tile.js</a>, <a href="Tile.js_.html#sunlight-1-line-196">line 196</a> </li></ul></dd> </dl> </dd> </dl> </article> </section> </div> <div class="clearfix"></div> <footer> <span class="copyright"> Phaser Copyright © 2012-2014 Photon Storm Ltd. </span> <br /> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a> on Mon Mar 24 2014 12:38:55 GMT-0000 (GMT) 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/sunlight.javascript.js"></script> <script src="scripts/sunlight-plugin.doclinks.js"></script> <script src="scripts/sunlight-plugin.linenumbers.js"></script> <script src="scripts/sunlight-plugin.menu.js"></script> <script src="scripts/jquery.min.js"></script> <script src="scripts/jquery.scrollTo.js"></script> <script src="scripts/jquery.localScroll.js"></script> <script src="scripts/bootstrap-dropdown.js"></script> <script src="scripts/toc.js"></script> <script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script> <script> $( function () { $( "#toc" ).toc( { anchorName : function(i, heading, prefix) { return $(heading).attr("id") || ( prefix + i ); }, selectors : "h1,h2,h3,h4", showAndHide : false, scrollTo : 60 } ); $( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" ); $( "#main span[id^='toc']" ).addClass( "toc-shim" ); } ); </script> </body> </html>