Class HealAttr

Heals the user or target by healRatio depending on the value of selfTarget

See

Hierarchy (view full)

MoveEffectAttr
- HealAttr

Index

Constructors

Properties

firstHitOnly healRatio selfTarget showAnim trigger

Methods

addHealPhase apply canApply getCondition getFailedText getMoveChance getTargetBenefitScore getUserBenefitScore

Constructors

constructor

new HealAttr(healRatio?, showAnim?, selfTarget?): HealAttr
Parameters
- Optional healRatio: number
- Optional showAnim: boolean
- Optional selfTarget: boolean
Returns HealAttr
Overrides MoveEffectAttr.constructor
- Defined in src/data/move.ts:1243

Properties

firstHitOnly

firstHitOnly: boolean

Should this effect only apply on the first hit?

`Private` healRatio

healRatio: number

The percentage of Stat.HP to heal

selfTarget

selfTarget: boolean

Should this Move target the user?

`Private` showAnim

showAnim: boolean

Should an animation be shown?

trigger

trigger: MoveEffectTrigger

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

See

phases.MoveEffectPhase.start

Methods

addHealPhase

addHealPhase(target, healRatio): void
Creates a new PokemonHealPhase. This heals the target and shows the appropriate message.
Parameters
- target: default
- healRatio: number
Returns void
- Defined in src/data/move.ts:1259

apply

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

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

getCondition

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

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

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

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
Overrides MoveEffectAttr.getTargetBenefitScore
- Defined in src/data/move.ts:1264

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