Class GameMode

constructor

• new GameMode(modeId, config, battleConfig?): GameMode

• Parameters

  • modeId: GameModes
  • config: GameModeConfig
  • OptionalbattleConfig: FixedBattleConfigs

  Returns GameMode

battleConfig

challenges

hasMysteryEncounters

hasNoShop

hasRandomBiomes

hasRandomBosses

hasShortBiomes

hasTrainers

isChallenge

isClassic

isDaily

isEndless

isSplicedOnly

maxMysteryEncounterWave

minMysteryEncounterWave

modeId

getClearScoreBonus

• getClearScoreBonus(): number

• Returns number

getEnemyModifierChance

• getEnemyModifierChance(isBoss): number

• Parameters

  • isBoss: boolean

  Returns number

getFixedBattle

• getFixedBattle(waveIndex): FixedBattleConfig

• Returns the config for the fixed battle for a particular wave.

  Parameters

  • waveIndex: number

    The wave to check.

  Returns FixedBattleConfig

  The fixed battle for this wave.

getMysteryEncounterLegalWaves

• getMysteryEncounterLegalWaves(): [number, number]

• Returns the wave range where MEs can spawn for the game mode [min, max]

  Returns [number, number]

getName

• getName(): string

• Returns string

getOverrideSpecies

• getOverrideSpecies(waveIndex): null | default

• Parameters

  • waveIndex: number

  Returns null | default

getStartingBiome

• getStartingBiome(scene): Biome

• Parameters

  • scene: default

    current BattleScene

  Returns Biome

  either:

  • random biome for Daily mode
  • override from overrides.ts
  • Town

getStartingLevel

• getStartingLevel(): number

• Returns number

  either:

  • override from overrides.ts
  • 20 for Daily Runs
  • 5 for all other modes

getStartingMoney

• getStartingMoney(): number

• Returns number

  either:

  • override from overrides.ts
  • 1000

getWaveForDifficulty

• getWaveForDifficulty(waveIndex, ignoreCurveChanges?): number

• Parameters

  • waveIndex: number
  • ignoreCurveChanges: boolean = false

  Returns number

hasChallenge

• hasChallenge(challenge): boolean

• Helper function to see if a GameMode has a specific challenge type

  Parameters

  • challenge: Challenges

    the Challenges it looks for

  Returns boolean

  true if the game mode has that challenge

isBattleClassicFinalBoss

• isBattleClassicFinalBoss(waveIndex): boolean

• Parameters

  • waveIndex: number

  Returns boolean

  true if the current battle is against classic mode's final boss

isBoss

• isBoss(waveIndex): boolean

• Every 10 waves is a boss battle

  Parameters

  • waveIndex: number

  Returns boolean

  true if waveIndex is a multiple of 10

isEndlessBoss

• isEndlessBoss(waveIndex): boolean

• Every 50 waves of an Endless mode is a boss At this time it is paradox pokemon

  Parameters

  • waveIndex: number

  Returns boolean

  true if waveIndex is a multiple of 50 in Endless

isEndlessMajorBoss

• isEndlessMajorBoss(waveIndex): boolean

• Every 1000 waves of an Endless mode is a major boss At this time it is Eternamax Eternatus

  Parameters

  • waveIndex: number

  Returns boolean

  true if waveIndex is a multiple of 1000 in Endless

isEndlessMinorBoss

• isEndlessMinorBoss(waveIndex): boolean

• Every 250 waves of an Endless mode is a minor boss At this time it is Eternatus

  Parameters

  • waveIndex: number

  Returns boolean

  true if waveIndex is a multiple of 250 in Endless

isFixedBattle

• isFixedBattle(waveIndex): boolean

• Checks whether there is a fixed battle on this gamemode on a given wave.

  Parameters

  • waveIndex: number

    The wave to check.

  Returns boolean

  If this game mode has a fixed battle on this wave

isFreshStartChallenge

• isFreshStartChallenge(): boolean

• Helper function to see if the game mode is using fresh start

  Returns boolean

  true if a fresh start challenge is being applied

isTrainerBoss

• isTrainerBoss(waveIndex, biomeType, offsetGym): boolean

• Parameters

  • waveIndex: number
  • biomeType: Biome
  • offsetGym: boolean

  Returns boolean

isWaveFinal

• isWaveFinal(waveIndex, modeId?): boolean

• Checks if wave provided is the final for current or specified game mode

  Parameters

  • waveIndex: number
  • modeId: GameModes = ...

    game mode

  Returns boolean

  if the current wave is final for classic or daily OR a minor boss in endless

isWaveTrainer

• isWaveTrainer(waveIndex, arena): boolean

• Determines whether or not to generate a trainer

  Parameters

  • waveIndex: number

    the current floor the player is on (trainer sprites fail to generate on X1 floors)
  • arena: Arena

    the arena that contains the scene and functions

  Returns boolean

  true if a trainer should be generated, false otherwise

StaticgetModeName

• getModeName(modeId): string

• Parameters

  • modeId: GameModes

  Returns string