Class MessageHeaderAttr

Header attribute to queue a message at the beginning of a turn.

See

Hierarchy (view full)

MoveHeaderAttr
- MessageHeaderAttr

Index

Constructors

Properties

Methods

apply getCondition getFailedText getTargetBenefitScore getUserBenefitScore

Constructors

constructor

new MessageHeaderAttr(message): MessageHeaderAttr
Parameters
- message: string | ((user: default, move: default) => string)
Returns MessageHeaderAttr
Overrides MoveHeaderAttr.constructor
- Defined in src/data/move.ts:1025

Properties

selfTarget

selfTarget: boolean

Should this Move target the user?

Methods

apply

apply(user, target, move, args): boolean
Applies move attributes
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 application of the ability succeeds

See
applyMoveAttrsInternal
Overrides MoveHeaderAttr.apply
- Defined in src/data/move.ts:1030

getCondition

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

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

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 MoveHeaderAttr.getTargetBenefitScore
- Defined in src/data/move.ts:930

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 MoveHeaderAttr.getUserBenefitScore
- Defined in src/data/move.ts:921