Class MoveEffectPhase

Hierarchy (View Summary)

PokemonPhase
- MoveEffectPhase

Constructors

constructor

new MoveEffectPhase(
    battlerIndex: BattlerIndex,
    targets: BattlerIndex[],
    move: default,
    reflected?: boolean,
    virtual?: boolean,
): MoveEffectPhase
Parameters
- battlerIndex: BattlerIndex
- targets: BattlerIndex[]
- move: default
- reflected: boolean = false
  Indicates that the move was reflected by the user due to magic coat or magic bounce
- virtual: boolean = false
  Indicates that the move is a virtual move (i.e. called by metronome)
Returns MoveEffectPhase
Overrides PokemonPhase.constructor
- Defined in src/phases/move-effect-phase.ts:108

Properties

`Protected`battlerIndex

battlerIndex: number

fieldIndex

fieldIndex: number

move

move: default

player

player: boolean

`Protected`reflected

reflected: boolean = false

`Protected`targets

targets: BattlerIndex[]

Methods

`Protected`applyHeldItemFlinchCheck

applyHeldItemFlinchCheck(
    user: default,
    target: default,
    dealsDamage: boolean,
): void
Handles checking for and applying Flinches
Parameters
- user: default
  The Pokemon using this phase's invoked move
- target: default
  Pokemon the current target of this phase's invoked move
- dealsDamage: boolean
  true if the attempted move successfully dealt damage
Returns void
a function intended to be passed into a then() call.
- Defined in src/phases/move-effect-phase.ts:447

`Protected`applyMove

applyMove(
    user: default,
    target: default,
    effectiveness: TypeDamageMultiplier,
): HitResult
Apply the result of this phase's move to the given target
Parameters
- user: default
  The Pokemon using this phase's invoked move
- target: default
  The Pokemon struck by the move
- effectiveness: TypeDamageMultiplier
  The effectiveness of the move against the target
Returns HitResult
- Defined in src/phases/move-effect-phase.ts:945

`Protected`applyMoveDamage

applyMoveDamage(
    user: default,
    target: default,
    effectiveness: TypeDamageMultiplier,
): HitResult
Sub-method of for applyMoveEffects that applies damage to the target.
Parameters
- user: default
  The Pokemon using this phase's invoked move
- target: default
  The Pokemon targeted by the move
- effectiveness: TypeDamageMultiplier
  The effectiveness of the move against the target
Returns HitResult
- Defined in src/phases/move-effect-phase.ts:803

`Protected`applyMoveEffects

