Class PokemonHeldItemModifier`Abstract`

Constructors

constructor

new PokemonHeldItemModifier(
    type: ModifierType,
    pokemonId: number,
    stackCount?: number,
): PokemonHeldItemModifier
Parameters
- type: ModifierType
- pokemonId: number
- OptionalstackCount: number
Returns PokemonHeldItemModifier
Overrides PersistentModifier.constructor
- Defined in src/modifier/modifier.ts:670

Properties

isTransferable

isTransferable: boolean = true

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

type

type: ModifierType

virtualStackCount

virtualStackCount: number

Methods

add

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

`Abstract`apply

apply(pokemon: default, ...args: unknown[]): boolean
Applies the PokemonHeldItemModifier to the given Pokemon.
Parameters
- pokemon: default
  The Pokemon that holds the held item
- ...args: unknown[]
  additional parameters
Returns boolean
Overrides PersistentModifier.apply
- Defined in src/modifier/modifier.ts:691

`Abstract`clone

clone(): PersistentModifier
Returns PersistentModifier
Inherited from PersistentModifier.clone
- Defined in src/modifier/modifier.ts:215

getArgs

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

getCountUnderMax

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

getIcon

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

getIconStackText

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

`Abstract`getMaxHeldItemCount

getMaxHeldItemCount(pokemon?: default): number
Parameters
- Optionalpokemon: default
Returns number
- Defined in src/modifier/modifier.ts:762

getMaxStackCount

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

getPokemon

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

getScoreMultiplier

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

getStackCount

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

incrementStack

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

isIconVisible

isIconVisible(): boolean
Returns boolean
Overrides PersistentModifier.isIconVisible
- Defined in src/modifier/modifier.ts:703

match

match(modifier: Modifier): boolean
Parameters
- modifier: Modifier
Returns boolean
Overrides PersistentModifier.match
- Defined in src/modifier/modifier.ts:678

`Abstract`matchType

matchType(_modifier: Modifier): boolean
Parameters
- _modifier: Modifier
Returns boolean
- Defined in src/modifier/modifier.ts:676

shouldApply

shouldApply(pokemon?: default, ..._args: unknown[]): boolean
Checks if PokemonHeldItemModifier should be applied.
Parameters
- Optionalpokemon: default
  The Pokemon that holds the item
- ..._args: unknown[]
  N/A
Returns boolean
if PokemonHeldItemModifier should be applied
Overrides PersistentModifier.shouldApply
- Defined in src/modifier/modifier.ts:699