Phaser 3 API Documentation

Class: Tile

Phaser .Tilemaps. Tile

A Tile is a representation of a single tile within the Tilemap. This is a lightweight data representation, so its position information is stored without factoring in scroll, layer scale or layer position.

new Tile(layer, index, x, y, width, height, baseWidth, baseHeight)

Parameters:

Name	Type	Description
`layer`	Phaser.Tilemaps.LayerData	The LayerData object in the Tilemap that this tile belongs to.
`index`	number	The unique index of this tile within the map.
`x`	number	The x coordinate of this tile in tile coordinates.
`y`	number	The y coordinate of this tile in tile coordinates.
`width`	number	Width of the tile in pixels.
`height`	number	Height of the tile in pixels.
`baseWidth`	number	The base width a tile in the map (in pixels). Tiled maps support multiple tileset sizes within one map, but they are still placed at intervals of the base tile width.
`baseHeight`	number	The base height of the tile in pixels (in pixels). Tiled maps support multiple tileset sizes within one map, but they are still placed at intervals of the base tile height.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 12)

Extends

Members

alpha :number

The alpha value of the Game Object.

This is a global value, impacting the entire Game Object, not just a region of it.

Type:

number

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Alpha#alpha

Source: src/gameobjects/components/Alpha.js (Line 129)

alphaBottomLeft :number

The alpha value starting from the bottom-left of the Game Object. This value is interpolated from the corner to the center of the Game Object.

Type:

number

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Alpha#alphaBottomLeft

Source: src/gameobjects/components/Alpha.js (Line 227)

alphaBottomRight :number

The alpha value starting from the bottom-right of the Game Object. This value is interpolated from the corner to the center of the Game Object.

Type:

number

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Alpha#alphaBottomRight

Source: src/gameobjects/components/Alpha.js (Line 257)

alphaTopLeft :number

The alpha value starting from the top-left of the Game Object. This value is interpolated from the corner to the center of the Game Object.

Type:

number

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Alpha#alphaTopLeft

Source: src/gameobjects/components/Alpha.js (Line 167)

alphaTopRight :number

The alpha value starting from the top-right of the Game Object. This value is interpolated from the corner to the center of the Game Object.

Type:

number

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Alpha#alphaTopRight

Source: src/gameobjects/components/Alpha.js (Line 197)

baseHeight :number

The maps base height of a tile in pixels. Tiled maps support multiple tileset sizes within one map, but they are still placed at intervals of the base tile size.

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 139)

baseWidth :number

The maps base width of a tile in pixels. Tiled maps support multiple tileset sizes within one map, but they are still placed at intervals of the base tile size.

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 129)

bottom :number

The bottom of the tile in pixels.

Set in the updatePixelXY method.

Type:

number

Since: 3.50.0
Source: src/tilemaps/Tile.js (Line 118)

<readonly> canCollide :boolean

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

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 781)

collideDown :boolean

Whether the tile should collide with any object on the bottom side.

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 218)

collideLeft :boolean

Whether the tile should collide with any object on the left side.

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 191)

collideRight :boolean

Whether the tile should collide with any object on the right side.

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 200)

<readonly> collides :boolean

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

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 798)

collideUp :boolean

Whether the tile should collide with any object on the top side.

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 209)

collisionCallback :function

Tile collision callback.

Type:

function

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 263)

collisionCallbackContext :object

The context in which the collision callback will be called.

Type:

object

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 272)

faceBottom :boolean

Whether the tiles bottom edge is interesting for collisions.

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 254)

faceLeft :boolean

Whether the tiles left edge is interesting for collisions.

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 227)

faceRight :boolean

Whether the tiles right edge is interesting for collisions.

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 236)

faceTop :boolean

Whether the tiles top edge is interesting for collisions.

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 245)

flipX :boolean

The horizontally flipped state of the Game Object.

A Game Object that is flipped horizontally will render inversed on the horizontal axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Type:

