Class FlinchedTag

BattlerTag that represents the Flinch status condition

Hierarchy (View Summary)

BattlerTag
- FlinchedTag

Index

Constructors

Properties

sourceId? sourceMove? tagType turnCount

Accessors

isBatonPassable lapseTypes

Methods

canAdd getDescriptor getMoveName getSourcePokemon isSourceLinked lapse loadTag onAdd onOverlap onRemove

Constructors

constructor

new FlinchedTag(sourceMove: MoveId): FlinchedTag
Parameters
- sourceMove: MoveId
Returns FlinchedTag
Overrides BattlerTag.constructor
- Defined in src/data/battler-tags.ts:710

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

turnCount

turnCount: number

The tag's remaining duration

Accessors

isBatonPassable

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

lapseTypes

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

Methods

canAdd

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

getDescriptor

getDescriptor(): string
Returns string
Overrides BattlerTag.getDescriptor
- Defined in src/data/battler-tags.ts:735

getMoveName

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

isSourceLinked

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

lapse

lapse(pokemon: Pokemon, lapseType: BattlerTagLapseType): boolean
Cancels the flinched Pokemon's currently used move this turn if called mid-execution, or removes the tag at end of turn.
Parameters
- pokemon: Pokemon
  The Pokemon with this tag.
- lapseType: BattlerTagLapseType
  The lapse type used for this function call.
Returns boolean
Whether the tag should remain active.
Overrides BattlerTag.lapse
- Defined in src/data/battler-tags.ts:720

loadTag

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

onOverlap

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

onRemove

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