API reference

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

C

classTileSet

@codexo/exojs-tilemap / tilemap / stable

A resolved tileset: a uniform grid of tiles within a texture atlas. Does **not** own its texture - the Loader or application code retains texture ownership. Tileset dimensions are validated at construction and frozen thereafter. Multiple tilesets are supported per TileMap; each carries its own tile dimensions, spacing, and optional per-tile metadata.

13
props
4
methods
0
events
Import
import { TileSet } from '@codexo/exojs-tilemap'

A resolved tileset: a uniform grid of tiles within a texture atlas.

Does **not** own its texture - the Loader or application code retains texture ownership. Tileset dimensions are validated at construction and frozen thereafter.

Multiple tilesets are supported per TileMap; each carries its own tile dimensions, spacing, and optional per-tile metadata.

Constructors1
new(options: TileSetOptionsOptions for constructing a TileSet.): TileSet
Methods4
definedTiles(): IterableIterator<TileDefinitionOptional per-tile metadata in a TileSet. Sparse - only defined tiles carry a definition.>
Iterate over all defined tiles (sparse).
getTileDefinition(localTileId: number): TileDefinitionOptional per-tile metadata in a TileSet. Sparse - only defined tiles carry a definition. | undefined
Retrieve per-tile metadata, or undefined if none defined.
getTileRect(localTileId: number): { height: number; width: number; x: number; y: number }
Compute the pixel-space source rectangle for a local tile ID within the atlas, accounting for columns, spacing, and margin.
setDefinitions(definitions: readonly TileDefinitionOptional per-tile metadata in a TileSet. Sparse - only defined tiles carry a definition.[]): void
Replace all tile definitions with the given array. Each entry's properties are copied and frozen. Part of the tilemap SDK contract for extension packages that build tilesets programmatically.
Properties13
class: string
Tileset class/type string (Tiled class; may be empty).
columns: number
Number of columns in the atlas grid.
margin: number
Pixel margin around the atlas.
name: string
Stable runtime name.
offsetX: number
Visual drawing offset X in pixels (Tiled tileoffset). Applied by the tile-layer geometry builder and by the tile-collision helpers - i.e. wherever this package places a tile on a grid. It is **not** folded into a TileObject's x/y: object layers are data-only, so code that draws a tile object itself has to add this offset the way a tile layer would.
offsetY: number
Visual drawing offset Y in pixels (Tiled tileoffset) - see offsetX for where it applies.
rows: number
Number of rows implied by tileCount and columns.
spacing: number
Pixel spacing between tiles in the atlas.
texture: TextureRegionAn immutable descriptor for a rectangular sub-region of a Texture. Stores the pixel-space source rectangle, pre-computed normalised UV bounds, and optional ext…
Atlas texture region - Loader-owned, never destroyed by the tileset.
tileCount: number
Total number of tiles in the tileset.
tileHeight: number
Tile height in pixels.
tileWidth: number
Tile width in pixels.
allDefinitions: Readonly<Record<number, TilePropertiesAn immutable, flat key-value bag of generic tile properties. Adapters copy and freeze source properties; the runtime never retains a caller-owned mutable objec… | undefined>>
Read-only snapshot of all per-tile definitions. The returned record is a caller-owned copy.
Source
packages/exojs-tilemap/src/TileSet.ts