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

    Interface CombatantGroupData

    interface CombatantGroupData {
        _id: string | null;
        _stats: DocumentStats;
        flags: DocumentFlags;
        img?: string;
        initiative?: number;
        name?: string;
        ownership?: object;
        system?: object;
        type: string;
    }
    Index

    Properties

    _id _stats flags img? initiative? name? ownership? system? type

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this CombatantGroup embedded document.

    _stats

    _stats: DocumentStats

    An object of creation and access information.

    flags: DocumentFlags

    An object of optional key/value flags.

    img?: string

    A customized image which replaces the inferred group image.

    initiative?: number

    The initiative value that will be used for all group members.

    name?: string

    A customized name which replaces the inferred group name.

    ownership?: object

    An object which configures ownership of this group.

    system?: object

    Game system data which is defined by system data models.

    type: string

    The type of this CombatantGroup.

    Settings

    Member Visibility

    On This Page

    Properties