Skip to content

Automation systems

Jump to bottom
Octol1ttle edited this page May 14, 2024 · 4 revisions

FlightAssistant's main features are automation systems. These systems are designed to automate as much flight as possible.

In order to use these systems effectively, you need to know what these systems are:

  • Selected altitude, heading and speed
  • Flight Planner
  • Flight Directors
  • Auto-firework
  • Autopilot

Selections and Flight Planner

In order for these automation systems to work correctly, they need to know what the pilot wants from them. The systems gather information either from selections or from the flight plan.

Selected flight

Selections are simple to use and aren't very powerful, but they can be useful for short-haul flights or situations where a flight plan isn't suitable.

Selections are managed via these commands:

  • /flightassistant select speed <speed>
  • /flightassistant select altitude <altitude>
  • /flightassistant select heading <heading>

Note that these selections take priority over the flight plan, use the following commands to reset them:

  • /flightassistant select speed managed
  • /flightassistant select altitude managed
  • /flightassistant select heading managed

Managed flight

Flight plans consist of waypoints and offer managed flight, with full automation from takeoff to landing. Just like selections, the flight plan is constructed via commands (right now, at least).

Note: Waypoint indexes start from zero, similar to array indexes in programming

Types of waypoints

Right now, there are 2 types of waypoints: a regular waypoint and a landing waypoint. A landing waypoint is the waypoint that will trigger landing logic in automation and other systems (for example, GPWS will suppress some terrain alerts while flying towards a landing waypoint).

The syntax for regular waypoints is: <targetX> <targetZ> [<targetAltitude>] [<targetSpeed>]. The first two arguments are required, the last two aren't, however it's recommended that a targetAltitude is set on all regular waypoints

The syntax for landing waypoints is: <targetX> <targetZ> land [<minimumAltitude> <absolute/aboveGround>]. <minimumAltitude> refers to the minimum descent altitude. absolute refers to the Y level, aboveGround refers to height above ground. While setting minimums isn't required, it's strongly recommended because they can help prevent CFIT incidents.

Restrictions on flight planning

  • You cannot add a landing waypoint as your first waypoint
  • You cannot execute the flight plan from a landing waypoint

Commands

These are the commands used to construct a flight plan:

  • /flightassistant plan add <waypoint> - add a waypoint to the end of the flight plan
  • /flightassistant plan remove <waypointIndex> - remove a waypoint located at the specified index
  • /flightassistant plan insert <insertAt> <waypoint> - insert a waypoint at the specified index, shifting waypoints down as necessary
  • /flightassistant plan replace <replaceAt> <waypoint> - replace a waypoint at the specified index
  • /flightassistant plan list - list all waypoints in flight plan
  • /flightassistant plan clear [<clearAllFrom>] - clear all waypoints starting from the specified index
  • /flightassistant plan execute [<executeFrom>] - execute the flight plan from the specified index
  • /flightassistant plan save <name> - save the flight plan to disk with the specified name
  • /flightassistant plan load <name> - load the flight plan from disk from the specified name

Executing the flight plan

After you've finished building your flight plan (and filing it with ATC), you can execute it, meaning that FlightAssistant will now use your flight plan to know where you want to go. After reaching the first waypoint, the mod will switch to the second waypoint, and then to the third, etc. Meaning that, after execution, the automation systems are fully capable to reach your destination without intervention.

Auto-firework

Auto-firework will activate fireworks in one of two scenarios:

  • Player speed decreases below the target speed
  • Player altitude is lower than the target altitude

Beside activating currently selected fireworks, Auto-firework can switch to any firework in the hotbar as long as it is not explosive.

The firework mode will display in the bottom left corner of the HUD:

  • NO FRWKS - there are no safe fireworks in the player's hotbar
  • FRWK PROT - some protection used fireworks for recovery
  • SPD or P. SPD - Auto-firework will activate below this speed. The P. prefix means that the speed was received from the flight plan.
  • FRWK CLB - Auto-firework activated to reach a higher altitude
  • FRWK IDLE - Auto-firework is idling to reach a lower altitude
  • A/FRWK ONLY - Manual firework usage is blocked, only Auto-firework can use them
  • MAN FRWK - Auto-firework is disconnected

Flight Directors and Autopilot

These systems are often used together. Flight Directors are lines that display on the HUD to show where the player needs to face to reach their destination. Following the flight directors means aligning the lines with the middle of your screen.

Autopilot follows the flight directors' commands, although these systems can be used independently.

The lateral (horizontal) and vertical modes will display in the bottom middle of the HUD:

  • Vertical
    • LAND - Landing mode is engaged, ground is detected at this altitude
    • ALT or P. ALT - This is the current target altitude. The P. prefix means that the altitude was received from the flight plan.
    • CLB or P. CLB - The autopilot is climbing to reach the target altitude. The P. prefix means that the altitude was received from the flight plan.
    • DES or P. DES - The autopilot is descending to reach the target altitude. The P. prefix means that the altitude was received from the flight plan.
    • No text - Either flight directors or autopilot are not engaged, or there's no information on where to go on the vertical axis
  • Lateral
    • HDG - This is the current selected heading
    • POS - This is the current waypoint's XZ position
    • APPR - Approach mode is engaged, this is the current landing waypoint's XZ position
    • No text - Either flight directors or autopilot are not engaged, or there's no information on where to go on the horizontal axis

Automation status

The status of automation systems will display in the bottom right of the HUD:

  • FD - Flight directors are enabled
  • A/FRWK - Auto-firework is enabled
  • AP - Autopilot is engaged
  • No text - None of these systems are engaged

This is all you need to know to operate the automation systems.

Clone this wiki locally