Skip to content

Pin

A Pin is a special Map element. Pins represent a single element on a single Map, indicating its position in that particular world view.

Pins place elements on a map. They interact with:

  • Maps (Pins exist on only one map at a time)
  • Elements (Pins locate a single element on a Map)

They are distinct from:

  • Markers (which define a Zone on a Map)

Pin discussions on GitHub

Field Type Description
map link to Map Map that the pin is placed on
element_type text: one of the 22 type names The type of the linked element, any of the 22
element_id id of an element of that type The id of the linked element
x integer x coordinate, from bottom left of the map
y integer y coordinate, from bottom left of the map
z integer z coordinate, in case of depth (optional)