Class ForceSwitchOutAttr

Base class defining all Move Effect Attributes

See

Hierarchy (view full)

MoveEffectAttr
- ForceSwitchOutAttr

Index

Constructors

Properties

batonPass firstHitOnly selfTarget trigger user

Methods

apply canApply getCondition getFailedText getMoveChance getSwitchOutCondition getTargetBenefitScore getUserBenefitScore

Constructors

constructor

new ForceSwitchOutAttr(user?, batonPass?): ForceSwitchOutAttr
Parameters
- Optional user: boolean
- Optional batonPass: boolean
Returns ForceSwitchOutAttr
Overrides MoveEffectAttr.constructor
- Defined in src/data/move.ts:4455

Properties

`Private` batonPass

batonPass: boolean

firstHitOnly

firstHitOnly: boolean

Should this effect only apply on the first hit?

selfTarget

selfTarget: boolean

Should this Move target the user?

trigger

trigger: MoveEffectTrigger

Defines when this effect should trigger in the move's effect order

See

phases.MoveEffectPhase.start

`Private` user

user: boolean

Methods

apply

apply(user, target, move, args): Promise<boolean>
Applies move effects so long as they are able based on canApply
Parameters
- user: default
- target: default
- move: default
- args: any[]
Returns Promise<boolean>
Overrides MoveEffectAttr.apply
- Defined in src/data/move.ts:4461

canApply

canApply(user, target, move, args): boolean
Determines whether the Move's effects are valid to apply
Parameters
- user: default
  Pokemon using the move
- target: default
  Pokemon target of the move
- move: default
  Move with this attribute
- args: any[]
  Set of unique arguments needed by this attribute
Returns boolean
true if basic application of the ability attribute should be possible
Inherited from MoveEffectAttr.canApply
- Defined in src/data/move.ts:822

getCondition

getCondition(): MoveConditionFunc
Returns MoveConditionFunc
the MoveCondition or MoveConditionFunc for this Move
Overrides MoveEffectAttr.getCondition
- Defined in src/data/move.ts:4518

getFailedText

getFailedText(user, target, move, cancelled): string
Parameters
- user: default
  Pokemon using the move
- target: default
  Pokemon target of the move
- move: default
  Move with this attribute
- cancelled: BooleanHolder
  Utils.BooleanHolder which stores if the move should fail
Returns string
the string representing failure of this Move
Overrides MoveEffectAttr.getFailedText
- Defined in src/data/move.ts:4522

getMoveChance

getMoveChance(user, target, move, selfEffect?): number
Gets the used move's additional effect chance. If user's ability has MoveEffectChanceMultiplierAbAttr or IgnoreMoveEffectsAbAttr modifies the base chance.
Parameters
- user: default
  Pokemon using this move
- target: default
  Pokemon target of this move
- move: default
  Move being used
- Optional selfEffect: Boolean
  Boolean if move targets user.
Returns number
Move chance value.
Inherited from MoveEffectAttr.getMoveChance
- Defined in src/data/move.ts:842

getSwitchOutCondition

getSwitchOutCondition(): MoveConditionFunc
Returns MoveConditionFunc
- Defined in src/data/move.ts:4528

getTargetBenefitScore

getTargetBenefitScore(user, target, move): number
Used by the Enemy AI to rank an attack based on a given target
Parameters
- user: default
- target: default
- move: default
Returns number
See
EnemyPokemon.getNextMove
Inherited from MoveEffectAttr.getTargetBenefitScore
- Defined in src/data/move.ts:782

getUserBenefitScore

getUserBenefitScore(user, target, move): number
Used by the Enemy AI to rank an attack based on a given user
Parameters
- user: default
- target: default
- move: default
Returns number
See
EnemyPokemon.getNextMove
Overrides MoveEffectAttr.getUserBenefitScore
- Defined in src/data/move.ts:4552