The client-side Combat document which extends the common BaseCombat model.
Track the sorted turn order of this combat encounter
The configuration setting used to record Combat preferences
Get the Combatant who has the current turn.
Get the Combatant who has the next turn.
Return the object of settings which modify the Combat Tracker behavior
Has this combat encounter been started?
Is this combat active in the current scene?
Set the current Combat encounter as active within the Scene. Deactivate all other Combat encounters within the viewed Scene and set this one as active
Get a Combatant using its Token id
The id of the Token for which to acquire the combatant
Get a Combatant using its Actor id
The id of the Actor for which to acquire the combatant
Begin the combat encounter, advancing to round 1 and turn 1
Advance the combat to the next round
Rewind the combat to the previous round
Advance the combat to the next turn
Rewind the combat to the previous turn
Display a dialog querying the GM whether they wish to end the combat encounter and empty the tracker
Toggle whether this combat is linked to the scene or globally available.
Reset all combatant initiative scores, setting the turn back to zero
Roll initiative for one or multiple Combatants within the Combat document
A Combatant id or Array of ids for which to roll
Additional options which modify how initiative rolls are created or presented.
A promise which resolves to the updated Combat document once updates are complete.
Roll initiative for all combatants which have not already rolled
Roll initiative for all non-player actors who have not already rolled
Assign initiative for a single Combatant within the Combat encounter. Update the Combat turn order to maintain the same combatant as the current turn.
The combatant ID for which to set initiative
A specific initiative value to set
Return the Array of combatants sorted into initiative order, breaking ties alphabetically by name.
Update active effect durations for all actors present in this Combat encounter.
Define how the array of Combatants is sorted in the displayed list of the tracker. This method can be overridden by a system or module which needs to display combatants in an alternative order. The default sorting rules sort in descending order of initiative using combatant IDs for tiebreakers.
Loads the registered Combat Theme (if any) and plays the requested type of sound. If multiple exist for that type, one is chosen at random.
One of [ "startEncounter", "nextUp", "yourTurn" ]