Type Alias EncounterCombatantSettings

Settings related to a combatant in the Encounter Sheet combat tab.

type EncounterCombatantSettings = {
    identifier: string;
    include: boolean;
    initiative: number | undefined;
    visible: boolean;
}

Properties

identifier: string

A unique identifier for retrieving/storing settings. Dots "." are replaced with hyphens "-" on storage and are reverted on retrieval.

include: boolean

When true, include this combatant when adding placeholders to the current encounter. Default: true

initiative: number | undefined

Optional prerolled/prefilled initiative count which is included when adding a combatant to the combat tracker.

visible: boolean

When false, this combatant is added to the combat tracker as hidden. Default: true (visible)