General Aircraft
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 aircraft Token Variables for use when creating gauges using WASM / C++.
Aircraft
Center Of Gravity
Panel Options
| Parameters | Universal Var Member | Description |
|---|---|---|
ANGLE_OF_ATTACK_INDICATOR | n (FLOAT64) | The AoA indicatior value, expressed as a radian cast to a 16bit integer, eg: round(VALUE) * 65536.0 |
AUDIO_PANEL_VOLUME | n (FLOAT64) | The Volume of the Audio Panel, as a percentage from 0 to 100. |
ATTITUDE_BARS_POSITION | n (FLOAT64) | AI reference pitch reference bars. Position ranges from -100 to 100. |
ATTITUDE_INDICATOR_BANK_DEGREES | n (FLOAT64) | AI bank indication, in degrees. |
ATTITUDE_INDICATOR_PITCH_DEGREES | n (FLOAT64) | AI pitch indication, in degrees. |
CROSS_FEED_SELECTOR | e (ENUM)0 = Off1 = Left to right2 = Right to left | The cross feed selector position. |
FUEL_TANK_SELECTOR | e (ENUM) | The fuel tank selector position. See Fuel Selector Codes values. |
FUEL_TANK_SELECTOR_2 | e (ENUM) | The fuel tank selector position. See Fuel Selector Codes values. |
GPWS_SYSTEM_ACTIVE | b (BOOL) | This will be TRUE (1) if the ground proximity warning system is active, or FALSE (0) otherwise. |
HORIZON_BAR_OFFSET | n (FLOAT64) | AI reference pitch reference bars. Position ranges from -10 to 10 degrees. |
INCIDENCE_ALPHA | n (FLOAT64) | The AoA value, in radians. |
INCIDENCE_BETA | n (FLOAT64) | The sideslip angle value, in radians. |
IS_ALTITUDE_FREEZE_ON | b (BOOL) | This will be TRUE (0) if the altitude of the aircraft is frozen, or FALSE (0) otherwise. |
IS_ATTITUDE_FREEZE_ON | b (BOOL) | Turns the freezing of the lat/lon position of the aircraft (either user or AI controlled) on or off. If this key event is set, it means that the latitude and longitude of the aircraft are not being controlled by by the simulation and so enabling, for example, a SimConnect client to control the position of the aircraft. This can also apply to altitude and attitude. Refer also to the SimConnect_AIReleaseControl function for further information. |
IS_LATITUDE_LONGITUDE_FREEZE_ON | b (BOOL) | This will be TRUE (0) if the longitude of the aircraft is frozen, or FALSE (0) otherwise. |
KOHLSMAN_SETTING_HG | n (FLOAT64) | Specifies knob position in inches of hg. |
KOHLSMAN_SETTING_MB | n (FLOAT64) | Specifies the altimeter knob position, in milli-bars. |
KOHLSMAN_SETTING_STD | b (BOOL) | Will be TRUE (1) if the altimeter is in standard mode, or FALSE (0) otherwise. |
MAGNETIC_COMPASS | n (FLOAT64) | Compass reading, in degrees. |
MAGNETIC_VAR | n (FLOAT64) | Magnetic north vs. true north angular error, in degrees. |
PANEL_AUTOBRAKE_SWITCH | e (ENUM)0 = RTO1 = Off2 = 13 = 24 = 35 = Max | The autobrake switch position. |
PANEL_AUTOPILOT_SPEED_SETTING | n (FLOAT64) | The autopilot speed setting, in Knots. |
PANEL_STATE_FLAGS | f (FLAGS) | The panel state flags, which can be a combination of the following:2 = Main Panel Visible (Bit 1)3 = Main Panel Composed (Bit 2)8 = Not used (Bit 3)16 = Not used (Bit 4)32 = Helicopter HUD Visible (Bit 5)64 = Aircraft HUD Visible (Bit 6)128 = Aircraft HUD On (Bit 7)256 = Radio Stack Visible (Bit 8)512 = HUD Metric Output (Bit 9)1024 = Main Panel On (Bit 10)2048 = Controls HUD Visible (Bit 11)4096 = Radio Stack Auto Popped (Bit 12)8192 = Main Panel Undocked (Bit 13)16384 = Aircraft HUD Exists (Bit 14)32768 = Helicopter HUD Exists (Bit 15)65536 = Panels Load Visible (Bit 16)131072 = HUD Load Visible (Bit 17)262144 = Panel Visible (Bit 18)524288 = HUD Panel Visible (Bit 19) |
SHUTOFF_VALVE_PULLED | b (BOOL) | Whether the shutoff valve has been pulled (TRUE, 1) or not (FALSE, 0). |
SMOKE_ENABLE | b (BOOL) | Whether the smoke system is active (TRUE, 1) or not (FALSE, 0), if one is available. |
SPEAKER_ACTIVE | b (BOOL) | Whether the speaker is active (TRUE, 1) or not (FALSE, 0). |
THROTTLE_LOWER_LIMIT | n (FLOAT64) | The amount of throttle defining lower limit, which can be negative for reverse thrust equipped airplanes. Value between -16384 and 16384. |
TURN_COORDINATOR_BALL_POS | n (FLOAT64) | Specifies the turn-coordinator ball position, from -127 to 127. |
TURN_COORDINATOR_BALL_POS_INV | n (FLOAT64) | Specifies the inverted (upside down) turn-coordinator ball position, from -127 to 127. |
TURN_INDICATOR_RATE | n (FLOAT64) | The turn indicator value in degrees per second. |
VARIOMETER_RATE | n (FLOAT64) | The variometer rate, in ft per second. |
WHISKEY_COMPASS_DEGREES | n (FLOAT64) | The magnetic compass indication, in degrees. |
