Class MoveRestrictionBattlerTag`Abstract`

Base class for tags that restrict the usage of moves. This effect is generally referred to as "disabling" a move in-game (not to be confused with MoveId.DISABLE).

Descendants can override isMoveRestricted to restrict moves that match a condition. A restricted move gets cancelled before it is used. Players and enemies should not be allowed to select restricted moves.

Todo

Require descendant subclasses to inherit a PRE_MOVE lapse type

Hierarchy (View Summary)

SerializableBattlerTag
- MoveRestrictionBattlerTag

Index

Constructors

constructor

new MoveRestrictionBattlerTag(
    tagType: BattlerTagType,
    lapseType:
        | BattlerTagLapseType
        | [NonCustomBattlerTagLapseType, ...NonCustomBattlerTagLapseType[]],
    turnCount: number,
    sourceMove?: MoveId,
    sourceId?: number,
    isBatonPassable?: boolean,
): MoveRestrictionBattlerTag
Parameters
- tagType: BattlerTagType
- lapseType:
  | BattlerTagLapseType
  | [NonCustomBattlerTagLapseType, ...NonCustomBattlerTagLapseType[]]
- turnCount: number
- OptionalsourceMove: MoveId
- OptionalsourceId: number
- isBatonPassable: boolean = false
Returns MoveRestrictionBattlerTag
Inherited from SerializableBattlerTag.constructor
- Defined in src/data/battler-tags.ts:171

Properties

`Optional`sourceId

sourceId?: number

The PID of the Pokemon that added this tag, or undefined if not set by a Pokemon.

`Optional`sourceMove

sourceMove?: MoveId

The MoveId that created this tag, or undefined if not set by a move.

`Readonly`tagType

tagType: MoveRestrictionBattlerTagType

turnCount

turnCount: number

The tag's remaining duration.

Accessors

lapseTypes

