GRID CARTOGRAPHER 4
Shortcuts

Element Reference

2019-04-12

This document contains an alphabetical reference of all elements that can be part of the exported XML document. Not all elements will always be included, check the individual descriptions for more details.

<bounds>

Defines the maximum bound of tiles on this floor. This element is not included for tile map planes, see <mapsize>.

Attribute Meaning
x0 The x co-ordinate of the left-most occupied tile.
y0 The y co-ordinate of the top or bottom most occupied tile as defined by the co-ordinate space specified by the origin attribute of the <setup> element.
width The number of tiles in each row.
height The number of rows from y0 to the last occupied row on this floor.

<c>

A single tilemap cell. These are present under <plane> elements. Note: All attributes are optional and if not present are assumed to be zero (unless otherwise specified).

Attribute Meaning
i The index of the custom tile used by this cell. A value from 0 to 7999. Only color custom tiles can be used with tilemaps. This attribute will be omitted for empty cells and the cell can be interpreted as having an empty or default appearance if required.
sp A string of characters that indicate special attribute flags assigned to this tile. Multiple characters can be present and will always appear in the order listed. Meanings are:\n • h Tile is horizontally flipped (custom tiles only).\n • v Tile is vertically flipped (custom tiles only).

<color>

Additional information about color custom tiles is stored within this element. If there aren't any custom tiles of this type then the element is omitted.

<custom>

Container element for custom tile information. If no custom tiles have been added to the map then this element is omitted.

<entry>

Describes a color palette entry.

Attribute Meaning
i The index number of the palette entry.
rgb The color value of the entry expressed in HTML notation #RRGGBB.
edit If set to 1 this indicates a color that has been edited.

<export>

Records the date, time and version number of Grid Cartographer used when the document was exported. It has the following attributes:

Attribute Meaning
from The friendly version number of Grid Cartographer used to export the document. This takes the form v#.#.#.
build The build number of Grid Cartographer used to export the document. This is guaranteed to increase with each version of the software and can be used for comparisons.
date The date of export in YYYY-MM-DD format.
time The (local) time of export in HH:MM:SS format.

<floor>

Attribute Meaning
index The number of the floor. Negative values are basements, zero is the ground floor and positive values are the floors above.

Note: A completely empty floor will not be exported. Take care to use the index attribute to correctly identify a floor's position.

<map>

This is the root container element of the document.

<mapsize>

Defines the size of all planes in a tilemap.

Attribute Meaning
width The number of tiles in each row.
height The number of rows.

Note: This element is only present on a tilemap, see the <bounds> element to determine the size of a floor in a region.

<name>

Either:

The name of a region or tilemap (UTF-8 encoded) is stored in a child CDATA element.

Or:

If the floor or plane name has been changed, this element stores its name (UTF-8 encoded) in a child CDATA element.

<monochrome>

Additional information about monochrome custom tiles is stored within this element. If there aren't any custom tiles of this type then the element is omitted.

<notes>

Container element for notes on a floor. If no notes were created this element will be omitted.

<note>

Notes can be added to each map floor/plane, one per grid tile. This element represents one of those notes. Notes are not exported in any particular order. Note elements have the following attributes:

Attribute Meaning
x The X co-ordinate of the note.
y The Y co-ordinate of the note given in the co-ordinate space specified by the origin attribute of the <setup> element.

The text itself is stored in a child CDATA element of the <note> element.

<plane>

Attribute Meaning
index The index of the plane. Plane indices start at 1.

Note: Even a completely empty plane will still be exported (unlike <floor> elements).

<palette>

Container element for palette entries used by this map. This element is present only if the user checks the Include Color Palette option on the Export Data menu.

<region>

This is the container element for a standard map region. Multiple regions are supported by the editor within one map file. Each region has the following attributes:

Attribute Meaning
floors The floor count of this region. Excluding ground floor if disabled.
lowest_floor The index of the lowest floor. Negative values are basements.
grid_shape The shape of the grid used for all floors in this region. The value can be one of: square, hexh or hexv.

<row>

