TilemapComponent
Defined in: tilemap/src/TilemapComponent.ts:34
Component that renders a Tiled map using @pixi/tilemap.
Extends
Section titled “Extends”Component
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TilemapComponent(
options):TilemapComponent
Defined in: tilemap/src/TilemapComponent.ts:42
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”TilemapComponent
Overrides
Section titled “Overrides”Component.constructor
Properties
Section titled “Properties”container
Section titled “container”
readonlycontainer:Container
Defined in: tilemap/src/TilemapComponent.ts:35
readonlydata:TilemapData
Defined in: tilemap/src/TilemapComponent.ts:36
enabled
Section titled “enabled”enabled:
boolean
Defined in: core/dist/index.d.ts:542
Whether this component is active. Disabled components are skipped by ComponentUpdateSystem.
Inherited from
Section titled “Inherited from”Component.enabled
entity
Section titled “entity”entity:
Entity
Defined in: core/dist/index.d.ts:540
Back-reference to the owning entity. Set by the engine when the component is added to an entity. Do not set manually.
Inherited from
Section titled “Inherited from”Component.entity
Accessors
Section titled “Accessors”context
Section titled “context”Get Signature
Section titled “Get Signature”get context():
EngineContext
Defined in: core/dist/index.d.ts:554
Access the EngineContext from the entity’s scene. Throws if the entity is not in a scene.
Returns
Section titled “Returns”EngineContext
Inherited from
Section titled “Inherited from”Component.context
heightPx
Section titled “heightPx”Get Signature
Section titled “Get Signature”get heightPx():
number
Defined in: tilemap/src/TilemapComponent.ts:111
Map height in pixels.
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get scene():
Scene
Defined in: core/dist/index.d.ts:549
Access the entity’s scene. Throws if the entity is not in a scene.
Prefer this over this.entity.scene! in component methods.
Returns
Section titled “Returns”Scene
Inherited from
Section titled “Inherited from”Component.scene
tileHeight
Section titled “tileHeight”Get Signature
Section titled “Get Signature”get tileHeight():
number
Defined in: tilemap/src/TilemapComponent.ts:121
Tile height in pixels.
Returns
Section titled “Returns”number
tileWidth
Section titled “tileWidth”Get Signature
Section titled “Get Signature”get tileWidth():
number
Defined in: tilemap/src/TilemapComponent.ts:116
Tile width in pixels.
Returns
Section titled “Returns”number
widthPx
Section titled “widthPx”Get Signature
Section titled “Get Signature”get widthPx():
number
Defined in: tilemap/src/TilemapComponent.ts:106
Map width in pixels.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”_runCleanups()
Section titled “_runCleanups()”_runCleanups():
void
Defined in: core/dist/index.d.ts:584
Internal
Run and clear all registered cleanups. Called by Entity.remove() and Entity._performDestroy() before onRemove/onDestroy.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Component._runCleanups
addCleanup()
Section titled “addCleanup()”
protectedaddCleanup(fn):void
Defined in: core/dist/index.d.ts:578
Register a cleanup function to run when this component is removed or destroyed.
Parameters
Section titled “Parameters”() => void
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Component.addCleanup
afterRestore()?
Section titled “afterRestore()?”
optionalafterRestore(data,resolve):void
Defined in: core/dist/index.d.ts:598
Called after onAdd() during save/load restoration. Apply state that depends on onAdd() having run.
Parameters
Section titled “Parameters”unknown
resolve
Section titled “resolve”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Component.afterRestore
fixedUpdate()?
Section titled “fixedUpdate()?”
optionalfixedUpdate(dt):void
Defined in: core/dist/index.d.ts:594
Called every fixed timestep by the built-in ComponentUpdateSystem.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Component.fixedUpdate
getCollisionShapes()
Section titled “getCollisionShapes()”getCollisionShapes(
objectLayerName?):TilemapColliderConfig[]
Defined in: tilemap/src/TilemapComponent.ts:161
Extract physics-agnostic collision shapes from object layers.
Parameters
Section titled “Parameters”objectLayerName?
Section titled “objectLayerName?”string
Returns
Section titled “Returns”getObjects()
Section titled “getObjects()”getObjects(
objectLayerName?):Record<string,MapObject[]>
Defined in: tilemap/src/TilemapComponent.ts:166
Extract objects from object layers grouped by class/name.
Parameters
Section titled “Parameters”objectLayerName?
Section titled “objectLayerName?”string
Returns
Section titled “Returns”Record<string, MapObject[]>
getTileAt()
Section titled “getTileAt()”getTileAt(
worldX,worldY,layerName?):number|null
Defined in: tilemap/src/TilemapComponent.ts:129
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
Section titled “Parameters”worldX
Section titled “worldX”number
worldY
Section titled “worldY”number
layerName?
Section titled “layerName?”string
Returns
Section titled “Returns”number | null
listen()
Section titled “listen()”
protectedlisten<T>(entity,token,handler):void
Defined in: core/dist/index.d.ts:574
Subscribe to events on any entity, auto-unsubscribe on removal.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity
EventToken<T>
handler
Section titled “handler”(data) => void
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Component.listen
listenScene()
Section titled “listenScene()”
protectedlistenScene<T>(token,handler):void
Defined in: core/dist/index.d.ts:576
Subscribe to scene-level bubbled events, auto-unsubscribe on removal.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”EventToken<T>
handler
Section titled “handler”(data, entity) => void
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Component.listenScene
onAdd()
Section titled “onAdd()”onAdd():
void
Defined in: tilemap/src/TilemapComponent.ts:66
Called when the component is added to an entity.
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”Component.onAdd
onDestroy()
Section titled “onDestroy()”onDestroy():
void
Defined in: tilemap/src/TilemapComponent.ts:77
Called when the component is destroyed (entity destroyed or component removed).
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”Component.onDestroy
onRemove()?
Section titled “onRemove()?”
optionalonRemove():void
Defined in: core/dist/index.d.ts:588
Called when the component is removed from an entity.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Component.onRemove
serialize()
Section titled “serialize()”serialize():
TilemapComponentData|null
Defined in: tilemap/src/TilemapComponent.ts:82
Return a JSON-serializable snapshot of this component’s state. Used by the save system.
Returns
Section titled “Returns”TilemapComponentData | null
Overrides
Section titled “Overrides”Component.serialize
service()
Section titled “service()”
protectedservice<T>(key):T
Defined in: core/dist/index.d.ts:564
Lazy proxy-based service resolution. Can be used at field-declaration time:
readonly camera = this.service(CameraKey);The actual resolution is deferred until first property access.
Type Parameters
Section titled “Type Parameters”T extends object
Parameters
Section titled “Parameters”ServiceKey<T>
Returns
Section titled “Returns”T
Inherited from
Section titled “Inherited from”Component.service
sibling()
Section titled “sibling()”
protectedsibling<C>(cls):C
Defined in: core/dist/index.d.ts:572
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
Section titled “Type Parameters”C extends Component
Parameters
Section titled “Parameters”ComponentClass<C>
Returns
Section titled “Returns”C
Inherited from
Section titled “Inherited from”Component.sibling
update()?
Section titled “update()?”
optionalupdate(dt):void
Defined in: core/dist/index.d.ts:592
Called every frame by the built-in ComponentUpdateSystem.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Component.update
protecteduse<T>(key):T
Defined in: core/dist/index.d.ts:556
Resolve a service by key, cached after first lookup.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”ServiceKey<T>
Returns
Section titled “Returns”T
Inherited from
Section titled “Inherited from”Component.use
fromSnapshot()
Section titled “fromSnapshot()”
staticfromSnapshot(data):TilemapComponent
Defined in: tilemap/src/TilemapComponent.ts:97
Parameters
Section titled “Parameters”Returns
Section titled “Returns”TilemapComponent