Class SpeciesStatBoosterModifier

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

See

Hierarchy (view full)

StatBoosterModifier
- SpeciesStatBoosterModifier

Constructors

constructor

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

Properties

`Protected` multiplier

multiplier: number

The multiplier used to increase the relevant stat(s)

pokemonId

pokemonId: number

`Private` species

species: Species[]

The species that the held item's stat boost(s) apply 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, virtual, scene): boolean
Parameters
- modifiers: PersistentModifier[]
- virtual: boolean
- scene: default
Returns boolean
Inherited from StatBoosterModifier.add
- Defined in src/modifier/modifier.ts:158

apply

apply(args): boolean
Boosts the incoming stat by a multiplier if the stat is listed in stats.
Parameters
- args: any[]
  [0] Pokemon N/A [1] Stat N/A [2] Utils.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:768

clone

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

contains

contains(speciesId, 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:879

getArgs

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

getIcon

getIcon(scene, forSummary?): Container
Parameters
- scene: default
- Optional forSummary: boolean
Returns Container
Inherited from StatBoosterModifier.getIcon
- Defined in src/modifier/modifier.ts:501

getIconStackText

getIconStackText(scene, virtual?): BitmapText
Parameters
- scene: default
- Optional virtual: boolean
Returns BitmapText
Inherited from StatBoosterModifier.getIconStackText
- Defined in src/modifier/modifier.ts:223

getMaxHeldItemCount

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

getMaxStackCount

getMaxStackCount(scene, forThreshold?): number
Parameters
- scene: default
- Optional forThreshold: boolean
Returns number
Inherited from StatBoosterModifier.getMaxStackCount
- Defined in src/modifier/modifier.ts:556

getPokemon

getPokemon(scene): default
Parameters
- scene: default
Returns default
Inherited from StatBoosterModifier.getPokemon
- Defined in src/modifier/modifier.ts:532

getScoreMultiplier

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

getSecondaryChanceMultiplier

getSecondaryChanceMultiplier(pokemon): number
Parameters
- pokemon: default
Returns number
Inherited from StatBoosterModifier.getSecondaryChanceMultiplier
- Defined in src/modifier/modifier.ts:541

getStackCount

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

getTransferrable

getTransferrable(withinParty): boolean
Parameters
- withinParty: boolean
Returns boolean
Inherited from StatBoosterModifier.getTransferrable
- Defined in src/modifier/modifier.ts:493

incrementStack

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

isIconVisible

isIconVisible(scene): boolean
Parameters
- scene: default
Returns boolean
Inherited from StatBoosterModifier.isIconVisible
- Defined in src/modifier/modifier.ts:497

match

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

matchType

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

shouldApply

shouldApply(args): 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
- args: any[]
  [0] Pokemon that holds the held item [1] Stat being checked at the time [2] Utils.NumberHolder N/A
Returns boolean
true if the stat could be boosted, false otherwise
Overrides StatBoosterModifier.shouldApply
- Defined in src/modifier/modifier.ts:868