From a6d5fc66f276674cfff9e77b8c3037697359094c Mon Sep 17 00:00:00 2001 From: "Amani H." <109637146+xsn34kzx@users.noreply.github.com> Date: Wed, 11 Sep 2024 20:56:58 -0400 Subject: [PATCH] =?UTF-8?q?[Balance]=20Disable=20Eviolite=20for=20G-Max=20?= =?UTF-8?q?Pok=C3=A9mon=20(#4184)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * [Balance] Disable Eviolite for G-Max Pokémon * Add Documentation --- src/modifier/modifier.ts | 13 ++ src/test/items/eviolite.test.ts | 279 ++++++++++++++------------------ 2 files changed, 135 insertions(+), 157 deletions(-) diff --git a/src/modifier/modifier.ts b/src/modifier/modifier.ts index f5c80618396..9273eb42b90 100644 --- a/src/modifier/modifier.ts +++ b/src/modifier/modifier.ts @@ -29,6 +29,7 @@ import { Abilities } from "#app/enums/abilities"; import { LearnMovePhase } from "#app/phases/learn-move-phase"; import { LevelUpPhase } from "#app/phases/level-up-phase"; import { PokemonHealPhase } from "#app/phases/pokemon-heal-phase"; +import { SpeciesFormKey } from "#app/data/pokemon-species"; export type ModifierPredicate = (modifier: Modifier) => boolean; @@ -923,6 +924,18 @@ export class EvolutionStatBoosterModifier extends StatBoosterModifier { return modifier instanceof EvolutionStatBoosterModifier; } + /** + * Checks if the stat boosts can apply and if the holder is not currently + * Gigantamax'd. + * @param args [0] {@linkcode Pokemon} that holds the held item + * [1] {@linkcode Stat} N/A + * [2] {@linkcode Utils.NumberHolder} N/A + * @returns true if the stat boosts can be applied, false otherwise + */ + shouldApply(args: any[]): boolean { + return super.shouldApply(args) && ((args[0] as Pokemon).getFormKey() !== SpeciesFormKey.GIGANTAMAX); + } + /** * Boosts the incoming stat value by a {@linkcode multiplier} if the holder * can evolve. Note that, if the holder is a fusion, they will receive diff --git a/src/test/items/eviolite.test.ts b/src/test/items/eviolite.test.ts index 83b00583893..d9991d47a89 100644 --- a/src/test/items/eviolite.test.ts +++ b/src/test/items/eviolite.test.ts @@ -1,16 +1,15 @@ import { Stat } from "#enums/stat"; -import { EvolutionStatBoosterModifier } from "#app/modifier/modifier"; -import { modifierTypes } from "#app/modifier/modifier-type"; -import i18next from "#app/plugins/i18n"; -import * as Utils from "#app/utils"; import { Species } from "#enums/species"; import GameManager from "#test/utils/gameManager"; import Phase from "phaser"; +import * as Utils from "#app/utils"; import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest"; +import { StatBoosterModifier } from "#app/modifier/modifier"; describe("Items - Eviolite", () => { let phaserGame: Phaser.Game; let game: GameManager; + const TIMEOUT = 20 * 1000; beforeAll(() => { phaserGame = new Phase.Game({ @@ -25,108 +24,65 @@ describe("Items - Eviolite", () => { beforeEach(() => { game = new GameManager(phaserGame); - game.override.battleType("single"); + game.override + .battleType("single") + .startingHeldItems([{ name: "EVIOLITE" }]); }); - it("EVIOLITE activates in battle correctly", async() => { - game.override.startingHeldItems([{ name: "EVIOLITE" }]); - const consoleSpy = vi.spyOn(console, "log"); - await game.startBattle([ + it("should provide 50% boost to DEF and SPDEF for unevolved, unfused pokemon", async() => { + await game.classicMode.startBattle([ Species.PICHU ]); - const partyMember = game.scene.getParty()[0]; + const partyMember = game.scene.getPlayerPokemon()!; - // Checking console log to make sure Eviolite is applied when getEffectiveStat (with the appropriate stat) is called - partyMember.getEffectiveStat(Stat.DEF); - expect(consoleSpy).toHaveBeenLastCalledWith("Applied", i18next.t("modifierType:ModifierType.EVIOLITE.name"), ""); + vi.spyOn(partyMember, "getEffectiveStat").mockImplementation((stat, _opponent?, _move?, _isCritical?) => { + const statValue = new Utils.NumberHolder(partyMember.getStat(stat, false)); + game.scene.applyModifiers(StatBoosterModifier, partyMember.isPlayer(), partyMember, stat, statValue); - // Printing dummy console messages along the way so subsequent checks don't pass because of the first - console.log(""); + // Ignore other calculations for simplicity - partyMember.getEffectiveStat(Stat.SPDEF); - expect(consoleSpy).toHaveBeenLastCalledWith("Applied", i18next.t("modifierType:ModifierType.EVIOLITE.name"), ""); + return Math.floor(statValue.value); + }); - console.log(""); + const defStat = partyMember.getStat(Stat.DEF, false); + const spDefStat = partyMember.getStat(Stat.SPDEF, false); - partyMember.getEffectiveStat(Stat.ATK); - expect(consoleSpy).not.toHaveBeenLastCalledWith("Applied", i18next.t("modifierType:ModifierType.EVIOLITE.name"), ""); + expect(partyMember.getEffectiveStat(Stat.DEF)).toBe(Math.floor(defStat * 1.5)); + expect(partyMember.getEffectiveStat(Stat.SPDEF)).toBe(Math.floor(spDefStat * 1.5)); + }, TIMEOUT); - console.log(""); - - partyMember.getEffectiveStat(Stat.SPATK); - expect(consoleSpy).not.toHaveBeenLastCalledWith("Applied", i18next.t("modifierType:ModifierType.EVIOLITE.name"), ""); - - console.log(""); - - partyMember.getEffectiveStat(Stat.SPD); - expect(consoleSpy).not.toHaveBeenLastCalledWith("Applied", i18next.t("modifierType:ModifierType.EVIOLITE.name"), ""); - }); - - it("EVIOLITE held by unevolved, unfused pokemon", async() => { - await game.startBattle([ - Species.PICHU - ]); - - const partyMember = game.scene.getParty()[0]; - - const defStat = partyMember.getStat(Stat.DEF); - const spDefStat = partyMember.getStat(Stat.SPDEF); - - // Making sure modifier is not applied without holding item - const defValue = new Utils.NumberHolder(defStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - const spDefValue = new Utils.NumberHolder(spDefStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); - - expect(defValue.value / defStat).toBe(1); - expect(spDefValue.value / spDefStat).toBe(1); - - // Giving Eviolite to party member and testing if it applies - partyMember.scene.addModifier(modifierTypes.EVIOLITE().newModifier(partyMember), true); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); - - expect(defValue.value / defStat).toBe(1.5); - expect(spDefValue.value / spDefStat).toBe(1.5); - }, 20000); - - it("EVIOLITE held by fully evolved, unfused pokemon", async() => { - await game.startBattle([ + it("should not provide a boost for fully evolved, unfused pokemon", async() => { + await game.classicMode.startBattle([ Species.RAICHU, ]); const partyMember = game.scene.getParty()[0]; - const defStat = partyMember.getStat(Stat.DEF); - const spDefStat = partyMember.getStat(Stat.SPDEF); + vi.spyOn(partyMember, "getEffectiveStat").mockImplementation((stat, _opponent?, _move?, _isCritical?) => { + const statValue = new Utils.NumberHolder(partyMember.getStat(stat, false)); + game.scene.applyModifiers(StatBoosterModifier, partyMember.isPlayer(), partyMember, stat, statValue); - // Making sure modifier is not applied without holding item - const defValue = new Utils.NumberHolder(defStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - const spDefValue = new Utils.NumberHolder(spDefStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); + // Ignore other calculations for simplicity - expect(defValue.value / defStat).toBe(1); - expect(spDefValue.value / spDefStat).toBe(1); + return Math.floor(statValue.value); + }); - // Giving Eviolite to party member and testing if it applies - partyMember.scene.addModifier(modifierTypes.EVIOLITE().newModifier(partyMember), true); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); + const defStat = partyMember.getStat(Stat.DEF, false); + const spDefStat = partyMember.getStat(Stat.SPDEF, false); - expect(defValue.value / defStat).toBe(1); - expect(spDefValue.value / spDefStat).toBe(1); - }, 20000); + expect(partyMember.getEffectiveStat(Stat.DEF)).toBe(defStat); + expect(partyMember.getEffectiveStat(Stat.SPDEF)).toBe(spDefStat); - it("EVIOLITE held by completely unevolved, fused pokemon", async() => { - await game.startBattle([ + }, TIMEOUT); + + it("should provide 50% boost to DEF and SPDEF for completely unevolved, fused pokemon", async() => { + await game.classicMode.startBattle([ Species.PICHU, Species.CLEFFA ]); - const partyMember = game.scene.getParty()[0]; - const ally = game.scene.getParty()[1]; + const [ partyMember, ally ] = game.scene.getParty(); // Fuse party members (taken from PlayerPokemon.fuse(...) function) partyMember.fusionSpecies = ally.species; @@ -137,35 +93,29 @@ describe("Items - Eviolite", () => { partyMember.fusionGender = ally.gender; partyMember.fusionLuck = ally.luck; - const defStat = partyMember.getStat(Stat.DEF); - const spDefStat = partyMember.getStat(Stat.SPDEF); + vi.spyOn(partyMember, "getEffectiveStat").mockImplementation((stat, _opponent?, _move?, _isCritical?) => { + const statValue = new Utils.NumberHolder(partyMember.getStat(stat, false)); + game.scene.applyModifiers(StatBoosterModifier, partyMember.isPlayer(), partyMember, stat, statValue); - // Making sure modifier is not applied without holding item - const defValue = new Utils.NumberHolder(defStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - const spDefValue = new Utils.NumberHolder(spDefStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); + // Ignore other calculations for simplicity - expect(defValue.value / defStat).toBe(1); - expect(spDefValue.value / spDefStat).toBe(1); + return Math.floor(statValue.value); + }); - // Giving Eviolite to party member and testing if it applies - partyMember.scene.addModifier(modifierTypes.EVIOLITE().newModifier(partyMember), true); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); + const defStat = partyMember.getStat(Stat.DEF, false); + const spDefStat = partyMember.getStat(Stat.SPDEF, false); - expect(defValue.value / defStat).toBe(1.5); - expect(spDefValue.value / spDefStat).toBe(1.5); - }, 20000); + expect(partyMember.getEffectiveStat(Stat.DEF)).toBe(Math.floor(defStat * 1.5)); + expect(partyMember.getEffectiveStat(Stat.SPDEF)).toBe(Math.floor(spDefStat * 1.5)); + }, TIMEOUT); - it("EVIOLITE held by partially unevolved (base), fused pokemon", async() => { - await game.startBattle([ + it("should provide 25% boost to DEF and SPDEF for partially unevolved (base), fused pokemon", async() => { + await game.classicMode.startBattle([ Species.PICHU, Species.CLEFABLE ]); - const partyMember = game.scene.getParty()[0]; - const ally = game.scene.getParty()[1]; + const [ partyMember, ally ] = game.scene.getParty(); // Fuse party members (taken from PlayerPokemon.fuse(...) function) partyMember.fusionSpecies = ally.species; @@ -176,35 +126,29 @@ describe("Items - Eviolite", () => { partyMember.fusionGender = ally.gender; partyMember.fusionLuck = ally.luck; - const defStat = partyMember.getStat(Stat.DEF); - const spDefStat = partyMember.getStat(Stat.SPDEF); + vi.spyOn(partyMember, "getEffectiveStat").mockImplementation((stat, _opponent?, _move?, _isCritical?) => { + const statValue = new Utils.NumberHolder(partyMember.getStat(stat, false)); + game.scene.applyModifiers(StatBoosterModifier, partyMember.isPlayer(), partyMember, stat, statValue); - // Making sure modifier is not applied without holding item - const defValue = new Utils.NumberHolder(defStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - const spDefValue = new Utils.NumberHolder(spDefStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); + // Ignore other calculations for simplicity - expect(defValue.value / defStat).toBe(1); - expect(spDefValue.value / spDefStat).toBe(1); + return Math.floor(statValue.value); + }); - // Giving Eviolite to party member and testing if it applies - partyMember.scene.addModifier(modifierTypes.EVIOLITE().newModifier(partyMember), true); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); + const defStat = partyMember.getStat(Stat.DEF, false); + const spDefStat = partyMember.getStat(Stat.SPDEF, false); - expect(defValue.value / defStat).toBe(1.25); - expect(spDefValue.value / spDefStat).toBe(1.25); - }, 20000); + expect(partyMember.getEffectiveStat(Stat.DEF)).toBe(Math.floor(defStat * 1.25)); + expect(partyMember.getEffectiveStat(Stat.SPDEF)).toBe(Math.floor(spDefStat * 1.25)); + }, TIMEOUT); - it("EVIOLITE held by partially unevolved (fusion), fused pokemon", async() => { - await game.startBattle([ + it("should provide 25% boost to DEF and SPDEF for partially unevolved (fusion), fused pokemon", async() => { + await game.classicMode.startBattle([ Species.RAICHU, Species.CLEFFA ]); - const partyMember = game.scene.getParty()[0]; - const ally = game.scene.getParty()[1]; + const [ partyMember, ally ] = game.scene.getParty(); // Fuse party members (taken from PlayerPokemon.fuse(...) function) partyMember.fusionSpecies = ally.species; @@ -215,35 +159,29 @@ describe("Items - Eviolite", () => { partyMember.fusionGender = ally.gender; partyMember.fusionLuck = ally.luck; - const defStat = partyMember.getStat(Stat.DEF); - const spDefStat = partyMember.getStat(Stat.SPDEF); + vi.spyOn(partyMember, "getEffectiveStat").mockImplementation((stat, _opponent?, _move?, _isCritical?) => { + const statValue = new Utils.NumberHolder(partyMember.getStat(stat, false)); + game.scene.applyModifiers(StatBoosterModifier, partyMember.isPlayer(), partyMember, stat, statValue); - // Making sure modifier is not applied without holding item - const defValue = new Utils.NumberHolder(defStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - const spDefValue = new Utils.NumberHolder(spDefStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); + // Ignore other calculations for simplicity - expect(defValue.value / defStat).toBe(1); - expect(spDefValue.value / spDefStat).toBe(1); + return Math.floor(statValue.value); + }); - // Giving Eviolite to party member and testing if it applies - partyMember.scene.addModifier(modifierTypes.EVIOLITE().newModifier(partyMember), true); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); + const defStat = partyMember.getStat(Stat.DEF, false); + const spDefStat = partyMember.getStat(Stat.SPDEF, false); - expect(defValue.value / defStat).toBe(1.25); - expect(spDefValue.value / spDefStat).toBe(1.25); - }, 20000); + expect(partyMember.getEffectiveStat(Stat.DEF)).toBe(Math.floor(defStat * 1.25)); + expect(partyMember.getEffectiveStat(Stat.SPDEF)).toBe(Math.floor(spDefStat * 1.25)); + }, TIMEOUT); - it("EVIOLITE held by completely evolved, fused pokemon", async() => { - await game.startBattle([ + it("should not provide a boost for fully evolved, fused pokemon", async() => { + await game.classicMode.startBattle([ Species.RAICHU, Species.CLEFABLE ]); - const partyMember = game.scene.getParty()[0]; - const ally = game.scene.getParty()[1]; + const [ partyMember, ally ] = game.scene.getParty(); // Fuse party members (taken from PlayerPokemon.fuse(...) function) partyMember.fusionSpecies = ally.species; @@ -254,24 +192,51 @@ describe("Items - Eviolite", () => { partyMember.fusionGender = ally.gender; partyMember.fusionLuck = ally.luck; - const defStat = partyMember.getStat(Stat.DEF); - const spDefStat = partyMember.getStat(Stat.SPDEF); + vi.spyOn(partyMember, "getEffectiveStat").mockImplementation((stat, _opponent?, _move?, _isCritical?) => { + const statValue = new Utils.NumberHolder(partyMember.getStat(stat, false)); + game.scene.applyModifiers(StatBoosterModifier, partyMember.isPlayer(), partyMember, stat, statValue); - // Making sure modifier is not applied without holding item - const defValue = new Utils.NumberHolder(defStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - const spDefValue = new Utils.NumberHolder(spDefStat); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); + // Ignore other calculations for simplicity - expect(defValue.value / defStat).toBe(1); - expect(spDefValue.value / spDefStat).toBe(1); + return Math.floor(statValue.value); + }); - // Giving Eviolite to party member and testing if it applies - partyMember.scene.addModifier(modifierTypes.EVIOLITE().newModifier(partyMember), true); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.DEF, defValue); - partyMember.scene.applyModifiers(EvolutionStatBoosterModifier, true, partyMember, Stat.SPDEF, spDefValue); + const defStat = partyMember.getStat(Stat.DEF, false); + const spDefStat = partyMember.getStat(Stat.SPDEF, false); - expect(defValue.value / defStat).toBe(1); - expect(spDefValue.value / spDefStat).toBe(1); - }, 20000); + expect(partyMember.getEffectiveStat(Stat.DEF)).toBe(defStat); + expect(partyMember.getEffectiveStat(Stat.SPDEF)).toBe(spDefStat); + }, TIMEOUT); + + it("should not provide a boost for Gigantamax Pokémon", async() => { + game.override.starterForms({ + [Species.PIKACHU]: 8, + [Species.EEVEE]: 2, + [Species.DURALUDON]: 1, + [Species.MEOWTH]: 1 + }); + + const gMaxablePokemon = [ Species.PIKACHU, Species.EEVEE, Species.DURALUDON, Species.MEOWTH ]; + + await game.classicMode.startBattle([ + Utils.randItem(gMaxablePokemon) + ]); + + const partyMember = game.scene.getPlayerPokemon()!; + + vi.spyOn(partyMember, "getEffectiveStat").mockImplementation((stat, _opponent?, _move?, _isCritical?) => { + const statValue = new Utils.NumberHolder(partyMember.getStat(stat, false)); + game.scene.applyModifiers(StatBoosterModifier, partyMember.isPlayer(), partyMember, stat, statValue); + + // Ignore other calculations for simplicity + + return Math.floor(statValue.value); + }); + + const defStat = partyMember.getStat(Stat.DEF, false); + const spDefStat = partyMember.getStat(Stat.SPDEF, false); + + expect(partyMember.getEffectiveStat(Stat.DEF)).toBe(defStat); + expect(partyMember.getEffectiveStat(Stat.SPDEF)).toBe(spDefStat); + }, TIMEOUT); });