TilemapEditor

Interactive tilemap editor component that enables in-game tile painting and erasing.

This component can be attached to a Tilemap entity to enable runtime editing functionality, allowing users to paint tiles with left-click and erase them with right-click. It supports continuous painting while dragging and interpolates between positions for smooth lines.

Usage Example #

// Create a tilemap and enable editing
var tilemap = new Tilemap();
tilemap.tilemapData = myTilemapData;

// Attach editor to allow painting on the 'main' layer
var editor = new TilemapEditor('main', grassTile, emptyTile);
tilemap.component(editor);

// Listen for edit events
editor.onFill(this, index -> {
    trace('Filled tile at index: $index');
});

Instance Members #

The tilemap entity this editor is attached to. Set automatically when used as a component.

The name of the tilemap layer to edit. Must match an existing layer in the tilemap data.

The tile value to apply when filling (left-click). This can be a tile ID from a tileset or a special value.

The tile value to apply when erasing (right-click). Typically 0 to represent an empty tile.

Whether editing is currently enabled. Set to false to temporarily disable user interaction.

Called when this editor is attached to a tilemap as a component. Sets up the necessary event listeners for pointer interaction.

Creates a new tilemap editor.

Private Members #

ID of the button currently being held down (-1 if none). 0 = left button, 2 = right button.

The tile value being painted with the current button. Cached to ensure consistency during drag operations.

Map tracking which tiles have been painted during the current drag. Prevents painting the same tile multiple times in one stroke.

Last painted X position in visual coordinates. Used for interpolating smooth lines when dragging.

Last painted Y position in visual coordinates. Used for interpolating smooth lines when dragging.

Calculates the tile index at a given position in visual coordinates. Takes into account layer offsets and tile dimensions.

Event emitted when a tile is filled with the fill value.

Event emitted when a tile is erased with the erase value.

Handles pointer down events to start tile painting or erasing. Left-click starts filling tiles, right-click starts erasing.

Handles pointer up events to stop tile painting or erasing. Cleans up the drag state when the mouse button is released.

Handles pointer move events during tile painting or erasing. Interpolates between the last and current positions to paint smooth lines, ensuring no tiles are missed when moving the pointer quickly.

Metadata #