[Bug] Fix type-hints for immunity (#3620)

* enable mock containers to be found by name

* enable mock text to be found by name

* add test coverage for type-hints

Only for "immunity" and "status moves"

public/images/pokemon/variant/exp/800-ultra.json

@@ -1,21 +1,5 @@
 {
 	"1": {
-		"b0a080": "e552ec",
-		"f8f8e8": "ffe2ed",
-		"9b8259": "b021c5",
-		"e5e4c2": "ffb9f9",
-		"000000": "000000",
-		"bc9b4e": "900090",
-		"f8f8d0": "ff8ae9",
-		"e8e088": "ff49e7",
-		"d0b868": "d10cc7",
-		"7d673b": "510059",
-		"282828": "282828",
-		"f84040": "f84040",
-		"f88888": "1ae2e6",
-		"c81010": "00c2d2"
-	},
-	"2": {
 		"b0a080": "d96b23",
 		"f8f8e8": "ffe1b8",
 		"9b8259": "b43c06",
@@ -30,5 +14,21 @@
 		"f84040": "f84040",
 		"f88888": "f88888",
 		"c81010": "c81010"
+	},
+	"2": {
+		"b0a080": "e552ec",
+		"f8f8e8": "ffe2ed",
+		"9b8259": "b021c5",
+		"e5e4c2": "ffb9f9",
+		"000000": "000000",
+		"bc9b4e": "900090",
+		"f8f8d0": "ff8ae9",
+		"e8e088": "ff49e7",
+		"d0b868": "d10cc7",
+		"7d673b": "510059",
+		"282828": "282828",
+		"f84040": "f84040",
+		"f88888": "1ae2e6",
+		"c81010": "00c2d2"
 	}
 }

src/battle-scene.ts

@@ -2419,9 +2419,14 @@ export default class BattleScene extends SceneBase {
           count = Math.max(count, Math.floor(chances / 2));
         }
         getEnemyModifierTypesForWave(difficultyWaveIndex, count, [ enemyPokemon ], this.currentBattle.battleType === BattleType.TRAINER ? ModifierPoolType.TRAINER : ModifierPoolType.WILD, upgradeChance)
-          .map(mt => mt.newModifier(enemyPokemon).add(this.enemyModifiers, false, this));
+          .map(mt => {
+            const enemyModifier = mt.newModifier(enemyPokemon);
+            if (enemyModifier instanceof TurnHeldItemTransferModifier) {
+              enemyModifier.setTransferrableFalse();
+            }
+            enemyModifier.add(this.enemyModifiers, false, this);
+          });
       });
-
       this.updateModifiers(false).then(() => resolve());
     });
   }

src/field/pokemon.ts

