Class Arena

constructor

• new Arena(scene, biome, bgm): Arena

• Parameters

  • scene: default
  • biome: Biome
  • bgm: string

  Returns Arena

bgm

biomeType

ReadonlyeventTarget

ignoreAbilities

scene

tags

terrain

weather

addTag

• addTag(tagType, turnCount, sourceMove, sourceId, side?, quiet?, targetIndex?): boolean

• Parameters

  • tagType: ArenaTagType
  • turnCount: number
  • sourceMove: undefined | Moves
  • sourceId: number
  • side: ArenaTagSide = ArenaTagSide.BOTH
  • quiet: boolean = false
  • OptionaltargetIndex: BattlerIndex

  Returns boolean

applyTags

• applyTags(tagType, ...args): void

• Parameters

  • tagType: ArenaTagType | Constructor<ArenaTag>
  • Rest...args: unknown[]

  Returns void

applyTagsForSide

• applyTagsForSide(tagType, side, ...args): void

• Parameters

  • tagType: ArenaTagType | Constructor<ArenaTag>
  • side: ArenaTagSide
  • Rest...args: unknown[]

  Returns void

findTags

• findTags(tagPredicate): ArenaTag[]

• Parameters

  • tagPredicate: ((t: ArenaTag) => boolean)
    • • (t): boolean

      • Parameters

        • t: ArenaTag

        Returns boolean

  Returns ArenaTag[]

findTagsOnSide

• findTagsOnSide(tagPredicate, side): ArenaTag[]

• Parameters

  • tagPredicate: ((t: ArenaTag) => boolean)
    • • (t): boolean

      • Parameters

        • t: ArenaTag

        Returns boolean

  • side: ArenaTagSide

  Returns ArenaTag[]

getAttackTypeMultiplier

• getAttackTypeMultiplier(attackType, grounded): number

• Parameters

  • attackType: Type
  • grounded: boolean

  Returns number

getBgTerrainColorRatioForBiome

• getBgTerrainColorRatioForBiome(): number

• Returns number

getBgmLoopPoint

• getBgmLoopPoint(): number

• Returns number

getDayTint

• getDayTint(): [number, number, number]

• Returns [number, number, number]

getDuskTint

• getDuskTint(): [number, number, number]

• Returns [number, number, number]

getNightTint

• getNightTint(): [number, number, number]

• Returns [number, number, number]

getSpeciesFormIndex

• getSpeciesFormIndex(species): number

• Parameters

  • species: default

  Returns number

getTag

• getTag(tagType): undefined | ArenaTag

• Parameters

  • tagType: ArenaTagType | Constructor<ArenaTag>

  Returns undefined | ArenaTag

getTagOnSide

• getTagOnSide(tagType, side): undefined | ArenaTag

• Parameters

  • tagType: ArenaTagType | Constructor<ArenaTag>
  • side: ArenaTagSide

  Returns undefined | ArenaTag

getTerrainType

• getTerrainType(): TerrainType

• Returns TerrainType

getTimeOfDay

• getTimeOfDay(): TimeOfDay

• Returns TimeOfDay

getTrainerChance

• getTrainerChance(): number

• Gets the denominator for the chance for a trainer spawn

  Returns number

  n where 1/n is the chance of a trainer battle

getTypeForBiome

• getTypeForBiome():
      | UNKNOWN
      | NORMAL
      | FIGHTING
      | FLYING
      | POISON
      | GROUND
      | ROCK
      | BUG
      | GHOST
      | STEEL
      | FIRE
      | WATER
      | GRASS
      | ELECTRIC
      | PSYCHIC
      | ICE
      | DRAGON
      | DARK
      | FAIRY

• Returns
      | UNKNOWN
      | NORMAL
      | FIGHTING
      | FLYING
      | POISON
      | GROUND
      | ROCK
      | BUG
      | GHOST
      | STEEL
      | FIRE
      | WATER
      | GRASS
      | ELECTRIC
      | PSYCHIC
      | ICE
      | DRAGON
      | DARK
      | FAIRY

hasTag

• hasTag(tagType): boolean

• Parameters

  • tagType: ArenaTagType

  Returns boolean

init

• init(): void

• Returns void

isMoveTerrainCancelled

• isMoveTerrainCancelled(user, targets, move): null | boolean

• Parameters

  • user: default
  • targets: BattlerIndex[]
  • move: default

  Returns null | boolean

isMoveWeatherCancelled

• isMoveWeatherCancelled(user, move): null | boolean

• Parameters

  • user: default
  • move: default

  Returns null | boolean

isOutside

• isOutside(): boolean

• Returns boolean

lapseTags

• lapseTags(): void

• Returns void

overrideTint

• overrideTint(): [number, number, number]

• Returns [number, number, number]

preloadBgm

• preloadBgm(): void

• Returns void

randomSpecies

• randomSpecies(waveIndex, level, attempt?, luckValue?): default

• Parameters

  • waveIndex: number
  • level: number
  • Optionalattempt: number
  • OptionalluckValue: number

  Returns default

randomTrainerType

• randomTrainerType(waveIndex): TrainerType

• Parameters

  • waveIndex: number

  Returns TrainerType

removeAllTags

• removeAllTags(): void

• Returns void

removeTag

• removeTag(tagType): boolean

• Parameters

  • tagType: ArenaTagType

  Returns boolean

removeTagOnSide

• removeTagOnSide(tagType, side, quiet?): boolean

• Parameters

  • tagType: ArenaTagType
  • side: ArenaTagSide
  • quiet: boolean = false

  Returns boolean

resetArenaEffects

• resetArenaEffects(): void

• Clears weather, terrain and arena tags when entering new biome or trainer battle.

  Returns void

setIgnoreAbilities

• setIgnoreAbilities(ignoreAbilities?): void

• Parameters

  • ignoreAbilities: boolean = true

  Returns void

triggerWeatherBasedFormChanges

• triggerWeatherBasedFormChanges(): void

• Function to trigger all weather based form changes

  Returns void

triggerWeatherBasedFormChangesToNormal

• triggerWeatherBasedFormChangesToNormal(): void

• Function to trigger all weather based form changes back into their normal forms

  Returns void

trySetTerrain

• trySetTerrain(terrain, hasPokemonSource, ignoreAnim?): boolean

• Parameters

  • terrain: TerrainType
  • hasPokemonSource: boolean
  • ignoreAnim: boolean = false

  Returns boolean

trySetWeather

• trySetWeather(weather, hasPokemonSource): boolean

• Attempts to set a new weather to the battle

  Parameters

  • weather: WeatherType

    new weather to set of type WeatherType
  • hasPokemonSource: boolean

    is the new weather from a pokemon

  Returns boolean

  true if new weather set, false if no weather provided or attempting to set the same weather as currently in use

trySetWeatherOverride

• trySetWeatherOverride(weather): boolean

• Sets weather to the override specified in overrides.ts

  Parameters

  • weather: WeatherType

    new weather to set of type WeatherType

  Returns boolean

  true to force trySetWeather to return true

updatePoolsForTimeOfDay

• updatePoolsForTimeOfDay(): void

• Returns void