Xivgear Types Documentation
    Preparing search index...

    Implements

    Index

    Constructors

    Properties

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

    Accessors

    • get equipOrBlockedSlots(): (
          | "OffHand"
          | "Head"
          | "Body"
          | "Hand"
          | "Legs"
          | "Feet"
          | "Ears"
          | "Neck"
          | "Wrist"
          | "Weapon"
          | "RingLeft"
          | "RingRight"
      )[]

      Returns (
          | "OffHand"
          | "Head"
          | "Body"
          | "Hand"
          | "Legs"
          | "Feet"
          | "Ears"
          | "Neck"
          | "Wrist"
          | "Weapon"
          | "RingLeft"
          | "RingRight"
      )[]

    Methods

    • Whether the item can be equipped to the slot. Usually this is only true for a single slot, but rings can be equipped to both left and right ring slots.

      Parameters

      • slot:
            | "OffHand"
            | "Head"
            | "Body"
            | "Hand"
            | "Legs"
            | "Feet"
            | "Ears"
            | "Neck"
            | "Wrist"
            | "Weapon"
            | "RingLeft"
            | "RingRight"

      Returns boolean

    • Get the list of slots which will be blocked from equipping items if this item is equipped. e.g. Vermilion Cloak blocks the head slot despite being equipped to body slot.

      Returns (
          | "OffHand"
          | "Head"
          | "Body"
          | "Hand"
          | "Legs"
          | "Feet"
          | "Ears"
          | "Neck"
          | "Wrist"
          | "Weapon"
          | "RingLeft"
          | "RingRight"
      )[]