From e9ee2c11799adfc33374133662cb153f4db03dec Mon Sep 17 00:00:00 2001 From: NightKev <34855794+DayKev@users.noreply.github.com> Date: Mon, 30 Sep 2024 10:10:00 -0700 Subject: [PATCH] [Refactor] Remove unused parameters in move flag functions (#4516) Also fix tsdocs for these functions --- src/data/move.ts | 140 +++++++++++++++++++++-------------------------- 1 file changed, 61 insertions(+), 79 deletions(-) diff --git a/src/data/move.ts b/src/data/move.ts index e163e89a272..35b5ad56927 100644 --- a/src/data/move.ts +++ b/src/data/move.ts @@ -398,220 +398,202 @@ export default class Move implements Localizable { /** * Sets the {@linkcode MoveFlags.MAKES_CONTACT} flag for the calling Move - * @param makesContact The value (boolean) to set the flag to + * @param setFlag Default `true`, set to `false` if the move doesn't make contact + * @see {@linkcode Abilities.STATIC} * @returns The {@linkcode Move} that called this function */ - makesContact(makesContact: boolean = true): this { - this.setFlag(MoveFlags.MAKES_CONTACT, makesContact); + makesContact(setFlag: boolean = true): this { + this.setFlag(MoveFlags.MAKES_CONTACT, setFlag); return this; } /** * Sets the {@linkcode MoveFlags.IGNORE_PROTECT} flag for the calling Move - * @param ignoresProtect The value (boolean) to set the flag to - * example: @see {@linkcode Moves.CURSE} + * @see {@linkcode Moves.CURSE} * @returns The {@linkcode Move} that called this function */ - ignoresProtect(ignoresProtect: boolean = true): this { - this.setFlag(MoveFlags.IGNORE_PROTECT, ignoresProtect); + ignoresProtect(): this { + this.setFlag(MoveFlags.IGNORE_PROTECT, true); return this; } /** * Sets the {@linkcode MoveFlags.IGNORE_VIRTUAL} flag for the calling Move - * @param ignoresVirtual The value (boolean) to set the flag to - * example: @see {@linkcode Moves.NATURE_POWER} + * @see {@linkcode Moves.NATURE_POWER} * @returns The {@linkcode Move} that called this function */ - ignoresVirtual(ignoresVirtual: boolean = true): this { - this.setFlag(MoveFlags.IGNORE_VIRTUAL, ignoresVirtual); + ignoresVirtual(): this { + this.setFlag(MoveFlags.IGNORE_VIRTUAL, true); return this; } /** * Sets the {@linkcode MoveFlags.SOUND_BASED} flag for the calling Move - * @param soundBased The value (boolean) to set the flag to - * example: @see {@linkcode Moves.UPROAR} + * @see {@linkcode Moves.UPROAR} * @returns The {@linkcode Move} that called this function */ - soundBased(soundBased: boolean = true): this { - this.setFlag(MoveFlags.SOUND_BASED, soundBased); + soundBased(): this { + this.setFlag(MoveFlags.SOUND_BASED, true); return this; } /** * Sets the {@linkcode MoveFlags.HIDE_USER} flag for the calling Move - * @param hidesUser The value (boolean) to set the flag to - * example: @see {@linkcode Moves.TELEPORT} + * @see {@linkcode Moves.TELEPORT} * @returns The {@linkcode Move} that called this function */ - hidesUser(hidesUser: boolean = true): this { - this.setFlag(MoveFlags.HIDE_USER, hidesUser); + hidesUser(): this { + this.setFlag(MoveFlags.HIDE_USER, true); return this; } /** * Sets the {@linkcode MoveFlags.HIDE_TARGET} flag for the calling Move - * @param hidesTarget The value (boolean) to set the flag to - * example: @see {@linkcode Moves.WHIRLWIND} + * @see {@linkcode Moves.WHIRLWIND} * @returns The {@linkcode Move} that called this function */ - hidesTarget(hidesTarget: boolean = true): this { - this.setFlag(MoveFlags.HIDE_TARGET, hidesTarget); + hidesTarget(): this { + this.setFlag(MoveFlags.HIDE_TARGET, true); return this; } /** * Sets the {@linkcode MoveFlags.BITING_MOVE} flag for the calling Move - * @param bitingMove The value (boolean) to set the flag to - * example: @see {@linkcode Moves.BITE} + * @see {@linkcode Moves.BITE} * @returns The {@linkcode Move} that called this function */ - bitingMove(bitingMove: boolean = true): this { - this.setFlag(MoveFlags.BITING_MOVE, bitingMove); + bitingMove(): this { + this.setFlag(MoveFlags.BITING_MOVE, true); return this; } /** * Sets the {@linkcode MoveFlags.PULSE_MOVE} flag for the calling Move - * @param pulseMove The value (boolean) to set the flag to - * example: @see {@linkcode Moves.WATER_PULSE} + * @see {@linkcode Moves.WATER_PULSE} * @returns The {@linkcode Move} that called this function */ - pulseMove(pulseMove: boolean = true): this { - this.setFlag(MoveFlags.PULSE_MOVE, pulseMove); + pulseMove(): this { + this.setFlag(MoveFlags.PULSE_MOVE, true); return this; } /** * Sets the {@linkcode MoveFlags.PUNCHING_MOVE} flag for the calling Move - * @param punchingMove The value (boolean) to set the flag to - * example: @see {@linkcode Moves.DRAIN_PUNCH} + * @see {@linkcode Moves.DRAIN_PUNCH} * @returns The {@linkcode Move} that called this function */ - punchingMove(punchingMove: boolean = true): this { - this.setFlag(MoveFlags.PUNCHING_MOVE, punchingMove); + punchingMove(): this { + this.setFlag(MoveFlags.PUNCHING_MOVE, true); return this; } /** * Sets the {@linkcode MoveFlags.SLICING_MOVE} flag for the calling Move - * @param slicingMove The value (boolean) to set the flag to - * example: @see {@linkcode Moves.X_SCISSOR} + * @see {@linkcode Moves.X_SCISSOR} * @returns The {@linkcode Move} that called this function */ - slicingMove(slicingMove: boolean = true): this { - this.setFlag(MoveFlags.SLICING_MOVE, slicingMove); + slicingMove(): this { + this.setFlag(MoveFlags.SLICING_MOVE, true); return this; } /** * Sets the {@linkcode MoveFlags.RECKLESS_MOVE} flag for the calling Move * @see {@linkcode Abilities.RECKLESS} - * @param recklessMove The value to set the flag to * @returns The {@linkcode Move} that called this function */ - recklessMove(recklessMove: boolean = true): this { - this.setFlag(MoveFlags.RECKLESS_MOVE, recklessMove); + recklessMove(): this { + this.setFlag(MoveFlags.RECKLESS_MOVE, true); return this; } /** * Sets the {@linkcode MoveFlags.BALLBOMB_MOVE} flag for the calling Move - * @param ballBombMove The value (boolean) to set the flag to - * example: @see {@linkcode Moves.ELECTRO_BALL} + * @see {@linkcode Moves.ELECTRO_BALL} * @returns The {@linkcode Move} that called this function */ - ballBombMove(ballBombMove: boolean = true): this { - this.setFlag(MoveFlags.BALLBOMB_MOVE, ballBombMove); + ballBombMove(): this { + this.setFlag(MoveFlags.BALLBOMB_MOVE, true); return this; } /** * Sets the {@linkcode MoveFlags.POWDER_MOVE} flag for the calling Move - * @param powderMove The value (boolean) to set the flag to - * example: @see {@linkcode Moves.STUN_SPORE} + * @see {@linkcode Moves.STUN_SPORE} * @returns The {@linkcode Move} that called this function */ - powderMove(powderMove: boolean = true): this { - this.setFlag(MoveFlags.POWDER_MOVE, powderMove); + powderMove(): this { + this.setFlag(MoveFlags.POWDER_MOVE, true); return this; } /** * Sets the {@linkcode MoveFlags.DANCE_MOVE} flag for the calling Move - * @param danceMove The value (boolean) to set the flag to - * example: @see {@linkcode Moves.PETAL_DANCE} + * @see {@linkcode Moves.PETAL_DANCE} * @returns The {@linkcode Move} that called this function */ - danceMove(danceMove: boolean = true): this { - this.setFlag(MoveFlags.DANCE_MOVE, danceMove); + danceMove(): this { + this.setFlag(MoveFlags.DANCE_MOVE, true); return this; } /** * Sets the {@linkcode MoveFlags.WIND_MOVE} flag for the calling Move - * @param windMove The value (boolean) to set the flag to - * example: @see {@linkcode Moves.HURRICANE} + * @see {@linkcode Moves.HURRICANE} * @returns The {@linkcode Move} that called this function */ - windMove(windMove: boolean = true): this { - this.setFlag(MoveFlags.WIND_MOVE, windMove); + windMove(): this { + this.setFlag(MoveFlags.WIND_MOVE, true); return this; } /** * Sets the {@linkcode MoveFlags.TRIAGE_MOVE} flag for the calling Move - * @param triageMove The value (boolean) to set the flag to - * example: @see {@linkcode Moves.ABSORB} + * @see {@linkcode Moves.ABSORB} * @returns The {@linkcode Move} that called this function */ - triageMove(triageMove: boolean = true): this { - this.setFlag(MoveFlags.TRIAGE_MOVE, triageMove); + triageMove(): this { + this.setFlag(MoveFlags.TRIAGE_MOVE, true); return this; } /** * Sets the {@linkcode MoveFlags.IGNORE_ABILITIES} flag for the calling Move - * @param ignoresAbilities sThe value (boolean) to set the flag to - * example: @see {@linkcode Moves.SUNSTEEL_STRIKE} + * @see {@linkcode Moves.SUNSTEEL_STRIKE} * @returns The {@linkcode Move} that called this function */ - ignoresAbilities(ignoresAbilities: boolean = true): this { - this.setFlag(MoveFlags.IGNORE_ABILITIES, ignoresAbilities); + ignoresAbilities(): this { + this.setFlag(MoveFlags.IGNORE_ABILITIES, true); return this; } /** * Sets the {@linkcode MoveFlags.CHECK_ALL_HITS} flag for the calling Move - * @param checkAllHits The value (boolean) to set the flag to - * example: @see {@linkcode Moves.TRIPLE_AXEL} + * @see {@linkcode Moves.TRIPLE_AXEL} * @returns The {@linkcode Move} that called this function */ - checkAllHits(checkAllHits: boolean = true): this { - this.setFlag(MoveFlags.CHECK_ALL_HITS, checkAllHits); + checkAllHits(): this { + this.setFlag(MoveFlags.CHECK_ALL_HITS, true); return this; } /** * Sets the {@linkcode MoveFlags.IGNORE_SUBSTITUTE} flag for the calling Move - * @param ignoresSubstitute The value (boolean) to set the flag to - * example: @see {@linkcode Moves.WHIRLWIND} + * @see {@linkcode Moves.WHIRLWIND} * @returns The {@linkcode Move} that called this function */ - ignoresSubstitute(ignoresSubstitute: boolean = true): this { - this.setFlag(MoveFlags.IGNORE_SUBSTITUTE, ignoresSubstitute); + ignoresSubstitute(): this { + this.setFlag(MoveFlags.IGNORE_SUBSTITUTE, true); return this; } /** * Sets the {@linkcode MoveFlags.REDIRECT_COUNTER} flag for the calling Move - * @param redirectCounter The value (boolean) to set the flag to - * example: @see {@linkcode Moves.METAL_BURST} + * @see {@linkcode Moves.METAL_BURST} * @returns The {@linkcode Move} that called this function */ - redirectCounter(redirectCounter: boolean = true): this { - this.setFlag(MoveFlags.REDIRECT_COUNTER, redirectCounter); + redirectCounter(): this { + this.setFlag(MoveFlags.REDIRECT_COUNTER, true); return this; } @@ -7268,7 +7250,7 @@ export function initMoves() { new StatusMove(Moves.CURSE, Type.GHOST, -1, 10, -1, 0, 2) .attr(CurseAttr) .ignoresSubstitute() - .ignoresProtect(true) + .ignoresProtect() .target(MoveTarget.CURSE), new AttackMove(Moves.FLAIL, Type.NORMAL, MoveCategory.PHYSICAL, -1, 100, 15, -1, 0, 2) .attr(LowHpPowerAttr),