Filter
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.
Constructor:
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. |
Extends
- Phaser.GameObjects.Components.AlphaSingle
- Phaser.GameObjects.Components.Flip
- Phaser.GameObjects.Components.Visible
Members
Description:
The alpha value of the Game Object.
This is a global value, impacting the entire Game Object, not just a region of it.
Type:
Description:
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:
Description:
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:
Description:
The bottom of the tile in pixels.
Set in the updatePixelXY method.
Type:
Description:
True if this tile can collide on any of its faces or has a collision callback set.
Type:
Description:
Whether the tile should collide with any object on the bottom side.
This property is used by Arcade Physics only, however, you can also use it in your own checks.
Type:
Description:
Whether the tile should collide with any object on the left side.
This property is used by Arcade Physics only, however, you can also use it in your own checks.
Type:
Description:
Whether the tile should collide with any object on the right side.
This property is used by Arcade Physics only, however, you can also use it in your own checks.
Type:
Description:
Whether the tile should collide with any object on the top side.
This property is used by Arcade Physics only, however, you can also use it in your own checks.
Type:
Description:
True if this tile can collide on any of its faces.
Type:
Description:
Tile collision callback.
Type:
Description:
The context in which the collision callback will be called.
Type:
Description:
Whether the tiles bottom edge is interesting for collisions.
Type:
Description:
Whether the tiles left edge is interesting for collisions.
Type:
Description:
Whether the tiles right edge is interesting for collisions.
Type:
Description:
Whether the tiles top edge is interesting for collisions.
Type:
Description:
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:
Description:
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:
Description:
True if this tile has any interesting faces.
Type:
Description:
The height of the tile in pixels.
Type:
Description:
The index of this tile within the map data corresponding to the tileset, or -1 if this represents a blank tile.
Type:
Description:
The LayerData in the Tilemap data that this tile belongs to.
Description:
An empty object where physics-engine specific information (e.g. bodies) may be stored.
Type:
Description:
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:
Description:
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:
Description:
Tile specific properties. These usually come from Tiled.
Type:
Description:
The right of the tile in pixels.
Set in the updatePixelXY method.
Type:
Description:
The rotation angle of this tile.
Type:
Description:
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:
Description:
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.
Description:
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:
Description:
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:
Description:
The tint fill mode.
false = An additive tint (the default), where vertices colors are blended with the texture.
true = A fill tint, where the vertices colors replace the texture, but respects texture alpha.
Type:
Description:
The visible state of the Game Object.
An invisible Game Object will skip rendering, but will still process update logic.
Type:
Description:
The width of the tile in pixels.
Type:
Description:
The x map coordinate of this tile in tile units.
Type:
Description:
The y map coordinate of this tile in tile units.
Type:
Methods
Description:
Clears all alpha values associated with this Game Object.
Immediately sets the alpha levels back to 1 (fully opaque).
Returns:
Description:
This Game Object instance.
Type:
Description:
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. |
Returns:
Description:
True if the coordinates are within this Tile, otherwise false.
Type:
- boolean
Description:
Copies the tile data and properties from the given Tile to this Tile. This copies everything except for position and interesting face calculations.
Parameters:
| name | type | description |
|---|---|---|
| tile | Phaser.Tilemaps.Tile |
The tile to copy from. |
Returns:
Description:
This Tile object instance.
Type:
Description:
Gets the world Y position of the bottom side of the tile, factoring in the layer's position, scale and scroll.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera | <optional> |
The Camera to use to perform the check. |
Returns:
Description:
The bottom (y) value of this tile.
Type:
- number
Description:
Gets the world rectangle bounding box for the tile, factoring in the layers position, scale and scroll.
Parameters:
| name | type | arguments | 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. |
Returns:
Description:
The bounds of this Tile.
Type:
- Phaser.Geom.Rectangle
- object
Description:
Gets the world X position of the center of the tile, factoring in the layer's position, scale and scroll.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera | <optional> |
The Camera to use to perform the check. |
Returns:
Description:
The center x position of this Tile.
Type:
- number
Description:
Gets the world Y position of the center of the tile, factoring in the layer's position, scale and scroll.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera | <optional> |
The Camera to use to perform the check. |
Returns:
Description:
The center y position of this Tile.
Type:
- number
Description:
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.
Returns:
Description:
The collision group for this Tile, as defined in the Tileset, or null if no group was defined.
Type:
- object
Description:
Gets the world X position of the left side of the tile, factoring in the layers position, scale and scroll.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera | <optional> |
The Camera to use to perform the check. |
Returns:
Description:
The left (x) value of this tile.
Type:
- number
Description:
Gets the world X position of the right side of the tile, factoring in the layer's position, scale and scroll.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera | <optional> |
The Camera to use to perform the check. |
Returns:
Description:
The right (x) value of this tile.
Type:
- number
Description:
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.
Returns:
Description:
The tile data for this Tile, as defined in the Tileset, or null if no data was defined.
Type:
- object
Description:
Gets the world Y position of the top side of the tile, factoring in the layer's position, scale and scroll.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera | <optional> |
The Camera to use to perform the check. |
Returns:
Description:
The top (y) value of this tile.
Type:
- number
Description:
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. |
Returns:
Description:
true if the Tile intersects with the given dimensions, otherwise false.
Type:
- boolean
Description:
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. |
Returns:
Description:
True if the Tile is interesting, otherwise false.
Type:
- boolean
Description:
Reset collision status flags.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| recalculateFaces | boolean | <optional> | true |
Whether or not to recalculate interesting faces for this tile and its neighbors. |
Returns:
Description:
This Tile object instance.
Type:
Description:
Reset faces.
Returns:
Description:
This Tile object instance.
Type:
Description:
Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.
Returns:
Description:
This Game Object instance.
Type:
Description:
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.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| value | number | <optional> | 1 |
The alpha value applied across the whole Game Object. |
Returns:
Description:
This Game Object instance.
Type:
Description:
Sets the collision flags for each side of this tile and updates the interesting faces list.
Parameters:
| name | type | arguments | 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. |
Returns:
Description:
This Tile object instance.
Type:
Description:
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. |
Returns:
Description:
This Tile object instance.
Type:
Description:
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. |
| y | boolean |
The horizontal flipped state. |
Returns:
Description:
This Game Object instance.
Type:
Description:
Sets the horizontal flipped state of this 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.
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
The flipped state. |
Returns:
Description:
This Game Object instance.
Type:
Description:
Sets the vertical flipped state of this Game Object.
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
The flipped state. |
Returns:
Description:
This Game Object instance.
Type:
Description:
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). |
Returns:
Description:
This Tile object instance.
Type:
Description:
Sets the visibility of this Game Object.
An invisible Game Object will skip rendering, but will still process update logic.
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
The visible state of the Game Object. |
Returns:
Description:
This Game Object instance.
Type:
Description:
Toggles the horizontal flipped state of this 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.
Returns:
Description:
This Game Object instance.
Type:
Description:
Toggles the vertical flipped state of this Game Object.
Returns:
Description:
This Game Object instance.
Type:
Description:
Used internally. Updates the tiles world XY position based on the current tile size.
Returns:
Description:
This Tile object instance.
Type: