attach github issues to all encounter jsdocs

src/data/mystery-encounters/encounters/dark-deal-encounter.ts

@@ -15,7 +15,7 @@ import { getRandomPlayerPokemon, getRandomSpeciesByStarterTier } from "#app/data
 /** i18n namespace for encounter */
 const namespace = "mysteryEncounter:dark_deal";
 
-// Exclude Ultra Beasts, Paradox, Necrozma, Eternatus, and egg-locked mythicals
+/** Exclude Ultra Beasts (inludes Cosmog/Solgaleo/Lunala/Necrozma), Paradox (includes Miraidon/Koraidon), Eternatus, and egg-locked mythicals */
 const excludedBosses = [
   Species.NECROZMA,
   Species.COSMOG,
@@ -68,6 +68,11 @@ const excludedBosses = [
   Species.PECHARUNT,
 ];
 
+/**
+ * Dark Deal encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/61 | GitHub Issue #61}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const DarkDealEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(MysteryEncounterType.DARK_DEAL)
     .withEncounterTier(MysteryEncounterTier.ROGUE)

src/data/mystery-encounters/encounters/department-store-sale-encounter.ts

@@ -15,6 +15,11 @@ import IMysteryEncounter, {
 /** i18n namespace for encounter */
 const namespace = "mysteryEncounter:department_store_sale";
 
+/**
+ * Department Store Sale encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/33 | GitHub Issue #33}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const DepartmentStoreSaleEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(MysteryEncounterType.DEPARTMENT_STORE_SALE)
     .withEncounterTier(MysteryEncounterTier.COMMON)

src/data/mystery-encounters/encounters/field-trip-encounter.ts

@@ -21,6 +21,11 @@ import IMysteryEncounter, {
 /** i18n namespace for the encounter */
 const namespace = "mysteryEncounter:field_trip";
 
+/**
+ * Field Trip encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/17 | GitHub Issue #17}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const FieldTripEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(MysteryEncounterType.FIELD_TRIP)
     .withEncounterTier(MysteryEncounterTier.COMMON)

src/data/mystery-encounters/encounters/fiery-fallout-encounter.ts

@@ -19,6 +19,11 @@ import { randSeedInt } from "#app/utils";
 /** the i18n namespace for the encounter */
 const namespace = "mysteryEncounter:fiery_fallout";
 
+/**
+ * Fiery Fallout encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/88 | GitHub Issue #88}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const FieryFalloutEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(
     MysteryEncounterType.FIERY_FALLOUT

src/data/mystery-encounters/encounters/fight-or-flight-encounter.ts

@@ -31,6 +31,11 @@ import { queueEncounterMessage, showEncounterText } from "#app/data/mystery-enco
 /** the i18n namespace for the encounter */
 const namespace = "mysteryEncounter:fight_or_flight";
 
+/**
+ * Fight or Flight encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/24 | GitHub Issue #24}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const FightOrFlightEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(
     MysteryEncounterType.FIGHT_OR_FLIGHT

src/data/mystery-encounters/encounters/lost-at-sea-encounter.ts

@@ -16,7 +16,7 @@ const OPTION_2_REQUIRED_MOVE = Moves.FLY;
  */
 const DAMAGE_PERCENTAGE: number = 25;
 /** The i18n namespace for the encounter */
-const namepsace = "mysteryEncounter:lostAtSea";
+const namepsace = "mysteryEncounter:lostAtSeaDialogue";
 
 /**
  * Lost at sea encounter.

src/data/mystery-encounters/encounters/mysterious-challengers-encounter.ts

@@ -23,6 +23,11 @@ import IMysteryEncounter, {
 /** the i18n namespace for the encounter */
 const namespace = "mysteryEncounter:mysterious_challengers";
 
+/**
+ * Mysterious Challengers encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/41 | GitHub Issue #41}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const MysteriousChallengersEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(
     MysteryEncounterType.MYSTERIOUS_CHALLENGERS

src/data/mystery-encounters/encounters/mysterious-chest-encounter.ts

@@ -14,6 +14,11 @@ import IMysteryEncounter, {
 } from "../mystery-encounter";
 import { EncounterOptionMode, MysteryEncounterOptionBuilder } from "../mystery-encounter-option";
 
+/**
+ * Mysterious Chest encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/32 | GitHub Issue #32}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const MysteriousChestEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(
     MysteryEncounterType.MYSTERIOUS_CHEST

src/data/mystery-encounters/encounters/safari-zone-encounter.ts

@@ -19,6 +19,11 @@ import { showEncounterText } from "#app/data/mystery-encounters/utils/encounter-
 /** the i18n namespace for the encounter */
 const namespace = "mysteryEncounter:safari_zone";
 
+/**
+ * Safari Zone encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/39 | GitHub Issue #39}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const SafariZoneEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(MysteryEncounterType.SAFARI_ZONE)
     .withEncounterTier(MysteryEncounterTier.GREAT)

src/data/mystery-encounters/encounters/shady-vitamin-dealer-encounter.ts

@@ -15,6 +15,11 @@ import { queueEncounterMessage } from "#app/data/mystery-encounters/utils/encoun
 /** the i18n namespace for this encounter */
 const namespace = "mysteryEncounter:shady_vitamin_dealer";
 
+/**
+ * Shady Vitamin Dealer encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/34 | GitHub Issue #34}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const ShadyVitaminDealerEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(
     MysteryEncounterType.SHADY_VITAMIN_DEALER

src/data/mystery-encounters/encounters/sleeping-snorlax-encounter.ts

@@ -16,11 +16,16 @@ import { queueEncounterMessage } from "#app/data/mystery-encounters/utils/encoun
 /** i18n namespace for the encounter */
 const namespace = "mysteryEncounter:sleeping_snorlax";
 
+/**
+ * Sleeping Snorlax encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/103 | GitHub Issue #103}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const SleepingSnorlaxEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(
     MysteryEncounterType.SLEEPING_SNORLAX
   )
-    .withEncounterTier(MysteryEncounterTier.ULTRA)
+    .withEncounterTier(MysteryEncounterTier.GREAT)
     .withSceneWaveRangeRequirement(10, 180) // waves 10 to 180
     .withCatchAllowed(true)
     .withHideWildIntroMessage(true)
@@ -110,12 +115,7 @@ export const SleepingSnorlaxEncounter: IMysteryEncounter =
           const p = instance.primaryPokemon;
           p.status = new Status(StatusEffect.SLEEP, 0, 3);
           p.updateInfo(true);
-          // const sitrus = (modifierTypes.BERRY?.() as ModifierTypeGenerator).generateType(scene.getParty(), [BerryType.SITRUS]);
-          const sitrus = generateModifierTypeOption(
-            scene,
-            modifierTypes.BERRY,
-            [BerryType.SITRUS]
-          );
+          const sitrus = generateModifierTypeOption(scene, modifierTypes.BERRY, [BerryType.SITRUS]);
 
           setEncounterRewards(scene, {
             guaranteedModifierTypeOptions: [sitrus],

src/data/mystery-encounters/encounters/training-session-encounter.ts

@@ -21,6 +21,11 @@ import { queueEncounterMessage } from "#app/data/mystery-encounters/utils/encoun
 /** The i18n namespace for the encounter */
 const namespace = "mysteryEncounter:training_session";
 
+/**
+ * Training Session encounter.
+ * @see {@link https://github.com/AsdarDevelops/PokeRogue-Events/issues/43 | GitHub Issue #43}
+ * @see For biome requirements check [mysteryEncountersByBiome](../mystery-encounters.ts)
+ */
 export const TrainingSessionEncounter: IMysteryEncounter =
   MysteryEncounterBuilder.withEncounterType(
     MysteryEncounterType.TRAINING_SESSION

src/locales/en/mystery-encounter.ts

@@ -1,4 +1,4 @@
-import { lostAtSea } from "./mystery-encounters/lost-at-sea";
+import { lostAtSeaDialogue } from "./mystery-encounters/lost-at-sea-dialogue";
 
 /**
  * Patterns that can be used:
@@ -260,5 +260,5 @@ export const mysteryEncounter = {
   $@s{item_fanfare}You gained a Berry!`,
   "sleeping_snorlax_option_3_good_result": "Your {{option3PrimaryName}} uses {{option3PrimaryMove}}! @s{item_fanfare}It steals Leftovers off the sleeping Snorlax and you make out like bandits!",
 
-  lostAtSea,
+  lostAtSea: lostAtSeaDialogue,
 } as const;

src/locales/en/mystery-encounters/lost-at-sea-dialogue.ts

@@ -1,4 +1,4 @@
-export const lostAtSea = {
+export const lostAtSeaDialogue = {
   intro: "Wandering aimlessly, you effectively get nowhere.",
   title: "Lost at sea",
   description: "The sea is turbulent in this area, and you seem to be running out of fuel.\nThis is bad. Is there a way out of the situation?",

src/test/mystery-encounter/encounters/lost-at-sea-encounter.test.ts

@@ -12,7 +12,7 @@ import GameManager from "#app/test/utils/gameManager";
 import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
 import { runSelectMysteryEncounterOption } from "../encounterTestUtils";
 
-const namepsace = "mysteryEncounter:lostAtSea";
+const namepsace = "mysteryEncounter:lostAtSeaDialogue";
 /** Blastoise for surf. Pidgeot for fly. Abra for none. */
 const defaultParty = [Species.BLASTOISE, Species.PIDGEOT, Species.ABRA];
 const defaultBiome = Biome.SEA;