Class DisabledTag`Sealed`

Tag representing the "disabling" effect performed by MoveId.DISABLE and AbilityId.CURSED_BODY. When the tag is added, the last-used move of the tag holder is set as the disabled move.

Hierarchy (View Summary)

MoveRestrictionBattlerTag
- DisabledTag

Index

Constructors

constructor

new DisabledTag(sourceId: number): DisabledTag
Parameters
- sourceId: number
Returns DisabledTag
Overrides MoveRestrictionBattlerTag.constructor
- Defined in src/data/battler-tags.ts:416

Properties

`Readonly`moveId

moveId: MoveId = MoveId.NONE

The move being disabled. Gets set when onAdd is called for this tag.

`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: DISABLED = BattlerTagType.DISABLED

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 MoveRestrictionBattlerTag.lapseTypes
- Defined in src/data/battler-tags.ts:165

Methods

canAdd

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

getDescriptor

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

getMoveName

getMoveName(): string | null
Returns string | null
Inherited from MoveRestrictionBattlerTag.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 MoveRestrictionBattlerTag.getSourcePokemon
- Defined in src/data/battler-tags.ts:257

interruptedText

interruptedText(pokemon: Pokemon, move: MoveId): string
Parameters
- pokemon: Pokemon
  Pokemon attempting to use the restricted move
- move: MoveId
  ID of the move being interrupted
Returns string
The text to display when the move is interrupted
Overrides MoveRestrictionBattlerTag.interruptedText
- Defined in src/data/battler-tags.ts:467

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 MoveRestrictionBattlerTag.isBatonPassable
- Defined in src/data/battler-tags.ts:155

isMoveRestricted

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

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
Inherited from MoveRestrictionBattlerTag.isMoveTargetRestricted
- Defined in src/data/battler-tags.ts:332

isSourceLinked

isSourceLinked(): boolean
Returns boolean
Inherited from MoveRestrictionBattlerTag.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
Inherited from MoveRestrictionBattlerTag.lapse
- Defined in src/data/battler-tags.ts:296

loadTag

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

onAdd

onAdd(pokemon: Pokemon): void
Attempt to disable the target's last move by setting this tag's moveId and showing a message.
Parameters
- pokemon: Pokemon
Returns void
Overrides MoveRestrictionBattlerTag.onAdd
- Defined in src/data/battler-tags.ts:428

onOverlap

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

onRemove

onRemove(pokemon: Pokemon): void
Parameters
- pokemon: Pokemon
Returns void
Overrides MoveRestrictionBattlerTag.onRemove
- Defined in src/data/battler-tags.ts:447

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
- 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
Overrides MoveRestrictionBattlerTag.selectionDeniedText
- Defined in src/data/battler-tags.ts:458

Class DisabledTagSealed

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DisabledTag

Properties

ReadonlymoveId

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

isMoveRestricted

Parameters

Returns boolean

isMoveTargetRestricted

Parameters

Returns boolean

isSourceLinked

Returns boolean

lapse

Parameters

Returns boolean

Remarks

loadTag

Parameters

Returns void

onAdd

Parameters

Returns void

onOverlap

Parameters

Returns void

onRemove

Parameters

Returns void

selectionDeniedText

Parameters

Returns string

Settings

On This Page

Class DisabledTag`Sealed`

`Readonly`moveId

`Optional`sourceId

`Optional`sourceMove

`Readonly`tagType