@@ -921,7 +921,7 @@ export default abstract class Pokemon extends Phaser.GameObjects.Container {
    * by how many learnable moves there are for the {@linkcode Pokemon}.
    */
   getLearnableLevelMoves(): Moves[] {
-    let levelMoves = this.getLevelMoves(1, true).map(lm => lm[1]);
+    let levelMoves = this.getLevelMoves(1, true, false, true).map(lm => lm[1]);
     if (this.metBiome === -1 && !this.scene.gameMode.isFreshStartChallenge() && !this.scene.gameMode.isDaily) {
       levelMoves = this.getUnlockedEggMoves().concat(levelMoves);
     }
@@ -1210,11 +1210,11 @@ export default abstract class Pokemon extends Phaser.GameObjects.Container {
    *
    * @param source - The Pokémon using the move.
    * @param move - The move being used.
-   * @returns The type damage multiplier or undefined if it's a status move
+   * @returns The type damage multiplier or 1 if it's a status move
    */
-  getMoveEffectiveness(source: Pokemon, move: PokemonMove): TypeDamageMultiplier | undefined {
+  getMoveEffectiveness(source: Pokemon, move: PokemonMove): TypeDamageMultiplier {
     if (move.getMove().category === MoveCategory.STATUS) {
-      return undefined;
+      return 1;
     }
 
     return this.getAttackMoveEffectiveness(source, move, !this.battleData?.abilityRevealed);

src/phases.ts

@@ -4033,13 +4033,24 @@ export class FaintPhase extends PokemonPhase {
     }
 
     if (this.player) {
-      const nonFaintedLegalPartyMembers = this.scene.getParty().filter(p => p.isAllowedInBattle());
-      const nonFaintedPartyMemberCount = nonFaintedLegalPartyMembers.length;
-      if (!nonFaintedPartyMemberCount) {
+      /** The total number of Pokemon in the player's party that can legally fight */
+      const legalPlayerPokemon = this.scene.getParty().filter(p => p.isAllowedInBattle());
+      /** The total number of legal player Pokemon that aren't currently on the field */
+      const legalPlayerPartyPokemon = legalPlayerPokemon.filter(p => !p.isActive(true));
+      if (!legalPlayerPokemon.length) {
+        /** If the player doesn't have any legal Pokemon, end the game */
         this.scene.unshiftPhase(new GameOverPhase(this.scene));
-      } else if (nonFaintedPartyMemberCount === 1 && this.scene.currentBattle.double) {
+      } else if (this.scene.currentBattle.double && legalPlayerPokemon.length === 1 && legalPlayerPartyPokemon.length === 0) {
+        /**
+         * If the player has exactly one Pokemon in total at this point in a double battle, and that Pokemon
+         * is already on the field, unshift a phase that moves that Pokemon to center position.
+         */
         this.scene.unshiftPhase(new ToggleDoublePositionPhase(this.scene, true));
-      } else if (nonFaintedPartyMemberCount >= this.scene.currentBattle.getBattlerCount()) {
+      } else if (legalPlayerPartyPokemon.length > 0) {
+        /**
+         * If previous conditions weren't met, and the player has at least 1 legal Pokemon off the field,
+         * push a phase that prompts the player to summon a Pokemon from their party.
+         */
         this.scene.pushPhase(new SwitchPhase(this.scene, this.fieldIndex, true, false));
       }
     } else {

src/test/moves/rollout.test.ts

@@ -12,6 +12,7 @@ import { SPLASH_ONLY } from "#test/utils/testUtils";
 describe("Moves - Rollout", () => {
   let phaserGame: Phaser.Game;
   let game: GameManager;
+  const TIMEOUT = 20 * 1000;
 
   beforeAll(() => {
     phaserGame = new Phaser.Game({
@@ -77,5 +78,5 @@ describe("Moves - Rollout", () => {
     // reset
     expect(turn6Dmg).toBeGreaterThanOrEqual(turn1Dmg - variance);
     expect(turn6Dmg).toBeLessThanOrEqual(turn1Dmg + variance);
-  });
+  }, TIMEOUT);
 });

src/test/ui/transfer-item.test.ts

@@ -87,7 +87,6 @@ describe("UI - Transfer Items", () => {
       handler.processInput(Button.ACTION); // select Pokemon
 
       expect(handler.optionsContainer.list.some((option) => (option as BBCodeText).text?.includes("Transfer"))).toBe(true);
-
       game.phaseInterceptor.unlock();
     });
 

src/test/ui/type-hints.test.ts

@@ -0,0 +1,89 @@
+import { Button } from "#app/enums/buttons.js";
+import { Moves } from "#app/enums/moves";
+import { Species } from "#app/enums/species";
+import { CommandPhase } from "#app/phases";
+import FightUiHandler from "#app/ui/fight-ui-handler.js";
+import { Mode } from "#app/ui/ui.js";
+import GameManager from "#test/utils/gameManager";
+import Phaser from "phaser";
+import { afterEach, beforeAll, beforeEach, describe, expect, it } from "vitest";
+import MockText from "../utils/mocks/mocksContainer/mockText";
+import { SPLASH_ONLY } from "../utils/testUtils";
+
+describe("UI - Type Hints", () => {
+  let phaserGame: Phaser.Game;
+  let game: GameManager;
+
+  beforeAll(() => {
+    phaserGame = new Phaser.Game({
+      type: Phaser.HEADLESS,
+    });
+  });
+
+  afterEach(() => {
+    game.phaseInterceptor.restoreOg();
+  });
+
+  beforeEach(async () => {
+    game = new GameManager(phaserGame);
+    game.settings.typeHints(true); //activate type hints
+    game.override.battleType("single").startingLevel(100).startingWave(1).enemyMoveset(SPLASH_ONLY);
+  });
+
+  it("check immunity color", async () => {
+    game.override
+      .battleType("single")
+      .startingLevel(100)
+      .startingWave(1)
+      .enemySpecies(Species.FLORGES)
+      .enemyMoveset(SPLASH_ONLY)
+      .moveset([Moves.DRAGON_CLAW]);
+    game.settings.typeHints(true); //activate type hints
+
+    await game.startBattle([Species.RAYQUAZA]);
+
+    game.onNextPrompt("CommandPhase", Mode.COMMAND, () => {
+      const { ui } = game.scene;
+      const handler = ui.getHandler<FightUiHandler>();
+      handler.processInput(Button.ACTION); // select "Fight"
+      game.phaseInterceptor.unlock();
+    });
+
+    game.onNextPrompt("CommandPhase", Mode.FIGHT, () => {
+      const { ui } = game.scene;
+      const movesContainer = ui.getByName<Phaser.GameObjects.Container>(FightUiHandler.MOVES_CONTAINER_NAME);
+      const dragonClawText = movesContainer
+        .getAll<Phaser.GameObjects.Text>()
+        .find((text) => text.text === "Dragon Claw")! as unknown as MockText;
+
+      expect.soft(dragonClawText.color).toBe("#929292");
+      ui.getHandler().processInput(Button.ACTION);
+    });
+    await game.phaseInterceptor.to(CommandPhase);
+  });
+
+  it("check status move color", async () => {
+    game.override.enemySpecies(Species.FLORGES).moveset([Moves.GROWL]);
+
+    await game.startBattle([Species.RAYQUAZA]);
+
+    game.onNextPrompt("CommandPhase", Mode.COMMAND, () => {
+      const { ui } = game.scene;
+      const handler = ui.getHandler<FightUiHandler>();
+      handler.processInput(Button.ACTION); // select "Fight"
+      game.phaseInterceptor.unlock();
+    });
+
+    game.onNextPrompt("CommandPhase", Mode.FIGHT, () => {
+      const { ui } = game.scene;
+      const movesContainer = ui.getByName<Phaser.GameObjects.Container>(FightUiHandler.MOVES_CONTAINER_NAME);
+      const growlText = movesContainer
+        .getAll<Phaser.GameObjects.Text>()
+        .find((text) => text.text === "Growl")! as unknown as MockText;
+
+      expect.soft(growlText.color).toBe(undefined);
+      ui.getHandler().processInput(Button.ACTION);
+    });
+    await game.phaseInterceptor.to(CommandPhase);
+  });
+});

src/test/utils/gameManager.ts

@@ -30,6 +30,7 @@ import { MoveHelper } from "./helpers/moveHelper";
 import { vi } from "vitest";
 import { ClassicModeHelper } from "./helpers/classicModeHelper";
 import { DailyModeHelper } from "./helpers/dailyModeHelper";
+import { SettingsHelper } from "./helpers/settingsHelper";
 
 /**
  * Class to manage the game state and transitions between phases.
@@ -44,6 +45,7 @@ export default class GameManager {
   public readonly move: MoveHelper;
   public readonly classicMode: ClassicModeHelper;
   public readonly dailyMode: DailyModeHelper;
+  public readonly settings: SettingsHelper;
 
   /**
    * Creates an instance of GameManager.
@@ -63,6 +65,7 @@ export default class GameManager {
     this.move = new MoveHelper(this);
     this.classicMode = new ClassicModeHelper(this);
     this.dailyMode = new DailyModeHelper(this);
+    this.settings = new SettingsHelper(this);
   }
 
   /**

src/test/utils/helpers/settingsHelper.ts

@@ -0,0 +1,15 @@
+import { GameManagerHelper } from "./gameManagerHelper";
+
+/**
+ * Helper to handle settings for tests
+ */
+export class SettingsHelper extends GameManagerHelper {
+
+  /**
+   * Disable/Enable type hints settings
+   * @param enable true to enabled, false to disabled
+   */
+  typeHints(enable: boolean) {
+    this.game.scene.typeHints = enable;
+  }
+}

src/test/utils/mocks/mocksContainer/mockContainer.ts

@@ -1,4 +1,5 @@
 import MockTextureManager from "#test/utils/mocks/mockTextureManager";
+import { vi } from "vitest";
 import { MockGameObject } from "../mockGameObject";
 
 export default class MockContainer implements MockGameObject {
@@ -13,6 +14,7 @@ export default class MockContainer implements MockGameObject {
   public frame;
   protected textureManager;
   public list: MockGameObject[] = [];
+  private name?: string;
 
   constructor(textureManager: MockTextureManager, x, y) {
     this.x = x;
@@ -159,9 +161,10 @@ export default class MockContainer implements MockGameObject {
     // Moves this Game Object to be below the given Game Object in the display list.
   }
 
-  setName(name) {
+  setName = vi.fn((name: string) => {
+    this.name = name;
     // return this.phaserSprite.setName(name);
-  }
+  });
 
   bringToTop(obj) {
     // Brings this Game Object to the top of its parents display list.

src/test/utils/mocks/mocksContainer/mockText.ts

@@ -1,4 +1,5 @@
 import UI from "#app/ui/ui";
+import { vi } from "vitest";
 import { MockGameObject } from "../mockGameObject";
 
 export default class MockText implements MockGameObject {
@@ -10,6 +11,8 @@ export default class MockText implements MockGameObject {
   public list: MockGameObject[] = [];
   public style;
   public text = "";
+  private name?: string;
+  public color?: string;
 
   constructor(textureManager, x, y, content, styleOptions) {
     this.scene = textureManager.scene;
@@ -190,10 +193,9 @@ export default class MockText implements MockGameObject {
     };
   }
 
-  setColor(color) {
-    // Sets the tint of this Game Object.
-    // return this.phaserText.setColor(color);
-  }
+  setColor = vi.fn((color: string) => {
+    this.color = color;
+  });
 
   setShadowColor(color) {
     // Sets the shadow color.
@@ -219,9 +221,9 @@ export default class MockText implements MockGameObject {
     // return this.phaserText.setAlpha(alpha);
   }
 
-  setName(name) {
-    // return this.phaserText.setName(name);
-  }
+  setName = vi.fn((name: string) => {
+    this.name = name;
+  });
 
   setAlign(align) {
     // return this.phaserText.setAlign(align);

src/ui/battle-message-ui-handler.ts

@@ -226,7 +226,7 @@ export default class BattleMessageUiHandler extends MessageUiHandler {
             highestIv = ivs[s];
           }
         });
-        if (shownStat) {
+        if (shownStat !== null && shownStat !== undefined) {
           shownStats.push(shownStat);
           statsPool.splice(statsPool.indexOf(shownStat), 1);
         }

src/ui/fight-ui-handler.ts

@@ -12,6 +12,8 @@ import {Button} from "#enums/buttons";
 import Pokemon, { PokemonMove } from "#app/field/pokemon.js";
 
 export default class FightUiHandler extends UiHandler {
+  public static readonly MOVES_CONTAINER_NAME = "moves";
+
   private movesContainer: Phaser.GameObjects.Container;
   private moveInfoContainer: Phaser.GameObjects.Container;
   private typeIcon: Phaser.GameObjects.Sprite;
@@ -35,7 +37,7 @@ export default class FightUiHandler extends UiHandler {
     const ui = this.getUi();
 
     this.movesContainer = this.scene.add.container(18, -38.7);
-    this.movesContainer.setName("moves");
+    this.movesContainer.setName(FightUiHandler.MOVES_CONTAINER_NAME);
     ui.add(this.movesContainer);
 
     this.moveInfoContainer = this.scene.add.container(1, 0);
@@ -271,11 +273,10 @@ export default class FightUiHandler extends UiHandler {
       return undefined;
     }
 
-    const moveColors = opponents.map((opponent) => {
-      return opponent.getMoveEffectiveness(pokemon, pokemonMove);
-    }).filter((eff) => !!eff).sort((a, b) => b - a).map((effectiveness) => {
-      return getTypeDamageMultiplierColor(effectiveness, "offense");
-    });
+    const moveColors = opponents
+      .map((opponent) => opponent.getMoveEffectiveness(pokemon, pokemonMove))
+      .sort((a, b) => b - a)
+      .map((effectiveness) => getTypeDamageMultiplierColor(effectiveness ?? 0, "offense"));
 
     return moveColors[0];
   }