Class ContactHeldItemTransferChanceModifier

Modifier for held items that add a chance to steal items from the target of a successful attack.

See

Hierarchy (view full)

HeldItemTransferModifier
- ContactHeldItemTransferChanceModifier

Constructors

constructor

new ContactHeldItemTransferChanceModifier(type, pokemonId, chancePercent, stackCount?): ContactHeldItemTransferChanceModifier
Parameters
- type: ModifierType
- pokemonId: number
- chancePercent: number
- OptionalstackCount: number
Returns ContactHeldItemTransferChanceModifier
Overrides HeldItemTransferModifier.constructor
- Defined in src/modifier/modifier.ts:2376

Properties

`Readonly`isTransferrable

isTransferrable: 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 HeldItemTransferModifier.add
- Defined in src/modifier/modifier.ts:161

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.
Inherited from HeldItemTransferModifier.apply
- Defined in src/modifier/modifier.ts:2277

clone

clone(): ContactHeldItemTransferChanceModifier
Returns ContactHeldItemTransferChanceModifier
Overrides HeldItemTransferModifier.clone
- Defined in src/modifier/modifier.ts:2400

getArgs

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

getIcon

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

getIconStackText

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

getMaxHeldItemCount

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

getMaxStackCount

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

getPokemon

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

getScoreMultiplier

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

getSecondaryChanceMultiplier

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

getStackCount

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

getTargets

getTargets(args): default[]
Determines the target to steal items from when this applies.
Parameters
- args: any[]
Returns default[]
The target (args[1]) stored in array format for use in HeldItemTransferModifier.apply
Overrides HeldItemTransferModifier.getTargets
- Defined in src/modifier/modifier.ts:2388

getTransferMessage

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

getTransferredItemCount

getTransferredItemCount(): number
Returns number
Overrides HeldItemTransferModifier.getTransferredItemCount
- Defined in src/modifier/modifier.ts:2408

incrementStack

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

isIconVisible

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

match

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

matchType

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

shouldApply

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