Measurement
A distance measurement drawn on a Map.
Measurements are the persistent form of the ruler tool — a path left on the map so a planned
move or a spell’s reach stays visible. Their type decides how the distance along that path
is counted.
- SeeAlso:
Map,MeasurementType
| Property | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | The unique identifier for this measurement. A UUID string automatically generated when the measurement is created. This serves as the primary key in the Realm database. |
type |
string |
Yes | How the distance is counted, as the raw value of a MeasurementType. Use typeValue for the typed form. Examples: "grid", "precise" |
color |
string |
Yes | The measurement’s color, as an RGB string. |
hidden |
boolean |
Yes | Whether the measurement is concealed from the players. |
data |
Array<integer> |
Yes | The measured path’s vertices, as a flat list of alternating x and y coordinates. Stored flat rather than as points, matching Wall/data. Examples: [100, 200, 340, 200] — a straight measurement between two points SeeAlso: points |
MeasurementType
Section titled “MeasurementType”How a Measurement’s distance is counted.
Type: string — one of:
gridprecise