PokéRogue
    Preparing search index...

    This arena tag facilitates the application of the move Imprison Imprison remains in effect as long as the source Pokemon is active and present on the field. Imprison will apply to any opposing Pokemon that switch onto the field as well.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    layers: number = 1

    The current number of layers this tag has.
    Starts at 1 and increases each time the trap is laid.

    maxDuration: number

    The tag's max duration.

    The side of the field that this arena tag affects.

    ArenaTagSide.BOTH

    sourceId: number | undefined

    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: IMPRISON = ArenaTagType.IMPRISON

    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 groundedOnly(): boolean

      Whether this tag should only affect grounded targets; default true

      Returns boolean

    • get i18nSideKey(): string
      Sealed

      Returns string

      A suffix corresponding to this tag's current side.

    • get maxLayers(): 1

      The maximum number of layers this tag can have.

      Returns 1

    • 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

    • This applies the effects of Imprison to any opposing Pokemon that switch into the field while the source Pokemon is still active

      Parameters

      • _simulated: boolean
      • pokemon: Pokemon

        The Pokemon Imprison is applied to

      Returns boolean

      true

    • Activate the hazard effect onto a Pokemon when it enters the field.

      Parameters

      • simulated: boolean

        Whether to suppress activation effects during execution

      • pokemon: Pokemon

        The Pokemon triggering this hazard

      Returns boolean

      true if this hazard affects the given Pokemon; false otherwise.

    • Check if the maximum number of layers for this tag has been reached.

      Returns boolean

      Whether this tag can have another layer added to it.

    • When the arena tag is removed, it also attempts to remove any related Battler Tags if they haven't already been removed from the affected Pokemon

      Parameters

      • quiet: boolean = false

      Returns void