Simulation Variables
Simulation Variables
Overview
06/26/2008 • 69 minutes to read
In this article
Table of Contents
Simulation Variables
There are two classes of simulation variables: aircraft and global data. The following tables list all the variables that can
appear in XML based gauges, or used from the SimConnect APIs.
See Also
Event IDs
SDK Overview
Table of Contents
Aircraft Data
Aircraft Engine Data
Fuel Tank Selection
Aircraft Fuel Data
Aircraft Lights Data
Aircraft Position and Speed Data
Aircraft Flight Instrumentation Data
Aircraft Avionics Data
Aircraft Controls Data
Aircraft Autopilot Data
Aircraft Landing Gear Data
Aircraft Environment Data
Helicopter Specific Data
Aircraft Miscellaneous Systems Data
Miscellaneous Data
Aircraft String Data
AI Controlled Aircraft
Carrier Operations
Racing
Environment Data
Program Data
Units of Measurement
Aircraft Data
Notes (Gauges)
Aircraft data is referenced by A: in XML gauges. Some parameters take an index to determine which of a multiple of
system is being queried. In XML gauges the syntax for adding an index is :N, for example:
FUEL TANK SELECTOR:index
Notes (SimConnect)
Simulation variables are referenced from within SimConnect clients with the SimConnect_AddToDataDefinition call
(see the SimConnect document for full details). When the units are listed as a structure or as a string, enter the empty
string, or simply NULL, in the units parameter of this function call.
For example:
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Kohlsman setting hg", "inHg"); hr =
Unless the Units column in the following table identifies the units as a structure or a string, the data will be returned by
default in a signed 64 bit floating point value. The SimConnect_AddToDataDefinition has an optional parameter to
change this to a signed 32 or 64 bit integer, or a signed 32 bit floating point value.
Notes (Multiplayer)
When the simulation is running in multiplayer mode, only a small number of variables are communicated between
aircraft. This is noted in the Multiplayer column (All aircraft or Shared Cockpit).
In the multiplayer Shared Cockpit mode the only supported index is 1, which means that the data is assumed to be
identical for all engines. In single player mode engine indexes are from 1 to 4.
GENERAL ENG MIXTURE Percent of max mixture lever position Percent Y Shared Cockpit
LEVER POSITION:index (Index of 1 only).
GENERAL ENG Percent of max prop lever position Percent Y Shared Cockpit
PROPELLER LEVER (Index of 1 only).
POSITION:index
RECIP ENG COWL FLAP Percent cowl flap opened Percent Y Shared Cockpit
POSITION:index (Index of 1 only).
PERCENT:index
RECIP ENG BRAKE Brake power produced by engine Foot pounds per Y -
POWER:index second
RECIP ENG FUEL TANK Fuel tank selected for engine. See fuel Enum N -
SELECTOR:index tank list.
RECIP ENG FUEL TANKS Fuel tanks used, one or more of the Mask Y -
USED:index following bit flags:
Center 1 Bit 0
Center 2 Bit 1
Center 3 Bit 2
Left Main Bit 3
Left Aux Bit 4
Left Tip Bit 5
Right Main Bit 6
Right Aux Bit 7
Right Tip Bit 8
External 1 Bit 9
External 2 Bit 10
USED:index
TURB ENG TANK Fuel tank selected for engine. See fuel Enum N -
SELECTOR:index tank list.
TURB ENG TANKS Fuel tanks used, one or more of the Mask N -
USED:index following bit flags:
Center 1 Bit 0
Center 2 Bit 1
Center 3 Bit 2
Left Main Bit 3
Left Aux Bit 4
Left Tip Bit 5
Right Main Bit 6
Right Aux Bit 7
Right Tip Bit 8
External 1 Bit 9
External 2 Bit 10
TURB ENG NUM TANKS Number of tanks currently being used Number N -
USED:index
TURB ENG FUEL FLOW Engine fuel flow Pounds per hour N -
PPH:index
ENG RPM ANIMATION Percent max rated rpm used for visual Percent N -
PERCENT:index animation
ENG FUEL FLOW BUG Fuel flow reference Pounds per hour N -
POSITION:index
GENERAL ENG FUEL Fuel used since the engines were last Pounds N -
USED SINCE START started
TURB ENG PRIMARY Percent thrust of primary nozzle Percent over 100 N -
NOZZLE PERCENT:index
TURB ENG IGNITION True if the turbine engine ignition switch Bool N -
SWITCH is on
TURB ENG MASTER True if the turbine engine master starter Bool N -
STARTER SWITCH switch is on
Number Description
0 Off
1 All
2 Left
3 Right
4 Left auxiliary
5 Right auxiliary
6 Center
7 Center2
8 Center3
9 External1
10 External2
11 Right tip
12 Left tip
13 Crossfeed
16 Both
17 External
18 Isolate
19 Left main
20 Right main
FUEL TANK LEFT MAIN LEVEL Percent of maximum capacity Percent Over Y -
100
FUEL TANK LEFT AUX LEVEL Percent of maximum capacity Percent Over Y -
100
FUEL TANK LEFT TIP LEVEL Percent of maximum capacity Percent Over Y -
100
FUEL TANK RIGHT MAIN LEVEL Percent of maximum capacity Percent Over Y -
100
FUEL TANK RIGHT AUX LEVEL Percent of maximum capacity Percent Over Y -
100
FUEL TANK RIGHT TIP LEVEL Percent of maximum capacity Percent Over Y -
100
100
FUEL TANK SELECTOR:index Which tank is selected. See fuel tank Enum N -
list.
FUEL SELECTED QUANTITY Percent or capacity for selected tank Percent Over N -
PERCENT 100
FUEL TOTAL QUANTITY WEIGHT Current total fuel weight of the aircraft Pounds N -
0x0004: Landing
0x0008: Taxi
0x0010: Strobe
0x0020: Panel
0x0040: Recognition
0x0080: Wing
0x0100: Logo
0x0200: Cabin
8 = Snow
9 = Ice
10 = Urban
11 = Forest
12 = Dirt
13 = Coral
14 = Gravel
15 = Oil_treated
16 = Steel_mats
17 = Bituminus
18 = Brick
19 = Macadam
20 = Planks
21 = Sand
22 = Shale
23 = Tarmac
24 = Wright_flyer_track
WING FLEX The current wing flex. Different Percent over 100 Y -
PCT:index values can be set for each wing
(for example, during banking). Set
an index of 1 for the left wing,
and 2 for the right wing.
STRUCT WORLD The world acceleration for each SIMCONNECT_DATA_XYZ structure, feet N -
ACCELERATION axis. Individual world acceleration per second squared
values are in the Aircraft Position
and Speed section.
AIRSPEED TRUE CALIBRATE Angle of True calibration scale on airspeed Degrees Y Shared
indicator Cockpit
aircraft)
PARTIAL PANEL ADF Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
PARTIAL PANEL AIRSPEED Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
PARTIAL PANEL ATTITUDE Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
PARTIAL PANEL COMM Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
PARTIAL PANEL COMPASS Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
PARTIAL PANEL AVIONICS Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum N -
PARTIAL PANEL ENGINE Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
PARTIAL PANEL FUEL Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum N -
INDICATOR
PARTIAL PANEL HEADING Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
PARTIAL PANEL VERTICAL Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
VELOCITY
PARTIAL PANEL NAV Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
PARTIAL PANEL PITOT Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
PARTIAL PANEL TURN Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum N -
COORDINATOR
PARTIAL PANEL VACUUM Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -
COM STANDBY Com standby frequency. Index is Frequency BCD16 N All aircraft
FREQUENCY:index 1 or 2.
frequency.
VERTICAL SPEED
3 = Missed
2 = VOR
3 = NDB
4 = ILS
5 = Localizer
6 = SDF
7 = LDA
8 = VOR/DME
9 = NDB/DME
10 = RNAV
11 = Backcourse
RUDDER PEDAL Percent rudder pedal deflection (for animation) Position (-16K to 0) Y -
POSITION -16K = left pedal
pushed full in
TRAILING EDGE Percent left trailing edge flap extended Percent Over 100 Y -
FLAPS LEFT
PERCENT
TRAILING EDGE Percent right trailing edge flap extended Percent Over 100 Y -
FLAPS RIGHT
PERCENT
TRAILING EDGE Angle left trailing edge flap extended. Use Radians N -
FLAPS LEFT TRAILING EDGE FLAPS LEFT PERCENT to set a
ANGLE value.
TRAILING EDGE Angle right trailing edge flap extended. Use Radians N -
FLAPS RIGHT TRAILING EDGE FLAPS RIGHT PERCENT to set a
ANGLE value.
LEADING EDGE Percent left leading edge flap extended Percent Over 100 Y -
FLAPS LEFT
PERCENT
LEADING EDGE Percent right leading edge flap extended Percent Over 100 Y -
FLAPS RIGHT
PERCENT
LEADING EDGE Angle left leading edge flap extended. Use Radians N -
FLAPS LEFT LEADING EDGE FLAPS LEFT PERCENT to set a
ANGLE value.
LEADING EDGE Angle right leading edge flap extended. Use Radians N -
FLAPS RIGHT LEADING EDGE FLAPS RIGHT PERCENT to set a
ANGLE value.
FLAP SPEED True if safe speed limit for flaps exceeded Bool N -
EXCEEDED
AILERON TRIM The trim position of the ailerons. Zero is fully Float. Percent over Y -
PCT retracted. 100
RUDDER TRIM The trim position of the rudder. Zero is no trim. Float. Percent over Y -
PCT 100
FUEL DUMP If true the aircraft is dumping fuel at the rate Bool N -
SWITCH set in the configuration file.
AUTOPILOT PITCH HOLD Set to True if the autopilot pitch hold has is Bool N -
engaged.
AUTOPILOT NAV1 LOCK True if autopilot nav1 lock applied Bool N Shared
Cockpit
FLY BY WIRE ELAC SWITCH True if the fly by wire Elevators and Ailerons Bool N -
computer is on.
FLY BY WIRE FAC SWITCH True if the fly by wire Flight Augmentation Bool N -
computer is on.
FLY BY WIRE SEC SWITCH True if the fly by wire Spoilers and Elevators Bool N -
computer is on.
FLY BY WIRE ELAC FAILED True if the Elevators and Ailerons computer has Bool N -
failed.
FLY BY WIRE FAC FAILED True if the Flight Augmentation computer has Bool N -
failed.
FLY BY WIRE SEC FAILED True if the Spoilers and Elevators computer has Bool N -
failed.
POSITION
WATER RUDDER Position of the water rudder handle (0 handle Percent Over 100 Y All aircraft
HANDLE POSITION retracted, 100 rudder handle applied)
GEAR CENTER Center wheel angle, negative to the left, positive Percent Over 100 N -
STEER ANGLE to the right.
GEAR LEFT STEER Left wheel angle, negative to the left, positive to Percent Over 100 N -
ANGLE the right.
GEAR RIGHT STEER Right wheel angle, negative to the left, positive to Percent Over 100 N -
ANGLE the right.
GEAR AUX STEER Aux wheel angle, negative to the left, positive to Percent Over 100 N -
ANGLE the right. The aux wheel is the fourth set of gear,
sometimes used on helicopters.
GEAR STEER Alternative method of getting the steer angle. Percent Over 100 N -
ANGLE:index Index is
0 = center
1 = left
2 = right
3 = aux
WATER LEFT Water left rudder angle, negative to the left, Percent Over 100 N -
RUDDER STEER positive to the right.
ANGLE
WATER RIGHT Water right rudder angle, negative to the left, Percent Over 100 N -
GEAR LEFT STEER Left steer angle as a percentage Percent Over 100 N -
ANGLE PCT
GEAR RIGHT STEER Right steer angle as a percentage Percent Over 100 N -
ANGLE PCT
GEAR AUX STEER Aux steer angle as a percentage Percent Over 100 N -
ANGLE PCT
GEAR STEER ANGLE Alternative method of getting steer angle as a Percent Over 100 N -
PCT:index percentage. Index is
0 = center
1 = left
2 = right
3 = aux
WATER LEFT Water left rudder angle as a percentage Percent Over 100 N -
RUDDER STEER
ANGLE PCT
0 = center
1 = left
2 = right
3 = aux
GEAR SPEED True if safe speed limit for gear exceeded Bool N -
EXCEEDED
TOTAL AIR Total air temperature is the air temperature at the Celsius N -
TEMPERATURE front of the aircraft where the ram pressure from
the speed of the aircraft is taken into account.
RAIN EFFECT
AVAILABLE
Note: Only variables that specifically mention the Bell helicopter apply to the Bell.
ACTIVE
ROTOR RPM PCT Percent max rated rpm Percent Over 100 N -
ENG TURBINE Turbine temperature. Applies only to Bell Celsius scalar 16K N -
TEMPERATURE helicopter. (degrees * 16384)
ENG TORQUE Torque. Returns main rotor torque for Bell Percent scalar 16K N -
PERCENT:index helicopter, or the indexed rotor torque of other (Ft/lbs * 16384)
helicopters.
ENG FUEL Fuel pressure. Applies only to Bell helicopter. PSI scalar 16K (Psi N -
PRESSURE * 16384)
ENG ELECTRICAL Electrical load. Applies only to Bell helicopter. Percent scalar 16K N -
LOAD (Max load *
16384)
ENG Transmission pressure. Applies only to Bell PSI scalar 16K (Psi N -
TRANSMISSION helicopter. * 16384)
PRESSURE
ENG ROTOR Rotor rpm. Returns main rotor rpm for Bell Percent scalar 16K N -
RPM:index helicopter, or the indexed rotor rpm of other (Max rpm * 16384)
helicopters.
NUM SLING CABLES The number of sling cables (not hoists) that are Number N -
configured for the aircraft. Refer to the
document Notes on Aircraft Systems.
PAYLOAD STATION Places the named object at the payload station String Y- set -
OBJECT:index identified by the index (starting from 1). The only
string is the Container name (refer to the title
property of Simulation Object Configuration
Files).
SLING OBJECT If units are set as boolean, returns True if a sling Bool/String N -
ATTACHED:index object is attached. If units are set as a string,
returns the container title of the object. There
can be multiple sling positions, indexed from 1.
The sling positions are set in the Aircraft
Configuration File.
SLING CABLE The length of the cable extending from the Feet Y -
EXTENDED aircraft.
LENGTH:index
SLING HOIST The percentage of the full length of the sling Percent_over_100 N -
PERCENT cable deployed.
DEPLOYED:index
SMOKE ENABLE Set to True to activate the smoke system, if one is Bool Y All aircraft
available (for example, on the Extra).
FOLDING WING LEFT Left folding wing position, 100 is fully folded Percent Y -
PERCENT Over 100
FOLDING WING Right folding wing position, 100 is fully folded Percent Y -
RIGHT PERCENT Over 100
ENGINE MIXURE True if engine mixture is available for prop engines. Bool N -
AVAILABLE Obsolete value as mixture is always available.
Spelling error in variable name.
BATTERY VOLTAGE
ELECTRICAL HOT Voltage available when battery switch is turned off Volts Y -
BATTERY BUS
VOLTAGE
ELECTRICAL HOT Current available when battery switch is turned off Amperes Y -
BATTERY BUS AMPS
VACUUM ON Cockpit
ATC SUGGESTED Suggested minimum runway length for takeoff. Used by Feet N -
ATC SUGGESTED Suggested minimum runway length for landing. Used by Feet N -
MIN RWY ATC
LANDING
AIRSPEED SELECT The airspeed, whether true or indicated airspeed has Knots N -
INDICATED OR been selected.
TRUE
over 100
EMPTY WEIGHT Empty weigth cross coupled moment of inertia Slugs per N -
CROSS COUPLED feet
MOI squared
TOTAL WEIGHT Total weight cross coupled moment of inertia Slugs per N -
CROSS COUPLED feet
MOI squared
MANUAL FUEL Position of manual fuel pump handle. 100 is fully Percent N -
PUMP HANDLE deployed. over 100
REALISM CRASH True indicates crashing with other aircraft is possible. Bool N -
WITH OTHERS
PITOT ICE PCT Amount of pitot ice. 100 is fully iced. Percent N -
over 100
STRUCTURAL ICE Amount of ice on aircraft structure. 100 is fully iced. Percent N -
PCT over 100
ARTIFICIAL In case scenery is not loaded for AI planes, this variable Feet N -
GROUND can be used to set a default surface elevation.
ELEVATION
VALID
YAW STRING The yaw string angle. Yaw strings are attached to gliders Radians N -
ANGLE as visible indicators of the yaw angle. An animation of
this is not implemented in ESP.
DISK PITCH ANGLE Main rotor pitch angle (helicopters only) Radians N -
DISK BANK ANGLE Main rotor bank angle (helicopters only) Radians N -
DISK PITCH PCT Main rotor pitch percent (helicopters only) Percent N -
over 100
DISK BANK PCT Main rotor bank percent (helicopters only) Percent N -
over 100
DISK CONING PCT Main rotor coning percent (helicopters only) Percent N -
over 100
TOW RELEASE Position of tow release handle. 100 is fully deployed. Percent N -
HANDLE over 100
TOW CONNECTION True if a towline is connected to both tow plane and Bool N -
glider.
SWITCH
GPWS SYSTEM True if the Ground Proximity Warning System is active Bool Y -
ACTIVE
IS ATTITUDE True if the attitude (pitch, bank and heading) of the Bool N -
FREEZE ON aircraft is frozen.
AI Controlled Aircraft
"Sleep"
"Waypoint"
"Takeoff"
"Landing"
"Taxi"
For example:
Notes
1. These variables make most sense for aircraft with flight plans. If an aircraft does not have a flight plan, the value
returned will be 0 (or false), or an empty string, depending on the units.
2. These variables only make sense for aircraft generated by the traffic database, and so have schedules. If an aircraft
does not have a schedule, the value returned will be 0 (or false), or an empty string, depending on the units.
Carrier Operations
LAUNCHBAR If this is set to True the launch bar switch has been Bool N -
SWITCH engaged.
HOLDBACK BAR Holdback bars allow build up of thrust before takeoff Bool N -
INSTALLED from a catapult, and are installed by the deck crew of
an aircraft carrier.
BLAST SHIELD Indexed from 1, 100 is fully deployed, 0 flat on deck Percent_over_100 N -
POSITION:index
CABLE CAUGHT A number 1 through 4 for the cable number caught Number N -
BY TAILHOOK by the tailhook. Cable 1 is the one closest to the
stern of the carrier. A value of 0 indicates no cable
was caught.
SURFACE The speed of the aircraft relative to the speed of the Feet_per_second N -
RELATIVE first surface directly underneath it. Use this to
GROUND SPEED retrieve, for example, an aircraft's taxiing speed while
it is moving on a moving carrier. It also applies to
airborne aircraft, for example when a helicopter is
successfully hovering above a moving ship, this value
should be zero. The returned value will be the same
as GROUND VELOCITY if the first surface beneath it
is not moving.
Racing
RECIP ENG CYLINDER Index high 16 bits is engine number, low 16 Percent_over_100 N -
HEALTH:index cylinder number, both indexed from 1.
RECIP ENG NUM Indexed from 1. The number of cylinders that Number N -
CYLINDERS FAILED have failed.
RECIP ENG Indexed from 1, each engine can have one Bool Y -
ANTIDETONATION antidetonation tank. Installed on racing
TANK VALVE:index aircraft. Refer to the document Notes on
Aircraft Systems.
RECIP ENG Indexed from 1. This value set in the Aircraft Gallons N -
ANTIDETONATION Configuration File.
TANK MAX
QUANTITY:index
RECIP ENG NITROUS Indexed from 1. Each engine can have one Bool Y -
TANK VALVE:index Nitrous fuel tank installed.
RECIP ENG NITROUS Indexed from 1. Refer to the Mission Creation Gallons Y -
TANK QUANTITY:index documentationfor the procedure for refilling
tanks.
RECIP ENG NITROUS Indexed from 1. This value set in the Aircraft Gallons N -
Environment Data
Program Data
Units of Measurement
The following table gives the strings that are accepted by the SDK for units. All the strings in the same row are identical in
meaning. Note that some strings have "per" spelled out, and some use "/", and note that a few contain hyphens or
underscores.
Distance
Area
Volume
Temperature
Angle
Global Position
Angular Velocity
Speed
Acceleration
Time
Power
Volume Rate
Weight
Weight Rate
Electrical Current
Electrical Potential
Frequency
Density
Pressure
Torque
Miscellaneous Units
Notes
When making object definitions in SimConnect, it is possible to request the units that the values are to be received in.
All the units in the tables below under one heading (such as Frequency or Speed) can be used as appropriate to the
client application, except those under Miscellaneous Units. See the SimConnect documentation for more details.
Distance Details
meter, meters, m ~
centimeter, centimeters, cm ~
kilometer, kilometers, km ~
millimeter, millimeters ~
mile, miles ~
nautical mile, nautical miles, nmile, nmiles Nautical mile, 2024 yards
foot, feet, ft ~
inch, inches, in ~
yard, yards ~
Area Details
Volume Details
liter, liters ~
gallon, gallons ~
quart, quarts ~
Temperature Details
farenheit, fahrenheit ~
celsius ~
Angle Details
radian, radians ~
round, rounds ~
degree latitude ~
degree longitude ~
grad, grads ~
Speed Details
feet/second ~
feet/minute, ft/min ~
mach, machs ~
Acceleration Details
Time Details
second, seconds ~
minute, minutes ~
hour, hours ~
day, days ~
year, years ~
Power Details
Watt, Watts ~
ft lb per second ~
Weight Details
kilogram, kilograms, kg ~
slug, slugs, geepound, geepounds A unit of mass to which a force of one pound imparts an acceleration of one
foot per second squared. One geepound, or slug, equals about 14.59 kg or
32.2lb.
volt, volts ~
Frequency Details
Hertz, Hz, ~
Kilohertz, KHz ~
Megahertz, MHz ~
Density Details
Pressure Details
pascal, pascals, Pa ~
kilopascal, kpa ~
bar, bars ~
boost cmHg ~
boost inHg ~
boost psi ~
squared
Torque Details
part ~
half, halfs ~
third, thirds ~
percent, percentage Normally a value between 0 and 100, though sometimes values outside this
range are possible (reverse thrust, for example).
percent over 100 Normally a value between 0.0 and 1.0, though sometimes values outside this
range are possible (reverse thrust, for example).
bel, bels ~
decibel, decibels ~
more_than_a_half ~
times ~
ratio ~
number, numbers ~
scaler ~
position ~
Bool, Boolean The only reliable numeric equivalent is that 0 is returned for False. Non-zero
values, especially both 1 and -1, are used to indicate True.
Bco16 ~
mask ~
flags ~
string ~
per radian ~
per degree ~