From 53ed8b9f96d5009c24aae26e6128ec44cc0f6eb9 Mon Sep 17 00:00:00 2001 From: Jakub Hanko <60473007+JakubHanko@users.noreply.github.com> Date: Sat, 18 May 2024 09:24:16 +0200 Subject: [PATCH] Add TSDocs --- src/data/ability.ts | 8 ++++++++ src/data/battler-tags.ts | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/src/data/ability.ts b/src/data/ability.ts index 60fa981685a..812bccaa11b 100644 --- a/src/data/ability.ts +++ b/src/data/ability.ts @@ -2690,8 +2690,16 @@ export class IgnoreTypeStatusEffectImmunityAbAttr extends AbAttr { } } +/** + * Abstract class for aura effects. Aura effects apply tags + * to a list of targets and keeps reapplying them as long + * as the aura source is active. + */ export abstract class AuraAbAttr extends AbAttr { } +/** + * Damage reduction aura triggered by {@linkcode Abilities.FRIEND_GUARD}. + */ export class FriendGuardAbAttr extends AuraAbAttr { apply(pokemon: Pokemon, passive: boolean, cancelled: Utils.BooleanHolder, args: any[]): boolean { const ally = pokemon.getAlly(); diff --git a/src/data/battler-tags.ts b/src/data/battler-tags.ts index 6bfc0a7c154..2ec158bc114 100644 --- a/src/data/battler-tags.ts +++ b/src/data/battler-tags.ts @@ -1276,6 +1276,11 @@ export class CursedTag extends BattlerTag { } } +/** + * Abstract class for aura tag effects. Lapse is triggered + * at the start of move phase. Tag is active as long + * as the its source is active. + */ export abstract class AuraTag extends BattlerTag { constructor(tagType: BattlerTagType, sourceId: number) { super(tagType, BattlerTagLapseType.CUSTOM, 0, undefined, sourceId); @@ -1287,6 +1292,9 @@ export abstract class AuraTag extends BattlerTag { } } +/** + * Tag that reduces received damage. Applied during pre-defend. + */ export class ReceivedMoveDamageMultiplierTag extends AuraTag { public powerMultiplier: number;