Tilemap

new Tilemap()

Tilemap component renders a grid of tiles from a tileset.

Extends

Classes

Tilemap

Members

pixelHeight

Get pixel height of the tilemap.

pixelWidth

Get pixel width of the tilemap.

(readonly) properties

The entity that this component is attached to.

Inherited From

Methods

addLayer()

Register another traversable map layer, ordered by render order then insertion.

deserialize(props)

Populates the component properties from a data object. Override this method for custom property handling.

Parameters:
NameTypeDescription
propsobject

The properties object (usually from JSON).

Inherited From

draw(ctx, offsetX, offsetY)

Draw the tilemap.

Parameters:
NameTypeDefaultDescription
ctxCanvasRenderingContext2D
offsetXnumber0

Camera offset X.

offsetYnumber0

Camera offset Y.

findPath()

Deterministic minimum-cost four-way path; returns coordinates excluding start, or null.

getCellMetadata()

Return a defensive copy of cell metadata, or null when unset/out of bounds.

getResolvedMetadata()

Resolve tile defaults with cell-specific metadata taking precedence.

getTile(x, y) → {number}

Get a tile at position.

Parameters:
NameTypeDescription
xnumber

X position in tiles.

ynumber

Y position in tiles.

Returns:

Tile ID or -1 if empty/out of bounds.

Type: 
number

getTileMetadata()

Return a defensive copy of metadata for a tile ID, or null when unset.

gridIndex()

Convert tile coordinates to a stable row-major grid index, or null out of bounds.

isSolid(x, y) → {boolean}

Check if a tile is solid (non-empty).

Parameters:
NameTypeDescription
xnumber
ynumber
Returns:
Type: 
boolean

loadFromArray(data)

Load tilemap from 2D array.

Parameters:
NameTypeDescription
dataArray.<Array.<number>>

2D array of tile IDs.

moveOccupant()

Move an occupied actor by one cardinal tile, leaving state unchanged on failure.

moveOccupantToward()

Follow a shortest path by one step toward a destination; returns the new cell or null.

occupy()

Place or move an occupant; each occupant may occupy only one cell.

setCellMetadata()

Set validated metadata for one row-major cell, overriding tile defaults.

setTile(x, y, tileId)

Set a tile at position.

Parameters:
NameTypeDescription
xnumber

X position in tiles.

ynumber

Y position in tiles.

tileIdnumber

Tile ID from tileset (-1 for empty).

setTileMetadata()

Set validated gameplay metadata for a tile ID.

worldToTile(worldX, worldY) → {Object}

Convert world position to tile position.

Parameters:
NameTypeDescription
worldXnumber
worldYnumber
Returns:
Type: 
Object