Tile
A piece of scenery placed on a Map.
Where a Token is a creature, a tile is everything else drawn on the map: furniture, doors,
props, decals, overlays. Tiles are free-form — positioned and sized in pixels rather than grid
cells, layered by layer and zIndex, and optionally animated or tinted through
components.
A tile can also carry a light, which is how a torch sconce or brazier both appears on the
map and illuminates it, and a reference, which makes it tappable to open a page or entity.
- SeeAlso:
Map,Asset,Component,Light
| Property | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | The unique identifier for this tile. A UUID string automatically generated when the tile is created. This serves as the primary key in the Realm database. |
x |
integer |
Yes | The tile’s horizontal position in map coordinates. SeeAlso: position |
y |
integer |
Yes | The tile’s vertical position in map coordinates. |
width |
integer |
Yes | The tile’s width in pixels. Note: Tiles are sized freely rather than snapped to the grid. |
height |
integer |
Yes | The tile’s height in pixels. |
rotation |
integer |
Yes | The tile’s rotation, in degrees. |
opacity |
number |
Yes | The tile’s opacity, from 0 to 1. |
scale |
number |
Yes | A uniform scale applied to the tile’s artwork. |
layer |
string |
No | Which map layer the tile is drawn on, as the raw value of a BattleMapLayer. Determines whether the tile sits under the tokens (floor scenery) or over them (roofs, overlays). Use layerValue for the typed form. |
zIndex |
integer |
Yes | The tile’s draw order within its layer. Higher values draw on top. |
hidden |
boolean |
Yes | Whether the tile is concealed from the players. |
locked |
boolean |
Yes | Whether the tile is protected from being moved or edited on the map. |
asset |
Asset | No | The artwork drawn for this tile. SeeAlso: Asset |
light |
Light | No | A light source attached to this tile. Lets scenery illuminate the map — a torch that both looks and behaves like one. SeeAlso: Light |
reference |
string |
No | A soft link to content this tile opens when tapped. Examples: "/page/goblin-ambush"; "/map/cragmaw-hideout" SeeAlso: referenceURL, linkedObject |
components |
Array<Component> | Yes | Filters and animations applied to the tile’s artwork. SeeAlso: Component |