For example, to flip tile ID 2 horizontally, you would use bitwise OR combining the tile ID and the flag, e.g. 2 | ITilemapInstance.TILE_FLIPPED_HORIZONTAL. Similarly you can test if the bit is set using tile & ITilemapInstance.TILE_FLIPPED_HORIZONTAL.
You can also use the masks to extract each component of the tile number. For example tile & ITilemapInstance.TILE_ID_MASK will return just the tile ID, since it removes all the flag bits.
Tilemap APIs
- mapWidth
- mapHeight
- getMapSize()
- Read-only numbers representing the size of the tilemap in tiles. The method allows getting both values at the same time.
- mapDisplayWidth
- mapDisplayHeight
- getMapDisplaySize()
- Read-only numbers with the displayed size of the tilemap, in tiles. The method allows getting both values at the same time.
- tileWidth
- tileHeight
- getTileSize()
- Read-only numbers with the size of a tile in pixels. The method allows getting both values at the same time.
- getTileAt(x, y)
- Get the tile at a given position in tiles (i.e. (0, 0) is the top-left tile of the tilemap, regardless of the tilemap's position or the tile size). Returns -1 for empty tiles or tiles outside the tilemap; otherwise use bit operations to determine tile ID or flags separately.
- setTileAt(x, y, tile)
- Set the tile at a given position in tiles. Use -1 to set a tile empty; otherwise use bit operations to combine the tile ID and flags.
- async replaceImage(blob)
- Replace the current tilemap image with the contents of a Blob representing an image file such as a PNG image. The blob can be locally generated or retrieved from a URL, for example:
// Loading an image from a URL
const response = await fetch(url);
const blob = await response.blob();
await tmInst.replaceImage(blob);