AUTOPILOT

This page lists the available autopilot Token Variables for use when creating gauges using WASM / C++.

 

 

Autopilot

Parameters Universal Var Member Description
AUTOPILOT_ACTIVE b (BOOL) Toggles the autopilot master on/off.
AUTOPILOT_AIRSPEED_ACQUISITION b (BOOL) Currently not used within the simulation.
AUTOPILOT_AIRSPEED_HOLD b (BOOL) Returns whether airspeed hold is active (1, TRUE) or not (0, FALSE).
AUTOPILOT_AIRSPEED_HOLD_CURRENT b (BOOL) Currently not used within the simulation.
AUTOPILOT_AIRSPEED_HOLD_VAR n (FLOAT64) Returns the target holding airspeed (in Knots) for the autopilot.
AUTOPILOT_AIRSPEED_MAX_CALCULATED n (FLOAT64) Can be set to limit the maximum airspeed of the autopilot to the given kcas value.
AUTOPILOT_AIRSPEED_MIN_CALCULATED n (FLOAT64) Can be set to limit the minimum airspeed of the autopilot to the given kcas value.
AUTOPILOT_ALTITUDE_ARM b (BOOL) Returns whether the autopilot is in altitude arm mode or not.
AUTOPILOT_ALTITUDE_LOCK b (BOOL) Toggles the autopilot altitude lock on or off.
AUTOPILOT_ALTITUDE_MANUALLY_TUNABLE b (BOOL) Returns whether the autopilot hold altitude is manually tuneable (1, TRUE) or not (0, FALSE). 
AUTOPILOT_ALTITUDE_SLOT_INDEX n (FLOAT64)

Index of the slot that the autopilot will use for the altitude reference. Note that there are 3 slot indices (1, 2, 3) that you can set/get normally, however you can also target slot index 0. Writing to slot 0 will overwrite all other slots with the slot 0 value, and by default the autopilot will follow slot 0 if you have not selected any slot index.

See alt_mode_slot_index for more information.
AUTOPILOT_APPROACH_ACTIVE b (BOOL) When TRUE (1), the autopilot is currently flying the approach Flight Plan (the last legs), and when FALSE (0) it's not.
AUTOPILOT_APPROACH_ARM b (BOOL) Returns TRUE (1) when the autopilot is active on the approach, once it reaches the adequate condition (in most cases, once it reaches the second-last waypoint of the flightplan).
AUTOPILOT_APPROACH_CAPTURED b (BOOL) Returns TRUE (1) when the lateral NAV mode is engaged and the angular deviation with the current tuned navigation frequency is less than 5°.
AUTOPILOT_APROACH_HOLD b (BOOL) Returns whether approach mode is active (1, TRUE) or not (0, FALSE).
AUTOPILOT_ATTITUDE_HOLD b (BOOL) Returns whether attitude hold mode is active (1, TRUE) or not (0, FALSE).
AUTOPILOT_AUTO_THROTTLE_ARM b (BOOL) Returns whether the autopilot auto-throttle is armed (1, TRUE) or not (0, FALSE).
AUTOPILOT_AVIONICS_MANAGED b (BOOL) Returns whether the autopilot has active managed avionics (1, TRUE) or not (0, FALSE).
AUTOPILOT_BACKCOURSE_HOLD b (BOOL) Returns whether the autopilot back course mode is active (1, TRUE) or not (0, FALSE).
AUTOPILOT_BANK_HOLD_REF n (FLOAT64)

The current bank-hold bank reference.