boolean

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Flip#flipX

Default Value:

false

Source: src/gameobjects/components/Flip.js (Line 17)

flipY :boolean

The vertically flipped state of the Game Object.

A Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down) Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Type:

boolean

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Flip#flipY

Default Value:

false

Source: src/gameobjects/components/Flip.js (Line 31)

<readonly> hasInterestingFace :boolean

True if this tile has any interesting faces.

Type:

boolean

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 815)

height :number

The height of the tile in pixels.

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 98)

index :number

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

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 61)

layer :Phaser.Tilemaps.LayerData

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

Type:

Phaser.Tilemaps.LayerData

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 52)

physics :object

An empty object where physics-engine specific information (e.g. bodies) may be stored.

Type:

object

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 292)

pixelX :number

The x coordinate of the top left of this tile in pixels. This is relative to the top left of the layer this tile is being rendered within. This property does NOT factor in camera scroll, layer scale or layer position.

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 149)

pixelY :number

The y coordinate of the top left of this tile in pixels. This is relative to the top left of the layer this tile is being rendered within. This property does NOT factor in camera scroll, layer scale or layer position.

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 160)

properties :any

Tile specific properties. These usually come from Tiled.

Type:

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 173)

right :number

The right of the tile in pixels.

Set in the updatePixelXY method.

Type:

number

Since: 3.50.0
Source: src/tilemaps/Tile.js (Line 107)

rotation :number

The rotation angle of this tile.

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 182)

<readonly, nullable> tilemap :Phaser.Tilemaps.Tilemap

The tilemap that contains this Tile. This will only return null if accessed from a LayerData instance before the tile is placed within a TilemapLayer.

Type:

Phaser.Tilemaps.Tilemap

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 881)

<readonly, nullable> tilemapLayer :Phaser.Tilemaps.TilemapLayer

The tilemap layer that contains this Tile. This will only return null if accessed from a LayerData instance before the tile is placed within a TilemapLayer.

Type:

Phaser.Tilemaps.TilemapLayer

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 863)

<readonly, nullable> tileset :Phaser.Tilemaps.Tileset

The tileset that contains this Tile. This is null if accessed from a LayerData instance before the tile is placed in a TilemapLayer, or if the tile has an index that doesn't correspond to any of the maps tilesets.

Type:

Phaser.Tilemaps.Tileset

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 832)

tint :number

The tint to apply to this tile. Note: tint is currently a single color value instead of the 4 corner tint component on other GameObjects.

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 281)

visible :boolean

The visible state of the Game Object.

An invisible Game Object will skip rendering, but will still process update logic.

Type:

boolean

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Visible#visible

Source: src/gameobjects/components/Visible.js (Line 31)

width :number

The width of the tile in pixels.

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 89)

x :number

The x map coordinate of this tile in tile units.

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 71)

y :number

The y map coordinate of this tile in tile units.

Type:

number

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 80)

Methods

clearAlpha()

Clears all alpha values associated with this Game Object.

Immediately sets the alpha levels back to 1 (fully opaque).

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Alpha#clearAlpha

Source: src/gameobjects/components/Alpha.js (Line 77)

Returns:

This Game Object instance.

Type: Phaser.Tilemaps.Tile

containsPoint(x, y)

Check if the given x and y world coordinates are within this Tile. This does not factor in camera scroll, layer scale or layer position.

Parameters:

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

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 302)

Returns:

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

Type: boolean

copy(tile)

Copies the tile data & properties from the given tile to this tile. This copies everything except for position and interesting faces.

Parameters:

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

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 319)

Returns:

This Tile object instance.

Type: Phaser.Tilemaps.Tile

destroy()

Clean up memory.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 768)

getBottom( [camera])

Gets the world Y position of the bottom side of the tile, factoring in the layer's position, scale and scroll.

Parameters:

