From 836e4d54dcb7fda82baca5e485a00b61afb27ba4 Mon Sep 17 00:00:00 2001
From: flx-sta <50131232+flx-sta@users.noreply.github.com>
Date: Fri, 13 Sep 2024 16:21:48 -0700
Subject: [PATCH] add: ExpGainsSpeed enum

---
 src/battle-scene.ts                    |  3 ++-
 src/enums/exp-gains-speed.ts           | 22 ++++++++++++++++++++++
 src/phases/show-party-exp-bar-phase.ts |  3 ++-
 src/test/utils/gameManager.ts          |  3 ++-
 4 files changed, 28 insertions(+), 3 deletions(-)
 create mode 100644 src/enums/exp-gains-speed.ts

diff --git a/src/battle-scene.ts b/src/battle-scene.ts
index f06ae607b0e..eb8949502aa 100644
--- a/src/battle-scene.ts
+++ b/src/battle-scene.ts
@@ -86,6 +86,7 @@ import { TitlePhase } from "./phases/title-phase";
 import { ToggleDoublePositionPhase } from "./phases/toggle-double-position-phase";
 import { TurnInitPhase } from "./phases/turn-init-phase";
 import { ShopCursorTarget } from "./enums/shop-cursor-target";
+import { ExpGainsSpeed } from "./enums/exp-gains-speed";
 
 export const bypassLogin = import.meta.env.VITE_BYPASS_LOGIN === "1";
 
@@ -161,7 +162,7 @@ export default class BattleScene extends SceneBase {
   public experimentalSprites: boolean = false;
   public musicPreference: integer = 0;
   public moveAnimations: boolean = true;
-  public expGainsSpeed: integer = 0;
+  public expGainsSpeed: ExpGainsSpeed = ExpGainsSpeed.DEFAULT;
   public skipSeenDialogues: boolean = false;
   /**
    * Determines if the egg hatching animation should be skipped
diff --git a/src/enums/exp-gains-speed.ts b/src/enums/exp-gains-speed.ts
new file mode 100644
index 00000000000..964c4f99c70
--- /dev/null
+++ b/src/enums/exp-gains-speed.ts
@@ -0,0 +1,22 @@
+/**
+ * Defines the speed of gaining experience.
+ *
+ * @remarks
+ * The `expGainSpeed` can have several modes:
+ * - `0` - Default: The normal speed.
+ * - `1` - Fast: Fast speed.
+ * - `2` - Faster: Faster speed.
+ * - `3` - Skip: Skip gaining exp animation.
+ *
+ * @default 0 - Uses the default normal speed.
+ */
+export enum ExpGainsSpeed {
+  /** The normal speed. */
+  DEFAULT,
+  /** Fast speed. */
+  FAST,
+  /** Faster speed. */
+  FASTER,
+  /** Skip gaining exp animation. */
+  SKIP
+}
diff --git a/src/phases/show-party-exp-bar-phase.ts b/src/phases/show-party-exp-bar-phase.ts
index 9e019b202a5..f1783e7715f 100644
--- a/src/phases/show-party-exp-bar-phase.ts
+++ b/src/phases/show-party-exp-bar-phase.ts
@@ -1,4 +1,5 @@
 import BattleScene from "#app/battle-scene";
+import { ExpGainsSpeed } from "#app/enums/exp-gains-speed";
 import { ExpNotification } from "#app/enums/exp-notification";
 import { ExpBoosterModifier } from "#app/modifier/modifier";
 import * as Utils from "#app/utils";
@@ -44,7 +45,7 @@ export class ShowPartyExpBarPhase extends PlayerPartyMemberPokemonPhase {
       } else {
         this.end();
       }
-    } else if (this.scene.expGainsSpeed < 3) {
+    } else if (this.scene.expGainsSpeed < ExpGainsSpeed.SKIP) {
       this.scene.partyExpBar.showPokemonExp(pokemon, exp.value, false, newLevel).then(() => {
         setTimeout(() => this.end(), 500 / Math.pow(2, this.scene.expGainsSpeed));
       });
diff --git a/src/test/utils/gameManager.ts b/src/test/utils/gameManager.ts
index cc364a74b83..0b114aa482b 100644
--- a/src/test/utils/gameManager.ts
+++ b/src/test/utils/gameManager.ts
@@ -49,6 +49,7 @@ import { OverridesHelper } from "./helpers/overridesHelper";
 import { SettingsHelper } from "./helpers/settingsHelper";
 import { ReloadHelper } from "./helpers/reloadHelper";
 import { CheckSwitchPhase } from "#app/phases/check-switch-phase";
+import { ExpGainsSpeed } from "#app/enums/exp-gains-speed";
 
 /**
  * Class to manage the game state and transitions between phases.
@@ -140,7 +141,7 @@ export default class GameManager {
     this.scene.gameSpeed = 5;
     this.scene.moveAnimations = false;
     this.scene.showLevelUpStats = false;
-    this.scene.expGainsSpeed = 3;
+    this.scene.expGainsSpeed = ExpGainsSpeed.SKIP;
     this.scene.expParty = ExpNotification.SKIP;
     this.scene.hpBarSpeed = 3;
     this.scene.enableTutorials = false;