pokerogue/test/mystery-encounter/encounters/field-trip-encounter.test.ts
Wlowscha 466c4aede2
Replace remaining Modifiers with Rewards (#6091)
* Changing remaining Modifiers to Consumables, and renaming ModifierType to Reward

* Renamed modifier files and moved them into items folder

* Using rewards in most places

* Removed consumables in favor of using rewards directly

* Renamed RewardTier to RarityTier

* Reward ids, function to match rewards

* Getting reward tiers from player pool still

* Messing around with parameters of Reward.apply()

* Always requiring player pokemon in rewards

* Fixing some functions in select-reward-phase and battle-scene

* Fixed various post-merge issues

* Fixed most localization strings (accidentally broken by replacing modifierType with reward)

* Fixed tests for select reward phase

* Using Pokemon.hasSpecies()

* Zero weight for trainer items rewards which are already max stack

* Cleaning up SelectRewardPhase, held item rewards behave the same as any PokemonReward

* Cleaned up some functions

* Introduced RewardCategoryId, distributed RewardIds

* Utility `is` functions for rewards

* Minor fixes

* Moved `HeldItemEffect` to its own file

* rmade some todo comments

* Adding a big comment

* Added tsdocs and removed `RewardClass`

* undid breaking changes

* added TODO

* Moved matchingRewards function to reward-utils.ts

* Added RewardGenerator classes for mints and tera shards

* Introducing default rarity tiers for trainer items and rewards

* RewardFunc now can return RewardGenerator

* Moved pool reward functions to their own file, plus other utility files

* Fixed WeightedModifier to work with the new RewardFunc

* Fixed wrong type import

* Shifting trainer item and reward ids to avoid overlaps

* Added some types

* Updated comment in reward.ts

* Added strong typing ot item maps

* added type safety to held item name map

---------

Co-authored-by: Bertie690 <taylormw163@gmail.com>
Co-authored-by: Sirz Benjie <142067137+SirzBenjie@users.noreply.github.com>
2025-07-27 17:09:21 -07:00

264 lines
12 KiB
TypeScript

import type { BattleScene } from "#app/battle-scene";
import { BiomeId } from "#enums/biome-id";
import { MoveId } from "#enums/move-id";
import { MysteryEncounterOptionMode } from "#enums/mystery-encounter-option-mode";
import { MysteryEncounterTier } from "#enums/mystery-encounter-tier";
import { MysteryEncounterType } from "#enums/mystery-encounter-type";
import { SpeciesId } from "#enums/species-id";
import { UiMode } from "#enums/ui-mode";
import * as EncounterPhaseUtils from "#mystery-encounters/encounter-phase-utils";
import { FieldTripEncounter } from "#mystery-encounters/field-trip-encounter";
import * as MysteryEncounters from "#mystery-encounters/mystery-encounters";
import { SelectRewardPhase } from "#phases/select-reward-phase";
import { runMysteryEncounterToEnd } from "#test/mystery-encounter/encounter-test-utils";
import { GameManager } from "#test/test-utils/game-manager";
import { RewardSelectUiHandler } from "#ui/reward-select-ui-handler";
import i18next from "i18next";
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
const namespace = "mysteryEncounters/fieldTrip";
const defaultParty = [SpeciesId.LAPRAS, SpeciesId.GENGAR, SpeciesId.ABRA];
const defaultBiome = BiomeId.CAVE;
const defaultWave = 45;
describe("Field Trip - Mystery Encounter", () => {
let phaserGame: Phaser.Game;
let game: GameManager;
let scene: BattleScene;
beforeAll(() => {
phaserGame = new Phaser.Game({ type: Phaser.HEADLESS });
});
beforeEach(async () => {
game = new GameManager(phaserGame);
scene = game.scene;
game.override
.mysteryEncounterChance(100)
.startingWave(defaultWave)
.startingBiome(defaultBiome)
.disableTrainerWaves()
.moveset([MoveId.TACKLE, MoveId.UPROAR, MoveId.SWORDS_DANCE]);
vi.spyOn(MysteryEncounters, "mysteryEncountersByBiome", "get").mockReturnValue(
new Map<BiomeId, MysteryEncounterType[]>([[BiomeId.CAVE, [MysteryEncounterType.FIELD_TRIP]]]),
);
});
afterEach(() => {
game.phaseInterceptor.restoreOg();
});
it("should have the correct properties", async () => {
await game.runToMysteryEncounter(MysteryEncounterType.FIELD_TRIP, defaultParty);
expect(FieldTripEncounter.encounterType).toBe(MysteryEncounterType.FIELD_TRIP);
expect(FieldTripEncounter.encounterTier).toBe(MysteryEncounterTier.COMMON);
expect(FieldTripEncounter.dialogue).toBeDefined();
expect(FieldTripEncounter.dialogue.intro).toStrictEqual([
{
text: `${namespace}:intro`,
},
{
speaker: `${namespace}:speaker`,
text: `${namespace}:intro_dialogue`,
},
]);
expect(FieldTripEncounter.dialogue.encounterOptionsDialogue?.title).toBe(`${namespace}:title`);
expect(FieldTripEncounter.dialogue.encounterOptionsDialogue?.description).toBe(`${namespace}:description`);
expect(FieldTripEncounter.dialogue.encounterOptionsDialogue?.query).toBe(`${namespace}:query`);
expect(FieldTripEncounter.options.length).toBe(3);
});
describe("Option 1 - Show off a physical move", () => {
it("should have the correct properties", () => {
const option = FieldTripEncounter.options[0];
expect(option.optionMode).toBe(MysteryEncounterOptionMode.DEFAULT);
expect(option.dialogue).toBeDefined();
expect(option.dialogue).toStrictEqual({
buttonLabel: `${namespace}:option.1.label`,
buttonTooltip: `${namespace}:option.1.tooltip`,
secondOptionPrompt: `${namespace}:second_option_prompt`,
});
});
it("Should give no reward on incorrect option", async () => {
await game.runToMysteryEncounter(MysteryEncounterType.FIELD_TRIP, defaultParty);
await runMysteryEncounterToEnd(game, 1, { pokemonNo: 1, optionNo: 2 });
await game.phaseInterceptor.to(SelectRewardPhase);
expect(scene.ui.getMode()).to.equal(UiMode.REWARD_SELECT);
const rewardSelectHandler = scene.ui.handlers.find(
h => h instanceof RewardSelectUiHandler,
) as RewardSelectUiHandler;
expect(rewardSelectHandler.options.length).toEqual(0);
});
it("Should give proper allRewards on correct Physical move option", async () => {
await game.runToMysteryEncounter(MysteryEncounterType.FIELD_TRIP, defaultParty);
await runMysteryEncounterToEnd(game, 1, { pokemonNo: 1, optionNo: 1 });
await game.phaseInterceptor.to(SelectRewardPhase);
expect(scene.ui.getMode()).to.equal(UiMode.REWARD_SELECT);
const rewardSelectHandler = scene.ui.handlers.find(
h => h instanceof RewardSelectUiHandler,
) as RewardSelectUiHandler;
expect(rewardSelectHandler.options.length).toEqual(5);
expect(rewardSelectHandler.options[0].rewardOption.type.name).toBe(
i18next.t("modifierType:TempStatStageBoosterItem.x_attack"),
);
expect(rewardSelectHandler.options[1].rewardOption.type.name).toBe(
i18next.t("modifierType:TempStatStageBoosterItem.x_defense"),
);
expect(rewardSelectHandler.options[2].rewardOption.type.name).toBe(
i18next.t("modifierType:TempStatStageBoosterItem.x_speed"),
);
expect(rewardSelectHandler.options[3].rewardOption.type.name).toBe(
i18next.t("modifierType:ModifierType.DIRE_HIT.name"),
);
expect(rewardSelectHandler.options[4].rewardOption.type.name).toBe(
i18next.t("modifierType:ModifierType.RARER_CANDY.name"),
);
});
it("should leave encounter without battle", async () => {
const leaveEncounterWithoutBattleSpy = vi.spyOn(EncounterPhaseUtils, "leaveEncounterWithoutBattle");
await game.runToMysteryEncounter(MysteryEncounterType.FIELD_TRIP, defaultParty);
await runMysteryEncounterToEnd(game, 1, { pokemonNo: 1, optionNo: 1 });
expect(leaveEncounterWithoutBattleSpy).toBeCalled();
});
});
describe("Option 2 - Give Food", () => {
it("should have the correct properties", () => {
const option = FieldTripEncounter.options[1];
expect(option.optionMode).toBe(MysteryEncounterOptionMode.DEFAULT);
expect(option.dialogue).toBeDefined();
expect(option.dialogue).toStrictEqual({
buttonLabel: `${namespace}:option.2.label`,
buttonTooltip: `${namespace}:option.2.tooltip`,
secondOptionPrompt: `${namespace}:second_option_prompt`,
});
});
it("Should give no reward on incorrect option", async () => {
await game.runToMysteryEncounter(MysteryEncounterType.FIELD_TRIP, defaultParty);
await runMysteryEncounterToEnd(game, 2, { pokemonNo: 1, optionNo: 1 });
await game.phaseInterceptor.to(SelectRewardPhase);
expect(scene.ui.getMode()).to.equal(UiMode.REWARD_SELECT);
const rewardSelectHandler = scene.ui.handlers.find(
h => h instanceof RewardSelectUiHandler,
) as RewardSelectUiHandler;
expect(rewardSelectHandler.options.length).toEqual(0);
});
it("Should give proper allRewards on correct Special move option", async () => {
await game.runToMysteryEncounter(MysteryEncounterType.FIELD_TRIP, defaultParty);
await runMysteryEncounterToEnd(game, 2, { pokemonNo: 1, optionNo: 2 });
await game.phaseInterceptor.to(SelectRewardPhase);
expect(scene.ui.getMode()).to.equal(UiMode.REWARD_SELECT);
const rewardSelectHandler = scene.ui.handlers.find(
h => h instanceof RewardSelectUiHandler,
) as RewardSelectUiHandler;
expect(rewardSelectHandler.options.length).toEqual(5);
expect(rewardSelectHandler.options[0].rewardOption.type.name).toBe(
i18next.t("modifierType:TempStatStageBoosterItem.x_sp_atk"),
);
expect(rewardSelectHandler.options[1].rewardOption.type.name).toBe(
i18next.t("modifierType:TempStatStageBoosterItem.x_sp_def"),
);
expect(rewardSelectHandler.options[2].rewardOption.type.name).toBe(
i18next.t("modifierType:TempStatStageBoosterItem.x_speed"),
);
expect(rewardSelectHandler.options[3].rewardOption.type.name).toBe(
i18next.t("modifierType:ModifierType.DIRE_HIT.name"),
);
expect(rewardSelectHandler.options[4].rewardOption.type.name).toBe(
i18next.t("modifierType:ModifierType.RARER_CANDY.name"),
);
});
it("should leave encounter without battle", async () => {
const leaveEncounterWithoutBattleSpy = vi.spyOn(EncounterPhaseUtils, "leaveEncounterWithoutBattle");
await game.runToMysteryEncounter(MysteryEncounterType.FIELD_TRIP, defaultParty);
await runMysteryEncounterToEnd(game, 2, { pokemonNo: 1, optionNo: 2 });
expect(leaveEncounterWithoutBattleSpy).toBeCalled();
});
});
describe("Option 3 - Give Item", () => {
it("should have the correct properties", () => {
const option = FieldTripEncounter.options[2];
expect(option.optionMode).toBe(MysteryEncounterOptionMode.DEFAULT);
expect(option.dialogue).toBeDefined();
expect(option.dialogue).toStrictEqual({
buttonLabel: `${namespace}:option.3.label`,
buttonTooltip: `${namespace}:option.3.tooltip`,
secondOptionPrompt: `${namespace}:second_option_prompt`,
});
});
it("Should give no reward on incorrect option", async () => {
await game.runToMysteryEncounter(MysteryEncounterType.FIELD_TRIP, defaultParty);
await runMysteryEncounterToEnd(game, 3, { pokemonNo: 1, optionNo: 1 });
await game.phaseInterceptor.to(SelectRewardPhase);
expect(scene.ui.getMode()).to.equal(UiMode.REWARD_SELECT);
const rewardSelectHandler = scene.ui.handlers.find(
h => h instanceof RewardSelectUiHandler,
) as RewardSelectUiHandler;
expect(rewardSelectHandler.options.length).toEqual(0);
});
it("Should give proper allRewards on correct Special move option", async () => {
vi.spyOn(i18next, "t");
await game.runToMysteryEncounter(MysteryEncounterType.FIELD_TRIP, defaultParty);
await runMysteryEncounterToEnd(game, 3, { pokemonNo: 1, optionNo: 3 });
await game.phaseInterceptor.to(SelectRewardPhase);
expect(scene.ui.getMode()).to.equal(UiMode.REWARD_SELECT);
const rewardSelectHandler = scene.ui.handlers.find(
h => h instanceof RewardSelectUiHandler,
) as RewardSelectUiHandler;
expect(rewardSelectHandler.options.length).toEqual(5);
expect(rewardSelectHandler.options[0].rewardOption.type.name).toBe(
i18next.t("modifierType:TempStatStageBoosterItem.x_accuracy"),
);
expect(rewardSelectHandler.options[1].rewardOption.type.name).toBe(
i18next.t("modifierType:TempStatStageBoosterItem.x_speed"),
);
expect(rewardSelectHandler.options[2].rewardOption.type.name).toBe(
i18next.t("modifierType:ModifierType.AddPokeballModifierType.name", {
modifierCount: 5,
pokeballName: i18next.t("pokeball:greatBall"),
}),
);
expect(i18next.t).toHaveBeenCalledWith(
"modifierType:ModifierType.AddPokeballModifierType.name",
expect.objectContaining({ modifierCount: 5 }),
);
expect(rewardSelectHandler.options[3].rewardOption.type.name).toBe(
i18next.t("modifierType:ModifierType.IV_SCANNER.name"),
);
expect(rewardSelectHandler.options[4].rewardOption.type.name).toBe(
i18next.t("modifierType:ModifierType.RARER_CANDY.name"),
);
});
it("should leave encounter without battle", async () => {
const leaveEncounterWithoutBattleSpy = vi.spyOn(EncounterPhaseUtils, "leaveEncounterWithoutBattle");
await game.runToMysteryEncounter(MysteryEncounterType.FIELD_TRIP, defaultParty);
await runMysteryEncounterToEnd(game, 2, { pokemonNo: 1, optionNo: 3 });
expect(leaveEncounterWithoutBattleSpy).toBeCalled();
});
});
});