Class PersistentModifier`Abstract`

Index

Constructors

Properties

Methods

add apply clone getArgs getCountUnderMax getIcon getIconStackText getMaxStackCount getStackCount incrementStack is isIconVisible match shouldApply

Constructors

constructor

new PersistentModifier(
type: ModifierType,
stackCount?: number,
): PersistentModifier
Parameters
- type: ModifierType
- stackCount: number = 1
Returns PersistentModifier
Overrides Modifier.constructor
- Defined in src/modifier/modifier.ts:192

Properties

`Private`_

_: never

This field does not exist at runtime and must not be used. Its sole purpose is to ensure that typescript is able to properly narrow when the is method is called.

stackCount

stackCount: number

type

type: ModifierType

virtualStackCount

virtualStackCount: number

Methods

add

add(modifiers: PersistentModifier[], virtual: boolean): boolean
Parameters
- modifiers: PersistentModifier[]
- virtual: boolean
Returns boolean
- Defined in src/modifier/modifier.ts:198

`Abstract`apply

apply(...args: unknown[]): boolean
Handles applying of Modifier
Parameters
- ...args: unknown[]
  collection of all passed parameters
Returns boolean
Inherited from Modifier.apply
- Defined in src/modifier/modifier.ts:180

`Abstract`clone

clone(): PersistentModifier
Returns PersistentModifier
- Defined in src/modifier/modifier.ts:213

getArgs

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

getCountUnderMax

getCountUnderMax(): number
Returns number
- Defined in src/modifier/modifier.ts:238

getIcon

getIcon(_forSummary?: boolean): Container
Parameters
- Optional_forSummary: boolean
Returns Container
- Defined in src/modifier/modifier.ts:246

getIconStackText

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

`Abstract`getMaxStackCount

getMaxStackCount(forThreshold?: boolean): number
Parameters
- OptionalforThreshold: boolean
Returns number
- Defined in src/modifier/modifier.ts:236

getStackCount

getStackCount(): number
Returns number
- Defined in src/modifier/modifier.ts:232

incrementStack

incrementStack(amount: number, virtual: boolean): boolean
Parameters
- amount: number
- virtual: boolean
Returns boolean
- Defined in src/modifier/modifier.ts:219

is

is<
    T extends
        | "PersistentModifier"
        | "ConsumableModifier"
        | "AddPokeballModifier"
        | "AddVoucherModifier"
        | "LapsingPersistentModifier"
        | "DoubleBattleChanceBoosterModifier"
        | "TempStatStageBoosterModifier"
        | "TempCritBoosterModifier"
        | "MapModifier"
        | "MegaEvolutionAccessModifier"
        | "GigantamaxAccessModifier"
        | "TerastallizeAccessModifier"
        | "PokemonHeldItemModifier"
        | "LapsingPokemonHeldItemModifier"
        | "BaseStatModifier"
        | "EvoTrackerModifier"
        | "PokemonBaseStatTotalModifier"
        | "PokemonBaseStatFlatModifier"
        | "PokemonIncrementingStatModifier"
        | "StatBoosterModifier"
        | "SpeciesStatBoosterModifier"
        | "CritBoosterModifier"
        | "SpeciesCritBoosterModifier"
        | "AttackTypeBoosterModifier"
        | "SurviveDamageModifier"
        | "BypassSpeedChanceModifier"
        | "FlinchChanceModifier"
        | "TurnHealModifier"
        | "TurnStatusEffectModifier"
        | "HitHealModifier"
        | "LevelIncrementBoosterModifier"
        | "BerryModifier"
        | "PreserveBerryModifier"
        | "PokemonInstantReviveModifier"
        | "ResetNegativeStatStageModifier"
        | "FieldEffectModifier"
        | "ConsumablePokemonModifier"
        | "TerastallizeModifier"
        | "PokemonHpRestoreModifier"
        | "PokemonStatusHealModifier"
        | "ConsumablePokemonMoveModifier"
        | "PokemonPpRestoreModifier"
        | "PokemonAllMovePpRestoreModifier"
        | "PokemonPpUpModifier"
        | "PokemonNatureChangeModifier"
        | "PokemonLevelIncrementModifier"
        | "TmModifier"
        | "RememberMoveModifier"
        | "EvolutionItemModifier"
        | "FusePokemonModifier"
        | "MultipleParticipantExpBonusModifier"
        | "HealingBoosterModifier"
        | "ExpBoosterModifier"
        | "PokemonExpBoosterModifier"
        | "ExpShareModifier"
        | "ExpBalanceModifier"
        | "PokemonFriendshipBoosterModifier"
        | "PokemonNatureWeightModifier"
        | "PokemonMoveAccuracyBoosterModifier"
        | "PokemonMultiHitModifier"
        | "PokemonFormChangeItemModifier"
        | "MoneyRewardModifier"
        | "DamageMoneyRewardModifier"
        | "MoneyInterestModifier"
        | "HiddenAbilityRateBoosterModifier"
        | "ShinyRateBoosterModifier"
        | "CriticalCatchChanceBoosterModifier"
        | "LockModifierTiersModifier"
        | "HealShopCostModifier"
        | "BoostBugSpawnModifier"
        | "SwitchEffectTransferModifier"
        | "HeldItemTransferModifier"
        | "TurnHeldItemTransferModifier"
        | "ContactHeldItemTransferChanceModifier"
        | "IvScannerModifier"
        | "ExtraModifierModifier"
        | "TempExtraModifierModifier"
        | "EnemyPersistentModifier"
        | "EnemyDamageMultiplierModifier"
        | "EnemyDamageBoosterModifier"
        | "EnemyDamageReducerModifier"
        | "EnemyTurnHealModifier"
        | "EnemyAttackStatusEffectChanceModifier"
        | "EnemyStatusEffectHealChanceModifier"
        | "EnemyEndureChanceModifier"
        | "EnemyFusionChanceModifier"
        | "MoneyMultiplierModifier",
