Constructors

Properties

bgm: string
biomeType: Biome
eventTarget: EventTarget = ...
ignoreAbilities: boolean
ignoringEffectSource: null | BattlerIndex
scene: default
tags: ArenaTag[]
terrain: null | Terrain
weather: null | Weather

Methods

  • Adds a new tag to the arena

    Parameters

    • tagType: ArenaTagType

      ArenaTagType the tag being added

    • turnCount: number

      How many turns the tag lasts

    • sourceMove: undefined | Moves

      Moves the move the tag came from, or undefined if not from a move

    • sourceId: number

      The ID of the pokemon in play the tag came from (see BattleScene.getPokemonById)

    • side: ArenaTagSide = ArenaTagSide.BOTH

      ArenaTagSide which side(s) the tag applies to

    • quiet: boolean = false

      If a message should be queued on screen to announce the tag being added

    • OptionaltargetIndex: BattlerIndex

      The BattlerIndex of the target pokemon

    Returns boolean

    false if there already exists a tag of this type in the Arena

  • Applies the specified tag to both sides (ie: both user and trainer's tag that match the Tag specified) by calling ()

    Parameters

    • tagType: ArenaTagType | Constructor<ArenaTag>

      Either an ArenaTagType string, or an actual ArenaTag class to filter which ones to apply

    • simulated: boolean

      if true, this applies arena tags without changing game state

    • Rest...args: unknown[]

      array of parameters that the called upon tags may need

    Returns void

  • Applies each ArenaTag in this Arena, based on which side (self, enemy, or both) is passed in as a parameter

    Parameters

    Returns void

  • Returns specific tags from the arena that pass the tagPredicate function passed in as a parameter, and apply to the given side

    Parameters

    Returns ArenaTag[]

    array of ArenaTags from which the Arena's tags return true and apply to the given side

  • Parameters

    • attackType: Type
    • grounded: boolean

    Returns number

  • Gets the denominator for the chance for a trainer spawn

    Returns number

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

  • Parameters

    • waveIndex: number
    • level: number
    • Optionalattempt: number
    • OptionalluckValue: number
    • OptionalisBoss: boolean

    Returns default

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

    Returns void

  • Parameters

    • ignoreAbilities: boolean
    • ignoringEffectSource: null | BattlerIndex = null

    Returns void

  • Function to trigger all weather based form changes

    Returns void

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

    Returns void

  • Parameters

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

    Returns boolean

  • Attempts to set a new weather to the battle

    Parameters

    Returns boolean

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

  • Sets weather to the override specified in overrides.ts

    Parameters

    Returns boolean

    true to force trySetWeather to return true