Class TMXTileMap

constructor

• new TMXTileMap(levelId, data): TMXTileMap

• Parameters

  • levelId: string

    name of TMX map

  • data: object

    TMX map in JSON format

  Returns TMXTileMap

  Example

  // create a new level object based on the TMX JSON object
  letlevel = newme.TMXTileMap(levelId, me.loader.getTMX(levelId));
  // add the level to the game world container
  level.addTo(me.game.world, true);
  Copy

backgroundcolor

bounds

class

cols

height

hexsidelength

infinite

0
Copy

initialized

isEditor

layers

name

nextobjectid

objectGroups

orientation

"orthogonal"
Copy

renderer

renderorder

"right-down"
Copy

rows

staggeraxis

staggerindex

tiledversion

tileheight

tilesets

tilewidth

version

width

addTo

• addTo(container, flatten?, setViewportBounds?): void

• add all the map layers and objects to the given container. note : this will not automatically update the camera viewport

  Parameters

  • container: Container

    target container

  • Optionalflatten: boolean

    if true, flatten all objects into the given container, else a me.Container object will be created for each corresponding groups

  • OptionalsetViewportBounds: boolean

    if true, set the viewport bounds to the map size, this should be set to true especially if adding a level to the game world container.

  Returns void

  Example

  // create a new level object based on the TMX JSON object
  letlevel = newme.TMXTileMap(levelId, me.loader.getTMX(levelId));
  // add the level to the game world container
  level.addTo(me.game.world, true, true);
  Copy

destroy

• destroy(): void

• destroy function, clean all allocated objects

  Returns void

getBounds

• getBounds(): Bounds

• return the map bounding rect

  Returns Bounds

getLayers

• getLayers(): TMXLayer []

• return all the existing layers

  Returns TMXLayer []

  Array of Layers

getObjects

• getObjects(flatten?): Renderable[]

• return an Array of instantiated objects, based on the map object definition

  Parameters

  • Optionalflatten: boolean

    if true, flatten all objects into the returned array. when false, a me.Container object will be created for each corresponding groups

  Returns Renderable[]

  Array of Objects

getRenderer

• getRenderer(): TMXRenderer

• Return the map default renderer

  Returns TMXRenderer

  a TMX renderer