Merge fa5a42791e into 106ed6b27b

* Using default animation for errors that occur.

* Renaming function to make it clear that logging happens

* Updating logging for missing animations

* Missed committing linter changes

* Update src/data/battle-anims.ts

Co-authored-by: NightKev <34855794+DayKev@users.noreply.github.com>

* Update src/data/battle-anims.ts

Co-authored-by: NightKev <34855794+DayKev@users.noreply.github.com>

* Update src/data/battle-anims.ts

Co-authored-by: NightKev <34855794+DayKev@users.noreply.github.com>

---------

Co-authored-by: NightKev <34855794+DayKev@users.noreply.github.com>
Co-authored-by: flx-sta <50131232+flx-sta@users.noreply.github.com>

README.md

@@ -55,7 +55,7 @@ Check out [Github Issues](https://github.com/pagefaultgames/pokerogue/issues) to
   - Pokémon Sword/Shield
   - Pokémon Legends: Arceus
   - Pokémon Scarlet/Violet
-  - Firel (Custom Laboratory, Metropolis, Seabed, and Space biome music)
+  - Firel (Custom Ice Cave, Laboratory, Metropolis, Plains, Power Plant, Seabed, Space, and Volcano biome music)
   - Lmz (Custom Jungle biome music)
   - Andr06 (Custom Slum and Sea biome music)
 

src/data/ability.ts

@@ -2625,7 +2625,11 @@ export class PreStatStageChangeAbAttr extends AbAttr {
   }
 }
 
