PokéRogue
    Preparing search index...

    Class ConditionalProtectTagAbstract

    Class to implement conditional team protection applies protection based on the attributes of incoming moves

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    ignoresBypass: boolean

    Whether this protection effect should apply to all moves, including ones that ignore other forms of protection.

    false

    maxDuration: number

    The tag's max duration.

    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: ArenaTagType

    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 condition(): ProtectConditionFunc

      The condition function to determine which moves are negated.

      Returns ProtectConditionFunc

    • 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 onProtectMessageKey(): string

      Return the message key that will be used when protecting an allied target. Within the text, the following variables will be populated:

      • {{pokemonNameWithAffix}}: The name of the Pokemon protected by the attack
      • {{moveName}}: The name of the move that created the tag
      • {{attackName}}: The name of the move that triggered the protection effect.

      Returns string

      arenaTag:conditionalProtectApply

    • 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

    • Reduce this ArenaTag's duration and apply any end-of-turn effects Will ignore durations of all tags with durations <=0.

      Returns boolean

      true if this tag should be kept; false if it should be removed.

    • 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