Function Parse

Parse(
    name: string,
    mapFormat: number,
    data: string | object | number[][],
    tileWidth: number,
    tileHeight: number,
    insertNull: boolean,
): MapData
Parses raw data of a given Tilemap format into a new MapData object. If no recognized data format is found, returns null. When loading from CSV or a 2D array, you should specify the tileWidth & tileHeight. When parsing from a map from Tiled, the tileWidth & tileHeight will be pulled from the map data.
Parameters
- name: string
  The name of the tilemap, used to set the name on the MapData.
- mapFormat: number
  See ../Formats.js.
- data: string | object | number[][]
  2D array, CSV string or Tiled JSON object.
- tileWidth: number
  The width of a tile in pixels. Required for 2D array and CSV, but ignored for Tiled JSON.
- tileHeight: number
  The height of a tile in pixels. Required for 2D array and CSV, but ignored for Tiled JSON.
- insertNull: boolean
  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.
Returns MapData
- Defined in types/phaser.d.ts:117393