TilemapComponentOptions

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

Options for creating a TilemapComponent.

Extends

VisualComponentOptions

Properties

alpha?

optional alpha?: number

Defined in: renderer/dist/index.d.ts:113

Alpha (opacity). Default: 1.

Inherited from

VisualComponentOptions.alpha

blendMode?

optional blendMode?: BLEND_MODES

Defined in: renderer/dist/index.d.ts:119

How this object’s pixels combine with what is drawn beneath it. Default: "normal". See BlendMode for the modes that need import "pixi.js/advanced-blend-modes".

Inherited from

VisualComponentOptions.blendMode

interactive?

optional interactive?: VisualInteractiveOptions

Defined in: renderer/dist/index.d.ts:132

Make the container interactive. When set, Pixi eventMode is configured so it participates in pointer hit-testing — required for any .on("pointerdown", ...) listener to fire.

consumeOnInteraction: true additionally marks it as a UI-input surface (via @yagejs/core’s consume registry), so a pointerdown landing on it is auto-claimed by @yagejs/input — preventing the same press from also firing gameplay action-map edges like MouseLeft. Default false: an interactive container still propagates the action, matching the “I want both Pixi events AND the action map” use case.

Inherited from

VisualComponentOptions.interactive

keyPrefix?

optional keyPrefix?: string

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

Override prefix used when auto-keying entities spawned from Tiled objects. Defaults to mapKey. Set this when multiple instances of the same map need distinct entity-key namespaces (e.g. instanced dungeons).

layer?

optional layer?: string

Defined in: renderer/dist/index.d.ts:107

Render layer name. Default: “default”.

Inherited from

VisualComponentOptions.layer

layers?

optional layers?: string[]

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

Which tile layers to render. Omit to render all.

map?

optional map?: TiledMapData

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

Parsed Tiled map data. Use only when you don’t have an AssetHandle. Save/load and auto-keys require mapKey or source.

mapKey?

optional mapKey?: string

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

Asset path to the Tiled JSON. Resolved via Assets.get. Save/load uses this.

source?

optional source?: AssetHandle<TiledMapData>

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

Asset handle for the map. Preferred — captures both the parsed data and the asset path.

tint?

optional tint?: ColorSource

Defined in: renderer/dist/index.d.ts:111

Tint color.

Inherited from

VisualComponentOptions.tint

visible?

optional visible?: boolean

Defined in: renderer/dist/index.d.ts:109

Initial visibility. Default: true.

Inherited from

VisualComponentOptions.visible