Merge pull request #2 from VirxEC/skip

Async packet handling

Author: VirxEC

rlbot/managers/bot.py

@@ -1,4 +1,5 @@
 import os
+from threading import Thread, Event
 from traceback import print_exc
 from typing import Optional
 
@@ -28,6 +29,12 @@ class Bot:
     _has_match_settings = False
     _has_field_info = False
 
+    _latest_packet = flat.GameTickPacket()
+    _lastest_prediction = flat.BallPrediction()
+    _packet_event = Event()
+    _packet_thread = None
+    _run_packet_thread = True
+
     def __init__(self):
         spawn_id = os.environ.get("RLBOT_SPAWN_IDS")
 
@@ -48,6 +55,9 @@ def __init__(self):
         )
         self._game_interface.packet_handlers.append(self._handle_packet)
 
+        self._packet_thread = Thread(target=self._packet_processor, daemon=True)
+        self._packet_thread.start()
+
         self.renderer = Renderer(self._game_interface)
 
     def _initialize_agent(self):
@@ -86,9 +96,13 @@ def _handle_field_info(self, field_info: flat.FieldInfo):
             self._initialize_agent()
 
     def _handle_ball_prediction(self, ball_prediction: flat.BallPrediction):
-        self.ball_prediction = ball_prediction
+        self._lastest_prediction = ball_prediction
 
     def _handle_packet(self, packet: flat.GameTickPacket):
+        self._latest_packet = packet
+        self._packet_event.set()
+
+    def _packet_preprocess(self, packet: flat.GameTickPacket) -> bool:
         if (
             self.index == -1
             or len(packet.players) <= self.index
@@ -107,7 +121,7 @@ def _handle_packet(self, packet: flat.GameTickPacket):
                         self.logger.error(
                             "Multiple bots in the game, please set RLBOT_SPAWN_IDS"
                         )
-                        return
+                        return False
 
                     player_index = i
                 self.index = player_index
@@ -118,17 +132,37 @@ def _handle_packet(self, packet: flat.GameTickPacket):
                     break
 
             if self.index == -1:
+                return False
+            
+        return True
+
+    def _packet_processor(self):
+        while self._run_packet_thread:
+            self._packet_event.wait()
+
+            # if the thread was unblocked,
+            # but it we're not supposed to be running,
+            # then exit
+            if not self._run_packet_thread:
                 return
 
-        try:
-            controller = self.get_output(packet)
-        except Exception as e:
-            self.logger.error("Bot %s returned an error to RLBot: %s", self.name, e)
-            print_exc()
-            return
+            self.ball_prediction = self._lastest_prediction
+            packet: flat.GameTickPacket = self._latest_packet
+
+            self._packet_event.clear()
+
+            if not self._packet_preprocess(packet):
+                continue
 
-        player_input = flat.PlayerInput(self.index, controller)
-        self._game_interface.send_player_input(player_input)
+            try:
+                controller = self.get_output(packet)
+            except Exception as e:
+                self.logger.error("Bot %s returned an error to RLBot: %s", self.name, e)
+                print_exc()
+                continue
+
+            player_input = flat.PlayerInput(self.index, controller)
+            self._game_interface.send_player_input(player_input)
 
     def run(
         self,
@@ -144,6 +178,9 @@ def run(
                 rlbot_server_port=rlbot_server_port,
             )
         finally:
+            self._run_packet_thread = False
+            self._packet_event.set()
+
             self.retire()
             del self._game_interface
 

rlbot/version.py

@@ -1,4 +1,4 @@
-__version__ = "5.0.0-beta.1"
+__version__ = "5.0.0-beta.2"
 
 
 RESET_SEQ = "\033[0m"
@@ -15,9 +15,12 @@ def _get_color(color: int) -> str:
 )
 
 RELEASE_NOTES = {
+    "5.0.0-beta.2": """
+    Ensure bots don't fall behind the most recent GameTickPacket.
+    """,
     "5.0.0-beta.1": """
     Initial iteration of the Python interface for RLBot.
-    """
+    """,
 }
 
 RELEASE_BANNER = f"""

tests/atba/atba.py

@@ -97,7 +97,7 @@ def get_output(self, packet: flat.GameTickPacket) -> flat.ControllerState:
             return self.controller
 
         if self.state_setting:
-            self.test_state_setting(packet.balls[0].physics.velocity)
+            self.test_state_setting(packet)
 
         if self.match_comms:
             # Limit packet spam
@@ -119,15 +119,27 @@ def get_output(self, packet: flat.GameTickPacket) -> flat.ControllerState:
 
         return self.controller
 
-    def test_state_setting(self, ball_velocity: flat.Vector3):
+    def test_state_setting(self, packet: flat.GameTickPacket):
         game_state = flat.DesiredGameState(
             [
                 flat.DesiredBallState(
                     flat.DesiredPhysics(
-                        velocity=flat.Vector3Partial(z=ball_velocity.z + 10)
+                        velocity=flat.Vector3Partial(
+                            z=packet.balls[0].physics.velocity.z + 10
+                        )
                     )
                 )
-            ]
+            ],
+            [
+                flat.DesiredCarState(
+                    flat.DesiredPhysics(
+                        velocity=flat.Vector3Partial(
+                            z=packet.players[i].physics.velocity.z + 1
+                        )
+                    )
+                )
+                for i in range(len(packet.players))
+            ],
         )
         self.set_game_state(game_state)
 

tests/necto/bot.py

@@ -54,6 +54,14 @@ class Necto(Bot):
     def initialize_agent(self):
         # Initialize the rlgym GameState object now that the game is active and the info is available
         self.obs_builder = NectoObsBuilder(self.field_info)
+
+        if len(self.field_info.boost_pads) != 34:
+            self.logger.warning(
+                "The standard number of boost pads is 34, but this map has %d:%s",
+                len(self.field_info.boost_pads),
+                "\n".join(map(str, self.field_info.boost_pads)),
+            )
+
         self.game_state = GameState(self.field_info, self.tick_skip)
 
         self.logger.warning(