Class StatChangeAttr

Base class defining all Move Effect Attributes

See

Hierarchy (view full)

MoveEffectAttr
- StatChangeAttr

Index

Constructors

Properties

firstHitOnly firstTargetOnly lastHitOnly levels selfTarget stats trigger

Methods

apply canApply getCondition getFailedText getLevels getMoveChance getTargetBenefitScore getUserBenefitScore

Constructors

constructor

new StatChangeAttr(stats, levels, selfTarget?, condition?, showMessage?, firstHitOnly?, moveEffectTrigger?, firstTargetOnly?): StatChangeAttr
Parameters
- stats: BattleStat | BattleStat[]
- levels: number
- OptionalselfTarget: boolean
  Should this Move target the user?
- Optionalcondition: MoveConditionFunc
- showMessage: boolean = true
- firstHitOnly: boolean = false
  Should this effect only apply on the first hit?
- moveEffectTrigger: MoveEffectTrigger = MoveEffectTrigger.HIT
- firstTargetOnly: boolean = false
  Should this effect only apply on the first target hit?
Returns StatChangeAttr
Overrides MoveEffectAttr.constructor
- Defined in src/data/move.ts:2454

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?

levels

levels: number

selfTarget

selfTarget: boolean

Should this Move target the user?

stats

stats: BattleStat[]

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 | Promise<boolean>
Applies move effects so long as they are able based on canApply
Parameters
- user: default
- target: default
- move: default
- args: any[]
Returns boolean | Promise<boolean>
Overrides MoveEffectAttr.apply
- Defined in src/data/move.ts:2464

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

getCondition

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

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

getLevels

getLevels(_user): number
Parameters
- _user: default
Returns number
- Defined in src/data/move.ts:2479

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

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

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