Add docs explaining what the assault area is.

This commit is contained in:
Dan Albert 2022-11-01 14:59:24 -07:00 committed by RndName
parent d81ba04ba5
commit 8b384f184c

View File

@ -304,6 +304,13 @@ class WaypointBuilder:
return self._target_area(f"ATTACK {target.name}", target, flyover=True) return self._target_area(f"ATTACK {target.name}", target, flyover=True)
def assault_area(self, target: MissionTarget) -> FlightWaypoint: 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) return self._target_area(f"ASSAULT {target.name}", target)
@staticmethod @staticmethod