Class PreAttackAbAttrAbstract

showAbility

addCondition

• addCondition(condition: AbAttrCondition): AbAttr

  Parameters

  • condition: AbAttrCondition

  Returns AbAttr

apply

• apply(_params: AbAttrBaseParams): void

  Apply this attribute's effects without checking conditions.

  Parameters

  • _params: AbAttrBaseParams

  Returns void

  Remarks

  Never call this method directly!
  Use applyAbAttrs instead.

canApply

• canApply(_params: Exact<Parameters<this["apply"]>[0]>): boolean

  Check whether this attribute can have its effects successfully applied. Applies to all instances of the given attribute.

  Parameters

  • _params: Exact<Parameters<this["apply"]>[0]>

    The parameters passed to this attribute's apply function; must match type exactly

  Returns boolean

getCondition

• getCondition(): null | AbAttrCondition

  Return the additional condition associated with this particular AbAttr instance, if any.

  Returns null | AbAttrCondition

  The extra condition for this AbAttr, or null if none exist

  Todo

  Make this use undefined instead of null

  Todo

  Prevent this from being overridden by sub-classes

getTriggerMessage

• getTriggerMessage(
      _params: Exact<Parameters<this["apply"]>[0]>,
      _abilityName: string,
  ): null | string

  Return the trigger message to show when this attribute is executed.

  Parameters

  • _params: Exact<Parameters<this["apply"]>[0]>

    The parameters passed to this attribute's apply function; must match type exactly
  • _abilityName: string

    The name of the current ability.

  Returns null | string

  Todo

  Remove null from signature in lieu of using an empty string

is

