Phaser Class: Tile

## Phaser. Tile

#### new Tile(layer, index, x, y, width, height)

  A Tile is a representation of a single tile within the Tilemap.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `layer` | object | The layer in the Tilemap data that this tile belongs to.
  `index` | number | The index of this tile type in the core map data.
  `x` | number | The x coordinate of this tile.
  `y` | number | The y coordinate of this tile.
  `width` | number | Width of the tile.
  `height` | number | Height of the tile.

  Source - tilemap/Tile.js, line 19

### Members

#### alpha :number

  The alpha value at which this tile is drawn to the canvas.

  Source - tilemap/Tile.js, line 84

#### <readonly> bottom :number

  The sum of the y and height properties.

  Source - tilemap/Tile.js, line 396

#### <readonly> canCollide :boolean

  True if this tile can collide on any of its faces or has a collision callback set.

  Source - tilemap/Tile.js, line 344

#### centerX

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `width` | number | The width of the tile in pixels.

  Source - tilemap/Tile.js, line 74

#### centerY

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `height` | number | The height of the tile in pixels.

  Source - tilemap/Tile.js, line 79

#### collideDown :boolean

  Indicating collide with any object on the bottom.

  Source - tilemap/Tile.js, line 138

#### collideLeft :boolean

  Indicating collide with any object on the left.

  Source - tilemap/Tile.js, line 120

#### collideRight :boolean

  Indicating collide with any object on the right.

  Source - tilemap/Tile.js, line 126

#### <readonly> collides :boolean

  True if this tile can collide on any of its faces.

  Source - tilemap/Tile.js, line 331

#### collideUp :boolean

  Indicating collide with any object on the top.

  Source - tilemap/Tile.js, line 132

#### collisionCallback :function

  Tile collision callback.

  Source - tilemap/Tile.js, line 144

#### collisionCallbackContext :object

  The context in which the collision callback will be called.

  Source - tilemap/Tile.js, line 150

#### faceBottom :boolean

  Is the bottom of this tile an interesting edge?

  Source - tilemap/Tile.js, line 104

#### faceLeft :boolean

  Is the left of this tile an interesting edge?

  Source - tilemap/Tile.js, line 109

#### faceRight :boolean

  Is the right of this tile an interesting edge?

  Source - tilemap/Tile.js, line 114

#### faceTop :boolean

  Is the top of this tile an interesting edge?

  Source - tilemap/Tile.js, line 99

#### flipped :boolean

  Whether this tile is flipped (mirrored) or not.

  Source - tilemap/Tile.js, line 49

#### height :number

  The height of the tile in pixels.

  Source - tilemap/Tile.js, line 69

#### index :number

  The index of this tile within the map data corresponding to the tileset, or -1 if this represents a blank/null tile.

  Source - tilemap/Tile.js, line 29

#### layer :object

  The layer in the Tilemap data that this tile belongs to.

  Source - tilemap/Tile.js, line 24

#### <readonly> left :number

  The x value in pixels.

  Source - tilemap/Tile.js, line 357

#### properties :object

  Tile specific properties.

  Source - tilemap/Tile.js, line 89

#### <readonly> right :number

  The sum of the x and width properties.

  Source - tilemap/Tile.js, line 370

#### rotation :number

  The rotation angle of this tile.

  Source - tilemap/Tile.js, line 44

#### scanned :boolean

  Has this tile been walked / turned into a poly?

  Source - tilemap/Tile.js, line 94

#### <readonly> top :number

  The y value.

  Source - tilemap/Tile.js, line 383

#### width :number

  The width of the tile in pixels.

  Source - tilemap/Tile.js, line 64

#### worldX

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `x` | number | The x map coordinate of this tile.

  Source - tilemap/Tile.js, line 54

#### worldY

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `y` | number | The y map coordinate of this tile.

  Source - tilemap/Tile.js, line 59

#### x :number

  The x map coordinate of this tile.

  Source - tilemap/Tile.js, line 34

#### y :number

  The y map coordinate of this tile.

  Source - tilemap/Tile.js, line 39

### Methods

#### containsPoint(x, y) → {boolean}

  Check if the given x and y world coordinates are within this Tile.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `x` | number | The x coordinate to test.
  `y` | number | The y coordinate to test.

  ##### Returns:

  boolean -

  True if the coordinates are within this Tile, otherwise false.

  Source - tilemap/Tile.js, line 156

#### copy(tile)

  Copies the tile data and properties from the given tile to this tile.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `tile` | Phaser.Tile | The tile to copy from.

  Source - tilemap/Tile.js, line 305

#### destroy()

  Clean up memory.

  Source - tilemap/Tile.js, line 220

#### intersects(x, y, right, bottom)

  Check for intersection with this tile.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `x` | number | The x axis in pixels.
  `y` | number | The y axis in pixels.
  `right` | number | The right point.
  `bottom` | number | The bottom point.

  Source - tilemap/Tile.js, line 170

#### isInteresting(collides, faces) → {boolean}

  Is this tile interesting?

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `collides` | boolean | If true will check any collides value.
  `faces` | boolean | If true will check any face value.

  ##### Returns:

  boolean -

  True if the Tile is interesting, otherwise false.

  Source - tilemap/Tile.js, line 275

#### resetCollision()

  Reset collision status flags.

  Source - tilemap/Tile.js, line 256

#### setCollision(left, right, up, down)

  Sets the collision flags for each side of this tile and updates the interesting faces list.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `left` | boolean | Indicating collide with any object on the left.
  `right` | boolean | Indicating collide with any object on the right.
  `up` | boolean | Indicating collide with any object on the top.
  `down` | boolean | Indicating collide with any object on the bottom.

  Source - tilemap/Tile.js, line 233

#### setCollisionCallback(callback, context)

  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.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `callback` | function | Callback function.
  `context` | object | Callback will be called within this context.

  Source - tilemap/Tile.js, line 205