Class HeldItemTransferModifier`Abstract`

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

See

Hierarchy (View Summary)

PokemonHeldItemModifier
- HeldItemTransferModifier
  - TurnHeldItemTransferModifier
  - ContactHeldItemTransferChanceModifier

Constructors

constructor

new HeldItemTransferModifier(
    type: ModifierType,
    pokemonId: number,
    stackCount?: number,
): HeldItemTransferModifier
Parameters
- type: ModifierType
- pokemonId: number
- OptionalstackCount: number
Returns HeldItemTransferModifier
Inherited from PokemonHeldItemModifier.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 PokemonHeldItemModifier.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.
Overrides PokemonHeldItemModifier.apply
- Defined in src/modifier/modifier.ts:3236

`Abstract`clone

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

getArgs

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

getCountUnderMax

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

getIcon

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

getIconStackText

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

`Abstract`getMaxHeldItemCount

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

getMaxStackCount

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

getPokemon

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

getScoreMultiplier

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

getStackCount

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

getTargets

getTargets(pokemon?: default, ..._args: unknown[]): default[]
Determines the targets to transfer items from when this applies.
Parameters
- Optionalpokemon: default
  the Pokemon holding this item
- ..._args: unknown[]
  N/A
Returns default[]
the opponents of the source Pokemon
- Defined in src/modifier/modifier.ts:3224

`Abstract`getTransferMessage

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

`Abstract`getTransferredItemCount

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

incrementStack

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

isIconVisible

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

match

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

`Abstract`matchType

matchType(_modifier: Modifier): boolean
Parameters
- _modifier: Modifier
Returns boolean
Inherited from PokemonHeldItemModifier.matchType
- 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
Inherited from PokemonHeldItemModifier.shouldApply
- Defined in src/modifier/modifier.ts:699

Class HeldItemTransferModifierAbstract

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HeldItemTransferModifier

Properties

isTransferable

pokemonId

stackCount

type

virtualStackCount

Methods

add

Parameters

Returns boolean

apply

Parameters

Returns boolean

Abstractclone

Returns PersistentModifier

getArgs

Returns any[]

getCountUnderMax

Returns number

getIcon

Parameters

Returns Container

getIconStackText

Parameters

Returns null | BitmapText

AbstractgetMaxHeldItemCount

Parameters

Returns number

getMaxStackCount

Parameters

Returns number

getPokemon

Returns undefined | default

getScoreMultiplier

Returns number

getStackCount

Returns number

getTargets

Parameters

Returns default[]

AbstractgetTransferMessage

Parameters

Returns string

AbstractgetTransferredItemCount

Returns number

incrementStack

Parameters

Returns boolean

isIconVisible

Returns boolean

match

Parameters

Returns boolean

AbstractmatchType

Parameters

Returns boolean

shouldApply

Parameters

Returns boolean

Settings

On This Page

Class HeldItemTransferModifier`Abstract`

`Abstract`clone

`Abstract`getMaxHeldItemCount

`Abstract`getTransferMessage

`Abstract`getTransferredItemCount

`Abstract`matchType