PokéRogue
    Preparing search index...

    Arena tag to contain stored healing effects, namely from Healing Wish and Lunar Dance. When a damaged Pokemon first enters the effect's field position, their HP is fully restored, and they are cured of any non-volatile status condition. If the effect is from Lunar Dance, their PP is also restored.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    maxDuration: number

    The tag's max duration.

    pendingHeals: Partial<Record<BattlerIndex, PendingHealEffect[]>> = {}

    All pending healing effects, organized by BattlerIndex

    The side of the field that this arena tag affects.

    ArenaTagSide.BOTH

    sourceId: undefined | number

    The PID of the Pokemon having created the tag, or undefined if not set by a Pokemon.

    sourceMove?: MoveId

    The MoveId that created this tag, or undefined if not set by a move.

    tagType: PENDING_HEAL = ArenaTagType.PENDING_HEAL

    The type of the arena tag

    turnCount: number

    The tag's remaining duration. Setting to any number <=0 will make the tag's duration effectively infinite.

    Accessors

    • get i18nSideKey(): string
      Sealed

      Returns string

      A suffix corresponding to this tag's current side.

    • get onAddMessageKey(): string

      Return the i18n locales key that will be shown when this tag is added.
      Within the text, {{pokemonNameWithAffix}} and {{moveName}} will be populated with the name of the Pokemon that added the tag and the name of the move that created the tag, respectively.

      Returns string

      If this evaluates to an empty string, no message will be displayed.

    • get onRemoveMessageKey(): string

      Return the i18n locales key that will be shown when this tag is removed.
      Within the text, {{pokemonNameWithAffix}} and {{moveName}} will be populated with the name of the Pokemon that added the tag and the name of the move that created the tag, respectively.

      Returns string

      If this evaluates to an empty string, no message will be displayed.

    Methods

    • Apply a pending healing effect on the given target index

      Parameters

      • simulated: boolean

        If true, suppresses changes to game state

      • pokemon: Pokemon

        The pokemon receiving the healing effect

      Returns boolean

      Whether the target Pokemon was healed by this effect

      If an effect is found for the index, the Pokemon at that index is healed to full HP, is cured of any non-volatile status, and has its PP fully restored (if the effect is from Lunar Dance).

    • Determines if the given PendingHealEffect can immediately heal the given target Pokemon.

      Parameters

      • healEffect: PendingHealEffect

        The PendingHealEffect to evaluate

      • pokemon: Pokemon

        The Pokemon to evaluate against

      Returns boolean

      true if the Pokemon can be healed by the effect

    • Trigger effects when this tag is added to the Arena. By default, will queue a message with the contents of getOnAddMessage.

      Parameters

      • quiet: boolean = false

        Whether to suppress any messages created during tag addition; default false

      Returns void

    • Trigger effects when this tag is removed from the Arena. By default, will queue a message with the contents of getOnRemoveMessage.

      Parameters

      • quiet: boolean = false

        Whether to suppress any messages created during tag addition; default false

      Returns void

    • Adds a pending healing effect to the field. Effects under the same move and target index as an existing effect are ignored.

      Parameters

      • targetIndex: BattlerIndex

        The BattlerIndex under which the effect applies

      • healEffect: PendingHealEffect

        The PendingHealEffect | data for the pending heal effect

      Returns void