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
- OptionalstackCount: number
Returns HeldItemTransferModifier
Overrides PokemonHeldItemModifier.constructor
- Defined in src/modifier/modifier.ts:2686

Properties

isTransferable

isTransferable: boolean = true

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

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

`Abstract`clone

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

getArgs

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

getIcon

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

getIconStackText

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

`Abstract`getMaxHeldItemCount

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

getMaxStackCount

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

getPokemon

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

getScoreMultiplier

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

getSecondaryChanceMultiplier

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

getStackCount

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

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

`Abstract`getTransferMessage

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

`Abstract`getTransferredItemCount

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

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

isIconVisible

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

match

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

`Abstract`matchType

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

shouldApply

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