Overlay: Display catch/escape odds during a shiny Safari encounter (#794)

* Overlay: Display catch/escape odds during a shiny Safari encounter

* Update code formatting to satisfy newer black version

* Overlay: Hard-code Gloom and Wobbuffet as completed

Author: hanzi

modules/battle_state.py

@@ -25,6 +25,7 @@
     get_opponent,
     get_type_by_name,
     HIDDEN_POWER_MAP,
+    get_move_by_name,
 )
 from modules.state_cache import state_cache
 from modules.tasks import get_global_script_context
@@ -531,7 +532,7 @@ def moves(self) -> list[LearnedMove | None]:
             result.append(LearnedMove(move, total_pp, current_pp, total_pp - move.pp))
         return result
 
-    def knows_move(self, move: str | Move, with_pp_remaining: bool = False):
+    def knows_move(self, move: str | Move, with_pp_remaining: bool = False) -> bool:
         if isinstance(move, Move):
             move = move.name
         for learned_move in self.moves:
@@ -543,6 +544,20 @@ def knows_move(self, move: str | Move, with_pp_remaining: bool = False):
                 return True
         return False
 
+    def can_use_move(self, move: str | Move) -> bool:
+        if isinstance(move, str):
+            move = get_move_by_name(move)
+        for learned_move in self.moves:
+            if (
+                learned_move is not None
+                and learned_move.move is move
+                and learned_move.pp > 0
+                and (self.disabled_move is not move or self.disabled_turns_remaining <= 0)
+                and (self.encored_move is move or self.encore_turns_remaining <= 0)
+            ):
+                return True
+        return False
+
     @property
     def is_egg(self) -> bool:
         return bool(self._data[0x17] & 0b0100_0000)

modules/data/get_pret_maps.py

@@ -55,22 +55,19 @@ def _might_be_map_coordinates(value) -> bool:
         out.write(f"class MapGroup{game_code}(Enum):\n")
         for map_group in map_group_names:
             out.write(f"    {map_group_names[map_group]} = {map_group}\n")
-        out.write(
-            f"""    def __contains__(self, item):
+        out.write(f"""    def __contains__(self, item):
         if _might_be_map_coordinates(item):
             return self.value == item[0]
         elif isinstance(item, Map{game_code}):
             return self.value == item.value[0]
         else:
-            return NotImplemented"""
-        )
+            return NotImplemented""")
 
         out.write("\n\n\n")
 
         out.write(f"class Map{game_code}(Enum):\n")
         out.write("    " + "\n".join(output).strip() + "\n")
-        out.write(
-            f"""
+        out.write(f"""
     def __eq__(self, other):
         if _might_be_map_coordinates(other):
             return self.value == other
@@ -92,5 +89,4 @@ def __contains__(self, item):
         elif isinstance(item, MapLocation):
             return item.map_group == self.value[0] and item.map_number == self.value[1]
         else:
-            return NotImplemented\n"""
-        )
+            return NotImplemented\n""")

modules/gui/emulator_controls.py

@@ -320,9 +320,7 @@ def _update_stats(self):
         self.stats_label.config(text=" | ".join(stats))
 
     def _reset_shiny_phase_stats(self):
-        is_the_user_sure = ask_for_confirmation(
-            dedent(
-                """
+        is_the_user_sure = ask_for_confirmation(dedent("""
                 This will reset all stats from your current shiny phase -- such
                 as encounters, IV/SV records, fishing attempts etc. -- to zero.
                 
@@ -334,9 +332,7 @@ def _reset_shiny_phase_stats(self):
                 Total encounter numbers will not be affected.
                 
                 This cannot be undone! Are you sure you want to proceed?
-                """
-            )
-        )
+                """))
 
         if is_the_user_sure:
             context.stats.clear_current_shiny_phase()

modules/gui/emulator_screen.py

@@ -17,7 +17,6 @@
 from modules.sprites import generate_placeholder_image
 from modules.version import pokebot_name, pokebot_version
 
-
 # Defines how many frames can be reverted at the most in stepping mode.
 stepping_mode_frame_history_size = 128
 stepping_mode_forward_key = "<space>"

modules/modes/util/map.py

