"""Flight plan generation. Flights are first planned generically by either the player or by the MissionPlanner. Those only plan basic information like the objective, aircraft type, and the size of the flight. The FlightPlanBuilder is responsible for generating the waypoints for the mission. """ from __future__ import annotations import math from abc import ABC from collections.abc import Iterator from dataclasses import dataclass from datetime import timedelta from functools import cached_property from typing import Any, Generic, TYPE_CHECKING, TypeGuard, TypeVar from game.typeguard import self_type_guard from game.utils import Distance, Speed, meters from .planningerror import PlanningError from ..flightwaypointtype import FlightWaypointType from ..starttype import StartType from ..traveltime import GroundSpeed, TravelTime if TYPE_CHECKING: from game.dcs.aircrafttype import FuelConsumption from game.theater import ControlPoint from ..flight import Flight from ..flightwaypoint import FlightWaypoint from ..package import Package from .formation import FormationFlightPlan from .loiter import LoiterFlightPlan from .patrolling import PatrollingFlightPlan INGRESS_TYPES = { FlightWaypointType.INGRESS_CAS, FlightWaypointType.INGRESS_ESCORT, FlightWaypointType.INGRESS_SEAD, FlightWaypointType.INGRESS_STRIKE, FlightWaypointType.INGRESS_DEAD, } @dataclass class Layout(ABC): departure: FlightWaypoint @property def waypoints(self) -> list[FlightWaypoint]: """A list of all waypoints in the flight plan, in order.""" return list(self.iter_waypoints()) def delete_waypoint(self, waypoint: FlightWaypoint) -> bool: return False def iter_waypoints(self) -> Iterator[FlightWaypoint]: """Iterates over all waypoints in the flight plan, in order.""" raise NotImplementedError LayoutT = TypeVar("LayoutT", bound=Layout) class FlightPlan(ABC, Generic[LayoutT]): def __init__(self, flight: Flight, layout: LayoutT) -> None: self.flight = flight self.layout = layout self.tot_offset = self.default_tot_offset() def __setstate__(self, state: dict[str, Any]) -> None: if "tot_offset" not in state: state["tot_offset"] = self.default_tot_offset() self.__dict__.update(state) @property def package(self) -> Package: return self.flight.package @property def waypoints(self) -> list[FlightWaypoint]: """A list of all waypoints in the flight plan, in order.""" return list(self.iter_waypoints()) def get_index_of_wpt_by_type(self, wpt_type: FlightWaypointType) -> int: index = 0 for wpt in self.waypoints: if wpt and not wpt.only_for_player: index += 1 if wpt.waypoint_type == wpt_type: return index return -1 def iter_waypoints(self) -> Iterator[FlightWaypoint]: """Iterates over all waypoints in the flight plan, in order.""" yield from self.layout.iter_waypoints() def edges( self, until: FlightWaypoint | None = None ) -> Iterator[tuple[FlightWaypoint, FlightWaypoint]]: """A list of all paths between waypoints, in order.""" waypoints = self.waypoints if until is None: last_index = len(waypoints) else: last_index = waypoints.index(until) + 1 return zip(self.waypoints[:last_index], self.waypoints[1:last_index]) def best_speed_between_waypoints( self, a: FlightWaypoint, b: FlightWaypoint ) -> Speed: """Desired ground speed between points a and b.""" factor = 1.0 if b.waypoint_type == FlightWaypointType.ASCEND_POINT: # Flights that start airborne already have some altitude and a good # amount of speed. factor = 0.5 elif b.waypoint_type == FlightWaypointType.LOITER: # On the way to the hold point the AI won't climb unless they're in # formation, so slowing down the flight lead gives them more time to # form up and climb. # https://forums.eagle.ru/forum/english/digital-combat-simulator/dcs-world-2-5/dcs-wishlist-aa/7121300-ai-flights-will-not-climb-to-hold-point-because-wingman-not-joined # # Plus, it's a loiter point so there's no reason to hurry. factor = 0.75 # TODO: Adjust if AGL. # We don't have an exact heightmap, but we should probably be performing # *some* adjustment for NTTR since the minimum altitude of the map is # near 2000 ft MSL. return GroundSpeed.for_flight(self.flight, min(a.alt, b.alt)) * factor def speed_between_waypoints(self, a: FlightWaypoint, b: FlightWaypoint) -> Speed: return self.best_speed_between_waypoints(a, b) @property def combat_speed_waypoints(self) -> set[FlightWaypoint]: return set() def fuel_consumption_between_points( self, a: FlightWaypoint, b: FlightWaypoint ) -> float | None: ppm = self.fuel_rate_to_between_points(a, b) if ppm is None: return None distance = meters(a.position.distance_to_point(b.position)) return distance.nautical_miles * ppm def fuel_rate_to_between_points( self, a: FlightWaypoint, b: FlightWaypoint ) -> float | None: if self.flight.unit_type.fuel_consumption is None: return None if a.waypoint_type is FlightWaypointType.TAKEOFF: return self.flight.unit_type.fuel_consumption.climb if b in self.combat_speed_waypoints: return self.flight.unit_type.fuel_consumption.combat return self.flight.unit_type.fuel_consumption.cruise @property def tot_waypoint(self) -> FlightWaypoint: """The waypoint that is associated with the package TOT, or None. Note that the only flight plans that should have no target waypoints are user-planned missions without any useful waypoints and flight plans that failed to generate. Nevertheless, we have to defend against it. """ raise NotImplementedError @property def tot(self) -> timedelta: return self.package.time_over_target + self.tot_offset @cached_property def bingo_fuel(self) -> int: """Bingo fuel value for the FlightPlan""" if (fuel := self.flight.unit_type.fuel_consumption) is not None: return self._bingo_estimate(fuel) return self._legacy_bingo_estimate() def _bingo_estimate(self, fuel: FuelConsumption) -> int: distance_to_arrival = self.max_distance_from(self.flight.arrival) fuel_consumed = fuel.cruise * distance_to_arrival.nautical_miles bingo = fuel_consumed + fuel.min_safe return math.ceil(bingo / 100) * 100 def _legacy_bingo_estimate(self) -> int: distance_to_arrival = self.max_distance_from(self.flight.arrival) bingo = 1000.0 # Minimum Emergency Fuel bingo += 500 # Visual Traffic bingo += 15 * distance_to_arrival.nautical_miles # TODO: Per aircraft tweaks. if self.flight.divert is not None: max_divert_distance = self.max_distance_from(self.flight.divert) bingo += 10 * max_divert_distance.nautical_miles return round(bingo / 100) * 100 @cached_property def joker_fuel(self) -> int: """Joker fuel value for the FlightPlan""" return self.bingo_fuel + 1000 def max_distance_from(self, cp: ControlPoint) -> Distance: """Returns the farthest waypoint of the flight plan from a ControlPoint. :arg cp The ControlPoint to measure distance from. """ if not self.waypoints: return meters(0) return max( [meters(cp.position.distance_to_point(w.position)) for w in self.waypoints] ) def default_tot_offset(self) -> timedelta: """This flight's offset from the package's TOT. Positive values represent later TOTs. An offset of -2 minutes is used for a flight that has a TOT 2 minutes before the rest of the package. """ return timedelta() def _travel_time_to_waypoint(self, destination: FlightWaypoint) -> timedelta: total = timedelta() if destination not in self.waypoints: raise PlanningError( f"Did not find destination waypoint {destination} in " f"waypoints for {self.flight}" ) for previous_waypoint, waypoint in self.edges(until=destination): total += self.travel_time_between_waypoints(previous_waypoint, waypoint) return total def travel_time_between_waypoints( self, a: FlightWaypoint, b: FlightWaypoint ) -> timedelta: return TravelTime.between_points( a.position, b.position, self.speed_between_waypoints(a, b) ) def tot_for_waypoint(self, waypoint: FlightWaypoint) -> timedelta | None: raise NotImplementedError def depart_time_for_waypoint(self, waypoint: FlightWaypoint) -> timedelta | None: raise NotImplementedError def request_escort_at(self) -> FlightWaypoint | None: return None def dismiss_escort_at(self) -> FlightWaypoint | None: return None def escorted_waypoints(self) -> Iterator[FlightWaypoint]: begin = self.request_escort_at() end = self.dismiss_escort_at() if begin is None or end is None: return escorting = False for waypoint in self.waypoints: if waypoint == begin: escorting = True if escorting: yield waypoint if waypoint == end: return def takeoff_time(self) -> timedelta: return self.tot - self._travel_time_to_waypoint(self.tot_waypoint) def startup_time(self) -> timedelta: start_time = ( self.takeoff_time() - self.estimate_startup() - self.estimate_ground_ops() ) # In case FP math has given us some barely below zero time, round to # zero. if math.isclose(start_time.total_seconds(), 0): start_time = timedelta() # Trim microseconds. DCS doesn't handle sub-second resolution for tasks, # and they're not interesting from a mission planning perspective so we # don't want them in the UI. # # Round down so *barely* above zero start times are just zero. start_time = timedelta(seconds=math.floor(start_time.total_seconds())) # Feature request #1309: Carrier planes should start at +1s # This is a workaround to a DCS problem: some AI planes spawn on # the 'sixpack' when start_time is zero and cause a deadlock. # Workaround: force the start_time to 1 second for these planes. if self.flight.from_cp.is_fleet and start_time.total_seconds() == 0: start_time = timedelta(seconds=1) return start_time def estimate_startup(self) -> timedelta: if self.flight.start_type is StartType.COLD: if self.flight.client_count: return timedelta(minutes=10) else: # The AI doesn't seem to have a real startup procedure. return timedelta(minutes=2) return timedelta() def estimate_ground_ops(self) -> timedelta: if self.flight.start_type in {StartType.RUNWAY, StartType.IN_FLIGHT}: return timedelta() if self.flight.from_cp.is_fleet: return timedelta(minutes=2) else: return timedelta(minutes=8) @property def mission_departure_time(self) -> timedelta: """The time that the mission is complete and the flight RTBs.""" raise NotImplementedError @self_type_guard def is_loiter(self, flight_plan: FlightPlan[Any]) -> TypeGuard[LoiterFlightPlan]: return False @self_type_guard def is_patrol( self, flight_plan: FlightPlan[Any] ) -> TypeGuard[PatrollingFlightPlan[Any]]: return False @self_type_guard def is_formation( self, flight_plan: FlightPlan[Any] ) -> TypeGuard[FormationFlightPlan]: return False