Xivgear Types Documentation
    Preparing search index...

    Interface SheetStatsExport

    Represents an exported set. Many of the fields fill the same role as the fields on GearPlanSheet.

    Some of the fields are only relevant for local saves, while others are only relevant for external (API) saves.

    interface SheetStatsExport {
        customFoods?: CustomFoodExport[];
        customItems?: CustomItemExport[];
        description?: string;
        ilvlSync?: number;
        isMultiJob?: boolean;
        itemDisplaySettings?: ItemDisplaySettings;
        job:
            | "PLD"
            | "WAR"
            | "DRK"
            | "GNB"
            | "WHM"
            | "SCH"
            | "AST"
            | "SGE"
            | "MNK"
            | "DRG"
            | "NIN"
            | "SAM"
            | "RPR"
            | "VPR"
            | "BRD"
            | "MCH"
            | "DNC"
            | "BLM"
            | "SMN"
            | "RDM"
            | "PCT"
            | "BLU";
        level: 70
        | 80
        | 90
        | 100;
        mfm?:
            | "leave_empty"
            | "autofill"
            | "retain_slot_else_prio"
            | "retain_item_else_prio"
            | "retain_slot"
            | "retain_item";
        mfMinGcd?: number;
        mfp?: (
            | "piety"
            | "crit"
            | "dhit"
            | "determination"
            | "tenacity"
            | "spellspeed"
            | "skillspeed"
        )[];
        name: string;
        partyBonus?: PartyBonusAmount;
        race?: RaceName;
        saveKey?: string;
        sets: SetStatsExport[];
        sims?: SimExport[];
        specialStats?: string
        | null;
        timestamp?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    customFoods? customItems? description? ilvlSync? isMultiJob? itemDisplaySettings? job level mfm? mfMinGcd? mfp? name partyBonus? race? saveKey? sets sims? specialStats? timestamp?

    Properties

    customFoods?: CustomFoodExport[]

    Custom foods

    customItems?: CustomItemExport[]

    Custom items

    description?: string

    Description of the gear set. May be multi-line.

    ilvlSync?: number

    If ilvl sync is enabled, this represents what level the sheet should be synced to

    isMultiJob?: boolean

    True if this is a multi-job sheet (within a single role)

    itemDisplaySettings?: ItemDisplaySettings

    Settings regarding which items to display

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

    The job abbreviation for the sheet.

    level: 70 | 80 | 90 | 100

    The level of the sheet (90, 80, etc)

    mfm?:
        | "leave_empty"
        | "autofill"
        | "retain_slot_else_prio"
        | "retain_item_else_prio"
        | "retain_slot"
        | "retain_item"

    What to do with materia slots on newly-selected items

    mfMinGcd?: number

    The target GCD for materia auto-fill

    mfp?: (
        | "piety"
        | "crit"
        | "dhit"
        | "determination"
        | "tenacity"
        | "spellspeed"
        | "skillspeed"
    )[]

    The materia auto-fill priority

    name: string

    Name of the sheet.

    partyBonus?: PartyBonusAmount

    Party bonus percentage (0-5)

    race?: RaceName

    The character clan (e.g. Wildwood or Duskwight) of the sheet.

    saveKey?: string

    Local only: the key used to save the sheet in localStorage

    sets: SetStatsExport[]

    The gear sets on the sheet.

    sims?: SimExport[]

    The simulations on this sheet.

    specialStats?: string | null
    timestamp?: number

    Unix timestamp

    Settings

    Member Visibility

    On This Page

    Properties