Class HitHealAttr

Heals user as a side effect of a move that hits a target. Healing is based on healRatio * the amount of damage dealt or a stat of the target.

See

Hierarchy (view full)

MoveEffectAttr
- HitHealAttr

Index

Constructors

constructor

new HitHealAttr(healRatio?, healStat?): HitHealAttr
Parameters
- Optional healRatio: number
- Optional healStat: Stat
Returns HitHealAttr
Overrides MoveEffectAttr.constructor
- Defined in src/data/move.ts:1492

Properties

firstHitOnly

firstHitOnly: boolean

Should this effect only apply on the first hit?

firstTargetOnly

firstTargetOnly: boolean

Should this effect only apply on the first target hit?

`Private` healRatio

healRatio: number

`Private` healStat

healStat: Stat

lastHitOnly

lastHitOnly: boolean

Should this effect only apply on the last hit?

`Private` message

message: string

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

Methods

apply

apply(user, target, move, args): boolean
Heals the user the determined amount and possibly displays a message about regaining health. If the target has the ReverseDrainAbAttr, all healing is instead converted to damage to the user.
Parameters
- user: default
  Pokemon using this move
- target: default
  Pokemon target of this move
- move: default
  Move being used
- args: any[]
  N/A
Returns boolean
true if the function succeeds
Overrides MoveEffectAttr.apply
- Defined in src/data/move.ts:1508

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

getCondition

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

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

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

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

getUserBenefitScore

getUserBenefitScore(user, target, move): number
Used by the Enemy AI to rank an attack based on a given user
Parameters
- user: default
  Pokemon using this move
- target: default
  Pokemon target of this move
- move: default
  Move being used
Returns number
an integer. Higher means enemy is more likely to use that move.
Overrides MoveEffectAttr.getUserBenefitScore
- Defined in src/data/move.ts:1537

Class HitHealAttr

See

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HitHealAttr

Properties

firstHitOnly

firstTargetOnly

Private healRatio

Private healStat

lastHitOnly

Private message

selfTarget

trigger

See

Methods

apply

Parameters

Returns boolean

canApply

Parameters

Returns boolean

getCondition

Returns MoveCondition | MoveConditionFunc

getFailedText

Parameters

Returns string

getMoveChance

Parameters

Returns number

getTargetBenefitScore

Parameters

Returns number

See

getUserBenefitScore

Parameters

Returns number

Settings

Member Visibility

Theme

On This Page

`Private` healRatio

`Private` healStat

`Private` message