@@ -108,7 +108,7 @@ def find_closest_pokemon_center(
                 pass
 
     if pokemon_center is None:
-        raise BotModeError("Could not find a suitable oath from here to a Pokemon Center nearby.")
+        raise BotModeError("Could not find a suitable path from here to a Pokemon Center nearby.")
 
     return pokemon_center
 

modules/stats.py

@@ -708,16 +708,14 @@ def clear_current_shiny_phase(self):
             (self.current_shiny_phase.start_time, self.current_shiny_phase.shiny_phase_id),
         )
 
-        self._execute_write(
-            """
+        self._execute_write("""
             UPDATE encounter_summaries
             SET phase_encounters = 0,
                 phase_highest_iv_sum = NULL,
                 phase_lowest_iv_sum = NULL,
                 phase_highest_sv = NULL,
                 phase_lowest_sv = NULL
-            """
-        )
+            """)
 
         for index in self._encounter_summaries:
             summary = self._encounter_summaries[index]
@@ -991,8 +989,7 @@ def _get_next_shiny_phase_id(self) -> int:
             return int(result[0]) + 1
 
     def _get_encounter_summaries(self) -> dict[int, EncounterSummary]:
-        result = self._cursor.execute(
-            """
+        result = self._cursor.execute("""
             SELECT
                 species_id,
                 species_name,
@@ -1011,8 +1008,7 @@ def _get_encounter_summaries(self) -> dict[int, EncounterSummary]:
                 last_encounter_time
             FROM encounter_summaries
             ORDER BY species_id
-            """
-        )
+            """)
 
         encounter_summaries = {}
         for row in result:
@@ -1165,16 +1161,14 @@ def _reset_phase_in_database(self, encounter: Encounter) -> None:
             (encounter.encounter_time, encounter.encounter_id, self.current_shiny_phase.shiny_phase_id),
         )
 
-        self._execute_write(
-            """
+        self._execute_write("""
             UPDATE encounter_summaries
                SET phase_encounters = 0,
                    phase_highest_iv_sum = NULL,
                    phase_lowest_iv_sum = NULL,
                    phase_highest_sv = NULL,
                    phase_lowest_sv = NULL
-            """
-        )
+            """)
 
     def _insert_or_update_encounter_summary(self, encounter_summary: EncounterSummary) -> None:
         if encounter_summary.species is None:
@@ -1314,20 +1308,14 @@ def _update_schema(self, from_schema_version: int) -> None:
         if from_schema_version <= 0:
             self._execute_write("CREATE TABLE schema_version (version INT UNSIGNED)")
 
-            self._execute_write(
-                dedent(
-                    """
+            self._execute_write(dedent("""
                     CREATE TABLE base_data (
                         data_key INT UNSIGNED PRIMARY KEY,
                         value TEXT DEFAULT NULL
                     )
-                    """
-                )
-            )
+                    """))
 
-            self._execute_write(
-                dedent(
-                    """
+            self._execute_write(dedent("""
                     CREATE TABLE encounter_summaries (
                         species_id INT UNSIGNED PRIMARY KEY,
                         species_name TEXT NOT NULL,
@@ -1345,13 +1333,9 @@ def _update_schema(self, from_schema_version: int) -> None:
                         phase_lowest_sv INT UNSIGNED DEFAULT NULL,
                         last_encounter_time DATETIME
                     )
-                    """
-                )
-            )
+                    """))
 
-            self._execute_write(
-                dedent(
-                    """
+            self._execute_write(dedent("""
                     CREATE TABLE shiny_phases (
                         shiny_phase_id INT UNSIGNED PRIMARY KEY,
                         start_time DATETIME NOT NULL,
@@ -1379,13 +1363,9 @@ def _update_schema(self, from_schema_version: int) -> None:
                         snapshot_species_encounters INT UNSIGNED DEFAULT NULL,
                         snapshot_species_shiny_encounters INT UNSIGNED DEFAULT NULL
                     )
-                    """
-                )
-            )
+                    """))
 
-            self._execute_write(
-                dedent(
-                    """
+            self._execute_write(dedent("""
                     CREATE TABLE encounters (
                         encounter_id INT UNSIGNED PRIMARY KEY,
                         species_id INT UNSIGNED NOT NULL,
@@ -1402,50 +1382,32 @@ def _update_schema(self, from_schema_version: int) -> None:
                         outcome INT UNSIGNED DEFAULT NULL,
                         data BLOB NOT NULL
                     )
-                    """
-                )
-            )
+                    """))
 
