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

    Variable CombatConst

    Combat: {
        collection: typeof CombatEncounters;
        dataModels: Record<string, typeof TypeDataModel>;
        documentClass: typeof documents.Combat;
        embedHandlers: DocumentEmbedHandler[];
        fallbackTurnMarker: string;
        initiative: { decimals: number; formula: null };
        initiativeIcon: { hover: string; icon: string };
        settings: CombatConfiguration;
        sidebarIcon: string;
        sounds: {
            epic: {
                label: string;
                nextUp: string[];
                startEncounter: string[];
                yourTurn: string[];
            };
            mc: {
                label: string;
                nextUp: string[];
                startEncounter: string[];
                yourTurn: string[];
            };
        };
        typeHints: Record<string, string>;
        typeIcons: Record<string, string>;
        typeLabels: Record<string, string>;
    } = ...

    Configuration for the Combat document

    Type Declaration

    • collection: typeof CombatEncounters
    • dataModels: Record<string, typeof TypeDataModel>
    • documentClass: typeof documents.Combat
    • embedHandlers: DocumentEmbedHandler[]
    • fallbackTurnMarker: string
    • initiative: { decimals: number; formula: null }
    • initiativeIcon: { hover: string; icon: string }
    • settings: CombatConfiguration
    • sidebarIcon: string
    • sounds: {
          epic: {
              label: string;
              nextUp: string[];
              startEncounter: string[];
              yourTurn: string[];
          };
          mc: {
              label: string;
              nextUp: string[];
              startEncounter: string[];
              yourTurn: string[];
          };
      }
    • typeHints: Record<string, string>
    • typeIcons: Record<string, string>
    • typeLabels: Record<string, string>