PokéRogue
    Preparing search index...

    A BattlerTag represents a semi-persistent effect that can be attached to a Pokemon. Tags can trigger various effects throughout a turn, and are cleared on switching out or through their respective lapse methods.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    __SerializableBattlerTag: never

    Nonexistent, dummy field to allow typescript to distinguish this class from BattlerTag.

    Does not exist at runtime, so must not be used!

    sourceId?: number

    The PID of the Pokemon that added this 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.

    turnCount: number

    The tag's remaining duration.

    Accessors

    Methods

    • Check whether this Tag can be transferred to another Pokemon via Baton Pass.

      Parameters

      • recipient: Pokemon

        The Pokemon receiving this Tag (i.e. the one switching in) Unused by default but exposed to allow for subclasses to perform custom logic.

      Returns boolean

      Whether this Tag can be transferred via Baton Pass. Defaults to returning the value set in the class constructor.

    • Apply the battler tag's effects based on the lapse type

      Parameters

      Returns boolean

      true if the tag should be kept (turnCount > 0 by default)

      Generally, this involves ticking down the tag's duration. The tag also initiates the effects it is responsbile for