Read a Tiled map summary
tiled_get_map_summaryRead map dimensions, metadata, layer tree, and external tileset ids from Tiled TMJ/TSJ files before editing. Supports infinite, isometric, and XML maps with read-only summaries.
Instructions
Reads dimensions, normalized root render/background/class metadata, revision, layer tree and external tileset identities before editing. Embedded (inline) atlas tilesets are listed separately with their tilesets[] index and GID range; they are pinned by the map revision and stay read-only. Infinite maps are readable too: the summary reports infinite:true, chunked tile-layer content bounds with startX/startY, and a read-only profile marker; isometric maps likewise return a read-only profile (tile data and GIDs are storage-identical to orthogonal), while staggered and hexagonal maps stay rejected. XML maps (.tmx) return a bounded read-only summary through a fail-closed XML subset reader — layer tree with data encodings, external tileset references resolved with per-file existence and revision pins, and an editable:false marker; TMX never reaches any edit planner.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mapPath | Yes | Canonical project-relative POSIX path; absolute paths and .. are forbidden |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |