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:286

Properties

maxDuration

maxDuration: number

The tag's max duration.

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.

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

Accessors

`Protected`i18nSideKey

get i18nSideKey(): string
Sealed
Returns string
A suffix corresponding to this tag's current side.
Inherited from SerializableArenaTag.i18nSideKey
- Defined in src/data/arena-tag.ts:148

`Protected`onAddMessageKey

get onAddMessageKey(): string
Return the i18n locales key that will be shown when this tag is added.
Within the text, {{pokemonNameWithAffix}} and {{moveName}} will be populated with the name of the Pokemon that added the tag and the name of the move that created the tag, respectively.

Returns string
Remarks
If this evaluates to an empty string, no message will be displayed.
Overrides SerializableArenaTag.onAddMessageKey
- Defined in src/data/arena-tag.ts:290

`Protected`onRemoveMessageKey

get onRemoveMessageKey(): string
Return the i18n locales key that will be shown when this tag is removed.
Within the text, {{pokemonNameWithAffix}} and {{moveName}} will be populated with the name of the Pokemon that added the tag and the name of the move that created the tag, respectively.

Returns string
Remarks
If this evaluates to an empty string, no message will be displayed.
Overrides SerializableArenaTag.onRemoveMessageKey
- Defined in src/data/arena-tag.ts:294

Methods

apply

apply(
    simulated: boolean,
    attacker: null | Pokemon,
    cancelled: BooleanHolder,
): boolean
Cancels the lowering of stats
Parameters
- simulated: boolean
  true if the effect should be applied quietly
- attacker: null | 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:306

`Protected`canAffect

canAffect(pokemon: Pokemon): boolean
Return whether this Tag can affect the given Pokemon, based on this tag's side.
Parameters
- pokemon: Pokemon
  The Pokemon to check
Returns boolean
Whether this tag can affect pokemon.
Inherited from SerializableArenaTag.canAffect
- Defined in src/data/arena-tag.ts:268

`Protected`getAffectedPokemon

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

Returns Pokemon[]
An array containing all Pokemon affected by this Tag.
Inherited from SerializableArenaTag.getAffectedPokemon
- Defined in src/data/arena-tag.ts:252

`Protected`getMoveName

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

`Protected`getSourcePokemon

getSourcePokemon(): undefined | Pokemon
Helper function that retrieves the source Pokemon.

Returns undefined | Pokemon
- The source Pokemon for this tag. Returns undefined if this.sourceId is undefined
Inherited from SerializableArenaTag.getSourcePokemon
- Defined in src/data/arena-tag.ts:244

lapse

lapse(): boolean
Reduce this ArenaTag's duration and apply any end-of-turn effects Will ignore durations of all tags with durations <=0.

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:216

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:231

onAdd

onAdd(quiet?: boolean): void
Trigger effects when this tag is added to the Arena. By default, will queue a message with the contents of getOnAddMessage.
Parameters
- quiet: boolean = false
  Whether to suppress any messages created during tag addition; default false
Returns void
Inherited from SerializableArenaTag.onAdd
- Defined in src/data/arena-tag.ts:174

onOverlap

onOverlap(_source?: Pokemon): void
Apply effects when this Tag overlaps by creating a new instance while one is already present.
Parameters
- Optional_source: Pokemon
  The Pokemon having added the tag
Returns void
Inherited from SerializableArenaTag.onOverlap
- Defined in src/data/arena-tag.ts:209

onRemove

onRemove(quiet?: boolean): void
Trigger effects when this tag is removed from the Arena. By default, will queue a message with the contents of getOnRemoveMessage.
Parameters
- quiet: boolean = false
  Whether to suppress any messages created during tag addition; default false
Returns void
Inherited from SerializableArenaTag.onRemove
- Defined in src/data/arena-tag.ts:192

Class MistTag

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MistTag

Properties

maxDuration

side

Default Value

sourceId

OptionalsourceMove

ReadonlytagType

turnCount

Accessors

Protectedi18nSideKey

Returns string

ProtectedonAddMessageKey

Returns string

Remarks

ProtectedonRemoveMessageKey

Returns string

Remarks

Methods

apply

Parameters

Returns boolean

ProtectedcanAffect

Parameters

Returns boolean

ProtectedgetAffectedPokemon

Returns Pokemon[]

ProtectedgetMoveName

Returns null | string

ProtectedgetSourcePokemon

Returns undefined | Pokemon

lapse

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

`Protected`i18nSideKey

`Protected`onAddMessageKey

`Protected`onRemoveMessageKey

`Protected`canAffect

`Protected`getAffectedPokemon

`Protected`getMoveName

`Protected`getSourcePokemon