Skip to content

StatusEffect

A condition or ongoing effect on a Combatant.

Status effects cover everything that temporarily changes a creature: conditions like poisoned or stunned, buffs like blessed or hasted, and spell effects with a duration. Each carries its own modifiers, which are applied on top of the combatant’s context alongside the combatant’s own — so an effect can change armor class or speed for as long as it lasts.

Duration is expressed relative to a turn rather than as a countdown: durationType names the moment the effect ends and roundStart/turnStart record when it began, so the tracker can tell when that moment arrives regardless of how initiative shifts.

The token drawn on the map picks these up through Token/effects, which reads them from the combatant.

  • SeeAlso: Combatant, Modifier, Token

View JSON Schema

Property Type Required Description
id string Yes The unique identifier for this effect. A UUID string generated when the effect is created. Embedded objects have no primary key, so this is indexed instead.
name string No The effect’s display name.
Examples: "Poisoned", "Blessed"
type string No The effect’s category within the loaded system.
Examples: "condition", "buff", "debuff"
reference string No A soft link to the Entity describing this effect. Lets an effect carry the full rules text of the condition or spell it came from.
Examples: "/condition/poisoned"; "/spell/bless" SeeAlso: referenceURL, entity
duration number No How long the effect lasts, in durationUnit. Applies when durationType is DurationType/time.
durationUnit string No The unit duration is counted in, as the raw value of a DurationUnit.
Examples: "round", "minute", "hour", "day"
durationType string No When the effect expires, as the raw value of a DurationType.
Examples: "targetEndNextTurn", "time"
descr string No The effect’s rules text.
notes string No Game-master notes on this instance of the effect.
color string No The effect’s color, as an RGB string. Used for the badge drawn on the token.
icon string No The icon representing the effect on the token and in the combatant list.
source string No The creature or ability that applied this effect. Anchors the source-relative DurationType cases — an effect ending on its caster’s next turn needs to know whose turn that is.
roundStart integer No The combat round the effect was applied in. SeeAlso: Game/round
turnStart integer No The turn within roundStart that the effect was applied on. SeeAlso: Game/turn
enabled boolean No Whether the effect is currently in force. Lets an effect be suspended — kept on the creature but not applied — without removing it.
data Object No Flexible JSON storage for system-specific or arbitrary structured data. Note: The structure of this data varies by game system.
attributes Object Yes Dynamic attribute storage supporting various data types.
modifiers Array<Modifier> Yes The adjustments this effect applies while it lasts.
Examples: -2 to attack rolls while poisoned; +1 to AC and saves while blessed SeeAlso: Modifier, Combatant/activeModifiers

When a StatusEffect expires.

Type: string — one of:

  • sourceStartNextTurn
  • sourceEndNextTurn
  • targetStartNextTurn
  • targetEndNextTurn
  • time

The unit a StatusEffect’s duration is counted in.

Type: string — one of:

  • round
  • minute
  • hour
  • day