Class FieldEffectModifier

Modifier used for held items, namely Mystical Rock, that extend the duration of weather and terrain effects.

See

Hierarchy (View Summary)

PokemonHeldItemModifier
- FieldEffectModifier

Index

Constructors

constructor

new FieldEffectModifier(
    type: ModifierType,
    pokemonId: number,
    stackCount?: number,
): FieldEffectModifier
Parameters
- type: ModifierType
- pokemonId: number
- OptionalstackCount: number
Returns FieldEffectModifier
Inherited from PokemonHeldItemModifier.constructor
- Defined in src/modifier/modifier.ts:659

Properties

isTransferable

isTransferable: boolean = true

pokemonId

pokemonId: number

stackCount

stackCount: number

type

type: ModifierType

virtualStackCount

virtualStackCount: number

Methods

add

add(modifiers: PersistentModifier[], virtual: boolean): boolean
Parameters
- modifiers: PersistentModifier[]
- virtual: boolean
Returns boolean
Inherited from PokemonHeldItemModifier.add
- Defined in src/modifier/modifier.ts:195

apply

apply(_pokemon: default, fieldDuration: NumberHolder): boolean
Provides two more turns per stack to any weather or terrain effect caused by the holder.
Parameters
- _pokemon: default
- fieldDuration: NumberHolder
  NumberHolder that stores the current field effect duration
Returns boolean
true if the field effect extension was applied successfully
Overrides PokemonHeldItemModifier.apply
- Defined in src/modifier/modifier.ts:2031

clone

clone(): FieldEffectModifier
Returns FieldEffectModifier
Overrides PokemonHeldItemModifier.clone
- Defined in src/modifier/modifier.ts:2040

getArgs

getArgs(): any[]
Returns any[]
Inherited from PokemonHeldItemModifier.getArgs
- Defined in src/modifier/modifier.ts:671

getIcon

getIcon(forSummary?: boolean): Container
Parameters
- OptionalforSummary: boolean
Returns Container
Inherited from PokemonHeldItemModifier.getIcon
- Defined in src/modifier/modifier.ts:696

getIconStackText

getIconStackText(virtual?: boolean): null | BitmapText
Parameters
- Optionalvirtual: boolean
Returns null | BitmapText
Inherited from PokemonHeldItemModifier.getIconStackText
- Defined in src/modifier/modifier.ts:260

getMaxHeldItemCount

getMaxHeldItemCount(_pokemon?: default): number
Parameters
- Optional_pokemon: default
Returns number
Overrides PokemonHeldItemModifier.getMaxHeldItemCount
- Defined in src/modifier/modifier.ts:2044

getMaxStackCount

getMaxStackCount(forThreshold?: boolean): number
Parameters
- OptionalforThreshold: boolean
Returns number
Inherited from PokemonHeldItemModifier.getMaxStackCount
- Defined in src/modifier/modifier.ts:737

getPokemon

getPokemon(): undefined | default
Returns undefined | default
Inherited from PokemonHeldItemModifier.getPokemon
- Defined in src/modifier/modifier.ts:729

getScoreMultiplier

getScoreMultiplier(): number
Returns number
Inherited from PokemonHeldItemModifier.getScoreMultiplier
- Defined in src/modifier/modifier.ts:733

getStackCount

getStackCount(): number
Returns number
Inherited from PokemonHeldItemModifier.getStackCount
- Defined in src/modifier/modifier.ts:229

incrementStack

incrementStack(amount: number, virtual: boolean): boolean
Parameters
- amount: number
- virtual: boolean
Returns boolean
Inherited from PokemonHeldItemModifier.incrementStack
- Defined in src/modifier/modifier.ts:216

isIconVisible

isIconVisible(): boolean
Returns boolean
Inherited from PokemonHeldItemModifier.isIconVisible
- Defined in src/modifier/modifier.ts:692

match

match(modifier: Modifier): boolean
Parameters
- modifier: Modifier
Returns boolean
Inherited from PokemonHeldItemModifier.match
- Defined in src/modifier/modifier.ts:667

matchType

matchType(modifier: Modifier): boolean
Parameters
- modifier: Modifier
Returns boolean
Overrides PokemonHeldItemModifier.matchType
- Defined in src/modifier/modifier.ts:2036

shouldApply

shouldApply(pokemon?: default, ..._args: unknown[]): boolean
Checks if PokemonHeldItemModifier should be applied.
Parameters
- Optionalpokemon: default
  The Pokemon that holds the item
- ..._args: unknown[]
  N/A
Returns boolean
if PokemonHeldItemModifier should be applied
Inherited from PokemonHeldItemModifier.shouldApply
- Defined in src/modifier/modifier.ts:688