[Bug] Fix Jaw Lock leaving the user trapped after the target faints (#3450)

* Fix Jaw Lock not removing TRAPPED tag after enemy faints

* Create tests for Jaw Lock

* Fix overrides import

* Clean up implementation + tests

* minor style change to phases

* Update src/data/move.ts

Co-authored-by: Adrian T. <68144167+torranx@users.noreply.github.com>

* Jaw Lock no longer overlaps its trapping effect

* Friendship ended with JAW_LOCK tag type

Now TRAPPED is my new best friend

---------

Co-authored-by: EmberCM <kooly213@hotmail.com>
Co-authored-by: Adrian T. <68144167+torranx@users.noreply.github.com>

src/data/move.ts

@@ -4438,6 +4438,39 @@ export class GulpMissileTagAttr extends MoveEffectAttr {
   }
 }
 
+/**
+ * Attribute to implement Jaw Lock's linked trapping effect between the user and target
+ * @extends AddBattlerTagAttr
+ */
+export class JawLockAttr extends AddBattlerTagAttr {
+  constructor() {
+    super(BattlerTagType.TRAPPED);
+  }
+
+  apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean {
+    if (!super.canApply(user, target, move, args)) {
+      return false;
+    }
+
+    // If either the user or the target already has the tag, do not apply
+    if (user.getTag(TrappedTag) || target.getTag(TrappedTag)) {
+      return false;
+    }
+
+    const moveChance = this.getMoveChance(user, target, move, this.selfTarget);
+    if (moveChance < 0 || moveChance === 100 || user.randSeedInt(100) < moveChance) {
+      /**
+       * Add the tag to both the user and the target.
+       * The target's tag source is considered to be the user and vice versa
+       */
+      return target.addTag(BattlerTagType.TRAPPED, 1, move.id, user.id)
+          && user.addTag(BattlerTagType.TRAPPED, 1, move.id, target.id);
+    }
+
+    return false;
+  }
+}
+
 export class CurseAttr extends MoveEffectAttr {
 
   apply(user: Pokemon, target: Pokemon, move:Move, args: any[]): boolean {
@@ -8313,8 +8346,7 @@ export function initMoves() {
       .attr(HighCritAttr)
       .attr(BypassRedirectAttr),
     new AttackMove(Moves.JAW_LOCK, Type.DARK, MoveCategory.PHYSICAL, 80, 100, 10, -1, 0, 8)
-      .attr(AddBattlerTagAttr, BattlerTagType.TRAPPED, false, false, 1, 1, false, true)
+      .attr(JawLockAttr)
-      .attr(AddBattlerTagAttr, BattlerTagType.TRAPPED, true, false, 1, 1, false, true)
       .bitingMove(),
     new SelfStatusMove(Moves.STUFF_CHEEKS, Type.NORMAL, -1, 10, -1, 0, 8) // TODO: Stuff Cheeks should not be selectable when the user does not have a berry, see wiki
       .attr(EatBerryAttr)

src/test/moves/jaw_lock.test.ts

@@ -0,0 +1,172 @@
+import { Abilities } from "#app/enums/abilities";
+import { BattlerTagType } from "#app/enums/battler-tag-type";
+import GameManager from "#app/test/utils/gameManager";
+import { getMovePosition } from "#app/test/utils/gameManagerUtils";
+import { Moves } from "#enums/moves";
+import { Species } from "#enums/species";
+import Phaser from "phaser";
+import { afterEach, beforeAll, beforeEach, describe, expect, it } from "vitest";
+import { SPLASH_ONLY } from "#app/test/utils/testUtils";
+import { BattlerIndex } from "#app/battle";
+import { FaintPhase } from "#app/phases/faint-phase";
+import { MoveEffectPhase } from "#app/phases/move-effect-phase";
+import { TurnEndPhase } from "#app/phases/turn-end-phase";
+import { BerryPhase } from "#app/phases/berry-phase";
+
+const TIMEOUT = 20 * 1000;
+
+describe("Moves - Jaw Lock", () => {
+  let phaserGame: Phaser.Game;
+  let game: GameManager;
+
+  beforeAll(() => {
+    phaserGame = new Phaser.Game({
+      type: Phaser.HEADLESS,
+    });
+  });
+
+  afterEach(() => {
+    game.phaseInterceptor.restoreOg();
+  });
+
+  beforeEach(() => {
+    game = new GameManager(phaserGame);
+
+    game.override
+      .battleType("single")
+      .enemySpecies(Species.SNORLAX)
+      .enemyAbility(Abilities.INSOMNIA)
+      .enemyMoveset(SPLASH_ONLY)
+      .moveset([Moves.JAW_LOCK, Moves.SPLASH])
+      .startingLevel(100)
+      .enemyLevel(100)
+      .disableCrits();
+  });
+
+  it(
+    "should trap the move's user and target",
+    async () => {
+      await game.startBattle([ Species.BULBASAUR ]);
+
+      const leadPokemon = game.scene.getPlayerPokemon()!;
+      const enemyPokemon = game.scene.getEnemyPokemon()!;
+
+      game.doAttack(getMovePosition(game.scene, 0, Moves.JAW_LOCK));
+
+      await game.phaseInterceptor.to(MoveEffectPhase, false);
+
+      expect(leadPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+      expect(enemyPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+
+      await game.phaseInterceptor.to(TurnEndPhase);
+
+      expect(leadPokemon.getTag(BattlerTagType.TRAPPED)).toBeDefined();
+      expect(enemyPokemon.getTag(BattlerTagType.TRAPPED)).toBeDefined();
+    }, TIMEOUT
+  );
+
+  it(
+    "should not trap either pokemon if the target faints",
+    async () => {
+      game.override.enemyLevel(1);
+      await game.startBattle([ Species.BULBASAUR ]);
+
+      const leadPokemon = game.scene.getPlayerPokemon()!;
+      const enemyPokemon = game.scene.getEnemyPokemon()!;
+
+      game.doAttack(getMovePosition(game.scene, 0, Moves.JAW_LOCK));
+
+      await game.phaseInterceptor.to(MoveEffectPhase, false);
+
+      expect(leadPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+      expect(enemyPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+
+      await game.phaseInterceptor.to(MoveEffectPhase);
+
+      expect(leadPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+      expect(enemyPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+
+      await game.phaseInterceptor.to(FaintPhase);
+
+      expect(leadPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+      expect(enemyPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+    }, TIMEOUT
+  );
+
+  it(
+    "should only trap the user until the target faints",
+    async () => {
+      await game.startBattle([ Species.BULBASAUR ]);
+
+      const leadPokemon = game.scene.getPlayerPokemon()!;
+      const enemyPokemon = game.scene.getEnemyPokemon()!;
+
+      game.doAttack(getMovePosition(game.scene, 0, Moves.JAW_LOCK));
+
+      await game.phaseInterceptor.to(MoveEffectPhase);
+
+      expect(leadPokemon.getTag(BattlerTagType.TRAPPED)).toBeDefined();
+      expect(enemyPokemon.getTag(BattlerTagType.TRAPPED)).toBeDefined();
+
+      await game.phaseInterceptor.to(TurnEndPhase);
+
+      await game.doKillOpponents();
+
+      expect(leadPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+    }, TIMEOUT
+  );
+
+  it(
+    "should not trap other targets after the first target is trapped",
+    async () => {
+      game.override.battleType("double");
+
+      await game.startBattle([ Species.CHARMANDER, Species.BULBASAUR ]);
+
+      const playerPokemon = game.scene.getPlayerField();
+      const enemyPokemon = game.scene.getEnemyField();
+
+      game.doAttack(getMovePosition(game.scene, 0, Moves.JAW_LOCK));
+      game.doSelectTarget(BattlerIndex.ENEMY);
+
+      game.doAttack(getMovePosition(game.scene, 1, Moves.SPLASH));
+
+      await game.phaseInterceptor.to(MoveEffectPhase);
+
+      expect(playerPokemon[0].getTag(BattlerTagType.TRAPPED)).toBeDefined();
+      expect(enemyPokemon[0].getTag(BattlerTagType.TRAPPED)).toBeDefined();
+
+      await game.toNextTurn();
+
+      game.doAttack(getMovePosition(game.scene, 0, Moves.JAW_LOCK));
+      game.doSelectTarget(BattlerIndex.ENEMY_2);
+
+      game.doAttack(getMovePosition(game.scene, 1, Moves.SPLASH));
+
+      await game.phaseInterceptor.to(MoveEffectPhase);
+
+      expect(enemyPokemon[1].getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+      expect(playerPokemon[0].getTag(BattlerTagType.TRAPPED)).toBeDefined();
+      expect(playerPokemon[0].getTag(BattlerTagType.TRAPPED)?.sourceId).toBe(enemyPokemon[0].id);
+    }, TIMEOUT
+  );
+
+  it(
+    "should not trap either pokemon if the target is protected",
+    async () => {
+      game.override.enemyMoveset(Array(4).fill(Moves.PROTECT));
+
+      await game.startBattle([ Species.BULBASAUR ]);
+
+      const playerPokemon = game.scene.getPlayerPokemon()!;
+      const enemyPokemon = game.scene.getEnemyPokemon()!;
+
+      game.doAttack(getMovePosition(game.scene, 0, Moves.JAW_LOCK));
+
+      await game.phaseInterceptor.to(BerryPhase, false);
+
+      expect(playerPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+      expect(enemyPokemon.getTag(BattlerTagType.TRAPPED)).toBeUndefined();
+    }, TIMEOUT
+  );
+});