Note that if you set this, the next frame the value will be overwritten by the engine, so you may need to write to this every game frame to ensure it maintains the required value.
AUTOPILOT_BANK_MODE b (BOOL) Returns whether the autopilot bank hold mode is active (1, TRUE) or not (0, FALSE).
AUTOPILOT_CRUISE_SPEED b (BOOL) Currently not used within the simulation.
AUTOPILOT_DISENGAGED b (BOOL) Returns whether the autopilot has been disengaged (1, TRUE) or not (0, FALSE).
AUTOPILOT_GLIDESLOPE_ACTIVE b (BOOL) Returns whether the autopilot is receiving a signal from the runway beacon and is following the slope to reach the ground (1, TRUE) or not (0, FALSE).
AUTOPILOT_GLIDESLOPE_ARM b (BOOL) Returns whether the autopilot is currently active on the glideslope (1, TRUE) or not (0, FALSE).
AUTOPILOT_GLIDESLOPE_HOLD b (BOOL) Returns whether the autopilot glidslope hold is active (1, TRUE) or not (0, FALSE).
AUTOPILOT_HEADING_LOCK b (BOOL) Returns whether the autopilot heading lock is enabled (1, TRUE) or not (0, FALSE).
AUTOPILOT_HEADING_LOCK_DIR n (FLOAT64) Specifies / Returns the locked in heading for the autopilot. 
AUTOPILOT_HEADING_MANUALLY_TUNABLE b (BOOL) Returns whether the autopilot heading lock is enabled (1, TRUE) or not (0, FALSE).
AUTOPILOT_HEADING_SLOT_INDEX n (FLOAT64) Index of the slot that the autopilot will use for the heading reference. Note that there are 3 slot indices (1, 2, 3) that you can set/get normally, however you can also target slot index 0. Writing to slot 0 will overwrite all other slots with the slot 0 value, and by default the autopilot will follow slot 0 if you have not selected any slot index.
AUTOPILOT_MACH_HOLD b (BOOL) Returns whether the autopilot mach hold is enabled (1, TRUE) or not (0, FALSE).
AUTOPILOT_MACH_HOLD_VAR n (FLOAT64) Returns the target holding mach airspeed for the autopilot.
AUTOPILOT_MANAGED_INDEX n (FLOAT64) Currently not used within the simulation.
AUTOPILOT_MANAGED_SPEED_IN_MACH b (BOOL) Returns whether the autopilot managed speed is in mach (1, TRUE) or not (0, FALSE).
AUTOPILOT_MANAGED_THROTTLE_ACTIVE b (BOOL) Returns whether the autopilot managed throttle is active (1, TRUE) or not (0, FALSE).
AUTOPILOT_MAX_BANK n (FLOAT64) Returns the maximum banking angle for the autopilot, in radians.
AUTOPILOT_MAX_BANK_ID n (FLOAT64) Returns the index of the current maximum bank setting of the autopilot.
AUTOPILOT_MAX_SPEED b (BOOL) Currently not used within the simulation.
AUTOPILOT_NAV1_LOCK b (BOOL) Returns TRUE (1) if the autopilot Nav1 lock is applied, or FALSE (0) otherwise.
AUTOPILOT_PITCH_HOLD b (BOOL) Returns TRUE (1) if the autopilot pitch hold is engaged, or FALSE (0) otherwise.
AUTOPILOT_PITCH_HOLD_REF n (FLOAT64) Returns the current autotpilot reference pitch, in radians.
AUTOPILOT_RPM_HOLD b (BOOL) Returns TRUE (1) if the autopilot RPM hold is engaged, or FALSE (0) otherwise.
AUTOPILOT_RPM_SLOT_INDEX n (FLOAT64) Index of the slot that the autopilot will use for the RPM reference. Note that there are 3 slot indices (1, 2, 3) that you can set/get normally, however you can also target slot index 0. Writing to slot 0 will overwrite all other slots with the slot 0 value, and by default the autopilot will follow slot 0 if you have not selected any slot index.
AUTOPILOT_SPEED_SLOT_INDEX n (FLOAT64) Index of the slot that the autopilot will use for the speed reference. Note that there are 3 slot indices (1, 2, 3) that you can set/get normally, however you can also target slot index 0. Writing to slot 0 will overwrite all other slots with the slot 0 value, and by default the autopilot will follow slot 0 if you have not selected any slot index.
AUTOPILOT_TAKEOFF_POWER_ACTIVE b (BOOL) Returns whether the Takeoff/Go-around mode is active (1, TRUE) or not (0, FALSE).
AUTOPILOT_THROTTLE_MAX_THRUST n (FLOAT64) This can be used to set/get the thrust lever position for autopilot maximum thrust.
AUTOPILOT_VERTICAL_HOLD b (BOOL) Returns 1 (TRUE) if the autopilot has vertical hold engaged, or returns 0 (FALSE) if it isn't.
AUTOPILOT_VS_SLOT_INDEX   Index of the slot that the autopilot will use for the VS reference. Note that there are 3 slot indices (1, 2, 3) that you can set/get normally, however you can also target slot index 0. Writing to slot 0 will overwrite all other slots with the slot 0 value, and by default the autopilot will follow slot 0 if you have not selected any slot index.
AUTOPILOT_WING_LEVELER b (BOOL) Returns whether the autopilot wing-leveler is active (1, TRUE) or not (0, FALSE).
AUTOPILOT_YAW_DAMPER b (BOOL) Returns whether the autopilot yaw-damper is active (1, TRUE) or not (0, FALSE).
DECISION_ALTITUDE_MSL n (FLOAT64) Returns the design decision altitude above mean sea level.
DECISION_HEIGHT n (FLOAT64) Returns the design decision height.

 

 

Flight Director

Parameters Universal Var Member Description
FLIGHT_DIRECTOR_ACTIVE b (BOOL) Returns 1 (TRUE) if the autopilot has has the flight director active, or returns 0 (FALSE) if it isn't.
FLIGHT_DIRECTOR_BANK n (FLOAT64) Returns the reference bank angle for the flight director, in degrees.
FLIGHT_DIRECTOR_BANK_EX1 n (FLOAT64) Returns the raw reference bank angle for the flight director, in degrees.
FLIGHT_DIRECTOR_PITCH n (FLOAT64) Returns the reference pitch for the flight director, in degrees.
FLIGHT_DIRECTOR_PITCH_EX1 n (FLOAT64) Returns the raw reference pitch for the flight director, in degrees.