PokéRogue
    Preparing search index...

    Class IngrainTag

    BattlerTag to implement the effects of Ingrain.

    Ingrain heals the user for 1/16th of their maximum HP each turn while grounding them and trapping them on-field.

    GroundedTag - Tag used by Ingrain and other effects to forcibly ground target

    Hierarchy (View Summary)

    Index
    constructor
    sourceId? sourceMove? tagType turnCount
    lapseTypes onAddMessageKey
    canAdd getDescriptor getMoveName getSourcePokemon isBatonPassable isSourceLinked lapse loadTag onAdd onOverlap onRemove
    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.

    tagType: INGRAIN = BattlerTagType.INGRAIN
    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.

    • 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

      • pokemon: Pokemon

        The Pokemon whom this tag belongs to. Unused by default but can be used by subclasses.

      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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods