Class ContactStatStageChangeProtectedTag

BattlerTag class for moves that block damaging moves and lower enemy stats if the enemy's move makes contact

See

Hierarchy (View Summary)

ContactProtectedTag
- 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 ContactProtectedTag.constructor
- Defined in src/data/battler-tags.ts:1981

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

blockStatus

get blockStatus(): boolean
Whether this protection effect should block status moves.

Returns boolean
Default Value
true

Remarks
Damaging moves are always blocked, regardless of this flag's state.
Overrides ContactProtectedTag.blockStatus
- Defined in src/data/battler-tags.ts:1977

isBatonPassable

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

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 ContactProtectedTag.lapseTypes
- Defined in src/data/battler-tags.ts:147

Methods

canAdd

canAdd(pokemon: Pokemon): boolean
Parameters
- pokemon: Pokemon
Returns boolean
Inherited from ContactProtectedTag.canAdd
- Defined in src/data/battler-tags.ts:175

getDescriptor

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

getMoveName

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

getSourcePokemon

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

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

isSourceLinked

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

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 ContactProtectedTag.lapse
- Defined in src/data/battler-tags.ts:1876

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 ContactProtectedTag.loadTag
- Defined in src/data/battler-tags.ts:223

onAdd

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

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 ContactProtectedTag.onContact
- Defined in src/data/battler-tags.ts:1993

onOverlap

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

onRemove

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

Class ContactStatStageChangeProtectedTag

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ContactStatStageChangeProtectedTag

Properties

OptionalsourceId

OptionalsourceMove

ReadonlytagType

turnCount

Accessors

blockStatus

Returns boolean

Default Value

Remarks

isBatonPassable

Returns boolean

lapseTypes

Returns readonly BattlerTagLapseType[]

Methods

canAdd

Parameters

Returns boolean

getDescriptor

Returns string

getMoveName

Returns string | null

getSourcePokemon

Returns Pokemon | undefined

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