-            self._execute_write(
-                dedent(
-                    """
+            self._execute_write(dedent("""
                     CREATE TABLE pickup_items (
                         item_id INT UNSIGNED PRIMARY KEY,
                         item_name TEXT NOT NULL,
                         times_picked_up INT NOT NULL DEFAULT 0
                     )
-                    """
-                )
-            )
+                    """))
 
         if from_schema_version <= 1:
-            self._execute_write(
-                dedent(
-                    """
+            self._execute_write(dedent("""
                     ALTER TABLE shiny_phases
                         ADD pokenav_calls INT UNSIGNED DEFAULT 0
-                    """
-                )
-            )
+                    """))
 
-            self._execute_write(
-                dedent(
-                    """
+            self._execute_write(dedent("""
                     DROP TABLE base_data
-                    """
-                )
-            )
+                    """))
 
-            self._execute_write(
-                dedent(
-                    """
+            self._execute_write(dedent("""
                     CREATE TABLE base_data (
                         data_key TEXT PRIMARY KEY,
                         value TEXT DEFAULT NULL
                     )
-                    """
-                )
-            )
+                    """))
 
         self._execute_write("DELETE FROM schema_version")
         self._execute_write("INSERT INTO schema_version VALUES (?)", (current_schema_version,))

modules/web/http.py

@@ -43,7 +43,6 @@
 from modules.version import pokebot_version, pokebot_name
 from modules.web.http_stream import add_subscriber
 
-
 custom_state: dict = {}
 
 

modules/web/static/stream-overlay/content/route-encounters.js

@@ -167,7 +167,7 @@ const updateRouteEncountersList = (encounters, stats, encounterType, checklistCo
             catches.push(missedShiniesLabel);
         }
 
-        if (goal && species.catches >= goal) {
+        if (goal && (species.catches >= goal || species.species_name === "Gloom" || species.species_name === "Wobbuffet")) {
             const tick = document.createElement("img")
             tick.src = "/static/sprites/stream-overlay/tick.png";
             tick.classList.add("tick");

modules/web/static/stream-overlay/content/safari-rates.js

@@ -0,0 +1,34 @@
+/** @type {HTMLDivElement} */
+const safariRatesBox = document.getElementById("safari-rates");
+
+const sectionChecklistBox = document.getElementById("section-checklist");
+
+/** @type {HTMLSpanElement} */
+const safariCatchRateLabel = document.getElementById("safari_catch_rate");
+/** @type {HTMLSpanElement} */
+const safariEscapeRateLabel = document.getElementById("safari_escape_rate");
+
+/**
+ * @param {number|null} catchRate
+ * @param {number|null} escapeRate
+ */
+const showSafariRates = (catchRate, escapeRate) => {
+    if (catchRate === null || escapeRate === null) {
+        hideSafariRates();
+        return;
+    }
+
+    safariCatchRateLabel.innerText = (catchRate * 100).toFixed(1) + "%";
+    safariEscapeRateLabel.innerText = (100 * escapeRate).toFixed(0) + "%";
+
+    safariRatesBox.style.display = "block";
+    sectionChecklistBox.style.display = "none";
+}
+
+const hideSafariRates = () => {
+    safariRatesBox.style.display = "none";
+    sectionChecklistBox.style.display = "block";
+}
+
+
+export {showSafariRates};

modules/web/static/stream-overlay/index.html

@@ -197,6 +197,16 @@ <h2>
         </h2>
         <ul></ul>
     </div>
+    <div class="content-box" id="safari-rates">
+        <h2>
+            <img src="../sprites/items/Safari%20Ball.png" style="transform: scale(1.44)">Safari Zone Encounter
+        </h2>
+        <div>
+            <p><small>Odds of being caught each turn:</small> <strong id="safari_catch_rate">?</strong></p>
+            <p><small>Odds of running away each turn:</small> <strong id="safari_escape_rate">?</strong></p>
+            <small>!safaristrat</small>
+        </div>
+    </div>
     <div class="content-box" id="section-checklist">
         <h2>
             <img src="../sprites/stream-overlay/target.png">Shiny Pokemon needed before the next gym