API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

C

classTileMap

@codexo/exojs-tilemap / tilemap / stable

A generic, format-independent tile map. Owns a finite grid of TileLayers and a shared set of TileSets. Tile data is stored in compact chunked arrays — no per-tile heap objects. The map does NOT own tileset textures (those are Loader-owned) and does NOT own SceneNode children — see import('./TileMapNode').TileMapNode, which owns those. Multiple tilesets are supported: each cell stores a packed tileset index and local tile ID, so different tilesets may have different tile dimensions.

19
props
21
methods
0
events
Import
import { TileMap } from '@codexo/exojs-tilemap'

A generic, format-independent tile map.

Owns a finite grid of TileLayers and a shared set of TileSets. Tile data is stored in compact chunked arrays — no per-tile heap objects.

The map does NOT own tileset textures (those are Loader-owned) and does NOT own SceneNode children — see import('./TileMapNode').TileMapNode, which owns those.

Multiple tilesets are supported: each cell stores a packed tileset index and local tile ID, so different tilesets may have different tile dimensions.

Constructors 1
new(options: TileMapOptions): TileMap
Methods 21
addLayer(layer: TileLayer): void
addObjectLayer(layer: ObjectLayer): void
addTileset(tileset: TileSet): void
clearTileAt(layerId: number, tx: number, ty: number): void
createView(options?: TileMapViewOptions): TileMapView
destroy(): void
getImageLayer(name: string): ImageLayer | undefined
getImageLayerById(id: number): ImageLayer | undefined
getLayerById(id: number): TileLayer | undefined
getLayerByName(name: string): TileLayer | undefined
getObjectLayer(name: string): ObjectLayer<S> | undefined
getObjectLayerById(id: number): ObjectLayer<S> | undefined
getTileAt(layerId: number, tx: number, ty: number): ResolvedTile | null
getTileLayer(name: string): TileLayer | undefined
getTileset(name: string): TileSet | undefined
pixelToTile(px: number, py: number): object
removeImageLayer(id: number): boolean
removeLayer(id: number): boolean
removeObjectLayer(id: number): boolean
setTileAt(layerId: number, tx: number, ty: number, tile: ResolvedTile): void
tileToPixel(tx: number, ty: number): object
Properties 19
backgroundColor: number | null
chunkHeight: number
chunkWidth: number
class: string
height: number
name: string
properties: TileProperties
renderOrder: string
tileHeight: number
tileWidth: number
width: number
destroyed: boolean
imageLayers: readonly ImageLayer[]
layers: readonly TileLayer[]
objectLayers: readonly ObjectLayer<ObjectSchema>[]
pixelHeight: number
pixelWidth: number
revision: number
tilesets: readonly TileSet[]
Source