Light
A light source on a Map.
Lights matter when Map/lineOfSight is on: they illuminate the wall-bounded areas around
them, which together with each token’s own Vision decides what the players can see.
Light falls off in two steps rather than smoothly — full brightness out to radiusMin, dim
light to radiusMax — matching how tabletop rules describe torches and lanterns.
A light is either placed directly on the map through Map/lights or attached to a
Tile, in which case it moves with the scenery.
- SeeAlso:
Map,Tile,Vision
| Property | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | The unique identifier for this light. A UUID string automatically generated when the light is created. This serves as the primary key in the Realm database. |
enabled |
boolean |
Yes | Whether the light is lit. Lets a source be extinguished without deleting it — a torch that can be put out. |
radiusMin |
integer |
Yes | The radius of bright light, in grid units. Examples: 20 — a torch’s bright radius in feet |
radiusMax |
integer |
Yes | The radius of dim light, in grid units. Beyond this the light contributes nothing. |
color |
string |
Yes | The light’s color, as an RGB string. Examples: "#ffffff" — neutral; "#ff9944" — firelight |
opacity |
number |
Yes | How strongly the light’s color tints the map, from 0 to 1. |
alwaysVisible |
boolean |
Yes | Whether the light is shown even where the players cannot see it. Lets a distant campfire or lit window be visible across an unexplored map. |
x |
integer |
Yes | The light’s horizontal position in map coordinates. SeeAlso: position |
y |
integer |
Yes | The light’s vertical position in map coordinates. |
sight |
any |
Yes |