Xivgear Types Documentation
    Preparing search index...
    type CooldownStatus = {
        capped: boolean;
        cappedAt: { absolute: number; relative: number };
        currentCharges: number;
        readyAt: { absolute: number; relative: number };
        readyToUse: boolean;
    }
    Index

    Properties

    capped: boolean

    Whether the cooldown is capped. For normal cooldowns, this is the same as readyToUse. For charges, this is when it will be fully capped.

    cappedAt: { absolute: number; relative: number }

    When the cooldown will be capped. For normal cooldowns, this is the same as readyAt. For charge-based abilities, this is when it is fully capped.

    currentCharges: number

    The current charge count. For non-charge abilities, this will only ever be 1 or 0.

    readyAt: { absolute: number; relative: number }

    When the cooldown will be ready, or already became ready to use. For normal cooldowns, this is when it will be off CD. For charge abilities, this is when it will have at least one charge. If it is already ready, this will return the current time.

    readyToUse: boolean

    Whether the cooldown is ready to use. For normal cooldowns, this means it is off CD. For charge abilities, this means it has at least one charge.