Class SheetProvider<SheetType>

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

Type Parameters

SheetType extends GearPlanSheet

Hierarchy (View Summary)

SheetProvider
- GraphicalSheetProvider

Index

Constructors

Methods

fromExport fromSaved fromScratch fromSetExport

Constructors

constructor

new SheetProvider<SheetType extends GearPlanSheet>(
sheetConstructor: SheetContstructor<SheetType>,
sheetManager: SheetManager,
): SheetProvider<SheetType>
Type Parameters
- SheetType extends GearPlanSheet
Parameters
- sheetConstructor: SheetContstructor<SheetType>
- sheetManager: SheetManager
Returns SheetProvider<SheetType>
- Defined in sheet.ts:74

Methods

fromExport

fromExport(importedData: SheetExport): SheetType
Produce a sheet from a SheetExport
Parameters
- importedData: SheetExport
Returns SheetType
- Defined in sheet.ts:86

fromSaved

fromSaved(sheetKey: string): SheetType
Try to load a sheet by its save key
Parameters
- sheetKey: string
  The key to load
Returns SheetType
The sheet if found, otherwise null
- Defined in sheet.ts:153

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,
): SheetType
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 SheetType
- Defined in sheet.ts:125

fromSetExport

fromSetExport(...importedData: SetExportExternalSingle[]): SheetType
Produce a sheet from a single-set export.
Parameters
- ...importedData: SetExportExternalSingle[]
Returns SheetType
- Defined in sheet.ts:105