Contains one row on this floor or tile map plane. If this row is part of a floor then it will be omitted if it contains no tiles. Tile map rows are always exported.

Attribute Meaning
y The y co-ordinate of the row in the co-ordinate space specified by the origin attribute of the <setup> element.

<setup>

Provides information about the map setup. It has the following attributes:

Attribute Meaning
origin Either tl or bl which, respectively, specify either a top-left or bottom-left grid origin.

<t>

Data for a single tile on a standard map region (not a tilemap).

Attribute Meaning
m A standard marker is present. See the marker table for the full list of supported icons.
msub Marker sub-data. This is only present for some marker types. See the corresponding entry in the marker table for further details.
mcm A custom monochrome marker is present. This is a value from 0 to 7999 corresponding to the index of the custom tile used in the monochrome list. See the <custom> element for more information.
mcc A custom color marker is present. This is a value from 0 to 7999 corresponding to the index of the custom tile used in the color list. See the <custom> element for more information.
mc The color of the marker layer. This is a palette index from 0 to 255. See the <palette> element below for more information. Note that color custom markers are not tinted and should ignore this value.
t A standard terrain type is present. See the terrain table for the full list of supported terrain types.
tcm A custom monochrome terrain is present. This is a value from 0 to 7999 corresponding to the index of the custom tile used in the monochrome list. See the <custom> element for more information.
tcc A custom color terrain is present. This is a value from 0 to 7999 corresponding to the index of the custom tile used in the color list. See the <custom> element for more information.
tc The color of the terrain layer. This is a palette index from 0 to 255. See the <palette> element section below for more information. Note that color custom terrain is not tinted and should ignore this value.
r The style of the R edge of this tile. See the edge table for the full list. Also see the tile data model document for the location of the R edge on the grid shape used.
i The style of the I edge of this tile. See the edge table for the full list. Also see the tile data model document for the location of the I edge on the grid shape used.
b The style of the B edge of this tile. See the edge table for the full list. Also see the tile data model document for the location of the B edge on the grid shape used.
rc The color of the R edge. This is a palette index from 0 to 255. See the <palette> element section below for more information. See the tile data model document for the location of the R edge for the grid shape used.
ic The color of the I edge. This is a palette index from 0 to 255. See the <palette> element section below for more information. See the tile data model document for the location of the I edge for the grid shape used.
bc The color of the B edge. This is a palette index from 0 to 255. See the <palette> element section below for more information. See the tile data model document for the location of the B edge for the grid shape used.
d If set to 1 this signifies the tile is dark.
fx A value composed from characters r, g and/or b that specify which of the three colored FX flags have been assigned to this tile. Multiple characters can be present and assigned to the tile.
c If set to 1 this signifies the tile has a ceiling.
sp A string of characters that indicate special attribute flags assigned to this tile. Multiple characters can be present and will always appear in the order listed. Meanings are:\n • h Tile is horizontally flipped (custom tiles only).\n • v Tile is vertically flipped (custom tiles only).
snip If the terrain snipper tool has been used on this tile to remove some part of the ground, this element is present. It can have one of two values: tl or br which represent whether the top/left or bottom/right of the tile is still visible.

<tile>

Describes a single custom tile added to the map.

Attribute Meaning
index The index number of the custom tile. See the <t> element which references this value with its mcm, mcc, tcm or tcc attributes.
width The width, in pixels, of the custom tile image.
height The height, in pixels, of the custom tile image.
unused If set to 1 this signifies that the custom tile is available but is not current used on any of the map floors.

The name of the custom tile is stored as a child CDATA element. The default name for a custom tile is the original file name of the imported image (including extension).

<tilemap>

This is the container element for a tilemap. Multiple tilemaps are supported by the editor within one map file. Each tilemap element has the following attributes:

Attribute Meaning
planes The number of planes in this tilemap.
lowest_plane The index of the lowest plane in the stack. Plane indices start at 1.
grid_shape The shape of the tilemap grid. Reserved for future expansion. As of this version, the value will always be square.

<tiles>

Container for tiles on this floor/plane. Floors, if no tiles are present, will omit this element. Planes will always include this element.