Class BattlerTag

constructor

• new BattlerTag(
      tagType: BattlerTagType,
      lapseType:
          | BattlerTagLapseType
          | [BattlerTagLapseType, ...BattlerTagLapseType[]],
      turnCount: number,
      sourceMove?: MoveId,
      sourceId?: number,
      isBatonPassable?: boolean,
  ): BattlerTag

  Parameters

  • tagType: BattlerTagType
  • lapseType: BattlerTagLapseType | [BattlerTagLapseType, ...BattlerTagLapseType[]]
  • turnCount: number
  • OptionalsourceMove: MoveId
  • OptionalsourceId: number
  • isBatonPassable: boolean = false

  Returns BattlerTag

OptionalsourceId

OptionalsourceMove

ReadonlytagType

turnCount

isBatonPassable

• get isBatonPassable(): boolean

  Returns boolean

lapseTypes

• get lapseTypes(): readonly BattlerTagLapseType[]

  Returns readonly BattlerTagLapseType[]

canAdd

• canAdd(_pokemon: Pokemon): boolean

  Parameters

  • _pokemon: Pokemon

  Returns boolean

getDescriptor

• getDescriptor(): string

  Returns string

getMoveName

• getMoveName(): null | string

  Returns null | string

getSourcePokemon

• getSourcePokemon(): null | Pokemon

  Helper function that retrieves the source Pokemon object

  Returns null | Pokemon

  The source Pokemon, or null if none is found

isSourceLinked

• isSourceLinked(): boolean

  Returns boolean

lapse

• lapse(_pokemon: Pokemon, _lapseType: BattlerTagLapseType): boolean

  Tick down this BattlerTag's duration.

  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`)

loadTag

• loadTag<const T extends BattlerTag>(
      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 BattlerTag

  Parameters

  • source: BaseBattlerTag & Pick<T, "tagType">

    An object containing the fields needed to reconstruct this tag.

  Returns void

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

onOverlap

• onOverlap(_pokemon: Pokemon): void

  Parameters

  • _pokemon: Pokemon

  Returns void

onRemove

• onRemove(_pokemon: Pokemon): void

  Parameters

  • _pokemon: Pokemon

  Returns void