Xivgear Types Documentation
    Preparing search index...

    Interface GearItem

    interface GearItem {
        acquisitionType: GearAcquisitionSource;
        activeSpecialStat: SpecialStatType | null;
        displayGearSlot: DisplayGearSlotInfo;
        displayGearSlotName:
            | "Weapon"
            | "OffHand"
            | "Head"
            | "Body"
            | "Hand"
            | "Legs"
            | "Feet"
            | "Ears"
            | "Neck"
            | "Wrist"
            | "Ring";
        equipLvl: number;
        iconUrl: URL;
        id: number;
        ilvl: number;
        isCustomRelic: boolean;
        isNqVersion: boolean;
        isSyncedDown: boolean;
        isUnique: boolean;
        materiaSlots: MateriaSlot[];
        name: string;
        nameTranslation: TranslatableString;
        occGearSlotName: | "OffHand"
        | "Head"
        | "Body"
        | "Hand"
        | "Legs"
        | "Feet"
        | "Ears"
        | "Neck"
        | "Wrist"
        | "Ring"
        | "Weapon2H"
        | "Weapon1H"
        | "ChestHead"
        | "ChestHeadLegsFeet"
        | "ChestLegsFeet"
        | "ChestLegsGloves"
        | "HeadChestHandsLegsFeet"
        | "LegsFeet";
        primarySubstat: (keyof RawStats)
        | null;
        rarity: number;
        relicStatModel: RelicStatModel | undefined;
        secondarySubstat: (keyof RawStats) | null;
        slotMapping: EquipSlotMap;
        statCaps: {
            crit?: number;
            defenseMag?: number;
            defensePhys?: number;
            determination?: number;
            dexterity?: number;
            dhit?: number;
            extraMainStat?: number;
            extraSecondaryStat?: number;
            gearHaste?: number;
            hp?: number;
            intelligence?: number;
            mind?: number;
            piety?: number;
            skillspeed?: number;
            spellspeed?: number;
            strength?: number;
            tenacity?: number;
            vitality?: number;
            wdMag?: number;
            wdPhys?: number;
            weaponDelay?: number;
        };
        stats: RawStats;
        syncedDownTo: number
        | null;
        unsyncedVersion: GearItem;
        usableByJob(
            job:
                | "PLD"
                | "WAR"
                | "DRK"
                | "GNB"
                | "WHM"
                | "SCH"
                | "AST"
                | "SGE"
                | "MNK"
                | "DRG"
                | "NIN"
                | "SAM"
                | "RPR"
                | "VPR"
                | "BRD"
                | "MCH"
                | "DNC"
                | "BLM"
                | "SMN"
                | "RDM"
                | "PCT"
                | "BLU",
        ): boolean;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    acquisitionType activeSpecialStat displayGearSlot displayGearSlotName equipLvl iconUrl id ilvl isCustomRelic isNqVersion isSyncedDown isUnique materiaSlots name nameTranslation occGearSlotName primarySubstat rarity relicStatModel secondarySubstat slotMapping statCaps stats syncedDownTo unsyncedVersion

    Methods

    usableByJob

    Properties

    acquisitionType: GearAcquisitionSource
    activeSpecialStat: SpecialStatType | null
    displayGearSlot: DisplayGearSlotInfo

    Which gear slot to populate in the UI

    displayGearSlotName:
        | "Weapon"
        | "OffHand"
        | "Head"
        | "Body"
        | "Hand"
        | "Legs"
        | "Feet"
        | "Ears"
        | "Neck"
        | "Wrist"
        | "Ring"

    Which gear slot to populate in the UI

    equipLvl: number

    equip level

    iconUrl: URL

    Item icon URL

    id: number

    Item ID

    ilvl: number

    ilvl

    isCustomRelic: boolean

    Whether this is a custom relic with editable stats

    isNqVersion: boolean
    isSyncedDown: boolean
    isUnique: boolean
    materiaSlots: MateriaSlot[]

    Materia slots on the item. When downsynced, this is replaced with an empty list.

    name: string

    Item name

    nameTranslation: TranslatableString

    Item name, including translations

    occGearSlotName:
        | "OffHand"
        | "Head"
        | "Body"
        | "Hand"
        | "Legs"
        | "Feet"
        | "Ears"
        | "Neck"
        | "Wrist"
        | "Ring"
        | "Weapon2H"
        | "Weapon1H"
        | "ChestHead"
        | "ChestHeadLegsFeet"
        | "ChestLegsFeet"
        | "ChestLegsGloves"
        | "HeadChestHandsLegsFeet"
        | "LegsFeet"

    Which gear slot the item occupies - different from the above, as 2H and 1H weapons are treated differently here

    primarySubstat: (keyof RawStats) | null

    The primary substat

    rarity: number
    relicStatModel: RelicStatModel | undefined
    secondarySubstat: (keyof RawStats) | null

    The secondary substat

    slotMapping: EquipSlotMap
    statCaps: {
        crit?: number;
        defenseMag?: number;
        defensePhys?: number;
        determination?: number;
        dexterity?: number;
        dhit?: number;
        extraMainStat?: number;
        extraSecondaryStat?: number;
        gearHaste?: number;
        hp?: number;
        intelligence?: number;
        mind?: number;
        piety?: number;
        skillspeed?: number;
        spellspeed?: number;
        strength?: number;
        tenacity?: number;
        vitality?: number;
        wdMag?: number;
        wdPhys?: number;
        weaponDelay?: number;
    }
    stats: RawStats

    The effective stats

    syncedDownTo: number | null
    unsyncedVersion: GearItem

    If this item is synced down, keep the unsynced version here.

    Methods

    • Parameters

      • job:
            | "PLD"
            | "WAR"
            | "DRK"
            | "GNB"
            | "WHM"
            | "SCH"
            | "AST"
            | "SGE"
            | "MNK"
            | "DRG"
            | "NIN"
            | "SAM"
            | "RPR"
            | "VPR"
            | "BRD"
            | "MCH"
            | "DNC"
            | "BLM"
            | "SMN"
            | "RDM"
            | "PCT"
            | "BLU"

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods