API reference

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

C

classTiledTileset

@codexo/exojs-tiled / tiled / stable

A parsed Tiled tileset - either embedded inline in a map's `tilesets` array, or parsed from an external `.tsj` file referenced by it. firstGid and lastGid define the inclusive range of global tile ids (after masking flip/rotation flags via `maskTiledGid`) that this tileset owns within its owning TiledMap.

21
props
2
methods
0
events
Import
import { TiledTileset } from '@codexo/exojs-tiled'

A parsed Tiled tileset - either embedded inline in a map's `tilesets` array, or parsed from an external `.tsj` file referenced by it.

firstGid and lastGid define the inclusive range of global tile ids (after masking flip/rotation flags via `maskTiledGid`) that this tileset owns within its owning TiledMap.

Constructors1
new(data: TiledTilesetDataA Tiled tileset, as the root of a standalone `.tsj` file or (minus `firstgid`) embedded inline in a map's `tilesets` array., firstGid: number, resources: TiledTilesetResourcesLoader-resolved resources for a TiledTileset: the absolute image URL(s) and the Texture instance(s) loaded for them. All textures are owned by the `Loader` cac…): TiledTileset
Methods2
getProperty(name: string): TiledPropertyDataOne custom property entry as written by Tiled (`properties` arrays on maps, tilesets, tiles, layers and objects). - `string` / `color` / `file` → `value` is a… | undefined
Looks up a custom property by name.
getTile(localId: number): TiledTileDataA per-tile definition within a tileset's `tiles` array. Sparse - only tiles carrying metadata (properties, animation, a collision objectgroup, or a collection-… | undefined
Looks up a per-tile definition by local tile id.
Properties21
class: string
columns: number
firstGid: number
First global tile id owned by this tileset.
imageHeight?: number
imageUrl?: string
Resolved URL of the tileset's atlas image, or undefined for a collection-of-images tileset.
imageWidth?: number
margin: number
name: string
objectAlignment?: TiledObjectAlignmentWhere a tile object's stored `x`/`y` sits within the tile's bounding box (TiledTilesetData.objectalignment). `'unspecified'` is Tiled's own default and is orie…
Where a tile object's stored position sits within its bounding box. undefined (and 'unspecified') means Tiled's orientation-dependent default - resolve it with import('./objectAlignment').resolveTiledObjectAlignment.
properties: readonly TiledPropertyDataOne custom property entry as written by Tiled (`properties` arrays on maps, tilesets, tiles, layers and objects). - `string` / `color` / `file` → `value` is a…[]
source?: string
Resolved URL of the external .tsj file, or undefined for an embedded tileset.
spacing: number
texture?: TextureA static GPU texture sourced from an image, canvas, or video element. Holds the pixel source, its sampling state (ScaleModes, WrapModes) and its upload state (…
Texture loaded for imageUrl. Loader-owned; not destroyed by TiledMap.destroy.
tileCount: number
tileHeight: number
tileOffset: TiledPointDataA 2D point as written by Tiled (used for tile offsets and object shapes).
tiles: readonly TiledTileDataA per-tile definition within a tileset's `tiles` array. Sparse - only tiles carrying metadata (properties, animation, a collision objectgroup, or a collection-…[]
tileTextures: ReadonlyMap<number, TextureA static GPU texture sourced from an image, canvas, or video element. Holds the pixel source, its sampling state (ScaleModes, WrapModes) and its upload state (…>
Textures loaded for collection-of-images tiles, keyed by local tile id. Loader-owned.
tileWidth: number
wangSets: readonly TiledWangSetDataA wangset entry within a tileset's `wangsets` array. `type` is `'corner'`, `'edge'`, or `'mixed'` (Tiled 1.5+). Older files may omit it or use other strings -…[]
Wang sets (terrain/auto-tile definitions) declared on this tileset. Empty when none are defined.
lastGid: number
Last global tile id (inclusive) owned by this tileset. Empty (lastGid < firstGid) when tileCount is 0.
Source
packages/exojs-tiled/src/TiledTileset.ts