+/**
+ * Protect one or all {@linkcode BattleStat} from reductions caused by other Pokémon's moves and Abilities
+ */
 export class ProtectStatAbAttr extends PreStatStageChangeAbAttr {
+  /** {@linkcode BattleStat} to protect or `undefined` if **all** {@linkcode BattleStat} are protected */
   private protectedStat?: BattleStat;
 
   constructor(protectedStat?: BattleStat) {
@@ -2634,7 +2638,17 @@ export class ProtectStatAbAttr extends PreStatStageChangeAbAttr {
     this.protectedStat = protectedStat;
   }
 
-  applyPreStatStageChange(_pokemon: Pokemon, _passive: boolean, simulated: boolean, stat: BattleStat, cancelled: Utils.BooleanHolder, _args: any[]): boolean {
+  /**
+   * Apply the {@linkcode ProtectedStatAbAttr} to an interaction
+   * @param _pokemon
+   * @param _passive
+   * @param simulated
+   * @param stat the {@linkcode BattleStat} being affected
+   * @param cancelled The {@linkcode Utils.BooleanHolder} that will be set to true if the stat is protected
+   * @param _args
+   * @returns true if the stat is protected, false otherwise
+   */
+  applyPreStatStageChange(_pokemon: Pokemon, _passive: boolean, _simulated: boolean, stat: BattleStat, cancelled: Utils.BooleanHolder, _args: any[]): boolean {
     if (Utils.isNullOrUndefined(this.protectedStat) || stat === this.protectedStat) {
       cancelled.value = true;
       return true;
@@ -3757,7 +3771,7 @@ export class StatStageChangeMultiplierAbAttr extends AbAttr {
     this.multiplier = multiplier;
   }
 
-  apply(pokemon: Pokemon, passive: boolean, simulated: boolean, cancelled: Utils.BooleanHolder, args: any[]): boolean {
+  override apply(pokemon: Pokemon, passive: boolean, simulated: boolean, cancelled: Utils.BooleanHolder, args: any[]): boolean {
     (args[0] as Utils.IntegerHolder).value *= this.multiplier;
 
     return true;

src/data/battle-anims.ts

@@ -488,14 +488,14 @@ export function initMoveAnim(scene: BattleScene, move: Moves): Promise<void> {
     } else {
       moveAnims.set(move, null);
       const defaultMoveAnim = allMoves[move] instanceof AttackMove ? Moves.TACKLE : allMoves[move] instanceof SelfStatusMove ? Moves.FOCUS_ENERGY : Moves.TAIL_WHIP;
-      const moveName = Moves[move].toLowerCase().replace(/\_/g, "-");
+
       const fetchAnimAndResolve = (move: Moves) => {
-        scene.cachedFetch(`./battle-anims/${moveName}.json`)
+        scene.cachedFetch(`./battle-anims/${Utils.animationFileName(move)}.json`)
           .then(response => {
             const contentType = response.headers.get("content-type");
             if (!response.ok || contentType?.indexOf("application/json") === -1) {
-              console.error(`Could not load animation file for move '${moveName}'`, response.status, response.statusText);
-              populateMoveAnim(move, moveAnims.get(defaultMoveAnim));
+              useDefaultAnim(move, defaultMoveAnim);
+              logMissingMoveAnim(move, response.status, response.statusText);
               return resolve();
             }
             return response.json();
@@ -515,6 +515,11 @@ export function initMoveAnim(scene: BattleScene, move: Moves): Promise<void> {
             } else {
               resolve();
             }
+          })
+          .catch(error => {
+            useDefaultAnim(move, defaultMoveAnim);
+            logMissingMoveAnim(move, error);
+            return resolve();
           });
       };
       fetchAnimAndResolve(move);
@@ -522,6 +527,29 @@ export function initMoveAnim(scene: BattleScene, move: Moves): Promise<void> {
   });
 }
 
+/**
+ * Populates the default animation for the given move.
+ *
+ * @param move the move to populate an animation for
+ * @param defaultMoveAnim the move to use as the default animation
+ */
+function useDefaultAnim(move: Moves, defaultMoveAnim: Moves) {
+  populateMoveAnim(move, moveAnims.get(defaultMoveAnim));
+}
+
+/**
+ * Helper method for printing a warning to the console when a move animation is missing.
+ *
+ * @param move the move to populate an animation for
+ * @param optionalParams parameters to add to the error logging
+ *
+ * @remarks use {@linkcode useDefaultAnim} to use a default animation
+ */
+function logMissingMoveAnim(move: Moves, ...optionalParams: any[]) {
+  const moveName = Utils.animationFileName(move);
+  console.warn(`Could not load animation file for move '${moveName}'`, ...optionalParams);
+}
+
 /**
  * Fetches animation configs to be used in a Mystery Encounter
  * @param scene

src/field/arena.ts

@@ -746,7 +746,7 @@ export class Arena {
     case Biome.TOWN:
       return 7.288;
     case Biome.PLAINS:
-      return 7.693;
+      return 17.485;
     case Biome.GRASS:
       return 1.995;
     case Biome.TALL_GRASS:
@@ -774,13 +774,13 @@ export class Arena {
     case Biome.DESERT:
       return 1.143;
     case Biome.ICE_CAVE:
-      return 15.010;
+      return 0.000;
     case Biome.MEADOW:
       return 3.891;
     case Biome.POWER_PLANT:
-      return 2.810;
+      return 9.447;
     case Biome.VOLCANO:
-      return 5.116;
+      return 17.637;
     case Biome.GRAVEYARD:
       return 3.232;
     case Biome.DOJO:

src/field/pokemon.ts

@@ -1273,13 +1273,13 @@ export default abstract class Pokemon extends Phaser.GameObjects.Container {
    * @param attrType {@linkcode AbAttr} The ability attribute to check for.
    * @param canApply {@linkcode Boolean} If false, it doesn't check whether the ability is currently active
    * @param ignoreOverride {@linkcode Boolean} If true, it ignores ability changing effects
-   * @returns {AbAttr[]} A list of all the ability attributes on this ability.
+   * @returns A list of all the ability attributes on this ability.
    */
-  getAbilityAttrs(attrType: { new(...args: any[]): AbAttr }, canApply: boolean = true, ignoreOverride?: boolean): AbAttr[] {
-    const abilityAttrs: AbAttr[] = [];
+  getAbilityAttrs<T extends AbAttr = AbAttr>(attrType: { new(...args: any[]): T }, canApply: boolean = true, ignoreOverride?: boolean): T[] {
+    const abilityAttrs: T[] = [];
 
     if (!canApply || this.canApplyAbility()) {
-      abilityAttrs.push(...this.getAbility(ignoreOverride).getAttrs(attrType));
+      abilityAttrs.push(...this.getAbility(ignoreOverride).getAttrs<T>(attrType));
     }
 
     if (!canApply || this.canApplyAbility(true)) {

src/locales/en/bgm-name.json

@@ -108,7 +108,7 @@
   "forest": "PMD EoS Dusk Forest",
   "grass": "PMD EoS Apple Woods",
   "graveyard": "PMD EoS Mystifying Forest",
-  "ice_cave": "PMD EoS Vast Ice Mountain",
+  "ice_cave": "Firel - -60F",
   "island": "PMD EoS Craggy Coast",
   "jungle": "Lmz - Jungle",
   "laboratory": "Firel - Laboratory",
@@ -116,8 +116,8 @@
   "meadow": "PMD EoS Sky Peak Forest",
   "metropolis": "Firel - Metropolis",
   "mountain": "PMD EoS Mt. Horn",
-  "plains": "PMD EoS Sky Peak Prairie",
-  "power_plant": "PMD EoS Far Amp Plains",
+  "plains": "Firel - Route 888",
+  "power_plant": "Firel - The Klink",
   "ruins": "PMD EoS Deep Sealed Ruin",
   "sea": "Andr06 - Marine Mystique",
   "seabed": "Firel - Seabed",
@@ -128,7 +128,7 @@
   "tall_grass": "PMD EoS Foggy Forest",
   "temple": "PMD EoS Aegis Cave",
   "town": "PMD EoS Random Dungeon Theme 3",
-  "volcano": "PMD EoS Steam Cave",
+  "volcano": "Firel - Twisturn Volcano",
   "wasteland": "PMD EoS Hidden Highland",
   "encounter_ace_trainer": "BW Trainers' Eyes Meet (Ace Trainer)",
   "encounter_backpacker": "BW Trainers' Eyes Meet (Backpacker)",

src/phases/stat-stage-change-phase.ts

@@ -6,7 +6,7 @@ import Pokemon from "#app/field/pokemon";
 import { getPokemonNameWithAffix } from "#app/messages";
 import { ResetNegativeStatStageModifier } from "#app/modifier/modifier";
 import { handleTutorial, Tutorial } from "#app/tutorial";
-import * as Utils from "#app/utils";
+import { NumberHolder, BooleanHolder } from "#app/utils";
 import i18next from "i18next";
 import { PokemonPhase } from "./pokemon-phase";
 import { Stat, type BattleStat, getStatKey, getStatStageChangeDescriptionKey } from "#enums/stat";
@@ -42,17 +42,23 @@ export class StatStageChangePhase extends PokemonPhase {
       return this.end();
     }
 
+    const stages = new NumberHolder(this.stages);
+
+    if (!this.ignoreAbilities) {
+      applyAbAttrs(StatStageChangeMultiplierAbAttr, pokemon, null, false, stages);
+    }
+
     let simulate = false;
 
     const filteredStats = this.stats.filter(stat => {
-      const cancelled = new Utils.BooleanHolder(false);
+      const cancelled = new BooleanHolder(false);
 
-      if (!this.selfTarget && this.stages < 0) {
+      if (!this.selfTarget && stages.value < 0) {
         // TODO: Include simulate boolean when tag applications can be simulated
         this.scene.arena.applyTagsForSide(MistTag, pokemon.isPlayer() ? ArenaTagSide.PLAYER : ArenaTagSide.ENEMY, cancelled);
       }
 
-      if (!cancelled.value && !this.selfTarget && this.stages < 0) {
+      if (!cancelled.value && !this.selfTarget && stages.value < 0) {
         applyPreStatStageChangeAbAttrs(ProtectStatAbAttr, pokemon, stat, cancelled, simulate);
       }
 
@@ -64,12 +70,6 @@ export class StatStageChangePhase extends PokemonPhase {
       return !cancelled.value;
     });
 
-    const stages = new Utils.IntegerHolder(this.stages);
-
-    if (!this.ignoreAbilities) {
-      applyAbAttrs(StatStageChangeMultiplierAbAttr, pokemon, null, false, stages);
-    }
-
     const relLevels = filteredStats.map(s => (stages.value >= 1 ? Math.min(pokemon.getStatStage(s) + stages.value, 6) : Math.max(pokemon.getStatStage(s) + stages.value, -6)) - pokemon.getStatStage(s));
 
     this.onChange && this.onChange(this.getPokemon(), filteredStats, relLevels);

src/test/abilities/contrary.test.ts

@@ -31,7 +31,7 @@ describe("Abilities - Contrary", () => {
   });
 
   it("should invert stat changes when applied", async() => {
-    await game.startBattle([
+    await game.classicMode.startBattle([
       Species.SLOWBRO
     ]);
 
@@ -39,4 +39,39 @@ describe("Abilities - Contrary", () => {
 
     expect(enemyPokemon.getStatStage(Stat.ATK)).toBe(1);
   }, 20000);
+
+  describe("With Clear Body", () => {
+    it("should apply positive effects", async () => {
+      game.override
+        .enemyPassiveAbility(Abilities.CLEAR_BODY)
+        .moveset([Moves.TAIL_WHIP]);
+      await game.classicMode.startBattle([Species.SLOWBRO]);
+
+      const enemyPokemon = game.scene.getEnemyPokemon()!;
+
+      expect(enemyPokemon.getStatStage(Stat.ATK)).toBe(1);
+
+      game.move.select(Moves.TAIL_WHIP);
+      await game.phaseInterceptor.to("TurnEndPhase");
+
+      expect(enemyPokemon.getStatStage(Stat.DEF)).toBe(1);
+    });
+
+    it("should block negative effects", async () => {
+      game.override
+        .enemyPassiveAbility(Abilities.CLEAR_BODY)
+        .enemyMoveset([Moves.HOWL, Moves.HOWL, Moves.HOWL, Moves.HOWL])
+        .moveset([Moves.SPLASH]);
+      await game.classicMode.startBattle([Species.SLOWBRO]);
+
+      const enemyPokemon = game.scene.getEnemyPokemon()!;
+
+      expect(enemyPokemon.getStatStage(Stat.ATK)).toBe(1);
+
+      game.move.select(Moves.SPLASH);
+      await game.phaseInterceptor.to("TurnEndPhase");
+
+      expect(enemyPokemon.getStatStage(Stat.ATK)).toBe(1);
+    });
+  });
 });

src/utils.ts

@@ -1,4 +1,5 @@
 import { MoneyFormat } from "#enums/money-format";
+import { Moves } from "#enums/moves";
 import i18next from "i18next";
 
 export const MissingTextureKey = "__MISSING";
@@ -628,3 +629,12 @@ export function getLocalizedSpriteKey(baseKey: string) {
 export function isBetween(num: number, min: number, max: number): boolean {
   return num >= min && num <= max;
 }
+
+/**
+ * Helper method to return the animation filename for a given move
+ *
+ * @param move the move for which the animation filename is needed
+ */
+export function animationFileName(move: Moves): string {
+  return Moves[move].toLowerCase().replace(/\_/g, "-");
+}