Class BaseStatModifier

Modifier used for held items, specifically vitamins like Carbos, Hp Up, etc., that increase the value of a given PermanentStat.

See

Hierarchy (view full)

PokemonHeldItemModifier
- BaseStatModifier

Constructors

constructor

new BaseStatModifier(type, pokemonId, stat, stackCount?): BaseStatModifier
Parameters
- type: ModifierType
- pokemonId: number
- stat:
      | HP
      | ATK
      | DEF
      | SPATK
      | SPDEF
      | SPD
- OptionalstackCount: number
Returns BaseStatModifier
Overrides PokemonHeldItemModifier.constructor
- Defined in src/modifier/modifier.ts:881

Properties

isTransferable

isTransferable: boolean = false

pokemonId

pokemonId: number

stackCount

stackCount: number

`Protected`stat

stat:
    | HP
    | ATK
    | DEF
    | SPATK
    | SPDEF
    | SPD

type

type: ModifierType

virtualStackCount

virtualStackCount: number

Methods

add

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

apply

apply(_pokemon, baseStats): boolean
Applies the BaseStatModifier to the specified Pokemon.
Parameters
- _pokemon: default
  the Pokemon to be modified
- baseStats: number[]
  the base stats of the Pokemon
Returns boolean
always true
Overrides PokemonHeldItemModifier.apply
- Defined in src/modifier/modifier.ts:917

clone

clone(): PersistentModifier
Returns PersistentModifier
Overrides PokemonHeldItemModifier.clone
- Defined in src/modifier/modifier.ts:893

getArgs

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

getIcon

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

getIconStackText

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

getMaxHeldItemCount

getMaxHeldItemCount(pokemon): number
Parameters
- pokemon: default
Returns number
Overrides PokemonHeldItemModifier.getMaxHeldItemCount
- Defined in src/modifier/modifier.ts:926

getMaxStackCount

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

getPokemon

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

getScoreMultiplier

getScoreMultiplier(): number
Returns number
Overrides PokemonHeldItemModifier.getScoreMultiplier
- Defined in src/modifier/modifier.ts:922

getSecondaryChanceMultiplier

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

getStackCount

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

incrementStack

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

isIconVisible

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

match

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

matchType

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

shouldApply

shouldApply(_pokemon?, baseStats?): boolean
Checks if BaseStatModifier should be applied to the specified Pokemon.
Parameters
- Optional_pokemon: default
  the Pokemon to be modified
- OptionalbaseStats: number[]
  the base stats of the Pokemon
Returns boolean
true if the Pokemon should be modified
Overrides PokemonHeldItemModifier.shouldApply
- Defined in src/modifier/modifier.ts:907