TilemapParser

Universal tilemap parser supporting multiple tilemap formats.

TilemapParser provides a unified interface for parsing different tilemap file formats and converting them to Ceramic's TilemapData structure. Currently supports TMX (Tiled Map Editor) format, with optional LDtk support when the ldtk plugin is enabled.

Features #

• TMX Support: Full parsing of Tiled Map Editor (.tmx) files
• TSX Support: External tileset (.tsx) file loading
• LDtk Support: Level Designer Toolkit parsing (requires ldtk plugin)
• Tileset Caching: Automatically caches parsed tilesets for performance
• Texture Loading: Supports custom texture loading callbacks

Usage Example #

var parser = new TilemapParser();

// Parse TMX file
var tmxMap = parser.parseTmx(tmxContent);

// Convert to TilemapData with texture loading
var tilemapData = parser.tmxMapToTilemapData(tmxMap,
    (source, configureAsset, done) -> {
        // Load texture from source path
        var texture = assets.texture(source);
        done(texture);
    }
);

// Apply to tilemap
var tilemap = new Tilemap();
tilemap.tilemapData = tilemapData;

Instance Members #

Parse LDtk file

Clear cached data (if any). Only tileset data is cached because it can be shared between maps. Normally not needed to clear manually unless working with a lot of different tilesets.

Parse TMX Tilemap (Tiled Map Editor format)

Extracts the names of all external tileset files referenced in a TMX file. This is useful for pre-loading TSX files before parsing the main TMX.

Converts a parsed TMX map to Ceramic's TilemapData format. This method handles the conversion of all map properties, tilesets, and layers.

Creates a new tilemap parser instance.

Private Members #

Internal TMX parser instance, created lazily when needed.

Internal LDtk parser instance, created lazily when needed.