Class AddArenaTagAttr

Base class defining all Move Effect Attributes

See

Hierarchy (view full)

MoveEffectAttr
- AddArenaTagAttr
  - AddArenaTrapTagAttr

Index

Constructors

Properties

failOnOverlap firstHitOnly selfSideTarget selfTarget tagType trigger turnCount

Methods

apply canApply getCondition getFailedText getTargetBenefitScore getUserBenefitScore

Constructors

constructor

new AddArenaTagAttr(tagType, turnCount?, failOnOverlap?, selfSideTarget?): AddArenaTagAttr
Parameters
- tagType: ArenaTagType
- Optional turnCount: number
- failOnOverlap: boolean = false
- selfSideTarget: boolean = false
Returns AddArenaTagAttr
Overrides MoveEffectAttr.constructor
- Defined in src/data/move.ts:4156

Properties

`Private` failOnOverlap

failOnOverlap: boolean

firstHitOnly

firstHitOnly: boolean

Should this effect only apply on the first hit?

selfSideTarget

selfSideTarget: boolean

selfTarget

selfTarget: boolean

Should this Move target the user?

tagType

tagType: ArenaTagType

trigger

trigger: MoveEffectTrigger

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

See

MoveEffectPhase.start

turnCount

turnCount: number

Methods

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

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

getCondition

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

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

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

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