Xivgear Types Documentation
    Preparing search index...

    Class CustomItem

    Implements

    Index

    Properties

    acquisitionType iconUrl isCustomRelic isNqVersion isSyncedDown primarySubstat rarity relicStatModel secondarySubstat slotMapping statCaps syncedDownTo unsyncedVersion

    Accessors

    activeSpecialStat customData displayGearSlot displayGearSlotName equipLvl id ilvl isUnique materiaSlots name nameTranslation occGearSlotName respectCaps stats

    Methods

    export recheckSync usableByJob fromExport fromScratch

    Properties

    acquisitionType: GearAcquisitionSource = 'custom'
    iconUrl: URL = ...

    Item icon URL

    isCustomRelic: boolean = false

    Whether this is a custom relic with editable stats

    isNqVersion: boolean = false
    isSyncedDown: boolean = false
    primarySubstat: keyof RawStats = null

    The primary substat

    rarity: 1
    relicStatModel: undefined = undefined
    secondarySubstat: keyof RawStats = null

    The secondary substat

    slotMapping: EquipSlotMap
    statCaps: Partial<RawStats> = {}
    syncedDownTo: number
    unsyncedVersion: GearItem = ...

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

    Accessors

    • get displayGearSlotName(): | "OffHand"
      | "Head"
      | "Body"
      | "Hand"
      | "Legs"
      | "Feet"
      | "Ears"
      | "Neck"
      | "Wrist"
      | "Ring"
      | "Weapon"

      Which gear slot to populate in the UI

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

    • get occGearSlotName(): | "Weapon2H"
      | "Weapon1H"
      | "OffHand"
      | "Head"
      | "Body"
      | "Hand"
      | "Legs"
      | "Feet"
      | "Ears"
      | "Neck"
      | "Wrist"
      | "Ring"

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

      Returns
          | "Weapon2H"
          | "Weapon1H"
          | "OffHand"
          | "Head"
          | "Body"
          | "Hand"
          | "Legs"
          | "Feet"
          | "Ears"
          | "Neck"
          | "Wrist"
          | "Ring"

    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

    • Parameters

      • fakeId: number
      • slot:
            | "Weapon2H"
            | "Weapon1H"
            | "OffHand"
            | "Head"
            | "Body"
            | "Hand"
            | "Legs"
            | "Feet"
            | "Ears"
            | "Neck"
            | "Wrist"
            | "Ring"
      • sheet: GearPlanSheet

      Returns CustomItem

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods