Change walls for impossible ramps (HonorgroundsLE) so that they return None or empty set instead of crashing the game

Author: BurnySc2

examples/terran/ramp_wall.py

@@ -43,30 +43,36 @@ async def on_step(self, iteration):
         # Uncomment the following if you want to build 3 supplydepots in the wall instead of a barracks in the middle + 2 depots in the corner
         # depot_placement_positions = self.main_base_ramp.corner_depots | {self.main_base_ramp.depot_in_middle}
 
-        barracks_placement_position = None
         barracks_placement_position = self.main_base_ramp.barracks_correct_placement
         # If you prefer to have the barracks in the middle without room for addons, use the following instead
         # barracks_placement_position = self.main_base_ramp.barracks_in_middle
 
         depots = self.units(SUPPLYDEPOT) | self.units(SUPPLYDEPOTLOWERED)
 
         # Draw ramp points
-        # def terrain_to_z_height(h):
-        #     return round(16 * h / 255, 2)
-
-        # for ramp in self.game_info.map_ramps:
-        #     for p in ramp.points:
-        #         h = self.get_terrain_height(p)
-        #         h2 = terrain_to_z_height(h)
-        #         pos = Point3((p.x, p.y, h2))
-        #         p0 = Point3((pos.x - 0.25, pos.y - 0.25, pos.z))
-        #         p1 = Point3((pos.x + 0.25, pos.y + 0.25, pos.z - 0.5))
-        #         print(f"drawing {p0} to {p1}")
-        #         self._client.debug_box_out(p0, p1, color=Point3((255, 0, 0)))
-        #
-        # await self._client.send_debug()
-
-        # Filter locations close to finished supply depots
+        def terrain_to_z_height(h):
+            return round(16 * h / 255, 2)
+
+        for ramp in self.game_info.map_ramps:
+            for p in ramp.points:
+                h = self.get_terrain_height(p)
+                h2 = terrain_to_z_height(h)
+                pos = Point3((p.x, p.y, h2))
+                p0 = Point3((pos.x - 0.25, pos.y - 0.25, pos.z))
+                p1 = Point3((pos.x + 0.25, pos.y + 0.25, pos.z - 0.5))
+                # print(f"Drawing {p0} to {p1}")
+                color=Point3((255, 0, 0))
+                if p in ramp.upper:
+                    color = Point3((0, 255, 0))
+                if p in ramp.upper2_for_ramp_wall:
+                    color = Point3((0, 255, 255))
+                if p in ramp.lower:
+                    color = Point3((0, 0, 255))
+                self._client.debug_box_out(p0, p1, color=color)
+
+        await self._client.send_debug()
+
+        # # Filter locations close to finished supply depots
         if depots:
             depot_placement_positions = {d for d in depot_placement_positions if depots.closest_distance_to(d) > 1}
 
@@ -82,7 +88,7 @@ async def on_step(self, iteration):
                 await self.do(w.build(SUPPLYDEPOT, target_depot_location))
 
         # Build barracks
-        if depots.ready.exists and self.can_afford(BARRACKS) and not self.already_pending(BARRACKS):
+        if depots.ready and self.can_afford(BARRACKS) and not self.already_pending(BARRACKS):
             if self.units(BARRACKS).amount + self.already_pending(BARRACKS) > 0:
                 return
             ws = self.workers.gathering
@@ -108,6 +114,7 @@ def main():
             "DarknessSanctuaryLE",
             "ParaSiteLE",  # Has 5 upper points at the main ramp
             "AcolyteLE",  # Has 4 upper points at the ramp to the in-base natural and 2 upper points at the small ramp
