Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...
    interface CombatData {
        _id: string | null;
        _stats: DocumentStats;
        active?: boolean;
        combatants: CombatantData[];
        flags: DocumentFlags;
        groups: CombatantGroupData[];
        round?: number;
        scene: string;
        sort?: number;
        system?: object;
        turn?: number | null;
        type: string;
    }
    Index

    Properties

    _id: string | null

    The _id which uniquely identifies this Combat document

    An object of creation and access information

    active?: boolean

    Is the Combat encounter currently active?

    combatants: CombatantData[]

    A Collection of Combatant embedded Documents

    An object of optional key/value flags

    A Collection of Documents that represent a grouping of individual Combatants.

    round?: number

    The current round of the Combat encounter

    scene: string

    The _id of a Scene within which this Combat occurs

    sort?: number

    The current sort order of this Combat relative to others in the same Scene

    system?: object

    Game system data which is defined by system data models.

    turn?: number | null

    The current turn in the Combat round

    type: string

    The type of this Combat.