applyMoveEffects(
    target: default,
    effectiveness: TypeDamageMultiplier,
    firstTarget: boolean,
): void
Applies all move effects that trigger in the event of a successful hit:
- PRE_APPLY effects`
- Applying damage to the target
- POST_APPLY effects
- Invoking applyOnTargetEffects if the move does not hit a substitute
- Triggering form changes and emergency exit / wimp out if this is the last hit
Parameters
- target: default
  the Pokemon hit by this phase's move.
- effectiveness: TypeDamageMultiplier
  The effectiveness of the move (as previously evaluated in hitCheck)
- firstTarget: boolean
  Whether this is the first target successfully struck by the move
Returns void
- Defined in src/phases/move-effect-phase.ts:772

`Protected`applyOnGetHitAbEffects

applyOnGetHitAbEffects(
    user: default,
    target: default,
    hitResult: HitResult,
): void
Applies reactive effects that occur when a Pokémon is hit. (i.e. Effect Spore, Disguise, Liquid Ooze, Beak Blast)
Parameters
- user: default
  The Pokemon using this phase's invoked move
- target: default
  Pokemon the current target of this phase's invoked move
- hitResult: HitResult
  The HitResult of the attempted move
Returns void
a Promise intended to be passed into a then() call.
- Defined in src/phases/move-effect-phase.ts:435

`Protected`applyOnTargetEffects

applyOnTargetEffects(
    user: default,
    target: default,
    hitResult: HitResult,
    firstTarget: boolean,
): void
Applies all effects aimed at the move's target. To be used when the target is successfully and directly hit by the move.
Parameters
- user: default
  The Pokemon using the move
- target: default
  The Pokemon targeted by the move
- hitResult: HitResult
  The HitResult obtained from applying the move
- firstTarget: boolean
  true if the target is the first Pokemon hit by the attack
Returns void
- Defined in src/phases/move-effect-phase.ts:973

checkBypassAccAndInvuln

checkBypassAccAndInvuln(target: default): undefined | boolean
Check whether the move should bypass both the accuracy and semi-invulnerable states.
Parameters
- target: default
  The Pokemon targeted by the invoked move
Returns undefined | boolean
true if the move should bypass accuracy and semi-invulnerability

Accuracy and semi-invulnerability can be bypassed by:
- An ability like Abilities.NO_GUARD | No Guard
- A poison type using Toxic
- A move like Lock-On or Mind Reader.
- A field-targeted move like spikes
Does not check against effects Glaive Rush status (which should not bypass semi-invulnerability), or interactions like Earthquake hitting against Dig, (which should not bypass the accuracy check).

See
hitCheck
- Defined in src/phases/move-effect-phase.ts:623

checkBypassSemiInvuln

checkBypassSemiInvuln(semiInvulnerableTag: nil | SemiInvulnerableTag): boolean
Check whether the move is able to ignore the given semiInvulnerableTag
Parameters
- semiInvulnerableTag: nil | SemiInvulnerableTag
  The semiInvulnerable tag to check against
Returns boolean
true if the move can ignore the semi-invulnerable state
- Defined in src/phases/move-effect-phase.ts:651

end

end(): void
Returns void
Overrides PokemonPhase.end
- Defined in src/phases/move-effect-phase.ts:399

executeForAll

executeForAll(func: PokemonFunc): void
Parameters
- func: PokemonFunc
Returns void
Inherited from PokemonPhase.executeForAll
- Defined in src/phases/field-phase.ts:8

getFirstTarget

getFirstTarget(): undefined | default
Returns undefined | default
The first target of this phase's invoked move
- Defined in src/phases/move-effect-phase.ts:673

`Protected`getNewHitPhase

getNewHitPhase(): MoveEffectPhase
Returns MoveEffectPhase
A new MoveEffectPhase with the same properties as this phase
- Defined in src/phases/move-effect-phase.ts:713

getPokemon

getPokemon(): default
Returns default
Inherited from PokemonPhase.getPokemon
- Defined in src/phases/pokemon-phase.ts:29

getTargets

getTargets(): default[]
Returns default[]
An array of all Pokemon targeted by this phase's invoked move
- Defined in src/phases/move-effect-phase.ts:668

getUserPokemon

getUserPokemon(): null | default
Returns null | default
The Pokemon using this phase's invoked move
- Defined in src/phases/move-effect-phase.ts:660

hideEnemyTrainer

hideEnemyTrainer(): void
Returns void
Inherited from PokemonPhase.hideEnemyTrainer
- Defined in src/phases/battle-phase.ts:37

hitCheck

hitCheck(target: default): HitCheckEntry
Conduct the hit check and type effectiveness for this move against the target

Checks occur in the following order:
1. if the move is self-target
2. if the target is on the field
3. if the target is hidden by the effects of its commander ability
4. if the target is in an applicable semi-invulnerable state
5. if the target has an applicable protection effect
6. if the move is reflected by magic coat or magic bounce
7. type effectiveness calculation, including immunities from abilities and typing
8. if accuracy is checked, whether the roll passes the accuracy check
Parameters
- target: default
  The Pokemon targeted by the invoked move
Returns HitCheckEntry
a HitCheckEntry containing the attack's HitCheckResult and effectiveness against the target.
- Defined in src/phases/move-effect-phase.ts:514

`Protected`onFaintTarget

onFaintTarget(user: default, target: default): void
Sub-method of applyMove that handles the event of a target fainting.
Parameters
- user: default
  The Pokemon using this phase's invoked move
- target: default
  The Pokemon that fainted
Returns void
- Defined in src/phases/move-effect-phase.ts:899

`Protected`queueHitResultMessage

queueHitResultMessage(result: HitResult): void
Sub-method of applyMove that queues the hit-result message on the final strike of the move against a target
Parameters
- result: HitResult
  The HitResult of the move
Returns void
- Defined in src/phases/move-effect-phase.ts:922

`Protected`removeTarget

removeTarget(target: default): void
Removes the given Pokemon from this phase's target list
Parameters
- target: default
  The Pokemon to be removed
Returns void
- Defined in src/phases/move-effect-phase.ts:681

showEnemyTrainer

showEnemyTrainer(trainerSlot?: TrainerSlot): void
Parameters
- trainerSlot: TrainerSlot = TrainerSlot.NONE
Returns void
Inherited from PokemonPhase.showEnemyTrainer
- Defined in src/phases/battle-phase.ts:6

start

start(): void
Returns void
Overrides PokemonPhase.start
- Defined in src/phases/move-effect-phase.ts:248

stopMultiHit

stopMultiHit(target?: default): void
Prevents subsequent strikes of this phase's invoked move from occurring
Parameters
- Optionaltarget: default
  If defined, only stop subsequent strikes against this Pokemon
Returns void
- Defined in src/phases/move-effect-phase.ts:695

`Protected`triggerMoveEffects

triggerMoveEffects(
    triggerType: MoveEffectTrigger,
    user: default,
    target: null | default,
    firstTarget?: null | boolean,
    selfTarget?: boolean,
): void
Triggers move effects of the given move effect trigger.
Parameters
- triggerType: MoveEffectTrigger
  The MoveEffectTrigger being applied
- user: default
  The Pokemon using the move
- target: null | default
  The Pokemon targeted by the move
- OptionalfirstTarget: null | boolean
  Whether the target is the first to be hit by the current strike
- OptionalselfTarget: boolean
  If defined, limits the effects triggered to either self-targeted effects (if set to true) or targeted effects (if set to false).
Returns void
a Promise applying the relevant move effects.
- Defined in src/phases/move-effect-phase.ts:738

`Protected`updateSubstitutes

updateSubstitutes(): void
Removes all substitutes that were broken by this phase's invoked move

Returns void
- Defined in src/phases/move-effect-phase.ts:718

Class MoveEffectPhase

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MoveEffectPhase

Properties

ProtectedbattlerIndex

fieldIndex

move

player

Protectedreflected

Protectedtargets

Methods

ProtectedapplyHeldItemFlinchCheck

Parameters

Returns void

ProtectedapplyMove

Parameters

Returns HitResult

ProtectedapplyMoveDamage

Parameters

Returns HitResult

ProtectedapplyMoveEffects

Parameters

Returns void

ProtectedapplyOnGetHitAbEffects

Parameters

Returns void

ProtectedapplyOnTargetEffects

Parameters

Returns void

checkBypassAccAndInvuln

Parameters

Returns undefined | boolean

See

checkBypassSemiInvuln

Parameters

Returns boolean

end

Returns void

executeForAll

Parameters

Returns void

getFirstTarget

Returns undefined | default

ProtectedgetNewHitPhase

Returns MoveEffectPhase

getPokemon

Returns default

getTargets

Returns default[]

getUserPokemon

Returns null | default

hideEnemyTrainer

Returns void

hitCheck

Parameters

Returns HitCheckEntry

ProtectedonFaintTarget

Parameters

Returns void

ProtectedqueueHitResultMessage

Parameters

Returns void

ProtectedremoveTarget

Parameters

Returns void

showEnemyTrainer

Parameters

Returns void

start

Returns void

stopMultiHit

Parameters

Returns void

`Protected`battlerIndex

`Protected`reflected

`Protected`targets

`Protected`applyHeldItemFlinchCheck

`Protected`applyMove

`Protected`applyMoveDamage

`Protected`applyMoveEffects

`Protected`applyOnGetHitAbEffects

`Protected`applyOnTargetEffects

`Protected`getNewHitPhase

`Protected`onFaintTarget

`Protected`queueHitResultMessage

`Protected`removeTarget

`Protected`triggerMoveEffects

`Protected`updateSubstitutes