PokéRogue
    Preparing search index...
    Index

    Constructors

    Properties

    bgm: string
    biomeType: BiomeId
    eventTarget: EventTarget = ...
    ignoreAbilities: boolean
    ignoringEffectSource: null | BattlerIndex
    lastTimeOfDay: TimeOfDay
    playerFaints: number

    Saves the number of times a party pokemon faints during a arena encounter. globalScene.currentBattle.enemyFaints is the corresponding faint counter for the enemy (this resets every wave).

    playerTerasUsed: number = 0
    pokemonPool: PokemonPools
    positionalTagManager: PositionalTagManager = ...

    All currently-active PositionalTags on both sides of the field, sorted by tag type.

    tags: ArenaTag[] = []

    All currently-active ArenaTags on both sides of the field.

    terrain: null | Terrain
    weather: null | Weather

    Methods

    • Add a new ArenaTag to the arena, triggering overlap effects on existing tags as applicable.

      Parameters

      • tagType: ArenaTagType

        The ArenaTagType of the tag to add.

      • turnCount: number

        The number of turns the newly-added tag should last.

      • sourceMove: undefined | MoveId

        The MoveId of the move creating the tag, or undefined if not from a move.

      • sourceId: number

        The PID of the Pokemon creating the tag.

      • side: ArenaTagSide = ArenaTagSide.BOTH

        The ArenaTagSide(s) to which the tag should apply; default ArenaTagSide.BOTH.

      • quiet: boolean = false

        Whether to suppress messages produced by tag addition; default false.

      Returns boolean

      true if the tag was successfully added without overlapping. // TODO: Do we need the return value here? literally nothing uses it

    • The loop point of any given biome track, read as seconds and milliseconds.

      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 PokemonSpecies

    • Find and remove all ArenaTags with the given tag types on the given side of the field.

      Parameters

      Returns void

      Review the other tag manipulation functions to see if they can be migrated towards using this (more efficient)

    • 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

      Parameters

      • Optionalsource: Pokemon

        The Pokemon causing the changes by removing itself from the field

      Returns void

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

      Returns void

    • Attempts to set a new terrain effect to the battle

      Parameters

      Returns boolean

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