Xivgear Types Documentation
    Preparing search index...

    Class DataApiGearInfo

    Implements

    Index

    Constructors

    constructor

    Properties

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

    Accessors

    activeSpecialStat

    Methods

    applyIlvlData recalcEffectiveStats usableByJob

    Constructors

    Properties

    acquisitionType: GearAcquisitionSource
    displayGearSlot: DisplayGearSlotInfo

    Which gear slot to populate in the UI

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

    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
    jobs: (
        | "PLD"
        | "WAR"
        | "DRK"
        | "GNB"
        | "WHM"
        | "SCH"
        | "AST"
        | "SGE"
        | "MNK"
        | "DRG"
        | "NIN"
        | "SAM"
        | "RPR"
        | "VPR"
        | "BRD"
        | "MCH"
        | "DNC"
        | "BLM"
        | "SMN"
        | "RDM"
        | "PCT"
        | "BLU"
    )[]
    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:
        | "Weapon2H"
        | "Weapon1H"
        | "OffHand"
        | "Head"
        | "Body"
        | "Hand"
        | "Legs"
        | "Feet"
        | "Ears"
        | "Neck"
        | "Wrist"
        | "Ring"
        | "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

    The primary substat

    rarity: number
    relicStatModel: RelicStatModel
    secondarySubstat: keyof RawStats

    The secondary substat

    slotMapping: DataApiEquipSlotMap
    specialStats: RawStats
    specialStatType: SpecialStatType
    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
    unsyncedVersion: DataApiGearInfo

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

    Accessors

    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

    Constructors
    Properties
    Accessors
    Methods