Class AbilityBattlerTag

Hierarchy (View Summary)

BattlerTag
- AbilityBattlerTag

Index

Constructors

Properties

ability isBatonPassable lapseTypes sourceId? sourceMove tagType turnCount

Methods

canAdd getDescriptor getMoveName getSourcePokemon isSourceLinked lapse loadTag onAdd onOverlap onRemove

Constructors

constructor

new AbilityBattlerTag(
    tagType: BattlerTagType,
    ability: Abilities,
    lapseType: BattlerTagLapseType,
    turnCount: number,
): AbilityBattlerTag
Parameters
- tagType: BattlerTagType
- ability: Abilities
- lapseType: BattlerTagLapseType
- turnCount: number
Returns AbilityBattlerTag
Overrides BattlerTag.constructor
- Defined in src/data/battler-tags.ts:1873

Properties

ability

ability: Abilities

isBatonPassable

isBatonPassable: boolean

lapseTypes

lapseTypes: BattlerTagLapseType[]

`Optional`sourceId

sourceId?: number

sourceMove

sourceMove: Moves

tagType

tagType: BattlerTagType

turnCount

turnCount: number

Methods

canAdd

canAdd(_pokemon: default): boolean
Parameters
- _pokemon: default
Returns boolean
Inherited from BattlerTag.canAdd
- Defined in src/data/battler-tags.ts:85

getDescriptor

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

getMoveName

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

getSourcePokemon

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

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

isSourceLinked

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

lapse

lapse(_pokemon: default, _lapseType: BattlerTagLapseType): boolean
Tick down this BattlerTag's duration.
Parameters
- _pokemon: default
- _lapseType: BattlerTagLapseType
Returns boolean
true if the tag should be kept (turnCount > 0`)
Inherited from BattlerTag.lapse
- Defined in src/data/battler-tags.ts:99

loadTag

loadTag(source: any): void
When given a battler tag or json representing one, load the data for it.
Parameters
- source: any
  A battler tag
Returns void
Overrides BattlerTag.loadTag
- Defined in src/data/battler-tags.ts:1883

onAdd

onAdd(_pokemon: default): void
Parameters
- _pokemon: default
Returns void
Inherited from BattlerTag.onAdd
- Defined in src/data/battler-tags.ts:89

onOverlap

onOverlap(_pokemon: default): void
Parameters
- _pokemon: default
Returns void
Inherited from BattlerTag.onOverlap
- Defined in src/data/battler-tags.ts:93

onRemove

onRemove(_pokemon: default): void
Parameters
- _pokemon: default
Returns void
Inherited from BattlerTag.onRemove
- Defined in src/data/battler-tags.ts:91