improve restaurant farmer

Author: Gin

SerialPrograms/Source/PokemonLZA/Inference/PokemonLZA_DialogDetector.h

@@ -47,7 +47,7 @@ class NormalDialogDetector : public VisualInferenceCallback{
 
 
 
-
+// Common white dialog box
 class FlatWhiteDialogDetector : public StaticScreenDetector{
 public:
     FlatWhiteDialogDetector(Color color = COLOR_RED, VideoOverlay* overlay = nullptr);
@@ -80,7 +80,7 @@ class FlatWhiteDialogWatcher : public DetectorToFinder<FlatWhiteDialogDetector>{
 };
 
 
-
+// Blue dialog box for when receiving an item
 class BlueDialogDetector : public StaticScreenDetector{
 public:
     BlueDialogDetector(Color color = COLOR_RED, VideoOverlay* overlay = nullptr);
@@ -113,7 +113,8 @@ class BlueDialogWatcher : public DetectorToFinder<BlueDialogDetector>{
 };
 
 
-
+// A blue dialog box slightly bigger than BlueDialogDetector with item profile picture
+// that appears after BlueDialogDetector to show the item description.
 class ItemReceiveDetector : public StaticScreenDetector{
 public:
     ItemReceiveDetector(Color color = COLOR_RED, VideoOverlay* overlay = nullptr);

SerialPrograms/Source/PokemonLZA/Programs/PokemonLZA_RestaurantFarmer.cpp

@@ -91,7 +91,7 @@ void RestaurantFarmer::StopButton::set_pressed(){
 
 
 
-void RestaurantFarmer::run_lobby(SingleSwitchProgramEnvironment& env, ProControllerContext& context){
+bool RestaurantFarmer::run_lobby(SingleSwitchProgramEnvironment& env, ProControllerContext& context){
     RestaurantFarmer_Descriptor::Stats& stats = env.current_stats<RestaurantFarmer_Descriptor::Stats>();
 
     while (true){
@@ -129,15 +129,17 @@ void RestaurantFarmer::run_lobby(SingleSwitchProgramEnvironment& env, ProControl
         case 0:
             env.log("Detected A button.");
             if (m_stop_after_current.load(std::memory_order_relaxed)){
-                return;
+                return true;
             }
             pbf_press_button(context, BUTTON_A, 160ms, 80ms);
             continue;
 
         case 1:
             env.log("Detected selection arrow.");
+            // This is when the restaurant receptionist is asking whether you want
+            // to start the battle
             pbf_mash_button(context, BUTTON_A, 5000ms);
-            return;
+            return false;
 
         case 2:
             env.log("Detected white dialog.");
@@ -256,8 +258,7 @@ void RestaurantFarmer::program(SingleSwitchProgramEnvironment& env, ProControlle
 //    auto lobby = env.console.video().snapshot();
 
     while (true){
-        run_lobby(env, context);
-        if (m_stop_after_current.load(std::memory_order_relaxed)){
+        if (run_lobby(env, context)){
             break;
         }
         run_battle(env, context);

SerialPrograms/Source/PokemonLZA/Programs/PokemonLZA_RestaurantFarmer.h

@@ -46,7 +46,12 @@ class RestaurantFarmer : public SingleSwitchProgramInstance, public ButtonListen
     std::atomic<bool> m_stop_after_current;
     StopButton STOP_AFTER_CURRENT;
 
-    void run_lobby(SingleSwitchProgramEnvironment& env, ProControllerContext& context);
+    // Handle all the logic of talking to the restaurant receptionist.
+    // Return true when the user clicks the button STOP_AFTER_CURRENT and the player character stops talking to
+    // the receptionist. Return false when it enters battle.
+    bool run_lobby(SingleSwitchProgramEnvironment& env, ProControllerContext& context);
+    // Handle all battle logic. Return when it detects the blue dialog box meaning the player character is at
+    // the receptionist receiving reward items.
     void run_battle(SingleSwitchProgramEnvironment& env, ProControllerContext& context);
 };