>(
    modifier: T,
): this is ModifierInstanceMap[T]
Return whether this modifier is of the given class
Type Parameters
- T extends
      | "PersistentModifier"
      | "ConsumableModifier"
      | "AddPokeballModifier"
      | "AddVoucherModifier"
      | "LapsingPersistentModifier"
      | "DoubleBattleChanceBoosterModifier"
      | "TempStatStageBoosterModifier"
      | "TempCritBoosterModifier"
      | "MapModifier"
      | "MegaEvolutionAccessModifier"
      | "GigantamaxAccessModifier"
      | "TerastallizeAccessModifier"
      | "PokemonHeldItemModifier"
      | "LapsingPokemonHeldItemModifier"
      | "BaseStatModifier"
      | "EvoTrackerModifier"
      | "PokemonBaseStatTotalModifier"
      | "PokemonBaseStatFlatModifier"
      | "PokemonIncrementingStatModifier"
      | "StatBoosterModifier"
      | "SpeciesStatBoosterModifier"
      | "CritBoosterModifier"
      | "SpeciesCritBoosterModifier"
      | "AttackTypeBoosterModifier"
      | "SurviveDamageModifier"
      | "BypassSpeedChanceModifier"
      | "FlinchChanceModifier"
      | "TurnHealModifier"
      | "TurnStatusEffectModifier"
      | "HitHealModifier"
      | "LevelIncrementBoosterModifier"
      | "BerryModifier"
      | "PreserveBerryModifier"
      | "PokemonInstantReviveModifier"
      | "ResetNegativeStatStageModifier"
      | "FieldEffectModifier"
      | "ConsumablePokemonModifier"
      | "TerastallizeModifier"
      | "PokemonHpRestoreModifier"
      | "PokemonStatusHealModifier"
      | "ConsumablePokemonMoveModifier"
      | "PokemonPpRestoreModifier"
      | "PokemonAllMovePpRestoreModifier"
      | "PokemonPpUpModifier"
      | "PokemonNatureChangeModifier"
      | "PokemonLevelIncrementModifier"
      | "TmModifier"
      | "RememberMoveModifier"
      | "EvolutionItemModifier"
      | "FusePokemonModifier"
      | "MultipleParticipantExpBonusModifier"
      | "HealingBoosterModifier"
      | "ExpBoosterModifier"
      | "PokemonExpBoosterModifier"
      | "ExpShareModifier"
      | "ExpBalanceModifier"
      | "PokemonFriendshipBoosterModifier"
      | "PokemonNatureWeightModifier"
      | "PokemonMoveAccuracyBoosterModifier"
      | "PokemonMultiHitModifier"
      | "PokemonFormChangeItemModifier"
      | "MoneyRewardModifier"
      | "DamageMoneyRewardModifier"
      | "MoneyInterestModifier"
      | "HiddenAbilityRateBoosterModifier"
      | "ShinyRateBoosterModifier"
      | "CriticalCatchChanceBoosterModifier"
      | "LockModifierTiersModifier"
      | "HealShopCostModifier"
      | "BoostBugSpawnModifier"
      | "SwitchEffectTransferModifier"
      | "HeldItemTransferModifier"
      | "TurnHeldItemTransferModifier"
      | "ContactHeldItemTransferChanceModifier"
      | "IvScannerModifier"
      | "ExtraModifierModifier"
      | "TempExtraModifierModifier"
      | "EnemyPersistentModifier"
      | "EnemyDamageMultiplierModifier"
      | "EnemyDamageBoosterModifier"
      | "EnemyDamageReducerModifier"
      | "EnemyTurnHealModifier"
      | "EnemyAttackStatusEffectChanceModifier"
      | "EnemyStatusEffectHealChanceModifier"
      | "EnemyEndureChanceModifier"
      | "EnemyFusionChanceModifier"
      | "MoneyMultiplierModifier"
Parameters
- modifier: T
  The modifier to check against
Returns this is ModifierInstanceMap[T]
Whether the modiifer is an instance of the given type

Remarks
Used to avoid requiring the caller to have imported the specific modifier class, avoiding circular dependencies.
Inherited from Modifier.is
- Defined in src/modifier/modifier.ts:155

isIconVisible

isIconVisible(): boolean
Returns boolean
- Defined in src/modifier/modifier.ts:242

match

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

shouldApply

shouldApply(..._args: unknown[]): boolean
Checks if Modifier should be applied
Parameters
- ..._args: unknown[]
  parameters passed to Function.apply
Returns boolean
always true by default
Inherited from Modifier.shouldApply
- Defined in src/modifier/modifier.ts:172

Class PersistentModifierAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PersistentModifier

Properties

Private_

stackCount

type

virtualStackCount

Methods

add

Parameters

Returns boolean

Abstractapply

Parameters

Returns boolean

Abstractclone

Returns PersistentModifier

getArgs

Returns any[]

getCountUnderMax

Returns number

getIcon

Parameters

Returns Container

getIconStackText

Parameters

Returns null | BitmapText

AbstractgetMaxStackCount

Parameters

Returns number

getStackCount

Returns number

incrementStack

Parameters

Returns boolean

is

Type Parameters

Parameters

Returns this is ModifierInstanceMap[T]

Remarks

isIconVisible

Returns boolean

match

Parameters

Returns boolean

shouldApply

Parameters

Returns boolean

Settings

On This Page

Class PersistentModifier`Abstract`

`Private`_

`Abstract`apply

`Abstract`clone

`Abstract`getMaxStackCount