Class FormBlockDamageTag

Common attributes of form change abilities that block damage

Hierarchy (View Summary)

SerializableBattlerTag
- FormBlockDamageTag
  - IceFaceBlockDamageTag

Index

Constructors

Properties

sourceId? sourceMove? tagType turnCount

Accessors

isBatonPassable lapseTypes

Methods

canAdd getDescriptor getMoveName getSourcePokemon isSourceLinked lapse loadTag onAdd onOverlap onRemove

Constructors

constructor

new FormBlockDamageTag(tagType: ICE_FACE | DISGUISE): FormBlockDamageTag
Parameters
- tagType: ICE_FACE | DISGUISE
Returns FormBlockDamageTag
Overrides SerializableBattlerTag.constructor
- Defined in src/data/battler-tags.ts:2556

Properties

`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: ICE_FACE | DISGUISE

turnCount

turnCount: number

The tag's remaining duration

Accessors

isBatonPassable

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

lapseTypes

get lapseTypes(): readonly BattlerTagLapseType[]
Returns readonly BattlerTagLapseType[]
Inherited from SerializableBattlerTag.lapseTypes
- Defined in src/data/battler-tags.ts:124

Methods

canAdd

canAdd(pokemon: Pokemon): boolean
Determines if the tag can be added to the Pokémon.
Parameters
- pokemon: Pokemon
  The Pokémon to which the tag might be added.
Returns boolean
true if the tag can be added, false otherwise.
Overrides SerializableBattlerTag.canAdd
- Defined in src/data/battler-tags.ts:2565

getDescriptor

getDescriptor(): string
Returns string
Inherited from SerializableBattlerTag.getDescriptor
- Defined in src/data/battler-tags.ts:174

getMoveName

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

getSourcePokemon

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

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

isSourceLinked

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

lapse

lapse(_pokemon: Pokemon, _lapseType: BattlerTagLapseType): boolean
Tick down this BattlerTag's duration.
Parameters
- _pokemon: Pokemon
  The Pokemon whom this tag belongs to. Unused by default but can be used by subclasses.
- _lapseType: BattlerTagLapseType
  The BattlerTagLapseType being lapsed. Unused by default but can be used by subclasses.
Returns boolean
true if the tag should be kept (turnCount > 0`)
Inherited from SerializableBattlerTag.lapse
- Defined in src/data/battler-tags.ts:170

loadTag

loadTag<const T extends FormBlockDamageTag>(
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 FormBlockDamageTag
Parameters
- source: BaseBattlerTag & Pick<T, "tagType">
  An object containing the fields needed to reconstruct this tag.
Returns void
Inherited from SerializableBattlerTag.loadTag
- Defined in src/data/battler-tags.ts:191

onAdd

onAdd(pokemon: Pokemon): void
Applies the tag to the Pokémon. Triggers a form change if the Pokémon is not in its defense form.
Parameters
- pokemon: Pokemon
  The Pokémon to which the tag is added.
Returns void
Overrides SerializableBattlerTag.onAdd
- Defined in src/data/battler-tags.ts:2574

onOverlap

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

onRemove

onRemove(pokemon: Pokemon): void
Removes the tag from the Pokémon. Triggers a form change when the tag is removed.
Parameters
- pokemon: Pokemon
  The Pokémon from which the tag is removed.
Returns void
Overrides SerializableBattlerTag.onRemove
- Defined in src/data/battler-tags.ts:2587