get lapseTypes(): readonly BattlerTagLapseType[]
The set of lapse types that this tag can be automatically lapsed with. If this is exclusively BattlerTagLapseType.CUSTOM, then the tag can only ever be lapsed manually via Pokemon.lapseTag (or calling the tag's lapse method directly)

Returns readonly BattlerTagLapseType[]
Inherited from SerializableBattlerTag.lapseTypes
- Defined in src/data/battler-tags.ts:165

Methods

canAdd

canAdd(pokemon: Pokemon): boolean
Parameters
- pokemon: Pokemon
Returns boolean
Inherited from SerializableBattlerTag.canAdd
- Defined in src/data/battler-tags.ts:194

getDescriptor

getDescriptor(): string
Returns string
Inherited from SerializableBattlerTag.getDescriptor
- Defined in src/data/battler-tags.ts:224

getMoveName

getMoveName(): string | null
Returns string | null
Inherited from SerializableBattlerTag.getMoveName
- Defined in src/data/battler-tags.ts:233

getSourcePokemon

getSourcePokemon(): Pokemon | undefined
Helper function that retrieves the source Pokemon object

Returns Pokemon | undefined
The source Pokemon, or undefined if none is found
Inherited from SerializableBattlerTag.getSourcePokemon
- Defined in src/data/battler-tags.ts:257

interruptedText

interruptedText(_pokemon: Pokemon, _move: MoveId): string
Gets the text to display when a move's execution is prevented as a result of the restriction. Because restriction effects also prevent selection of the move, this situation can only arise if a pokemon first selects a move, then gets outsped by a pokemon using a move that restricts the selected move.
Parameters
- _pokemon: Pokemon
  The pokemon attempting to use the restricted move
- _move: MoveId
  The ID of the move being interrupted
Returns string
The text to display when the move is interrupted
- Defined in src/data/battler-tags.ts:355

isBatonPassable

isBatonPassable(recipient: Pokemon): boolean
Check whether this Tag can be transferred to another Pokemon via Baton Pass.
Parameters
- recipient: Pokemon
  The Pokemon receiving this Tag (i.e. the one switching in) Unused by default but exposed to allow for subclasses to perform custom logic.
Returns boolean
Whether this Tag can be transferred via Baton Pass. Defaults to returning the value set in the class constructor.
Inherited from SerializableBattlerTag.isBatonPassable
- Defined in src/data/battler-tags.ts:155

`Abstract`isMoveRestricted

isMoveRestricted(move: MoveId, user?: Pokemon): boolean
Determine whether a move's usage is restricted by this tag
Parameters
- move: MoveId
  The MoveId being checked
- Optionaluser: Pokemon
  The Pokemon involved
Returns boolean
true if the move is restricted by this tag, otherwise false.
- Defined in src/data/battler-tags.ts:322

isMoveTargetRestricted

isMoveTargetRestricted(_move: MoveId, _user: Pokemon, _target: Pokemon): boolean
Check if this tag is restricting a move based on a user's decisions during the target selection phase
Parameters
- _move: MoveId
  MoveId to check restriction for
- _user: Pokemon
  The user of the move
- _target: Pokemon
  The pokemon targeted by the move
Returns boolean
Whether the move is restricted by this tag
- Defined in src/data/battler-tags.ts:332

isSourceLinked

isSourceLinked(): boolean
Returns boolean
Inherited from SerializableBattlerTag.isSourceLinked
- Defined in src/data/battler-tags.ts:229

lapse

lapse(pokemon: Pokemon, lapseType: BattlerTagLapseType): boolean
Apply the battler tag's effects based on the lapse type
Parameters
- pokemon: Pokemon
  The Pokemon whom this tag belongs to. Unused by default but can be used by subclasses.
- lapseType: BattlerTagLapseType
  The BattlerTagLapseType being lapsed. Unused by default but can be used by subclasses.
Returns boolean
true if the tag should be kept (turnCount > 0 by default)

Remarks
Generally, this involves ticking down the tag's duration. The tag also initiates the effects it is responsbile for
Overrides SerializableBattlerTag.lapse
- Defined in src/data/battler-tags.ts:296

loadTag

loadTag<const T extends MoveRestrictionBattlerTag>(
source: BaseBattlerTag & Pick<T, "tagType">,
): void
Load the data for a given BattlerTag or JSON representation thereof. Should be inherited from by any battler tag with custom attributes.
Type Parameters
- const T extends MoveRestrictionBattlerTag
Parameters
- source: BaseBattlerTag & Pick<T, "tagType">
  An object containing the fields needed to reconstruct this tag
Returns void
Inherited from SerializableBattlerTag.loadTag
- Defined in src/data/battler-tags.ts:242

onAdd

onAdd(_pokemon: Pokemon): void
Apply effects that occur when the tag is added to a Pokemon
Parameters
- _pokemon: Pokemon
  The Pokemon the tag was added to
Returns void
Inherited from SerializableBattlerTag.onAdd
- Defined in src/data/battler-tags.ts:202

onOverlap

onOverlap(_pokemon: Pokemon): void
Parameters
- _pokemon: Pokemon
Returns void
Inherited from SerializableBattlerTag.onOverlap
- Defined in src/data/battler-tags.ts:206

onRemove

onRemove(_pokemon: Pokemon): void
Parameters
- _pokemon: Pokemon
Returns void
Inherited from SerializableBattlerTag.onRemove
- Defined in src/data/battler-tags.ts:204

`Abstract`selectionDeniedText

selectionDeniedText(pokemon: Pokemon, move: MoveId): string
Get the text to display when the player attempts to select a move that is restricted by this tag.
Parameters
- pokemon: Pokemon
  The pokemon for which the player is attempting to select the restricted move
- move: MoveId
  The ID of the Move that is having its selection denied
Returns string
The text to display when the player attempts to select the restricted move
- Defined in src/data/battler-tags.ts:344

Class MoveRestrictionBattlerTagAbstract

Todo

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MoveRestrictionBattlerTag

Properties

OptionalsourceId

OptionalsourceMove

ReadonlytagType

turnCount

Accessors

lapseTypes

Returns readonly BattlerTagLapseType[]

Methods

canAdd

Parameters

Returns boolean

getDescriptor

Returns string

getMoveName

Returns string | null

getSourcePokemon

Returns Pokemon | undefined

interruptedText

Parameters

Returns string

isBatonPassable

Parameters

Returns boolean

AbstractisMoveRestricted

Parameters

Returns boolean

isMoveTargetRestricted

Parameters

Returns boolean

isSourceLinked

Returns boolean

lapse

Parameters

Returns boolean

Remarks

loadTag

Type Parameters

Parameters

Returns void

onAdd

Parameters

Returns void

onOverlap

Parameters

Returns void

onRemove

Parameters

Returns void

AbstractselectionDeniedText

Parameters

Returns string

Settings

On This Page

Class MoveRestrictionBattlerTag`Abstract`

`Optional`sourceId

`Optional`sourceMove

`Readonly`tagType

`Abstract`isMoveRestricted

`Abstract`selectionDeniedText