Rename initialize_agent -> initialize

Author: VirxEC

rlbot/managers/bot.py

@@ -57,7 +57,7 @@ def __init__(self):
 
         self.renderer = Renderer(self._game_interface)
 
-    def _initialize_agent(self):
+    def _initialize(self):
         # search match settings for our name
         for player in self.match_settings.player_configurations:
             if player.spawn_id == self.spawn_id:
@@ -66,7 +66,7 @@ def _initialize_agent(self):
                 break
 
         try:
-            self.initialize_agent()
+            self.initialize()
         except Exception as e:
             self.logger.critical(
                 "Bot %s failed to initialize due the following error: %s", self.name, e
@@ -86,7 +86,7 @@ def _handle_match_settings(self, match_settings: flat.MatchSettings):
             and self._has_field_info
             and self._has_player_mapping
         ):
-            self._initialize_agent()
+            self._initialize()
 
     def _handle_field_info(self, field_info: flat.FieldInfo):
         self.field_info = field_info
@@ -97,7 +97,7 @@ def _handle_field_info(self, field_info: flat.FieldInfo):
             and self._has_match_settings
             and self._has_player_mapping
         ):
-            self._initialize_agent()
+            self._initialize()
 
     def _handle_player_mappings(self, player_mappings: flat.TeamControllables):
         self.team = player_mappings.team
@@ -111,7 +111,7 @@ def _handle_player_mappings(self, player_mappings: flat.TeamControllables):
             and self._has_match_settings
             and self._has_field_info
         ):
-            self._initialize_agent()
+            self._initialize()
 
     def _handle_ball_prediction(self, ball_prediction: flat.BallPrediction):
         self._latest_prediction = ball_prediction
@@ -260,12 +260,12 @@ def set_loadout(self, loadout: flat.PlayerLoadout, spawn_id: int):
         """
         Sets the loadout of a bot.
 
-        For use as a loadout generator, call inside of `initialize_agent`.
-        Will be ignored if called outside of `initialize_agent` when state setting is disabled.
+        For use as a loadout generator, call inside of `initialize`.
+        Will be ignored if called outside of `initialize` when state setting is disabled.
         """
         self._game_interface.send_set_loadout(flat.SetLoadout(spawn_id, loadout))
 
-    def initialize_agent(self):
+    def initialize(self):
         """
         Called for all heaver initialization that needs to happen.
         Field info, match settings, name, index, and team are fully loaded at this point, and won't return garbage data.

rlbot/managers/hivemind.py

@@ -54,15 +54,15 @@ def __init__(self):
 
         self.renderer = Renderer(self._game_interface)
 
-    def _initialize_agent(self):
+    def _initialize(self):
         # search match settings for our spawn ids
         for player in self.match_settings.player_configurations:
             if player.spawn_id in self.spawn_ids:
                 self.names.append(player.name)
                 self.loggers.append(get_logger(player.name))
 
         try:
-            self.initialize_agent()
+            self.initialize()
         except Exception as e:
             self._logger.critical(
                 "Hivemind %s failed to initialize due the following error: %s",
@@ -84,7 +84,7 @@ def _handle_match_settings(self, match_settings: flat.MatchSettings):
             and self._has_field_info
             and self._has_player_mapping
         ):
-            self._initialize_agent()
+            self._initialize()
 
     def _handle_field_info(self, field_info: flat.FieldInfo):
         self.field_info = field_info
@@ -95,7 +95,7 @@ def _handle_field_info(self, field_info: flat.FieldInfo):
             and self._has_match_settings
             and self._has_player_mapping
         ):
-            self._initialize_agent()
+            self._initialize()
 
     def _handle_player_mappings(self, player_mappings: flat.TeamControllables):
         self.team = player_mappings.team
@@ -110,7 +110,7 @@ def _handle_player_mappings(self, player_mappings: flat.TeamControllables):
             and self._has_match_settings
             and self._has_field_info
         ):
-            self._initialize_agent()
+            self._initialize()
 
     def _handle_ball_prediction(self, ball_prediction: flat.BallPrediction):
         self._latest_prediction = ball_prediction
@@ -268,12 +268,12 @@ def set_loadout(self, loadout: flat.PlayerLoadout, spawn_id: int):
         """
         Sets the loadout of a bot.
 
