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 Summary)

PokemonHeldItemModifier
- BaseStatModifier

Constructors

constructor

new BaseStatModifier(
    type: ModifierType,
    pokemonId: number,
    stat: HP | ATK | DEF | SPATK | SPDEF | SPD,
    stackCount?: number,
): 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:825

Properties

isTransferable

isTransferable: boolean = false

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

pokemonId

pokemonId: number

The ID of the Pokemon that this item belongs to.

stackCount

stackCount: number

`Protected`stat

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

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

apply

apply(_pokemon: default, baseStats: number[]): 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:861

clone

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

getArgs

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

getCountUnderMax

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

getIcon

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

getIconStackText

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

getMaxHeldItemCount

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

getMaxStackCount

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

getPokemon

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

getScoreMultiplier

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

getStackCount

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

incrementStack

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

isIconVisible

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

match

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

matchType

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

shouldApply

shouldApply(_pokemon?: default, baseStats?: number[]): 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:851