Xivgear Types Documentation
    Preparing search index...

    Implements

    Index

    Constructors

    Accessors

    • get allClassJobs(): (
          | "PLD"
          | "WAR"
          | "DRK"
          | "GNB"
          | "WHM"
          | "SCH"
          | "AST"
          | "SGE"
          | "MNK"
          | "DRG"
          | "NIN"
          | "SAM"
          | "RPR"
          | "VPR"
          | "BRD"
          | "MCH"
          | "DNC"
          | "BLM"
          | "SMN"
          | "RDM"
          | "PCT"
          | "BLU"
      )[]

      Returns (
          | "PLD"
          | "WAR"
          | "DRK"
          | "GNB"
          | "WHM"
          | "SCH"
          | "AST"
          | "SGE"
          | "MNK"
          | "DRG"
          | "NIN"
          | "SAM"
          | "RPR"
          | "VPR"
          | "BRD"
          | "MCH"
          | "DNC"
          | "BLM"
          | "SMN"
          | "RDM"
          | "PCT"
          | "BLU"
      )[]

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

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

    Methods

    • Get the implicit max ilvl for a particular level of character. Can be different for weapons vs non-weapons. For example, if the highest ilvl at level 80 is 535 for weapons, then getImplicitIlvlSync(80, true) will return 535. Returns undefined if the max cannot be determined.

      Parameters

      • level: number
      • isWeapon: boolean

      Returns number

    • Retrieve a gear item by item ID. Returns undefined if the item cannot be found. If forceNq is true, will only look for an NQ version.

      Parameters

      • id: number
      • forceNq: boolean = false

      Returns GearItem

    • Get the multipliers for a particular job.

      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 JobMultipliers