Navigation
These archived docs are for Phaser 2.2.2 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

Phaser. TilemapParser

new TilemapParser()

Phaser.TilemapParser parses data objects from Phaser.Loader that need more preparation before they can be inserted into a Tilemap.

Source code: tilemap/TilemapParser.js, line 12

Public Methods

<static> getEmptyData() → {object}

Returns an empty map data object.

Returns
object -

Generated map data.

Source code: tilemap/TilemapParser.js, line 120

<static> parse(game, key, tileWidth, tileHeight, width, height) → {object}

Parse tilemap data from the cache and creates a Tilemap object.

Parameters
Name Type Argument Default Description
game Phaser.Game

Game reference to the currently running game.

key string

The key of the tilemap in the Cache.

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.

Returns
object -

The parsed map object.

Source code: tilemap/TilemapParser.js, line 14

<static> parseCSV(data, tileWidth, tileHeight) → {object}

Parses a CSV file into valid map data.

Parameters
Name Type Argument Default Description
data string

The CSV file data.

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.

Returns
object -

Generated map data.

Source code: tilemap/TilemapParser.js, line 63

<static> parseJSON(json) → {object}

Parses a Tiled JSON file into valid map data.

Parameters
Name Type Description
json object

The JSON map data.

Returns
object -

Generated and parsed map data.

Source code: tilemap/TilemapParser.js, line 182