Class GameMode

Implements

GameModeConfig

Constructors

constructor

new GameMode(
    modeId: GameModes,
    config: GameModeConfig,
    battleConfig?: FixedBattleConfigs,
): GameMode
Parameters
- modeId: GameModes
- config: GameModeConfig
- OptionalbattleConfig: FixedBattleConfigs
Returns GameMode
- Defined in src/game-mode.ts:60

Properties

battleConfig

battleConfig: FixedBattleConfigs

challenges

challenges: Challenge[]

`Optional`dailyConfig

dailyConfig?: CustomDailyRunConfig

hasMysteryEncounters

hasMysteryEncounters: boolean

hasNoShop

hasNoShop: boolean

hasRandomBiomes

hasRandomBiomes: boolean

hasRandomBosses

hasRandomBosses: boolean

hasShortBiomes

hasShortBiomes: boolean

hasTrainers

hasTrainers: boolean

isChallenge

isChallenge: boolean

isClassic

isClassic: boolean

isDaily

isDaily: boolean

isEndless

isEndless: boolean

isSplicedOnly

isSplicedOnly: boolean

maxMysteryEncounterWave

maxMysteryEncounterWave: number

minMysteryEncounterWave

minMysteryEncounterWave: number

modeId

modeId: GameModes

Methods

getClearScoreBonus

getClearScoreBonus(): number
Returns number
- Defined in src/game-mode.ts:383

getEnemyModifierChance

getEnemyModifierChance(isBoss: boolean): number
Parameters
- isBoss: boolean
Returns number
- Defined in src/game-mode.ts:395

getFixedBattle

getFixedBattle(waveIndex: number): FixedBattleConfig | undefined
Returns the config for the fixed battle for a particular wave.
Parameters
- waveIndex: number
  The wave to check.
Returns FixedBattleConfig | undefined
The fixed battle for this wave.
- Defined in src/game-mode.ts:365

getMysteryEncounterLegalWaves

getMysteryEncounterLegalWaves(): [minWave: number, maxWave: number]
Returns the wave range where MEs can spawn for the game mode [min, max]

Returns [minWave: number, maxWave: number]
- Defined in src/game-mode.ts:425

getName

getName(): string
Returns string
- Defined in src/game-mode.ts:407

getOverrideSpecies

getOverrideSpecies(waveIndex: number): PokemonSpecies | null
Parameters
- waveIndex: number
Returns PokemonSpecies | null
- Defined in src/game-mode.ts:264

getShopStatus

getShopStatus(): boolean
Check if the current game mode has the shop enabled or not

Returns boolean
Whether the shop is available in the current mode
- Defined in src/game-mode.ts:377

getStartingBiome

getStartingBiome(): BiomeId
Returns BiomeId
either:
- override from overrides.ts
- random biome for Daily mode
- Town
- Defined in src/game-mode.ts:179

getStartingLevel

getStartingLevel(): number
Helper function to get starting level for game mode.

Returns number
either:
- starting level override from overrides.ts
- 20 for Daily Runs
- 5 for all other modes
- Defined in src/game-mode.ts:137

getStartingMoney

getStartingMoney(): number
Returns number
either:
- override from overrides.ts
- 1000
- override from a custom daily seed
- Defined in src/game-mode.ts:155

getWaveForDifficulty

getWaveForDifficulty(waveIndex: number, ignoreCurveChanges?: boolean): number
Parameters
- waveIndex: number
- ignoreCurveChanges: boolean = false
Returns number
- Defined in src/game-mode.ts:192

hasAnyChallenges

hasAnyChallenges(): boolean
Helper function to see if a GameMode has any challenges, needed in tests

Returns boolean
true if the game mode has at least one challenge
- Defined in src/game-mode.ts:105

hasChallenge

hasChallenge(challenge: Challenges): 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
- Defined in src/game-mode.ts:97

isBattleClassicFinalBoss

isBattleClassicFinalBoss(waveIndex: number): boolean
Parameters
- waveIndex: number
Returns boolean
true if the current battle is against classic mode's final boss
- Defined in src/game-mode.ts:315

isBoss

isBoss(waveIndex: number): boolean
Every 10 waves is a boss battle
Parameters
- waveIndex: number
Returns boolean
true if waveIndex is a multiple of 10
- Defined in src/game-mode.ts:308

isEndlessBoss

isEndlessBoss(waveIndex: number): boolean
Check whether the current wave is an Endless boss of any kind.
Parameters
- waveIndex: number
  The current wave number.
Returns boolean
Whether waveIndex corresponds to an Endless boss.
- Defined in src/game-mode.ts:324

isEndlessMajorBoss

isEndlessMajorBoss(waveIndex: number): 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
- Defined in src/game-mode.ts:343

isEndlessMinorBoss

isEndlessMinorBoss(waveIndex: number): boolean
Check whether the current wave is an Endless minor boss. Currently is normal Eternatus.
Parameters
- waveIndex: number
  The current wave number.
Returns boolean
Whether waveIndex is a multiple of 250 during endless mode.
- Defined in src/game-mode.ts:334

isFixedBattle

isFixedBattle(waveIndex: number): 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
- Defined in src/game-mode.ts:352

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
- Defined in src/game-mode.ts:113

isFullFreshStartChallenge

isFullFreshStartChallenge(): boolean
Helper function to see if the game mode is using fresh start

Returns boolean
true if a fresh start challenge is being applied
- Defined in src/game-mode.ts:121

isTrainerBoss

isTrainerBoss(
    waveIndex: number,
    biomeType: BiomeId,
    offsetGym: boolean,
): boolean
Parameters
- waveIndex: number
- biomeType: BiomeId
- offsetGym: boolean
Returns boolean
- Defined in src/game-mode.ts:252

isWaveFinal

isWaveFinal(waveIndex: number, modeId?: GameModes): 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
- Defined in src/game-mode.ts:291

isWaveTrainer

isWaveTrainer(waveIndex: number): 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)
Returns boolean
Whether a trainer should be generated
- Defined in src/game-mode.ts:206

setChallengeValue

setChallengeValue(challenge: Challenges, value: number, severity?: number): void
Enables challenges if they are disabled and sets the specified challenge's value
Parameters
- challenge: Challenges
  The challenge to set
- value: number
  The value to give the challenge. Impact depends on the specific challenge
- Optionalseverity: number
  If provided, will override the given severity amount. Unused if challenge does not use severity
Returns void
Todo
Add severity support to daily mode challenge setting
- Defined in src/game-mode.ts:77

trySetCustomDailyConfig

trySetCustomDailyConfig(seed: string): string
Sets the daily config if the seed is a custom seed.
Parameters
- seed: string
  The seed to check
Returns string
The seed to use.

Remarks
If it is not a custom seed, it will return the original seed.
- Defined in src/game-mode.ts:443

`Static`getModeName

getModeName(modeId: GameModes): string
Parameters
- modeId: GameModes
Returns string
- Defined in src/game-mode.ts:448