You are browsing legacy Phaser documentation that is 4+ years out of date. Please see https://newdocs.phaser.io

Class: MapData

Phaser.Tilemaps. MapData

A class for representing data about a map. Maps are parsed from CSV, Tiled, etc. into this format. A Tilemap object get a copy of this data and then unpacks the needed properties into itself.

new MapData( [config])

Parameters:
Name Type Argument Description
config Phaser.Types.Tilemaps.MapDataConfig <optional>

The Map configuration object.
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 11)

Members

collision :object

An object of collision data. Must be created as physics object or will return undefined.

Type:
  • object
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 181)

format :number

The format of the map data.

Type:
  • number
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 104)

height :number

The height of the entire tilemap.

Type:
  • number
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 50)

heightInPixels :number

The height in pixels of the entire tilemap.

Type:
  • number
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 95)

hexSideLength :number

The length of the horizontal sides of the hexagon. Only used for hexagonal orientation Tilemaps.

Type:
  • number
Since: 3.50.0
Source: src/tilemaps/mapdata/MapData.js (Line 217)

imageCollections :array

The collection of images the map uses(specified in Tiled)

Type:
  • array
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 199)

images :array

An array of Tiled Image Layers.

Type:
  • array
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 163)

infinite :boolean

If the map is infinite or not.

Type:
  • boolean
Since: 3.17.0
Source: src/tilemaps/mapdata/MapData.js (Line 59)

layers :Array.<Phaser.Tilemaps.LayerData>|Phaser.Tilemaps.ObjectLayer

An array with all the layers configured to the MapData.

Type:
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 154)

name :string

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

Type:
  • string
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 32)

objects :object

An object of Tiled Object Layers.

Type:
  • object
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 172)

orientation :Phaser.Tilemaps.OrientationType

The orientation of the map data (i.e. orthogonal, isometric, hexagonal), default 'orthogonal'.

Type:
Since: 3.50.0
Source: src/tilemaps/mapdata/MapData.js (Line 113)

properties :object

Map specific properties (can be specified in Tiled)

Type:
  • object
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 145)

renderOrder :string

Determines the draw order of tilemap. Default is right-down

0, or 'right-down' 1, or 'left-down' 2, or 'right-up' 3, or 'left-up'

Type:
  • string
Since: 3.12.0
Source: src/tilemaps/mapdata/MapData.js (Line 122)

tileHeight :number

The height of the tiles.

Type:
  • number
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 77)

tiles :array

An array of tile instances.

Type:
  • array
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 208)

tilesets :Array.<Phaser.Tilemaps.Tileset>

An array of Tilesets.

Type:
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 190)

tileWidth :number

The width of the tiles.

Type:
  • number
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 68)

version :string

The version of the map data (as specified in Tiled).

Type:
  • string
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 136)

width :number

The width of the entire tilemap.

Type:
  • number
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 41)

widthInPixels :number

The width in pixels of the entire tilemap.

Type:
  • number
Since: 3.0.0
Source: src/tilemaps/mapdata/MapData.js (Line 86)