Add off-map spawn locations.

The AI isn't making use of these yet, but it's not smart enough to do so
anyway.

Would benefit from an icon to differentiate it on the map.

I'm stretching the definition of "control point" quite a bit. We might
want to put a class above `ControlPoint` for `AirSpawnLocation` to
represent types of spawn locations that can't be captured and don't have
ground objectives.

Fixes https://github.com/Khopa/dcs_liberation/issues/274

game/game.py

@@ -26,7 +26,7 @@ from .event.frontlineattack import FrontlineAttackEvent
 from .factions.faction import Faction
 from .infos.information import Information
 from .settings import Settings
-from .theater import ConflictTheater, ControlPoint
+from .theater import ConflictTheater, ControlPoint, OffMapSpawn
 from .weather import Conditions, TimeOfDay
 
 COMMISION_UNIT_VARIETY = 4
@@ -289,6 +289,9 @@ class Game:
         if len(potential_cp_armor) == 0:
             potential_cp_armor = self.theater.enemy_points()
 
+        potential_cp_armor = [p for p in potential_cp_armor if
+                              not isinstance(p, OffMapSpawn)]
+
         i = 0
         potential_units = db.FACTIONS[self.enemy_name].frontline_units
 

game/theater/conflicttheater.py

@@ -16,6 +16,7 @@ from dcs.countries import (
 )
 from dcs.country import Country
 from dcs.mapping import Point
+from dcs.planes import F_15C
 from dcs.ships import (
     CVN_74_John_C__Stennis,
     LHA_1_Tarawa,
@@ -31,11 +32,17 @@ from dcs.terrain import (
     thechannel,
 )
 from dcs.terrain.terrain import Airport, Terrain
-from dcs.unitgroup import Group, ShipGroup, StaticGroup, VehicleGroup
+from dcs.unitgroup import (
+    FlyingGroup,
+    Group,
+    ShipGroup,
+    StaticGroup,
+    VehicleGroup,
+)
 from dcs.vehicles import AirDefence, Armor
 
 from gen.flights.flight import FlightType
-from .controlpoint import ControlPoint, MissionTarget
+from .controlpoint import ControlPoint, MissionTarget, OffMapSpawn
 from .landmap import Landmap, load_landmap, poly_contains
 from ..utils import nm_to_meter
 
@@ -94,6 +101,8 @@ class MizCampaignLoader:
     BLUE_COUNTRY = CombinedJointTaskForcesBlue()
     RED_COUNTRY = CombinedJointTaskForcesRed()
 
+    OFF_MAP_UNIT_TYPE = F_15C.id
+
     CV_UNIT_TYPE = CVN_74_John_C__Stennis.id
     LHA_UNIT_TYPE = LHA_1_Tarawa.id
     FRONT_LINE_UNIT_TYPE = Armor.APC_M113.id
@@ -175,6 +184,11 @@ class MizCampaignLoader:
     def red(self) -> Country:
         return self.country(blue=False)
 
+    def off_map_spawns(self, blue: bool) -> Iterator[FlyingGroup]:
+        for group in self.country(blue).plane_group:
+            if group.units[0].type == self.OFF_MAP_UNIT_TYPE:
+                yield group
+
     def carriers(self, blue: bool) -> Iterator[ShipGroup]:
         for group in self.country(blue).ship_group:
             if group.units[0].type == self.CV_UNIT_TYPE:
@@ -236,6 +250,12 @@ class MizCampaignLoader:
                 control_points[control_point.id] = control_point
 
         for blue in (False, True):
+            for group in self.off_map_spawns(blue):
+                control_point = OffMapSpawn(next(self.control_point_id),
+                                            str(group.name), group.position)
+                control_point.captured = blue
+                control_point.captured_invert = group.late_activation
+                control_points[control_point.id] = control_point
             for group in self.carriers(blue):
                 # TODO: Name the carrier.
                 control_point = ControlPoint.carrier(

game/theater/controlpoint.py

@@ -40,6 +40,7 @@ class ControlPointType(Enum):
     LHA_GROUP = 2              # A group with a Tarawa carrier (Helicopters & Harrier)
     FARP = 4                   # A FARP, with slots for helicopters
     FOB = 5                    # A FOB (ground units only)
+    OFF_MAP = 6
 
 
 class LocationType(Enum):
@@ -364,3 +365,17 @@ class ControlPoint(MissionTarget):
                 yield from [
                     # TODO: FlightType.STRIKE
                 ]
+
+
+class OffMapSpawn(ControlPoint):
+    def __init__(self, id: int, name: str, position: Point):
+        from . import IMPORTANCE_MEDIUM, SIZE_REGULAR
+        super().__init__(id, name, position, at=position, radials=[],
+                         size=SIZE_REGULAR, importance=IMPORTANCE_MEDIUM,
+                         has_frontline=False, cptype=ControlPointType.OFF_MAP)
+
+    def capture(self, game: Game, for_player: bool) -> None:
+        raise RuntimeError("Off map control points cannot be captured")
+
+    def mission_types(self, for_player: bool) -> Iterator[FlightType]:
+        yield from []

game/theater/start_generator.py

@@ -42,8 +42,7 @@ from gen.sam.sam_group_generator import (
 from theater import (
     ConflictTheater,
     ControlPoint,
-    ControlPointType,
-    TheaterGroundObject,
+    ControlPointType, OffMapSpawn,
 )
 
 GroundObjectTemplates = Dict[str, Dict[str, Any]]
@@ -139,7 +138,13 @@ class GameGenerator:
         control_point.base.commision_points = {}
         control_point.base.strength = 1
 
+        # The tasks here are confusing. PinpointStrike for some reason means
+        # ground units.
         for task in [PinpointStrike, CAP, CAS, AirDefence]:
+            if isinstance(control_point, OffMapSpawn):
+                # Off-map spawn locations start with no aircraft.
+                continue
+
             if IMPORTANCE_HIGH <= control_point.importance <= IMPORTANCE_LOW:
                 raise ValueError(
                     f"CP importance must be between {IMPORTANCE_LOW} and "
@@ -366,6 +371,11 @@ class ControlPointGroundObjectGenerator:
             self.control_point.connected_objectives.append(g)
 
 
+class NoOpGroundObjectGenerator(ControlPointGroundObjectGenerator):
+    def generate(self) -> bool:
+        return True
+
+
 class CarrierGroundObjectGenerator(ControlPointGroundObjectGenerator):
     def generate(self) -> bool:
         if not super().generate():
@@ -660,6 +670,8 @@ class GroundObjectGenerator:
             generator = CarrierGroundObjectGenerator(self.game, control_point)
         elif control_point.cptype == ControlPointType.LHA_GROUP:
             generator = LhaGroundObjectGenerator(self.game, control_point)
+        elif isinstance(control_point, OffMapSpawn):
+            generator = NoOpGroundObjectGenerator(self.game, control_point)
         else:
             generator = AirbaseGroundObjectGenerator(self.game, control_point,
                                                      self.templates)

game/utils.py

@@ -12,3 +12,7 @@ def meter_to_nm(value_in_meter: float) -> int:
 
 def nm_to_meter(value_in_nm: float) -> int:
     return int(value_in_nm * 1852)
+
+
+def knots_to_kph(knots: float) -> int:
+    return int(knots * 1.852)