feat: Delay map loading to avoid modified content kick

Author: cetteup

BF2AutoSpectator/common/config.py

@@ -22,6 +22,7 @@ class Config(metaclass=Singleton):
     __tesseract_path: str
     __limit_rtl: bool
     __instance_rtl: int
+    __map_load_delay: int
 
     __use_controller: bool
     __controller_base_uri: str
@@ -40,7 +41,7 @@ class Config(metaclass=Singleton):
     __player_rotation_paused_until: datetime = None
 
     def set_options(self, player_name: str, player_pass: str, server_ip: str, server_port: str, server_pass: str,
-                    server_mod: str, game_path: str, tesseract_path: str, limit_rtl: bool, instance_rtl: int,
+                    server_mod: str, game_path: str, tesseract_path: str, limit_rtl: bool, instance_rtl: int, map_load_delay: int,
                     use_controller: bool, controller_base_uri: str, control_obs: bool, obs_url: str,
                     resolution: str, debug_screenshot: bool,
                     min_iterations_on_player: int, max_iterations_on_player: int,
@@ -56,6 +57,7 @@ def set_options(self, player_name: str, player_pass: str, server_ip: str, server
         self.__tesseract_path = tesseract_path
         self.__limit_rtl = limit_rtl
         self.__instance_rtl = instance_rtl
+        self.__map_load_delay = map_load_delay
 
         self.__use_controller = use_controller
         self.__controller_base_uri = controller_base_uri
@@ -122,6 +124,9 @@ def limit_rtl(self) -> bool:
     def get_instance_trl(self) -> int:
         return self.__instance_rtl
 
+    def get_map_load_delay(self) -> int:
+        return self.__map_load_delay
+
     def use_controller(self) -> bool:
         return self.__use_controller
 

BF2AutoSpectator/common/constants.py

@@ -59,7 +59,8 @@
                 'score-list': (10, 42, 1071, 677),
                 'top-players': (221, 42, 860, 677),
                 'top-scores': (434, 42, 647, 677),
-                'map-briefing': (646, 42, 435, 677)
+                'map-briefing': (646, 42, 435, 677),
+                'loading-bar': (9, 685, 1220, 22)
             },
             'spawn-menu': {
                 'close-button': (1232, 38, 23, 664)
@@ -116,7 +117,8 @@
                 'score-list': (12, 53, 1339, 846),
                 'top-players': (276, 53, 1075, 846),
                 'top-scores': (542, 53, 809, 846),
-                'map-briefing': (808, 53, 543, 846)
+                'map-briefing': (808, 53, 543, 846),
+                'loading-bar': (12, 858, 1525, 27)
             },
             'spawn-menu': {
                 'close-button': (1541, 47, 30, 830)

BF2AutoSpectator/game/instance_manager.py

@@ -337,6 +337,19 @@ def is_map_loading(self) -> bool:
         # Check if game is on round end screen
         return self.is_round_end_screen_visible() and not join_game_button_present
 
+    def is_loading_bar_visible(self) -> bool:
+        histogram = histogram_screenshot_region(
+            self.game_window,
+            constants.COORDINATES[self.resolution]['hists']['eor']['loading-bar']
+        )
+
+        delta = calc_cv2_hist_delta(
+            histogram,
+            self.histograms[self.resolution]['eor']['loading-bar']
+        )
+
+        return delta < constants.HISTCMP_MAX_DELTA
+
     def is_map_briefing_visible(self) -> bool:
         return 'map briefing' in ocr_screenshot_game_window_region(
             self.game_window,
@@ -643,6 +656,33 @@ def disconnect_from_server(self) -> bool:
         # We should still be in the menu but see the "play now" button instead of the "disconnect" button
         return self.is_in_menu() and self.is_play_now_button_visible()
 
+    def delay_map_load(self, delay: int) -> bool:
+        if not self.state.map_loading():
+            return False
+
+        check_count = 0
+        check_limit = 5
+        started_loading = False
+        while not started_loading and check_count < check_limit:
+            started_loading = self.is_loading_bar_visible()
+            if not started_loading:
+                check_count += 1
+                time.sleep(1)
+
+        if not started_loading:
+            return False
+
+        # Toggling ALT somehow "pauses"/"resumes" the game while keeping the audio running
+        # In contrast, BF2mld's approach of suspending the process pauses the audio (not ideal with loading music on)
+        logger.debug('Suspending map load')
+        pyautogui.press('alt')
+        time.sleep(delay)
+
+        logger.debug('Resuming map load')
+        pyautogui.press('alt')
+
+        return True
+
     def toggle_hud(self, direction: int) -> bool:
         return self.issue_console_command(f'renderer.drawHud {str(direction)}')
 

BF2AutoSpectator/game/instance_state.py

@@ -21,6 +21,7 @@ class GameInstanceState:
     __server_player_count: int = -1
 
     # Map details (map is as in one entry in the map rotation)
+    __rotation_map_load_delayed: bool = False
     __rotation_map_name: str = None
     __rotation_map_size: int = -1
     __rotation_game_mode: str = None
@@ -114,6 +115,12 @@ def set_server_player_count(self, player_count: int):
     def get_server_player_count(self) -> int:
         return self.__server_player_count
 
+    def set_rotation_map_load_delayed(self, delayed: bool):
+        self.__rotation_map_load_delayed = delayed
+
+    def rotation_map_load_delayed(self) -> bool:
+        return self.__rotation_map_load_delayed
+
     def set_rotation_map_name(self, map_name: str):
         self.__rotation_map_name = map_name
 
@@ -200,6 +207,7 @@ def halted(self, grace_period: float = 0.0) -> bool:
     # Reset relevant fields after map rotation
     def map_rotation_reset(self):
         self.__active_join_possible_after = None
+        self.__rotation_map_load_delayed = False
         self.__rotation_map_name = None
         self.__rotation_map_size = -1
         self.__rotation_game_mode = None
@@ -235,6 +243,7 @@ def restart_reset(self):
         self.__map_loading = False
         self.__active_join_possible_after = None
         self.__round_num = 0
+        self.__rotation_map_load_delayed = False
         self.__rotation_map_name = None
         self.__rotation_map_size = -1
         self.__rotation_game_mode = None

BF2AutoSpectator/spectate.py

@@ -38,6 +38,9 @@ def run():
     parser.add_argument('--min-iterations-on-player',
                         help='Number of iterations to stay on a player before allowing the next_player command',
                         type=int, default=1)
+    parser.add_argument('--map-load-delay',
+                        help='Number of seconds to delay map loading by (think: BF2mld)',
+                        type=int, default=5)
     parser.add_argument('--use-controller', dest='use_controller', action='store_true')
     parser.add_argument('--controller-base-uri', help='Base uri of web controller', type=str)
     parser.add_argument('--control-obs', dest='control_obs', action='store_true')
@@ -63,6 +66,7 @@ def run():
         tesseract_path=args.tesseract_path,
         limit_rtl=args.limit_rtl,
         instance_rtl=args.instance_rtl,
+        map_load_delay=args.map_load_delay,
         use_controller=args.use_controller,
         controller_base_uri=args.controller_base_uri,
         control_obs=args.control_obs,
@@ -547,6 +551,12 @@ def run():
                 cc.update_game_phase(GamePhase.betweenRounds)
                 gis.map_rotation_reset()
                 continue
+
+            # Suspend/delay map loading to avoid a modified content kick on map switches
+            delay = config.get_map_load_delay()
+            if delay > 0 and not gis.rotation_map_load_delayed() and gim.delay_map_load(delay):
+                gis.set_rotation_map_load_delayed(True)
+
             # Set loading phase *after* between rounds phase to make sure we go spectating -> between rounds -> loading
             cc.update_game_phase(GamePhase.loading)
             time.sleep(3)