Class ContactStatStageChangeProtectedTag

BattlerTag class for moves that block damaging moves and lower enemy stats if the enemy's move makes contact Used by MoveId.KINGS_SHIELD, MoveId.OBSTRUCT, MoveId.SILK_TRAP

Hierarchy (View Summary)

DamageProtectedTag
- ContactStatStageChangeProtectedTag

Index

Constructors

constructor

new ContactStatStageChangeProtectedTag(
    sourceMove: MoveId,
    tagType: ContactStatStageChangeProtectedTagType,
    stat: ATK | DEF | SPATK | SPDEF | SPD | ACC | EVA,
    levels: number,
): ContactStatStageChangeProtectedTag
Parameters
- sourceMove: MoveId
- tagType: ContactStatStageChangeProtectedTagType
- stat: ATK | DEF | SPATK | SPDEF | SPD | ACC | EVA
- levels: number
Returns ContactStatStageChangeProtectedTag
Overrides DamageProtectedTag.constructor
- Defined in src/data/battler-tags.ts:1875

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

turnCount

turnCount: number

The tag's remaining duration

Accessors

isBatonPassable

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

lapseTypes

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

Methods

canAdd

canAdd(_pokemon: Pokemon): boolean
Parameters
- _pokemon: Pokemon
Returns boolean
Inherited from DamageProtectedTag.canAdd
- Defined in src/data/battler-tags.ts:148

getDescriptor

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

getMoveName

getMoveName(): null | string
Returns null | string
Inherited from DamageProtectedTag.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 DamageProtectedTag.getSourcePokemon
- Defined in src/data/battler-tags.ts:201

isSourceLinked

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

lapse

lapse(pokemon: Pokemon, lapseType: BattlerTagLapseType): boolean
Lapse the tag and apply onContact if the move makes contact and lapseType is custom, respecting the move's flags and the pokemon's abilities, and whether the lapseType is custom.
Parameters
- pokemon: Pokemon
  The pokemon with the tag
- lapseType: BattlerTagLapseType
  The type of lapse to apply. If this is not CUSTOM, no effect will be applied.
Returns boolean
Whether the tag continues to exist after the lapse.
Inherited from DamageProtectedTag.lapse
- Defined in src/data/battler-tags.ts:1790

loadTag

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

onAdd

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

onContact

onContact(attacker: Pokemon, _user: Pokemon): void
Initiate the stat stage change on the attacker
Parameters
- attacker: Pokemon
  The pokemon using the contact move
- _user: Pokemon
Returns void
Overrides DamageProtectedTag.onContact
- Defined in src/data/battler-tags.ts:1887

onOverlap

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

onRemove

onRemove(_pokemon: Pokemon): void
Parameters
- _pokemon: Pokemon
Returns void
Inherited from DamageProtectedTag.onRemove
- Defined in src/data/battler-tags.ts:158

Class ContactStatStageChangeProtectedTag

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ContactStatStageChangeProtectedTag

Properties

OptionalsourceId

OptionalsourceMove

ReadonlytagType

turnCount

Accessors

isBatonPassable

Returns boolean

lapseTypes

Returns readonly BattlerTagLapseType[]

Methods

canAdd

Parameters

Returns boolean

getDescriptor

Returns string

getMoveName

Returns null | string

getSourcePokemon

Returns null | Pokemon

isSourceLinked

Returns boolean

lapse

Parameters

Returns boolean

loadTag

Type Parameters

Parameters

Returns void

onAdd

Parameters

Returns void

onContact

Parameters

Returns void

onOverlap

Parameters

Returns void

onRemove

Parameters

Returns void

Settings

On This Page

`Optional`sourceId

`Optional`sourceMove

`Readonly`tagType