Name	Type	Argument	Description
`camera`	Phaser.Cameras.Scene2D.Camera	<optional>	The Camera to use to perform the check.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 439)

Returns:

The bottom (y) value of this tile.

Type: number

getBounds( [camera] [, output])

Gets the world rectangle bounding box for the tile, factoring in the layers position, scale and scroll.

Parameters:

Name	Type	Argument	Description
`camera`	Phaser.Cameras.Scene2D.Camera	<optional>	The Camera to use to perform the check.
`output`	Phaser.Geom.Rectangle	<optional>	Optional Rectangle object to store the results in.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 460)

Returns:

The bounds of this Tile.

Type: Phaser.Geom.Rectangle | object

getCenterX( [camera])

Gets the world X position of the center of the tile, factoring in the layer's position, scale and scroll.

Parameters:

Name	Type	Argument	Description
`camera`	Phaser.Cameras.Scene2D.Camera	<optional>	The Camera to use to perform the check.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 484)

Returns:

The center x position of this Tile.

Type: number

getCenterY( [camera])

Gets the world Y position of the center of the tile, factoring in the layer's position, scale and scroll.

Parameters:

Name	Type	Argument	Description
`camera`	Phaser.Cameras.Scene2D.Camera	<optional>	The Camera to use to perform the check.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 500)

Returns:

The center y position of this Tile.

Type: number

getCollisionGroup()

The collision group for this Tile, defined within the Tileset. This returns a reference to the collision group stored within the Tileset, so any modification of the returned object will impact all tiles that have the same index as this tile.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 349)

Returns:

The collision group for this Tile, as defined in the Tileset, or null if no group was defined.

Type: object

getLeft( [camera])

Gets the world X position of the left side of the tile, factoring in the layers position, scale and scroll.

Parameters:

Name	Type	Argument	Description
`camera`	Phaser.Cameras.Scene2D.Camera	<optional>	The Camera to use to perform the check.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 380)

Returns:

The left (x) value of this tile.

Type: number

getRight( [camera])

Gets the world X position of the right side of the tile, factoring in the layer's position, scale and scroll.

Parameters:

Name	Type	Argument	Description
`camera`	Phaser.Cameras.Scene2D.Camera	<optional>	The Camera to use to perform the check.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 398)

Returns:

The right (x) value of this tile.

Type: number

getTileData()

The tile data for this Tile, defined within the Tileset. This typically contains Tiled collision data, tile animations and terrain information. This returns a reference to the tile data stored within the Tileset, so any modification of the returned object will impact all tiles that have the same index as this tile.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 364)

Returns:

The tile data for this Tile, as defined in the Tileset, or null if no data was defined.

Type: object

getTop( [camera])

Gets the world Y position of the top side of the tile, factoring in the layer's position, scale and scroll.

Parameters:

Name	Type	Argument	Description
`camera`	Phaser.Cameras.Scene2D.Camera	<optional>	The Camera to use to perform the check.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 416)

Returns:

The top (y) value of this tile.

Type: number

intersects(x, y, right, bottom)

Check for intersection with this tile. This does not factor in camera scroll, layer scale or layer position.

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.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 516)

Returns:

true if the Tile intersects with the given dimensions, otherwise false.

Type: boolean

isInteresting(collides, faces)

Checks if the tile is interesting.

Parameters:

Name	Type	Description
`collides`	boolean	If true, will consider the tile interesting if it collides on any side.
`faces`	boolean	If true, will consider the tile interesting if it has an interesting face.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 538)

Returns:

True if the Tile is interesting, otherwise false.

Type: boolean

resetCollision( [recalculateFaces])

Reset collision status flags.

Parameters:

Name	Type	Argument	Default	Description
`recalculateFaces`	boolean	<optional>	true	Whether or not to recalculate interesting faces for this tile and its neighbors.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 567)

Returns:

This Tile object instance.

Type: Phaser.Tilemaps.Tile

