clean up Wild Zone Entrance

Author: Gin

SerialPrograms/Source/PokemonLZA/Programs/PokemonLZA_BasicNavigation.cpp

@@ -9,7 +9,7 @@
 #include "CommonTools/Async/InferenceRoutines.h"
 #include "CommonTools/VisualDetectors/BlackScreenDetector.h"
 #include "NintendoSwitch/Commands/NintendoSwitch_Commands_PushButtons.h"
-//#include "NintendoSwitch/Commands/NintendoSwitch_Commands_Superscalar.h"
+#include "NintendoSwitch/Commands/NintendoSwitch_Commands_Superscalar.h"
 #include "NintendoSwitch/Controllers/NintendoSwitch_ProController.h"
 #include "NintendoSwitch/NintendoSwitch_ConsoleHandle.h"
 #include "PokemonLZA/Inference/Map/PokemonLZA_DirectionArrowDetector.h"
@@ -21,11 +21,7 @@
 #include "PokemonLZA/Inference/PokemonLZA_SelectionArrowDetector.h"
 #include "PokemonLZA_BasicNavigation.h"
 
-namespace PokemonAutomation{
-namespace NintendoSwitch{
-namespace PokemonLZA{
-
-
+namespace PokemonAutomation::NintendoSwitch::PokemonLZA{
 
 bool save_game_to_menu(ConsoleHandle& console, ProControllerContext& context){
 
@@ -421,6 +417,40 @@ double get_current_facing_angle(
 }
 
 
+void leave_zone_gate(ConsoleHandle& console, ProControllerContext& context){
+    console.log("Leaving zone gate");
+    OverworldPartySelectionWatcher overworld_watcher(COLOR_WHITE, &console.overlay());
+    pbf_mash_button(context, BUTTON_A, 1s);
+    context.wait_for_all_requests();
+    wait_until(
+        console, context,
+        std::chrono::seconds(40), // wait this long in case day/night change happens
+        {overworld_watcher}
+    );
+    pbf_wait(context, 100ms); // after leaving the gate, the game needs this long time to give back control
+    context.wait_for_all_requests();
+    console.overlay().add_log("Left Gate");
+    console.log("Finished leaving zone gate");
 }
+
+
+int run_towards_wild_zone_gate(
+    ConsoleHandle& console, ProControllerContext& context,
+    const ImageFloatBox& button_A_box,
+    uint8_t run_direction_x, uint8_t run_direction_y,
+    PokemonAutomation::Milliseconds run_time
+){
+    ButtonWatcher buttonA(COLOR_RED, ButtonType::ButtonA, button_A_box, &console.overlay());
+    OverworldPartySelectionOverWatcher overworld_gone(COLOR_WHITE, &console.overlay(), std::chrono::milliseconds(400));
+    return run_until<ProControllerContext>(
+        console, context,
+        [&run_time](ProControllerContext& context){
+            // running back
+            ssf_press_button(context, BUTTON_B, 0ms, run_time, 0ms);
+            pbf_move_left_joystick(context, 128, 255, run_time, 0ms);
+        },
+        {{buttonA, overworld_gone}}
+    );
 }
+
 }

SerialPrograms/Source/PokemonLZA/Programs/PokemonLZA_BasicNavigation.h

@@ -7,6 +7,7 @@
 #ifndef PokemonAutomation_PokemonLZA_BasicNavigation_H
 #define PokemonAutomation_PokemonLZA_BasicNavigation_H
 
+#include "Common/Cpp/Time.h"
 #include "PokemonLZA/Programs/PokemonLZA_Locations.h"
 
 namespace PokemonAutomation{
@@ -91,6 +92,26 @@ void wait_until_overworld(
 // - Pointing to the right is 90.0 degrees.
 double get_current_facing_angle(ConsoleHandle& console, ProControllerContext& context);
 
+// While at the gate in the zone, mash A to leave the zone.
+// If day/night change happens during this period, the function still returns after
+// day/night change finishes. You can sandwich the function with
+// `WallClock time = current_time();` to measure time spent in this function to know
+// if day/night change happens.
+void leave_zone_gate(ConsoleHandle& console, ProControllerContext& context);
+
+// Run towards a wild zone until either button A is detected at specified box region,
+// or if day/night change happens
+// Return
+// -  0 if button A is detected
+// -  1 if day/night change happens
+// - -1 if it does not reach the gate in the end. Possible reasons are wrong run direction
+//   or get stuck by terrain or obstacle on the way
+int run_towards_wild_zone_gate(
+    ConsoleHandle& console, ProControllerContext& context,
+    const ImageFloatBox& button_A_box,
+    uint8_t run_direction_x, uint8_t run_direction_y,
+    Milliseconds run_time
+);
 
 }
 }

SerialPrograms/Source/PokemonLZA/Programs/ShinyHunting/PokemonLZA_WildZoneEntrance.cpp

@@ -88,7 +88,7 @@ class ShinyHunt_WildZoneEntrance_Descriptor::Stats : public StatsTracker{
         , day_changes(m_stats["Day/Night Changes"])
     {
         m_display_order.emplace_back("Visits");
-        m_display_order.emplace_back("Chased", PreloadSettings::instance().DEVELOPER_MODE ? ALWAYS_VISIBLE : ALWAYS_HIDDEN);
+        m_display_order.emplace_back("Chased");
         m_display_order.emplace_back("Shiny Sounds");
         m_display_order.emplace_back("Game Resets");
         m_display_order.emplace_back("Errors", HIDDEN_IF_ZERO);
@@ -186,29 +186,6 @@ void go_to_entrance(
     env.console.overlay().add_log("Detect Entrance");
 }
 
-// While at the gate in the zone, mash A to leave the zone.
-// If day/night change happens during this period, the function still returns after
-// day/night change finishes, but then we don't know if the player character is still
-// in the wild zone or not.
-void leave_zone_gate(
-    SingleSwitchProgramEnvironment& env,
-    ProControllerContext& context
-){
-    env.log("Leaving zone gate");
-    OverworldPartySelectionWatcher overworld_watcher(COLOR_WHITE, &env.console.overlay());
-    pbf_mash_button(context, BUTTON_A, 1s);
-    context.wait_for_all_requests();
-    wait_until(
-        env.console, context,
-        std::chrono::seconds(40), // wait this long in case day/night change happens
-        {overworld_watcher}
-    );
-    pbf_wait(context, 100ms); // after leaving the gate, the game needs this long time to give back control
-    context.wait_for_all_requests();
-    env.console.overlay().add_log("Left Gate");
-    env.log("Finished leaving zone gate");
-}
-
 
 void fast_travel_outside_zone(
     SingleSwitchProgramEnvironment& env,
@@ -312,27 +289,19 @@ void leave_zone_and_reset_spawns(
         map_to_overworld(env.console, context);
     }
 
-    walk_time_in_zone += 2s; // give some extra time
-    env.log("Escaping");
-    env.console.overlay().add_log("Escaping Back to Entrance");
     stats.chased++;
     env.update_stats();
 
+    walk_time_in_zone += 2s; // give some extra time
+    env.log("Escaping");
+    env.console.overlay().add_log("Escaping Back to Entrance");
+    
     const double starting_angle = get_current_facing_angle(env.console, context);
 
-    ButtonWatcher buttonA(COLOR_RED, ButtonType::ButtonA, {0.3, 0.2, 0.4, 0.7}, &env.console.overlay());
-    OverworldPartySelectionOverWatcher overworld_gone(COLOR_WHITE, &env.console.overlay(), std::chrono::milliseconds(400));
-    int ret = run_until<ProControllerContext>(
-        env.console, context,
-        [&walk_time_in_zone](ProControllerContext& context){
-            // running back
-            ssf_press_button(context, BUTTON_B, 0ms, walk_time_in_zone, 0ms);
-            pbf_move_left_joystick(context, 128, 255, walk_time_in_zone, 0ms);
-        },
-        {{buttonA, overworld_gone}}
-    );
+    const ImageFloatBox button_A_box{0.3, 0.2, 0.4, 0.7};
+    int ret = run_towards_wild_zone_gate(env.console, context, button_A_box, 128, 255, walk_time_in_zone);
     switch (ret){
-    case 0:
+    case 0: // Found button A. Reached the gate.
         break;
     case 1:
         env.log("Day/night change happened while escaping");
@@ -347,7 +316,6 @@ void leave_zone_and_reset_spawns(
             env.log("Facing angle difference after day/night change: " + tostr_fixed(angle_between, 0) + " deg, from "
                 + tostr_fixed(starting_angle, 0) + " to " + tostr_fixed(current_facing_angle, 0) + " deg");
 
-            buttonA.reset_state();
             uint8_t joystick_y = 0;
             if (angle_between > 150.0){
                 // we are facing towards the gate
@@ -368,17 +336,7 @@ void leave_zone_and_reset_spawns(
             }
 
             // Running forward or backward depends on character facing to go back to zone entrance
-            // Since day/night change just happened, we are sure this running sequence won't be interrupted
-            // by day/night change again. So no need to call overworld detector.
-            ret = run_until<ProControllerContext>(
-                env.console, context,
-                [&walk_time_in_zone, &joystick_y](ProControllerContext& context){
-                    // running forward
-                    ssf_press_button(context, BUTTON_B, 0ms, walk_time_in_zone, 0ms);
-                    pbf_move_left_joystick(context, 128, joystick_y, walk_time_in_zone, 0ms);
-                },
-                {{buttonA}}
-            );
+            ret = run_towards_wild_zone_gate(env.console, context, button_A_box, 128, joystick_y, walk_time_in_zone);
             if (ret != 0){
                 stats.errors++;
                 env.update_stats();
@@ -415,7 +373,7 @@ void leave_zone_and_reset_spawns(
     env.console.overlay().add_log("Found Button A. Leaving Zone");
 
     WallClock start_time = current_time();
-    leave_zone_gate(env, context);
+    leave_zone_gate(env.console, context);
     WallClock end_time = current_time();
     shiny_sound_handler.process_pending(context);
 
@@ -460,7 +418,7 @@ void leave_zone_and_reset_spawns(
     map_to_overworld(env.console, context);
     // Mash A to leave zone gate
     env.log("Mashing A again to leave zone");
-    leave_zone_gate(env, context);
+    leave_zone_gate(env.console, context);
     // Do a fast travel outside the gate to reset spawns
     env.log("Finally, we should have left the zone");
     fast_travel_outside_zone(env, context, wild_zone, to_max_zoom_level_on_map, std::move(extra_eror_msg));