MSFS SDK Documentation Logo
Retail
  • SDK Documentation

Radio Navigation

IMPORTANT!

Token Variables - along with the Gauge API - have been deprecated in Microsoft Flight Simulator 2024 in favour of the new Vars API and Event API, which work with the more extensive and supported Simulation Variables and Key Events.

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

ADF

ParametersUniversal Var MemberDescription
ADF_500_HZ_TUNABLEn (FLOAT)Specifies the tuneable ADF frequency.
ADF_CARD_RADIALn (FLOAT)Specifies the ADF card cardinal direction, in degrees from 0 to 360.
ADF_EXTENDED_FREQUENCYn (FLOAT)Specifies the ADF extended frequency, Frequency BCD16 encoded.
ADF_FREQUENCYn (FLOAT)Specifies the ADF frequency, Frequency BCD16 encoded.
ADF_IDENTITYp (PVOID)Pointer to a string with the ADF identity.
ADF_MORSE_IDENTb (BOOL)This will be TRUE (1) if there is a morse signal, FALSE (0) otherwise.
ADF_NEEDLEn (FLOAT)The ADF needle position, expressed as 16-bit pseudo-degrees.
ADF_SIGNAL_STRENGTHn (FLOAT)The ADF signal strength where 0 is no signal, and 256 and above is a good signal.
ADF_SOUND_TOGGLEb (BOOL)Whether the ADF audio is on (TRUE, 1) or off (FALSE, 0).
ADF_VOLUMEn (FLOAT)The volume of the ADF output, expressed as a Percent Over 100.

ATC

ParametersUniversal Var MemberDescription
ATC_AIRPORT_IS_TOWEREDb (BOOL)This will be TRUE (1) if the airport is controlled, or FALSE (0) otherwise.
ATC_CLEARED_LANDINGb (BOOL)This will be TRUE (1) if the ATC has cleared the aircraft for landing, or FALSE (0) otherwise.
ATC_CLEARED_TAKEOFFb (BOOL)This will be TRUE (1) if the ATC has cleared the aircraft for takeoff, or FALSE (0) otherwise.
ATC_CLEARED_TAXIb (BOOL)This will be TRUE (1) if the ATC has cleared the aircraft for taxi, or FALSE (0) otherwise.
ATC_RUNWAY_AIRPORT_NAMEp (PVOID)A pointer to the name of the airport of the runway assigned by the ATC.
ATC_RUNWAY_DISTANCEn (FLOAT)This value represents the distance between the aircraft and the center of the runway selected by the ATC. Value is in meters.
ATC_RUNWAY_END_DISTANCEn (FLOAT)This value corresponds to the horizontal distance between the aircraft and the end of the runway selected by the ATC. Value is in meters.
ATC_RUNWAY_HEADING_DEGREES_TRUEn (FLOAT)This value represents the true heading of the runway selected by the ATC, in degrees.
ATC_RUNWAY_LENGTHn (FLOAT)The length of the runway assigned by the ATC, in meters. Will return -1 if no runway is assigned.
ATC_RUNWAY_RELATIVE_POSITION_Xn (FLOAT)This value corresponds to the aircraft’s main gear relative X (transverse) axis position on the runway selected by the ATC. Value is in meters.
ATC_RUNWAY_RELATIVE_POSITION_Yn (FLOAT)This value corresponds to the aircraft’s main gear relative Y (height) axis position on the runway selected by the ATC. Value is in meters.
ATC_RUNWAY_RELATIVE_POSITION_Zn (FLOAT)This value corresponds to the aircraft’s main gear relative Z (longitudinal) axis position on the runway selected by the ATC. Value is in meters.
ATC_RUNWAY_SELECTEDn (BOOL)Whether the ATC has pre-selected a runway for the aircraft (TRUE, 1) or not (FALSE, 0).
ATC_RUNWAY_START_DISTANCEn (FLOAT)This value corresponds to the horizontal distance between the aircraft and the start of the runway selected by the ATC. Value is in meters.
ATC_RUNWAY_TDPOINT_RELATIVE_POSITION_Xn (FLOAT)This value represents the aircraft main gear relative X (transverse) axis position according to the aiming point of the runway selected by the ATC. Value is in meters.
ATC_RUNWAY_TDPOINT_RELATIVE_POSITION_Yn (FLOAT)This value represents the aircraft main gear relative Y (height) axis position according to the aiming point of the runway selected by the ATC. Value is in meters.
ATC_RUNWAY_TDPOINT_RELATIVE_POSITION_Zn (FLOAT)This value represents the aircraft main gear relative Z (longitudinal) axis position according to the aiming point of the runway selected by the ATC. Value is in meters.
ATC_RUNWAY_WIDTHn (FLOAT)The width of the runway assigned by the ATC, in meters. Will return -1 if no runway is assigned.
SLOPE_TO_ATC_RUNWAYn (FLOAT)The slope between the aircraft and the expected landing position of the runway, in radians. Will return 0 if no runway is assigned.

Beacons

ParametersUniversal Var MemberDescription
MARKER_BEACON_SENSITIVITY_HIGHb (BOOL)Whether the Marker Beacon is in High Sensitivity mode (TRUE, 1) or not (FALSE, 0).
MARKER_BEACON_STATEe (ENUM)0 = no beacon1 = outer2 = middle3 = innerThe marker beacon state.
MARKER_BEACON_TEST_MUTEb (BOOL)Whether the Marker Beacon is in test/mute mode (TRUE, 1) or not (FALSE, 0).
MARKER_SOUND_TOGGLEn (FLOAT)Whether the Marker Beacon sound is on (TRUE, 1) or not (FALSE, 0).

COM

ParametersUniversal Var MemberDescription
COM_ACTIVE_FREQUENCYn (FLOAT)The COM active frequency, Frequency BCD16 encoded.
COM_BOTH_RECEIVEn (FLOAT)Whether the audio is being recieved on both COMs (TRUE , 1) or not (FALSE, 0).
COM_FREQUENCYCOM2_FREQUENCYn (FLOAT)Specifies COM 1/2 radio frequency, Frequency BCD16 encoded.
COM_RADIO_25_KHZ_TUNABLEb (BOOL)Whether the COM radio is tuneable (TRUE , 1) or not (FALSE, 0).
COM_RECEIVEb (BOOL)Whether the aircraft is receiving on this COM channel (TRUE, 1) or not (FALSE, 0).
COM_RECEIVE_EX1b (BOOL)Whether the aircraft is receiving on this COM channel (TRUE, 1) or not (FALSE, 0).
COM_STANDBY_FREQUENCYCOM_STBY_FREQUENCYCOM2_STBY_FREQUENCYn (FLOAT)Specifies COM 1/2 radio standby frequency, Frequency BCD16 encoded.
COM_VOLUMEn (FLOAT)The volume of the COM radio, as a percentage between 0 and 100.
COM1_AUTOSWITCH_ONCOM2_AUTOSWITCH_ONb (BOOL)Whether the aircraft COM switch 1/2 is on (TRUE, 1) or not (FALSE, 0).
COM1_STORED_FREQUENCYCOM2_STORED_FREQUENCYCOM3_STORED_FREQUENCYn (FLOAT)Specifies COM 1/2/3 stored frequency, Frequency BCD16 encoded.
COM1_TRANSMIT_SELECTCOM2_TRANSMIT_SELECTb (BOOL)Audio panel COM transmit state, either on (TRUE, 1) or off (FALSE, 0).

DME

ParametersUniversal Var MemberDescription
CURRENT_DMEe (ENUM)0 = DME11 = DME2The currently selected DME.
CURRENT_DME_DISTANCEn (FLOAT)The DME (1 or 2) distance, in nm.
CURRENT_DME_SPEEDn (FLOAT)The DME (1 or 2) speed, in Knots.
CURRENT_DME_MINn (FLOAT)The DME (1 or 2) minutes until arriving.
DME1_DISPLAY_TYPEDME2_DISPLAY_TYPEb (BOOL)The type of display for the DME, either TRUE (1) for the speed, in knots, or FALSE (0) for the distance readout.
DME1_DISTANCEDME2_DISTANCEn (FLOAT)The DME (1 or 2) distance readout.
DME1_MORSE_IDENTDME2_MORSE_IDENTb (BOOL)This will be TRUE (1) if there is a morse signal, FALSE (0) otherwise.
DME1_SPEEDDME2_SPEEDn (FLOAT)The DME (1 or 2) speed readout.
DME_SOUND_TOGGLEn (FLOAT)Audio panel DME audio state, either on (TRUE, 1) or off (FALSE, 0).

GPS

