Class ArenaTagAbstract

constructor

• new ArenaTag(
      turnCount: number,
      sourceMove?: MoveId,
      sourceId?: number,
      side?: ArenaTagSide,
  ): ArenaTag

  Parameters

  • turnCount: number
  • OptionalsourceMove: MoveId
  • OptionalsourceId: number
  • side: ArenaTagSide = ArenaTagSide.BOTH

  Returns ArenaTag

side

sourceId

OptionalsourceMove

Abstract ReadonlytagType

turnCount

apply

• apply(_arena: Arena, _simulated: boolean, ..._args: unknown[]): boolean

  Parameters

  • _arena: Arena
  • _simulated: boolean
  • ..._args: unknown[]

  Returns boolean

getAffectedPokemon

• getAffectedPokemon(): Pokemon[]

  Helper function that retrieves the Pokemon affected

  Returns Pokemon[]

  list of PlayerPokemon or EnemyPokemon on the field

getMoveName

• getMoveName(): null | string

  Returns null | string

getSourcePokemon

• getSourcePokemon(): null | Pokemon

  Helper function that retrieves the source Pokemon

  Returns null | Pokemon

  • The source Pokemon for this tag. Returns null if this.sourceId is undefined

lapse

• lapse(_arena: Arena): boolean

  Trigger this ArenaTag's effect, reducing its duration as applicable. Will ignore durations of all tags with durations <=0.

  Parameters

  • _arena: Arena

    The Arena at the moment the tag is being lapsed. Unused by default but can be used by sub-classes.

  Returns boolean

  true if this tag should be kept; false if it should be removed.

loadTag

• loadTag<const T extends ArenaTag>(
      source: BaseArenaTag & Pick<T, "tagType">,
  ): void

  When given a arena tag or json representing one, load the data for it. This is meant to be inherited from by any arena tag with custom attributes

  Type Parameters

  • const T extends ArenaTag

  Parameters

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

    The arena tag being loaded

  Returns void

onAdd

• onAdd(_arena: Arena, _quiet?: boolean): void

  Parameters

  • _arena: Arena
  • _quiet: boolean = false

  Returns void

onOverlap

• onOverlap(_arena: Arena, _source: null | Pokemon): void

  Parameters

  • _arena: Arena
  • _source: null | Pokemon

  Returns void

onRemove

• onRemove(_arena: Arena, quiet?: boolean): void

  Parameters

  • _arena: Arena
  • quiet: boolean = false

  Returns void