resetFaces()

Reset faces.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 604)

Returns:

This Tile object instance.

Type: Phaser.Tilemaps.Tile

resetFlip()

Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Flip#resetFlip

Source: src/gameobjects/components/Flip.js (Line 140)

Returns:

This Game Object instance.

Type: Phaser.Tilemaps.Tile

setAlpha( [topLeft] [, topRight] [, bottomLeft] [, bottomRight])

Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders. Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.

If your game is running under WebGL you can optionally specify four different alpha values, each of which correspond to the four corners of the Game Object. Under Canvas only the topLeft value given is used.

Parameters:

Name	Type	Argument	Default	Description
`topLeft`	number	<optional>	1	The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object.
`topRight`	number	<optional>		The alpha value used for the top-right of the Game Object. WebGL only.
`bottomLeft`	number	<optional>		The alpha value used for the bottom-left of the Game Object. WebGL only.
`bottomRight`	number	<optional>		The alpha value used for the bottom-right of the Game Object. WebGL only.

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Alpha#setAlpha

Source: src/gameobjects/components/Alpha.js (Line 92)

Returns:

This Game Object instance.

Type: Phaser.Tilemaps.Tile

setCollision(left [, right] [, up] [, down] [, recalculateFaces])

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

Parameters:

Name	Type	Argument	Default	Description
`left`	boolean			Indicating collide with any object on the left.
`right`	boolean	<optional>		Indicating collide with any object on the right.
`up`	boolean	<optional>		Indicating collide with any object on the top.
`down`	boolean	<optional>		Indicating collide with any object on the bottom.
`recalculateFaces`	boolean	<optional>	true	Whether or not to recalculate interesting faces for this tile and its neighbors.

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 622)

Returns:

This Tile object instance.

Type: Phaser.Tilemaps.Tile

setCollisionCallback(callback, context)

Set a callback to be called when this tile is hit by an object. The callback must true for collision processing to take place.

Parameters:

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

Since: 3.0.0
Source: src/tilemaps/Tile.js (Line 666)

Returns:

This Tile object instance.

Type: Phaser.Tilemaps.Tile

setFlip(x, y)

Sets the horizontal and vertical flipped state of this Game Object.

A Game Object that is flipped will render inversed on the flipped axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Parameters:

Name	Type	Description
`x`	boolean	The horizontal flipped state. `false` for no flip, or `true` to be flipped.
`y`	boolean	The horizontal flipped state. `false` for no flip, or `true` to be flipped.

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Flip#setFlip

Source: src/gameobjects/components/Flip.js (Line 117)

Returns:

This Game Object instance.

Type: Phaser.Tilemaps.Tile

setFlipX(value)

Sets the horizontal flipped state of this Game Object.

Parameters:

Name	Type	Description
`value`	boolean	The flipped state. `false` for no flip, or `true` to be flipped.

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Flip#setFlipX

Source: src/gameobjects/components/Flip.js (Line 79)

Returns:

This Game Object instance.

Type: Phaser.Tilemaps.Tile

setFlipY(value)

Sets the vertical flipped state of this Game Object.

Parameters:

Name	Type	Description
`value`	boolean	The flipped state. `false` for no flip, or `true` to be flipped.

Since: 3.0.0

Inherited From:

Phaser.GameObjects.Components.Flip#setFlipY

Source: src/gameobjects/components/Flip.js (Line 100)

Returns:

This Game Object instance.

Type: Phaser.Tilemaps.Tile

setSize(tileWidth, tileHeight, baseWidth, baseHeight)

Sets the size of the tile and updates its pixelX and pixelY.

Parameters:

Name	Type	Description
`tileWidth`	number	The width of the tile in pixels.
`tileHeight`	number	The height of the tile in pixels.
`baseWidth`	number	The base width a tile in the map (in pixels).
`baseHeight`	number	The base height of the tile in pixels (in pixels).