Class RemoveArenaTagsAttr

Generic class for removing arena tags

Param: tagTypes:

The types of tags that can be removed

Param: selfSideTarget:

Is the user removing tags from its own side?

Hierarchy (view full)

MoveEffectAttr
- RemoveArenaTagsAttr

Index

Constructors

Properties

firstHitOnly selfSideTarget selfTarget tagTypes trigger

Methods

apply canApply getCondition getFailedText getTargetBenefitScore getUserBenefitScore

Constructors

constructor

new RemoveArenaTagsAttr(tagTypes, selfSideTarget): RemoveArenaTagsAttr
Parameters
- tagTypes: ArenaTagType[]
- selfSideTarget: boolean
Returns RemoveArenaTagsAttr
Overrides MoveEffectAttr.constructor
- Defined in src/data/move.ts:4133

Properties

firstHitOnly

firstHitOnly: boolean

Should this effect only apply on the first hit?

selfSideTarget

selfSideTarget: boolean

selfTarget

selfTarget: boolean

Should this Move target the user?

tagTypes

tagTypes: ArenaTagType[]

trigger

trigger: MoveEffectTrigger

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

See

MoveEffectPhase.start

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

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

getCondition

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

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

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

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