TilemapAPI
constTilemapAPI:object
Defined in: tilemap/tilemapAPI.ts:98
The static tilemap toolkit — chunk/tile accessors over the wasm module,
addressed by runtime layer handle. Contract: game code reads this as the
Res(Tilemaps) resource like every other subsystem; direct TilemapAPI.*
calls are the host/tooling surface (the editor’s tile tools, tests) where no
App is in scope. Both names are the same object.
Type Declaration
Section titled “Type Declaration”advanceAnimations()
Section titled “advanceAnimations()”advanceAnimations(
entity,dtMs):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
clearTileAnimations()
Section titled “clearTileAnimations()”clearTileAnimations(
entity):void
Drop every tile animation on the layer (a tileset swap re-adds the new set’s).
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
destroyLayer()
Section titled “destroyLayer()”destroyLayer(
entity):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
exportChunks()
Section titled “exportChunks()”exportChunks(
entity):string
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”string
fillRect()
Section titled “fillRect()”fillRect(
entity,x,y,w,h,tileId):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
number
number
tileId
Section titled “tileId”number
Returns
Section titled “Returns”void
flipTile()
Section titled “flipTile()”flipTile(
entity,x,y,flipH,flipV,flipD):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
boolean
boolean
boolean
Returns
Section titled “Returns”void
getTile()
Section titled “getTile()”getTile(
entity,x,y):number
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
Returns
Section titled “Returns”number
getTileProperty()
Section titled “getTileProperty()”getTileProperty(
entity,x,y,key):string
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
string
Returns
Section titled “Returns”string
hasLayer()
Section titled “hasLayer()”hasLayer(
entity):boolean
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”boolean
importChunks()
Section titled “importChunks()”importChunks(
entity,encoded):boolean
Parameters
Section titled “Parameters”entity
Section titled “entity”number
encoded
Section titled “encoded”string
Returns
Section titled “Returns”boolean
initInfiniteLayer()
Section titled “initInfiniteLayer()”initInfiniteLayer(
entity,tileWidth,tileHeight):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
tileWidth
Section titled “tileWidth”number
tileHeight
Section titled “tileHeight”number
Returns
Section titled “Returns”void
initLayer()
Section titled “initLayer()”initLayer(
entity,width,height,tileWidth,tileHeight):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
height
Section titled “height”number
tileWidth
Section titled “tileWidth”number
tileHeight
Section titled “tileHeight”number
Returns
Section titled “Returns”void
rotateTile()
Section titled “rotateTile()”rotateTile(
entity,x,y,degrees):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
degrees
Section titled “degrees”number
Returns
Section titled “Returns”void
setChunkTiles()
Section titled “setChunkTiles()”setChunkTiles(
entity,chunkX,chunkY,tiles,width,height):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
chunkX
Section titled “chunkX”number
chunkY
Section titled “chunkY”number
Uint16Array
number
height
Section titled “height”number
Returns
Section titled “Returns”void
setGridType()
Section titled “setGridType()”setGridType(
entity,type):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
Returns
Section titled “Returns”void
setHexParams()
Section titled “setHexParams()”setHexParams(
entity,sideLength,staggerAxisX,staggerIndexEven):void
Hexagonal-grid layout inputs (Tiled hexsidelength/staggeraxis/staggerindex); only read when the layer’s grid type is Hexagonal (3).
Parameters
Section titled “Parameters”entity
Section titled “entity”number
sideLength
Section titled “sideLength”number
staggerAxisX
Section titled “staggerAxisX”boolean
staggerIndexEven
Section titled “staggerIndexEven”boolean
Returns
Section titled “Returns”void
setOriginEntity()
Section titled “setOriginEntity()”setOriginEntity(
layerKey,originEntity):void
Parameters
Section titled “Parameters”layerKey
Section titled “layerKey”number
originEntity
Section titled “originEntity”number
Returns
Section titled “Returns”void
setRenderProps()
Section titled “setRenderProps()”setRenderProps(
entity,textureHandle,tilesetColumns,uvTileW,uvTileH,sortLayer,depth,parallaxX,parallaxY):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
textureHandle
Section titled “textureHandle”number
tilesetColumns
Section titled “tilesetColumns”number
uvTileW
Section titled “uvTileW”number
uvTileH
Section titled “uvTileH”number
sortLayer
Section titled “sortLayer”number
number
parallaxX
Section titled “parallaxX”number
parallaxY
Section titled “parallaxY”number
Returns
Section titled “Returns”void
setTile()
Section titled “setTile()”setTile(
entity,x,y,tileId):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
tileId
Section titled “tileId”number
Returns
Section titled “Returns”void
setTileAnimation()
Section titled “setTileAnimation()”setTileAnimation(
entity,tileId,frames):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
tileId
Section titled “tileId”number
frames
Section titled “frames”object[]
Returns
Section titled “Returns”void
setTileProperty()
Section titled “setTileProperty()”setTileProperty(
entity,tileId,key,value):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
tileId
Section titled “tileId”number
string
string
Returns
Section titled “Returns”void
setTiles()
Section titled “setTiles()”setTiles(
entity,tiles):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Uint16Array
Returns
Section titled “Returns”void
setTilesets()
Section titled “setTilesets()”setTilesets(
entity,slots):void
Replace the layer’s multi-tileset table. Empty array reverts to single-tileset.
Parameters
Section titled “Parameters”entity
Section titled “entity”number
object[]
Returns
Section titled “Returns”void
setTint()
Section titled “setTint()”setTint(
entity,r,g,b,a,opacity):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
number
number
opacity
Section titled “opacity”number
Returns
Section titled “Returns”void
setVisible()
Section titled “setVisible()”setVisible(
entity,visible):void
Parameters
Section titled “Parameters”entity
Section titled “entity”number
visible
Section titled “visible”boolean
Returns
Section titled “Returns”void
tileToWorld()
Section titled “tileToWorld()”tileToWorld(
entity,tx,ty,originX,originY):object
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
originX
Section titled “originX”number
originY
Section titled “originY”number
Returns
Section titled “Returns”object
x:
number
y:
number
worldToTile()
Section titled “worldToTile()”worldToTile(
entity,wx,wy,originX,originY):object
Parameters
Section titled “Parameters”entity
Section titled “entity”number
number
number
originX
Section titled “originX”number
originY
Section titled “originY”number
Returns
Section titled “Returns”object
x:
number
y:
number