Class FloatingTag

Battler Tag that lifts the affected Pokemon into the air and provides immunity to Ground type moves.

See

Hierarchy (View Summary)

TypeImmuneTag
- FloatingTag

Index

Constructors

Properties

sourceId? sourceMove? tagType turnCount

Accessors

immuneType isBatonPassable lapseTypes

Methods

canAdd getDescriptor getMoveName getSourcePokemon isSourceLinked lapse loadTag onAdd onOverlap onRemove

Constructors

constructor

new FloatingTag(
    tagType: BattlerTagType,
    sourceMove: MoveId,
    turnCount: number,
): FloatingTag
Parameters
- tagType: BattlerTagType
- sourceMove: MoveId
- turnCount: number
Returns FloatingTag
Overrides TypeImmuneTag.constructor
- Defined in src/data/battler-tags.ts:2277

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

turnCount

turnCount: number

The tag's remaining duration.

Accessors

immuneType

get immuneType(): PokemonType
Returns PokemonType
Inherited from TypeImmuneTag.immuneType
- Defined in src/data/battler-tags.ts:2259

isBatonPassable

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

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

Methods

canAdd

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

getDescriptor

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

getMoveName

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

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 TypeImmuneTag.getSourcePokemon
- Defined in src/data/battler-tags.ts:232

isSourceLinked

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

lapse

lapse(_pokemon: Pokemon, _lapseType: BattlerTagLapseType): boolean
Apply the battler tag's effects based on the lapse type
Parameters
- _pokemon: Pokemon
  The Pokemon whom this tag belongs to. Unused by default but can be used by subclasses.
- _lapseType: BattlerTagLapseType
  The BattlerTagLapseType being lapsed. Unused by default but can be used by subclasses.
Returns boolean
true if the tag should be kept (turnCount > 0`)

Remarks
Generally, this involves ticking down the tag's duration. The tag also initiates the effects it is responsbile for
Inherited from TypeImmuneTag.lapse
- Defined in src/data/battler-tags.ts:196

loadTag

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

onAdd

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

onOverlap

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

onRemove

onRemove(pokemon: Pokemon): void
Parameters
- pokemon: Pokemon
Returns void
Overrides TypeImmuneTag.onRemove
- Defined in src/data/battler-tags.ts:2293