Creates a new Phaser.Tilemap object. The map can either be populated with data from a Tiled JSON file or from a CSV file.
Tiled is a free software package specifically for creating tile maps, and is available from http://www.mapeditor.org
To do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key.
When using CSV data you must provide the key and the tileWidth and tileHeight parameters.
If creating a blank tilemap to be populated later, you can either specify no parameters at all and then use Tilemap.create or pass the map and tile dimensions here.
Note that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.
A Tile map is rendered to the display using a TilemapLayer. It is not added to the display list directly itself.
A map may have multiple layers. You can perform operations on the map data such as copying, pasting, filling and shuffling the tiles around.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
game | Phaser.Game | Game reference to the currently running game. | ||
key | string | <optional> | The key of the tilemap data as stored in the Cache. If you're creating a blank map either leave this parameter out or pass | |
tileWidth | number | <optional> | 32 | The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. |
tileHeight | number | <optional> | 32 | The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data. |
width | number | <optional> | 10 | The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this. |
height | number | <optional> | 10 | The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this. |
An array of tile indexes that collide.
An array of collision data (polylines, etc).
The current layer.
Map data used for debug values only.
If set then console.log is used to dump out useful layer creation debug data.
The format of the map data, either Phaser.Tilemap.CSV or Phaser.Tilemap.TILED_JSON.
A reference to the currently running Game.
The height of the map (in tiles).
The height of the map in pixels based on height * tileHeight.
An array of Image Collections.
An array of Tiled Image Layers.
The key of this map data in the Phaser.Cache.
The current layer object.
An array of Tilemap layer data.
An array of Tiled Object Layers.
The orientation of the map data (as specified in Tiled), usually 'orthogonal'.
Map specific properties as specified in Tiled.
The base height of the tiles in the map (in pixels).
The super array of Tiles.
An array of Tilesets.
The base width of the tiles in the map (in pixels).
The version of the map data (as specified in Tiled, usually 1).
The width of the map (in tiles).
The width of the map in pixels based on width * tileWidth.
Adds an image to the map to be used as a tileset. A single map may use multiple tilesets.
Note that the tileset name can be found in the JSON file exported from Tiled, or in the Tiled editor.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
tileset | string | The name of the tileset as specified in the map data. | ||
key | string | Phaser.BitmapData | <optional> | The key of the Phaser.Cache image used for this tileset. | |
tileWidth | number | <optional> | 32 | The width of the tiles in the Tileset Image. If not given it will default to the map.tileWidth value, if that isn't set then 32. |
tileHeight | number | <optional> | 32 | The height of the tiles in the Tileset Image. If not given it will default to the map.tileHeight value, if that isn't set then 32. |
tileMargin | number | <optional> | 0 | The width of the tiles in the Tileset Image. |
tileSpacing | number | <optional> | 0 | The height of the tiles in the Tileset Image. |
gid | number | <optional> | 0 | If adding multiple tilesets to a blank/dynamic map, specify the starting GID the set will use here. |
Returns the Tileset object that was created or updated, or null if it failed.
Internal function.
| Name | Type | Description |
|---|---|---|
layer | number | The index of the TilemapLayer to operate on. |
Copies all of the tiles in the given rectangular block into the tilemap data buffer.
| Name | Type | Argument | Description |
|---|---|---|---|
x | integer | X position of the top left of the area to copy (given in tiles, not pixels) | |
y | integer | Y position of the top left of the area to copy (given in tiles, not pixels) | |
width | integer | The width of the area to copy (given in tiles, not pixels) | |
height | integer | The height of the area to copy (given in tiles, not pixels) | |
layer | integer | string | Phaser.TilemapLayer | <optional> | The layer to copy the tiles from. |
An array of the tiles that were copied.
Creates an empty map of the given dimensions and one blank layer. If layers already exist they are erased.
| Name | Type | Argument | Description |
|---|---|---|---|
name | string | The name of the default layer of the map. | |
width | number | The width of the map in tiles. | |
height | number | The height of the map in tiles. | |
tileWidth | number | The width of the tiles the map uses for calculations. | |
tileHeight | number | The height of the tiles the map uses for calculations. | |
group | Phaser.Group | <optional> | Optional Group to add the layer to. If not specified it will be added to the World group. |
The TilemapLayer object. This is an extension of Phaser.Image and can be moved around the display list accordingly.
Creates a new and empty layer on this Tilemap. By default TilemapLayers are fixed to the camera.
| Name | Type | Argument | Description |
|---|---|---|---|
name | string | The name of this layer. Must be unique within the map. | |
width | number | The width of the layer in tiles. | |
height | number | The height of the layer in tiles. | |
tileWidth | number | The width of the tiles the layer uses for calculations. | |
tileHeight | number | The height of the tiles the layer uses for calculations. | |
group | Phaser.Group | <optional> | Optional Group to add the layer to. If not specified it will be added to the World group. |
The TilemapLayer object. This is an extension of Phaser.Image and can be moved around the display list accordingly.
Creates a Sprite for every object matching the given gid in the map data. You can optionally specify the group that the Sprite will be created in. If none is
given it will be created in the World. All properties from the map data objectgroup are copied across to the Sprite, so you can use this as an easy way to
configure Sprite properties from within the map editor. For example giving an object a property of alpha: 0.5 in the map editor will duplicate that when the
Sprite is created. You could also give it a value like: body.velocity.x: 100 to set it moving automatically.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
name | string | The name of the Object Group to create Sprites from. | ||
gid | number | The layer array index value, or if a string is given the layer name within the map data. | ||
key | string | The Game.cache key of the image that this Sprite will use. | ||
frame | number | string | <optional> | If the Sprite image contains multiple frames you can specify which one to use here. | |
exists | boolean | <optional> | true | The default exists state of the Sprite. |
autoCull | boolean | <optional> | false | The default autoCull state of the Sprite. Sprites that are autoCulled are culled from the camera if out of its range. |
group | Phaser.Group | <optional> | Phaser.World | Group to add the Sprite to. If not specified it will be added to the World group. |
CustomClass | object | <optional> | Phaser.Sprite | If you wish to create your own class, rather than Phaser.Sprite, pass the class here. Your class must extend Phaser.Sprite and have the same constructor parameters. |
adjustY | boolean | <optional> | true | By default the Tiled map editor uses a bottom-left coordinate system. Phaser uses top-left. So most objects will appear too low down. This parameter moves them up by their height. |
Creates a Sprite for every object matching the given tile indexes in the map data.
You can specify the group that the Sprite will be created in. If none is given it will be created in the World.
You can optional specify if the tile will be replaced with another after the Sprite is created. This is useful if you want to lay down special
tiles in a level that are converted to Sprites, but want to replace the tile itself with a floor tile or similar once converted.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
tiles | integer | Array | The tile index, or array of indexes, to create Sprites from. | ||
replacements | integer | Array | The tile index, or array of indexes, to change a converted tile to. Set to | ||
key | string | The Game.cache key of the image that this Sprite will use. | ||
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. | |
group | Phaser.Group | <optional> | Phaser.World | Group to add the Sprite to. If not specified it will be added to the World group. |
properties | object | <optional> | An object that contains the default properties for your newly created Sprite. This object will be iterated and any matching Sprite property will be set. |
The number of Sprites that were created.
Creates a new TilemapLayer object. By default TilemapLayers are fixed to the camera.
The layer parameter is important. If you've created your map in Tiled then you can get this by looking in Tiled and looking at the Layer name.
Or you can open the JSON file it exports and look at the layers[].name value. Either way it must match.
If you wish to create a blank layer to put your own tiles on then see Tilemap.createBlankLayer.
| Name | Type | Argument | Description |
|---|---|---|---|
layer | number | string | The layer array index value, or if a string is given the layer name, within the map data that this TilemapLayer represents. | |
width | number | <optional> | The rendered width of the layer, should never be wider than Game.width. If not given it will be set to Game.width. |
height | number | <optional> | The rendered height of the layer, should never be wider than Game.height. If not given it will be set to Game.height. |
group | Phaser.Group | <optional> | Optional Group to add the object to. If not specified it will be added to the World group. |
The TilemapLayer object. This is an extension of Phaser.Sprite and can be moved around the display list accordingly.
Removes all layer data from this tile map and nulls the game reference.
Note: You are responsible for destroying any TilemapLayer objects you generated yourself, as Tilemap doesn't keep a reference to them.
Dumps the tilemap data out to the console.
Fills the given area with the specified tile.
| Name | Type | Argument | Description |
|---|---|---|---|
index | number | The index of the tile that the area will be filled with. | |
x | number | X position of the top left of the area to operate one, given in tiles, not pixels. | |
y | number | Y position of the top left of the area to operate one, given in tiles, not pixels. | |
width | number | The width in tiles of the area to operate on. | |
height | number | The height in tiles of the area to operate on. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. |
For each tile in the given area defined by x/y and width/height run the given callback.
| Name | Type | Argument | Description |
|---|---|---|---|
callback | number | The callback. Each tile in the given area will be passed to this callback as the first and only parameter. | |
context | number | The context under which the callback should be run. | |
x | number | X position of the top left of the area to operate one, given in tiles, not pixels. | |
y | number | Y position of the top left of the area to operate one, given in tiles, not pixels. | |
width | number | The width in tiles of the area to operate on. | |
height | number | The height in tiles of the area to operate on. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. |
Gets the image index based on its name.
| Name | Type | Description |
|---|---|---|
name | string | The name of the image to get. |
The index of the image in this tilemap, or null if not found.
Gets the layer index based on the layers name.
| Name | Type | Description |
|---|---|---|
location | array | The local array to search. |
name | string | The name of the array element to get. |
The index of the element in the array, or null if not found.
Gets the TilemapLayer index as used in the setCollision calls.
| Name | Type | Description |
|---|---|---|
layer | number | string | Phaser.TilemapLayer | The layer to operate on. If not given will default to this.currentLayer. |
The TilemapLayer index.
Gets the layer index based on its name.
| Name | Type | Description |
|---|---|---|
name | string | The name of the layer to get. |
The index of the layer in this tilemap, or null if not found.
Gets a tile from the Tilemap Layer. The coordinates are given in tile values.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
x | number | X position to get the tile from (given in tile units, not pixels) | ||
y | number | Y position to get the tile from (given in tile units, not pixels) | ||
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to get the tile from. | |
nonNull | boolean | <optional> | false | If true getTile won't return null for empty tiles, but a Tile object with an index of -1. |
The tile at the given coordinates or null if no tile was found or the coordinates were invalid.
Gets the tile above the tile coordinates given.
Mostly used as an internal function by calculateFaces.
| Name | Type | Description |
|---|---|---|
layer | number | The local layer index to get the tile from. Can be determined by Tilemap.getLayer(). |
x | number | The x coordinate to get the tile from. In tiles, not pixels. |
y | number | The y coordinate to get the tile from. In tiles, not pixels. |
Gets the tile below the tile coordinates given.
Mostly used as an internal function by calculateFaces.
| Name | Type | Description |
|---|---|---|
layer | number | The local layer index to get the tile from. Can be determined by Tilemap.getLayer(). |
x | number | The x coordinate to get the tile from. In tiles, not pixels. |
y | number | The y coordinate to get the tile from. In tiles, not pixels. |
Gets the tile to the left of the tile coordinates given.
Mostly used as an internal function by calculateFaces.
| Name | Type | Description |
|---|---|---|
layer | number | The local layer index to get the tile from. Can be determined by Tilemap.getLayer(). |
x | number | The x coordinate to get the tile from. In tiles, not pixels. |
y | number | The y coordinate to get the tile from. In tiles, not pixels. |
Gets the tile to the right of the tile coordinates given.
Mostly used as an internal function by calculateFaces.
| Name | Type | Description |
|---|---|---|
layer | number | The local layer index to get the tile from. Can be determined by Tilemap.getLayer(). |
x | number | The x coordinate to get the tile from. In tiles, not pixels. |
y | number | The y coordinate to get the tile from. In tiles, not pixels. |
Gets the tileset index based on its name.
| Name | Type | Description |
|---|---|---|
name | string | The name of the tileset to get. |
The index of the tileset in this tilemap, or null if not found.
Gets a tile from the Tilemap layer. The coordinates are given in pixel values.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
x | number | X position to get the tile from (given in pixels) | ||
y | number | Y position to get the tile from (given in pixels) | ||
tileWidth | number | <optional> | The width of the tiles. If not given the map default is used. | |
tileHeight | number | <optional> | The height of the tiles. If not given the map default is used. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to get the tile from. | |
nonNull | boolean | <optional> | false | If true getTile won't return null for empty tiles, but a Tile object with an index of -1. |
The tile at the given coordinates.
Checks if there is a tile at the given location.
| Name | Type | Description |
|---|---|---|
x | number | X position to check if a tile exists at (given in tile units, not pixels) |
y | number | Y position to check if a tile exists at (given in tile units, not pixels) |
layer | number | string | Phaser.TilemapLayer | The layer to set as current. |
True if there is a tile at the given location, otherwise false.
Pastes a previously copied block of tile data into the given x/y coordinates. Data should have been prepared with Tilemap.copy.
| Name | Type | Argument | Description |
|---|---|---|---|
x | number | X position of the top left of the area to paste to (given in tiles, not pixels) | |
y | number | Y position of the top left of the area to paste to (given in tiles, not pixels) | |
tileblock | array | The block of tiles to paste. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to paste the tiles into. |
Puts a tile of the given index value at the coordinate specified.
If you pass null as the tile it will pass your call over to Tilemap.removeTile instead.
| Name | Type | Argument | Description |
|---|---|---|---|
tile | Phaser.Tile | number | null | The index of this tile to set or a Phaser.Tile object. If null the tile is removed from the map. | |
x | number | X position to place the tile (given in tile units, not pixels) | |
y | number | Y position to place the tile (given in tile units, not pixels) | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to modify. |
The Tile object that was created or added to this map.
Puts a tile into the Tilemap layer. The coordinates are given in pixel values.
| Name | Type | Argument | Description |
|---|---|---|---|
tile | Phaser.Tile | number | The index of this tile to set or a Phaser.Tile object. | |
x | number | X position to insert the tile (given in pixels) | |
y | number | Y position to insert the tile (given in pixels) | |
tileWidth | number | The width of the tile in pixels. | |
tileHeight | number | The height of the tile in pixels. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to modify. |
The Tile object that was created or added to this map.
Randomises a set of tiles in a given area.
| Name | Type | Argument | Description |
|---|---|---|---|
x | number | X position of the top left of the area to operate one, given in tiles, not pixels. | |
y | number | Y position of the top left of the area to operate one, given in tiles, not pixels. | |
width | number | The width in tiles of the area to operate on. | |
height | number | The height in tiles of the area to operate on. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. |
Removes all layers from this tile map.
Removes the tile located at the given coordinates and updates the collision data.
| Name | Type | Argument | Description |
|---|---|---|---|
x | number | X position to place the tile (given in tile units, not pixels) | |
y | number | Y position to place the tile (given in tile units, not pixels) | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to modify. |
The Tile object that was removed from this map.
Removes the tile located at the given coordinates and updates the collision data. The coordinates are given in pixel values.
| Name | Type | Argument | Description |
|---|---|---|---|
x | number | X position to insert the tile (given in pixels) | |
y | number | Y position to insert the tile (given in pixels) | |
tileWidth | number | The width of the tile in pixels. | |
tileHeight | number | The height of the tile in pixels. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to modify. |
The Tile object that was removed from this map.
Scans the given area for tiles with an index matching source and updates their index to match dest.
| Name | Type | Argument | Description |
|---|---|---|---|
source | number | The tile index value to scan for. | |
dest | number | The tile index value to replace found tiles with. | |
x | number | X position of the top left of the area to operate one, given in tiles, not pixels. | |
y | number | Y position of the top left of the area to operate one, given in tiles, not pixels. | |
width | number | The width in tiles of the area to operate on. | |
height | number | The height in tiles of the area to operate on. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. |
Searches the entire map layer for the first tile matching the given index, then returns that Phaser.Tile object.
If no match is found it returns null.
The search starts from the top-left tile and continues horizontally until it hits the end of the row, then it drops down to the next column.
If the reverse boolean is true, it scans starting from the bottom-right corner traveling up to the top-left.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
index | number | The tile index value to search for. | ||
skip | number | <optional> | 0 | The number of times to skip a matching tile before returning. |
reverse | number | <optional> | false | If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left. |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to get the tile from. |
The first (or n skipped) tile with the matching index.
Sets collision the given tile or tiles. You can pass in either a single numeric index or an array of indexes: [ 2, 3, 15, 20].
The collides parameter controls if collision will be enabled (true) or disabled (false).
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
indexes | number | array | Either a single tile index, or an array of tile IDs to be checked for collision. | ||
collides | boolean | <optional> | true | If true it will enable collision. If false it will clear collision. |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. If not given will default to this.currentLayer. | |
recalculate | boolean | <optional> | true | Recalculates the tile faces after the update. |
Sets collision on a range of tiles where the tile IDs increment sequentially.
Calling this with a start value of 10 and a stop value of 14 would set collision for tiles 10, 11, 12, 13 and 14.
The collides parameter controls if collision will be enabled (true) or disabled (false).
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
start | number | The first index of the tile to be set for collision. | ||
stop | number | The last index of the tile to be set for collision. | ||
collides | boolean | <optional> | true | If true it will enable collision. If false it will clear collision. |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. If not given will default to this.currentLayer. | |
recalculate | boolean | <optional> | true | Recalculates the tile faces after the update. |
Sets collision on all tiles in the given layer, except for the IDs of those in the given array.
The collides parameter controls if collision will be enabled (true) or disabled (false).
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
indexes | array | An array of the tile IDs to not be counted for collision. | ||
collides | boolean | <optional> | true | If true it will enable collision. If false it will clear collision. |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. If not given will default to this.currentLayer. | |
recalculate | boolean | <optional> | true | Recalculates the tile faces after the update. |
Sets collision values on a tile in the set.
You shouldn't usually call this method directly, instead use setCollision, setCollisionBetween or setCollisionByExclusion.
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
index | number | The index of the tile on the layer. | ||
collides | boolean | <optional> | true | If true it will enable collision on the tile. If false it will clear collision values from the tile. |
layer | number | <optional> | The layer to operate on. If not given will default to this.currentLayer. | |
recalculate | boolean | <optional> | true | Recalculates the tile faces after the update. |
Sets the current layer to the given index.
| Name | Type | Description |
|---|---|---|
layer | number | string | Phaser.TilemapLayer | The layer to set as current. |
Turn off/on the recalculation of faces for tile or collision updates.setPreventRecalculate(true) puts recalculation on hold while setPreventRecalculate(false) recalculates all the changed layers.
| Name | Type | Description |
|---|---|---|
value | boolean | If true it will put the recalculation on hold. |
Sets a global collision callback for the given tile index within the layer. This will affect all tiles on this layer that have the same index.
If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it.
If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.
| Name | Type | Argument | Description |
|---|---|---|---|
indexes | number | array | Either a single tile index, or an array of tile indexes to have a collision callback set for. | |
callback | function | The callback that will be invoked when the tile is collided with. | |
callbackContext | object | The context under which the callback is called. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. If not given will default to this.currentLayer. |
Sets a global collision callback for the given map location within the layer. This will affect all tiles on this layer found in the given area.
If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it.
If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.
| Name | Type | Argument | Description |
|---|---|---|---|
x | number | X position of the top left of the area to copy (given in tiles, not pixels) | |
y | number | Y position of the top left of the area to copy (given in tiles, not pixels) | |
width | number | The width of the area to copy (given in tiles, not pixels) | |
height | number | The height of the area to copy (given in tiles, not pixels) | |
callback | function | The callback that will be invoked when the tile is collided with. | |
callbackContext | object | The context under which the callback is called. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. If not given will default to this.currentLayer. |
Sets the base tile size for the map.
| Name | Type | Description |
|---|---|---|
tileWidth | number | The width of the tiles the map uses for calculations. |
tileHeight | number | The height of the tiles the map uses for calculations. |
Shuffles a set of tiles in a given area. It will only randomise the tiles in that area, so if they're all the same nothing will appear to have changed!
| Name | Type | Argument | Description |
|---|---|---|---|
x | number | X position of the top left of the area to operate one, given in tiles, not pixels. | |
y | number | Y position of the top left of the area to operate one, given in tiles, not pixels. | |
width | number | The width in tiles of the area to operate on. | |
height | number | The height in tiles of the area to operate on. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. |
Scans the given area for tiles with an index matching tileA and swaps them with tileB.
| Name | Type | Argument | Description |
|---|---|---|---|
tileA | number | First tile index. | |
tileB | number | Second tile index. | |
x | number | X position of the top left of the area to operate one, given in tiles, not pixels. | |
y | number | Y position of the top left of the area to operate one, given in tiles, not pixels. | |
width | number | The width in tiles of the area to operate on. | |
height | number | The height in tiles of the area to operate on. | |
layer | number | string | Phaser.TilemapLayer | <optional> | The layer to operate on. |
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Tilemap.html