[Go to site: main page, start]

Interface ActiveEffectDuration

interface ActiveEffectDuration {
    _combatTime?: number;
    _worldTime?: number;
    expired: boolean;
    expiry: string | null;
    label: string;
    remaining: number;
    seconds: number | null;
    secondsRemaining?: number;
    units:
        | "years"
        | "months"
        | "days"
        | "hours"
        | "minutes"
        | "seconds"
        | "rounds"
        | "turns";
    value: number
    | null;
}
Index

Properties

_combatTime?: number

An internal flag used determine when to recompute turns-based duration

_worldTime?: number

An internal flag used determine when to recompute seconds-based duration

expired: boolean

Is this ActiveEffect expired?

expiry: string | null

An identifier of an event at which the Effect will expire: expiration occurs when both the end of the duration and the expiry event are reached. A truly indefinite duration is one in which both duration value and expiry are null.

label: string

A formatted string label that represents the remaining duration

remaining: number

The remaining effect duration in a quantity of the configured unit

seconds: number | null

The total duration in seconds

secondsRemaining?: number

The remaining effect duration in seconds, given it is possible to express

units:
    | "years"
    | "months"
    | "days"
    | "hours"
    | "minutes"
    | "seconds"
    | "rounds"
    | "turns"

The time- or combat-based unit of the duration value

value: number | null

The maximum duration of the Effect in the quantity of the unit, with null being initialized to Infinity