Class AddSubstituteAttr

Attribute to put in a Substitute Doll for the user.

See

apply

Hierarchy (view full)

MoveEffectAttr
- AddSubstituteAttr

Index

Constructors

constructor

new AddSubstituteAttr(hpCost?): AddSubstituteAttr
Parameters
- hpCost: number = 0.25
Returns AddSubstituteAttr
Overrides MoveEffectAttr.constructor
- Defined in src/data/move.ts:1483

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?

lastHitOnly

lastHitOnly: boolean

Should this effect only apply on the last 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

Methods

apply

apply(user, target, move, args): boolean
Removes 1/4 of the user's maximum HP (rounded down) to create a substitute for the user
Parameters
- user: default
  the Pokemon that used the move.
- target: default
  n/a
- move: default
  the Move with this attribute.
- args: any[]
  n/a
Returns boolean
true if the attribute successfully applies, false otherwise
Overrides MoveEffectAttr.apply
- Defined in src/data/move.ts:1497

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
- Optionalargs: 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:1008

getCondition

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

getFailedText

getFailedText(user, target, move, cancelled): null | 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 null | string
the string representing failure of this Move
Overrides MoveEffectAttr.getFailedText
- Defined in src/data/move.ts:1518

getMoveChance

getMoveChance(user, target, move, selfEffect?, showAbility?): 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
- OptionalselfEffect: Boolean
  Boolean if move targets user.
- OptionalshowAbility: Boolean
Returns number
Move chance value.
Inherited from MoveEffectAttr.getMoveChance
- Defined in src/data/move.ts:1028

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

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

Class AddSubstituteAttr

See

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AddSubstituteAttr

Properties

firstHitOnly

firstTargetOnly

lastHitOnly

selfTarget

trigger

See

Methods

apply

Parameters

Returns boolean

canApply

Parameters

Returns boolean

getCondition

Returns MoveConditionFunc

getFailedText

Parameters

Returns null | string

getMoveChance

Parameters

Returns number

getTargetBenefitScore

Parameters

Returns number

See

getUserBenefitScore

Parameters

Returns number

See

Settings

On This Page