Class MistTag

Arena Tag class for Mist. Prevents Pokémon on the opposing side from lowering the stats of the Pokémon in the Mist.

Hierarchy (View Summary)

SerializableArenaTag
- MistTag

Index

Constructors

constructor

new MistTag(
    turnCount: number,
    sourceId: undefined | number,
    side: ArenaTagSide,
): MistTag
Parameters
- turnCount: number
- sourceId: undefined | number
- side: ArenaTagSide
Returns MistTag
Overrides SerializableArenaTag.constructor
- Defined in src/data/arena-tag.ts:211

Properties

side

side: ArenaTagSide

The side of the field that this arena tag affects.

Default Value

ArenaTagSide.BOTH

sourceId

sourceId: undefined | number

The PID of the Pokemon having created the tag, or undefined if not set by a Pokemon.

Todo

Implement handling for ArenaTags created by non-pokemon sources (most tags will throw errors without a source)

`Optional`sourceMove

sourceMove?: MoveId

The MoveId that created this tag, or undefined if not set by a move.

`Readonly`tagType

tagType: MIST = ArenaTagType.MIST

The type of the arena tag

turnCount

turnCount: number

The tag's remaining duration. Setting to any number <=0 will make the tag's duration effectively infinite.

Methods

apply

apply(
    _arena: Arena,
    simulated: boolean,
    attacker: Pokemon,
    cancelled: BooleanHolder,
): boolean
Cancels the lowering of stats
Parameters
- _arena: Arena
  the Arena containing this effect
- simulated: boolean
  true if the effect should be applied quietly
- attacker: Pokemon
  the Pokemon using a move into this effect.
- cancelled: BooleanHolder
  a BooleanHolder whose value is set to true to flag the stat reduction as cancelled
Returns boolean
true if a stat reduction was cancelled; false otherwise
Overrides SerializableArenaTag.apply
- Defined in src/data/arena-tag.ts:245

getAffectedPokemon

getAffectedPokemon(): Pokemon[]
Helper function that retrieves the Pokemon affected

Returns Pokemon[]
list of PlayerPokemon or EnemyPokemon on the field
Inherited from SerializableArenaTag.getAffectedPokemon
- Defined in src/data/arena-tag.ts:185

getMoveName

getMoveName(): null | string
Returns null | string
Inherited from SerializableArenaTag.getMoveName
- Defined in src/data/arena-tag.ts:156

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
Inherited from SerializableArenaTag.getSourcePokemon
- Defined in src/data/arena-tag.ts:177

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.
Inherited from SerializableArenaTag.lapse
- Defined in src/data/arena-tag.ts:150

loadTag

loadTag<const T extends MistTag>(
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 MistTag
Parameters
- source: BaseArenaTag & Pick<T, "tagType">
  The arena tag being loaded
Returns void
Inherited from SerializableArenaTag.loadTag
- Defined in src/data/arena-tag.ts:165

onAdd

onAdd(arena: Arena, quiet?: boolean): void
Parameters
- arena: Arena
- quiet: boolean = false
Returns void
Overrides SerializableArenaTag.onAdd
- Defined in src/data/arena-tag.ts:215

onOverlap

onOverlap(_arena: Arena, _source: null | Pokemon): void
Parameters
- _arena: Arena
- _source: null | Pokemon
Returns void
Inherited from SerializableArenaTag.onOverlap
- Defined in src/data/arena-tag.ts:141

onRemove

onRemove(_arena: Arena, quiet?: boolean): void
Parameters
- _arena: Arena
- quiet: boolean = false
Returns void
Inherited from SerializableArenaTag.onRemove
- Defined in src/data/arena-tag.ts:130

Class MistTag

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MistTag

Properties

side

Default Value

sourceId

Todo

OptionalsourceMove

ReadonlytagType

turnCount

Methods

apply

Parameters

Returns boolean

getAffectedPokemon

Returns Pokemon[]

getMoveName

Returns null | string

getSourcePokemon

Returns null | Pokemon

lapse

Parameters

Returns boolean

loadTag

Type Parameters

Parameters

Returns void

onAdd

Parameters

Returns void

onOverlap

Parameters

Returns void

onRemove

Parameters

Returns void

Settings

On This Page

`Optional`sourceMove

`Readonly`tagType