diff --git a/src/data/moves/move.ts b/src/data/moves/move.ts index a501a2399c1..b8bedd44986 100644 --- a/src/data/moves/move.ts +++ b/src/data/moves/move.ts @@ -93,6 +93,10 @@ import { ChargingMove, MoveAttrMap, MoveAttrString, MoveKindString, MoveClassMap import { applyMoveAttrs } from "./apply-attrs"; import { frenzyMissFunc, getMoveTargets } from "./move-utils"; +/** + * A function used to conditionally determine execution of a given {@linkcode MoveAttr}. + * Conventionally returns `true` for success and `false` for failure. +*/ type MoveConditionFunc = (user: Pokemon, target: Pokemon, move: Move) => boolean; export type UserMoveConditionFunc = (user: Pokemon, move: Move) => boolean; @@ -1401,18 +1405,31 @@ export class BeakBlastHeaderAttr extends AddBattlerTagHeaderAttr { } } +/** + * Attribute to display a message before a move is executed. + */ export class PreMoveMessageAttr extends MoveAttr { - private message: string | ((user: Pokemon, target: Pokemon, move: Move) => string); + /** The message to display or a function returning one */ + private message: string | ((user: Pokemon, target: Pokemon, move: Move) => string | undefined); + /** + * Create a new {@linkcode PreMoveMessageAttr} to display a message before move execution. + * @param message - The message to display before move use, either as a string or a function producing one. + * @remarks + * If {@linkcode message} evaluates to an empty string (`''`), no message will be displayed + * (though the move will still succeed). + */ constructor(message: string | ((user: Pokemon, target: Pokemon, move: Move) => string)) { super(); this.message = message; } - apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean { - const message = typeof this.message === "string" - ? this.message as string - : this.message(user, target, move); + apply(user: Pokemon, target: Pokemon, move: Move, _args: any[]): boolean { + const message = typeof this.message === "function" + ? this.message(user, target, move) + : this.message; + + // TODO: Consider changing if/when MoveAttr `apply` return values become significant if (message) { globalScene.phaseManager.queueMessage(message, 500); return true; @@ -11323,7 +11340,11 @@ export function initMoves() { .attr(ForceSwitchOutAttr, true, SwitchType.SHED_TAIL) .condition(failIfLastInPartyCondition), new SelfStatusMove(MoveId.CHILLY_RECEPTION, PokemonType.ICE, -1, 10, -1, 0, 9) - .attr(PreMoveMessageAttr, (user, move) => i18next.t("moveTriggers:chillyReception", { pokemonName: getPokemonNameWithAffix(user) })) + .attr(PreMoveMessageAttr, (user, _target, _move) => + // Don't display text if current move phase is follow up (ie move called indirectly) + isVirtual((globalScene.phaseManager.getCurrentPhase() as MovePhase).useMode) + ? "" + : i18next.t("moveTriggers:chillyReception", { pokemonName: getPokemonNameWithAffix(user) })) .attr(ChillyReceptionAttr, true), new SelfStatusMove(MoveId.TIDY_UP, PokemonType.NORMAL, -1, 10, -1, 0, 9) .attr(StatStageChangeAttr, [ Stat.ATK, Stat.SPD ], 1, true) diff --git a/src/data/mystery-encounters/utils/encounter-pokemon-utils.ts b/src/data/mystery-encounters/utils/encounter-pokemon-utils.ts index c78cfe68f91..3672604c4dd 100644 --- a/src/data/mystery-encounters/utils/encounter-pokemon-utils.ts +++ b/src/data/mystery-encounters/utils/encounter-pokemon-utils.ts @@ -751,7 +751,7 @@ export async function catchPokemon( UiMode.POKEDEX_PAGE, pokemon.species, pokemon.formIndex, - attributes, + [attributes], null, () => { globalScene.ui.setMode(UiMode.MESSAGE).then(() => { diff --git a/src/phases/move-phase.ts b/src/phases/move-phase.ts index 41a1042387b..2e94b085948 100644 --- a/src/phases/move-phase.ts +++ b/src/phases/move-phase.ts @@ -668,6 +668,9 @@ export class MovePhase extends BattlePhase { }), 500, ); + + // Moves with pre-use messages (Magnitude, Chilly Reception, Fickle Beam, etc.) always display their messages even on failure + // TODO: This assumes single target for message funcs - is this sustainable? applyMoveAttrs("PreMoveMessageAttr", this.pokemon, this.pokemon.getOpponents(false)[0], this.move.getMove()); } diff --git a/test/moves/chilly_reception.test.ts b/test/moves/chilly_reception.test.ts index 14141208161..4d15bfff284 100644 --- a/test/moves/chilly_reception.test.ts +++ b/test/moves/chilly_reception.test.ts @@ -1,11 +1,14 @@ -import { AbilityId } from "#enums/ability-id"; +import { RandomMoveAttr } from "#app/data/moves/move"; +import { MoveResult } from "#enums/move-result"; +import { getPokemonNameWithAffix } from "#app/messages"; import { MoveId } from "#enums/move-id"; import { SpeciesId } from "#enums/species-id"; +import { AbilityId } from "#app/enums/ability-id"; import { WeatherType } from "#enums/weather-type"; import GameManager from "#test/testUtils/gameManager"; +import i18next from "i18next"; import Phaser from "phaser"; -//import { TurnInitPhase } from "#app/phases/turn-init-phase"; -import { afterEach, beforeAll, beforeEach, describe, expect, it } from "vitest"; +import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; describe("Moves - Chilly Reception", () => { let phaserGame: Phaser.Game; @@ -25,95 +28,121 @@ describe("Moves - Chilly Reception", () => { game = new GameManager(phaserGame); game.override .battleStyle("single") - .moveset([MoveId.CHILLY_RECEPTION, MoveId.SNOWSCAPE]) + .moveset([MoveId.CHILLY_RECEPTION, MoveId.SNOWSCAPE, MoveId.SPLASH, MoveId.METRONOME]) .enemyMoveset(MoveId.SPLASH) .enemyAbility(AbilityId.BALL_FETCH) .ability(AbilityId.BALL_FETCH); }); - it("should still change the weather if user can't switch out", async () => { + it("should display message before use, switch the user out and change the weather to snow", async () => { + await game.classicMode.startBattle([SpeciesId.SLOWKING, SpeciesId.MEOWTH]); + + const [slowking, meowth] = game.scene.getPlayerParty(); + + game.move.select(MoveId.CHILLY_RECEPTION); + game.doSelectPartyPokemon(1); + await game.toEndOfTurn(); + + expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); + expect(game.scene.getPlayerPokemon()).toBe(meowth); + expect(slowking.isOnField()).toBe(false); + expect(game.phaseInterceptor.log).toContain("SwitchSummonPhase"); + expect(game.textInterceptor.logs).toContain( + i18next.t("moveTriggers:chillyReception", { pokemonName: getPokemonNameWithAffix(slowking) }), + ); + }); + + it("should still change weather if user can't switch out", async () => { await game.classicMode.startBattle([SpeciesId.SLOWKING]); game.move.select(MoveId.CHILLY_RECEPTION); + await game.toEndOfTurn(); - await game.phaseInterceptor.to("BerryPhase", false); expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); + expect(game.phaseInterceptor.log).not.toContain("SwitchSummonPhase"); + expect(game.scene.getPlayerPokemon()?.getLastXMoves()[0].result).toBe(MoveResult.SUCCESS); }); - it("should switch out even if it's snowing", async () => { + it("should still switch out even if weather cannot be changed", async () => { await game.classicMode.startBattle([SpeciesId.SLOWKING, SpeciesId.MEOWTH]); - // first turn set up snow with snowscape, try chilly reception on second turn + + expect(game.scene.arena.weather?.weatherType).not.toBe(WeatherType.SNOW); + + const [slowking, meowth] = game.scene.getPlayerParty(); + game.move.select(MoveId.SNOWSCAPE); - await game.phaseInterceptor.to("BerryPhase", false); + await game.toNextTurn(); + expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); - await game.phaseInterceptor.to("TurnInitPhase", false); game.move.select(MoveId.CHILLY_RECEPTION); game.doSelectPartyPokemon(1); + // TODO: Uncomment lines once wimp out PR fixes force switches to not reset summon data immediately + // await game.phaseInterceptor.to("SwitchSummonPhase", false); + // expect(slowking.getLastXMoves()[0].result).toBe(MoveResult.SUCCESS); + + await game.toEndOfTurn(); - await game.phaseInterceptor.to("BerryPhase", false); expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); - expect(game.scene.getPlayerField()[0].species.speciesId).toBe(SpeciesId.MEOWTH); + expect(game.phaseInterceptor.log).toContain("SwitchSummonPhase"); + expect(game.scene.getPlayerPokemon()).toBe(meowth); + expect(slowking.isOnField()).toBe(false); }); - it("happy case - switch out and weather changes", async () => { + // Source: https://replay.pokemonshowdown.com/gen9ou-2367532550 + it("should fail (while still displaying message) if neither weather change nor switch out succeeds", async () => { + await game.classicMode.startBattle([SpeciesId.SLOWKING]); + + expect(game.scene.arena.weather?.weatherType).not.toBe(WeatherType.SNOW); + + const slowking = game.scene.getPlayerPokemon()!; + + game.move.select(MoveId.SNOWSCAPE); + await game.toNextTurn(); + + expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); + + game.move.select(MoveId.CHILLY_RECEPTION); + game.doSelectPartyPokemon(1); + await game.toEndOfTurn(); + + expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); + expect(game.phaseInterceptor.log).not.toContain("SwitchSummonPhase"); + expect(game.scene.getPlayerPokemon()).toBe(slowking); + expect(slowking.getLastXMoves()[0].result).toBe(MoveResult.FAIL); + expect(game.textInterceptor.logs).toContain( + i18next.t("moveTriggers:chillyReception", { pokemonName: getPokemonNameWithAffix(slowking) }), + ); + }); + + it("should succeed without message if called indirectly", async () => { + vi.spyOn(RandomMoveAttr.prototype, "getMoveOverride").mockReturnValue(MoveId.CHILLY_RECEPTION); await game.classicMode.startBattle([SpeciesId.SLOWKING, SpeciesId.MEOWTH]); - game.move.select(MoveId.CHILLY_RECEPTION); - game.doSelectPartyPokemon(1); + const [slowking, meowth] = game.scene.getPlayerParty(); + + game.move.select(MoveId.METRONOME); + game.doSelectPartyPokemon(1); + await game.toEndOfTurn(); - await game.phaseInterceptor.to("BerryPhase", false); expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); - expect(game.scene.getPlayerField()[0].species.speciesId).toBe(SpeciesId.MEOWTH); + expect(game.scene.getPlayerPokemon()).toBe(meowth); + expect(slowking.isOnField()).toBe(false); + expect(game.phaseInterceptor.log).toContain("SwitchSummonPhase"); + expect(game.textInterceptor.logs).not.toContain( + i18next.t("moveTriggers:chillyReception", { pokemonName: getPokemonNameWithAffix(slowking) }), + ); }); - // enemy uses another move and weather doesn't change - it("check case - enemy not selecting chilly reception doesn't change weather ", async () => { - game.override.battleStyle("single").enemyMoveset([MoveId.CHILLY_RECEPTION, MoveId.TACKLE]).moveset(MoveId.SPLASH); - + // Bugcheck test for enemy AI bug + it("check case - enemy not selecting chilly reception doesn't change weather", async () => { + game.override.enemyMoveset([MoveId.CHILLY_RECEPTION, MoveId.TACKLE]); await game.classicMode.startBattle([SpeciesId.SLOWKING, SpeciesId.MEOWTH]); game.move.select(MoveId.SPLASH); await game.move.selectEnemyMove(MoveId.TACKLE); + await game.toEndOfTurn(); - await game.phaseInterceptor.to("BerryPhase", false); - expect(game.scene.arena.weather?.weatherType).toBe(undefined); - }); - - it("enemy trainer - expected behavior ", async () => { - game.override - .battleStyle("single") - .startingWave(8) - .enemyMoveset(MoveId.CHILLY_RECEPTION) - .enemySpecies(SpeciesId.MAGIKARP) - .moveset([MoveId.SPLASH, MoveId.THUNDERBOLT]); - - await game.classicMode.startBattle([SpeciesId.JOLTEON]); - const RIVAL_MAGIKARP1 = game.scene.getEnemyPokemon()?.id; - - game.move.select(MoveId.SPLASH); - await game.phaseInterceptor.to("BerryPhase", false); - expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); - expect(game.scene.getEnemyPokemon()?.id !== RIVAL_MAGIKARP1); - - await game.phaseInterceptor.to("TurnInitPhase", false); - game.move.select(MoveId.SPLASH); - - // second chilly reception should still switch out - await game.phaseInterceptor.to("BerryPhase", false); - expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); - await game.phaseInterceptor.to("TurnInitPhase", false); - expect(game.scene.getEnemyPokemon()?.id === RIVAL_MAGIKARP1); - game.move.select(MoveId.THUNDERBOLT); - - // enemy chilly recep move should fail: it's snowing and no option to switch out - // no crashing - await game.phaseInterceptor.to("BerryPhase", false); - expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); - await game.phaseInterceptor.to("TurnInitPhase", false); - expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); - game.move.select(MoveId.SPLASH); - await game.phaseInterceptor.to("BerryPhase", false); - expect(game.scene.arena.weather?.weatherType).toBe(WeatherType.SNOW); + expect(game.scene.arena.weather?.weatherType).toBeUndefined(); }); });