Xivgear Types Documentation
    Preparing search index...

    The top-level gear manager, but with graphical support

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Properties

    _materiaAutoFillController: MateriaAutoFillController
    _timestamp: Date
    altJobs: (
        | "PLD"
        | "WAR"
        | "DRK"
        | "GNB"
        | "WHM"
        | "SCH"
        | "AST"
        | "SGE"
        | "MNK"
        | "DRG"
        | "NIN"
        | "SAM"
        | "RPR"
        | "VPR"
        | "BRD"
        | "MCH"
        | "DNC"
        | "BLM"
        | "SMN"
        | "RDM"
        | "PCT"
        | "BLU"
    )[]
    buttonsArea: HTMLDivElement
    classJobName:
        | "PLD"
        | "WAR"
        | "DRK"
        | "GNB"
        | "WHM"
        | "SCH"
        | "AST"
        | "SGE"
        | "MNK"
        | "DRG"
        | "NIN"
        | "SAM"
        | "RPR"
        | "VPR"
        | "BRD"
        | "MCH"
        | "DNC"
        | "BLM"
        | "SMN"
        | "RDM"
        | "PCT"
        | "BLU"
    editorArea: HTMLDivElement
    headerArea: HTMLDivElement
    headerBacklinkArea: HTMLDivElement
    ilvlSync: number
    isEmbed: boolean = false
    isMultiJob: boolean
    level: 70 | 80 | 90 | 100
    materiaAutoFillPrio: MateriaAutoFillPrio
    materiaFillMode:
        | "leave_empty"
        | "autofill"
        | "retain_slot_else_prio"
        | "retain_item_else_prio"
        | "retain_slot"
        | "retain_item"
    midBarArea: HTMLDivElement
    sheetManager: SheetManager
    shouldAddDefaultSimsToNewSheet: boolean
    tableArea: HTMLDivElement
    tableHolder: HTMLDivElement
    tableHolderOuter: HTMLDivElement
    toolbarHolder: HTMLDivElement
    toolbarNode: Node

    Accessors

    • get description(): string

      The description of the sheet.

      Returns string

    • set description(desc: string): void

      Parameters

      • desc: string

      Returns void

    • get foodItemsForDisplay(): FoodItem[]

      Food items which are relevant and pass the filter. Custom foods will be displayed regardless of filtering.

      Returns FoodItem[]

    • get itemsForDisplay(): GearItem[]

      Get all items which are relevant, and are not filtered out by display settings. Custom items are always displayed regardless of filtering.

      Returns GearItem[]

    • get relevantFoodForSolver(): FoodItem[]

      Relevant food for the meld/food solver. Will return all of the highest level food with two valid stats and all custom food.

      Returns FoodItem[]

    • get saveKey(): string

      The key under which this sheet should be saved in LocalStorage.

      Returns string

    Methods

    • Delete the given custom food item, first asking for confirmation if the item is equipped on any set.

      Parameters

      • item: CustomFood

        The food item to delete

      • confirmationCallback: (equipppedOnsets: string[]) => boolean

        A callback to be called to confirm the deletion of an item which is currently equipped. Receives the names of sets as the first parameter.

      Returns boolean

    • Delete the given custom item, first asking for confirmation if the item is equipped on any set.

      Parameters

      • item: CustomItem

        The item to delete.

      • confirmationCallback: (equipppedOnsets: string[]) => boolean

        A callback to be called to confirm the deletion of an item which is currently equipped. Receives the names of sets as the first parameter.

      Returns boolean

    • Get the best possible materia for a particular slot of the given stat.

      Parameters

      • stat:
            | "determination"
            | "piety"
            | "crit"
            | "dhit"
            | "spellspeed"
            | "skillspeed"
            | "tenacity"
      • meldSlot: MeldableMateriaSlot

      Returns Materia

    • Return the highest ilvl of non-custom items in a particular slot

      Parameters

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

      Returns number

    • Returns the highest

      Parameters

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

      Returns GearItem

    • Determine whether a stat is relevant to this sheet based on its job.

      Relevant means:

      • The stat is not undefined.
      • If it is the main stat (including vit), then it is the primary stat for the job.
        • Vit is not relevant for any job since it is not the main stat of any job.
      • If it is a substat, it is not filtered out by the job.
      • If it is gear haste, it is only relevant if we have an active special stat which cares about haste.

      Parameters

      Returns boolean

    • Return an item from the DataManager by its ID. Returns undefined if the item could not be found.

      Parameters

      • id: number

        The item ID. For custom items, use the custom item's fake ID.

      • forceNq: boolean = false

        If true, searches for an NQ version of an otherwise-HQ item.

      Returns GearItem

    • Parameters

      Returns {
          get autoFillMode(): | "leave_empty"
          | "autofill"
          | "retain_slot_else_prio"
          | "retain_item_else_prio"
          | "retain_slot"
          | "retain_item";
          set autoFillMode(
              mode:
                  | "leave_empty"
                  | "autofill"
                  | "retain_slot_else_prio"
                  | "retain_item_else_prio"
                  | "retain_slot"
                  | "retain_item",
          ): void;
          get prio(): MateriaAutoFillPrio;
          callback(): void;
          fillAll(): void;
          fillEmpty(): void;
          lockEmpty(): void;
          lockFilled(): void;
          unequipUnlocked(): void;
          unlockAll(): void;
      }

    • Returns the starting set of data for a new custom item.

      Parameters

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

        The slot for which to make the custom item.

      Returns CustomItem

    • Request a save to be completed asynchronously. The actual save is only performed once no more requestSave() calls have happened for a certain timeout, thus allowing multiple modifications to be coalesced into a single save operation.

      Returns void

    • Copy this sheet to a new save slot.

      Parameters

      • name: string

        New name. Leave unspecified/undefined to keep existing name.

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

        New job. Leave unspecified/undefined to keep existing job.

      • level: 70 | 80 | 90 | 100

        New level. Leave unspecified/undefined to keep existing level.

      • ilvlSync: number | "keep"

        New ilvl sync. Leave unspecified or use special value 'keep' to keep existing ilvl sync.

      • multiJob: boolean

        Whether to create the new sheet as a multi-job sheet or not.

      Returns string

      The saveKey of the new sheet.

    • Get the class/job stats for a different class/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 JobData