Class ContactDamageProtectedTag`Sealed`

BattlerTag class for moves that block damaging moves damage the enemy if the enemy's move makes contact Used by MoveId.SPIKY_SHIELD

Hierarchy (View Summary)

ContactProtectedTag
- ContactDamageProtectedTag

Index

Constructors

constructor

new ContactDamageProtectedTag(
sourceMove: MoveId,
damageRatio: number,
): ContactDamageProtectedTag
Parameters
- sourceMove: MoveId
- damageRatio: number
Returns ContactDamageProtectedTag
Overrides ContactProtectedTag.constructor
- Defined in src/data/battler-tags.ts:1816

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

turnCount

turnCount: number

The tag's remaining duration

Accessors

isBatonPassable

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

lapseTypes

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

Methods

canAdd

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

getDescriptor

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

getMoveName

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

isSourceLinked

isSourceLinked(): boolean
Returns boolean
Inherited from ContactProtectedTag.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 ContactProtectedTag.lapse
- Defined in src/data/battler-tags.ts:1790

loadTag

loadTag<const T extends ContactDamageProtectedTag>(
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 ContactDamageProtectedTag
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: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 ContactProtectedTag.onAdd
- Defined in src/data/battler-tags.ts:1741

onContact

onContact(attacker: Pokemon, user: Pokemon): void
Damage the attacker by this.damageRatio of the target's max HP
Parameters
- attacker: Pokemon
  The pokemon using the contact move
- user: Pokemon
  The pokemon that is being attacked and has the tag
Returns void
Overrides ContactProtectedTag.onContact
- Defined in src/data/battler-tags.ts:1826

onOverlap

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

onRemove

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

Class ContactDamageProtectedTagSealed

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ContactDamageProtectedTag

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

Class ContactDamageProtectedTag`Sealed`

`Optional`sourceId

`Optional`sourceMove

`Readonly`tagType