PokéRogue
    Preparing search index...

    Class DamagingTrapTagAbstract

    Abstract base class for all damaging trapping effects.

    Handles dealing damage and playing the appropriate animation.

    Hierarchy (View Summary)

    Index
    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.

    • get onAddMessageKey(): string

      Return the i18n locales key that will be shown when this tag is added.
      Within the text, {{pokemonNameWithAffix}} and {{sourcePokemonName}} will be populated with the name of the Pokemon to whom this Tag is attached and the source Pokemon's name, respectively.

      Returns string

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

    • get triggerMessageKey(): string
      Sealed

      Returns string

    • Sealed

      Damage the Pokemon to whom this Tag is attached.

      Handles checking for Magic Guard, queueing animations, and other assorted checks.

      Parameters

      Returns void

    • Sealed

      Returns number

    • Returns string | null

    • Helper function that retrieves the source Pokemon object

      Returns Pokemon | undefined

      The source Pokemon, or undefined if none is found

    • 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