Xivgear Types Documentation
    Preparing search index...

    Used ability definition with added extra data. Used in the GUI.

    interface MchPreDmgUsedAbility {
        ability:
            | Readonly<
                {
                    _idForCooldown?: number;
                    activatesBuffs?: readonly Buff[];
                    alternativeScalings?: AlternativeScaling[];
                    animationLock?: number;
                    appDelay?: number;
                    attackType: | "Unknown"
                    | "Auto-attack"
                    | "Spell"
                    | "Weaponskill"
                    | "Ability"
                    | "Item";
                    buffApplicationDelay?: number;
                    cast?: number;
                    combos?: readonly ComboData[];
                    cooldown?: Cooldown;
                    fixedGcd?: boolean;
                    id: number;
                    itemId?: number;
                    name: string;
                    noIcon?: boolean;
                    translate?: boolean;
                } & {
                    levelModifiers?: LevelModifier<
                        {
                            _idForCooldown?: number;
                            activatesBuffs?: readonly Buff[];
                            alternativeScalings?: AlternativeScaling[];
                            animationLock?: number;
                            appDelay?: number;
                            attackType: | "Unknown"
                            | "Auto-attack"
                            | "Spell"
                            | "Weaponskill"
                            | "Ability"
                            | "Item";
                            buffApplicationDelay?: number;
                            cast?: number;
                            combos?: readonly ComboData[];
                            cooldown?: Cooldown;
                            fixedGcd?: boolean;
                            id: number;
                            itemId?: number;
                            name: string;
                            noIcon?: boolean;
                            translate?: boolean;
                        },
                    >[];
                } & Readonly<{ potency: null }> & {
                    levelModifiers?: LevelModifier<Readonly<{ potency: null }>>[];
                },
            > & Readonly<LevelModifiable<{ gcd: number; type: "gcd" }>>
            | Readonly<
                {
                    _idForCooldown?: number;
                    activatesBuffs?: readonly Buff[];
                    alternativeScalings?: AlternativeScaling[];
                    animationLock?: number;
                    appDelay?: number;
                    attackType: | "Unknown"
                    | "Auto-attack"
                    | "Spell"
                    | "Weaponskill"
                    | "Ability"
                    | "Item";
                    buffApplicationDelay?: number;
                    cast?: number;
                    combos?: readonly ComboData[];
                    cooldown?: Cooldown;
                    fixedGcd?: boolean;
                    id: number;
                    itemId?: number;
                    name: string;
                    noIcon?: boolean;
                    translate?: boolean;
                } & {
                    levelModifiers?: LevelModifier<
                        {
                            _idForCooldown?: number;
                            activatesBuffs?: readonly Buff[];
                            alternativeScalings?: AlternativeScaling[];
                            animationLock?: number;
                            appDelay?: number;
                            attackType: | "Unknown"
                            | "Auto-attack"
                            | "Spell"
                            | "Weaponskill"
                            | "Ability"
                            | "Item";
                            buffApplicationDelay?: number;
                            cast?: number;
                            combos?: readonly ComboData[];
                            cooldown?: Cooldown;
                            fixedGcd?: boolean;
                            id: number;
                            itemId?: number;
                            name: string;
                            noIcon?: boolean;
                            translate?: boolean;
                        },
                    >[];
                } & Readonly<
                    {
                        alternativeScalings?: AlternativeScaling[];
                        attackType: | "Unknown"
                        | "Auto-attack"
                        | "Spell"
                        | "Weaponskill"
                        | "Ability"
                        | "Item";
                        autoCrit?: boolean;
                        autoDh?: boolean;
                        dot?: DotInfo;
                        potency: number;
                    },
                > & {
                    levelModifiers?: LevelModifier<
                        Readonly<
                            {
                                alternativeScalings?: AlternativeScaling[];
                                attackType: | "Unknown"
                                | "Auto-attack"
                                | "Spell"
                                | "Weaponskill"
                                | "Ability"
                                | "Item";
                                autoCrit?: boolean;
                                autoDh?: boolean;
                                dot?: DotInfo;
                                potency: number;
                            },
                        >,
                    >[];
                },
            > & Readonly<LevelModifiable<{ gcd: number; type: "gcd" }>>
            | Readonly<
                {
                    _idForCooldown?: number;
                    activatesBuffs?: readonly Buff[];
                    alternativeScalings?: AlternativeScaling[];
                    animationLock?: number;
                    appDelay?: number;
                    attackType: | "Unknown"
                    | "Auto-attack"
                    | "Spell"
                    | "Weaponskill"
                    | "Ability"
                    | "Item";
                    buffApplicationDelay?: number;
                    cast?: number;
                    combos?: readonly ComboData[];
                    cooldown?: Cooldown;
                    fixedGcd?: boolean;
                    id: number;
                    itemId?: number;
                    name: string;
                    noIcon?: boolean;
                    translate?: boolean;
                } & {
                    levelModifiers?: LevelModifier<
                        {
                            _idForCooldown?: number;
                            activatesBuffs?: readonly Buff[];
                            alternativeScalings?: AlternativeScaling[];
                            animationLock?: number;
                            appDelay?: number;
                            attackType: | "Unknown"
                            | "Auto-attack"
                            | "Spell"
                            | "Weaponskill"
                            | "Ability"
                            | "Item";
                            buffApplicationDelay?: number;
                            cast?: number;
                            combos?: readonly ComboData[];
                            cooldown?: Cooldown;
                            fixedGcd?: boolean;
                            id: number;
                            itemId?: number;
                            name: string;
                            noIcon?: boolean;
                            translate?: boolean;
                        },
                    >[];
                } & Readonly<{ potency: null }> & {
                    levelModifiers?: LevelModifier<Readonly<{ potency: null }>>[];
                },
            > & Readonly<LevelModifiable<{ type: "ogcd" }>>
            | Readonly<
                {
                    _idForCooldown?: number;
                    activatesBuffs?: readonly Buff[];
                    alternativeScalings?: AlternativeScaling[];
                    animationLock?: number;
                    appDelay?: number;
                    attackType: | "Unknown"
                    | "Auto-attack"
                    | "Spell"
                    | "Weaponskill"
                    | "Ability"
                    | "Item";
                    buffApplicationDelay?: number;
                    cast?: number;
                    combos?: readonly ComboData[];
                    cooldown?: Cooldown;
                    fixedGcd?: boolean;
                    id: number;
                    itemId?: number;
                    name: string;
                    noIcon?: boolean;
                    translate?: boolean;
                } & {
                    levelModifiers?: LevelModifier<
                        {
                            _idForCooldown?: number;
                            activatesBuffs?: readonly Buff[];
                            alternativeScalings?: AlternativeScaling[];
                            animationLock?: number;
                            appDelay?: number;
                            attackType: | "Unknown"
                            | "Auto-attack"
                            | "Spell"
                            | "Weaponskill"
                            | "Ability"
                            | "Item";
                            buffApplicationDelay?: number;
                            cast?: number;
                            combos?: readonly ComboData[];
                            cooldown?: Cooldown;
                            fixedGcd?: boolean;
                            id: number;
                            itemId?: number;
                            name: string;
                            noIcon?: boolean;
                            translate?: boolean;
                        },
                    >[];
                } & Readonly<
                    {
                        alternativeScalings?: AlternativeScaling[];
                        attackType: | "Unknown"
                        | "Auto-attack"
                        | "Spell"
                        | "Weaponskill"
                        | "Ability"
                        | "Item";
                        autoCrit?: boolean;
                        autoDh?: boolean;
                        dot?: DotInfo;
                        potency: number;
                    },
                > & {
                    levelModifiers?: LevelModifier<
                        Readonly<
                            {
                                alternativeScalings?: AlternativeScaling[];
                                attackType: | "Unknown"
                                | "Auto-attack"
                                | "Spell"
                                | "Weaponskill"
                                | "Ability"
                                | "Item";
                                autoCrit?: boolean;
                                autoDh?: boolean;
                                dot?: DotInfo;
                                potency: number;
                            },
                        >,
                    >[];
                },
            > & Readonly<LevelModifiable<{ type: "ogcd" }>>
            | never
            | Readonly<
                {
                    _idForCooldown?: number;
                    activatesBuffs?: readonly Buff[];
                    alternativeScalings?: AlternativeScaling[];
                    animationLock?: number;
                    appDelay?: number;
                    attackType: | "Unknown"
                    | "Auto-attack"
                    | "Spell"
                    | "Weaponskill"
                    | "Ability"
                    | "Item";
                    buffApplicationDelay?: number;
                    cast?: number;
                    combos?: readonly ComboData[];
                    cooldown?: Cooldown;
                    fixedGcd?: boolean;
                    id: number;
                    itemId?: number;
                    name: string;
                    noIcon?: boolean;
                    translate?: boolean;
                } & {
                    levelModifiers?: LevelModifier<
                        {
                            _idForCooldown?: number;
                            activatesBuffs?: readonly Buff[];
                            alternativeScalings?: AlternativeScaling[];
                            animationLock?: number;
                            appDelay?: number;
                            attackType: | "Unknown"
                            | "Auto-attack"
                            | "Spell"
                            | "Weaponskill"
                            | "Ability"
                            | "Item";
                            buffApplicationDelay?: number;
                            cast?: number;
                            combos?: readonly ComboData[];
                            cooldown?: Cooldown;
                            fixedGcd?: boolean;
                            id: number;
                            itemId?: number;
                            name: string;
                            noIcon?: boolean;
                            translate?: boolean;
                        },
                    >[];
                } & Readonly<
                    {
                        alternativeScalings?: AlternativeScaling[];
                        attackType: | "Unknown"
                        | "Auto-attack"
                        | "Spell"
                        | "Weaponskill"
                        | "Ability"
                        | "Item";
                        autoCrit?: boolean;
                        autoDh?: boolean;
                        dot?: DotInfo;
                        potency: number;
                    },
                > & {
                    levelModifiers?: LevelModifier<
                        Readonly<
                            {
                                alternativeScalings?: AlternativeScaling[];
                                attackType: | "Unknown"
                                | "Auto-attack"
                                | "Spell"
                                | "Weaponskill"
                                | "Ability"
                                | "Item";
                                autoCrit?: boolean;
                                autoDh?: boolean;
                                dot?: DotInfo;
                                potency: number;
                            },
                        >,
                    >[];
                },
            > & Readonly<
                {
                    alternativeScalings?: AlternativeScaling[];
                    attackType: | "Unknown"
                    | "Auto-attack"
                    | "Spell"
                    | "Weaponskill"
                    | "Ability"
                    | "Item";
                    autoCrit?: boolean;
                    autoDh?: boolean;
                    dot?: DotInfo;
                    potency: number;
                },
            > & Readonly<LevelModifiable<{ type: "autoattack" }>>;
        appDelay: number;
        appDelayFromStart: number;
        buffs: Buff[];
        castTimeFromStart: number;
        combinedEffects: CombinedBuffEffect;
        dot?: DotDamageUnf;
        extraData: { gauge: { battery: number; heat: number } };
        gaugeAfter: {};
        lockTime: number;
        snapshotTimeFromStart: number;
        totalTimeTaken: number;
        usedAt: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    ability:
        | Readonly<
            {
                _idForCooldown?: number;
                activatesBuffs?: readonly Buff[];
                alternativeScalings?: AlternativeScaling[];
                animationLock?: number;
                appDelay?: number;
                attackType: | "Unknown"
                | "Auto-attack"
                | "Spell"
                | "Weaponskill"
                | "Ability"
                | "Item";
                buffApplicationDelay?: number;
                cast?: number;
                combos?: readonly ComboData[];
                cooldown?: Cooldown;
                fixedGcd?: boolean;
                id: number;
                itemId?: number;
                name: string;
                noIcon?: boolean;
                translate?: boolean;
            } & {
                levelModifiers?: LevelModifier<
                    {
                        _idForCooldown?: number;
                        activatesBuffs?: readonly Buff[];
                        alternativeScalings?: AlternativeScaling[];
                        animationLock?: number;
                        appDelay?: number;
                        attackType: | "Unknown"
                        | "Auto-attack"
                        | "Spell"
                        | "Weaponskill"
                        | "Ability"
                        | "Item";
                        buffApplicationDelay?: number;
                        cast?: number;
                        combos?: readonly ComboData[];
                        cooldown?: Cooldown;
                        fixedGcd?: boolean;
                        id: number;
                        itemId?: number;
                        name: string;
                        noIcon?: boolean;
                        translate?: boolean;
                    },
                >[];
            } & Readonly<{ potency: null }> & {
                levelModifiers?: LevelModifier<Readonly<{ potency: null }>>[];
            },
        > & Readonly<LevelModifiable<{ gcd: number; type: "gcd" }>>
        | Readonly<
            {
                _idForCooldown?: number;
                activatesBuffs?: readonly Buff[];
                alternativeScalings?: AlternativeScaling[];
                animationLock?: number;
                appDelay?: number;
                attackType: | "Unknown"
                | "Auto-attack"
                | "Spell"
                | "Weaponskill"
                | "Ability"
                | "Item";
                buffApplicationDelay?: number;
                cast?: number;
                combos?: readonly ComboData[];
                cooldown?: Cooldown;
                fixedGcd?: boolean;
                id: number;
                itemId?: number;
                name: string;
                noIcon?: boolean;
                translate?: boolean;
            } & {
                levelModifiers?: LevelModifier<
                    {
                        _idForCooldown?: number;
                        activatesBuffs?: readonly Buff[];
                        alternativeScalings?: AlternativeScaling[];
                        animationLock?: number;
                        appDelay?: number;
                        attackType: | "Unknown"
                        | "Auto-attack"
                        | "Spell"
                        | "Weaponskill"
                        | "Ability"
                        | "Item";
                        buffApplicationDelay?: number;
                        cast?: number;
                        combos?: readonly ComboData[];
                        cooldown?: Cooldown;
                        fixedGcd?: boolean;
                        id: number;
                        itemId?: number;
                        name: string;
                        noIcon?: boolean;
                        translate?: boolean;
                    },
                >[];
            } & Readonly<
                {
                    alternativeScalings?: AlternativeScaling[];
                    attackType: | "Unknown"
                    | "Auto-attack"
                    | "Spell"
                    | "Weaponskill"
                    | "Ability"
                    | "Item";
                    autoCrit?: boolean;
                    autoDh?: boolean;
                    dot?: DotInfo;
                    potency: number;
                },
            > & {
                levelModifiers?: LevelModifier<
                    Readonly<
                        {
                            alternativeScalings?: AlternativeScaling[];
                            attackType: | "Unknown"
                            | "Auto-attack"
                            | "Spell"
                            | "Weaponskill"
                            | "Ability"
                            | "Item";
                            autoCrit?: boolean;
                            autoDh?: boolean;
                            dot?: DotInfo;
                            potency: number;
                        },
                    >,
                >[];
            },
        > & Readonly<LevelModifiable<{ gcd: number; type: "gcd" }>>
        | Readonly<
            {
                _idForCooldown?: number;
                activatesBuffs?: readonly Buff[];
                alternativeScalings?: AlternativeScaling[];
                animationLock?: number;
                appDelay?: number;
                attackType: | "Unknown"
                | "Auto-attack"
                | "Spell"
                | "Weaponskill"
                | "Ability"
                | "Item";
                buffApplicationDelay?: number;
                cast?: number;
                combos?: readonly ComboData[];
                cooldown?: Cooldown;
                fixedGcd?: boolean;
                id: number;
                itemId?: number;
                name: string;
                noIcon?: boolean;
                translate?: boolean;
            } & {
                levelModifiers?: LevelModifier<
                    {
                        _idForCooldown?: number;
                        activatesBuffs?: readonly Buff[];
                        alternativeScalings?: AlternativeScaling[];
                        animationLock?: number;
                        appDelay?: number;
                        attackType: | "Unknown"
                        | "Auto-attack"
                        | "Spell"
                        | "Weaponskill"
                        | "Ability"
                        | "Item";
                        buffApplicationDelay?: number;
                        cast?: number;
                        combos?: readonly ComboData[];
                        cooldown?: Cooldown;
                        fixedGcd?: boolean;
                        id: number;
                        itemId?: number;
                        name: string;
                        noIcon?: boolean;
                        translate?: boolean;
                    },
                >[];
            } & Readonly<{ potency: null }> & {
                levelModifiers?: LevelModifier<Readonly<{ potency: null }>>[];
            },
        > & Readonly<LevelModifiable<{ type: "ogcd" }>>
        | Readonly<
            {
                _idForCooldown?: number;
                activatesBuffs?: readonly Buff[];
                alternativeScalings?: AlternativeScaling[];
                animationLock?: number;
                appDelay?: number;
                attackType: | "Unknown"
                | "Auto-attack"
                | "Spell"
                | "Weaponskill"
                | "Ability"
                | "Item";
                buffApplicationDelay?: number;
                cast?: number;
                combos?: readonly ComboData[];
                cooldown?: Cooldown;
                fixedGcd?: boolean;
                id: number;
                itemId?: number;
                name: string;
                noIcon?: boolean;
                translate?: boolean;
            } & {
                levelModifiers?: LevelModifier<
                    {
                        _idForCooldown?: number;
                        activatesBuffs?: readonly Buff[];
                        alternativeScalings?: AlternativeScaling[];
                        animationLock?: number;
                        appDelay?: number;
                        attackType: | "Unknown"
                        | "Auto-attack"
                        | "Spell"
                        | "Weaponskill"
                        | "Ability"
                        | "Item";
                        buffApplicationDelay?: number;
                        cast?: number;
                        combos?: readonly ComboData[];
                        cooldown?: Cooldown;
                        fixedGcd?: boolean;
                        id: number;
                        itemId?: number;
                        name: string;
                        noIcon?: boolean;
                        translate?: boolean;
                    },
                >[];
            } & Readonly<
                {
                    alternativeScalings?: AlternativeScaling[];
                    attackType: | "Unknown"
                    | "Auto-attack"
                    | "Spell"
                    | "Weaponskill"
                    | "Ability"
                    | "Item";
                    autoCrit?: boolean;
                    autoDh?: boolean;
                    dot?: DotInfo;
                    potency: number;
                },
            > & {
                levelModifiers?: LevelModifier<
                    Readonly<
                        {
                            alternativeScalings?: AlternativeScaling[];
                            attackType: | "Unknown"
                            | "Auto-attack"
                            | "Spell"
                            | "Weaponskill"
                            | "Ability"
                            | "Item";
                            autoCrit?: boolean;
                            autoDh?: boolean;
                            dot?: DotInfo;
                            potency: number;
                        },
                    >,
                >[];
            },
        > & Readonly<LevelModifiable<{ type: "ogcd" }>>
        | never
        | Readonly<
            {
                _idForCooldown?: number;
                activatesBuffs?: readonly Buff[];
                alternativeScalings?: AlternativeScaling[];
                animationLock?: number;
                appDelay?: number;
                attackType: | "Unknown"
                | "Auto-attack"
                | "Spell"
                | "Weaponskill"
                | "Ability"
                | "Item";
                buffApplicationDelay?: number;
                cast?: number;
                combos?: readonly ComboData[];
                cooldown?: Cooldown;
                fixedGcd?: boolean;
                id: number;
                itemId?: number;
                name: string;
                noIcon?: boolean;
                translate?: boolean;
            } & {
                levelModifiers?: LevelModifier<
                    {
                        _idForCooldown?: number;
                        activatesBuffs?: readonly Buff[];
                        alternativeScalings?: AlternativeScaling[];
                        animationLock?: number;
                        appDelay?: number;
                        attackType: | "Unknown"
                        | "Auto-attack"
                        | "Spell"
                        | "Weaponskill"
                        | "Ability"
                        | "Item";
                        buffApplicationDelay?: number;
                        cast?: number;
                        combos?: readonly ComboData[];
                        cooldown?: Cooldown;
                        fixedGcd?: boolean;
                        id: number;
                        itemId?: number;
                        name: string;
                        noIcon?: boolean;
                        translate?: boolean;
                    },
                >[];
            } & Readonly<
                {
                    alternativeScalings?: AlternativeScaling[];
                    attackType: | "Unknown"
                    | "Auto-attack"
                    | "Spell"
                    | "Weaponskill"
                    | "Ability"
                    | "Item";
                    autoCrit?: boolean;
                    autoDh?: boolean;
                    dot?: DotInfo;
                    potency: number;
                },
            > & {
                levelModifiers?: LevelModifier<
                    Readonly<
                        {
                            alternativeScalings?: AlternativeScaling[];
                            attackType: | "Unknown"
                            | "Auto-attack"
                            | "Spell"
                            | "Weaponskill"
                            | "Ability"
                            | "Item";
                            autoCrit?: boolean;
                            autoDh?: boolean;
                            dot?: DotInfo;
                            potency: number;
                        },
                    >,
                >[];
            },
        > & Readonly<
            {
                alternativeScalings?: AlternativeScaling[];
                attackType: | "Unknown"
                | "Auto-attack"
                | "Spell"
                | "Weaponskill"
                | "Ability"
                | "Item";
                autoCrit?: boolean;
                autoDh?: boolean;
                dot?: DotInfo;
                potency: number;
            },
        > & Readonly<LevelModifiable<{ type: "autoattack" }>>

    The ability that was used

    appDelay: number

    The raw application delay from snapshot to application

    appDelayFromStart: number

    The application delay from usedAt

    buffs: Buff[]

    The buffs that were active either when the ability started casting, or when it snapshotted, depending on what bonuses the buff provides.

    TODO: consider adding buffsAtStart and buffsAtSnapshot to clearly delineate these.

    castTimeFromStart: number

    The total cast time from usedAt

    combinedEffects: CombinedBuffEffect

    The combined effects that were active when the ability snapshotted, with the exception that the 'haste' field comes from the start of the cast, since that is when haste matters.

    If a DoT, the DoT damage

    extraData: { gauge: { battery: number; heat: number } }

    Extra data relating to the ability used. Useful for sims which wish to attach their own extra information for display in the results. Deprecated for Gauge use - see gaugeAftrer.

    gaugeAfter: {}

    Gauge information.

    lockTime: number

    The total time where you are unable to take other actions. For an instant, this is the animation lock. For a cast, this is the cast time + caster tax.

    snapshotTimeFromStart: number

    The total time between usedAt and snapshot

    totalTimeTaken: number

    The total time used by the ability. This doesn't mean exclusive use - e.g. for an instant GCD, this is the total GCD time, not the total time you are unable to use other actions.

    usedAt: number

    When the ability was initiated.