Class GraphicalSheetProvider

SheetProvider is the base class for turning sheet exports or fresh sheets into rehydrated sheet objects.

Hierarchy (View Summary)

SheetProvider<GearPlanSheetGui>
- GraphicalSheetProvider

Index

Constructors

Methods

fromExport fromSaved fromScratch fromSetExport

Constructors

constructor

new GraphicalSheetProvider(): GraphicalSheetProvider
Returns GraphicalSheetProvider
Overrides SheetProvider.constructor
- Defined in packages/frontend/src/scripts/components/sheet/provider.ts:8

Methods

fromExport

fromExport(importedData: SheetExport): GearPlanSheetGui
Produce a sheet from a SheetExport
Parameters
- importedData: SheetExport
Returns GearPlanSheetGui
Overrides SheetProvider.fromExport
- Defined in packages/frontend/src/scripts/components/sheet/provider.ts:12

fromSaved

fromSaved(sheetKey: string): GearPlanSheetGui
Try to load a sheet by its save key
Parameters
- sheetKey: string
  The key to load
Returns GearPlanSheetGui
The sheet if found, otherwise null
Overrides SheetProvider.fromSaved
- Defined in packages/frontend/src/scripts/components/sheet/provider.ts:24

fromScratch

fromScratch(
    sheetKey: string,
    sheetName: string,
    classJob:
        | "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,
    ilvlSync: number,
    multiJob: boolean,
): GearPlanSheetGui
Create a new sheet from scratch
Parameters
- sheetKey: string
  The save key for the sheet
- sheetName: string
  The name of the sheet
- classJob:
      | "PLD"
      | "WAR"
      | "DRK"
      | "GNB"
      | "WHM"
      | "SCH"
      | "AST"
      | "SGE"
      | "MNK"
      | "DRG"
      | "NIN"
      | "SAM"
      | "RPR"
      | "VPR"
      | "BRD"
      | "MCH"
      | "DNC"
      | "BLM"
      | "SMN"
      | "RDM"
      | "PCT"
      | "BLU"
  The class/job of the sheet
- level: 70 | 80 | 90 | 100
  The level of the sheet
- ilvlSync: number
  The ilvl sync of the sheet, or undefined if the sheet should not have an ilvl sync.
- multiJob: boolean
  Whether to create a multi-job sheet.
Returns GearPlanSheetGui
Overrides SheetProvider.fromScratch
- Defined in packages/frontend/src/scripts/components/sheet/provider.ts:30

fromSetExport

fromSetExport(...importedData: SetExport[]): GearPlanSheetGui
Produce a sheet from a single-set export.
Parameters
- ...importedData: SetExport[]
Returns GearPlanSheetGui
Overrides SheetProvider.fromSetExport
- Defined in packages/frontend/src/scripts/components/sheet/provider.ts:18