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

    Variable ActiveEffectConst

    ActiveEffect: {
        changeTypes: Record<string, ActiveEffectChangeTypeConfig>;
        dataModels: Record<string, typeof ActiveEffectTypeDataModel>;
        defaultType: string;
        documentClass: typeof documents.ActiveEffect;
        embedHandlers: DocumentEmbedHandler[];
        expiryAction: "update" | "delete" | null;
        expiryEvents: Record<string, string>;
        phases: Record<string, { hint: string; label: string }>;
        sidebarIcon: string;
        typeHints: Record<string, string>;
        typeIcons: Record<string, string>;
        typeLabels: Record<string, string>;
    } = ...

    Configuration for the ActiveEffect embedded document type

    Type Declaration

    • changeTypes: Record<string, ActiveEffectChangeTypeConfig>
    • dataModels: Record<string, typeof ActiveEffectTypeDataModel>
    • defaultType: string
    • documentClass: typeof documents.ActiveEffect
    • embedHandlers: DocumentEmbedHandler[]
    • expiryAction: "update" | "delete" | null

      The action taken by the ActiveEffectRegistry upon an ActiveEffect's expiration. An update action will set the value of ActiveEffectDuration#expired.

    • expiryEvents: Record<string, string>

      Additional expiry events registered by packages, with the key of each entry being an identifier and the value a label. Such events must be triggered by calling documents.ActiveEffect.registry.refresh. If an expiry event happens in tandem with advancing world time, the advancement must be done before notifying the registry of the custom event.

    • phases: Record<string, { hint: string; label: string }>

      Additional change phases registered by packages. Actor#applyActiveEffects must be called by introducing packages at the desired points in data preparation or on certain events.

    • sidebarIcon: string
    • typeHints: Record<string, string>
    • typeIcons: Record<string, string>
    • typeLabels: Record<string, string>