Class SpeciesCritBoosterModifier

Modifier used for held items that apply critical-hit stage boost(s) if the holder is of a specific Species.

See

Hierarchy (view full)

CritBoosterModifier
- SpeciesCritBoosterModifier

Constructors

constructor

new SpeciesCritBoosterModifier(type, pokemonId, stageIncrement, species, stackCount?): SpeciesCritBoosterModifier
Parameters
- type: ModifierType
- pokemonId: number
- stageIncrement: number
- species: Species[]
- OptionalstackCount: number
Returns SpeciesCritBoosterModifier
Overrides CritBoosterModifier.constructor
- Defined in src/modifier/modifier.ts:1300

Properties

isTransferable

isTransferable: boolean = true

pokemonId

pokemonId: number

stackCount

stackCount: number

`Protected`stageIncrement

stageIncrement: number

The amount of stages by which the held item increases the current critical-hit stage value

type

type: ModifierType

virtualStackCount

virtualStackCount: number

Methods

add

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

apply

apply(args): boolean
Increases the current critical-hit stage value by stageIncrement.
Parameters
- args: any[]
  [0] Pokemon N/A [1] Utils.IntegerHolder that holds the resulting critical-hit level
Returns boolean
true if the critical-hit stage boost applies successfully, false otherwise
Inherited from CritBoosterModifier.apply
- Defined in src/modifier/modifier.ts:1278

clone

clone(): SpeciesCritBoosterModifier
Returns SpeciesCritBoosterModifier
Overrides CritBoosterModifier.clone
- Defined in src/modifier/modifier.ts:1306

getArgs

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

getIcon

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

getIconStackText

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

getMaxHeldItemCount

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

getMaxStackCount

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

getPokemon

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

getScoreMultiplier

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

getSecondaryChanceMultiplier

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

getStackCount

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

incrementStack

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

isIconVisible

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

match

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

matchType

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

shouldApply

shouldApply(args): boolean
Checks if the holder's Species (or its fused species) is listed in species.
Parameters
- args: any[]
  [0] Pokemon that holds the held item [1] Utils.IntegerHolder N/A
Returns boolean
true if the critical-hit level can be incremented, false otherwise
Overrides CritBoosterModifier.shouldApply
- Defined in src/modifier/modifier.ts:1325