TilemapComponent

Defined in: tilemap/src/TilemapComponent.ts:51

Component that renders a Tiled map using @pixi/tilemap.

Extends

Component

Constructors

Constructor

new TilemapComponent(options): TilemapComponent

Defined in: tilemap/src/TilemapComponent.ts:65

Parameters

options

TilemapComponentOptions

Returns

TilemapComponent

Overrides

Component.constructor

Properties

container

readonly container: Container

Defined in: tilemap/src/TilemapComponent.ts:52

data

readonly data: TilemapData

Defined in: tilemap/src/TilemapComponent.ts:53

enabled

enabled: boolean

Defined in: core/dist/index.d.ts:1731

Whether this component is active. Disabled components are skipped by ComponentUpdateSystem.

Inherited from

Component.enabled

entity

entity: Entity

Defined in: core/dist/index.d.ts:1729

Back-reference to the owning entity. Set by the engine when the component is added to an entity. Do not set manually.

Inherited from

Component.entity

keyPrefix

readonly keyPrefix: string | null

Defined in: tilemap/src/TilemapComponent.ts:57

Prefix used to derive auto-keys for entities spawned from objects.

mapKey

readonly mapKey: string | null

Defined in: tilemap/src/TilemapComponent.ts:55

Asset path of this map, or null if constructed from a raw TiledMapData without one.

Accessors

context

Get Signature

get context(): EngineContext

Defined in: core/dist/index.d.ts:1744

Access the EngineContext from the entity’s scene. Throws if the entity is not in a scene.

Returns

EngineContext

Inherited from

Component.context

heightPx

Get Signature

get heightPx(): number

Defined in: tilemap/src/TilemapComponent.ts:157

Map height in pixels.

Returns

number

scene

Get Signature

get scene(): Scene

Defined in: core/dist/index.d.ts:1739

Access the entity’s scene. Throws if the entity is not in a scene. Prefer this over threading through this.entity.scene in component code.

Returns

Scene

Inherited from

Component.scene

tileHeight

Get Signature

get tileHeight(): number

Defined in: tilemap/src/TilemapComponent.ts:167

Tile height in pixels.

Returns

number

tileWidth

Get Signature

get tileWidth(): number

Defined in: tilemap/src/TilemapComponent.ts:162

Tile width in pixels.

Returns

number

widthPx

Get Signature

get widthPx(): number

Defined in: tilemap/src/TilemapComponent.ts:152

Map width in pixels.

Returns

number

Methods

_runCleanups()

_runCleanups(): void

Defined in: core/dist/index.d.ts:1785

Internal

Run and clear all registered cleanups. Called by Entity.remove() and Entity._performDestroy() before onRemove/onDestroy.

Returns

void

Inherited from

Component._runCleanups

addCleanup()

protected addCleanup(fn): void

Defined in: core/dist/index.d.ts:1779

Parameters

fn

() => void

Returns

void

Inherited from

Component.addCleanup

afterRestore()?

optional afterRestore(data, resolve): void

Defined in: core/dist/index.d.ts:1799

Called after onAdd() during save/load restoration. Apply state that depends on onAdd() having run.

Parameters

data

unknown

resolve

SnapshotResolver

Returns

void

Inherited from

Component.afterRestore

findObject()

findObject(id): MapObject | undefined

Defined in: tilemap/src/TilemapComponent.ts:282

Find an object by its Tiled id. Searches every object layer.

Parameters

id

number

Returns

MapObject | undefined

findObjectByName()

findObjectByName(name): MapObject | undefined

Defined in: tilemap/src/TilemapComponent.ts:292

Find the first object with a matching name. Searches every object layer.

Parameters

name

string

Returns

MapObject | undefined

fixedUpdate()?

optional fixedUpdate(dt): void

Defined in: core/dist/index.d.ts:1795

Called every fixed timestep by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.fixedUpdate

forEachObject()

forEachObject(layerName, fn): void

Defined in: tilemap/src/TilemapComponent.ts:252

Iterate every object on the given layer (or every layer if omitted), passing the auto-derived stable key alongside each object so callers can spawn entities with scene.spawn(Class, params, { key }).

Skips objects that don’t have a key prefix (component constructed from raw map: without mapKey or keyPrefix) — those callers should iterate getObjects directly.

Parameters

layerName

string | undefined

fn

(obj, key) => void

Returns

void

getAllObjects()

getAllObjects(): MapObject[]

Defined in: tilemap/src/TilemapComponent.ts:233

Flat list of every object across every object layer. Memoized — safe because parsed map data is immutable post-construction.

Returns

MapObject[]

getCollisionShapes()

getCollisionShapes(objectLayerName?): TilemapColliderConfig[]

Defined in: tilemap/src/TilemapComponent.ts:207

Extract physics-agnostic collision shapes from object layers.

Parameters

objectLayerName?

string

Returns

TilemapColliderConfig[]

getObjects()

getObjects(objectLayerName?): Record<string, MapObject[]>

Defined in: tilemap/src/TilemapComponent.ts:212