ParametersUniversal Var MemberDescription
GPS_DRIVES_NAV1b (BOOL)Whether the GPS is driving the Nav 1 indicator (TRUE, 1) or not (FALSE, 0).
GPS_FLAGSf (FLAGS)GPS flag settings. See GPS_FLAG_ in GAUGES.h.
GPS_FLIGHTPLAN_TOTAL_DISTANCEn (FLOAT)The GPS flightplan total distance in meters.
GPS_GROUND_HEADINGn (FLOAT)The current GPS true heading, in Radians (0 - 2PI).
GPS_GROUND_SPEEDn (FLOAT)The current ground speed, in meters per second.
GPS_GROUND_TRACKn (FLOAT)The current GPS ground track (heading + magvar, magnetic yaw), in Radians (0 - 2PI).
GPS_MAGVARn (FLOAT)The current GPS magnetic variation, in radians.
GPS_OBS_ACTIVEb (BOOL)Whether the OBS mode is currently active (TRUE, 1) or not (FALSE, 0). If TRUE, this will disable the automatic sequencing of waypoints in the GPS flight plan.
GPS_OBS_VALUEn (FLOAT)The current course set for the OBS, in degrees.
GPS_POSITION_ALTn (FLOAT)The current GPS altitude, in meters.
GPS_POSITION_LATn (FLOAT)The current GPS latitude, in latitude meters (meters * (360 / 40007000)).
GPS_POSITION_LONn (FLOAT)The current GPS longitude, in radians.
GPS_WP_BEARINGn (FLOAT)The magnetic bearing to waypoint the next heading, in radians.
GPS_WP_CROSS_TRKn (FLOAT)The cross track distance, in meters.
GPS_WP_DISTANCEn (FLOAT)Meters to next waypoint.
GPS_WP_NEXT_ALTn (FLOAT)The altitude of next waypoint, in meters.
GPS_WP_NEXT_LATn (FLOAT)The latitude of next waypoint, in degrees.
GPS_WP_NEXT_LONn (FLOAT)The longitude of next waypoint, in degrees.
GPS_WP_PREV_ALTn (FLOAT)The altitude of previous waypoint, in meters.
GPS_WP_PREV_LATn (FLOAT)The latitude of previous waypoint, in degrees.
GPS_WP_PREV_LONn (FLOAT)The longitude of previous waypoint, in degrees.
GPS_WP_REQ_HDGn (FLOAT)The required heading, magnetic, from the prev wayppoint to next waypoint, in radians.
GPS_WP_STRINGp (PVOID)The name of the next waypoint.
GPS_WP_TRUE_BEARINGn (FLOAT)The true bearing to the waypoint, in degrees.
GPS_WP_TRUE_REQ_HDGn (FLOAT)The required true heading to the waypoint, in degrees.

HSI

ParametersUniversal Var MemberDescription
HSI_BEARINGn (FLOAT)This will return the HSI needle bearing, in degrees.
HSI_BEARING_VALIDb (BOOL)This will be TRUE (1) if the HSI_BEARING variable contains valid data, or FALSE (0) otherwise.
HSI_DESIRED_HEADING_NEEDLEn (FLOAT)The HSI desired heading, in degrees.
HSI_DISTANCEn (FLOAT)The DME/GPS distance in nm.
HSI_HORIZONTAL_NEEDLEn (FLOAT)The HSI horizontal needle position between -1 and 1, which corresponds to -0.7º and 0.7º.
HSI_HORIZONTAL_VALIDb (BOOL)Whether the HSI signal is valid (TRUE, 1) or not (FALSE, 0).
HSI_OBI_NEEDLEn (FLOAT)The OBS needle setting, in degrees.
HSI_SIGNAL_LOCALISERb (BOOL)Whether the station is a localiser (TRUE, 1) or not (FALSE, 0).
HSI_SPEEDn (FLOAT)The DME/GPS speed, in Knots.
HSI_STATION_NAMEp (PVOID)The HSI station name.
HSI_TF_FLAGe (ENUM)0 = Off1 = TO2 = FROMThe HSI to/from flag setting.
HSI_VERTICAL_VALIDb (BOOL)Whether the NAV flag is on (TRUE, 1) or not (FALSE, 0).
HSI_VERTICAL_NEEDLEn (FLOAT)The HSI vertical needle position. The value returned will be between -1 and 1 (corresponding to -10º and 10º) if VOR, or between -2.5º and 2.5º if localizer, or between -5nm and 5nm if GPS.
ParametersUniversal Var MemberDescription
NAV_VOLUMEn (FLOAT)The volume of the NAV Radio, expressed as a percentage from 0 to 100.
NAV1_AUTOSWITCH_ONNAV2_AUTOSWITCH_ONb (BOOL)Whether the NAV1/2 autoswitch is on (TRUE, 1) or not (FALSE, 0).
NAV1_COMMNAV_TESTNAV2_COMMNAV_TESTb (BOOL)This will be TRUE (1) if the NAV1/2 COM system is working and FALSE (0) if it is not.
NAV1_FREQUENCYNAV2_FREQUENCYn (FLOAT)The NAV1/2 active frequency, expressed as a Frequency BCD16 value.
NAV1_MORSE_IDENTNAV2_MORSE_IDENTb (BOOL)This will be TRUE (1) if there is a morse signal, and FALSE (0) otherwise.
NAV1_SOUND_TOGGLENAV2_SOUND_TOGGLEn (FLOAT)This will be TRUE (1) if NAV1/2 audio is enabled, and FALSE (0) otherwise.
NAV1_STBY_FREQUENCYNAV2_STBY_FREQUENCYn (FLOAT)The NAV1/2 standby frequency, expressed as a Frequency BCD16 value.
NAV1_VOR_RADIALNAV2_VOR_RADIALn (FLOAT)The rdial that the aircraft is on, in radians.
TACAN_DRIVES_NAV1b (BOOL)Whether the TACAN is driving the Nav 1 indicator (TRUE, 1) or not (FALSE, 0).

