Better handle handle_match_communication API

Author: VirxEC

rlbot/managers/bot.py

@@ -44,7 +44,7 @@ def __init__(self):
         self._game_interface.match_settings_handlers.append(self._handle_match_settings)
         self._game_interface.field_info_handlers.append(self._handle_field_info)
         self._game_interface.match_communication_handlers.append(
-            self.handle_match_communication
+            self._handle_match_communication
         )
         self._game_interface.ball_prediction_handlers.append(
             self._handle_ball_prediction
@@ -186,8 +186,26 @@ def run(
             self.retire()
             del self._game_interface
 
-    def handle_match_communication(self, match_comm: flat.MatchComm):
-        pass
+    def _handle_match_communication(self, match_comm: flat.MatchComm):
+        self.handle_match_communication(
+            match_comm.index,
+            match_comm.team,
+            match_comm.content,
+            match_comm.display,
+            match_comm.team_only,
+        )
+
+    def handle_match_communication(
+        self,
+        index: int,
+        team: int,
+        content: bytes,
+        display: Optional[str],
+        team_only: bool,
+    ):
+        """
+        Called when a match communication is received.
+        """
 
     def send_match_comm(
         self, content: bytes, display: Optional[str] = None, team_only: bool = False

rlbot/managers/hivemind.py

@@ -46,7 +46,7 @@ def __init__(self):
         self._game_interface.match_settings_handlers.append(self._handle_match_settings)
         self._game_interface.field_info_handlers.append(self._handle_field_info)
         self._game_interface.match_communication_handlers.append(
-            self.handle_match_communication
+            self._handle_match_communication
         )
         self._game_interface.ball_prediction_handlers.append(
             self._handle_ball_prediction
@@ -191,8 +191,26 @@ def get_ball_prediction(self) -> flat.BallPrediction:
         """
         return self.ball_prediction
 
-    def handle_match_communication(self, match_comm: flat.MatchComm):
-        pass
+    def _handle_match_communication(self, match_comm: flat.MatchComm):
+        self.handle_match_communication(
+            match_comm.index,
+            match_comm.team,
+            match_comm.content,
+            match_comm.display,
+            match_comm.team_only,
+        )
+
+    def handle_match_communication(
+        self,
+        index: int,
+        team: int,
+        content: bytes,
+        display: Optional[str],
+        team_only: bool,
+    ):
+        """
+        Called when a match communication is received.
+        """
 
     def send_match_comm(
         self,

rlbot/managers/script.py

@@ -40,7 +40,7 @@ def __init__(self):
         self._game_interface.match_settings_handlers.append(self._handle_match_settings)
         self._game_interface.field_info_handlers.append(self._handle_field_info)
         self._game_interface.match_communication_handlers.append(
-            self.handle_match_communication
+            self._handle_match_communication
         )
         self._game_interface.ball_prediction_handlers.append(
             self._handle_ball_prediction
@@ -105,8 +105,26 @@ def run(
             self.retire()
             del self._game_interface
 
-    def handle_match_communication(self, match_comm: flat.MatchComm):
-        pass
+    def _handle_match_communication(self, match_comm: flat.MatchComm):
+        self.handle_match_communication(
+            match_comm.index,
+            match_comm.team,
+            match_comm.content,
+            match_comm.display,
+            match_comm.team_only,
+        )
+
+    def handle_match_communication(
+        self,
+        index: int,
+        team: int,
+        content: bytes,
+        display: Optional[str],
+        team_only: bool,
+    ):
+        """
+        Called when a match communication is received.
+        """
 
     def send_match_comm(
         self, content: bytes, display: Optional[str] = None, team_only: bool = False

rlbot/version.py

@@ -1,4 +1,4 @@
-__version__ = "5.0.0-beta.4"
+__version__ = "5.0.0-beta.5"
 
 
 RESET_SEQ = "\033[0m"
@@ -15,6 +15,9 @@ def _get_color(color: int) -> str:
 )
 
 RELEASE_NOTES = {
+    "5.0.0-beta.5": """
+    Better handle `handle_match_communication` API
+    """,
     "5.0.0-beta.4": """
     Better state setting API
     """,

tests/atba/atba.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import math
+from typing import Optional
 
 from rlbot import flat
 from rlbot.managers import Bot
@@ -77,10 +78,15 @@ def initialize_agent(self):
         )
         self.renderer.end_rendering()
 
-    def handle_match_communication(self, match_comm: flat.MatchComm):
-        self.logger.info(
-            f"Received match communication from index {match_comm.index}! {match_comm.display}"
-        )
+    def handle_match_communication(
+        self,
+        index: int,
+        team: int,
+        content: bytes,
+        display: Optional[str],
+        team_only: bool,
+    ):
+        self.logger.info(f"Received match communication from index {index}! {display}")
 
     def get_output(self, packet: flat.GameTickPacket) -> flat.ControllerState:
         if self.rendering: