Phaser API Documentation

  Version: 
tilemap([key], [tileWidth], [tileHeight], [width], [height], [data], [insertNull])

Description:

Creates a Tilemap from the given key or data, or creates a blank Tilemap if no key/data provided. When loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing from a map from Tiled, the tileWidth, tileHeight, width & height will be pulled from the map data. For an empty map, you should specify tileWidth, tileHeight, width & height.

Parameters:

name type arguments Default description
key string <optional>

The key in the Phaser cache that corresponds to the loaded tilemap data.

tileWidth number <optional> 32

The width of a tile in pixels. Pass in null to leave as the default.

tileHeight number <optional> 32

The height of a tile in pixels. Pass in null to leave as the default.

width number <optional> 10

The width of the map in tiles. Pass in null to leave as the default.

height number <optional> 10

The height of the map in tiles. Pass in null to leave as the default.

data Array.<Array.<number>> <optional>

Instead of loading from the cache, you can also load directly from a 2D array of tile indexes. Pass in null for no data.

insertNull boolean <optional> false

Controls how empty tiles, tiles with an index of -1, in the map data are handled. If true, empty locations will get a value of null. If false, empty location will get a Tile object with an index of -1. If you've a large sparsely populated map and the tile data doesn't need to change then setting this value to true will help with memory consumption. However if your map is small or you need to update the tiles dynamically, then leave the default value set.

Since: 3.0.0