Token Status Effects

Mod developers may want to customize the set of status effects which can be applied to tokens. The game system provides the flexibility to accomplish this by interacting with the TokenEffects() class.

class TokenEffects()

A singleton canvas element which allows the player to assign status effect icons to tokens they control. Whenever a player wants to assign status effect icons to a token we just reposition the same container.

Mod developers can customize the set of icons which are valid token status effects by altering the CONFIG.STATUS_EFFECTS Array.

TokenEffects.activate(token)

Activate the TokenEffects ui and display it next to the specified token. Set the token that the interface is actively modifying to direct click events on the effect icons.

Arguments:
  • token (Token) – The Token next to which the status effects icons should be displayed
TokenEffects.deactivate(token)

Hide the TokenEffects container from view and unset the active token that it modifies.