From 8b384f184c377c7d9dea129d9e9718a8d5da0021 Mon Sep 17 00:00:00 2001 From: Dan Albert Date: Tue, 1 Nov 2022 14:59:24 -0700 Subject: [PATCH] Add docs explaining what the assault area is. --- game/ato/flightplans/waypointbuilder.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/game/ato/flightplans/waypointbuilder.py b/game/ato/flightplans/waypointbuilder.py index ad0d97fd..61521728 100644 --- a/game/ato/flightplans/waypointbuilder.py +++ b/game/ato/flightplans/waypointbuilder.py @@ -304,6 +304,13 @@ class WaypointBuilder: return self._target_area(f"ATTACK {target.name}", target, flyover=True) def assault_area(self, target: MissionTarget) -> FlightWaypoint: + """A destination waypoint used by air-assault ground troops. + + This waypoint is an implementation detail for CTLD and should not be followed by + aircraft. + """ + # TODO: Add a property that can hide this waypoint from the player's flight + # plan. return self._target_area(f"ASSAULT {target.name}", target) @staticmethod