Class Tilemap

Tilemap entity for rendering tiled maps.

Hierarchy (View Summary)

Entity
- Tilemap

Constructors

constructor

new Tilemap(game: Game, options: IEntityTilemapLayerOptions): Tilemap
Creates a tilemap entity.
Parameters
- game: Game
  The game instance this tilemap belongs to.
- options: IEntityTilemapLayerOptions
  Configuration options for the tilemap.
Returns Tilemap
Overrides Entity.constructor
- Defined in game.ts:277

Properties

`Readonly`children

children: Entity[] = []

data

data: (string | number)[][] = ...

`Optional`eachTile

eachTile?: (
    tileId: string | number,
    mapX: number,
    mapY: number,
) => undefined | void | ISpriteRenderOptions

error

error: Vec2 = ...

`Protected`game

game: Game

globalZindex

globalZindex: number = 0

localZindex

localZindex: number = 0

parent

parent: null | Entity = null

position

position: Vec2

`Protected`rapid

rapid: Rapid

rotation

rotation: number

scale

scale: Vec2

shape

shape: TilemapShape

tags

tags: string[]

tileSet

tileSet: TileSet

transform

transform: MatrixStack = ...

ySortCallback

ySortCallback: YSortCallback[] = []

`Static` `Readonly`DEFAULT_ERROR

DEFAULT_ERROR: 0

`Static` `Readonly`EMPTY_TILE

EMPTY_TILE: -1

Accessors

x

get x(): number
Returns number
Inherited from Entity.x
- Defined in game.ts:30
set x(nx: number): void
Parameters
- nx: number
Returns void
Inherited from Entity.x
- Defined in game.ts:38

y

get y(): number
Returns number
Inherited from Entity.y
- Defined in game.ts:34
set y(ny: number): void
Parameters
- ny: number
Returns void
Inherited from Entity.y
- Defined in game.ts:42

Methods

addChild

addChild(child: Entity): void
Adds a child entity to this entity.
Parameters
- child: Entity
  The entity to add as a child.
Returns void
Inherited from Entity.addChild
- Defined in game.ts:152

collectRenderables

collectRenderables(queue: Entity[]): void
Collects renderable entities, excluding children unless they override onRender.
Parameters
- queue: Entity[]
  The array to collect renderable entities.
Returns void
Overrides Entity.collectRenderables
- Defined in game.ts:297

dispose

dispose(): void
Disposes of the entity and its children.

Returns void
Inherited from Entity.dispose
- Defined in game.ts:216

fill

fill(
    tileId: string | number,
    startX: number,
    startY: number,
    width: number,
    height: number,
): void
Fills a rectangular area with a specified tile ID.
Parameters
- tileId: string | number
  The tile ID to use for filling.
- startX: number
  The starting X coordinate.
- startY: number
  The starting Y coordinate.
- width: number
  The width of the fill area.
- height: number
  The height of the fill area.
Returns void
- Defined in game.ts:350

findDescendant

findDescendant(
predicate: (entity: Entity) => boolean,
onlyFirst?: boolean,
): null | Entity | Entity[]
Finds descendant entities matching a predicate.
Parameters
- predicate: (entity: Entity) => boolean
  Function to test each entity.
- onlyFirst: boolean = true
  If true, returns only the first match; otherwise, returns all matches.
Returns null | Entity | Entity[]
A single entity, an array of entities, or null if no matches are found.
Inherited from Entity.findDescendant
- Defined in game.ts:178

findDescendantByTag

findDescendantByTag(
tags: string[],
onlyFirst?: boolean,
): null | Entity | Entity[]
Finds descendant entities with all specified tags.
Parameters
- tags: string[]
  Array of tags to match.
- onlyFirst: boolean = false
  If true, returns only the first match; otherwise, returns all matches.
Returns null | Entity | Entity[]
A single entity, an array of entities, or null if no matches are found.
Inherited from Entity.findDescendantByTag
- Defined in game.ts:205

getParentTransform

getParentTransform(): MatrixStack
Gets the parent transform or the renderer's matrix stack if no parent exists.

Returns MatrixStack
The transform matrix stack.
Inherited from Entity.getParentTransform
- Defined in game.ts:81

getTile

getTile(x: number, y: number): undefined | string | number
Gets the tile ID at the specified map coordinates.
Parameters
- x: number
  The X coordinate (column) on the map.
- y: number
  The Y coordinate (row) on the map.
Returns undefined | string | number
The tile ID (number or string) or undefined if coordinates are out of bounds.
- Defined in game.ts:325

localToMap

localToMap(local: Vec2): void
Converts local coordinates to map coordinates.
Parameters
- local: Vec2
  The local coordinates to convert.
Returns void
- Defined in game.ts:373

mapToLocal

mapToLocal(local: Vec2): void
Converts map coordinates to local coordinates.
Parameters
- local: Vec2
  The map coordinates to convert.
Returns void
- Defined in game.ts:381

onRender

onRender(render: Rapid): void
Renders the tilemap layer.
Parameters
- render: Rapid
  The rendering engine instance.
Returns void
Overrides Entity.onRender
- Defined in game.ts:389

`Protected`onUpdate

onUpdate(deltaTime: number): void
Hook for custom update logic.
Parameters
- deltaTime: number
  Time elapsed since the last update in seconds.
Returns void
Inherited from Entity.onUpdate
- Defined in game.ts:100

`Protected`postDispose

postDispose(): void
Hook for custom cleanup logic before disposal.

Returns void
Inherited from Entity.postDispose
- Defined in game.ts:226

removeChild

removeChild(child: Entity): void
Removes a child entity from this entity.
Parameters
- child: Entity
  The entity to remove.
Returns void
Inherited from Entity.removeChild
- Defined in game.ts:164

removeTile

removeTile(x: number, y: number): boolean
Removes a tile at the specified map coordinates (sets it to EMPTY_TILE).
Parameters
- x: number
  The X coordinate (column) on the map.
- y: number
  The Y coordinate (row) on the map.
Returns boolean
True if the tile was removed successfully, false if coordinates are out of bounds.
- Defined in game.ts:338

setData

setData(newData: (string | number)[][]): void
Replaces the entire tilemap data and updates dimensions.
Parameters
- newData: (string | number)[][]
  The new 2D array of tile data.
Returns void
- Defined in game.ts:365

setTile

setTile(x: number, y: number, tileId: string | number): boolean
Sets a tile at the specified map coordinates.
Parameters
- x: number
  The X coordinate (column) on the map.
- y: number
  The Y coordinate (row) on the map.
- tileId: string | number
  The tile ID to set (number or string).
Returns boolean
True if the tile was set successfully, false if coordinates are out of bounds.
- Defined in game.ts:310

update

update(deltaTime: number): void
Updates the entity and its children.
Parameters
- deltaTime: number
  Time elapsed since the last update in seconds.
Returns void
Inherited from Entity.update
- Defined in game.ts:89

updateTransform

updateTransform(deep?: boolean): void
Updates the entity's transform, optionally updating parent transforms.
Parameters
- deep: boolean = false
  If true, recursively updates parent transforms.
Returns void
Inherited from Entity.updateTransform
- Defined in game.ts:135