Class HeldItemTransferModifier`Abstract`

Abstract class for held items that steal other Pokemon's items.

See

Hierarchy (view full)

PokemonHeldItemModifier
- HeldItemTransferModifier
  - TurnHeldItemTransferModifier
  - ContactHeldItemTransferChanceModifier

Constructors

constructor

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

Properties

pokemonId

pokemonId: number

stackCount

stackCount: number

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

apply

apply(args): boolean
Steals an item from a set of target Pokemon. This prioritizes high-tier held items when selecting the item to steal.
Parameters
- args: any[]
  [0] The Pokemon holding this item
Returns boolean
true if an item was stolen; false otherwise.
Overrides PokemonHeldItemModifier.apply
- Defined in src/modifier/modifier.ts:2152

`Abstract` clone

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

getArgs

getArgs(): any[]
Returns any[]
Inherited from PokemonHeldItemModifier.getArgs
- Defined in src/modifier/modifier.ts:486

getIcon

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

getIconStackText

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

`Abstract` getMaxHeldItemCount

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

getMaxStackCount

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

getPokemon

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

getScoreMultiplier

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

getSecondaryChanceMultiplier

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

getStackCount

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

getTargets

getTargets(args): default[]
Determines the targets to transfer items from when this applies.
Parameters
- args: any[]
Returns default[]
the opponents of the source Pokemon
- Defined in src/modifier/modifier.ts:2138

`Abstract` getTransferMessage

getTransferMessage(pokemon, targetPokemon, item): string
Parameters
- pokemon: default
- targetPokemon: default
- item: ModifierType
Returns string
- Defined in src/modifier/modifier.ts:2208

getTransferrable

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

`Abstract` getTransferredItemCount

getTransferredItemCount(): number
Returns number
- Defined in src/modifier/modifier.ts:2206

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

isIconVisible

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

match

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

`Abstract` matchType

matchType(_modifier): boolean
Parameters
- _modifier: Modifier
Returns boolean
Inherited from PokemonHeldItemModifier.matchType
- Defined in src/modifier/modifier.ts:480

shouldApply

shouldApply(args): boolean
Parameters
- args: any[]
Returns boolean
Inherited from PokemonHeldItemModifier.shouldApply
- Defined in src/modifier/modifier.ts:490