-        For use as a loadout generator, call inside of `initialize_agent`.
-        Will be ignored if called outside of `initialize_agent` when state setting is disabled.
+        For use as a loadout generator, call inside of `initialize`.
+        Will be ignored if called outside of `initialize` when state setting is disabled.
         """
         self._game_interface.send_set_loadout(flat.SetLoadout(spawn_id, loadout))
 
-    def initialize_agent(self):
+    def initialize(self):
         """
         Called for all heaver initialization that needs to happen.
         Field info and match settings are fully loaded at this point, and won't return garbage data.

rlbot/managers/script.py

@@ -51,12 +51,12 @@ def __init__(self):
 
         self.renderer = Renderer(self._game_interface)
 
-    def _initialize_agent(self):
+    def _initialize(self):
         self.name = self.match_settings.script_configurations[self.index].name
         self.logger = get_logger(self.name)
 
         try:
-            self.initialize_agent()
+            self.initialize()
         except Exception as e:
             self.logger.critical(
                 "Script %s failed to initialize due the following error: %s",
@@ -78,7 +78,7 @@ def _handle_match_settings(self, match_settings: flat.MatchSettings):
             and self._has_field_info
             and self._has_player_mapping
         ):
-            self._initialize_agent()
+            self._initialize()
 
     def _handle_field_info(self, field_info: flat.FieldInfo):
         self.field_info = field_info
@@ -89,7 +89,7 @@ def _handle_field_info(self, field_info: flat.FieldInfo):
             and self._has_match_settings
             and self._has_player_mapping
         ):
-            self._initialize_agent()
+            self._initialize()
 
     def _handle_player_mappings(self, player_mappings: flat.TeamControllables):
         self.team = player_mappings.team
@@ -103,7 +103,7 @@ def _handle_player_mappings(self, player_mappings: flat.TeamControllables):
             and self._has_match_settings
             and self._has_field_info
         ):
-            self._initialize_agent()
+            self._initialize()
 
     def _handle_ball_prediction(self, ball_prediction: flat.BallPrediction):
         self._latest_prediction = ball_prediction
@@ -236,7 +236,7 @@ def set_loadout(self, loadout: flat.PlayerLoadout, spawn_id: int):
         """
         self._game_interface.send_set_loadout(flat.SetLoadout(self.spawn_id, loadout))
 
-    def initialize_agent(self):
+    def initialize(self):
         """
         Called for all heaver initialization that needs to happen.
         Field info and match settings are fully loaded at this point, and won't return garbage data.

rlbot/version.py

@@ -16,6 +16,7 @@ def _get_color(color: int) -> str:
 
 RELEASE_NOTES = {
     "5.0.0-beta.9": """
+    Rename the `initialize_agent` method to `initialize`
     Update to new sockets spec
     """,
     "5.0.0-beta.8": """

tests/atba/atba.py

@@ -61,7 +61,7 @@ class Atba(Bot):
     last_send = 0
     controller = flat.ControllerState()
 
-    def initialize_agent(self):
+    def initialize(self):
         self.logger.info("Initializing agent!")
 
         num_boost_pads = len(self.field_info.boost_pads)

tests/necto/bot.py

@@ -51,7 +51,7 @@ class Necto(Bot):
     kickoff_index = -1
     ticks = tick_skip  # So we take an action the first tick
 
-    def initialize_agent(self):
+    def initialize(self):
         # Initialize the rlgym GameState object now that the game is active and the info is available
         self.obs_builder = NectoObsBuilder(self.field_info)