refactor LA MMO Finder code

Author: Gin

SerialPrograms/CMakeLists.txt

@@ -896,16 +896,16 @@ file(GLOB MAIN_SOURCES
     Source/NintendoSwitch/Controllers/SerialPABotBase/NintendoSwitch_SerialPABotBase_WirelessJoycon.h
     Source/NintendoSwitch/Controllers/SerialPABotBase/NintendoSwitch_SerialPABotBase_WirelessProController.cpp
     Source/NintendoSwitch/Controllers/SerialPABotBase/NintendoSwitch_SerialPABotBase_WirelessProController.h
+    Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase3_ControllerState.h
+    Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase3_ProController.cpp
+    Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase3_ProController.h
     Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase_Connection.cpp
     Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase_Connection.h
     Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase_Descriptor.cpp
     Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase_Descriptor.h
     Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase_ProController.cpp
     Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase_ProController.h
     Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase_SelectorWidget.h
-    Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase3_ControllerState.h
-    Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase3_ProController.cpp
-    Source/NintendoSwitch/Controllers/SysbotBase/SysbotBase3_ProController.h
     Source/NintendoSwitch/DevPrograms/BoxDraw.cpp
     Source/NintendoSwitch/DevPrograms/BoxDraw.h
     Source/NintendoSwitch/DevPrograms/JoyconProgram.cpp
@@ -1342,6 +1342,8 @@ file(GLOB MAIN_SOURCES
     Source/PokemonLA/Programs/General/PokemonLA_ClothingBuyer.h
     Source/PokemonLA/Programs/General/PokemonLA_DistortionWaiter.cpp
     Source/PokemonLA/Programs/General/PokemonLA_DistortionWaiter.h
+    Source/PokemonLA/Programs/General/PokemonLA_MMORoutines.cpp
+    Source/PokemonLA/Programs/General/PokemonLA_MMORoutines.h
     Source/PokemonLA/Programs/General/PokemonLA_OutbreakFinder.cpp
     Source/PokemonLA/Programs/General/PokemonLA_OutbreakFinder.h
     Source/PokemonLA/Programs/General/PokemonLA_PokedexTasksReader.cpp

SerialPrograms/Source/PokemonLA/Programs/General/PokemonLA_OutbreakFinder.cpp

@@ -20,23 +20,20 @@
 #include "Pokemon/Resources/Pokemon_PokemonNames.h"
 #include "Pokemon/Inference/Pokemon_NameReader.h"
 #include "PokemonLA/PokemonLA_TravelLocations.h"
-#include "PokemonLA/Inference/PokemonLA_DialogDetector.h"
 #include "PokemonLA/Inference/Map/PokemonLA_MapDetector.h"
 #include "PokemonLA/Inference/Map/PokemonLA_SelectedRegionDetector.h"
 #include "PokemonLA/Inference/Map/PokemonLA_OutbreakReader.h"
-#include "PokemonLA/Inference/Map/PokemonLA_MapMissionTabReader.h"
-#include "PokemonLA/Inference/Map/PokemonLA_MapZoomLevelReader.h"
-#include "PokemonLA/Inference/Map/PokemonLA_MMOSpriteStarSymbolDetector.h"
-#include "PokemonLA/Inference/Map/PokemonLA_PokemonMapSpriteReader.h"
+#include "PokemonLA/PokemonLA_Settings.h"
 #include "PokemonLA/Programs/PokemonLA_GameEntry.h"
 #include "PokemonLA/Programs/PokemonLA_GameSave.h"
+#include "PokemonLA/Programs/PokemonLA_RegionNavigation.h"
 #include "PokemonLA/Resources/PokemonLA_AvailablePokemon.h"
 #include "PokemonLA/Resources/PokemonLA_PokemonSprites.h"
 #include "PokemonLA/Inference/Objects/PokemonLA_ButtonDetector.h"
 #include "PokemonLA/Inference/Objects/PokemonLA_MMOQuestionMarkDetector.h"
+#include "PokemonLA_MMORoutines.h"
 #include "PokemonLA_OutbreakFinder.h"
-#include "PokemonLA/Programs/PokemonLA_RegionNavigation.h"
-#include "PokemonLA/PokemonLA_Settings.h"
+
 
 #include <sstream>
 
@@ -102,36 +99,6 @@ const StringSelectDatabase& MMO_DATABASE(){
 }
 
 
-
-namespace{
-
-
-
-std::vector<std::string> load_mmo_names(){
-    return {
-        "fieldlands-mmo",
-        "mirelands-mmo",
-        "coastlands-mmo",
-        "highlands-mmo",
-        "icelands-mmo"
-    };
-}
-
-// The name of each MMO event happening at each region. Their slugs are:
-// - "fieldlands-mmo"
-// - "mirelands-mmo"
-// - "coastlands-mmo"
-// - "highlands-mmo"
-// - "icelands-mmo"
-const std::vector<std::string>& MMO_NAMES(){
-    const static std::vector<std::string> mmo_names = load_mmo_names();
-    return mmo_names;
-}
-
-
-} // anonymous namespace
-
-
 OutbreakFinder_Descriptor::OutbreakFinder_Descriptor()
     : SingleSwitchProgramDescriptor(
         "PokemonLA:OutbreakFinder",
@@ -435,244 +402,6 @@ void OutbreakFinder::goto_region_and_return(SingleSwitchProgramEnvironment& env,
     mash_A_to_change_region(env, env.console, context);
 }
 
-std::set<std::string> OutbreakFinder::enter_region_and_read_MMO(
-    SingleSwitchProgramEnvironment& env, ProControllerContext& context,
-    const std::string& mmo_name,
-    const std::set<std::string>& desired_MMOs,
-    const std::set<std::string>& desired_star_MMOs
-){
-    OutbreakFinder_Descriptor::Stats& stats = env.current_stats<OutbreakFinder_Descriptor::Stats>();
-
-    MapRegion region = MapRegion::NONE;
-    TravelLocation location = TravelLocations::instance().Fieldlands_Fieldlands;
-    Camp camp = Camp::FIELDLANDS_FIELDLANDS;
-    for(size_t i = 0; i < 5; i++){
-        if (mmo_name == MMO_NAMES()[i]){
-            switch (i){
-            case 0:
-                region = MapRegion::FIELDLANDS;
-                location = TravelLocations::instance().Fieldlands_Fieldlands;
-                camp = Camp::FIELDLANDS_FIELDLANDS;
-                break;
-            case 1:
-                region = MapRegion::MIRELANDS;
-                location = TravelLocations::instance().Mirelands_Mirelands;
-                camp = Camp::MIRELANDS_MIRELANDS;
-                break;
-            case 2:
-                region = MapRegion::COASTLANDS;
-                location = TravelLocations::instance().Coastlands_Beachside;
-                camp = Camp::COASTLANDS_BEACHSIDE;
-                break;
-            case 3:
-                region = MapRegion::HIGHLANDS;
-                location = TravelLocations::instance().Highlands_Highlands;
-                camp = Camp::HIGHLANDS_HIGHLANDS;
-                break;
-            case 4:
-                region = MapRegion::ICELANDS;
-                location = TravelLocations::instance().Icelands_Snowfields;
-                camp = Camp::ICELANDS_SNOWFIELDS;
-                break;
-            }
-        }
-    }
-    if (region == MapRegion::NONE){
-        throw InternalProgramError(&env.console.logger(), PA_CURRENT_FUNCTION, "No MMO region name found.");
-    }
-
-    env.log("Go to " + std::string(MAP_REGION_NAMES[int(region)]) + " to check MMO.");
-    goto_camp_from_jubilife(env, env.console, context, location);
-
-    // Open map
-    pbf_press_button(context, BUTTON_MINUS, 50, 100);
-    context.wait_for_all_requests();
-
-    // Take a photo of the map before 
-    VideoSnapshot question_mark_image = env.console.video().snapshot();
-
-    // Fix zoom level:
-    const int zoom_level = read_map_zoom_level(question_mark_image);
-    if (zoom_level < 0){
-        OperationFailedException::fire(
-            ErrorReport::SEND_ERROR_REPORT,
-            "Canot read map zoom level.",
-            env.console
-        );
-    }
-
-    if (zoom_level == 0){
-        pbf_press_button(context, BUTTON_ZR, 50, 50);
-        context.wait_for_all_requests();
-        question_mark_image = env.console.video().snapshot();
-    }else if (zoom_level == 2){
-        pbf_press_button(context, BUTTON_ZL, 50, 50);
-        context.wait_for_all_requests();
-        question_mark_image = env.console.video().snapshot();
-    }
-
-    // Move cursor away so that it does not show a text box that occludes MMO sprites.
-    pbf_move_left_joystick(context, 0, 0, 300, 30);
-    context.wait_for_all_requests();
-
-    // Fix Missions & Requests tab:
-    if (is_map_mission_tab_raised(question_mark_image)){
-        pbf_press_button(context, BUTTON_R, 50, 100);
-        context.wait_for_all_requests();
-        question_mark_image = env.console.video().snapshot();
-    }
-
-    // Now detect question marks:
-    MMOQuestionMarkDetector question_mark_detector(env.logger());
-
-    const auto quest_results = question_mark_detector.detect_MMOs_on_region_map(question_mark_image);
-    env.log("Detected MMO question marks:");
-    for(const auto& box : quest_results){
-        std::ostringstream os;
-        os << "- " << box.center_x() << ", " << box.center_y() << " " << box.width() << " x " << box.height();
-        env.log(os.str());
-    }
-
-    // Clean the detected boxes, make them square.
-    std::vector<ImagePixelBox> new_boxes;
-    for (size_t i = 0; i < quest_results.size(); i++){
-        const auto& box = quest_results[i];
-
-        pxint_t radius = (pxint_t)((box.width() + box.height()) / 4 + 0.5);
-        pxint_t center_x = (pxint_t)box.center_x();
-        pxint_t center_y = (pxint_t)box.center_y();
-        auto new_box = ImagePixelBox(center_x - radius, center_y - radius, center_x + radius, center_y + radius);
-        new_boxes.push_back(new_box);
-    }
-
-    // Leave map view, back to overworld
-    pbf_press_button(context, BUTTON_B, 20, 50);
-
-    // Now go to Mai to see the reviewed map
-    goto_Mai_from_camp(env.logger(), context, camp);
-
-    pbf_mash_button(context, BUTTON_A, 350);
-    context.wait_for_all_requests();
-
-    // Wait for the last dialog box before the MMO pokemon sprites are revealed.
-    {
-        EventDialogDetector event_dialog_detector(env.logger(), env.console.overlay(), true);
-        int ret = wait_until(env.console, context, std::chrono::seconds(10), {{event_dialog_detector}});
-        if (ret < 0){
-            OperationFailedException::fire(
-                ErrorReport::SEND_ERROR_REPORT,
-                "Dialog box not detected when waiting for MMO map.",
-                env.console
-            );
-        }
-    }
-    pbf_press_button(context, BUTTON_B, 50, 50);
-
-    while (true){
-        EventDialogDetector event_dialog_detector(env.logger(), env.console.overlay(), true);
-        MapDetector map_detector;
-        context.wait_for_all_requests();
-        int ret = wait_until(
-            env.console, context, std::chrono::seconds(10),
-            {event_dialog_detector, map_detector}
-        );
-        switch (ret){
-        case 0:
-            env.console.log("Detected dialog.");
-            pbf_press_button(context, BUTTON_B, 20, 105);
-            continue;
-        case 1:
-            env.console.log("Found revealed map thanks to Munchlax!");
-            break;
-        default:
-            OperationFailedException::fire(
-                ErrorReport::SEND_ERROR_REPORT,
-                "Map not detected after talking to Mai.",
-                env.console
-            );
-        }
-        break;
-    }
-
-#if 0
-    MapDetector map_detector;
-    ret = wait_until(env.console, context, std::chrono::seconds(5), {{map_detector}});
-    if (ret < 0){
-        OperationFailedException::fire(
-            env.console, ErrorReport::SEND_ERROR_REPORT,
-            "Map not detected after talking to Mai.",
-            true
-        );
-    }
-    env.console.log("Found revealed map thanks to Munchlax!");
-#endif
-
-    VideoOverlaySet mmo_sprites_overlay(env.console);
-    for (size_t i = 0; i < new_boxes.size(); i++){
-        mmo_sprites_overlay.add(COLOR_BLUE, pixelbox_to_floatbox(question_mark_image, new_boxes[i]));
-    }
-
-    // Move cursor away so that it does not show a text box that occludes MMO sprites.
-    pbf_move_left_joystick(context, 0, 0, 300, 30);
-    context.wait_for_all_requests();
-
-    std::set<std::string> found;
-
-    // Check MMO results:
-    std::vector<std::string> sprites;
-    VideoSnapshot sprites_screen = env.console.video().snapshot();
-    for (size_t i = 0; i < new_boxes.size(); i++){
-        auto result = match_sprite_on_map(env.logger(), sprites_screen, new_boxes[i], region, DEBUG_MODE);
-        env.console.log("Found MMO sprite " + result.slug);
-        stats.mmo_pokemon++;
-
-        sprites.push_back(result.slug);
-        if (desired_MMOs.find(result.slug) != desired_MMOs.end()){
-            found.insert(result.slug);
-        }
-    }
-
-    // Check star MMO results:
-    std::vector<ImagePixelBox> star_boxes;
-    for (size_t i = 0; i < new_boxes.size(); i++){
-        const auto& sprite_box = new_boxes[i];
-        pxint_t radius = (pxint_t)sprite_box.width() / 2;
-        pxint_t center_x = (pxint_t)sprite_box.center_x();
-        pxint_t center_y = (pxint_t)sprite_box.center_y();
-        ImagePixelBox star_box(
-            center_x + radius/10,
-            center_y - radius*16/10,
-            center_x + radius * 5/4,
-            center_y
-        );
-        star_boxes.push_back(std::move(star_box));
-    }
-
-    MMOSpriteStarSymbolDetector star_detector(sprites_screen, star_boxes);
-
-    env.log("Detect star symbols...");
-    wait_until(env.console, context, std::chrono::seconds(5), {{star_detector}});
-    for (size_t i = 0; i < new_boxes.size(); i++){
-        std::ostringstream os;
-        os << "- " << sprites[i] << " box [" << star_boxes[i].min_x << ", " << star_boxes[i].min_y
-           << star_boxes[i].max_x << ", " << star_boxes[i].max_y << "]"
-           <<  " motion: " << star_detector.animation_value(i)
-           << " color: " << star_detector.symbol_color(i);
-        if (star_detector.is_star(i)){
-            stats.stars++;
-            os << ", has star";
-            if (desired_star_MMOs.find(sprites[i]) != desired_star_MMOs.end()){
-                found.insert(sprites[i]);
-            }
-        }
-        env.log(os.str());
-    }
-
-    env.update_stats();
-
-    return found;
-}
-
 
 std::vector<std::string> OutbreakFinder::run_iteration(
     SingleSwitchProgramEnvironment& env, ProControllerContext& context,
@@ -735,7 +464,16 @@ std::vector<std::string> OutbreakFinder::run_iteration(
         save_game_from_overworld(env, env.console, context);
 
         for(const auto& mmo_name: found_hisui_map_events){
-            std::set<std::string> found_pokemon = enter_region_and_read_MMO(env, context, mmo_name, desired_MMOs, desired_star_MMOs);
+            OutbreakFinder_Descriptor::Stats& stats = env.current_stats<OutbreakFinder_Descriptor::Stats>();
+            int num_new_mmo_pokemon_found = 0;
+            int num_new_star_mmo_found = 0;
+            std::set<std::string> found_pokemon = enter_region_and_read_MMO(
+                env, context, mmo_name, desired_MMOs, desired_star_MMOs, DEBUG_MODE,
+                num_new_mmo_pokemon_found, num_new_star_mmo_found);
+            stats.mmo_pokemon += num_new_mmo_pokemon_found;
+            stats.stars += num_new_star_mmo_found;
+            env.update_stats();
+
             if (found_pokemon.size() > 0){
                 stats.matches += found_pokemon.size();
                 std::ostringstream os;

SerialPrograms/Source/PokemonLA/Programs/General/PokemonLA_OutbreakFinder.h

@@ -68,15 +68,6 @@ class OutbreakFinder : public SingleSwitchProgramInstance{
         const std::set<std::string>& desired_events
     );
 
-    // Enter a map with MMO and read names of the pokemon appearing in the MMO.
-    // - mmo_name: MMO event slug, e.g. "fieldlands-mmo"
-    std::set<std::string> enter_region_and_read_MMO(
-        SingleSwitchProgramEnvironment& env, ProControllerContext& context,
-        const std::string& mmo_name,
-        const std::set<std::string>& desired_MMOs,
-        const std::set<std::string>& desired_star_MMOs
-    );
-
     // Go to a random wild region and return to refresh outbreaks.
     // If `inside_map` is true, the function is called when the game is inside the travel map.
     // Otherwise, the function is called when the player character is standing at the program start location.