Class SacrificialAttrOnHit

Attribute used for moves which self KO the user but only if the move hits a target

See

Hierarchy (view full)

MoveEffectAttr
- SacrificialAttrOnHit

Index

Constructors

Properties

firstHitOnly selfTarget trigger

Methods

apply canApply getCondition getFailedText getTargetBenefitScore getUserBenefitScore

Constructors

constructor

new SacrificialAttrOnHit(): SacrificialAttrOnHit
Returns SacrificialAttrOnHit
Overrides MoveEffectAttr.constructor
- Defined in src/data/move.ts:911

Properties

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

MoveEffectPhase.start

Methods

apply

apply(user, target, move, args): boolean
Deals damage to the user equal to their current hp if the move lands
Parameters
- user: default
  Pokemon that used the move
- target: default
  Pokemon target of the move
- move: default
  Move with this attribute
- args: any[]
  N/A
Returns boolean
true if the function succeeds
Overrides MoveEffectAttr.apply
- Defined in src/data/move.ts:923

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:607

getCondition

getCondition(): MoveCondition | MoveConditionFunc
Returns MoveCondition | MoveConditionFunc
the MoveCondition or MoveConditionFunc for this Move
Inherited from MoveEffectAttr.getCondition
- Defined in src/data/move.ts:537

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
Inherited from MoveEffectAttr.getFailedText
- Defined in src/data/move.ts:549

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:567

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:935