Support for the RenderingStatus message

Author: VirxEC

rlbot/interface.py

@@ -45,6 +45,7 @@ class SocketRelay:
     controllable_team_info_handlers: list[
         Callable[[flat.ControllableTeamInfo], None]
     ] = []
+    rendering_status_handlers: list[Callable[[flat.RenderingStatus], None]] = []
     raw_handlers: list[Callable[[flat.CoreMessage], None]] = []
 
     def __init__(
@@ -114,13 +115,11 @@ def send_msg(
             | flat.StopCommand
             | flat.SetLoadout
             | flat.InitComplete
+            | flat.RenderingStatus
         ),
     ):
         self.send_bytes(flat.InterfacePacket(msg).pack())
 
-    def remove_render_group(self, group_id: int):
-        self.send_msg(flat.RemoveRenderGroup(group_id))
-
     def stop_match(self, shutdown_server: bool = False):
         self.send_msg(flat.StopCommand(shutdown_server))
 
@@ -298,6 +297,9 @@ def handle_incoming_message(self, incoming_message: bytes) -> MsgHandlingResult:
             case flat.ControllableTeamInfo() as controllable_team_info:
                 for handler in self.controllable_team_info_handlers:
                     handler(controllable_team_info)
+            case flat.RenderingStatus() as rendering_status:
+                for handler in self.rendering_status_handlers:
+                    handler(rendering_status)
             case _:
                 self.logger.warning(
                     "Received unknown message type: %s",

rlbot/managers/bot.py

@@ -31,6 +31,7 @@ class Bot:
     index: int = -1
     name: str = ""
     player_id: int = 0
+    can_render: bool = False
 
     @property
     def spawn_id(self) -> int:
@@ -90,6 +91,9 @@ def __init__(self, default_agent_id: Optional[str] = None):
             self._handle_controllable_team_info
         )
         self._game_interface.packet_handlers.append(self._handle_packet)
+        self._game_interface.rendering_status_handlers.append(
+            self.rendering_status_update
+        )
 
         self.renderer = Renderer(self._game_interface)
 
@@ -103,15 +107,6 @@ def _try_initialize(self):
             # Not ready to initialize
             return
 
-        # Search match settings for our name
-        for player in self.match_config.player_configurations:
-            match player.variety.item:
-                case flat.CustomBot(name):
-                    if player.player_id == self.player_id:
-                        self.name = name
-                        self.logger = get_logger(self.name)
-                        break
-
         try:
             self.initialize()
         except Exception as e:
@@ -127,6 +122,24 @@ def _try_initialize(self):
     def _handle_match_config(self, match_config: flat.MatchConfiguration):
         self.match_config = match_config
         self._has_match_settings = True
+        self.can_render = (
+            match_config.enable_rendering == flat.DebugRendering.OnByDefault
+        )
+
+        # Search match settings for our name
+        for player in self.match_config.player_configurations:
+            match player.variety.item:
+                case flat.CustomBot(name):
+                    if player.player_id == self.player_id:
+                        self.name = name
+                        self.logger = get_logger(self.name)
+                        break
+        else:  # else block runs if break was not hit
+            self.logger.warning(
+                "Bot with agent id '%s' did not find itself in the match settings",
+                self._game_interface.agent_id,
+            )
+
         self._try_initialize()
 
     def _handle_field_info(self, field_info: flat.FieldInfo):
@@ -228,6 +241,34 @@ def _handle_match_communication(self, match_comm: flat.MatchComm):
             match_comm.team_only,
         )
 