• is<
      K extends
          | "BlockRecoilDamageAttr"
          | "DoubleBattleChanceAbAttr"
          | "PostBattleInitAbAttr"
          | "PostBattleInitFormChangeAbAttr"
          | "PostTeraFormChangeStatChangeAbAttr"
          | "ClearWeatherAbAttr"
          | "ClearTerrainAbAttr"
          | "PreDefendAbAttr"
          | "PreDefendFullHpEndureAbAttr"
          | "BlockItemTheftAbAttr"
          | "StabBoostAbAttr"
          | "ReceivedMoveDamageMultiplierAbAttr"
          | "AlliedFieldDamageReductionAbAttr"
          | "ReceivedTypeDamageMultiplierAbAttr"
          | "TypeImmunityAbAttr"
          | "AttackTypeImmunityAbAttr"
          | "TypeImmunityHealAbAttr"
          | "NonSuperEffectiveImmunityAbAttr"
          | "FullHpResistTypeAbAttr"
          | "PostDefendAbAttr"
          | "FieldPriorityMoveImmunityAbAttr"
          | "PostStatStageChangeAbAttr"
          | "MoveImmunityAbAttr"
          | "WonderSkinAbAttr"
          | "MoveImmunityStatStageChangeAbAttr"
          | "ReverseDrainAbAttr"
          | "PostDefendStatStageChangeAbAttr"
          | "PostDefendHpGatedStatStageChangeAbAttr"
          | "PostDefendApplyArenaTrapTagAbAttr"
          | "PostDefendApplyBattlerTagAbAttr"
          | "PostDefendTypeChangeAbAttr"
          | "PostDefendTerrainChangeAbAttr"
          | "PostDefendContactApplyStatusEffectAbAttr"
          | "EffectSporeAbAttr"
          | "PostDefendContactApplyTagChanceAbAttr"
          | "PostReceiveCritStatStageChangeAbAttr"
          | "PostDefendContactDamageAbAttr"
          | "PostDefendPerishSongAbAttr"
          | "PostDefendWeatherChangeAbAttr"
          | "PostDefendAbilitySwapAbAttr"
          | "PostDefendAbilityGiveAbAttr"
          | "PostDefendMoveDisableAbAttr"
          | "PostStatStageChangeStatStageChangeAbAttr"
          | "PreAttackAbAttr"
          | "MoveEffectChanceMultiplierAbAttr"
          | "IgnoreMoveEffectsAbAttr"
          | "VariableMovePowerAbAttr"
          | "FieldPreventExplosiveMovesAbAttr"
          | "FieldMultiplyStatAbAttr"
          | "MoveTypeChangeAbAttr"
          | "PokemonTypeChangeAbAttr"
          | "AddSecondStrikeAbAttr"
          | "DamageBoostAbAttr"
          | "MovePowerBoostAbAttr"
          | "MoveTypePowerBoostAbAttr"
          | "LowHpMoveTypePowerBoostAbAttr"
          | "VariableMovePowerBoostAbAttr"
          | "FieldMovePowerBoostAbAttr"
          | "PreAttackFieldMoveTypePowerBoostAbAttr"
          | "FieldMoveTypePowerBoostAbAttr"
          | "UserFieldMoveTypePowerBoostAbAttr"
          | "AllyMoveCategoryPowerBoostAbAttr"
          | "StatMultiplierAbAttr"
          | "PostAttackAbAttr"
          | "AllyStatMultiplierAbAttr"
          | "ExecutedMoveAbAttr"
          | "GorillaTacticsAbAttr"
          | "PostAttackStealHeldItemAbAttr"
          | "PostAttackApplyStatusEffectAbAttr"
          | "PostAttackContactApplyStatusEffectAbAttr"
          | "PostAttackApplyBattlerTagAbAttr"
          | "PostDefendStealHeldItemAbAttr"
          | "PostSetStatusAbAttr"
          | "SynchronizeStatusAbAttr"
          | "PostVictoryAbAttr"
          | "PostVictoryFormChangeAbAttr"
          | "PostKnockOutAbAttr"
          | "PostKnockOutStatStageChangeAbAttr"
          | "CopyFaintedAllyAbilityAbAttr"
          | "IgnoreOpponentStatStagesAbAttr"
          | "IntimidateImmunityAbAttr"
          | "PostIntimidateStatStageChangeAbAttr"
          | "PostSummonAbAttr"
          | "PostSummonRemoveEffectAbAttr"
          | "PostSummonRemoveArenaTagAbAttr"
          | "PostSummonAddArenaTagAbAttr"
          | "PostSummonMessageAbAttr"
          | "PostSummonUnnamedMessageAbAttr"
          | "PostSummonAddBattlerTagAbAttr"
          | "PostSummonRemoveBattlerTagAbAttr"
          | "PostSummonStatStageChangeAbAttr"
          | "PostSummonAllyHealAbAttr"
          | "PostSummonClearAllyStatStagesAbAttr"
          | "DownloadAbAttr"
          | "PostSummonWeatherChangeAbAttr"
          | "PostSummonTerrainChangeAbAttr"
          | "PostSummonHealStatusAbAttr"
          | "PostSummonFormChangeAbAttr"
          | "PostSummonCopyAbilityAbAttr"
          | "PostSummonUserFieldRemoveStatusEffectAbAttr"
          | "PostSummonCopyAllyStatsAbAttr"
          | "PostSummonTransformAbAttr"
          | "PostSummonWeatherSuppressedFormChangeAbAttr"
          | "PostSummonFormChangeByWeatherAbAttr"
          | "CommanderAbAttr"
          | "PreSwitchOutAbAttr"
          | "PreSwitchOutResetStatusAbAttr"
          | "PreSwitchOutClearWeatherAbAttr"
          | "PreSwitchOutHealAbAttr"
          | "PreSwitchOutFormChangeAbAttr"
          | "PreLeaveFieldAbAttr"
          | "PreLeaveFieldClearWeatherAbAttr"
          | "PreLeaveFieldRemoveSuppressAbilitiesSourceAbAttr"
          | "PreStatStageChangeAbAttr"
          | "ReflectStatStageChangeAbAttr"
          | "ProtectStatAbAttr"
          | "ConfusionOnStatusEffectAbAttr"
          | "PreSetStatusAbAttr"
          | "PreSetStatusEffectImmunityAbAttr"
          | "StatusEffectImmunityAbAttr"
          | "UserFieldStatusEffectImmunityAbAttr"
          | "ConditionalUserFieldStatusEffectImmunityAbAttr"
          | "ConditionalUserFieldProtectStatAbAttr"
          | "PreApplyBattlerTagAbAttr"
          | "PreApplyBattlerTagImmunityAbAttr"
          | "BattlerTagImmunityAbAttr"
          | "UserFieldBattlerTagImmunityAbAttr"
          | "ConditionalUserFieldBattlerTagImmunityAbAttr"
          | "BlockCritAbAttr"
          | "BonusCritAbAttr"
          | "MultCritAbAttr"
          | "ConditionalCritAbAttr"
          | "BlockNonDirectDamageAbAttr"
          | "BlockStatusDamageAbAttr"
          | "BlockOneHitKOAbAttr"
          | "ChangeMovePriorityAbAttr"
          | "IgnoreContactAbAttr"
          | "PreWeatherEffectAbAttr"
          | "PreWeatherDamageAbAttr"
          | "SuppressWeatherEffectAbAttr"
          | "ForewarnAbAttr"
          | "FriskAbAttr"
          | "PostWeatherChangeAbAttr"
          | "PostWeatherChangeFormChangeAbAttr"
          | "PostWeatherLapseAbAttr"
          | "PostWeatherLapseHealAbAttr"
          | "PostWeatherLapseDamageAbAttr"
          | "PostTerrainChangeAbAttr"
          | "PostTurnAbAttr"
          | "PostTurnStatusHealAbAttr"
          | "PostTurnResetStatusAbAttr"
          | "PostTurnRestoreBerryAbAttr"
          | "CudChewConsumeBerryAbAttr"
          | "CudChewRecordBerryAbAttr"
          | "MoodyAbAttr"
          | "SpeedBoostAbAttr"
          | "PostTurnHealAbAttr"
          | "PostTurnFormChangeAbAttr"
          | "PostTurnHurtIfSleepingAbAttr"
          | "FetchBallAbAttr"
          | "PostBiomeChangeAbAttr"
          | "PostBiomeChangeWeatherChangeAbAttr"
          | "PostBiomeChangeTerrainChangeAbAttr"
          | "PostMoveUsedAbAttr"
          | "PostDancingMoveAbAttr"
          | "PostItemLostAbAttr"
          | "PostItemLostApplyBattlerTagAbAttr"
          | "StatStageChangeMultiplierAbAttr"
          | "StatStageChangeCopyAbAttr"
          | "BypassBurnDamageReductionAbAttr"
          | "ReduceBurnDamageAbAttr"
          | "DoubleBerryEffectAbAttr"
          | "PreventBerryUseAbAttr"
          | "HealFromBerryUseAbAttr"
          | "RunSuccessAbAttr"
          | "CheckTrappedAbAttr"
          | "ArenaTrapAbAttr"
          | "MaxMultiHitAbAttr"
          | "PostBattleAbAttr"
          | "PostBattleLootAbAttr"
          | "PostFaintAbAttr"
          | "PostFaintUnsuppressedWeatherFormChangeAbAttr"
          | "PostFaintContactDamageAbAttr"
          | "PostFaintHPDamageAbAttr"
          | "RedirectMoveAbAttr"
          | "RedirectTypeMoveAbAttr"
          | "BlockRedirectAbAttr"
          | "ReduceStatusEffectDurationAbAttr"
          | "FlinchEffectAbAttr"
          | "FlinchStatStageChangeAbAttr"
          | "IncreasePpAbAttr"
          | "ForceSwitchOutImmunityAbAttr"
          | "ReduceBerryUseThresholdAbAttr"
          | "WeightMultiplierAbAttr"
          | "SyncEncounterNatureAbAttr"
          | "MoveAbilityBypassAbAttr"
          | "AlwaysHitAbAttr"
          | "IgnoreProtectOnContactAbAttr"
          | "InfiltratorAbAttr"
          | "ReflectStatusMoveAbAttr"
          | "NoTransformAbilityAbAttr"
          | "NoFusionAbilityAbAttr"
          | "IgnoreTypeImmunityAbAttr"
          | "IgnoreTypeStatusEffectImmunityAbAttr"
          | "MoneyAbAttr"
          | "PostSummonStatStageChangeOnArenaAbAttr"
          | "FormBlockDamageAbAttr"
          | "PreSummonAbAttr"
          | "IllusionPreSummonAbAttr"
          | "IllusionBreakAbAttr"
          | "PostDefendIllusionBreakAbAttr"
          | "IllusionPostBattleAbAttr"
          | "BypassSpeedChanceAbAttr"
          | "PreventBypassSpeedChanceAbAttr"
          | "TerrainEventTypeChangeAbAttr"
          | "PostDamageAbAttr"
          | "PostDamageForceSwitchAbAttr",
  >(
      attr: K,
  ): this is AbAttrMap[K]

  Return whether this attribute is of the given type.

  Type Parameters

  • K extends
        | "BlockRecoilDamageAttr"
        | "DoubleBattleChanceAbAttr"
        | "PostBattleInitAbAttr"
        | "PostBattleInitFormChangeAbAttr"
        | "PostTeraFormChangeStatChangeAbAttr"
        | "ClearWeatherAbAttr"
        | "ClearTerrainAbAttr"
        | "PreDefendAbAttr"
        | "PreDefendFullHpEndureAbAttr"
        | "BlockItemTheftAbAttr"
        | "StabBoostAbAttr"
        | "ReceivedMoveDamageMultiplierAbAttr"
        | "AlliedFieldDamageReductionAbAttr"
        | "ReceivedTypeDamageMultiplierAbAttr"
        | "TypeImmunityAbAttr"
        | "AttackTypeImmunityAbAttr"
        | "TypeImmunityHealAbAttr"
        | "NonSuperEffectiveImmunityAbAttr"
        | "FullHpResistTypeAbAttr"
        | "PostDefendAbAttr"
        | "FieldPriorityMoveImmunityAbAttr"
        | "PostStatStageChangeAbAttr"
        | "MoveImmunityAbAttr"
        | "WonderSkinAbAttr"
        | "MoveImmunityStatStageChangeAbAttr"
        | "ReverseDrainAbAttr"
        | "PostDefendStatStageChangeAbAttr"
        | "PostDefendHpGatedStatStageChangeAbAttr"
        | "PostDefendApplyArenaTrapTagAbAttr"
        | "PostDefendApplyBattlerTagAbAttr"
        | "PostDefendTypeChangeAbAttr"
        | "PostDefendTerrainChangeAbAttr"
        | "PostDefendContactApplyStatusEffectAbAttr"
        | "EffectSporeAbAttr"
        | "PostDefendContactApplyTagChanceAbAttr"
        | "PostReceiveCritStatStageChangeAbAttr"
        | "PostDefendContactDamageAbAttr"
        | "PostDefendPerishSongAbAttr"
        | "PostDefendWeatherChangeAbAttr"
        | "PostDefendAbilitySwapAbAttr"
        | "PostDefendAbilityGiveAbAttr"
        | "PostDefendMoveDisableAbAttr"
        | "PostStatStageChangeStatStageChangeAbAttr"
        | "PreAttackAbAttr"
        | "MoveEffectChanceMultiplierAbAttr"
        | "IgnoreMoveEffectsAbAttr"
        | "VariableMovePowerAbAttr"
        | "FieldPreventExplosiveMovesAbAttr"
        | "FieldMultiplyStatAbAttr"
        | "MoveTypeChangeAbAttr"
        | "PokemonTypeChangeAbAttr"
        | "AddSecondStrikeAbAttr"
        | "DamageBoostAbAttr"
        | "MovePowerBoostAbAttr"
        | "MoveTypePowerBoostAbAttr"
        | "LowHpMoveTypePowerBoostAbAttr"
        | "VariableMovePowerBoostAbAttr"
        | "FieldMovePowerBoostAbAttr"
        | "PreAttackFieldMoveTypePowerBoostAbAttr"
        | "FieldMoveTypePowerBoostAbAttr"
        | "UserFieldMoveTypePowerBoostAbAttr"
        | "AllyMoveCategoryPowerBoostAbAttr"
        | "StatMultiplierAbAttr"
        | "PostAttackAbAttr"
        | "AllyStatMultiplierAbAttr"
        | "ExecutedMoveAbAttr"
        | "GorillaTacticsAbAttr"
        | "PostAttackStealHeldItemAbAttr"
        | "PostAttackApplyStatusEffectAbAttr"
        | "PostAttackContactApplyStatusEffectAbAttr"
        | "PostAttackApplyBattlerTagAbAttr"
        | "PostDefendStealHeldItemAbAttr"
        | "PostSetStatusAbAttr"
        | "SynchronizeStatusAbAttr"
        | "PostVictoryAbAttr"
        | "PostVictoryFormChangeAbAttr"
        | "PostKnockOutAbAttr"
        | "PostKnockOutStatStageChangeAbAttr"
        | "CopyFaintedAllyAbilityAbAttr"
        | "IgnoreOpponentStatStagesAbAttr"
        | "IntimidateImmunityAbAttr"
        | "PostIntimidateStatStageChangeAbAttr"
        | "PostSummonAbAttr"
        | "PostSummonRemoveEffectAbAttr"
        | "PostSummonRemoveArenaTagAbAttr"
        | "PostSummonAddArenaTagAbAttr"
        | "PostSummonMessageAbAttr"
        | "PostSummonUnnamedMessageAbAttr"
        | "PostSummonAddBattlerTagAbAttr"
        | "PostSummonRemoveBattlerTagAbAttr"
        | "PostSummonStatStageChangeAbAttr"
        | "PostSummonAllyHealAbAttr"
        | "PostSummonClearAllyStatStagesAbAttr"
        | "DownloadAbAttr"
        | "PostSummonWeatherChangeAbAttr"
        | "PostSummonTerrainChangeAbAttr"
        | "PostSummonHealStatusAbAttr"
        | "PostSummonFormChangeAbAttr"
        | "PostSummonCopyAbilityAbAttr"
        | "PostSummonUserFieldRemoveStatusEffectAbAttr"
        | "PostSummonCopyAllyStatsAbAttr"
        | "PostSummonTransformAbAttr"
        | "PostSummonWeatherSuppressedFormChangeAbAttr"
        | "PostSummonFormChangeByWeatherAbAttr"
        | "CommanderAbAttr"
        | "PreSwitchOutAbAttr"
        | "PreSwitchOutResetStatusAbAttr"
        | "PreSwitchOutClearWeatherAbAttr"
        | "PreSwitchOutHealAbAttr"
        | "PreSwitchOutFormChangeAbAttr"
        | "PreLeaveFieldAbAttr"
        | "PreLeaveFieldClearWeatherAbAttr"
        | "PreLeaveFieldRemoveSuppressAbilitiesSourceAbAttr"
        | "PreStatStageChangeAbAttr"
        | "ReflectStatStageChangeAbAttr"
        | "ProtectStatAbAttr"
        | "ConfusionOnStatusEffectAbAttr"
        | "PreSetStatusAbAttr"
        | "PreSetStatusEffectImmunityAbAttr"
        | "StatusEffectImmunityAbAttr"
        | "UserFieldStatusEffectImmunityAbAttr"
        | "ConditionalUserFieldStatusEffectImmunityAbAttr"
        | "ConditionalUserFieldProtectStatAbAttr"
        | "PreApplyBattlerTagAbAttr"
        | "PreApplyBattlerTagImmunityAbAttr"
        | "BattlerTagImmunityAbAttr"
        | "UserFieldBattlerTagImmunityAbAttr"
        | "ConditionalUserFieldBattlerTagImmunityAbAttr"
        | "BlockCritAbAttr"
        | "BonusCritAbAttr"
        | "MultCritAbAttr"
        | "ConditionalCritAbAttr"
        | "BlockNonDirectDamageAbAttr"
        | "BlockStatusDamageAbAttr"
        | "BlockOneHitKOAbAttr"
        | "ChangeMovePriorityAbAttr"
        | "IgnoreContactAbAttr"
        | "PreWeatherEffectAbAttr"
        | "PreWeatherDamageAbAttr"
        | "SuppressWeatherEffectAbAttr"
        | "ForewarnAbAttr"
        | "FriskAbAttr"
        | "PostWeatherChangeAbAttr"
        | "PostWeatherChangeFormChangeAbAttr"
        | "PostWeatherLapseAbAttr"
        | "PostWeatherLapseHealAbAttr"
        | "PostWeatherLapseDamageAbAttr"
        | "PostTerrainChangeAbAttr"
        | "PostTurnAbAttr"
        | "PostTurnStatusHealAbAttr"
        | "PostTurnResetStatusAbAttr"
        | "PostTurnRestoreBerryAbAttr"
        | "CudChewConsumeBerryAbAttr"
        | "CudChewRecordBerryAbAttr"
        | "MoodyAbAttr"
        | "SpeedBoostAbAttr"
        | "PostTurnHealAbAttr"
        | "PostTurnFormChangeAbAttr"
        | "PostTurnHurtIfSleepingAbAttr"
        | "FetchBallAbAttr"
        | "PostBiomeChangeAbAttr"
        | "PostBiomeChangeWeatherChangeAbAttr"
        | "PostBiomeChangeTerrainChangeAbAttr"
        | "PostMoveUsedAbAttr"
        | "PostDancingMoveAbAttr"
        | "PostItemLostAbAttr"
        | "PostItemLostApplyBattlerTagAbAttr"
        | "StatStageChangeMultiplierAbAttr"
        | "StatStageChangeCopyAbAttr"
        | "BypassBurnDamageReductionAbAttr"
        | "ReduceBurnDamageAbAttr"
        | "DoubleBerryEffectAbAttr"
        | "PreventBerryUseAbAttr"
        | "HealFromBerryUseAbAttr"
        | "RunSuccessAbAttr"
        | "CheckTrappedAbAttr"
        | "ArenaTrapAbAttr"
        | "MaxMultiHitAbAttr"
        | "PostBattleAbAttr"
        | "PostBattleLootAbAttr"
        | "PostFaintAbAttr"
        | "PostFaintUnsuppressedWeatherFormChangeAbAttr"
        | "PostFaintContactDamageAbAttr"
        | "PostFaintHPDamageAbAttr"
        | "RedirectMoveAbAttr"
        | "RedirectTypeMoveAbAttr"
        | "BlockRedirectAbAttr"
        | "ReduceStatusEffectDurationAbAttr"
        | "FlinchEffectAbAttr"
        | "FlinchStatStageChangeAbAttr"
        | "IncreasePpAbAttr"
        | "ForceSwitchOutImmunityAbAttr"
        | "ReduceBerryUseThresholdAbAttr"
        | "WeightMultiplierAbAttr"
        | "SyncEncounterNatureAbAttr"
        | "MoveAbilityBypassAbAttr"
        | "AlwaysHitAbAttr"
        | "IgnoreProtectOnContactAbAttr"
        | "InfiltratorAbAttr"
        | "ReflectStatusMoveAbAttr"
        | "NoTransformAbilityAbAttr"
        | "NoFusionAbilityAbAttr"
        | "IgnoreTypeImmunityAbAttr"
        | "IgnoreTypeStatusEffectImmunityAbAttr"
        | "MoneyAbAttr"
        | "PostSummonStatStageChangeOnArenaAbAttr"
        | "FormBlockDamageAbAttr"
        | "PreSummonAbAttr"
        | "IllusionPreSummonAbAttr"
        | "IllusionBreakAbAttr"
        | "PostDefendIllusionBreakAbAttr"
        | "IllusionPostBattleAbAttr"
        | "BypassSpeedChanceAbAttr"
        | "PreventBypassSpeedChanceAbAttr"
        | "TerrainEventTypeChangeAbAttr"
        | "PostDamageAbAttr"
        | "PostDamageForceSwitchAbAttr"

  Parameters

  • attr: K

    The attribute to check against

  Returns this is AbAttrMap[K]

  Whether the attribute is an instance of the given type

  Remarks

  Used to avoid requiring the caller to have imported the specific attribute type, avoiding circular dependencies.