Remove extends tags

This commit is contained in:
Sirz Benjie 2025-09-10 12:12:27 -05:00
parent 4efcd2cc3c
commit d7e4ab3d66
No known key found for this signature in database
GPG Key ID: 4A524B4D196C759E
11 changed files with 26 additions and 228 deletions

View File

@ -3323,7 +3323,7 @@ export class BattleScene extends SceneBase {
/** /**
* This function retrieves the sprite and audio keys for active Pokemon. * This function retrieves the sprite and audio keys for active Pokemon.
* Active Pokemon include both enemy and player Pokemon of the current wave. * Active Pokemon include both enemy and player Pokemon of the current wave.
* Note: Questions on garbage collection go to @frutescens * Note: Questions on garbage collection go to `@frutescens`
* @returns a string array of active sprite and audio keys that should not be deleted * @returns a string array of active sprite and audio keys that should not be deleted
*/ */
getActiveKeys(): string[] { getActiveKeys(): string[] {

View File

@ -842,7 +842,6 @@ export class NonSuperEffectiveImmunityAbAttr extends TypeImmunityAbAttr {
/** /**
* Attribute implementing the effects of {@link https://bulbapedia.bulbagarden.net/wiki/Tera_Shell_(Ability) | Tera Shell} * Attribute implementing the effects of {@link https://bulbapedia.bulbagarden.net/wiki/Tera_Shell_(Ability) | Tera Shell}
* When the source is at full HP, incoming attacks will have a maximum 0.5x type effectiveness multiplier. * When the source is at full HP, incoming attacks will have a maximum 0.5x type effectiveness multiplier.
* @extends PreDefendAbAttr
*/ */
export class FullHpResistTypeAbAttr extends PreDefendAbAttr { export class FullHpResistTypeAbAttr extends PreDefendAbAttr {
/** /**
@ -1351,11 +1350,9 @@ export class PostDefendContactDamageAbAttr extends PostDefendAbAttr {
} }
} }
/** /**
* @description: This ability applies the Perish Song tag to the attacking pokemon * This ability applies the Perish Song tag to the attacking pokemon
* and the defending pokemon if the move makes physical contact and neither pokemon * and the defending pokemon if the move makes physical contact and neither pokemon
* already has the Perish Song tag. * already has the Perish Song tag.
* @class PostDefendPerishSongAbAttr
* @extends {PostDefendAbAttr}
*/ */
export class PostDefendPerishSongAbAttr extends PostDefendAbAttr { export class PostDefendPerishSongAbAttr extends PostDefendAbAttr {
private turns: number; private turns: number;
@ -1961,19 +1958,16 @@ export class PreAttackFieldMoveTypePowerBoostAbAttr extends FieldMovePowerBoostA
/** /**
* Boosts the power of a specific type of move for all Pokemon in the field. * Boosts the power of a specific type of move for all Pokemon in the field.
* @extends PreAttackFieldMoveTypePowerBoostAbAttr
*/ */
export class FieldMoveTypePowerBoostAbAttr extends PreAttackFieldMoveTypePowerBoostAbAttr {} export class FieldMoveTypePowerBoostAbAttr extends PreAttackFieldMoveTypePowerBoostAbAttr {}
/** /**
* Boosts the power of a specific type of move for the user and its allies. * Boosts the power of a specific type of move for the user and its allies.
* @extends PreAttackFieldMoveTypePowerBoostAbAttr
*/ */
export class UserFieldMoveTypePowerBoostAbAttr extends PreAttackFieldMoveTypePowerBoostAbAttr {} export class UserFieldMoveTypePowerBoostAbAttr extends PreAttackFieldMoveTypePowerBoostAbAttr {}
/** /**
* Boosts the power of moves in specified categories. * Boosts the power of moves in specified categories.
* @extends FieldMovePowerBoostAbAttr
*/ */
export class AllyMoveCategoryPowerBoostAbAttr extends FieldMovePowerBoostAbAttr { export class AllyMoveCategoryPowerBoostAbAttr extends FieldMovePowerBoostAbAttr {
/** /**
@ -3180,7 +3174,6 @@ export class PostSummonTransformAbAttr extends PostSummonAbAttr {
/** /**
* Reverts weather-based forms to their normal forms when the user is summoned. * Reverts weather-based forms to their normal forms when the user is summoned.
* Used by Cloud Nine and Air Lock. * Used by Cloud Nine and Air Lock.
* @extends PostSummonAbAttr
*/ */
export class PostSummonWeatherSuppressedFormChangeAbAttr extends PostSummonAbAttr { export class PostSummonWeatherSuppressedFormChangeAbAttr extends PostSummonAbAttr {
override canApply(_params: AbAttrBaseParams): boolean { override canApply(_params: AbAttrBaseParams): boolean {
@ -3200,7 +3193,6 @@ export class PostSummonWeatherSuppressedFormChangeAbAttr extends PostSummonAbAtt
/** /**
* Triggers weather-based form change when summoned into an active weather. * Triggers weather-based form change when summoned into an active weather.
* Used by Forecast and Flower Gift. * Used by Forecast and Flower Gift.
* @extends PostSummonAbAttr
*/ */
export class PostSummonFormChangeByWeatherAbAttr extends PostSummonAbAttr { export class PostSummonFormChangeByWeatherAbAttr extends PostSummonAbAttr {
private ability: AbilityId; private ability: AbilityId;
@ -4996,7 +4988,6 @@ export class PostMoveUsedAbAttr extends AbAttr {
/** /**
* Triggers after a dance move is used either by the opponent or the player * Triggers after a dance move is used either by the opponent or the player
* @extends PostMoveUsedAbAttr
*/ */
export class PostDancingMoveAbAttr extends PostMoveUsedAbAttr { export class PostDancingMoveAbAttr extends PostMoveUsedAbAttr {
override canApply({ source, pokemon }: PostMoveUsedAbAttrParams): boolean { override canApply({ source, pokemon }: PostMoveUsedAbAttrParams): boolean {
@ -5055,7 +5046,6 @@ export class PostDancingMoveAbAttr extends PostMoveUsedAbAttr {
/** /**
* Triggers after the Pokemon loses or consumes an item * Triggers after the Pokemon loses or consumes an item
* @extends AbAttr
*/ */
export class PostItemLostAbAttr extends AbAttr { export class PostItemLostAbAttr extends AbAttr {
canApply(_params: Closed<AbAttrBaseParams>): boolean { canApply(_params: Closed<AbAttrBaseParams>): boolean {
@ -5226,7 +5216,6 @@ type ArenaTrapCondition = (user: Pokemon, target: Pokemon) => boolean;
/** /**
* Base class for checking if a Pokemon is trapped by arena trap * Base class for checking if a Pokemon is trapped by arena trap
* @extends AbAttr
* @field {@linkcode arenaTrapCondition} Conditional for trapping abilities. * @field {@linkcode arenaTrapCondition} Conditional for trapping abilities.
* For example, Magnet Pull will only activate if opponent is Steel type. * For example, Magnet Pull will only activate if opponent is Steel type.
* @see {@linkcode applyCheckTrapped} * @see {@linkcode applyCheckTrapped}
@ -5849,8 +5838,6 @@ export class IgnoreTypeStatusEffectImmunityAbAttr extends AbAttr {
/** /**
* Gives money to the user after the battle. * Gives money to the user after the battle.
*
* @extends PostBattleAbAttr
*/ */
export class MoneyAbAttr extends PostBattleAbAttr { export class MoneyAbAttr extends PostBattleAbAttr {
override canApply({ simulated, victory }: PostBattleAbAttrParams): boolean { override canApply({ simulated, victory }: PostBattleAbAttrParams): boolean {

View File

@ -1458,7 +1458,6 @@ export class PreMoveMessageAttr extends MoveAttr {
* Attribute for moves that can be conditionally interrupted to be considered to * Attribute for moves that can be conditionally interrupted to be considered to
* have failed before their "useMove" message is displayed. Currently used by * have failed before their "useMove" message is displayed. Currently used by
* Focus Punch. * Focus Punch.
* @extends MoveAttr
*/ */
export class PreUseInterruptAttr extends MoveAttr { export class PreUseInterruptAttr extends MoveAttr {
protected message: string | MoveMessageFunc; protected message: string | MoveMessageFunc;
@ -1502,7 +1501,6 @@ export class PreUseInterruptAttr extends MoveAttr {
/** /**
* Attribute for Status moves that take attack type effectiveness * Attribute for Status moves that take attack type effectiveness
* into consideration (i.e. {@linkcode https://bulbapedia.bulbagarden.net/wiki/Thunder_Wave_(move) | Thunder Wave}) * into consideration (i.e. {@linkcode https://bulbapedia.bulbagarden.net/wiki/Thunder_Wave_(move) | Thunder Wave})
* @extends MoveAttr
*/ */
export class RespectAttackTypeImmunityAttr extends MoveAttr { } export class RespectAttackTypeImmunityAttr extends MoveAttr { }
@ -1786,9 +1784,7 @@ export class RecoilAttr extends MoveEffectAttr {
/** /**
* Attribute used for moves which self KO the user regardless if the move hits a target * Attribute used for moves which self KO the user regardless if the move hits a target
* @extends MoveEffectAttr */
* @see {@linkcode apply}
**/
export class SacrificialAttr extends MoveEffectAttr { export class SacrificialAttr extends MoveEffectAttr {
constructor() { constructor() {
super(true, { trigger: MoveEffectTrigger.POST_TARGET }); super(true, { trigger: MoveEffectTrigger.POST_TARGET });
@ -1819,9 +1815,7 @@ export class SacrificialAttr extends MoveEffectAttr {
/** /**
* Attribute used for moves which self KO the user but only if the move hits a target * Attribute used for moves which self KO the user but only if the move hits a target
* @extends MoveEffectAttr */
* @see {@linkcode apply}
**/
export class SacrificialAttrOnHit extends MoveEffectAttr { export class SacrificialAttrOnHit extends MoveEffectAttr {
constructor() { constructor() {
super(true); super(true);
@ -1858,8 +1852,6 @@ export class SacrificialAttrOnHit extends MoveEffectAttr {
/** /**
* Attribute used for moves which cut the user's Max HP in half. * Attribute used for moves which cut the user's Max HP in half.
* Triggers using {@linkcode MoveEffectTrigger.POST_TARGET}. * Triggers using {@linkcode MoveEffectTrigger.POST_TARGET}.
* @extends MoveEffectAttr
* @see {@linkcode apply}
*/ */
export class HalfSacrificialAttr extends MoveEffectAttr { export class HalfSacrificialAttr extends MoveEffectAttr {
constructor() { constructor() {
@ -1959,8 +1951,6 @@ export class AddSubstituteAttr extends MoveEffectAttr {
/** /**
* Heals the user or target by {@linkcode healRatio} depending on the value of {@linkcode selfTarget} * Heals the user or target by {@linkcode healRatio} depending on the value of {@linkcode selfTarget}
* @extends MoveEffectAttr
* @see {@linkcode apply}
*/ */
export class HealAttr extends MoveEffectAttr { export class HealAttr extends MoveEffectAttr {
constructor( constructor(
@ -2049,8 +2039,6 @@ export class RestAttr extends HealAttr {
/** /**
* Cures the user's party of non-volatile status conditions, ie. Heal Bell, Aromatherapy * Cures the user's party of non-volatile status conditions, ie. Heal Bell, Aromatherapy
* @extends MoveEffectAttr
* @see {@linkcode apply}
*/ */
export class PartyStatusCureAttr extends MoveEffectAttr { export class PartyStatusCureAttr extends MoveEffectAttr {
/** Message to display after using move */ /** Message to display after using move */
@ -2109,7 +2097,6 @@ export class PartyStatusCureAttr extends MoveEffectAttr {
/** /**
* Applies damage to the target's ally equal to 1/16 of that ally's max HP. * Applies damage to the target's ally equal to 1/16 of that ally's max HP.
* @extends MoveEffectAttr
*/ */
export class FlameBurstAttr extends MoveEffectAttr { export class FlameBurstAttr extends MoveEffectAttr {
constructor() { constructor() {
@ -2198,8 +2185,6 @@ export class SacrificialFullRestoreAttr extends SacrificialAttr {
/** /**
* Attribute used for moves which ignore type-based debuffs from weather, namely Hydro Steam. * Attribute used for moves which ignore type-based debuffs from weather, namely Hydro Steam.
* Called during damage calculation after getting said debuff from getAttackTypeMultiplier in the Pokemon class. * Called during damage calculation after getting said debuff from getAttackTypeMultiplier in the Pokemon class.
* @extends MoveAttr
* @see {@linkcode apply}
*/ */
export class IgnoreWeatherTypeDebuffAttr extends MoveAttr { export class IgnoreWeatherTypeDebuffAttr extends MoveAttr {
/** The {@linkcode WeatherType} this move ignores */ /** The {@linkcode WeatherType} this move ignores */
@ -2278,8 +2263,6 @@ export class SandHealAttr extends WeatherHealAttr {
/** /**
* Heals the target or the user by either {@linkcode normalHealRatio} or {@linkcode boostedHealRatio} * Heals the target or the user by either {@linkcode normalHealRatio} or {@linkcode boostedHealRatio}
* depending on the evaluation of {@linkcode condition} * depending on the evaluation of {@linkcode condition}
* @extends HealAttr
* @see {@linkcode apply}
*/ */
export class BoostHealAttr extends HealAttr { export class BoostHealAttr extends HealAttr {
/** Healing received when {@linkcode condition} is false */ /** Healing received when {@linkcode condition} is false */
@ -2312,8 +2295,6 @@ export class BoostHealAttr extends HealAttr {
/** /**
* Heals the target only if it is the ally * Heals the target only if it is the ally
* @extends HealAttr
* @see {@linkcode apply}
*/ */
export class HealOnAllyAttr extends HealAttr { export class HealOnAllyAttr extends HealAttr {
override canApply(user: Pokemon, target: Pokemon, _move: Move, _args?: any[]): boolean { override canApply(user: Pokemon, target: Pokemon, _move: Move, _args?: any[]): boolean {
@ -2332,9 +2313,6 @@ export class HealOnAllyAttr extends HealAttr {
/** /**
* Heals user as a side effect of a move that hits a target. * Heals user as a side effect of a move that hits a target.
* Healing is based on {@linkcode healRatio} * the amount of damage dealt or a stat of the target. * Healing is based on {@linkcode healRatio} * the amount of damage dealt or a stat of the target.
* @extends MoveEffectAttr
* @see {@linkcode apply}
* @see {@linkcode getUserBenefitScore}
*/ */
// TODO: Make Strength Sap its own attribute that extends off of this one // TODO: Make Strength Sap its own attribute that extends off of this one
export class HitHealAttr extends MoveEffectAttr { export class HitHealAttr extends MoveEffectAttr {
@ -2404,8 +2382,6 @@ export class HitHealAttr extends MoveEffectAttr {
* Attribute used for moves that change priority in a turn given a condition, * Attribute used for moves that change priority in a turn given a condition,
* e.g. Grassy Glide * e.g. Grassy Glide
* Called when move order is calculated in {@linkcode TurnStartPhase}. * Called when move order is calculated in {@linkcode TurnStartPhase}.
* @extends MoveAttr
* @see {@linkcode apply}
*/ */
export class IncrementMovePriorityAttr extends MoveAttr { export class IncrementMovePriorityAttr extends MoveAttr {
/** The condition for a move's priority being incremented */ /** The condition for a move's priority being incremented */
@ -2441,10 +2417,8 @@ export class IncrementMovePriorityAttr extends MoveAttr {
/** /**
* Attribute used for attack moves that hit multiple times per use, e.g. Bullet Seed. * Attribute used for attack moves that hit multiple times per use, e.g. Bullet Seed.
* *
* @remarks
* Applied at the beginning of {@linkcode MoveEffectPhase}. * Applied at the beginning of {@linkcode MoveEffectPhase}.
*
* @extends MoveAttr
* @see {@linkcode apply}
*/ */
export class MultiHitAttr extends MoveAttr { export class MultiHitAttr extends MoveAttr {
/** This move's intrinsic multi-hit type. It should never be modified. */ /** This move's intrinsic multi-hit type. It should never be modified. */
@ -2954,8 +2928,6 @@ export class StealEatBerryAttr extends EatBerryAttr {
/** /**
* Move attribute that signals that the move should cure a status effect * Move attribute that signals that the move should cure a status effect
* @extends MoveEffectAttr
* @see {@linkcode apply()}
*/ */
export class HealStatusEffectAttr extends MoveEffectAttr { export class HealStatusEffectAttr extends MoveEffectAttr {
/** List of Status Effects to cure */ /** List of Status Effects to cure */
@ -3038,8 +3010,6 @@ export class BypassSleepAttr extends MoveAttr {
/** /**
* Attribute used for moves that bypass the burn damage reduction of physical moves, currently only facade * Attribute used for moves that bypass the burn damage reduction of physical moves, currently only facade
* Called during damage calculation * Called during damage calculation
* @extends MoveAttr
* @see {@linkcode apply}
*/ */
export class BypassBurnDamageReductionAttr extends MoveAttr { export class BypassBurnDamageReductionAttr extends MoveAttr {
/** Prevents the move's damage from being reduced by burn /** Prevents the move's damage from being reduced by burn
@ -3148,7 +3118,6 @@ export class OneHitKOAttr extends MoveAttr {
/** /**
* Attribute that allows charge moves to resolve in 1 turn under a given condition. * Attribute that allows charge moves to resolve in 1 turn under a given condition.
* Should only be used for {@linkcode ChargingMove | ChargingMoves} as a `chargeAttr`. * Should only be used for {@linkcode ChargingMove | ChargingMoves} as a `chargeAttr`.
* @extends MoveAttr
*/ */
export class InstantChargeAttr extends MoveAttr { export class InstantChargeAttr extends MoveAttr {
/** The condition in which the move with this attribute instantly charges */ /** The condition in which the move with this attribute instantly charges */
@ -3185,7 +3154,6 @@ export class InstantChargeAttr extends MoveAttr {
/** /**
* Attribute that allows charge moves to resolve in 1 turn while specific {@linkcode WeatherType | Weather} * Attribute that allows charge moves to resolve in 1 turn while specific {@linkcode WeatherType | Weather}
* is active. Should only be used for {@linkcode ChargingMove | ChargingMoves} as a `chargeAttr`. * is active. Should only be used for {@linkcode ChargingMove | ChargingMoves} as a `chargeAttr`.
* @extends InstantChargeAttr
*/ */
export class WeatherInstantChargeAttr extends InstantChargeAttr { export class WeatherInstantChargeAttr extends InstantChargeAttr {
constructor(weatherTypes: WeatherType[]) { constructor(weatherTypes: WeatherType[]) {
@ -3315,7 +3283,6 @@ export class WishAttr extends MoveEffectAttr {
/** /**
* Attribute that cancels the associated move's effects when set to be combined with the user's ally's * Attribute that cancels the associated move's effects when set to be combined with the user's ally's
* subsequent move this turn. Used for Grass Pledge, Water Pledge, and Fire Pledge. * subsequent move this turn. Used for Grass Pledge, Water Pledge, and Fire Pledge.
* @extends OverrideMoveEffectAttr
*/ */
export class AwaitCombinedPledgeAttr extends OverrideMoveEffectAttr { export class AwaitCombinedPledgeAttr extends OverrideMoveEffectAttr {
constructor() { constructor() {
@ -3370,7 +3337,6 @@ export class AwaitCombinedPledgeAttr extends OverrideMoveEffectAttr {
/** /**
* Set of optional parameters that may be applied to stat stage changing effects * Set of optional parameters that may be applied to stat stage changing effects
* @extends MoveEffectAttrOptions
* @see {@linkcode StatStageChangeAttr} * @see {@linkcode StatStageChangeAttr}
*/ */
interface StatStageChangeAttrOptions extends MoveEffectAttrOptions { interface StatStageChangeAttrOptions extends MoveEffectAttrOptions {
@ -3387,9 +3353,6 @@ interface StatStageChangeAttrOptions extends MoveEffectAttrOptions {
* @param stages How many stages to change the stat(s) by, [-6, 6] * @param stages How many stages to change the stat(s) by, [-6, 6]
* @param selfTarget `true` if the move is self-targetting * @param selfTarget `true` if the move is self-targetting
* @param options {@linkcode StatStageChangeAttrOptions} Container for any optional parameters for this attribute. * @param options {@linkcode StatStageChangeAttrOptions} Container for any optional parameters for this attribute.
*
* @extends MoveEffectAttr
* @see {@linkcode apply}
*/ */
export class StatStageChangeAttr extends MoveEffectAttr { export class StatStageChangeAttr extends MoveEffectAttr {
public stats: BattleStat[]; public stats: BattleStat[];
@ -3820,8 +3783,6 @@ export class ResetStatsAttr extends MoveEffectAttr {
/** /**
* Attribute used for status moves, specifically Heart, Guard, and Power Swap, * Attribute used for status moves, specifically Heart, Guard, and Power Swap,
* that swaps the user's and target's corresponding stat stages. * that swaps the user's and target's corresponding stat stages.
* @extends MoveEffectAttr
* @see {@linkcode apply}
*/ */
export class SwapStatStagesAttr extends MoveEffectAttr { export class SwapStatStagesAttr extends MoveEffectAttr {
/** The stat stages to be swapped between the user and the target */ /** The stat stages to be swapped between the user and the target */
@ -4109,8 +4070,6 @@ export class WeightPowerAttr extends VariablePowerAttr {
/** /**
* Attribute used for Electro Ball move. * Attribute used for Electro Ball move.
* @extends VariablePowerAttr
* @see {@linkcode apply}
**/ **/
export class ElectroBallPowerAttr extends VariablePowerAttr { export class ElectroBallPowerAttr extends VariablePowerAttr {
/** /**
@ -4144,8 +4103,6 @@ export class ElectroBallPowerAttr extends VariablePowerAttr {
/** /**
* Attribute used for Gyro Ball move. * Attribute used for Gyro Ball move.
* @extends VariablePowerAttr
* @see {@linkcode apply}
**/ **/
export class GyroBallPowerAttr extends VariablePowerAttr { export class GyroBallPowerAttr extends VariablePowerAttr {
/** /**
@ -4544,8 +4501,6 @@ const hasStockpileStacksCondition: MoveConditionFunc = (user) => {
/** /**
* Attribute used for multi-hit moves that increase power in increments of the * Attribute used for multi-hit moves that increase power in increments of the
* move's base power for each hit, namely Triple Kick and Triple Axel. * move's base power for each hit, namely Triple Kick and Triple Axel.
* @extends VariablePowerAttr
* @see {@linkcode apply}
*/ */
export class MultiHitPowerIncrementAttr extends VariablePowerAttr { export class MultiHitPowerIncrementAttr extends VariablePowerAttr {
/** The max number of base power increments allowed for this move */ /** The max number of base power increments allowed for this move */
@ -4582,8 +4537,6 @@ export class MultiHitPowerIncrementAttr extends VariablePowerAttr {
* Attribute used for moves that double in power if the given move immediately * Attribute used for moves that double in power if the given move immediately
* preceded the move applying the attribute, namely Fusion Flare and * preceded the move applying the attribute, namely Fusion Flare and
* Fusion Bolt. * Fusion Bolt.
* @extends VariablePowerAttr
* @see {@linkcode apply}
*/ */
export class LastMoveDoublePowerAttr extends VariablePowerAttr { export class LastMoveDoublePowerAttr extends VariablePowerAttr {
/** The move that must precede the current move */ /** The move that must precede the current move */
@ -4686,7 +4639,6 @@ export class CombinedPledgeStabBoostAttr extends MoveAttr {
/** /**
* Variable Power attribute for {@link https://bulbapedia.bulbagarden.net/wiki/Round_(move) | Round}. * Variable Power attribute for {@link https://bulbapedia.bulbagarden.net/wiki/Round_(move) | Round}.
* Doubles power if another Pokemon has previously selected Round this turn. * Doubles power if another Pokemon has previously selected Round this turn.
* @extends VariablePowerAttr
*/ */
export class RoundPowerAttr extends VariablePowerAttr { export class RoundPowerAttr extends VariablePowerAttr {
override apply(user: Pokemon, target: Pokemon, move: Move, args: [NumberHolder]): boolean { override apply(user: Pokemon, target: Pokemon, move: Move, args: [NumberHolder]): boolean {
@ -4704,8 +4656,6 @@ export class RoundPowerAttr extends VariablePowerAttr {
* Attribute for the "combo" effect of {@link https://bulbapedia.bulbagarden.net/wiki/Round_(move) | Round}. * Attribute for the "combo" effect of {@link https://bulbapedia.bulbagarden.net/wiki/Round_(move) | Round}.
* Preempts the next move in the turn order with the first instance of any Pokemon * Preempts the next move in the turn order with the first instance of any Pokemon
* using Round. Also marks the Pokemon using the cued Round to double the move's power. * using Round. Also marks the Pokemon using the cued Round to double the move's power.
* @extends MoveEffectAttr
* @see {@linkcode RoundPowerAttr}
*/ */
export class CueNextRoundAttr extends MoveEffectAttr { export class CueNextRoundAttr extends MoveEffectAttr {
constructor() { constructor() {
@ -4907,8 +4857,6 @@ export class StormAccuracyAttr extends VariableAccuracyAttr {
/** /**
* Attribute used for moves which never miss * Attribute used for moves which never miss
* against Pokemon with the {@linkcode BattlerTagType.MINIMIZED} * against Pokemon with the {@linkcode BattlerTagType.MINIMIZED}
* @extends VariableAccuracyAttr
* @see {@linkcode apply}
*/ */
export class AlwaysHitMinimizeAttr extends VariableAccuracyAttr { export class AlwaysHitMinimizeAttr extends VariableAccuracyAttr {
/** /**
@ -4981,9 +4929,8 @@ export class PhotonGeyserCategoryAttr extends VariableMoveCategoryAttr {
* Attribute used for tera moves that change category based on the user's Atk and SpAtk stats * Attribute used for tera moves that change category based on the user's Atk and SpAtk stats
* Note: Currently, `getEffectiveStat` does not ignore all abilities that affect stats except those * Note: Currently, `getEffectiveStat` does not ignore all abilities that affect stats except those
* with the attribute of `StatMultiplierAbAttr` * with the attribute of `StatMultiplierAbAttr`
* TODO: Remove the `.partial()` tag from Tera Blast and Tera Starstorm when the above issue is resolved
* @extends VariableMoveCategoryAttr
*/ */
// TODO: Remove the `.partial()` tag from Tera Blast and Tera Starstorm when the above issue is resolved
export class TeraMoveCategoryAttr extends VariableMoveCategoryAttr { export class TeraMoveCategoryAttr extends VariableMoveCategoryAttr {
apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean { apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean {
const category = (args[0] as NumberHolder); const category = (args[0] as NumberHolder);
@ -5000,7 +4947,6 @@ export class TeraMoveCategoryAttr extends VariableMoveCategoryAttr {
/** /**
* Increases the power of Tera Blast if the user is Terastallized into Stellar type * Increases the power of Tera Blast if the user is Terastallized into Stellar type
* @extends VariablePowerAttr
*/ */
export class TeraBlastPowerAttr extends VariablePowerAttr { export class TeraBlastPowerAttr extends VariablePowerAttr {
/** /**
@ -5027,8 +4973,6 @@ export class TeraBlastPowerAttr extends VariablePowerAttr {
/** /**
* Change the move category to status when used on the ally * Change the move category to status when used on the ally
* @extends VariableMoveCategoryAttr
* @see {@linkcode apply}
*/ */
export class StatusCategoryOnAllyAttr extends VariableMoveCategoryAttr { export class StatusCategoryOnAllyAttr extends VariableMoveCategoryAttr {
/** /**
@ -5260,8 +5204,6 @@ export class WeatherBallTypeAttr extends VariableMoveTypeAttr {
/** /**
* Changes the move's type to match the current terrain. * Changes the move's type to match the current terrain.
* Has no effect if the user is not grounded. * Has no effect if the user is not grounded.
* @extends VariableMoveTypeAttr
* @see {@linkcode apply}
*/ */
export class TerrainPulseTypeAttr extends VariableMoveTypeAttr { export class TerrainPulseTypeAttr extends VariableMoveTypeAttr {
/** /**
@ -5309,7 +5251,6 @@ export class TerrainPulseTypeAttr extends VariableMoveTypeAttr {
/** /**
* Changes type based on the user's IVs * Changes type based on the user's IVs
* @extends VariableMoveTypeAttr
*/ */
export class HiddenPowerTypeAttr extends VariableMoveTypeAttr { export class HiddenPowerTypeAttr extends VariableMoveTypeAttr {
apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean { apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean {
@ -5337,7 +5278,6 @@ export class HiddenPowerTypeAttr extends VariableMoveTypeAttr {
/** /**
* Changes the type of Tera Blast to match the user's tera type * Changes the type of Tera Blast to match the user's tera type
* @extends VariableMoveTypeAttr
*/ */
export class TeraBlastTypeAttr extends VariableMoveTypeAttr { export class TeraBlastTypeAttr extends VariableMoveTypeAttr {
/** /**
@ -5364,7 +5304,6 @@ export class TeraBlastTypeAttr extends VariableMoveTypeAttr {
/** /**
* Attribute used for Tera Starstorm that changes the move type to Stellar * Attribute used for Tera Starstorm that changes the move type to Stellar
* @extends VariableMoveTypeAttr
*/ */
export class TeraStarstormTypeAttr extends VariableMoveTypeAttr { export class TeraStarstormTypeAttr extends VariableMoveTypeAttr {
/** /**
@ -5410,7 +5349,6 @@ export class MatchUserTypeAttr extends VariableMoveTypeAttr {
/** /**
* Changes the type of a Pledge move based on the Pledge move combined with it. * Changes the type of a Pledge move based on the Pledge move combined with it.
* @extends VariableMoveTypeAttr
*/ */
export class CombinedPledgeTypeAttr extends VariableMoveTypeAttr { export class CombinedPledgeTypeAttr extends VariableMoveTypeAttr {
override apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean { override apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean {
@ -5666,7 +5604,6 @@ export class FrenzyAttr extends MoveEffectAttr {
/** /**
* Attribute that grants {@link https://bulbapedia.bulbagarden.net/wiki/Semi-invulnerable_turn | semi-invulnerability} to the user during * Attribute that grants {@link https://bulbapedia.bulbagarden.net/wiki/Semi-invulnerable_turn | semi-invulnerability} to the user during
* the associated move's charging phase. Should only be used for {@linkcode ChargingMove | ChargingMoves} as a `chargeAttr`. * the associated move's charging phase. Should only be used for {@linkcode ChargingMove | ChargingMoves} as a `chargeAttr`.
* @extends MoveEffectAttr
*/ */
export class SemiInvulnerableAttr extends MoveEffectAttr { export class SemiInvulnerableAttr extends MoveEffectAttr {
/** The type of {@linkcode SemiInvulnerableTag} to grant to the user */ /** The type of {@linkcode SemiInvulnerableTag} to grant to the user */
@ -5792,7 +5729,6 @@ export class AddBattlerTagAttr extends MoveEffectAttr {
/** /**
* Adds a {@link https://bulbapedia.bulbagarden.net/wiki/Seeding | Seeding} effect to the target * Adds a {@link https://bulbapedia.bulbagarden.net/wiki/Seeding | Seeding} effect to the target
* as seen with Leech Seed and Sappy Seed. * as seen with Leech Seed and Sappy Seed.
* @extends AddBattlerTagAttr
*/ */
export class LeechSeedAttr extends AddBattlerTagAttr { export class LeechSeedAttr extends AddBattlerTagAttr {
constructor() { constructor() {
@ -5802,7 +5738,6 @@ export class LeechSeedAttr extends AddBattlerTagAttr {
/** /**
* Adds the appropriate battler tag for Smack Down and Thousand arrows * Adds the appropriate battler tag for Smack Down and Thousand arrows
* @extends AddBattlerTagAttr
*/ */
export class FallDownAttr extends AddBattlerTagAttr { export class FallDownAttr extends AddBattlerTagAttr {
constructor() { constructor() {
@ -5827,7 +5762,6 @@ export class FallDownAttr extends AddBattlerTagAttr {
/** /**
* Adds the appropriate battler tag for Gulp Missile when Surf or Dive is used. * Adds the appropriate battler tag for Gulp Missile when Surf or Dive is used.
* @extends MoveEffectAttr
*/ */
export class GulpMissileTagAttr extends MoveEffectAttr { export class GulpMissileTagAttr extends MoveEffectAttr {
constructor() { constructor() {
@ -5867,7 +5801,6 @@ export class GulpMissileTagAttr extends MoveEffectAttr {
/** /**
* Attribute to implement Jaw Lock's linked trapping effect between the user and target * Attribute to implement Jaw Lock's linked trapping effect between the user and target
* @extends AddBattlerTagAttr
*/ */
export class JawLockAttr extends AddBattlerTagAttr { export class JawLockAttr extends AddBattlerTagAttr {
constructor() { constructor() {
@ -6033,7 +5966,6 @@ export class ProtectAttr extends AddBattlerTagAttr {
/** /**
* Attribute to remove all Substitutes from the field. * Attribute to remove all Substitutes from the field.
* @extends MoveEffectAttr
* @see {@link https://bulbapedia.bulbagarden.net/wiki/Tidy_Up_(move) | Tidy Up} * @see {@link https://bulbapedia.bulbagarden.net/wiki/Tidy_Up_(move) | Tidy Up}
* @see {@linkcode SubstituteTag} * @see {@linkcode SubstituteTag}
*/ */
@ -6065,7 +5997,6 @@ export class RemoveAllSubstitutesAttr extends MoveEffectAttr {
* Attribute used when a move can deal damage to {@linkcode BattlerTagType} * Attribute used when a move can deal damage to {@linkcode BattlerTagType}
* Moves that always hit but do not deal double damage: Thunder, Fissure, Sky Uppercut, * Moves that always hit but do not deal double damage: Thunder, Fissure, Sky Uppercut,
* Smack Down, Hurricane, Thousand Arrows * Smack Down, Hurricane, Thousand Arrows
* @extends MoveAttr
*/ */
export class HitsTagAttr extends MoveAttr { export class HitsTagAttr extends MoveAttr {
/** The {@linkcode BattlerTagType} this move hits */ /** The {@linkcode BattlerTagType} this move hits */
@ -6179,8 +6110,6 @@ export class AddArenaTrapTagAttr extends AddArenaTagAttr {
/** /**
* Attribute used for Stone Axe and Ceaseless Edge. * Attribute used for Stone Axe and Ceaseless Edge.
* Applies the given ArenaTrapTag when move is used. * Applies the given ArenaTrapTag when move is used.
* @extends AddArenaTagAttr
* @see {@linkcode apply}
*/ */
export class AddArenaTrapTagHitAttr extends AddArenaTagAttr { export class AddArenaTrapTagHitAttr extends AddArenaTagAttr {
/** /**
@ -6273,10 +6202,7 @@ export class RemoveScreensAttr extends MoveEffectAttr {
} }
} }
/*Swaps arena effects between the player and enemy side /** Swaps arena effects between the player and enemy side */
* @extends MoveEffectAttr
* @see {@linkcode apply}
*/
export class SwapArenaTagsAttr extends MoveEffectAttr { export class SwapArenaTagsAttr extends MoveEffectAttr {
public SwapTags: ArenaTagType[]; public SwapTags: ArenaTagType[];
@ -6342,8 +6268,6 @@ export class AddPledgeEffectAttr extends AddArenaTagAttr {
/** /**
* Attribute used for Revival Blessing. * Attribute used for Revival Blessing.
* @extends MoveEffectAttr
* @see {@linkcode apply}
*/ */
export class RevivalBlessingAttr extends MoveEffectAttr { export class RevivalBlessingAttr extends MoveEffectAttr {
constructor() { constructor() {
@ -6408,7 +6332,6 @@ export class RevivalBlessingAttr extends MoveEffectAttr {
} }
} }
export class ForceSwitchOutAttr extends MoveEffectAttr { export class ForceSwitchOutAttr extends MoveEffectAttr {
constructor( constructor(
private selfSwitch: boolean = false, private selfSwitch: boolean = false,
@ -6921,8 +6844,6 @@ export class FirstMoveTypeAttr extends MoveEffectAttr {
/** /**
* Attribute used to call a move. * Attribute used to call a move.
* Used by other move attributes: {@linkcode RandomMoveAttr}, {@linkcode RandomMovesetMoveAttr}, {@linkcode CopyMoveAttr} * Used by other move attributes: {@linkcode RandomMoveAttr}, {@linkcode RandomMovesetMoveAttr}, {@linkcode CopyMoveAttr}
* @see {@linkcode apply} for move call
* @extends OverrideMoveEffectAttr
*/ */
class CallMoveAttr extends OverrideMoveEffectAttr { class CallMoveAttr extends OverrideMoveEffectAttr {
protected invalidMoves: ReadonlySet<MoveId>; protected invalidMoves: ReadonlySet<MoveId>;
@ -6954,8 +6875,6 @@ class CallMoveAttr extends OverrideMoveEffectAttr {
/** /**
* Attribute used to call a random move. * Attribute used to call a random move.
* Used for {@linkcode MoveId.METRONOME} * Used for {@linkcode MoveId.METRONOME}
* @see {@linkcode apply} for move selection and move call
* @extends CallMoveAttr to call a selected move
*/ */
export class RandomMoveAttr extends CallMoveAttr { export class RandomMoveAttr extends CallMoveAttr {
constructor(invalidMoves: ReadonlySet<MoveId>) { constructor(invalidMoves: ReadonlySet<MoveId>) {
@ -7003,8 +6922,6 @@ export class RandomMoveAttr extends CallMoveAttr {
* Fails if the user has no callable moves. * Fails if the user has no callable moves.
* *
* Invalid moves are indicated by what is passed in to invalidMoves: {@linkcode invalidAssistMoves} or {@linkcode invalidSleepTalkMoves} * Invalid moves are indicated by what is passed in to invalidMoves: {@linkcode invalidAssistMoves} or {@linkcode invalidSleepTalkMoves}
* @extends RandomMoveAttr to use the callMove function on a moveId
* @see {@linkcode getCondition} for move selection
*/ */
export class RandomMovesetMoveAttr extends CallMoveAttr { export class RandomMovesetMoveAttr extends CallMoveAttr {
private includeParty: boolean; private includeParty: boolean;
@ -7190,8 +7107,6 @@ export class NaturePowerAttr extends OverrideMoveEffectAttr {
/** /**
* Attribute used to copy a previously-used move. * Attribute used to copy a previously-used move.
* Used for {@linkcode MoveId.COPYCAT} and {@linkcode MoveId.MIRROR_MOVE} * Used for {@linkcode MoveId.COPYCAT} and {@linkcode MoveId.MIRROR_MOVE}
* @see {@linkcode apply} for move selection and move call
* @extends CallMoveAttr to call a selected move
*/ */
export class CopyMoveAttr extends CallMoveAttr { export class CopyMoveAttr extends CallMoveAttr {
private mirrorMove: boolean; private mirrorMove: boolean;
@ -7694,10 +7609,6 @@ export class SwitchAbilitiesAttr extends MoveEffectAttr {
/** /**
* Attribute used for moves that suppress abilities like {@linkcode MoveId.GASTRO_ACID}. * Attribute used for moves that suppress abilities like {@linkcode MoveId.GASTRO_ACID}.
* A suppressed ability cannot be activated. * A suppressed ability cannot be activated.
*
* @extends MoveEffectAttr
* @see {@linkcode apply}
* @see {@linkcode getCondition}
*/ */
export class SuppressAbilitiesAttr extends MoveEffectAttr { export class SuppressAbilitiesAttr extends MoveEffectAttr {
/** Sets ability suppression for the target pokemon and displays a message. */ /** Sets ability suppression for the target pokemon and displays a message. */
@ -7723,8 +7634,7 @@ export class SuppressAbilitiesAttr extends MoveEffectAttr {
/** /**
* Applies the effects of {@linkcode SuppressAbilitiesAttr} if the target has already moved this turn. * Applies the effects of {@linkcode SuppressAbilitiesAttr} if the target has already moved this turn.
* @extends MoveEffectAttr * @see {@linkcode MoveId.CORE_ENFORCER}
* @see {@linkcode MoveId.CORE_ENFORCER} (the move which uses this effect)
*/ */
export class SuppressAbilitiesIfActedAttr extends MoveEffectAttr { export class SuppressAbilitiesIfActedAttr extends MoveEffectAttr {
/** /**
@ -7773,8 +7683,6 @@ export class TransformAttr extends MoveEffectAttr {
/** /**
* Attribute used for status moves, namely Speed Swap, * Attribute used for status moves, namely Speed Swap,
* that swaps the user's and target's corresponding stats. * that swaps the user's and target's corresponding stats.
* @extends MoveEffectAttr
* @see {@linkcode apply}
*/ */
export class SwapStatAttr extends MoveEffectAttr { export class SwapStatAttr extends MoveEffectAttr {
/** The stat to be swapped between the user and the target */ /** The stat to be swapped between the user and the target */
@ -7815,7 +7723,6 @@ export class SwapStatAttr extends MoveEffectAttr {
/** /**
* Attribute used to switch the user's own stats. * Attribute used to switch the user's own stats.
* Used by Power Shift. * Used by Power Shift.
* @extends MoveEffectAttr
*/ */
export class ShiftStatAttr extends MoveEffectAttr { export class ShiftStatAttr extends MoveEffectAttr {
private statToSwitch: EffectiveStat; private statToSwitch: EffectiveStat;
@ -7872,8 +7779,6 @@ export class ShiftStatAttr extends MoveEffectAttr {
* Attribute used for status moves, namely Power Split and Guard Split, * Attribute used for status moves, namely Power Split and Guard Split,
* that take the average of a user's and target's corresponding * that take the average of a user's and target's corresponding
* stats and assign that average back to each corresponding stat. * stats and assign that average back to each corresponding stat.
* @extends MoveEffectAttr
* @see {@linkcode apply}
*/ */
export class AverageStatsAttr extends MoveEffectAttr { export class AverageStatsAttr extends MoveEffectAttr {
/** The stats to be averaged individually between the user and the target */ /** The stats to be averaged individually between the user and the target */
@ -7926,11 +7831,7 @@ export class MoneyAttr extends MoveEffectAttr {
} }
} }
/** /** Applies {@linkcode BattlerTagType.DESTINY_BOND} to the user */
* Applies {@linkcode BattlerTagType.DESTINY_BOND} to the user.
*
* @extends MoveEffectAttr
*/
export class DestinyBondAttr extends MoveEffectAttr { export class DestinyBondAttr extends MoveEffectAttr {
constructor() { constructor() {
super(true, { trigger: MoveEffectTrigger.PRE_APPLY }); super(true, { trigger: MoveEffectTrigger.PRE_APPLY });
@ -7951,10 +7852,7 @@ export class DestinyBondAttr extends MoveEffectAttr {
} }
} }
/** /** Attribute to apply a battler tag to the target if they have had their stats boosted this turn */
* Attribute to apply a battler tag to the target if they have had their stats boosted this turn.
* @extends AddBattlerTagAttr
*/
export class AddBattlerTagIfBoostedAttr extends AddBattlerTagAttr { export class AddBattlerTagIfBoostedAttr extends AddBattlerTagAttr {
constructor(tag: BattlerTagType) { constructor(tag: BattlerTagType) {
super(tag, false, false, 2, 5); super(tag, false, false, 2, 5);
@ -7977,7 +7875,6 @@ export class AddBattlerTagIfBoostedAttr extends AddBattlerTagAttr {
/** /**
* Attribute to apply a status effect to the target if they have had their stats boosted this turn. * Attribute to apply a status effect to the target if they have had their stats boosted this turn.
* @extends MoveEffectAttr
*/ */
export class StatusIfBoostedAttr extends MoveEffectAttr { export class StatusIfBoostedAttr extends MoveEffectAttr {
public effect: StatusEffect; public effect: StatusEffect;
@ -8073,7 +7970,6 @@ export class AfterYouAttr extends MoveEffectAttr {
/** /**
* Move effect to force the target to move last, ignoring priority. * Move effect to force the target to move last, ignoring priority.
* If applied to multiple targets, they move in speed order after all other moves. * If applied to multiple targets, they move in speed order after all other moves.
* @extends MoveEffectAttr
*/ */
export class ForceLastAttr extends MoveEffectAttr { export class ForceLastAttr extends MoveEffectAttr {
/** /**
@ -8317,9 +8213,6 @@ export class ResistLastMoveTypeAttr extends MoveEffectAttr {
* Drops the target's immunity to types it is immune to * Drops the target's immunity to types it is immune to
* and makes its evasiveness be ignored during accuracy * and makes its evasiveness be ignored during accuracy
* checks. Used by: {@linkcode MoveId.ODOR_SLEUTH | Odor Sleuth}, {@linkcode MoveId.MIRACLE_EYE | Miracle Eye} and {@linkcode MoveId.FORESIGHT | Foresight} * checks. Used by: {@linkcode MoveId.ODOR_SLEUTH | Odor Sleuth}, {@linkcode MoveId.MIRACLE_EYE | Miracle Eye} and {@linkcode MoveId.FORESIGHT | Foresight}
*
* @extends AddBattlerTagAttr
* @see {@linkcode apply}
*/ */
export class ExposedMoveAttr extends AddBattlerTagAttr { export class ExposedMoveAttr extends AddBattlerTagAttr {
constructor(tagType: BattlerTagType) { constructor(tagType: BattlerTagType) {

View File

@ -16,10 +16,7 @@ export enum ArenaEventType {
TAG_REMOVED = "onTagRemoved", TAG_REMOVED = "onTagRemoved",
} }
/** /** Base container class for all {@linkcode ArenaEventType} events */
* Base container class for all {@linkcode ArenaEventType} events
* @extends Event
*/
export class ArenaEvent extends Event { export class ArenaEvent extends Event {
/** The total duration of the {@linkcode ArenaEventType} */ /** The total duration of the {@linkcode ArenaEventType} */
public duration: number; public duration: number;
@ -29,10 +26,7 @@ export class ArenaEvent extends Event {
this.duration = duration; this.duration = duration;
} }
} }
/** /** Container class for {@linkcode ArenaEventType.WEATHER_CHANGED} events */
* Container class for {@linkcode ArenaEventType.WEATHER_CHANGED} events
* @extends ArenaEvent
*/
export class WeatherChangedEvent extends ArenaEvent { export class WeatherChangedEvent extends ArenaEvent {
/** The {@linkcode WeatherType} being overridden */ /** The {@linkcode WeatherType} being overridden */
public oldWeatherType: WeatherType; public oldWeatherType: WeatherType;
@ -45,10 +39,7 @@ export class WeatherChangedEvent extends ArenaEvent {
this.newWeatherType = newWeatherType; this.newWeatherType = newWeatherType;
} }
} }
/** /** Container class for {@linkcode ArenaEventType.TERRAIN_CHANGED} events */
* Container class for {@linkcode ArenaEventType.TERRAIN_CHANGED} events
* @extends ArenaEvent
*/
export class TerrainChangedEvent extends ArenaEvent { export class TerrainChangedEvent extends ArenaEvent {
/** The {@linkcode TerrainType} being overridden */ /** The {@linkcode TerrainType} being overridden */
public oldTerrainType: TerrainType; public oldTerrainType: TerrainType;
@ -62,10 +53,7 @@ export class TerrainChangedEvent extends ArenaEvent {
} }
} }
/** /** Container class for {@linkcode ArenaEventType.TAG_ADDED} events */
* Container class for {@linkcode ArenaEventType.TAG_ADDED} events
* @extends ArenaEvent
*/
export class TagAddedEvent extends ArenaEvent { export class TagAddedEvent extends ArenaEvent {
/** The {@linkcode ArenaTagType} being added */ /** The {@linkcode ArenaTagType} being added */
public arenaTagType: ArenaTagType; public arenaTagType: ArenaTagType;
@ -91,10 +79,7 @@ export class TagAddedEvent extends ArenaEvent {
this.arenaTagMaxLayers = arenaTagMaxLayers!; // TODO: is this bang correct? this.arenaTagMaxLayers = arenaTagMaxLayers!; // TODO: is this bang correct?
} }
} }
/** /** Container class for {@linkcode ArenaEventType.TAG_REMOVED} events */
* Container class for {@linkcode ArenaEventType.TAG_REMOVED} events
* @extends ArenaEvent
*/
export class TagRemovedEvent extends ArenaEvent { export class TagRemovedEvent extends ArenaEvent {
/** The {@linkcode ArenaTagType} being removed */ /** The {@linkcode ArenaTagType} being removed */
public arenaTagType: ArenaTagType; public arenaTagType: ArenaTagType;

View File

@ -43,10 +43,7 @@ export enum BattleSceneEventType {
NEW_ARENA = "onNewArena", NEW_ARENA = "onNewArena",
} }
/** /** Container class for {@linkcode BattleSceneEventType.CANDY_UPGRADE_NOTIFICATION_CHANGED} events */
* Container class for {@linkcode BattleSceneEventType.CANDY_UPGRADE_NOTIFICATION_CHANGED} events
* @extends Event
*/
export class CandyUpgradeNotificationChangedEvent extends Event { export class CandyUpgradeNotificationChangedEvent extends Event {
/** The new value the setting was changed to */ /** The new value the setting was changed to */
public newValue: number; public newValue: number;
@ -57,10 +54,7 @@ export class CandyUpgradeNotificationChangedEvent extends Event {
} }
} }
/** /** Container class for {@linkcode BattleSceneEventType.MOVE_USED} events */
* Container class for {@linkcode BattleSceneEventType.MOVE_USED} events
* @extends Event
*/
export class MoveUsedEvent extends Event { export class MoveUsedEvent extends Event {
/** The ID of the {@linkcode Pokemon} that used the {@linkcode Move} */ /** The ID of the {@linkcode Pokemon} that used the {@linkcode Move} */
public pokemonId: number; public pokemonId: number;
@ -76,10 +70,7 @@ export class MoveUsedEvent extends Event {
this.ppUsed = ppUsed; this.ppUsed = ppUsed;
} }
} }
/** /** Container class for {@linkcode BattleSceneEventType.BERRY_USED} events */
* Container class for {@linkcode BattleSceneEventType.BERRY_USED} events
* @extends Event
*/
export class BerryUsedEvent extends Event { export class BerryUsedEvent extends Event {
/** The {@linkcode BerryModifier} being used */ /** The {@linkcode BerryModifier} being used */
public berryModifier: BerryModifier; public berryModifier: BerryModifier;
@ -90,28 +81,19 @@ export class BerryUsedEvent extends Event {
} }
} }
/** /** Container class for {@linkcode BattleSceneEventType.ENCOUNTER_PHASE} events */
* Container class for {@linkcode BattleSceneEventType.ENCOUNTER_PHASE} events
* @extends Event
*/
export class EncounterPhaseEvent extends Event { export class EncounterPhaseEvent extends Event {
constructor() { constructor() {
super(BattleSceneEventType.ENCOUNTER_PHASE); super(BattleSceneEventType.ENCOUNTER_PHASE);
} }
} }
/** /** Container class for {@linkcode BattleSceneEventType.TURN_INIT} events */
* Container class for {@linkcode BattleSceneEventType.TURN_INIT} events
* @extends Event
*/
export class TurnInitEvent extends Event { export class TurnInitEvent extends Event {
constructor() { constructor() {
super(BattleSceneEventType.TURN_INIT); super(BattleSceneEventType.TURN_INIT);
} }
} }
/** /** Container class for {@linkcode BattleSceneEventType.TURN_END} events */
* Container class for {@linkcode BattleSceneEventType.TURN_END} events
* @extends Event
*/
export class TurnEndEvent extends Event { export class TurnEndEvent extends Event {
/** The amount of turns in the current battle */ /** The amount of turns in the current battle */
public turnCount: number; public turnCount: number;
@ -121,10 +103,7 @@ export class TurnEndEvent extends Event {
this.turnCount = turnCount; this.turnCount = turnCount;
} }
} }
/** /** Container class for {@linkcode BattleSceneEventType.NEW_ARENA} events */
* Container class for {@linkcode BattleSceneEventType.NEW_ARENA} events
* @extends Event
*/
export class NewArenaEvent extends Event { export class NewArenaEvent extends Event {
constructor() { constructor() {
super(BattleSceneEventType.NEW_ARENA); super(BattleSceneEventType.NEW_ARENA);

View File

@ -8,7 +8,6 @@ export enum EggEventType {
/** /**
* Container class for {@linkcode EggEventType.EGG_COUNT_CHANGED} events * Container class for {@linkcode EggEventType.EGG_COUNT_CHANGED} events
* @extends Event
*/ */
export class EggCountChangedEvent extends Event { export class EggCountChangedEvent extends Event {
/** The updated egg count. */ /** The updated egg count. */

View File

@ -874,11 +874,7 @@ export class AttackTypeBoosterModifierType
export type SpeciesStatBoosterItem = keyof typeof SpeciesStatBoosterModifierTypeGenerator.items; export type SpeciesStatBoosterItem = keyof typeof SpeciesStatBoosterModifierTypeGenerator.items;
/** /** Modifier type for {@linkcode SpeciesStatBoosterModifier} */
* Modifier type for {@linkcode SpeciesStatBoosterModifier}
* @extends PokemonHeldItemModifierType
* @implements GeneratedPersistentModifierType
*/
export class SpeciesStatBoosterModifierType export class SpeciesStatBoosterModifierType
extends PokemonHeldItemModifierType extends PokemonHeldItemModifierType
implements GeneratedPersistentModifierType implements GeneratedPersistentModifierType
@ -1396,7 +1392,6 @@ class TempStatStageBoosterModifierTypeGenerator extends ModifierTypeGenerator {
* Modifier type generator for {@linkcode SpeciesStatBoosterModifierType}, which * Modifier type generator for {@linkcode SpeciesStatBoosterModifierType}, which
* encapsulates the logic for weighting the most useful held item from * encapsulates the logic for weighting the most useful held item from
* the current list of {@linkcode items}. * the current list of {@linkcode items}.
* @extends ModifierTypeGenerator
*/ */
class SpeciesStatBoosterModifierTypeGenerator extends ModifierTypeGenerator { class SpeciesStatBoosterModifierTypeGenerator extends ModifierTypeGenerator {
/** Object comprised of the currently available species-based stat boosting held items */ /** Object comprised of the currently available species-based stat boosting held items */

View File

@ -345,9 +345,6 @@ export class AddVoucherModifier extends ConsumableModifier {
* modifier will be removed. If a modifier of the same type is to be added, it * modifier will be removed. If a modifier of the same type is to be added, it
* will reset {@linkcode battleCount} back to {@linkcode maxBattles} of the * will reset {@linkcode battleCount} back to {@linkcode maxBattles} of the
* existing modifier instead of adding that modifier directly. * existing modifier instead of adding that modifier directly.
* @extends PersistentModifier
* @abstract
* @see {@linkcode add}
*/ */
export abstract class LapsingPersistentModifier extends PersistentModifier { export abstract class LapsingPersistentModifier extends PersistentModifier {
/** The maximum amount of battles the modifier will exist for */ /** The maximum amount of battles the modifier will exist for */
@ -458,8 +455,6 @@ export abstract class LapsingPersistentModifier extends PersistentModifier {
/** /**
* Modifier used for passive items, specifically lures, that * Modifier used for passive items, specifically lures, that
* temporarily increases the chance of a double battle. * temporarily increases the chance of a double battle.
* @extends LapsingPersistentModifier
* @see {@linkcode apply}
*/ */
export class DoubleBattleChanceBoosterModifier extends LapsingPersistentModifier { export class DoubleBattleChanceBoosterModifier extends LapsingPersistentModifier {
public declare type: DoubleBattleChanceBoosterModifierType; public declare type: DoubleBattleChanceBoosterModifierType;
@ -495,8 +490,6 @@ export class DoubleBattleChanceBoosterModifier extends LapsingPersistentModifier
* Modifier used for party-wide items, specifically the X items, that * Modifier used for party-wide items, specifically the X items, that
* temporarily increases the stat stage multiplier of the corresponding * temporarily increases the stat stage multiplier of the corresponding
* {@linkcode TempBattleStat}. * {@linkcode TempBattleStat}.
* @extends LapsingPersistentModifier
* @see {@linkcode apply}
*/ */
export class TempStatStageBoosterModifier extends LapsingPersistentModifier { export class TempStatStageBoosterModifier extends LapsingPersistentModifier {
/** The stat whose stat stage multiplier will be temporarily increased */ /** The stat whose stat stage multiplier will be temporarily increased */
@ -562,8 +555,6 @@ export class TempStatStageBoosterModifier extends LapsingPersistentModifier {
/** /**
* Modifier used for party-wide items, namely Dire Hit, that * Modifier used for party-wide items, namely Dire Hit, that
* temporarily increments the critical-hit stage * temporarily increments the critical-hit stage
* @extends LapsingPersistentModifier
* @see {@linkcode apply}
*/ */
export class TempCritBoosterModifier extends LapsingPersistentModifier { export class TempCritBoosterModifier extends LapsingPersistentModifier {
clone() { clone() {
@ -818,8 +809,6 @@ export abstract class LapsingPokemonHeldItemModifier extends PokemonHeldItemModi
/** /**
* Modifier used for held items, specifically vitamins like Carbos, Hp Up, etc., that * Modifier used for held items, specifically vitamins like Carbos, Hp Up, etc., that
* increase the value of a given {@linkcode PermanentStat}. * increase the value of a given {@linkcode PermanentStat}.
* @extends PokemonHeldItemModifier
* @see {@linkcode apply}
*/ */
export class BaseStatModifier extends PokemonHeldItemModifier { export class BaseStatModifier extends PokemonHeldItemModifier {
protected stat: PermanentStat; protected stat: PermanentStat;
@ -1126,8 +1115,6 @@ export class PokemonIncrementingStatModifier extends PokemonHeldItemModifier {
/** /**
* Modifier used for held items that Applies {@linkcode Stat} boost(s) * Modifier used for held items that Applies {@linkcode Stat} boost(s)
* using a multiplier. * using a multiplier.
* @extends PokemonHeldItemModifier
* @see {@linkcode apply}
*/ */
export class StatBoosterModifier extends PokemonHeldItemModifier { export class StatBoosterModifier extends PokemonHeldItemModifier {
/** The stats that the held item boosts */ /** The stats that the held item boosts */
@ -1194,8 +1181,6 @@ export class StatBoosterModifier extends PokemonHeldItemModifier {
/** /**
* Modifier used for held items, specifically Eviolite, that apply * Modifier used for held items, specifically Eviolite, that apply
* {@linkcode Stat} boost(s) using a multiplier if the holder can evolve. * {@linkcode Stat} boost(s) using a multiplier if the holder can evolve.
* @extends StatBoosterModifier
* @see {@linkcode apply}
*/ */
export class EvolutionStatBoosterModifier extends StatBoosterModifier { export class EvolutionStatBoosterModifier extends StatBoosterModifier {
matchType(modifier: Modifier): boolean { matchType(modifier: Modifier): boolean {
@ -1246,8 +1231,6 @@ export class EvolutionStatBoosterModifier extends StatBoosterModifier {
/** /**
* Modifier used for held items that Applies {@linkcode Stat} boost(s) using a * Modifier used for held items that Applies {@linkcode Stat} boost(s) using a
* multiplier if the holder is of a specific {@linkcode SpeciesId}. * multiplier if the holder is of a specific {@linkcode SpeciesId}.
* @extends StatBoosterModifier
* @see {@linkcode apply}
*/ */
export class SpeciesStatBoosterModifier extends StatBoosterModifier { export class SpeciesStatBoosterModifier extends StatBoosterModifier {
/** The species that the held item's stat boost(s) apply to */ /** The species that the held item's stat boost(s) apply to */
@ -1321,8 +1304,6 @@ export class SpeciesStatBoosterModifier extends StatBoosterModifier {
/** /**
* Modifier used for held items that apply critical-hit stage boost(s). * Modifier used for held items that apply critical-hit stage boost(s).
* @extends PokemonHeldItemModifier
* @see {@linkcode apply}
*/ */
export class CritBoosterModifier extends PokemonHeldItemModifier { export class CritBoosterModifier extends PokemonHeldItemModifier {
/** The amount of stages by which the held item increases the current critical-hit stage value */ /** The amount of stages by which the held item increases the current critical-hit stage value */
@ -1369,8 +1350,6 @@ export class CritBoosterModifier extends PokemonHeldItemModifier {
/** /**
* Modifier used for held items that apply critical-hit stage boost(s) * Modifier used for held items that apply critical-hit stage boost(s)
* if the holder is of a specific {@linkcode SpeciesId}. * if the holder is of a specific {@linkcode SpeciesId}.
* @extends CritBoosterModifier
* @see {@linkcode shouldApply}
*/ */
export class SpeciesCritBoosterModifier extends CritBoosterModifier { export class SpeciesCritBoosterModifier extends CritBoosterModifier {
/** The species that the held item's critical-hit stage boost applies to */ /** The species that the held item's critical-hit stage boost applies to */
@ -1694,8 +1673,6 @@ export class TurnHealModifier extends PokemonHeldItemModifier {
/** /**
* Modifier used for held items, namely Toxic Orb and Flame Orb, that apply a * Modifier used for held items, namely Toxic Orb and Flame Orb, that apply a
* set {@linkcode StatusEffect} at the end of a turn. * set {@linkcode StatusEffect} at the end of a turn.
* @extends PokemonHeldItemModifier
* @see {@linkcode apply}
*/ */
export class TurnStatusEffectModifier extends PokemonHeldItemModifier { export class TurnStatusEffectModifier extends PokemonHeldItemModifier {
/** The status effect to be applied by the held item */ /** The status effect to be applied by the held item */
@ -1966,8 +1943,6 @@ export class PokemonInstantReviveModifier extends PokemonHeldItemModifier {
/** /**
* Modifier used for held items, namely White Herb, that restore adverse stat * Modifier used for held items, namely White Herb, that restore adverse stat
* stages in battle. * stages in battle.
* @extends PokemonHeldItemModifier
* @see {@linkcode apply}
*/ */
export class ResetNegativeStatStageModifier extends PokemonHeldItemModifier { export class ResetNegativeStatStageModifier extends PokemonHeldItemModifier {
matchType(modifier: Modifier) { matchType(modifier: Modifier) {
@ -2013,8 +1988,6 @@ export class ResetNegativeStatStageModifier extends PokemonHeldItemModifier {
/** /**
* Modifier used for held items, namely Mystical Rock, that extend the * Modifier used for held items, namely Mystical Rock, that extend the
* duration of weather and terrain effects. * duration of weather and terrain effects.
* @extends PokemonHeldItemModifier
* @see {@linkcode apply}
*/ */
export class FieldEffectModifier extends PokemonHeldItemModifier { export class FieldEffectModifier extends PokemonHeldItemModifier {
/** /**
@ -3400,8 +3373,6 @@ export class ExtraModifierModifier extends PersistentModifier {
/** /**
* Modifier used for timed boosts to the player's shop item rewards. * Modifier used for timed boosts to the player's shop item rewards.
* @extends LapsingPersistentModifier
* @see {@linkcode apply}
*/ */
export class TempExtraModifierModifier extends LapsingPersistentModifier { export class TempExtraModifierModifier extends LapsingPersistentModifier {
/** /**

View File

@ -6,10 +6,7 @@ import type { EggHatchSceneUiHandler } from "#ui/handlers/egg-hatch-scene-ui-han
import { addTextObject } from "#ui/text"; import { addTextObject } from "#ui/text";
import { addWindow } from "#ui/ui-theme"; import { addWindow } from "#ui/ui-theme";
/** /** A container that displays the count of hatching eggs */
* A container that displays the count of hatching eggs.
* @extends Phaser.GameObjects.Container
*/
export class EggCounterContainer extends Phaser.GameObjects.Container { export class EggCounterContainer extends Phaser.GameObjects.Container {
private readonly WINDOW_DEFAULT_WIDTH = 37; private readonly WINDOW_DEFAULT_WIDTH = 37;
private readonly WINDOW_MEDIUM_WIDTH = 42; private readonly WINDOW_MEDIUM_WIDTH = 42;

View File

@ -18,11 +18,7 @@ import { addTextObject } from "#ui/text";
import { truncateString } from "#utils/common"; import { truncateString } from "#utils/common";
import i18next from "i18next"; import i18next from "i18next";
/** /** Class representing the settings UI handler for gamepads */
* Class representing the settings UI handler for gamepads.
*
* @extends AbstractControlSettingsUiHandler
*/
export class SettingsGamepadUiHandler extends AbstractControlSettingsUiHandler { export class SettingsGamepadUiHandler extends AbstractControlSettingsUiHandler {
/** /**

View File

@ -19,11 +19,7 @@ import { truncateString } from "#utils/common";
import { toPascalSnakeCase } from "#utils/strings"; import { toPascalSnakeCase } from "#utils/strings";
import i18next from "i18next"; import i18next from "i18next";
/** /** Class representing the settings UI handler for keyboards */
* Class representing the settings UI handler for keyboards.
*
* @extends AbstractControlSettingsUiHandler
*/
export class SettingsKeyboardUiHandler extends AbstractControlSettingsUiHandler { export class SettingsKeyboardUiHandler extends AbstractControlSettingsUiHandler {
/** /**
* Creates an instance of SettingsKeyboardUiHandler. * Creates an instance of SettingsKeyboardUiHandler.