+    def rendering_status_update(self, update: flat.RenderingStatus):
+        """
+        Called when the server sends a rendering status update for ANY bot or script.
+
+        By default, this will update `self.can_render` if appropriate.
+        """
+        if update.is_bot and update.index == self.index:
+            self.can_render = update.status
+
+    def update_rendering_status(
+        self,
+        status: bool,
+        index: Optional[int] = None,
+        is_bot: bool = True,
+    ):
+        """
+        Requests the server to update the status of the ability for this bot to render.
+        Will be ignored if rendering has been set to AlwaysOff in the match settings.
+        If the status is successfully updated, the `self.rendering_status_update` method will be called which will update `self.can_render`.
+
+        - `status`: `True` to enable rendering, `False` to disable.
+        - `index`: The index of the bot to update. If `None`, uses the bot's own index.
+        - `is_bot`: `True` if `index` is a bot index, `False` if it is a script index.
+        """
+        self._game_interface.send_msg(
+            flat.RenderingStatus(self.index if index is None else index, is_bot, status)
+        )
+
     def handle_match_comm(
         self,
         index: int,

rlbot/managers/hivemind.py

@@ -33,6 +33,7 @@ class Hivemind:
     indices: list[int] = []
     names: list[str] = []
     player_ids: list[int] = []
+    can_render: bool = False
 
     @property
     def spawn_ids(self) -> list[int]:
@@ -92,6 +93,9 @@ def __init__(self, default_agent_id: Optional[str] = None):
             self._handle_controllable_team_info
         )
         self._game_interface.packet_handlers.append(self._handle_packet)
+        self._game_interface.rendering_status_handlers.append(
+            self.rendering_status_update
+        )
 
         self.renderer = Renderer(self._game_interface)
 
@@ -104,16 +108,6 @@ def _try_initialize(self):
         ):
             return
 
-        # Search match settings for our spawn ids
-        for player_id in self.player_ids:
-            for player in self.match_config.player_configurations:
-                match player.variety.item:
-                    case flat.CustomBot(name):
-                        if player.player_id == player_id:
-                            self.names.append(name)
-                            self.loggers.append(get_logger(name))
-                            break
-
         try:
             self.initialize()
         except Exception as e:
@@ -131,6 +125,17 @@ def _try_initialize(self):
     def _handle_match_config(self, match_config: flat.MatchConfiguration):
         self.match_config = match_config
         self._has_match_settings = True
+
+        # Search match settings for our spawn ids
+        for player_id in self.player_ids:
+            for player in self.match_config.player_configurations:
+                match player.variety.item:
+                    case flat.CustomBot(name):
+                        if player.player_id == player_id:
+                            self.names.append(name)
+                            self.loggers.append(get_logger(name))
+                            break
+
         self._try_initialize()
 
     def _handle_field_info(self, field_info: flat.FieldInfo):