Pilot

ParametersUniversal Var MemberDescription
PILOT_TRANSMITTER_TYPEe (ENUM)0 = COM11 = COM22 = COM33 = TEL4 = NONEThe channel on which the pilot is transmitting.
PILOT_TRANSMITTINGb (BOOL)Whether the pilot is transmitting (TRUE, 1) or not (FALSE, 0).

Radio

ParametersUniversal Var MemberDescription
RADIO_HEIGHTn (FLOAT)The radar altitude, in meters.
RADIO_MORSE_IDENT_STATESf (FLAGS)The radio morse state, formed using these flags:1: VOR1 (Bit 1)2: VOR2 (Bit 2)4: DME1 (Bit 3)8: DME2 (Bit 4)16: ADF (Bit 5)
RADIO_STACK_VISIBLEb (BOOL)Whether the radio stack is visible (TRUE, 1) or not (FALSE, 0).

VOR

ParametersUniversal Var MemberDescription
VOR1_BACK_COURSE_FLAGSVOR2_BACK_COURSE_FLAGSf (FLAGS)The status of VOR1/2, comprised from the following:BIT0:[index] Back course availableBIT1:[index] Localizer tuned inBIT2:[index] On courseBIT7:[index] Station active
VOR1_BEARING_DEGREESVOR2_BEARING_DEGREESn (FLOAT)The relative bearing for the VOR1/2 station, measured in degrees.
VOR1_CODEVOR2_CODEf (FLAGS)The VOR 1/2 code flags:BIT0:[index] 1= DME availableBIT1:[index] 1 = TACAN availableBIT2:[index] 1= voice availableBIT3:[index] 1= no nav signal availableBIT4:[index] 1= DME transmitter at glide slope transmitterBIT5:[index] 1= no localizer backcourseBIT6:[index] 1= glideslope availableBIT7:[index] 0= VOR, 1= Localizer
VOR1_GS_FLAGVOR2_GS_FLAGb (BOOL)Whether there is a glideslope signal on VOR1/2 (TRUE, 1) or not (FALSE, 0).
VOR1_GS_NEEDLEVOR2_GS_NEEDLEn (FLOAT)The glideslope needle deflection, between -120 and 120, which corresponds to -0.7 and 0.7.
VOR1_IDENTITYVOR2_IDENTITYp (PVOID)The VOR 1/2 identity, as a string.
VOR1_MAG_VARVOR2_MAG_VARn (FLOAT)The magnetic deviation at the location of the VOR1/2 station, between 0 and 65536, corresponding to 0º to 360º.
VOR1_NEEDLEVOR2_NEEDLEn (FLOAT)The VOR1/2 needle deviation, between -127 and 127. This corresponds to between -10 and 10 if VOR, or between -2.5 and 2.5 if localizer.
VOR1_NEEDLE_RADIOn (FLOAT)The VOR1 needle deviation - driven always by VOR - between -127 and 127. This corresponds to between -10 and 10 if VOR, or between -2.5 and 2.5 if localizer.
VOR1_OBIVOR2_OBIn (FLOAT)The VOR1/2 OBS setting, in degrees.
VOR1_SIGNAL_STRENGTHVOR2_SIGNAL_STRENGTHn (FLOAT)The VOR1/2 signal strnegth where 0 is no signal and greater than or eqiual to 256 is a good signal.
VOR1_TF_FLAGVOR2_TF_FLAGe (ENUM)0 = Off1 = To2 = FromThe to/from status of VOR1/2.
Prev
Helicopters
Next
Surfaces

0/255