Objects from object layers grouped by class ?? name. Use a layer name to scope.

Parameters

objectLayerName?

string

Returns

Record<string, MapObject[]>

getProperty()

getProperty<T>(obj, name): T | undefined

Defined in: tilemap/src/TilemapComponent.ts:302

Read a typed custom property off any tilemap object.

Type Parameters

T

T = unknown

Parameters

obj

MapObject

name

string

Returns

T | undefined

getPropertyArray()

getPropertyArray<T>(obj, name): T[]

Defined in: tilemap/src/TilemapComponent.ts:307

Read an indexed property bag (name[0], name[1], …) as an array.

Type Parameters

T

T = unknown

Parameters

obj

MapObject

name

string

Returns

T[]

getTileAt()

getTileAt(worldX, worldY, layerName?): number | null

Defined in: tilemap/src/TilemapComponent.ts:175

Returns the tile GID at a world position, accounting for entity Transform offset. Returns null if the position is outside the map or the tile is empty.

Parameters

worldX

number

worldY

number

layerName?

string

Returns

number | null

listen()

protected listen<T>(entity, token, handler): void

Defined in: core/dist/index.d.ts:1771

Subscribe to events on any entity, auto-unsubscribe on removal.

Type Parameters

T

T

Parameters

entity

Entity

token

EventToken<T>

handler

(data) => void

Returns

void

Inherited from

Component.listen

listenScene()

protected listenScene<T>(token, handler): void

Defined in: core/dist/index.d.ts:1777

Subscribe to scene-level events, auto-unsubscribe on removal. Handlers fire for bubbled entity events (entity = source) and scene.emit events (entity = undefined).

Type Parameters

T

T

Parameters

token

EventToken<T>

handler

(data, entity?) => void

Returns

void

Inherited from

Component.listenScene

objectKey()

objectKey(obj): string

Defined in: tilemap/src/TilemapComponent.ts:272

Auto-derived stable key for an object: <keyPrefix>#object:<id>.

Parameters

obj

MapObject

Returns

string

onAdd()

onAdd(): void

Defined in: tilemap/src/TilemapComponent.ts:109

Called when the component is added to an entity.

Returns

void

Overrides

Component.onAdd

onDestroy()

onDestroy(): void

Defined in: tilemap/src/TilemapComponent.ts:119

Called when the component is destroyed (entity destroyed or component removed).

Returns

void

Overrides

Component.onDestroy

onRemove()?

optional onRemove(): void

Defined in: core/dist/index.d.ts:1789

Called when the component is removed from an entity.

Returns

void

Inherited from

Component.onRemove

resolveRef()

resolveRef(obj, propName): MapObject | undefined

Defined in: tilemap/src/TilemapComponent.ts:315

Resolve a Tiled object-reference property to the actual object. Auto-collects across every layer so callers don’t have to.

Parameters

obj

MapObject

propName

string

Returns

MapObject | undefined

resolveRefArray()

resolveRefArray(obj, propName): MapObject[]

Defined in: tilemap/src/TilemapComponent.ts:320

Same as resolveRef, but for indexed object-reference arrays.

Parameters

obj

MapObject

propName

string

Returns

MapObject[]

serialize()

serialize(): TilemapComponentData | null

Defined in: tilemap/src/TilemapComponent.ts:124

Return a JSON-serializable snapshot of this component’s state. Used by the save system.

Returns

TilemapComponentData | null

Overrides

Component.serialize

service()

protected service<T>(key): T

Defined in: core/dist/index.d.ts:1761

Lazy proxy-based service resolution. Can be used at field-declaration time:

readonly input = this.service(InputManagerKey);

The actual resolution is deferred until first property access.

Type Parameters

T

T extends object

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.service

sibling()

protected sibling<C>(cls): C

Defined in: core/dist/index.d.ts:1769

Lazy proxy-based sibling component resolution. Can be used at field-declaration time:

readonly anim = this.sibling(AnimatedSpriteComponent);

The actual resolution is deferred until first property access.

Type Parameters

C

C extends Component

Parameters

cls

ComponentClass<C>

Returns

C

Inherited from

Component.sibling

update()?

optional update(dt): void

Defined in: core/dist/index.d.ts:1793

Called every frame by the built-in ComponentUpdateSystem.

Parameters

dt

number

Returns

void

Inherited from

Component.update

use()

protected use<T>(key): T

Defined in: core/dist/index.d.ts:1752

Resolve a service by key, cached after first lookup. Scene-scoped values (registered via scene._registerScoped) take precedence over engine scope. A key declared with scope: "scene" that falls back to engine scope emits a one-shot dev warning — almost always signals a missed beforeEnter hook.

Type Parameters

T

T

Parameters

key

ServiceKey<T>

Returns

T

Inherited from

Component.use

fromSnapshot()

static fromSnapshot(data): TilemapComponent

Defined in: tilemap/src/TilemapComponent.ts:142

Parameters

data

TilemapComponentData

Returns

TilemapComponent