Class IngrainTag

Applies the Ingrain tag to a pokemon

Hierarchy (View Summary)

TrappedTag
- IngrainTag

Index

Constructors

Properties

#isBatonPassable #lapseTypes sourceId? sourceMove? tagType turnCount

Accessors

isBatonPassable lapseTypes

Methods

canAdd getDescriptor getMoveName getSourcePokemon getTrapMessage isSourceLinked lapse loadTag onAdd onOverlap onRemove

Constructors

constructor

new IngrainTag(sourceId: number): IngrainTag
Parameters
- sourceId: number
Returns IngrainTag
Overrides TrappedTag.constructor
- Defined in src/data/battler-tags.ts:1383

Properties

`Private`#isBatonPassable

"#isBatonPassable": boolean = false

`Private`#lapseTypes

"#lapseTypes": readonly [BattlerTagLapseType, BattlerTagLapseType]

`Optional`sourceId

sourceId?: number

The PID of the Pokemon that added this tag, or undefined if not set by a Pokemon.

`Optional`sourceMove

sourceMove?: MoveId

The MoveId that created this tag, or undefined if not set by a move.

`Readonly`tagType

tagType: INGRAIN = BattlerTagType.INGRAIN

turnCount

turnCount: number

The tag's remaining duration.

Accessors

isBatonPassable

get isBatonPassable(): boolean
Returns boolean
Inherited from TrappedTag.isBatonPassable
- Defined in src/data/battler-tags.ts:133

lapseTypes

get lapseTypes(): readonly BattlerTagLapseType[]
The set of lapse types that this tag can be automatically lapsed with. If this is exclusively BattlerTagLapseType.CUSTOM, then the tag can only ever be lapsed manually via Pokemon.lapseTag (or calling the tag's lapse method directly)

Returns readonly BattlerTagLapseType[]
Inherited from TrappedTag.lapseTypes
- Defined in src/data/battler-tags.ts:143

Methods

canAdd

canAdd(pokemon: Pokemon): boolean
Check if the Ingrain tag can be added to the pokemon
Parameters
- pokemon: Pokemon
  The pokemon to check if the tag can be added to
Returns boolean
boolean True if the tag can be added, false otherwise
Overrides TrappedTag.canAdd
- Defined in src/data/battler-tags.ts:1392

getDescriptor

getDescriptor(): string
Returns string
Overrides TrappedTag.getDescriptor
- Defined in src/data/battler-tags.ts:1420

getMoveName

getMoveName(): null | string
Returns null | string
Inherited from TrappedTag.getMoveName
- Defined in src/data/battler-tags.ts:205

getSourcePokemon

getSourcePokemon(): undefined | Pokemon
Helper function that retrieves the source Pokemon object

Returns undefined | Pokemon
The source Pokemon, or undefined if none is found
Inherited from TrappedTag.getSourcePokemon
- Defined in src/data/battler-tags.ts:224

getTrapMessage

getTrapMessage(pokemon: Pokemon): string
Parameters
- pokemon: Pokemon
Returns string
Overrides TrappedTag.getTrapMessage
- Defined in src/data/battler-tags.ts:1414

isSourceLinked

isSourceLinked(): boolean
Returns boolean
Inherited from TrappedTag.isSourceLinked
- Defined in src/data/battler-tags.ts:688

lapse

lapse(pokemon: Pokemon, lapseType: BattlerTagLapseType): boolean
Apply the battler tag's effects based on the lapse type
Parameters
- pokemon: Pokemon
- lapseType: BattlerTagLapseType
Returns boolean
true if the tag should be kept (turnCount > 0`)

Remarks
Generally, this involves ticking down the tag's duration. The tag also initiates the effects it is responsbile for
Overrides TrappedTag.lapse
- Defined in src/data/battler-tags.ts:1396

loadTag

loadTag<const T extends IngrainTag>(
source: BaseBattlerTag & Pick<T, "tagType">,
): void
Load the data for a given BattlerTag or JSON representation thereof. Should be inherited from by any battler tag with custom attributes.
Type Parameters
- const T extends IngrainTag
Parameters
- source: BaseBattlerTag & Pick<T, "tagType">
  An object containing the fields needed to reconstruct this tag
Returns void
Inherited from TrappedTag.loadTag
- Defined in src/data/battler-tags.ts:214

onAdd

onAdd(pokemon: Pokemon): void
Apply effects that occur when the tag is added to a Pokemon
Parameters
- pokemon: Pokemon
Returns void
Inherited from TrappedTag.onAdd
- Defined in src/data/battler-tags.ts:667

onOverlap

onOverlap(_pokemon: Pokemon): void
Parameters
- _pokemon: Pokemon
Returns void
Inherited from TrappedTag.onOverlap
- Defined in src/data/battler-tags.ts:180

onRemove

onRemove(pokemon: Pokemon): void
Parameters
- pokemon: Pokemon
Returns void
Inherited from TrappedTag.onRemove
- Defined in src/data/battler-tags.ts:673