TMXTileset

class TMXTileset

a TMX Tile Set Object

Constructor


new TMXTileset(tileset: object) → {}
Parameters:
Name Type Description
tileset object

tileset data in JSON format (http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#tileset)

Summary


Properties from TMXTileset

Public Properties


class TMXTileset.js:58
class: boolean

boolean

the tileset class

isAnimated TMXTileset.js:46
isAnimated: boolean = false

boolean

Tileset contains animated tiles

isCollection TMXTileset.js:52
isCollection: boolean = false

boolean

true if the tileset is a "Collection of Image" Tileset

Public Methods


contains TMXTileset.js:183
contains(gid: number) → {boolean}

return true if the gid belongs to the tileset

Parameters:
Name Type Description
gid number
Returns:
Type Description
boolean
getTileImage TMXTileset.js:164
getTileImage(gid: number) → {Image}

return the tile image from a "Collection of Image" tileset

Parameters:
Name Type Description
gid number
Returns:
Type Description
Image

corresponding image or undefined

getTileProperties TMXTileset.js:208
getTileProperties(tileId: number) → {object}

return the properties of the specified tile

Parameters:
Name Type Description
tileId number
Returns:
Type Description
object
getViewTileId TMXTileset.js:192
getViewTileId(gid: number) → {number}

Get the view (local) tile ID from a GID, with animations applied

Parameters:
Name Type Description
gid number

Global tile ID

Returns:
Type Description
number

View tile ID


Powered by webdoc!