@@ -229,6 +234,36 @@ def run(
             self.retire()
             del self._game_interface
 
+    def rendering_status_update(self, update: flat.RenderingStatus):
+        """
+        Called when the server sends a rendering status update for ANY bot or script.
+
+        By default, this will update `self.can_render` if appropriate.
+        """
+        if update.is_bot and update.index in self.indices:
+            self.can_render = update.status
+
+    def update_rendering_status(
+        self,
+        status: bool,
+        index: Optional[int] = None,
+        is_bot: bool = True,
+    ):
+        """
+        Requests the server to update the status of the ability for this bot to render.
+        Will be ignored if rendering has been set to AlwaysOff in the match settings.
+        If the status is successfully updated, the `self.rendering_status_update` method will be called which will update `self.can_render`.
+
+        - `status`: `True` to enable rendering, `False` to disable.
+        - `index`: The index of the bot to update. If `None`, uses the bot's own index.
+        - `is_bot`: `True` if `index` is a bot index, `False` if it is a script index.
+        """
+        self._game_interface.send_msg(
+            flat.RenderingStatus(
+                self.indices[0] if index is None else index, is_bot, status
+            )
+        )
+
     def _handle_match_communication(self, match_comm: flat.MatchComm):
         self.handle_match_comm(
             match_comm.index,

rlbot/managers/rendering.py

@@ -55,10 +55,8 @@ class Renderer:
     _screen_height_factor = 1.0
 
     def __init__(self, game_interface: SocketRelay):
-        self._render_group: Callable[[flat.RenderGroup], None] = game_interface.send_msg
-
-        self._remove_render_group: Callable[[int], None] = (
-            game_interface.remove_render_group
+        self._send_msg: Callable[[flat.RenderGroup | flat.RemoveRenderGroup], None] = (
+            game_interface.send_msg
         )
 
     def set_resolution(self, screen_width: float, screen_height: float):
@@ -141,7 +139,7 @@ def end_rendering(self):
                 )
             return
 
-        self._render_group(flat.RenderGroup(self._current_renders, self._group_id))
+        self._send_msg(flat.RenderGroup(self._current_renders, self._group_id))
         self._current_renders.clear()
         self._group_id = None
 
@@ -151,7 +149,7 @@ def clear_render_group(self, group_id: str = DEFAULT_GROUP_ID):
         Note: It is not possible to clear render groups of other bots.
         """
         group_id_hash = Renderer._get_group_id(group_id)
-        self._remove_render_group(group_id_hash)
+        self._send_msg(flat.RemoveRenderGroup(group_id_hash))
         self._used_group_ids.discard(group_id_hash)
 
     def clear_all_render_groups(self):
@@ -160,7 +158,7 @@ def clear_all_render_groups(self):
         Note: This does not clear render groups created by other bots.
         """
         for group_id in self._used_group_ids:
-            self._remove_render_group(group_id)
+            self._send_msg(flat.RemoveRenderGroup(group_id))
         self._used_group_ids.clear()
 
     def is_rendering(self):

rlbot/managers/script.py

@@ -26,6 +26,7 @@ class Script:
 
     index: int = 0
     name: str = "UnknownScript"
+    can_render: bool = False
 
     match_config = flat.MatchConfiguration()
     field_info = flat.FieldInfo()
@@ -59,6 +60,9 @@ def __init__(self, default_agent_id: Optional[str] = None):
             self._handle_ball_prediction
         )
         self._game_interface.packet_handlers.append(self._handle_packet)
+        self._game_interface.rendering_status_handlers.append(
+            self.rendering_status_update
+        )
 
         self.renderer = Renderer(self._game_interface)
 
@@ -88,12 +92,15 @@ def _try_initialize(self):
 
     def _handle_match_config(self, match_config: flat.MatchConfiguration):
         self.match_config = match_config
+        self._has_match_settings = True
+        self.can_render = (
+            match_config.enable_rendering == flat.DebugRendering.OnByDefault
+        )
 
         for i, script in enumerate(match_config.script_configurations):
             if script.agent_id == self._game_interface.agent_id:
                 self.index = i
                 self.name = script.name
-                self._has_match_settings = True
                 break
         else:  # else block runs if break was not hit
             self.logger.warning(
@@ -180,6 +187,34 @@ def _handle_match_communication(self, match_comm: flat.MatchComm):
             match_comm.team_only,
         )
 
+    def rendering_status_update(self, update: flat.RenderingStatus):
+        """
+        Called when the server sends a rendering status update for ANY bot or script.
+
+        By default, this will update `self.can_render` if appropriate.
+        """
+        if not update.is_bot and update.index == self.index:
+            self.can_render = update.status
+
+    def update_rendering_status(
+        self,
+        status: bool,
+        index: Optional[int] = None,
+        is_bot: bool = False,
+    ):
+        """
+        Requests the server to update the status of the ability for this bot to render.
+        Will be ignored if rendering has been set to AlwaysOff in the match settings.
+        If the status is successfully updated, the `self.rendering_status_update` method will be called which will update `self.can_render`.
+
+        - `status`: `True` to enable rendering, `False` to disable.
+        - `index`: The index of the bot to update. If `None`, uses the script's own index.
+        - `is_bot`: `True` if `index` is a bot index, `False` if it is a script index.
+        """
+        self._game_interface.send_msg(
+            flat.RenderingStatus(self.index if index is None else index, is_bot, status)
+        )
+
     def handle_match_comm(
         self,
         index: int,

tests/render_test.toml

@@ -5,7 +5,7 @@ launcher = "Steam"
 [match]
 game_mode = "Soccar"
 game_map_upk = "Stadium_P"
-enable_rendering = true
+enable_rendering = "OffByDefault"
 
 [[cars]]
 type = "Human"

tests/render_test/render.py

@@ -8,6 +8,9 @@ class RenderFun(Script):
     last_state = flat.MatchPhase.Inactive
     player_count = 0
 
+    def initialize(self):
+        self.update_rendering_status(True)
+
     def handle_packet(self, packet: flat.GamePacket):
         if (
             packet.match_info.match_phase != flat.MatchPhase.Replay

tests/run_only.py

@@ -5,7 +5,7 @@
 
 DIR = Path(__file__).parent
 
-MATCH_CONFIG_PATH = DIR / "human_vs_necto.toml"
+MATCH_CONFIG_PATH = DIR / "render_test.toml"
 RLBOT_SERVER_FOLDER = DIR / "../"
 
 if __name__ == "__main__":