clik-engine API
    Preparing search index...

    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.

    Index

    Constructors

    Properties

    collision: object

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

    format: number

    The format of the map data.

    height: number

    The height of the entire tilemap.

    heightInPixels: number

    The height in pixels of the entire tilemap.

    hexSideLength: number

    The length of the horizontal sides of the hexagon.

    Only used for hexagonal orientation Tilemaps.

    imageCollections: any[]

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

    images: any[]

    An array of Tiled Image Layers.

    infinite: boolean

    If the map is infinite or not.

    An array with all the layers configured to the MapData.

    name: string

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

    An object of Tiled Object Layers.

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

    properties: object

    Map specific properties (can be specified in Tiled)

    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'

    staggerAxis: string

    The Stagger Axis as defined in Tiled.

    Only used for hexagonal orientation Tilemaps.

    staggerIndex: string

    The Stagger Index as defined in Tiled.

    Either 'odd' or 'even'.

    Only used for hexagonal orientation Tilemaps.

    tileHeight: number

    The height of the tiles.

    tiles: any[]

    An array of tile instances.

    tilesets: Tileset[]

    An array of Tilesets.

    tileWidth: number

    The width of the tiles.

    version: string

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

    width: number

    The width of the entire tilemap.

    widthInPixels: number

    The width in pixels of the entire tilemap.