Class ContactHeldItemTransferChanceModifier

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

See

Hierarchy (View Summary)

HeldItemTransferModifier
- ContactHeldItemTransferChanceModifier

Constructors

constructor

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

Properties

`Readonly`chance

chance: number

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

apply

apply(pokemon: default, target?: default, ..._args: unknown[]): boolean
Steals an item from a set of target Pokemon. This prioritizes high-tier held items when selecting the item to steal.
Parameters
- pokemon: default
  The Pokemon holding this item
- Optionaltarget: default
  The Pokemon to steal from (optional)
- ..._args: unknown[]
  N/A
Returns boolean
true if an item was stolen; false otherwise.
Inherited from HeldItemTransferModifier.apply
- Defined in src/modifier/modifier.ts:3236

clone

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

getArgs

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

getCountUnderMax

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

getIcon

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

getIconStackText

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

getMaxHeldItemCount

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

getMaxStackCount

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

getPokemon

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

getScoreMultiplier

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

getStackCount

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

getTargets

getTargets(_holderPokemon: default, targetPokemon: default): default[]
Determines the target to steal items from when this applies.
Parameters
- _holderPokemon: default
  The Pokemon holding this item
- targetPokemon: default
  The Pokemon the holder is targeting with an attack
Returns default[]
The target Pokemon as array for further use in apply implementations
Overrides HeldItemTransferModifier.getTargets
- Defined in src/modifier/modifier.ts:3354

getTransferMessage

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

getTransferredItemCount

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

incrementStack

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

isIconVisible

isIconVisible(): boolean
Returns boolean
Inherited from HeldItemTransferModifier.isIconVisible
- Defined in src/modifier/modifier.ts:703

match

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

matchType

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

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

Class ContactHeldItemTransferChanceModifier

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ContactHeldItemTransferChanceModifier

Properties

Readonlychance

isTransferable

pokemonId

stackCount

type

virtualStackCount

Methods

add

Parameters

Returns boolean

apply

Parameters

Returns boolean

clone

Returns ContactHeldItemTransferChanceModifier

getArgs

Returns any[]

getCountUnderMax

Returns number

getIcon

Parameters

Returns Container

getIconStackText

Parameters

Returns null | BitmapText

getMaxHeldItemCount

Parameters

Returns number

getMaxStackCount

Parameters

Returns number

getPokemon

Returns undefined | default

getScoreMultiplier

Returns number

getStackCount

Returns number

getTargets

Parameters

Returns default[]

getTransferMessage

Parameters

Returns string

getTransferredItemCount

Returns number

incrementStack

Parameters

Returns boolean

isIconVisible

Returns boolean

match

Parameters

Returns boolean

matchType

Parameters

Returns boolean

shouldApply

Parameters

Returns boolean

Settings

On This Page

`Readonly`chance