Tileset

Represents a collection of tiles used by a tilemap.

A tileset contains the image data and metadata for tiles that can be placed in a tilemap. Each tile is identified by a global ID (GID) that's unique across all tilesets in a tilemap. Tilesets support various features including tile spacing, margins, and slope definitions for physics interactions.

Features #

• Tile Organization: Tiles arranged in a grid with configurable spacing and margins
• Global IDs: Each tile has a unique GID for referencing across layers
• Slope Support: Define collision slopes for individual tiles
• Grid Orientation: Support for orthogonal and isometric tile arrangements
• Reactive Properties: Extends Model for automatic change notifications

Usage Example #

var tileset = new Tileset();
tileset.name = "terrain";
tileset.firstGid = 1;
tileset.tileSize(32, 32);
tileset.image = tilesetImage;

// Add a slope for tile index 5
tileset.slope(5, {
    index: 5,
    y0: 0.0,    // Left edge height (0 = bottom, 1 = top)
    y1: 0.5,    // Right edge height
    rotation: 0 // Optional rotation
});

Instance Members #

Reference to the source LDtk tileset definition when this tileset was imported from LDtk. Provides access to additional LDtk-specific metadata.

First global id. Maps to the first tile in this tileset.

The name of this tileset

The (maximum) width of tiles in this tileset

The (maximum) height of tiles in this tileset

The spacing between tiles in this tileset

The margin around the tiles in this tileset

The number of tiles in this tileset

The number of tile columns in this tileset

The number of tile rows in this tileset

The image used to display tiles in this tileset

Orientation of the grid for the tiles in this tileset. Only used in case of isometric orientation, to determine how tile overlays for terrain an collision information are rendered.

Width of a grid cell. Only used in case of isometric orientation, to determine how tile overlays for terrain an collision information are rendered.

Height of a grid cell. Only used in case of isometric orientation, to determine how tile overlays for terrain an collision information are rendered.

The texture used to display tiles in this tileset. This is a shorthand of image.texture

Slopes in this tileset or null if there is no slope.

A shorthand to set tileWidth and tileHeight

Get the global id from the given column and row coordinates in the tileset.

Gets the column position of a tile within this tileset from its global ID.

Gets the row position of a tile within this tileset from its global ID.

Add a slope to this tileset.

Private Members #

A mapping to access a given slope by it's tile index without having to walk through the whole slope array

Internal: true if TilesetImage instance was created implicitly from assigning a texture object.

Event when ldtkTileset field changes.

Event when firstGid field changes.

Event when name field changes.

Event when tileWidth field changes.

Event when tileHeight field changes.

Event when spacing field changes.

Event when margin field changes.

Event when tileCount field changes.

Event when columns field changes.

Event when rows field changes.

Event when image field changes.

Event when gridOrientation field changes.

Event when gridCellWidth field changes.

Event when gridCellHeight field changes.

Event when slopes field changes.

Metadata #