AreaEffect
A marked-out area on a Map — a spell template or zone.
Area effects are the geometry side of abilities that cover ground: a fireball’s sphere, a
breath weapon’s cone, a wall of fire’s line. Which of radius, length, width and
angle apply depends on the shape.
Unlike an Aura, an area effect is anchored to the map rather than to a creature — though it
can record the token that produced it in source.
- SeeAlso:
Map,Aura,Shape
| Property | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | The unique identifier for this area effect. A UUID string automatically generated when the effect is created. This serves as the primary key in the Realm database. |
shape |
string |
Yes | The effect’s geometry, as the raw value of a Shape. Determines which of the dimension fields apply. Use shapeValue for the typed form. Examples: "sphere", "cone", "line", "cube", "cylinder", "square" |
color |
string |
Yes | The effect’s fill color, as an RGB string. Examples: "#ff6600" — fire |
x |
integer |
Yes | The effect’s origin, horizontally, in map coordinates. SeeAlso: start |
y |
integer |
Yes | The effect’s origin, vertically, in map coordinates. |
zIndex |
integer |
Yes | The effect’s draw order among other area effects. Higher values draw on top. |
opacity |
number |
Yes | The effect’s opacity, from 0 to 1. |
angle |
number |
Yes | The direction the effect is aimed, in radians. Applies to Shape/cone and Shape/line. |
radius |
number |
Yes | The effect’s radius, in map coordinates. Applies to Shape/sphere and Shape/cylinder. |
length |
number |
Yes | The effect’s reach from its origin, in map coordinates. Applies to Shape/cone and Shape/line. |
width |
number |
Yes | The effect’s cross-measure, in map coordinates. Applies to Shape/line, Shape/cube and Shape/square. |
asset |
Asset | No | Artwork drawn in place of a plain filled shape. SeeAlso: Asset |
source |
Token | No | The token that produced this effect, if any. Records who cast the spell; the effect itself stays anchored to the map. SeeAlso: Token |
reference |
string |
No | A soft link to the content this effect comes from. Examples: "/spell/fireball" SeeAlso: referenceURL |
hidden |
boolean |
Yes | Whether the effect is concealed from the players. |
locked |
boolean |
Yes | Whether the effect is protected from being moved or edited on the map. |
components |
Array<Component> | Yes | Filters and animations applied to the effect’s artwork. SeeAlso: Component |
The geometry of an AreaEffect.
Type: string — one of:
conecubecylinderlinesquaresphere