Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface CombatantData

    interface CombatantData {
        _id: string | null;
        _stats: DocumentStats;
        actorId?: string;
        defeated?: boolean;
        flags: DocumentFlags;
        group?: string;
        hidden?: boolean;
        img?: string;
        initiative?: number;
        name?: string;
        system?: object;
        tokenId?: string;
        type: string;
    }
    Index

    Properties

    _id _stats actorId? defeated? flags group? hidden? img? initiative? name? system? tokenId? type

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this Combatant embedded document

    _stats

    _stats: DocumentStats

    An object of creation and access information.

    actorId?: string

    The _id of an Actor associated with this Combatant

    defeated?: boolean

    Has this Combatant been defeated?

    flags: DocumentFlags

    An object of optional key/value flags

    group?: string

    An optional group this Combatant belongs to.

    hidden?: boolean

    Is this Combatant currently hidden?

    img?: string

    A customized image which replaces the Token image in the tracker

    initiative?: number

    The initiative score for the Combatant which determines its turn order

    name?: string

    A customized name which replaces the name of the Token in the tracker

    system?: object

    Game system data which is defined by system data models.

    tokenId?: string

    The _id of a Token associated with this Combatant

    type: string

    The type of this Combatant.

    Settings

    Member Visibility

    On This Page

    Properties