[Refactor] Create global scene variable

eslint.config.js

@@ -46,6 +46,7 @@ export default [
             "computed-property-spacing": ["error", "never" ], // Enforces consistent spacing inside computed property brackets
             "space-infix-ops": ["error", { "int32Hint": false }], // Enforces spacing around infix operators
             "no-multiple-empty-lines": ["error", { "max": 2, "maxEOF": 1, "maxBOF": 0 }], // Disallows multiple empty lines
+            "@typescript-eslint/consistent-type-imports": "error", // Enforces type-only imports wherever possible
         }
     }
 ]

src/@types/common.ts

@@ -1,3 +1 @@
-import BattleScene from "#app/battle-scene";
-
-export type ConditionFn = (scene: BattleScene, args?: any[]) => boolean;
+export type ConditionFn = (args?: any[]) => boolean;

src/@types/i18next.d.ts

@@ -1,4 +1,4 @@
-import { TOptions } from "i18next";
+import type { TOptions } from "i18next";
 
 // Module declared to make referencing keys in the localization files type-safe.
 declare module "i18next" {

src/data/balance/biomes.ts

@@ -1,6 +1,7 @@
 import { Type } from "#enums/type";
 import * as Utils from "#app/utils";
-import { pokemonEvolutions, SpeciesFormEvolution } from "#app/data/balance/pokemon-evolutions";
+import type { SpeciesFormEvolution } from "#app/data/balance/pokemon-evolutions";
+import { pokemonEvolutions } from "#app/data/balance/pokemon-evolutions";
 import i18next from "i18next";
 import { Biome } from "#enums/biome";
 import { Species } from "#enums/species";

src/data/berry.ts

@@ -1,5 +1,6 @@
 import { getPokemonNameWithAffix } from "../messages";
-import Pokemon, { HitResult } from "../field/pokemon";
+import type Pokemon from "../field/pokemon";
+import { HitResult } from "../field/pokemon";
 import { getStatusEffectHealText } from "./status-effect";
 import * as Utils from "../utils";
 import { DoubleBerryEffectAbAttr, PostItemLostAbAttr, ReduceBerryUseThresholdAbAttr, applyAbAttrs, applyPostItemLostAbAttrs } from "./ability";
@@ -9,6 +10,7 @@ import { BerryType } from "#enums/berry-type";
 import { Stat, type BattleStat } from "#app/enums/stat";
 import { PokemonHealPhase } from "#app/phases/pokemon-heal-phase";
 import { StatStageChangePhase } from "#app/phases/stat-stage-change-phase";
+import { globalScene } from "#app/global-scene";
 
 export function getBerryName(berryType: BerryType): string {
   return i18next.t(`berry:${BerryType[berryType]}.name`);
@@ -73,7 +75,7 @@ export function getBerryEffectFunc(berryType: BerryType): BerryEffectFunc {
         }
         const hpHealed = new Utils.NumberHolder(Utils.toDmgValue(pokemon.getMaxHp() / 4));
         applyAbAttrs(DoubleBerryEffectAbAttr, pokemon, null, false, hpHealed);
-        pokemon.scene.unshiftPhase(new PokemonHealPhase(pokemon.scene, pokemon.getBattlerIndex(),
+        globalScene.unshiftPhase(new PokemonHealPhase(pokemon.getBattlerIndex(),
           hpHealed.value, i18next.t("battle:hpHealBerry", { pokemonNameWithAffix: getPokemonNameWithAffix(pokemon), berryName: getBerryName(berryType) }), true));
         applyPostItemLostAbAttrs(PostItemLostAbAttr, berryOwner ?? pokemon, false);
       };
@@ -83,7 +85,7 @@ export function getBerryEffectFunc(berryType: BerryType): BerryEffectFunc {
           pokemon.battleData.berriesEaten.push(berryType);
         }
         if (pokemon.status) {
-          pokemon.scene.queueMessage(getStatusEffectHealText(pokemon.status.effect, getPokemonNameWithAffix(pokemon)));
+          globalScene.queueMessage(getStatusEffectHealText(pokemon.status.effect, getPokemonNameWithAffix(pokemon)));
         }
         pokemon.resetStatus(true, true);
         pokemon.updateInfo();
@@ -102,7 +104,7 @@ export function getBerryEffectFunc(berryType: BerryType): BerryEffectFunc {
         const stat: BattleStat = berryType - BerryType.ENIGMA;
         const statStages = new Utils.NumberHolder(1);
         applyAbAttrs(DoubleBerryEffectAbAttr, pokemon, null, false, statStages);
-        pokemon.scene.unshiftPhase(new StatStageChangePhase(pokemon.scene, pokemon.getBattlerIndex(), true, [ stat ], statStages.value));
+        globalScene.unshiftPhase(new StatStageChangePhase(pokemon.getBattlerIndex(), true, [ stat ], statStages.value));
         applyPostItemLostAbAttrs(PostItemLostAbAttr, berryOwner ?? pokemon, false);
       };
     case BerryType.LANSAT:
@@ -121,7 +123,7 @@ export function getBerryEffectFunc(berryType: BerryType): BerryEffectFunc {
         const randStat = Utils.randSeedInt(Stat.SPD, Stat.ATK);
         const stages = new Utils.NumberHolder(2);
         applyAbAttrs(DoubleBerryEffectAbAttr, pokemon, null, false, stages);
-        pokemon.scene.unshiftPhase(new StatStageChangePhase(pokemon.scene, pokemon.getBattlerIndex(), true, [ randStat ], stages.value));
+        globalScene.unshiftPhase(new StatStageChangePhase(pokemon.getBattlerIndex(), true, [ randStat ], stages.value));
         applyPostItemLostAbAttrs(PostItemLostAbAttr, berryOwner ?? pokemon, false);
       };
     case BerryType.LEPPA:
@@ -132,7 +134,7 @@ export function getBerryEffectFunc(berryType: BerryType): BerryEffectFunc {
         const ppRestoreMove = pokemon.getMoveset().find(m => !m?.getPpRatio()) ? pokemon.getMoveset().find(m => !m?.getPpRatio()) : pokemon.getMoveset().find(m => m!.getPpRatio() < 1); // TODO: is this bang correct?
         if (ppRestoreMove !== undefined) {
         ppRestoreMove!.ppUsed = Math.max(ppRestoreMove!.ppUsed - 10, 0);
-        pokemon.scene.queueMessage(i18next.t("battle:ppHealBerry", { pokemonNameWithAffix: getPokemonNameWithAffix(pokemon), moveName: ppRestoreMove!.getName(), berryName: getBerryName(berryType) }));
+        globalScene.queueMessage(i18next.t("battle:ppHealBerry", { pokemonNameWithAffix: getPokemonNameWithAffix(pokemon), moveName: ppRestoreMove!.getName(), berryName: getBerryName(berryType) }));
         applyPostItemLostAbAttrs(PostItemLostAbAttr, berryOwner ?? pokemon, false);
         }
       };

src/data/challenge.ts

@@ -1,18 +1,22 @@
 import * as Utils from "#app/utils";
 import i18next from "i18next";
-import { defaultStarterSpecies, DexAttrProps, GameData } from "#app/system/game-data";
-import PokemonSpecies, { getPokemonSpecies, getPokemonSpeciesForm } from "#app/data/pokemon-species";
+import type { DexAttrProps, GameData } from "#app/system/game-data";
+import { defaultStarterSpecies } from "#app/system/game-data";
+import type PokemonSpecies from "#app/data/pokemon-species";
+import { getPokemonSpecies, getPokemonSpeciesForm } from "#app/data/pokemon-species";
 import { speciesStarterCosts } from "#app/data/balance/starters";
-import Pokemon, { PokemonMove } from "#app/field/pokemon";
-import { BattleType, FixedBattleConfig } from "#app/battle";
+import type Pokemon from "#app/field/pokemon";
+import { PokemonMove } from "#app/field/pokemon";
+import type { FixedBattleConfig } from "#app/battle";
+import { BattleType } from "#app/battle";
 import Trainer, { TrainerVariant } from "#app/field/trainer";
-import { GameMode } from "#app/game-mode";
+import type { GameMode } from "#app/game-mode";
 import { Type } from "#enums/type";
 import { Challenges } from "#enums/challenges";
 import { Species } from "#enums/species";
 import { TrainerType } from "#enums/trainer-type";
 import { Nature } from "#enums/nature";
-import { Moves } from "#enums/moves";
+import type { Moves } from "#enums/moves";
 import { TypeColor, TypeShadow } from "#enums/color";
 import { pokemonEvolutions } from "#app/data/balance/pokemon-evolutions";
 import { pokemonFormChanges } from "#app/data/pokemon-forms";
@@ -467,7 +471,7 @@ export class SingleGenerationChallenge extends Challenge {
     if (trainerTypes.length === 0) {
       return false;
     } else {
-      battleConfig.setBattleType(BattleType.TRAINER).setGetTrainerFunc(scene => new Trainer(scene, trainerTypes[this.value - 1], TrainerVariant.DEFAULT));
+      battleConfig.setBattleType(BattleType.TRAINER).setGetTrainerFunc(() => new Trainer(trainerTypes[this.value - 1], TrainerVariant.DEFAULT));
       return true;
     }
   }

src/data/custom-pokemon-data.ts

@@ -1,7 +1,7 @@
-import { Abilities } from "#enums/abilities";
-import { Type } from "#enums/type";
+import type { Abilities } from "#enums/abilities";
+import type { Type } from "#enums/type";
 import { isNullOrUndefined } from "#app/utils";
-import { Nature } from "#enums/nature";
+import type { Nature } from "#enums/nature";
 
 /**
  * Data that can customize a Pokemon in non-standard ways from its Species

src/data/daily-run.ts

@@ -1,10 +1,11 @@
 import { PartyMemberStrength } from "#enums/party-member-strength";
-import { Species } from "#enums/species";
-import BattleScene from "#app/battle-scene";
+import type { Species } from "#enums/species";
+import { globalScene } from "#app/global-scene";
 import { PlayerPokemon } from "#app/field/pokemon";
-import { Starter } from "#app/ui/starter-select-ui-handler";
+import type { Starter } from "#app/ui/starter-select-ui-handler";
 import * as Utils from "#app/utils";
-import PokemonSpecies, { PokemonSpeciesForm, getPokemonSpecies, getPokemonSpeciesForm } from "#app/data/pokemon-species";
+import type { PokemonSpeciesForm } from "#app/data/pokemon-species";
+import PokemonSpecies, { getPokemonSpecies, getPokemonSpeciesForm } from "#app/data/pokemon-species";
 import { speciesStarterCosts } from "#app/data/balance/starters";
 import { pokerogueApi } from "#app/plugins/api/pokerogue-api";
 
@@ -21,17 +22,17 @@ export function fetchDailyRunSeed(): Promise<string | null> {
   });
 }
 
-export function getDailyRunStarters(scene: BattleScene, seed: string): Starter[] {
+export function getDailyRunStarters(seed: string): Starter[] {
   const starters: Starter[] = [];
 
-  scene.executeWithSeedOffset(() => {
-    const startingLevel = scene.gameMode.getStartingLevel();
+  globalScene.executeWithSeedOffset(() => {
+    const startingLevel = globalScene.gameMode.getStartingLevel();
 
     if (/\d{18}$/.test(seed)) {
       for (let s = 0; s < 3; s++) {
         const offset = 6 + s * 6;
         const starterSpeciesForm = getPokemonSpeciesForm(parseInt(seed.slice(offset, offset + 4)) as Species, parseInt(seed.slice(offset + 4, offset + 6)));
-        starters.push(getDailyRunStarter(scene, starterSpeciesForm, startingLevel));
+        starters.push(getDailyRunStarter(starterSpeciesForm, startingLevel));
       }
       return;
     }
@@ -48,17 +49,17 @@ export function getDailyRunStarters(scene: BattleScene, seed: string): Starter[]
         .filter(s => speciesStarterCosts[s] === cost);
       const randPkmSpecies = getPokemonSpecies(Utils.randSeedItem(costSpecies));
       const starterSpecies = getPokemonSpecies(randPkmSpecies.getTrainerSpeciesForLevel(startingLevel, true, PartyMemberStrength.STRONGER));
-      starters.push(getDailyRunStarter(scene, starterSpecies, startingLevel));
+      starters.push(getDailyRunStarter(starterSpecies, startingLevel));
     }
   }, 0, seed);
 
   return starters;
 }
 
-function getDailyRunStarter(scene: BattleScene, starterSpeciesForm: PokemonSpeciesForm, startingLevel: integer): Starter {
+function getDailyRunStarter(starterSpeciesForm: PokemonSpeciesForm, startingLevel: integer): Starter {
   const starterSpecies = starterSpeciesForm instanceof PokemonSpecies ? starterSpeciesForm : getPokemonSpecies(starterSpeciesForm.speciesId);
   const formIndex = starterSpeciesForm instanceof PokemonSpecies ? undefined : starterSpeciesForm.formIndex;
-  const pokemon = new PlayerPokemon(scene, starterSpecies, startingLevel, undefined, formIndex, undefined, undefined, undefined, undefined, undefined, undefined);
+  const pokemon = new PlayerPokemon(starterSpecies, startingLevel, undefined, formIndex, undefined, undefined, undefined, undefined, undefined, undefined);
   const starter: Starter = {
     species: starterSpecies,
     dexAttr: pokemon.getDexAttr(),

src/data/egg-hatch-data.ts

@@ -1,6 +1,6 @@
-import BattleScene from "#app/battle-scene";
-import { PlayerPokemon } from "#app/field/pokemon";
-import { DexEntry, StarterDataEntry } from "#app/system/game-data";
+import { globalScene } from "#app/global-scene";
+import type { PlayerPokemon } from "#app/field/pokemon";
+import type { DexEntry, StarterDataEntry } from "#app/system/game-data";
 
 /**
  * Stores data associated with a specific egg and the hatched pokemon
@@ -17,11 +17,8 @@ export class EggHatchData {
   public dexEntryBeforeUpdate: DexEntry;
   /** stored copy of the hatched pokemon's starter entry before it was updated due to hatch */
   public starterDataEntryBeforeUpdate: StarterDataEntry;
-  /** reference to the battle scene to get gamedata and update dex */
-  private scene: BattleScene;
 
-  constructor(scene: BattleScene, pokemon: PlayerPokemon, eggMoveIndex: number) {
-    this.scene = scene;
+  constructor(pokemon: PlayerPokemon, eggMoveIndex: number) {
     this.pokemon = pokemon;
     this.eggMoveIndex = eggMoveIndex;
   }
@@ -39,8 +36,8 @@ export class EggHatchData {
      * Used before updating the dex, so comparing the pokemon to these entries will show the new attributes
      */
   setDex() {
-    const currDexEntry = this.scene.gameData.dexData[this.pokemon.species.speciesId];
-    const currStarterDataEntry = this.scene.gameData.starterData[this.pokemon.species.getRootSpeciesId()];
+    const currDexEntry = globalScene.gameData.dexData[this.pokemon.species.speciesId];
+    const currStarterDataEntry = globalScene.gameData.starterData[this.pokemon.species.getRootSpeciesId()];
     this.dexEntryBeforeUpdate = {
       seenAttr: currDexEntry.seenAttr,
       caughtAttr: currDexEntry.caughtAttr,
@@ -86,9 +83,9 @@ export class EggHatchData {
      */
   updatePokemon(showMessage : boolean = false) {
     return new Promise<void>(resolve => {
-      this.scene.gameData.setPokemonCaught(this.pokemon, true, true, showMessage).then(() => {
-        this.scene.gameData.updateSpeciesDexIvs(this.pokemon.species.speciesId, this.pokemon.ivs);
-        this.scene.gameData.setEggMoveUnlocked(this.pokemon.species, this.eggMoveIndex, showMessage).then((value) => {
+      globalScene.gameData.setPokemonCaught(this.pokemon, true, true, showMessage).then(() => {
+        globalScene.gameData.updateSpeciesDexIvs(this.pokemon.species.speciesId, this.pokemon.ivs);
+        globalScene.gameData.setEggMoveUnlocked(this.pokemon.species, this.eggMoveIndex, showMessage).then((value) => {
           this.setEggMoveUnlocked(value);
           resolve();
         });