Tileset

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:28

Represents a tileset with tile definitions and texture atlas.

Handles UV coordinate calculation and animated tile management.

Example

const tileset = new Tileset({
  name: 'dungeon',
  firstGid: 1,
  tileWidth: 16,
  tileHeight: 16,
  imageWidth: 256,
  imageHeight: 256,
  columns: 16,
  tileCount: 256,
  tiles: new Map(),
  texture: myTexture,
})

const uv = tileset.getUV(5) // Get UV for tile GID 5

Constructors

Constructor

new Tileset(data): Tileset

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:61

Parameters

data

TilesetData

Returns

Tileset

Properties

columns

readonly columns: number

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:44

Grid info

---

firstGid

readonly firstGid: number

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:33

First GID

---

imageHeight

readonly imageHeight: number

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:41

---

imageWidth

readonly imageWidth: number

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:40

Atlas dimensions

---

margin

readonly margin: number

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:47

---

name

readonly name: string

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:30

Tileset name

---

spacing

readonly spacing: number

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:46

---

tileCount

readonly tileCount: number

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:45

---

tileHeight

readonly tileHeight: number

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:37

---

tileWidth

readonly tileWidth: number

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:36

Tile dimensions

Accessors

texture

Get Signature

get texture(): Texture <unknown, TextureEventMap > | null

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:104

Get the texture atlas.

Returns

Texture <unknown, TextureEventMap > | null

Set Signature

set texture(value): void

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:112

Set the texture atlas. Applies texture options from textureOptions property or TextureConfig.options.

Parameters

value

Texture <unknown, TextureEventMap > | null

Returns

void

---

textureOptions

Get Signature

get textureOptions(): TexturePreset | TextureOptions | undefined

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:123

Get the texture options for this tileset.

Returns

TexturePreset | TextureOptions | undefined

Set Signature

set textureOptions(value): void

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:131

Set the texture options for this tileset. If a texture is already set, it will be updated with the new options.

Parameters

value

TexturePreset | TextureOptions | undefined

Returns

void

Methods

containsGid()

containsGid(gid): boolean

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:142

Check if a GID belongs to this tileset.

Parameters

gid

number

Returns

boolean

---

dispose()

dispose(): void

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:217

Dispose of resources.

Returns

void

---

getAnimatedTileIds()

getAnimatedTileIds(): number[]

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:210

Get all animated tile IDs (as GIDs).

Returns

number[]

---

getAnimation()

getAnimation(gid): TileAnimationFrame[] | undefined

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:202

Get animation frames for a tile.

Parameters

gid

number

Returns

TileAnimationFrame[] | undefined

---

getLocalId()

getLocalId(gid): number

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:150

Get local ID from GID.

Parameters

gid

number

Returns

number

---

getTile()

getTile(gid): TileDefinition | undefined

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:186

Get tile definition.

Parameters

gid

number

Returns

TileDefinition | undefined

---

getUV()

getUV(gid): object

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:159

Get UV coordinates for a tile. Returns normalized UV coordinates (0-1) for the tile in the atlas. Note: Y is NOT flipped here - the material handles coordinate space conversion.

Parameters

gid

number

Returns

object

height

height: number

width

width: number

x

x: number

y

y: number

---

isAnimated()

isAnimated(gid): boolean

Defined in: packages/three-flatland/src/tilemap/Tileset.ts:194

Check if a tile is animated.

Parameters

gid

number

Returns

boolean