TilemapLayerData

Data model representing a single layer within a tilemap.

TilemapLayerData holds all the information needed to render and interact with a tilemap layer, including tile indices, dimensions, positioning, and visual properties. This is a reactive Model that notifies observers when properties change, allowing TilemapLayer visuals to update automatically.

Features #

• Tile Storage: Holds tile indices referencing tilesets via global IDs (GIDs)
• Auto-tiling Support: Can store both original and computed tiles after auto-tiling
• Per-tile Properties: Supports per-tile alpha and offset values
• Layer Properties: Position, size, visibility, opacity, and blending modes
• Reactive Updates: Extends Model for automatic change notifications

Usage Example #

// Create a new layer data
var layer = new TilemapLayerData();
layer.name = 'collision';
layer.grid(20, 15); // 20x15 tiles
layer.tileSize(32, 32); // 32x32 pixel tiles

// Set tiles (array of TilemapTile values)
var tiles = [];
for (i in 0...300) {
    tiles.push(i == 150 ? 1 : 0); // Single tile in center
}
layer.tiles = tiles;

// Configure visual properties
layer.opacity = 0.8;
layer.color = Color.RED;

Instance Members #

Reference to the source LDtk layer instance when this layer was imported from LDtk. Provides access to additional LDtk-specific data and properties.

The name of the layer

The x position of the layer in tiles

The y position of the layer in tiles

The width of the layer in tiles

The height of the layer in tiles

The opacity of the layer

Whether this layer is visible or not

X offset for this layer in points.

Y offset for this layer in points.

Explicit depth, or null of that should be computed by Tilemap instead

Tile default blending

Tile default (tint) color

Extra tile default blending

Extra tile default alpha

Tiles

Per-tile alpha, or null if there is no custom alpha per tile

Per-tile x offset in pixels, or null if there is no offset

Per-tile y offset in pixels, or null if there is no offset

Computed tiles, after applying auto-tiling (if any). Will be null if no auto-tiling is used.

Per-computed tile alpha, or null if there is no custom alpha per computed tile

Per-computed tile x offset in pixels, or null if there is no offset per computed tile

Per-computed tile y offset in pixels, or null if there is no offset per computed tile

Is true if this layer has tiles. Some layers don't have tile and don't need to be rendered with tilemap layer quads, but are still available as containers to add custom objects (like LDtk entities).

Is true (default) if this layer should have its tiles rendered (if any).

The width of a tile in this layer

The height of a tile in this layer

A shorthand to set columns and rows

A shorthand to set x and y

A shorthand to set offsetX and offsetY

A shorthand to set tileWidth and tileHeight

Converts column and row coordinates to a tile index.

Retrieves the tile at the specified column and row position from the tiles array.

Retrieves the computed tile at the specified column and row position. Used when auto-tiling has been applied to get the final tile value.

Gets the column position from a tile index.

Gets the row position from a tile index.

Private Members #

Event when ldtkLayer field changes.

Event when name field changes.

Event when x field changes.

Event when y field changes.

Event when columns field changes.

Event when rows field changes.

Event when opacity field changes.

Event when visible field changes.

Event when offsetX field changes.

Event when offsetY field changes.

Event when explicitDepth field changes.

Event when blending field changes.

Event when color field changes.

Event when extraBlending field changes.

Event when extraOpacity field changes.

Event when tiles field changes.

Event when tilesAlpha field changes.

Event when tilesOffsetX field changes.

Event when tilesOffsetY field changes.

Event when computedTiles field changes.

Event when computedTilesAlpha field changes.

Event when computedTilesOffsetX field changes.

Event when computedTilesOffsetY field changes.

Event when hasTiles field changes.

Event when shouldRenderTiles field changes.

Event when tileWidth field changes.

Event when tileHeight field changes.

Metadata #