+            "HonorgroundsLE", # Has 4 or 9 upper points at the large main base ramp
         ]
     )
     sc2.run_game(

sc2/bot_ai.py

@@ -133,10 +133,17 @@ def main_base_ramp(self) -> "Ramp":
         # The reason for len(ramp.upper) in {2, 5} is:        
         # ParaSite map has 5 upper points, and most other maps have 2 upper points at the main ramp.
         # The map Acolyte has 4 upper points at the wrong ramp (which is closest to the start position).
-        self.cached_main_base_ramp = min(
-            (ramp for ramp in self.game_info.map_ramps if len(ramp.upper) in {2, 5}),
-            key=lambda r: self.start_location.distance_to(r.top_center),
-        )
+        try:
+            self.cached_main_base_ramp = min(
+                (ramp for ramp in self.game_info.map_ramps if len(ramp.upper) in {2, 5}),
+                key=lambda r: self.start_location.distance_to(r.top_center),
+            )
+        except ValueError:
+            # Hardcoded hotfix for Honorgrounds LE map, as that map has a large main base ramp with inbase natural
+            self.cached_main_base_ramp = min(
+                (ramp for ramp in self.game_info.map_ramps if len(ramp.upper) in {4, 9}),
+                key=lambda r: self.start_location.distance_to(r.top_center),
+            )
         return self.cached_main_base_ramp
 
     @property_cache_forever

sc2/game_info.py

@@ -92,8 +92,10 @@ def bottom_center(self) -> Point2:
         return pos
 
     @property_immutable_cache
-    def barracks_in_middle(self) -> Point2:
+    def barracks_in_middle(self) -> Optional[Point2]:
         """ Barracks position in the middle of the 2 depots """
+        if len(self.upper) not in {2, 5}:
+            return None
         if len(self.upper2_for_ramp_wall) == 2:
             points = self.upper2_for_ramp_wall
             p1 = points.pop().offset((self.x_offset, self.y_offset))
@@ -105,27 +107,35 @@ def barracks_in_middle(self) -> Point2:
         raise Exception("Not implemented. Trying to access a ramp that has a wrong amount of upper points.")
 
     @property_immutable_cache
-    def depot_in_middle(self) -> Point2:
+    def depot_in_middle(self) -> Optional[Point2]:
         """ Depot in the middle of the 3 depots """
         if len(self.upper2_for_ramp_wall) == 2:
             points = self.upper2_for_ramp_wall
-            p1 = points.pop().offset((self.x_offset, self.y_offset))  # still an error with pixelmap?
+            p1 = points.pop().offset((self.x_offset, self.y_offset))
             p2 = points.pop().offset((self.x_offset, self.y_offset))
             # Offset from top point to depot center is (1.5, 0.5)
-            intersects = p1.circle_intersection(p2, 2.5 ** 0.5)
+            try:
+                intersects = p1.circle_intersection(p2, 2.5 ** 0.5)
+            except AssertionError:
+                # Returns None when no placement was found, this is the case on the map Honorgrounds LE with an exceptionally large main base ramp
+                return None
             anyLowerPoint = next(iter(self.lower))
             return max(intersects, key=lambda p: p.distance_to_point2(anyLowerPoint))
         raise Exception("Not implemented. Trying to access a ramp that has a wrong amount of upper points.")
 
     @property_mutable_cache
     def corner_depots(self) -> Set[Point2]:
         """ Finds the 2 depot positions on the outside """
+        if not self.upper2_for_ramp_wall:
+            return set()
         if len(self.upper2_for_ramp_wall) == 2:
             points = self.upper2_for_ramp_wall
-            p1 = points.pop().offset((self.x_offset, self.y_offset))  # still an error with pixelmap?
+            p1 = points.pop().offset((self.x_offset, self.y_offset))
             p2 = points.pop().offset((self.x_offset, self.y_offset))
             center = p1.towards(p2, p1.distance_to_point2(p2) / 2)
             depotPosition = self.depot_in_middle
+            if depotPosition is None:
+                return set()
             # Offset from middle depot to corner depots is (2, 1)
             intersects = center.circle_intersection(depotPosition, 5 ** 0.5)
             return intersects
@@ -140,8 +150,10 @@ def barracks_can_fit_addon(self) -> bool:
         raise Exception("Not implemented. Trying to access a ramp that has a wrong amount of upper points.")
 
     @property_immutable_cache
-    def barracks_correct_placement(self) -> Point2:
+    def barracks_correct_placement(self) -> Optional[Point2]:
         """ Corrected placement so that an addon can fit """
+        if self.barracks_in_middle is None:
+            return None
         if len(self.upper2_for_ramp_wall) == 2:
             if self.barracks_can_fit_addon:
                 return self.barracks_in_middle

test/test_pickled_data.py

@@ -169,15 +169,23 @@ def test_game_info(self, bot: BotAI):
 
         # Test if main base ramp works
         ramp: Ramp = bot.main_base_ramp
-        assert ramp.barracks_correct_placement
-        assert ramp.barracks_in_middle
-        assert ramp.depot_in_middle
-        assert len(ramp.corner_depots) == 2
+        # On the map HonorgroundsLE, the main base is large and it would take a bit of effort to fix, so it returns None or empty set
+        if len(ramp.upper) in {2, 5}:
+            assert ramp.barracks_correct_placement
+            assert ramp.barracks_in_middle
+            assert ramp.depot_in_middle
+            assert len(ramp.corner_depots) == 2
+            assert ramp.upper2_for_ramp_wall
+        else:
+            # On maps it is unable to find valid wall positions (Honorgrounds LE) it should return None
+            assert ramp.barracks_correct_placement is None
+            assert ramp.barracks_in_middle is None
+            assert ramp.depot_in_middle is None
+            assert ramp.corner_depots == set()
         assert ramp.top_center
         assert ramp.bottom_center
         assert ramp.size
         assert ramp.points
-        assert ramp.upper2_for_ramp_wall
         assert ramp.upper
         assert ramp.lower