Class FloatingTag

OptionalsourceId

OptionalsourceMove

turnCount

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[]

canAdd

• canAdd(pokemon: Pokemon): boolean

  Parameters

  • pokemon: Pokemon

  Returns boolean

getDescriptor

• getDescriptor(): string

  Returns string

getMoveName

• getMoveName(): string | null

  Returns string | null

getSourcePokemon

• getSourcePokemon(): Pokemon | undefined

  Helper function that retrieves the source Pokemon object

  Returns Pokemon | undefined

  The source Pokemon, or undefined if none is found

isBatonPassable

• isBatonPassable(recipient: Pokemon): boolean

  Check whether this Tag can be transferred to another Pokemon via Baton Pass.

  Parameters

  • recipient: Pokemon

    The Pokemon receiving this Tag (i.e. the one switching in) Unused by default but exposed to allow for subclasses to perform custom logic.

  Returns boolean

  Whether this Tag can be transferred via Baton Pass. Defaults to returning the value set in the class constructor.

isSourceLinked

• isSourceLinked(): boolean

  Returns boolean

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 by default)

  Remarks

  Generally, this involves ticking down the tag's duration. The tag also initiates the effects it is responsbile for

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

onOverlap

• onOverlap(_pokemon: Pokemon): void

  Parameters

  • _pokemon: Pokemon

  Returns void