Class SpeciesStatBoosterModifier

Modifier used for held items that Applies Stat boost(s) using a multiplier if the holder is of a specific Species.

See

apply

Hierarchy (View Summary)

StatBoosterModifier
- SpeciesStatBoosterModifier

Constructors

constructor

new SpeciesStatBoosterModifier(
    type: ModifierType,
    pokemonId: number,
    stats: Stat[],
    multiplier: number,
    species: Species[],
    stackCount?: number,
): SpeciesStatBoosterModifier
Parameters
- type: ModifierType
- pokemonId: number
- stats: Stat[]
- multiplier: number
- species: Species[]
- OptionalstackCount: number
Returns SpeciesStatBoosterModifier
Overrides StatBoosterModifier.constructor
- Defined in src/modifier/modifier.ts:1279

Properties

isTransferable

isTransferable: boolean = true

Whether this item can be transfered to or stolen by another Pokemon.

`Protected`multiplier

multiplier: number

The multiplier used to increase the relevant stat(s)

pokemonId

pokemonId: number

The ID of the Pokemon that this item belongs to.

stackCount

stackCount: number

`Protected`stats

stats: Stat[]

The stats that the held item boosts

type

type: ModifierType

virtualStackCount

virtualStackCount: number

Methods

add

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

apply

apply(_pokemon: default, _stat: Stat, statValue: NumberHolder): boolean
Boosts the incoming stat by a multiplier if the stat is listed in stats.
Parameters
- _pokemon: default
  the Pokemon that holds the item
- _stat: Stat
  the Stat to be boosted
- statValue: NumberHolder
  NumberHolder that holds the resulting value of the stat
Returns boolean
true if the stat boost applies successfully, false otherwise

See
shouldApply
Inherited from StatBoosterModifier.apply
- Defined in src/modifier/modifier.ts:1203

clone

clone(): SpeciesStatBoosterModifier
Returns SpeciesStatBoosterModifier
Overrides StatBoosterModifier.clone
- Defined in src/modifier/modifier.ts:1292

contains

contains(speciesId: Species, stat: Stat): boolean
Checks if either parameter is included in the corresponding lists
Parameters
- speciesId: Species
  Species being checked
- stat: Stat
  Stat being checked
Returns boolean
true if both parameters are in species and stats respectively, false otherwise
- Defined in src/modifier/modifier.ts:1340

getArgs

getArgs(): any[]
Returns any[]
Overrides StatBoosterModifier.getArgs
- Defined in src/modifier/modifier.ts:1303

getCountUnderMax

getCountUnderMax(): number
Returns number
Inherited from StatBoosterModifier.getCountUnderMax
- Defined in src/modifier/modifier.ts:240

getIcon

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

getIconStackText

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

getMaxHeldItemCount

getMaxHeldItemCount(_pokemon: default): number
Parameters
- _pokemon: default
Returns number
Inherited from StatBoosterModifier.getMaxHeldItemCount
- Defined in src/modifier/modifier.ts:1208

getMaxStackCount

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

getPokemon

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

getScoreMultiplier

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

getStackCount

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

incrementStack

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

isIconVisible

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

match

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

matchType

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

shouldApply

shouldApply(pokemon: default, stat: Stat, statValue: NumberHolder): boolean
Checks if the incoming stat is listed in stats and if the holder's Species (or its fused species) is listed in species.
Parameters
- pokemon: default
  Pokemon that holds the item
- stat: Stat
  Stat being checked at the time
- statValue: NumberHolder
  NumberHolder that holds the resulting value of the stat
Returns boolean
true if the stat could be boosted, false otherwise
Overrides StatBoosterModifier.shouldApply
- Defined in src/modifier/modifier.ts:1326

Class SpeciesStatBoosterModifier

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SpeciesStatBoosterModifier

Properties

isTransferable

Protectedmultiplier

pokemonId

stackCount

Protectedstats

type

virtualStackCount

Methods

add

Parameters

Returns boolean

apply

Parameters

Returns boolean

See

clone

Returns SpeciesStatBoosterModifier

contains

Parameters

Returns boolean

getArgs

Returns any[]

getCountUnderMax

Returns number

getIcon

Parameters

Returns Container

getIconStackText

Parameters

Returns null | BitmapText

getMaxHeldItemCount

Parameters

Returns number

getMaxStackCount

Parameters

Returns number

getPokemon

Returns undefined | default

getScoreMultiplier

Returns number

getStackCount

Returns number

incrementStack

Parameters

Returns boolean

isIconVisible

Returns boolean

match

Parameters

Returns boolean

matchType

Parameters

Returns boolean

shouldApply

Parameters

Returns boolean

Settings

On This Page

`Protected`multiplier

`Protected`stats