Xivgear Types Documentation
    Preparing search index...

    Interface SetExport

    Represents an exported set. Note that in addition to some fields only being applicable to internal vs external usage, some fields may be present based on whether this set was exported as a standalone individual set, or as part of a full sheet.

    If it is an individual sheet export, then several of the properties that would normally live at the sheet level will instead be here (such as job and level).

    interface SetExport {
        description?: string;
        food?: number;
        isSeparator?: boolean;
        items: ItemsSlotsExport;
        jobOverride?:
            | "PLD"
            | "WAR"
            | "DRK"
            | "GNB"
            | "WHM"
            | "SCH"
            | "AST"
            | "SGE"
            | "MNK"
            | "DRG"
            | "NIN"
            | "SAM"
            | "RPR"
            | "VPR"
            | "BRD"
            | "MCH"
            | "DNC"
            | "BLM"
            | "SMN"
            | "RDM"
            | "PCT"
            | "BLU"
            | null;
        materiaMemory?: MateriaMemoryExport;
        name: string;
        relicStatMemory?: RelicStatMemoryExport;
    }
    Index

    Properties

    description? food? isSeparator? items jobOverride? materiaMemory? name relicStatMemory?

    Properties

    description?: string

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

    food?: number

    Equipped food (by item ID)

    isSeparator?: boolean

    Indicates that this set is a separator rather than an actual set

    items: ItemsSlotsExport

    Equipped items (and their materia and/or relic stats)

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

    For multi-class sheets, each set can have a different job.

    materiaMemory?: MateriaMemoryExport

    When an item is de-selected, its former materia are remembered so that they can later be automatically re-equipped based on settings. They keys are slot names (so that left/right ring can be differentiated), and the values are lists of tuples of [item ID, [materia 0, materia 1, ... materia n]]

    name: string

    Name of the gear set.

    relicStatMemory?: RelicStatMemoryExport

    When a relic is de-selected, its former stats are remembered here so that they can be recalled if the relic is selected again. They keys are item IDs, and the values are RelicStats.

    Settings

    Member Visibility

    On This Page

    Properties