Class GameData

constructor

• new GameData(scene): GameData

• Parameters

  • scene: default

  Returns GameData

achvUnlocks

dexData

eggs

gameStats

gender

secretId

starterData

trainerId

unlocks

voucherCounts

voucherUnlocks

addStarterCandy

• addStarterCandy(species, count): void

• Parameters

  • species: default
  • count: number

  Returns void

clearLocalData

• clearLocalData(): void

• Returns void

consolidateDexData

• consolidateDexData(dexData): void

• Parameters

  • dexData: DexData

  Returns void

deleteSession

• deleteSession(slotId): Promise<boolean>

• Parameters

  • slotId: number

  Returns Promise<boolean>

fixLegendaryStats

• fixLegendaryStats(systemData): void

• Parameters

  • systemData: SystemSaveData

  Returns void

fixStarterData

• fixStarterData(systemData): void

• Parameters

  • systemData: SystemSaveData

  Returns void

fixVariantData

• fixVariantData(systemData): void

• Parameters

  • systemData: SystemSaveData

  Returns void

getDexAttrLuck

• getDexAttrLuck(dexAttr): number

• Parameters

  • dexAttr: bigint

  Returns number

getFormAttr

• getFormAttr(formIndex): bigint

• Parameters

  • formIndex: number

  Returns bigint

getFormIndex

• getFormIndex(attr): number

• Parameters

  • attr: bigint

  Returns number

getNaturesForAttr

• getNaturesForAttr(natureAttr): Nature[]

• Parameters

  • natureAttr: number

  Returns Nature[]

getSession

• getSession(slotId): Promise<SessionSaveData>

• Parameters

  • slotId: number

  Returns Promise<SessionSaveData>

getSpeciesCount

• getSpeciesCount(dexEntryPredicate): number

• Parameters

  • dexEntryPredicate: ((entry) => boolean)
    • • (entry): boolean

      • Parameters

        • entry: DexEntry

        Returns boolean

  Returns number

getSpeciesDefaultDexAttr

• getSpeciesDefaultDexAttr(species, forSeen?, optimistic?): bigint

• Parameters

  • species: default
  • forSeen: boolean = false
  • optimistic: boolean = false

  Returns bigint

getSpeciesDefaultNature

• getSpeciesDefaultNature(species): Nature

• Parameters

  • species: default

  Returns Nature

getSpeciesDefaultNatureAttr

• getSpeciesDefaultNatureAttr(species): number

• Parameters

  • species: default

  Returns number

getSpeciesDexAttrProps

• getSpeciesDexAttrProps(species, dexAttr): DexAttrProps

• Parameters

  • species: default
  • dexAttr: bigint

  Returns DexAttrProps

getSpeciesStarterValue

• getSpeciesStarterValue(speciesId): number

• Parameters

  • speciesId: Species

  Returns number

getStarterCount

• getStarterCount(dexEntryPredicate): number

• Parameters

  • dexEntryPredicate: ((entry) => boolean)
    • • (entry): boolean

      • Parameters

        • entry: DexEntry

        Returns boolean

  Returns number

getStarterSpeciesDefaultAbilityIndex

• getStarterSpeciesDefaultAbilityIndex(species): number

• Parameters

  • species: default

  Returns number

getSystemSaveData

• getSystemSaveData(): SystemSaveData

• Returns SystemSaveData

getTutorialFlags

• getTutorialFlags(): TutorialFlags

• Returns TutorialFlags

importData

• importData(dataType, slotId?): void

• Parameters

  • dataType: GameDataType
  • slotId: number = 0

  Returns void

incrementRibbonCount

• incrementRibbonCount(species, forStarter?): number

• Parameters

  • species: default
  • forStarter: boolean = false

  Returns number

initSystem

• initSystem(systemDataStr, cachedSystemDataStr?): Promise<boolean>

• Parameters

  • systemDataStr: string
  • Optional cachedSystemDataStr: string

  Returns Promise<boolean>

loadSession

• loadSession(scene, slotId, sessionData?): Promise<boolean>

• Parameters

  • scene: default
  • slotId: number
  • Optional sessionData: SessionSaveData

  Returns Promise<boolean>

loadSystem

• loadSystem(): Promise<boolean>

• Returns Promise<boolean>

migrateStarterAbilities

• migrateStarterAbilities(systemData, initialStarterData?): void

• Parameters

  • systemData: SystemSaveData
  • Optional initialStarterData: StarterData

  Returns void

offlineNewClear

• offlineNewClear(scene): Promise<boolean>

• Parameters

  • scene: default

  Returns Promise<boolean>

parseSessionData

• parseSessionData(dataStr): SessionSaveData

• Parameters

  • dataStr: string

  Returns SessionSaveData

saveAll

• saveAll(scene, skipVerification?, sync?, useCachedSession?, useCachedSystem?): Promise<boolean>

• Parameters

  • scene: default
  • skipVerification: boolean = false
  • sync: boolean = false
  • useCachedSession: boolean = false
  • useCachedSystem: boolean = false

  Returns Promise<boolean>

saveSetting

• saveSetting(setting, valueIndex): boolean

• Parameters

  • setting: Setting
  • valueIndex: number

  Returns boolean

saveSystem

• saveSystem(): Promise<boolean>

• Returns Promise<boolean>

saveTutorialFlag

• saveTutorialFlag(tutorial, flag): boolean

• Parameters

  • tutorial: Tutorial
  • flag: boolean

  Returns boolean

setEggMoveUnlocked

• setEggMoveUnlocked(species, eggMoveIndex): Promise<boolean>

• Parameters

  • species: default
  • eggMoveIndex: number

  Returns Promise<boolean>

setPokemonCaught

• setPokemonCaught(pokemon, incrementCount?, fromEgg?): Promise<void>

• Parameters

  • pokemon: default
  • incrementCount: boolean = true
  • fromEgg: boolean = false

  Returns Promise<void>

setPokemonSeen

• setPokemonSeen(pokemon, incrementCount?, trainer?): void

• Parameters

  • pokemon: default
  • incrementCount: boolean = true
  • trainer: boolean = false

  Returns void

setPokemonSpeciesCaught

• setPokemonSpeciesCaught(pokemon, species, incrementCount?, fromEgg?): Promise<void>

• Parameters

  • pokemon: default
  • species: default
  • incrementCount: boolean = true
  • fromEgg: boolean = false

  Returns Promise<void>

tryClearSession

• tryClearSession(scene, slotId): Promise<[success: boolean, newClear: boolean]>

• Parameters

  • scene: default
  • slotId: number

  Returns Promise<[success: boolean, newClear: boolean]>

tryExportData

• tryExportData(dataType, slotId?): Promise<boolean>

• Parameters

  • dataType: GameDataType
  • slotId: number = 0

  Returns Promise<boolean>

updateSpeciesDexIvs

• updateSpeciesDexIvs(speciesId, ivs): void

• Parameters

  • speciesId: Species
  • ivs: number[]

  Returns void

verify

• verify(): Promise<boolean>

• Returns Promise<boolean>