Class AddSubstituteAttr

Attribute to put in a Substitute Doll for the user.

Hierarchy (View Summary)

MoveEffectAttr
- AddSubstituteAttr

Index

Constructors

constructor

new AddSubstituteAttr(hpCost: number, roundUp: boolean): AddSubstituteAttr
Parameters
- hpCost: number
- roundUp: boolean
Returns AddSubstituteAttr
Overrides MoveEffectAttr.constructor
- Defined in src/data/moves/move.ts:1814

Properties

`Protected` `Optional`options

options?: MoveEffectAttrOptions

A container for this attribute's optional parameters

See

MoveEffectAttrOptions for supported params.

selfTarget

selfTarget: boolean

Should this Move target the user?

Accessors

effectChanceOverride

get effectChanceOverride(): undefined | number
If defined, overrides the move's base chance for this secondary effect to trigger.

Returns undefined | number
Inherited from MoveEffectAttr.effectChanceOverride
- Defined in src/data/moves/move.ts:1233

firstHitOnly

get firstHitOnly(): boolean
true if this effect should only trigger on the first hit of multi-hit moves.

Returns boolean
Default
```
false
```
Inherited from MoveEffectAttr.firstHitOnly
- Defined in src/data/moves/move.ts:1207

firstTargetOnly

get firstTargetOnly(): boolean
true if this effect should apply only upon hitting a target for the first time when targeting multiple Pokemon.

Returns boolean
Default
```
false
```
Inherited from MoveEffectAttr.firstTargetOnly
- Defined in src/data/moves/move.ts:1225

lastHitOnly

get lastHitOnly(): boolean
true if this effect should only trigger on the last hit of multi-hit moves.

Returns boolean
Default
```
false
```
Inherited from MoveEffectAttr.lastHitOnly
- Defined in src/data/moves/move.ts:1216

trigger

get trigger(): MoveEffectTrigger
Defines when this effect should trigger in the move's effect order.

Returns MoveEffectTrigger
Default
```
MoveEffectTrigger.POST_APPLY
```
See
MoveEffectTrigger
Inherited from MoveEffectAttr.trigger
- Defined in src/data/moves/move.ts:1198

Methods

apply

apply(user: default, target: default, move: default, args: any[]): boolean
Removes 1/4 of the user's maximum HP (rounded down) to create a substitute for the user
Parameters
- user: default
  The Pokemon that used the move.
- target: default
  n/a
- move: default
  The Move with this attribute.
- args: any[]
  n/a
Returns boolean
true if the attribute successfully applies, false otherwise
Overrides MoveEffectAttr.apply
- Defined in src/data/moves/move.ts:1829

canApply

canApply(user: default, target: default, move: default, args?: any[]): 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
- Optionalargs: 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/moves/move.ts:1246

getCondition

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

getFailedText

getFailedText(
    user: default,
    _target: default,
    _move: default,
): undefined | string
Get the substitute-specific failure message if one should be displayed.
Parameters
- user: default
  The pokemon using the move.
- _target: default
- _move: default
Returns undefined | string
The substitute-specific failure message if the conditions apply, otherwise undefined
Overrides MoveEffectAttr.getFailedText
- Defined in src/data/moves/move.ts:1856

getMoveChance

getMoveChance(
    user: default,
    target: default,
    move: default,
    selfEffect?: Boolean,
    showAbility?: Boolean,
): number
Gets the used move's additional effect chance. Chance is modified by MoveEffectChanceMultiplierAbAttr and IgnoreMoveEffectsAbAttr.
Parameters
- user: default
  Pokemon using this move
- target: default
  Target of this move
- move: default
  Move being used
- OptionalselfEffect: Boolean
  true if move targets user.
- OptionalshowAbility: Boolean
Returns number
Move effect chance value.
Inherited from MoveEffectAttr.getMoveChance
- Defined in src/data/moves/move.ts:1266

getTargetBenefitScore

getTargetBenefitScore(user: default, target: default, move: default): 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/moves/move.ts:1156

getUserBenefitScore

getUserBenefitScore(user: default, target: default, move: default): 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
Overrides MoveEffectAttr.getUserBenefitScore
- Defined in src/data/moves/move.ts:1840

Class AddSubstituteAttr

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AddSubstituteAttr

Properties

Protected Optionaloptions

See

selfTarget

Accessors

effectChanceOverride

Returns undefined | number

firstHitOnly

Returns boolean

Default

firstTargetOnly

Returns boolean

Default

lastHitOnly

Returns boolean

Default

trigger

Returns MoveEffectTrigger

Default

See

Methods

apply

Parameters

Returns boolean

canApply

Parameters

Returns boolean

getCondition

Returns MoveConditionFunc

getFailedText

Parameters

Returns undefined | string

getMoveChance

Parameters

Returns number

getTargetBenefitScore

Parameters

Returns number

See

getUserBenefitScore

Parameters

Returns number

See

Settings

On This Page

`Protected` `Optional`options