Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

Simulation Variables

Download as pdf or txt
Download as pdf or txt
You are on page 1of 114

Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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

1 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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

2 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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 =

SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Indicated Altitude", "feet"); hr =

SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Plane Latitude", "degrees"); hr =

SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Plane Longitude", "degrees"); hr =

SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_2, "Category", null); \\ string hr =

SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_2, "AI Waypoint List", null); \\ structure

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).

3 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

Aircraft Engine Data

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.

Simulation Variable Description Units Settable Multiplayer

NUMBER OF ENGINES Number of engines (minimum 0, Number N -


maximum 4)

ENGINE CONTROL Selected engines (combination of bit Mask Y -


SELECT flags)
1 = Engine 1
2 = Engine 2
4 = Engine 3
8 = Engine 4

THROTTLE LOWER LIMIT Percent throttle defining lower limit Percent N -


(negative for reverse thrust equipped
airplanes)

ENGINE TYPE Engine type: Enum N -


0 = Piston
1 = Jet
2 = None
3 = Helo(Bell) turbine
4 = Unsupported
5 = Turboprop

MASTER IGNITION Aircraft master ignition switch (grounds Bool N -


SWITCH all engines magnetos)

4 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

GENERAL ENG Combustion flag Bool Y Shared Cockpit


COMBUSTION:index (Index of 1 only).

GENERAL ENG MASTER Alternator (generator) switch Bool N Shared Cockpit


ALTERNATOR:index (Index of 1 only).

GENERAL ENG FUEL Fuel pump switch Bool N Shared Cockpit


PUMP SWITCH:index (Index of 1 only).

GENERAL ENG FUEL Fuel pump on/off Bool N -


PUMP ON:index

GENERAL ENG Engine rpm Rpm N -


RPM:index

GENERAL ENG PCT MAX Percent of max rated rpm Percent N -


RPM:index

GENERAL ENG MAX Maximum attained rpm Rpm N -


REACHED RPM:index

GENERAL ENG Percent of max throttle position Percent Y Shared Cockpit


THROTTLE LEVER (Index of 1 only).
POSITION:index

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).

5 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

POSITION:index

GENERAL ENG Engine starter on/off Bool N -


STARTER:index

GENERAL ENG EXHAUST Engine exhaust gas temperature. Rankine Y -


GAS
TEMPERATURE:index

GENERAL ENG OIL Engine oil pressure Psf Y -


PRESSURE:index

GENERAL ENG OIL Percent of max oil capacity leaked Percent N -


LEAKED PERCENT:index

GENERAL ENG Percent of maximum engine sound Percent N -


COMBUSTION SOUND
PERCENT:index

GENERAL ENG DAMAGE Percent of total engine damage Percent N -


PERCENT:index

GENERAL ENG OIL Engine oil temperature Rankine Y -


TEMPERATURE:index

GENERAL ENG Fail flag Bool N -


FAILED:index

GENERAL ENG Alternator (generator) switch Bool N -


GENERATOR
SWITCH:index

6 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

GENERAL ENG Alternator (generator) on/off Bool Y -


GENERATOR
ACTIVE:index

GENERAL ENG ANTI ICE Engine anti-ice switch Bool N -


POSITION:index

GENERAL ENG FUEL Fuel valve state Bool N Shared Cockpit


VALVE:index (Index of 1 only).

GENERAL ENG FUEL Engine fuel pressure Psi Y -


PRESSURE:index

GENERAL ENG ELAPSED Total engine elapsed time Hours N -


TIME:index

RECIP ENG COWL FLAP Percent cowl flap opened Percent Y Shared Cockpit
POSITION:index (Index of 1 only).

RECIP ENG Engine primer position Bool Y -


PRIMER:index

RECIP ENG MANIFOLD Engine manifold pressure Psi Y -


PRESSURE:index

RECIP ENG ALTERNATE Alternate air control Position Y -


AIR POSITION:index

RECIP ENG COOLANT Percent coolant available Percent Y -


RESERVOIR

7 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

PERCENT:index

RECIP ENG LEFT Left magneto state Bool Y Shared Cockpit


MAGNETO:index (Index of 1 only).

RECIP ENG RIGHT Right magneto state Bool Y Shared Cockpit


MAGNETO:index (Index of 1 only).

RECIP ENG BRAKE Brake power produced by engine Foot pounds per Y -
POWER:index second

RECIP ENG STARTER Torque produced by engine Foot pound Y -


TORQUE:index

RECIP ENG Turbo failed state Bool Y -


TURBOCHARGER
FAILED:index

RECIP ENG EMERGENCY War emergency power active Bool Y -


BOOST ACTIVE:index

RECIP ENG EMERGENCY Elapsed time war emergency power Hours Y -


BOOST ELAPSED active
TIME:index

RECIP ENG WASTEGATE Percent turbo wastegate closed Percent Y -


POSITION:index

RECIP ENG TURBINE Engine turbine inlet temperature Celsius Y -


INLET
TEMPERATURE:index

8 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

RECIP ENG CYLINDER Engine cylinder head temperature Celsius Y -


HEAD
TEMPERATURE:index

RECIP ENG RADIATOR Engine radiator temperature Celsius Y -


TEMPERATURE:index

RECIP ENG FUEL True if fuel is available Bool Y -


AVAILABLE:index

RECIP ENG FUEL Engine fuel flow Pounds per hour Y -


FLOW:index

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

RECIP ENG FUEL Number of tanks currently being used Number N -


NUMBER TANKS

9 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

USED:index

RECIP CARBURETOR Carburetor temperature Celsius Y -


TEMPERATURE:index

RECIP MIXTURE Fuel / Air mixture ratio Ratio Y -


RATIO:index

TURB ENG N1:index Turbine engine N1 Percent Y Shared Cockpit


(Index of 1 only).

TURB ENG N2:index Turbine engine N2 Percent Y Shared Cockpit


(Index of 1 only).

TURB ENG CORRECTED Turbine engine corrected N1 Percent Y Shared Cockpit


N1:index (Index of 1 only).

TURB ENG CORRECTED Turbine engine corrected N2 Percent Y Shared Cockpit


N2:index (Index of 1 only).

TURB ENG CORRECTED Corrected fuel flow Pounds per hour Y -


FF:index

TURB ENG MAX TORQUE Percent of max rated torque Percent Y -


PERCENT:index

TURB ENG PRESSURE Engine pressure ratio Ratio Y -


RATIO:index

TURB ENG ITT:index Engine ITT Rankine Y -

10 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

TURB ENG Afterburner state Bool N -


AFTERBURNER:index

TURB ENG JET Engine jet thrust Pounds N -


THRUST:index

TURB ENG BLEED Bleed air pressure Psi N -


AIR: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

11 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

TURB ENG FUEL True if fuel is available Bool N -


AVAILABLE:index

TURB ENG REVERSE Percent thrust reverser nozzles deployed Percent N -


NOZZLE PERCENT:index

TURB ENG Engine vibration value Number N -


VIBRATION:index

ENG FAILED:index Failure flag Number N -

ENG RPM ANIMATION Percent max rated rpm used for visual Percent N -
PERCENT:index animation

ENG ON FIRE:index On fire state Bool Y -

ENG FUEL FLOW BUG Fuel flow reference Pounds per hour N -
POSITION:index

PROP RPM:index Propeller rpm Rpm Y -

PROP MAX RPM Percent of max rated rpm Percent N -


PERCENT:index

PROP THRUST:index Propeller thrust Pounds N -

PROP BETA:index Prop blade pitch angle Radians N -

12 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

PROP FEATHERING Feathering inhibit flag Bool N -


INHIBIT:index

PROP FEATHERED:index Feathered state Bool N -

PROP SYNC DELTA Corrected prop correction input on Position N -


LEVER:index slaved engine

PROP AUTO FEATHER Auto-feather armed state Bool N -


ARMED:index

PROP FEATHER Prop feather switch Bool N -


SWITCH:index

PANEL AUTO FEATHER Auto-feather arming switch Bool N -


SWITCH:index

PROP SYNC True if prop sync is active Bool N -


ACTIVE:index

PROP DEICE True if prop deice switch on Bool N -


SWITCH:index

ENG COMBUSTION True if the engine is running Bool N -

ENG N1 RPM:index Engine N1 rpm Rpm (0 to 16384 = N -


0 to 100%)

ENG N2 RPM:index Engine N2 rpm Rpm(0 to 16384 = N -


0 to 100%)

13 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ENG FUEL FLOW Engine fuel flow Gallons per hour N -


GPH:index

ENG FUEL FLOW Engine fuel flow Pounds per hour N -


PPH:index

ENG TORQUE:index Torque Foot pounds N -

ENG ANTI ICE:index Anti-ice switch Bool N -

ENG PRESSURE Engine pressure ratio Ratio (0-16384) N -


RATIO:index

ENG EXHAUST GAS Exhaust gas temperature Rankine N -


TEMPERATURE:index

ENG EXHAUST GAS Governed engine setting Percent over 100 N -


TEMPERATURE
GES:index

ENG CYLINDER HEAD Engine cylinder head temperature Rankine N -


TEMPERATURE:index

ENG OIL Engine oil temperature Rankine N -


TEMPERATURE:index

ENG OIL Engine oil pressure Pounds per square N -


PRESSURE:index foot

ENG OIL Engine oil quantitiy as a percentage of Percent over 100 N -


QUANTITY:index full capacity

14 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ENG HYDRAULIC Engine hydraulic pressure Pounds per square N -


PRESSURE:index foot

ENG HYDRAULIC Engine hydraulic fluid quantity, as a Percent over 100 N -


QUANTITY:index percentage of total capacity

ENG MANIFOLD Engine manifold pressure. inHG. N -


PRESSURE:index

ENG VIBRATION:index Engine vibration Number N -

ENG RPM SCALER:index Obsolete Scalar N -

ENG MAX RPM Maximum rpm Rpm N -

GENERAL ENG STARTER True if engine starter is active Bool N -


ACTIVE

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

TURB ENG The stage of the afterburner, or 0 if the Number N -

15 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

AFTERBURNER STAGE afterburner is not active.


ACTIVE

TURB ENG The percentage that the afterburner is Percent_over_100 N -


AFTERBURNER PCT running at.
ACTIVE

Fuel Tank Selection

Number Description

0 Off

1 All

2 Left

3 Right

4 Left auxiliary

5 Right auxiliary

6 Center

7 Center2

8 Center3

16 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

9 External1

10 External2

11 Right tip

12 Left tip

13 Crossfeed

14 Crossfeed left to right

15 Crossfeed right to left

16 Both

17 External

18 Isolate

19 Left main

20 Right main

Aircraft Fuel Data

Simulation Variable Description Units Settable Multiplayer

17 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

FUEL TANK CENTER LEVEL Percent of maximum capacity Percent Over Y -


100

FUEL TANK CENTER2 LEVEL Percent of maximum capacity Percent Over Y -


100

FUEL TANK CENTER3 LEVEL Percent of maximum capacity Percent Over Y -


100

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

FUEL TANK EXTERNAL1 LEVEL Percent of maximum capacity Percent Over Y -


100

FUEL TANK EXTERNAL2 LEVEL Percent of maximum capacity Percent Over Y -

18 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

100

FUEL TANK CENTER CAPACITY Maximum capacity in volume Gallons N -

FUEL TANK CENTER2 CAPACITY Maximum capacity in volume Gallons N -

FUEL TANK CENTER3 CAPACITY Maximum capacity in volume Gallons N -

FUEL TANK LEFT MAIN Maximum capacity in volume Gallons N -


CAPACITY

FUEL TANK LEFT AUX CAPACITY Maximum capacity in volume Gallons N -

FUEL TANK LEFT TIP CAPACITY Maximum capacity in volume Gallons N -

FUEL TANK RIGHT MAIN Maximum capacity in volume Gallons N -


CAPACITY

FUEL TANK RIGHT AUX Maximum capacity in volume Gallons N -


CAPACITY

FUEL TANK RIGHT TIP Maximum capacity in volume Gallons N -


CAPACITY

FUEL TANK EXTERNAL1 Maximum capacity in volume Gallons N -


CAPACITY

FUEL TANK EXTERNAL2 Maximum capacity in volume Gallons N -


CAPACITY

FUEL LEFT CAPACITY Maximum capacity in volume Gallons N -

19 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

FUEL RIGHT CAPACITY Maximum capacity in volume Gallons N -

FUEL TANK CENTER QUANTITY Current quantity in volume Gallons Y -

FUEL TANK CENTER2 QUANTITY Current quantity in volume Gallons Y -

FUEL TANK CENTER3 QUANTITY Current quantity in volume Gallons Y -

FUEL TANK LEFT MAIN Current quantity in volume Gallons Y -


QUANTITY

FUEL TANK LEFT AUX Current quantity in volume Gallons Y -


QUANTITY

FUEL TANK LEFT TIP QUANTITY Current quantity in volume Gallons Y -

FUEL TANK RIGHT MAIN Current quantity in volume Gallons Y -


QUANTITY

FUEL TANK RIGHT AUX Current quantity in volume Gallons Y -


QUANTITY

FUEL TANK RIGHT TIP Current quantity in volume Gallons Y -


QUANTITY

FUEL TANK EXTERNAL1 Current quantity in volume Gallons Y -


QUANTITY

FUEL TANK EXTERNAL2 Current quantity in volume Gallons Y -


QUANTITY

20 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

FUEL LEFT QUANTITY Current quantity in volume Gallons N -

FUEL RIGHT QUANTITY Current quantity in volume Gallons N -

FUEL TOTAL QUANTITY Current quantity in volume Gallons N -

FUEL WEIGHT PER GALLON Fuel weight per gallon Pounds N -

FUEL TANK SELECTOR:index Which tank is selected. See fuel tank Enum N -
list.

FUEL CROSS FEED Cross feed valve: Enum N -


0 = Closed
1 = Open

FUEL TOTAL CAPACITY Total capacity of the aircraft Gallons N -

FUEL SELECTED QUANTITY Percent or capacity for selected tank Percent Over N -
PERCENT 100

FUEL SELECTED QUANTITY Quantity of selected tank Gallons N -

FUEL TOTAL QUANTITY WEIGHT Current total fuel weight of the aircraft Pounds N -

NUM FUEL SELECTORS Number of selectors on the aircraft Number N -

UNLIMITED FUEL Unlimited fuel flag Bool N -

ESTIMATED FUEL FLOW Estimated fuel flow at cruise Pounds per N -


hour

21 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

Aircraft Lights Data

Simulation Description Units Settable Multiplayer


Variable

LIGHT STROBE Light switch state Bool N All aircraft

LIGHT PANEL Light switch state Bool N All aircraft

LIGHT LANDING Light switch state Bool N All aircraft

LIGHT TAXI Light switch state Bool N All aircraft

LIGHT BEACON Light switch state Bool N All aircraft

LIGHT NAV Light switch state Bool N All aircraft

LIGHT LOGO Light switch state Bool N All aircraft

LIGHT WING Light switch state Bool N All aircraft

LIGHT Light switch state Bool N All aircraft


RECOGNITION

LIGHT CABIN Light switch state Bool N All aircraft

LIGHT ON STATES Bit mask: Mask N -


0x0001: Nav
0x0002: Beacon

22 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

0x0004: Landing
0x0008: Taxi
0x0010: Strobe
0x0020: Panel
0x0040: Recognition
0x0080: Wing
0x0100: Logo
0x0200: Cabin

LIGHT STATES Same as LIGHT ON STATES Mask N All aircraft

LANDING LIGHT Landing light pitch bank and SIMCONNECT_DATA_XYZ N -


PBH heading structure

LIGHT TAXI ON Return true if the light is on. Bool N -

LIGHT STROBE ON Return true if the light is on. Bool N -

LIGHT PANEL ON Return true if the light is on. Bool N -

LIGHT Return true if the light is on. Bool N -


RECOGNITION ON

LIGHT WING ON Return true if the light is on. Bool N -

LIGHT LOGO ON Return true if the light is on. Bool N -

LIGHT CABIN ON Return true if the light is on. Bool N -

LIGHT HEAD ON Return true if the light is on. Bool N -

23 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

LIGHT BRAKE ON Return true if the light is on. Bool N -

LIGHT NAV ON Return true if the light is on. Bool N -

LIGHT BEACON ON Return true if the light is on. Bool N -

LIGHT LANDING Return true if the light is on. Bool N -


ON

Aircraft Position and Speed Data

Simulation Description Units Settable Multiplayer


Variable

GROUND Speed relative to the earths Knots N -


VELOCITY surface

TOTAL WORLD Speed relative to the earths Feet per second N -


VELOCITY center

VELOCITY BODY True longitudinal speed, relative Feet per second Y -


Z to aircraft axis

VELOCITY BODY True lateral speed, relative to Feet per second Y -


X aircraft axis

VELOCITY BODY True vertical speed, relative to Feet per second Y -


Y aircraft axis

24 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

VELOCITY Speed relative to earth, in Feet per second Y -


WORLD Z North/South direction

VELOCITY Speed relative to earth, in Feet per second Y -


WORLD X East/West direction

VELOCITY Speed relative to earth, in vertical Feet per second Y -


WORLD Y direction

ACCELERATION Acceleration relative to earth, in Feet per second squared Y -


WORLD X east/west direction

ACCELERATION Acceleration relative to earch, in Feet per second squared Y -


WORLD Y vertical direction

ACCELERATION Acceleration relative to earth, in Feet per second squared Y -


WORLD Z north/south direction

ACCELERATION Acceleration relative to aircraft Feet per second squared Y -


BODY X axix, in east/west direction

ACCELERATION Acceleration relative to aircraft Feet per second squared Y -


BODY Y axis, in vertical direction

ACCELERATION Acceleration relative to aircraft Feet per second squared Y -


BODY Z axis, in north/south direction

ROTATION Rotation relative to aircraft axis Feet per second Y -


VELOCITY BODY
X

25 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ROTATION Rotation relative to aircraft axis Feet per second Y -


VELOCITY BODY
Y

ROTATION Rotation relative to aircraft axis Feet per second Y -


VELOCITY BODY
Z

RELATIVE WIND Lateral speed relative to wind Feet per second N -


VELOCITY BODY
X

RELATIVE WIND Vertical speed relative to wind Feet per second N -


VELOCITY BODY
Y

RELATIVE WIND Longitudinal speed relative to Feet per second N -


VELOCITY BODY wind
Z

PLANE ALT Altitude above the surface Feet Y -


ABOVE GROUND

PLANE LATITUDE Latitude of aircraft, North is Radians Y -


positive, South negative

PLANE Longitude of aircraft, East is Radians Y -


LONGITUDE positive, West negative

PLANE ALTITUDE Altitude of aircraft Feet Y -

26 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

PLANE PITCH Pitch angle, although the name Radians Y -


DEGREES mentions degrees the units used
are radians

PLANE BANK Bank angle, although the name Radians Y -


DEGREES mentions degrees the units used
are radians

PLANE HEADING Heading relative to true north, Radians Y -


DEGREES TRUE although the name mentions
degrees the units used are
radians

PLANE HEADING Heading relative to magnetic Radians Y -


DEGREES north, although the name
MAGNETIC mentions degrees the units used
are radians

MAGVAR Magnetic variation Degrees N -

GROUND Altitude of surface Meters N -


ALTITUDE

SURFACE TYPE Type of surface: Enum N -


0 = Concrete
1 = Grass
2 = Water
3 = Grass_bumpy
4 = Asphalt
5 = Short_grass
6 = Long_grass
7 = Hard_turf

27 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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

SIM ON On ground flag Bool N -


GROUND

INCIDENCE Angle of attack Radians N -


ALPHA

INCIDENCE BETA Sideslip angle Radians N -

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.

28 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

STRUCT Returns the latitude, longitude SIMCONNECT_DATA_LATLONALTstructure N -


LATLONALT and altitude of the user aircraft.

STRUCT Returns the pitch, bank and SIMCONNECT_DATA_LATLONALTstructure N -


LATLONALTPBH heading of the user aircraft.

STRUCT SURFACE The relative surface velocity. SIMCONNECT_DATA_XYZ structure, feet N -


RELATIVE per second
VELOCITY

STRUCT The world velocity. SIMCONNECT_DATA_XYZ structure, feet N -


WORLDVELOCITY per second

STRUCT WORLD The world rotation velocity. SIMCONNECT_DATA_XYZ structure, N -


ROTATION radians per second
VELOCITY

STRUCT BODY The object body velocity. SIMCONNECT_DATA_XYZ structure, feet N -


VELOCITY per second

STRUCT BODY The body rotation velocity. SIMCONNECT_DATA_XYZ structure, N -


ROTATION Individual body rotation values radians per second
VELOCITY are in the Aircraft Position and
Speed section.

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.

STRUCT ENGINE The engine position relative to SIMCONNECT_DATA_XYZ structure, feet. N -

29 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

POSITION:index the reference datum position for


the aircraft.

STRUCT The angle of the eyepoint view. SIMCONNECT_DATA_XYZ structure, N -


EYEPOINT Zero, zero, zero is straight ahead. radians
DYNAMIC ANGLE

STRUCT A variable offset away from the SIMCONNECT_DATA_XYZ structure, feet N -


EYEPOINT EYEPOINT POSITION
DYNAMIC
OFFSET

EYEPOINT The eyepoint position relative to SIMCONNECT_DATA_XYZ structure, feet N -


POSITION the reference datum position for
the aircraft.

Aircraft Flight Instrumentation Data

Simulation Variable Description Units Settable Multiplayer

AIRSPEED TRUE True airspeed Knots Y -

AIRSPEED INDICATED Indicated airspeed Knots Y -

AIRSPEED TRUE CALIBRATE Angle of True calibration scale on airspeed Degrees Y Shared
indicator Cockpit

AIRSPEED BARBER POLE Redline airspeed (dynamic on some Knots N -

30 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

aircraft)

AIRSPEED MACH Current mach Mach N -

VERTICAL SPEED Vertical speed indication Feet per second Y -

MACH MAX OPERATE Maximum design mach Mach N -

STALL WARNING Stall warning state Bool N -

OVERSPEED WARNING Overspeed warning state Bool N -

BARBER POLE MACH Mach associated with maximum airspeed Mach N -

INDICATED ALTITUDE Altimeter indication Feet Y -

KOHLSMAN SETTING MB Altimeter setting Millibars Y -

KOHLSMAN SETTING HG Altimeter setting Inches of N -


Mercury, inHg

ATTITUDE INDICATOR AI pitch indication Radians N -


PITCH DEGREES

ATTITUDE INDICATOR AI bank indication Radians N -


BANK DEGREES

ATTITUDE BARS POSITION AI reference pitch reference bars Percent Over N -


100

31 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ATTITUDE CAGE AI caged state Bool N -

WISKEY COMPASS Magnetic compass indication Degrees Y -


INDICATION DEGREES

PLANE HEADING DEGREES Heading indicator (directional gyro) Radians Y -


GYRO indication

HEADING INDICATOR Heading indicator (directional gyro) Radians N -


indication

GYRO DRIFT ERROR Angular error of heading indicator Radians N -

DELTA HEADING RATE Rate of turn of heading indicator Radians per Y -


second

TURN COORDINATOR BALL Turn coordinator ball position Position 128 N -


(-127 to 127)

ANGLE OF ATTACK AoA indication Radians N -


INDICATOR

RADIO HEIGHT Radar altitude Feet N -

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 Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -


ALTIMETER

32 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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 Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -


ELECTRICAL

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 Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -


TRANSPONDER

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

33 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

PARTIAL PANEL VACUUM Gauge fail flag (0 = ok, 1 = fail, 2 = blank) Enum Y -

MAX G FORCE Maximum G force attained Gforce N -

MIN G FORCE Minimum G force attained Gforce N -

SUCTION PRESSURE Vacuum system suction pressure Inches of Y -


Mercury, inHg

Aircraft Avionics Data

Simulation Description Units Settable Multiplayer


Variable

AVIONICS Avionics switch state Bool N All aircraft


MASTER SWITCH

NAV Nav audio flag. Index of 1 or 2. Bool N Shared


SOUND:index Cockpit

DME SOUND DME audio flag Bool N Shared


Cockpit

ADF ADF audio flag. Index of 0 or 1. Bool N Shared


SOUND:index Cockpit

MARKER SOUND Marker audio flag Bool N Shared


Cockpit

34 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

COM Audio panel com transmit state. Bool N Shared


TRANSMIT:index Index of 1 or 2. Cockpit

COM RECIEVE ALL Flag if all Coms receiving Bool N Shared


Cockpit

COM ACTIVE Com frequency. Index is 1 or 2. Frequency BCD16 N All aircraft


FREQUENCY:index

COM STANDBY Com standby frequency. Index is Frequency BCD16 N All aircraft
FREQUENCY:index 1 or 2.

COM Radio status flag : Enum N -


STATUS:index -1 =Invalid
0 = OK
1 = Does not exist
2 = No electricity
3 = Failed

NAV Flag if Nav equipped on aircraft Bool N -


AVAILABLE:index

NAV ACTIVE Nav active frequency. Index is 1 or MHz N Shared


FREQUENCY:index 2. Cockpit

NAV STANDBY Nav standby frequency. Index is 1 MHz N Shared


FREQUENCY:index or 2. Cockpit

NAV Nav signal strength Number N -


SIGNAL:index

35 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

NAV HAS Flag if Nav has signal Bool N -


NAV:index

NAV HAS Flag if tuned station is a localizer Bool N -


LOCALIZER:index

NAV HAS Flag if tuned station has a DME Bool N -


DME:index

NAV HAS GLIDE Flag if tuned station has a Bool N -


SLOPE:index glideslope

NAV BACK Returns the following bit flags: Flags N -


COURSE BIT0: 1=back course available
FLAGS:index BIT1: 1=localizer tuned in
BIT2: 1=on course
BIT7: 1=station active

NAV Magnetic variation of tuned nav Degrees N -


MAGVAR:index station

NAV Radial that aircraft is on Degrees N -


RADIAL:index

NAV RADIAL Difference between current radial Degrees N -


ERROR:index and OBS tuned radial

NAV Localizer course heading Degrees N -


LOCALIZER:index

NAV GLIDE SLOPE Difference between current Degrees N -

36 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ERROR:index position and glideslope angle.


Note that this provides 32 bit
floating point precision, rather
than the 8 bit integer precision of
NAV GSI.

NAV CDI:index CDI needle deflection (+/- 127) Number N -

NAV GSI:index Glideslope needle deflection (+/- Number N -


119). Note that this provides only
8 bit precision, whereas NAV
GLIDE SLOPE ERROR provides 32
bit floating point precision.

NAV Nav TO/FROM flag: Enum N -


TOFROM:index 0 = Off
1 = TO
2 = FROM

NAV GS Glideslope flag Bool N -


FLAG:index

NAV OBS:index OBS setting. Index of 1 or 2. Degrees N Shared


Cockpit

NAV DME:index DME distance Nautical miles N -

NAV DME speed Knots N -


DMESPEED:index

37 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ADF ACTIVE ADF frequency. Index of 1 or 2. Frequency ADF BCD32 N Shared


FREQUENCY:index Cockpit

ADF STANDBY ADF standby frequency Hz N -


FREQUENCY:index

ADF Current direction from NDB Degrees N -


RADIAL:index station

ADF Signal strength Number N -


SIGNAL:index

TRANSPONDER 4-digit code BCO16 N All aircraft


CODE:index (Index of 1
only).

MARKER BEACON Marker beacon state: Enum Y -


STATE 0 = None
1 = Outer
2 = Middle
3 = Inner

INNER MARKER Inner marker state Bool Y -

MIDDLE MARKER Middle marker state Bool Y -

OUTER MARKER Outer marker state Bool Y -

NAV RAW GLIDE Glide slope angle Degrees N -


SLOPE:index

38 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ADF CARD ADF compass rose setting Degrees N Shared


Cockpit

HSI CDI NEEDLE Needle deflection (+/- 127) Number N -

HSI GSI NEEDLE Needle deflection (+/- 119) Number N -

HSI CDI NEEDLE Signal valid Bool N -


VALID

HSI GSI NEEDLE Signal valid Bool N -


VALID

HSI TF FLAGS Nav TO/FROM flag: Enum N -


0 = Off
1 = TO
2 = FROM

HSI BEARING This will return true if the HSI Bool N -


VALID BEARING variable contains valid
data.

HSI BEARING If the GPS DRIVES NAV1 variable Degrees N -


is true and the HSI BEARING
VALID variable is true, this
variable contains the HSI needle
bearing. If the GPS DRIVES NAV1
variable is false and the HSI
BEARING VALID variable is true,
this variable contains the ADF1

39 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

frequency.

HSI HAS Station is a localizer Bool N -


LOCALIZER

HSI SPEED DME/GPS speed Knots N -

HSI DISTANCE DME/GPS distance Nautical miles N -

GPS POSITION Current GPS latitude Degrees N -


LAT

GPS POSITION Current GPS longitude Degrees N -


LON

GPS POSITION Current GPS altitude Meters N -


ALT

GPS MAGVAR Current GPS magnetic variation Radians N -

GPS IS ACTIVE Flight plan mode active Bool N -


FLIGHT PLAN

GPS IS ACTIVE Waypoint mode active Bool N -


WAY POINT

GPS IS ARRIVED Is flight plan destination reached Bool N -

GPS IS DIRECTTO Is Direct To Waypoint mode active Bool N -


FLIGHTPLAN

40 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

GPS GROUND Current ground speed Meters per second N -


SPEED

GPS GROUND Current true heading Radians N -


TRUE HEADING

GPS GROUND Current magnetic ground track Radians N -


MAGNETIC
TRACK

GPS GROUND Current true ground track Radians N -


TRUE TRACK

GPS WP Distance to waypoint Meters N -


DISTANCE

GPS WP BEARING Magnetic bearing to waypoint Radians N -

GPS WP TRUE True bearing to waypoint Radians N -


BEARING

GPS WP CROSS Cross track distance Meters N -


TRK

GPS WP DESIRED Desired track to waypoint Radians N -


TRACK

GPS WP TRUE Required true heading to Radians N -


REQ HDG waypoint

GPS WP Vertical speed to waypoint Meters per second N -

41 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

VERTICAL SPEED

GPS WP TRACK Tracking angle error to waypoint Radians N -


ANGLE ERROR

GPS ETE Estimated time enroute to Seconds N -


destination

GPS ETA Estimated time of arrival at Seconds N -


destination

GPS WP NEXT Latitude of next waypoint Degrees N -


LAT

GPS WP NEXT Longitude of next waypoint Degrees N -


LON

GPS WP NEXT Altitude of next waypoint Meters N -


ALT

GPS WP PREV Is previous waypoint valid (i.e. Bool N -


VALID current waypoint is not the first
waypoint)

GPS WP PREV LAT Latitude of previous waypoint Degrees N -

GPS WP PREV Longitude of previous waypoint Degrees N -


LON

GPS WP PREV ALT Altitude of previous waypoint Meters N -

42 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

GPS WP ETE Estimated time enroute to Seconds N -


waypoint

GPS WP ETA Estimated time of arrival at Seconds N -


waypoint

GPS COURSE TO Suggested heading to steer (for Radians N -


STEER autopilot)

GPS FLIGHT PLAN Index of waypoint Number N -


WP INDEX

GPS FLIGHT PLAN Number of waypoints Number N -


WP COUNT

GPS IS ACTIVE Is switching to next waypoint Bool N -


WP LOCKED locked

GPS IS Is approach loaded Bool N -


APPROACH
LOADED

GPS IS Is approach mode active Bool N -


APPROACH
ACTIVE

GPS APPROACH Sub mode within approach mode Enum N -


MODE :
0 = None
1 = Transition
2 = Final

43 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

3 = Missed

GPS APPROACH Waypoint type within approach Enum N -


WP TYPE mode :
0 = None
1 = Fix
2 = Procedure turn left
3 = Procedure turn right
4 = Dme arc left
5 = Dme arc right
6 = Holding left
7 = Holding right
8 = Distance
9 = Altitude
10 = Manual sequence
11 = Vector to final

GPS APPROACH Waypoint is the runway Bool N -


IS WP RUNWAY

GPS APPROACH Segment type within approach : Enum N -


SEGMENT TYPE 0 = Line
1 = Arc clockwise
2 = Arc counter-clockwise

GPS APPROACH Index of approach for given Number N -


APPROACH airport
INDEX

GPS APPROACH Approach type : Enum N -


APPROACH TYPE 0 = None
1 = GPS

44 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

2 = VOR
3 = NDB
4 = ILS
5 = Localizer
6 = SDF
7 = LDA
8 = VOR/DME
9 = NDB/DME
10 = RNAV
11 = Backcourse

GPS APPROACH Index of approach transition Number N -


TRANSITION
INDEX

GPS APPROACH Is approach transition final Bool N -


IS FINAL approach segment

GPS APPROACH Is approach segment missed Bool N -


IS MISSED approach segment

GPS APPROACH Deviation of local time from GMT Seconds N -


TIMEZONE
DEVIATION

GPS APPROACH Index of current waypoint Number N -


WP INDEX

GPS APPROACH Number of waypoints Number N -


WP COUNT

45 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

GPS DRIVES NAV1 GPS is driving Nav 1 indicator Bool N Shared


Cockpit

COM RECEIVE ALL Toggles all COM radios to receive Bool N -


on

COM AVAILABLE True if either COM1 or COM2 is Bool N -


available

COM TEST:index Enter an index of 1 or 2. True if Bool N -


the COM system is working.

TRANSPONDER True if a transponder is available Bool N -


AVAILABLE

ADF AVAILABLE True if ADF is available Bool N -

ADF Legacy, use ADF ACTIVE Frequency BCD16 N -


FREQUENCY:index FREQUENCY

ADF EXT Legacy, use ADF ACTIVE Frequency BCD16 N -


FREQUENCY:index FREQUENCY

ADF IDENT ICAO code String N -

ADF NAME Descriptive name String N -

NAV IDENT ICAO code String N -

NAV NAME Descriptive name String N -

46 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

NAV CODES:index Returns bit flags with the Flags N -


following meaning:
BIT7: 0= VOR 1= Localizer
BIT6: 1= glideslope available
BIT5: 1= no localizer backcourse
BIT4: 1= DME transmitter at glide
slope transmitter
BIT3: 1= no nav signal available
BIT2: 1= voice available
BIT1: 1 = TACAN available
BIT0: 1= DME available

NAV GLIDE SLOPE The glide slope gradient. Number N -

NAV RELATIVE Relative bearing to station Degrees N -


BEARING TO
STATION:index

SELECTED DME Selected DME Number N Shared


Cockpit

GPS WP NEXT ID ID of next GPS waypoint String N -

GPS WP PREV ID ID of previous GPS waypoint String N -

GPS TARGET Distance to target Meters N -


DISTANCE

GPS TARGET Altitude of GPS target Meters N -


ALTITUDE

47 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ADF Returns the latitude, longitude SIMCONNECT_DATA_LATLONALTstructure N -


LATLONALT:index and altitude of the station the
radio equipment is currently
tuned to, or zeros if the radio is
not tuned to any ADF station.
Index of 1 or 2 for ADF 1 and ADF
2.

NAV VOR Returns the VOR station latitude, SIMCONNECT_DATA_LATLONALTstructure N -


LATLONALT:index longitude and altitude.

NAV GS Returns the glide slope. SIMCONNECT_DATA_LATLONALTstructure N -


LATLONALT:index

NAV DME Returns the DME station. SIMCONNECT_DATA_LATLONALTstructure N -


LATLONALT:index

INNER MARKER Returns the latitude, longitude SIMCONNECT_DATA_LATLONALTstructure N -


LATLONALT and altitude of the inner marker
of an approach to a runway, if the
aircraft is within the required
proximity, otherwise it will return
zeros.

MIDDLE MARKER Returns the latitude, longitude SIMCONNECT_DATA_LATLONALTstructure N -


LATLONALT and altitude of the middle marker.

OUTER MARKER Returns the latitude, longitude SIMCONNECT_DATA_LATLONALTstructure N -


LATLONALT and altitude of the outer marker.

Aircraft Controls Data

48 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

Simulation Description Units Settable Multiplayer


Variable

YOKE Y POSITION Percent control deflection fore/aft (for Position (-16K to 0) Y -


animation) -16K = Yoke fully
pushed in

YOKE X POSITION Percent control deflection left/right (for Position (-16K to 0) Y -


animation) -16K =

RUDDER PEDAL Percent rudder pedal deflection (for animation) Position (-16K to 0) Y -
POSITION -16K = left pedal
pushed full in

RUDDER Percent rudder input deflection Position (-16K to 0) Y -


POSITION -16K = full left

ELEVATOR Percent elevator input deflection Position (-16K to 0) Y -


POSITION -16K = full down

AILERON Percent aileron input left/right Position (-16K to 0) Y -


POSITION -16K = full left

ELEVATOR TRIM Elevator trim deflection Radians Y Shared


POSITION Cockpit

ELEVATOR TRIM Percent elevator trim (for indication) Position (-16K to 0) N -


INDICATOR -16K = full down

49 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ELEVATOR TRIM Percent elevator trim Percent Over 100 N -


PCT

BRAKE LEFT Percent left brake Position (0 to 32K) 0 Y -


POSITION = off, 32K full

BRAKE RIGHT Percent right brake Position (0 to 32K) 0 Y -


POSITION = off, 32K full

BRAKE Brake on indication Position (0 to 16K) 0 N -


INDICATOR = off, 16K full

BRAKE PARKING Parking brake on Position (0 to 32K) 0 Y Shared


POSITION = off, 32K full Cockpit

BRAKE PARKING Parking brake indicator Bool N -


INDICATOR

SPOILERS ARMED Auto-spoilers armed Bool N All aircraft

SPOILERS Spoiler handle position Percent Over 100 or Y All aircraft


HANDLE Position (16K =
POSITION down, 0 = up)

SPOILERS LEFT Percent left spoiler deflected Percent Over 100 or N -


POSITION Position (0 =
retracted, 16K fully
extended)

SPOILERS RIGHT Percent right spoiler deflected Percent Over 100 or N -


POSITION Position (0 =

50 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

retracted, 16K fully


extended)

FLAPS HANDLE Percent flap handle extended Percent Over 100 N -


PERCENT

FLAPS HANDLE Index of current flap position Number Y All aircraft


INDEX

FLAPS NUM Number of flap positions Number N -


HANDLE
POSITIONS

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

51 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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.

AILERON LEFT Angle deflection Radians N -


DEFLECTION

AILERON LEFT Percent deflection Percent Over 100 N -


DEFLECTION PCT

AILERON RIGHT Angle deflection Radians N -


DEFLECTION

AILERON RIGHT Percent deflection Percent Over 100 N -


DEFLECTION PCT

AILERON Angle deflection Radians N -


AVERAGE
DEFLECTION

AILERON TRIM Angle deflection Radians N -

52 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

AILERON TRIM Percent deflection Percent Over 100 Y Shared


PCT Cockpit

RUDDER Angle deflection Radians N -


DEFLECTION

RUDDER Percent deflection Percent Over 100 N -


DEFLECTION PCT

RUDDER TRIM Angle deflection Radians N -

RUDDER TRIM Percent deflection Percent Over 100 Y Shared


PCT Cockpit

FLAPS AVAILABLE True if flaps available Bool N -

FLAP DAMAGE BY True if flagps are damaged by excessive speed Bool N -


SPEED

FLAP SPEED True if safe speed limit for flaps exceeded Bool N -
EXCEEDED

ELEVATOR Angle deflection Radians N -


DEFLECTION

ELEVATOR Percent deflection Percent Over 100 N -


DEFLECTION PCT

ALTERNATE Alternate static air source Bool N All aircraft


STATIC SOURCE
OPEN

53 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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

FOLDING WING True if the folding wing handle is engaged. Bool N -


HANDLE
POSITION

FUEL DUMP If true the aircraft is dumping fuel at the rate Bool N -
SWITCH set in the configuration file.

Aircraft Autopilot Data

Simulation Variable Description Units Settable Multiplayer

AUTOPILOT AVAILABLE Available flag Bool N -

AUTOPILOT MASTER On/off flag Bool N Shared


Cockpit

AUTOPILOT NAV SELECTED Index of Nav radio selected Number N -

AUTOPILOT WING LEVELER Wing leveler active Bool N Shared


Cockpit

AUTOPILOT NAV1 LOCK Lateral nav mode active Bool N -

54 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

AUTOPILOT HEADING Heading mode active Bool N Shared


LOCK Cockpit

AUTOPILOT HEADING Selected heading Degrees N Shared


LOCK DIR Cockpit

AUTOPILOT ALTITUDE Altitude hole active Bool N Shared


LOCK Cockpit

AUTOPILOT ALTITUDE Selected altitude Feet N Shared


LOCK VAR Cockpit

AUTOPILOT ATTITUDE Attitude hold active Bool N Shared


HOLD Cockpit

AUTOPILOT GLIDESLOPE GS hold active Bool N Shared


HOLD Cockpit

AUTOPILOT PITCH HOLD Current reference pitch Radians N -


REF

AUTOPILOT APPROACH Approach mode active Bool N Shared


HOLD Cockpit

AUTOPILOT BACKCOURSE Back course mode active Bool N Shared


HOLD Cockpit

AUTOPILOT VERTICAL Selected vertical speed Feet/minute N Shared


HOLD VAR Cockpit

AUTOPILOT PITCH HOLD Set to True if the autopilot pitch hold has is Bool N -

55 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

engaged.

AUTOPILOT FLIGHT Flight director active Bool N Shared


DIRECTOR ACTIVE Cockpit

AUTOPILOT FLIGHT Reference pitch angle Radians N -


DIRECTOR PITCH

AUTOPILOT FLIGHT Reference bank angle Radians N -


DIRECTOR BANK

AUTOPILOT AIRSPEED Airspeed hold active Bool N Shared


HOLD Cockpit

AUTOPILOT AIRSPEED Selected airspeed Knots N Shared


HOLD VAR Cockpit

AUTOPILOT MACH HOLD Mach hold active Bool N Shared


Cockpit

AUTOPILOT MACH HOLD Selected mach Number N Shared


VAR Cockpit

AUTOPILOT YAW DAMPER Yaw damper active Bool N Shared


Cockpit

AUTOPILOT RPM HOLD Selected rpm Number N -


VAR

AUTOPILOT THROTTLE Autothrottle armed Bool N Shared


ARM Cockpit

56 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

AUTOPILOT TAKEOFF Takeoff / Go Around power mode active Bool N Shared


POWER ACTIVE Cockpit

AUTOTHROTTLE ACTIVE Auto-throttle active Bool N -

AUTOPILOT NAV1 LOCK True if autopilot nav1 lock applied Bool N Shared
Cockpit

AUTOPILOT VERTICAL True if autopilot vertical hold applied Bool N -


HOLD

AUTOPILOT RPM HOLD True if autopilot rpm hold applied Bool N -

AUTOPILOT MAX BANK True if autopilot max bank applied Radians N -

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 -

57 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

failed.

Aircraft Landing Gear Data

Simulation Description Units Settable Multiplayer


Variable

IS GEAR True if gear can be retracted Bool N -


RETRACTABLE

IS GEAR SKIS True if landing gear is skis Bool N -

IS GEAR FLOATS True if landing gear is floats Bool N -

IS GEAR SKIDS True if landing gear is skids Bool N -

IS GEAR WHEELS True if landing gear is wheels Bool N -

GEAR HANDLE True if gear handle is applied Bool Y All aircraft


POSITION

GEAR HYDRAULIC Gear hydraulic pressure Pound force per N -


PRESSURE square foot (psf)

TAILWHEEL LOCK True if tailwheel lock applied Bool N -


ON

GEAR CENTER Percent center gear extended Percent Over 100 Y -

58 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

POSITION

GEAR LEFT Percent left gear extended Percent Over 100 Y -


POSITION

GEAR RIGHT Percent right gear extended Percent Over 100 Y -


POSITION

GEAR TAIL Percent tail gear extended Percent Over 100 N -


POSITION

GEAR AUX Percent auxiliary gear extended Percent Over 100 N -


POSITION

GEAR Position of landing gear: Enum Y -


POSITION:index 0 = unknown
1 = up
2 = down

GEAR ANIMATION Percent gear animation extended Number N -


POSITION:index

GEAR TOTAL PCT Percent total gear extended Percentage N -


EXTENDED

AUTO BRAKE Auto brake switch position Number N -


SWITCH CB

WATER RUDDER Position of the water rudder handle (0 handle Percent Over 100 Y All aircraft
HANDLE POSITION retracted, 100 rudder handle applied)

59 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

WATER LEFT Percent extended Percentage N -


RUDDER EXTENDED

WATER RIGHT Percent extended Percentage N -


RUDDER EXTENDED

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 -

60 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

RUDDER STEER positive to the right.


ANGLE

GEAR CENTER Center steer angle as a percentage Percent Over 100 N -


STEER ANGLE PCT

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

WATER RIGHT Water right rudder as a percentage Percent Over 100 N -


RUDDER STEER
ANGLE PCT

WHEEL RPM:index Wheel rpm. Index is Rpm N -

61 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

0 = center
1 = left
2 = right
3 = aux

CENTER WHEEL Center landing gear rpm Rpm N -


RPM

LEFT WHEEL RPM Left landing gear rpm Rpm N -

RIGHT WHEEL RPM Right landing gear rpm Rpm N -

AUX WHEEL RPM Rpm of fourth set of gear wheels. Rpm N -

WHEEL ROTATION Wheel rotation angle. Index is Radians N -


ANGLE:index 0 = center
1 = left
2 = right
3 = aux

CENTER WHEEL Center wheel rotation angle Radians N -


ROTATION ANGLE

LEFT WHEEL Left wheel rotation angle Radians N -


ROTATION ANGLE

RIGHT WHEEL Right wheel rotation angle Radians N -


ROTATION ANGLE

AUX WHEEL Aux wheel rotation angle Radians N -


ROTATION ANGLE

62 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

GEAR EMERGENCY True if gear emergency handle applied Bool N -


HANDLE POSITION

GEAR WARNING One of: Enum N -


0: unknown
1: normal
2: amphib

ANTISKID BRAKES True if antiskid brakes active Bool N -


ACTIVE

RETRACT FLOAT True if retract float switch on Bool N -


SWITCH

RETRACT LEFT If aircraft has retractable floats. Percent (0 is fully N -


FLOAT EXTENDED retracted, 100 is
fully extended)

RETRACT RIGHT If aircraft has retractable floats. Percent (0 is fully N -


FLOAT EXTENDED retracted, 100 is
fully extended)

STEER INPUT Position of steering tiller Percent over 100 N -


CONTROL

GEAR DAMAGE BY True if gear has been damaged by excessive Bool N -


SPEED speed

GEAR SPEED True if safe speed limit for gear exceeded Bool N -
EXCEEDED

63 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

NOSEWHEEL LOCK True if the nosewheel lock is engaged. Bool N -


ON

Aircraft Environment Data

Simulation Description Units Settable Multiplayer


Variable

AMBIENT Ambient density Slugs per cubic N -


DENSITY feet

AMBIENT Ambient temperature Celsius N -


TEMPERATURE

AMBIENT Ambient pressure Inches of N -


PRESSURE mercury, inHg

AMBIENT WIND Wind velocity Knots N -


VELOCITY

AMBIENT WIND Wind direction Degrees N -


DIRECTION

AMBIENT WIND X Wind component in East/West direction. Meters per N -


second

AMBIENT WIND Y Wind component in vertical direction. Meters per N -


second

64 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

AMBIENT WIND Z Wind component in North/South direction. Meters per N -


second

STRUCT AMBIENT X (latitude), Y (vertical) and Z (longitude) Feet_per_second N -


WIND components of the wind.

AMBIENT PRECIP Precip state (bit field) Mask N -


STATE 2 = None
4 = Rain
8 = Snow

AIRCRAFT WIND Wind component in aircraft lateral axis Knots N -


X

AIRCRAFT WIND Wind component in aircraft vertical axis Knots N -


Y

AIRCRAFT WIND Wind component in aircraft longitudinal axis Knots N -


Z

BAROMETER Barometric pressure Millibars N -


PRESSURE

SEA LEVEL Barometric pressure at sea level Millibars N -


PRESSURE

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.

WINDSHIELD Is visual effect available on this aircraft Bool N -

65 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

RAIN EFFECT
AVAILABLE

AMBIENT IN True if the aircraft is in a cloud. Bool N -


CLOUD

AMBIENT Ambient visibility Meters N -


VISIBILITY

STANDARD ATM Outside temperature on the standard ATM scale Rankine N -


TEMPERATURE

Helicopter Specific Data

Note: Only variables that specifically mention the Bell helicopter apply to the Bell.

Simulation Description Units Settable Multiplayer


Variable

ROTOR BRAKE Percent actuated Percent Over 100 N -


HANDLE POS

ROTOR BRAKE Active Bool N -


ACTIVE

ROTOR CLUTCH Switch position Bool N -


SWITCH POS

ROTOR CLUTCH Active Bool N -

66 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ACTIVE

ROTOR Main rotor transmission temperature Rankine N -


TEMPERATURE

ROTOR CHIP Chip detection Bool N -


DETECTED

ROTOR GOV Switch position Bool N -


SWITCH POS

ROTOR GOV ACTIVE Active Bool N -

ROTOR LATERAL Trim percent Percent Over 100 N -


TRIM PCT

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)

67 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ENG Transmission pressure. Applies only to Bell PSI scalar 16K (Psi N -
TRANSMISSION helicopter. * 16384)
PRESSURE

ENG Transmission temperature. Applies only to Bell Celsius scalar 16K N -


TRANSMISSION helicopter. (Degrees * 16384)
TEMPERATURE

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.

COLLECTIVE The position of the helicopter's collective. 0 is Percent_over_100 N -


POSITION fully up, 100 fully depressed.

Slings and Hoists

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).

PAYLOAD STATION The number of objects at the payload station Number N -


NUM (indexed from 1).
SIMOBJECTS:index

68 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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 True if the cable is broken. Bool N -


BROKEN:index

SLING CABLE The length of the cable extending from the Feet Y -
EXTENDED aircraft.
LENGTH:index

SLING ACTIVE The payload station (identified by the Number Y -


PAYLOAD parameter) where objects will be placed from
STATION:index the sling (identified by the index).

SLING HOIST The percentage of the full length of the sling Percent_over_100 N -
PERCENT cable deployed.
DEPLOYED:index

SLING HOOK IN A Boolean for whether or not the hook is in Bool N -


PICKUP pickup mode, so capable of picking up another
MODE:index object.

IS ATTACHED TO Set to true if this object is attached to a sling. Bool N -


SLING

Aircraft Miscellaneous Systems Data

69 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

Simulation Description Units Settable Multiplayer


Variable

SMOKE ENABLE Set to True to activate the smoke system, if one is Bool Y All aircraft
available (for example, on the Extra).

SMOKESYSTEM Smoke system available Bool N -


AVAILABLE

PITOT HEAT Pitot heat active Bool N All aircraft

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

CANOPY OPEN Percent primary door/exit open Percent Y -


Over 100

TAILHOOK POSITION Percent tail hook extended Percent Y -


Over 100

EXIT OPEN:index Percent door/exit open Percent Y -


Over 100

STALL HORN True if stall alarm available Bool N -


AVAILABLE

70 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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.

CARB HEAT True if carb heat available Bool N -


AVAILABLE

SPOILER AVAILABLE True if spoiler system available Bool N -

IS TAIL DRAGGER True if the aircraft is a taildragger Bool N -

STROBES AVAILABLE True if strobe lights are available Bool N -

TOE BRAKES True if toe brakes are available Bool N -


AVAILABLE

PUSHBACK STATE Type of pushback : Enum Y -


0 = Straight
1 = Left
2 = Right

ELECTRICAL MASTER Battery switch position Bool Y All aircraft


BATTERY

ELECTRICAL TOTAL Total load amps Amperes Y -


LOAD AMPS

ELECTRICAL Battery load Amperes Y -


BATTERY LOAD

ELECTRICAL Battery voltage Volts Y -

71 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

BATTERY VOLTAGE

ELECTRICAL MAIN Main bus voltage Volts Y -


BUS VOLTAGE

ELECTRICAL MAIN Main bus current Amperes Y -


BUS AMPS

ELECTRICAL Avionics bus voltage Volts Y -


AVIONICS BUS
VOLTAGE

ELECTRICAL Avionics bus current Amperes Y -


AVIONICS BUS AMPS

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

ELECTRICAL Battery bus voltage Volts Y -


BATTERY BUS
VOLTAGE

ELECTRICAL Battery bus current Amperes Y -


BATTERY BUS AMPS

ELECTRICAL GENALT Genalt bus voltage (takes engine index) Volts Y -


BUS VOLTAGE:index

72 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

ELECTRICAL GENALT Genalt bus current (takes engine index) Amperes Y -


BUS AMPS:index

CIRCUIT GENERAL Is electrical power available to this circuit Bool N -


PANEL ON

CIRCUIT FLAP Is electrical power available to this circuit Bool N -


MOTOR ON

CIRCUIT GEAR Is electrical power available to this circuit Bool N -


MOTOR ON

CIRCUIT AUTOPILOT Is electrical power available to this circuit Bool N -


ON

CIRCUIT AVIONICS Is electrical power available to this circuit Bool N -


ON

CIRCUIT PITOT HEAT Is electrical power available to this circuit Bool N -


ON

CIRCUIT PROP SYNC Is electrical power available to this circuit Bool N -


ON

CIRCUIT AUTO Is electrical power available to this circuit Bool N -


FEATHER ON

CIRCUIT AUTO Is electrical power available to this circuit Bool N -


BRAKES ON

CIRCUIT STANDY Is electrical power available to this circuit Bool N Shared

73 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

VACUUM ON Cockpit

CIRCUIT MARKER Is electrical power available to this circuit Bool N -


BEACON ON

CIRCUIT GEAR Is electrical power available to this circuit Bool N -


WARNING ON

CIRCUIT HYDRAULIC Is electrical power available to this circuit Bool N -


PUMP ON

HYDRAULIC Hydraulic system pressure. Indexes start at 1. Pound force N -


PRESSURE:index per square
foot

HYDRAULIC Hydraulic pressure changes will follow changes to Percent Y -


RESERVOIR this variable. Indexes start at 1. Over 100
PERCENT:index

HYDRAULIC SYSTEM Percent system functional Percent N -


INTEGRITY Over 100

STRUCTURAL DEICE True if the aircraft structure deice switch is on Bool N -


SWITCH

APPLY HEAT TO Used when too close to a fire. Bool Y -


SYSTEMS

DROPPABLE The type of droppable object at the station number String Y -


OBJECTS TYPE:index identified by the index.

74 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

DROPPABLE The number of droppable objects at the station Number N -


OBJECTS number identified by the index.
COUNT:index

Aircraft Miscellaneous Data

Simulation Description Units Settable Multiplayer


Variable

TOTAL WEIGHT Total weight of the aircraft Pounds N -

MAX GROSS Maximum gross weight of the aircaft Pounds N -


WEIGHT

EMPTY WEIGHT Empty weight of the aircraft Pounds N -

IS USER SIM Is this the user loaded aircraft Bool N -

SIM DISABLED Is sim disabled Bool Y -

G FORCE Current g force GForce Y All aircraft

ATC HEAVY Is this aircraft recognized by ATC as heavy Bool Y -

AUTO Is auto-coordination active Bool Y -


COORDINATION

REALISM General realism percent Number Y -

75 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

TRUE AIRSPEED True if True Airspeed has been selected Bool Y -


SELECTED

DESIGN SPEED VS0 Design speed at VS0 Feet per N -


second

DESIGN SPEED VS1 Design speed at VS1 Feet per N -


second

DESIGN SPEED VC Design speed at VC Feet per N -


second

MIN DRAG Minimum drag velocity Feet per N -


VELOCITY second

ESTIMATED CRUISE Estimated cruise speed Feet per N -


SPEED second

CG PERCENT Longitudinal CG position as a percent of reference chord Percent N -


over 100

CG PERCENT Lateral CG position as a percent of reference chord Percent N -


LATERAL over 100

IS SLEW ACTIVE True if slew is active Bool Y Shared


Cockpit

IS SLEW ALLOWED True if slew is enabled Bool Y Shared


Cockpit

ATC SUGGESTED Suggested minimum runway length for takeoff. Used by Feet N -

76 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

MIN RWY TAKEOFF ATC

ATC SUGGESTED Suggested minimum runway length for landing. Used by Feet N -
MIN RWY ATC
LANDING

PAYLOAD STATION Individual payload station weight Pounds Y -


WEIGHT:index

PAYLOAD STATION Number of payload stations Number N -


COUNT

USER INPUT Is input allowed from the user Bool Y -


ENABLED

TYPICAL DESCENT Normal descent rate Feet per N -


RATE minute

VISUAL MODEL Model radius Meters N -


RADIUS

CATEGORY One of the following: String N -


"Airplane",
"Helicopter",
"Boat",
"GroundVehicle",
"ControlTower",
"SimpleObject",
"Viewer"

SIGMA SQRT Sigma sqrt Number N -

77 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

DYNAMIC Dynamic pressure Pounds N -


PRESSURE per
square
foot

TOTAL VELOCITY Velocity regardless of direction. For example, if a Feet per N -


helicopter is ascending vertically at 100 fps, getting this second
variable will return 100.

AIRSPEED SELECT The airspeed, whether true or indicated airspeed has Knots N -
INDICATED OR been selected.
TRUE

VARIOMETER RATE Variometer rate Feet per N -


second

VARIOMETER True if the variometer switch is on Bool N -


SWITCH

PRESSURE Altitude reading Meters N -


ALTITUDE

MAGNETIC Compass reading Degrees N -


COMPASS

TURN INDICATOR Turn indicator reading Radians N -


RATE per
second

TURN INDICATOR True if turn indicator switch is on Bool N -


SWITCH

78 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

YOKE Y INDICATOR Yoke position in vertical direction Position N -

YOKE X INDICATOR Yoke position in horizontal direction Position N -

RUDDER PEDAL Rudder pedal position Position N -


INDICATOR

BRAKE DEPENDENT Brake dependent hydraulic pressure reading Pounds N -


HYDRAULIC per
PRESSURE square
foot

PANEL ANTI ICE True if panel anti-ice switch is on Bool N -


SWITCH

WING AREA Total wing area Square N -


feet

WING SPAN Total wing span Feet N -

BETA DOT Beta dot Radians N -


per
second

LINEAR CL ALPHA Linear CL alpha Per radian N -

STALL ALPHA Stall alpha Radians N -

ZERO LIFT ALPHA Zero lift alpha Radians N -

CG AFT LIMIT Aft limit of CG Percent N -

79 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

over 100

CG FWD LIMIT Forward limit of CG Percent N -


over 100

CG MAX MACH Max mach CG Machs N -

CG MIN MACH Min mach CG Machs N -

PAYLOAD STATION Descriptive name for payload station String N -


NAME

ELEVON Elevon deflection Radians N -


DEFLECTION

EXIT TYPE One of: Enum N -


0: Main
1: Cargo
2: Emergency
3: Unknown

EXIT POSX Position of exit relative to datum reference point Feet N -

EXIT POSY Position of exit relative to datum reference point Feet N -

EXIT POSZ Position of exit relative to datum reference point Feet N -

DECISION HEIGHT Design decision height Feet N -

DECISION Design decision altitude above mean sea level Feet N -


ALTITUDE MSL

80 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

EMPTY WEIGHT Empty weight pitch moment of inertia Slugs per N -


PITCH MOI feet
squared

EMPTY WEIGHT Empty weight roll moment of inertia Slugs per N -


ROLL MOI feet
squared

EMPTY WEIGHT Empty weight yaw moment of inertia Slugs per N -


YAW MOI feet
squared

EMPTY WEIGHT Empty weigth cross coupled moment of inertia Slugs per N -
CROSS COUPLED feet
MOI squared

TOTAL WEIGHT Total weight pitch moment of inertia Slugs per N -


PITCH MOI feet
squared

TOTAL WEIGHT Total weight roll moment of inertia Slugs per N -


ROLL MOI feet
squared

TOTAL WEIGHT Total weight yaw moment of inertia Slugs per N -


YAW MOI feet
squared

TOTAL WEIGHT Total weight cross coupled moment of inertia Slugs per N -
CROSS COUPLED feet
MOI squared

81 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

WATER BALLAST True if water ballast valve is available Bool N -


VALVE

MAX RATED Maximum rated rpm Rpm N -


ENGINE RPM

FULL THROTTLE Full throttle thrust to weight ratio Number N -


THRUST TO
WEIGHT RATIO

PROP AUTO CRUISE True if prop auto cruise active Bool N -


ACTIVE

PROP ROTATION Prop rotation angle Radians N -


ANGLE

PROP BETA MAX Prop beta max Radians N -

PROP BETA MIN Prop beta min Radians N -

PROP BETA MIN Prop beta min reverse Radians N -


REVERSE

FUEL SELECTED One of: Enum N -


TRANSFER MODE -1: off
0: auto
1: forward
2: aft
3: manual

DROPPABLE Descriptive name, used in User Interface dialogs, of a String N -

82 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

OBJECTS UI NAME droppable object

MANUAL FUEL Position of manual fuel pump handle. 100 is fully Percent N -
PUMP HANDLE deployed. over 100

BLEED AIR SOURCE One of: Enum N -


CONTROL 0: min
1: auto
2: off
3: apu
4: engines

ELECTRICAL OLD Legacy, use ELECTRICAL BATTERY LOAD Amps N -


CHARGING AMPS

HYDRAULIC True if hydraulic switch is on Bool N -


SWITCH

CONCORDE VISOR One of: Enum N All aircraft


NOSE HANDLE 0: visor up, nose down
1: visor down, nose up
2: visor down, nose 5 degrees
3: visor down, nose 12.5 degrees

CONCORDE VISOR 0 = up, 1.0 = extended/down Percent N -


POSITION PERCENT over 100

CONCORDE NOSE 0 = up Radians N -


ANGLE

REALISM CRASH True indicates crashing with other aircraft is possible. Bool N -

83 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

WITH OTHERS

REALISM CRASH True indicates crash detection is turned on. Bool N -


DETECTION

MANUAL True if instrument lights are set manually Bool N -


INSTRUMENT
LIGHTS

PITOT ICE PCT Amount of pitot ice. 100 is fully iced. Percent N -
over 100

SEMIBODY Semibody loadfactor x and z are not supported. Number N -


LOADFACTOR Y

SEMIBODY Semibody loadfactory ydot Per N -


LOADFACTOR YDOT second

RAD INS SWITCH True if Rad INS switch on Bool N -

SIMULATED Simulated radius Feet N -


RADIUS

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

SURFACE INFO True indicates SURFACE CONDITION is meaningful. Bool N -

84 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

VALID

SURFACE One of: Enum N -


CONDITION 0: Normal
1: Wet
2: Icy
3: Snow

PUSHBACK ANGLE Pushback angle (the heading of the tug) Radians N -

PUSHBACK The towpoint position, relative to the aircrafts datum Feet N -


CONTACTX reference point.

PUSHBACK Pushback contact position in vertical direction Feet N -


CONTACTY

PUSHBACK Pushback contact position in fore/aft direction Feet N -


CONTACTZ

PUSHBACK WAIT True if waiting for pushback. Bool N -

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.

YAW STRING PCT Yaw string angle as a percentage Percent N -


EXTENDED over 100

INDUCTOR Inductor compass deviation reading Percent N -


COMPASS PERCENT over 100
DEVIATION

85 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

INDUCTOR Inductor compass heading Radians N -


COMPASS
HEADING REF

ANEMOMETER PCT Anemometer rpm as a percentage Percent N -


RPM over 100

ROTOR ROTATION Main rotor rotation angle (helicopters only) Radians N -


ANGLE

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

NAV VOR LLAF64 Nav VOR latitude, longitude, altitude LLA N -


structure

NAV GS LLAF64 Nav GS latitude, longitude, altitude LLA N -


structure

STATIC CG TO Static CG to ground Feet N -


GROUND

86 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

STATIC PITCH Static pitch Radians N -

CRASH SEQUENCE One of: Enum N -


0: off
1: complete
3: reset
4: pause
11: start

CRASH FLAG One of: Enum N Shared


0: None Cockpit
2: Mountain
4: General
6: Building
8: Splash
10: Gear up
12: Overstress
14: Building
16: Aircraft
18: Fuel Truck

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.

APU PCT RPM Auxiliary power unit rpm, as a percentage Percent N -


over 100

APU PCT STARTER Auxiliary power unit starter, as a percentage Percent N -


over 100

87 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

APU VOLTS Auxiliary power unit voltage Volts N -

APU GENERATOR True if APU generator switch on Bool N -


SWITCH

APU GENERATOR True if APU generator active Bool N -


ACTIVE

APU ON FIRE True if APU on fire Bool N -


DETECTED

PRESSURIZATION The current altitude of the cabin pressurization.. Feet N -


CABIN ALTITUDE

PRESSURIZATION The set altitude of the cabin pressurization. Feet N -


CABIN ALTITUDE
GOAL

PRESSURIZATION The rate at which cabin pressurization changes. Feet per N -


CABIN ALTITUDE second
RATE

PRESSURIZATION The difference in pressure between the set altitude Pounds N -


PRESSURE pressurization and the current pressurization. per
DIFFERENTIAL square
foot

PRESSURIZATION True if the cabin pressurization dump switch is on. Bool N -


DUMP SWITCH

FIRE BOTTLE True if the fire bottle switch is on. Bool N -

88 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

SWITCH

FIRE BOTTLE True if the fire bottle is discharged. Bool N -


DISCHARGED

CABIN NO True if the No Smoking switch is on. Bool Y -


SMOKING ALERT
SWITCH

CABIN SEATBELTS True if the Seatbelts switch is on. Bool Y -


ALERT SWITCH

GPWS WARNING True if Ground Proximity Warning System installed. Bool N -

GPWS SYSTEM True if the Ground Proximity Warning System is active Bool Y -
ACTIVE

IS LATITUDE True if the lat/lon of the aircraft (either user or AI Bool N -


LONGITUDE FREEZE controlled) is frozen. If this variable returns true, it means
ON that the latitude and longitude of the aircraft are not
being controlled by ESP, so enabling, for example, a
SimConnect client to control the position of the aircraft.
This can also apply to altitude and attitude.
Also refer to the range of KEY_FREEZE..... Event IDs.

IS ALTITUDE True if the altitude of the aircraft is frozen. Bool N -


FREEZE ON

IS ATTITUDE True if the attitude (pitch, bank and heading) of the Bool N -
FREEZE ON aircraft is frozen.

89 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

Aircraft String Data

Simulation Variable Description Units Settable Multiplayer

ATC TYPE Type used by ATC String (30) N -

ATC MODEL Model used by ATC String (10) N -

ATC ID ID used by ATC String (10) Y -

ATC AIRLINE Airline used by ATC String (50) Y -

ATC FLIGHT NUMBER Flight Number used by ATC String (6) Y -

TITLE Title from aircraft.cfg Variable length N -


string

HSI STATION IDENT Tuned station identifier String(6) N -

GPS WP_PREV ID ID of previous GPS waypoint String N -

GPS WP_NEXT ID ID of next GPS waypoint String N -

GPS APPROACH AIRPORT ID ID of airport String N -

GPS APPROACH APPROACH ID ID of approach String N -

GPS APPROACH TRANSITION ID of approach transition String N -


ID

90 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

AI Controlled Aircraft

Simulation Description Units Settable Multiplayer


Variable

AI DESIRED SPEED Desired speed of the AI object. Knots Y -

AI WAYPOINT LIST List of waypoints that an AI SIMCONNECT_DATA_WAYPOINT Y -


controlled object should follow. structure list

AI CURRENT Current waypoint in the list Number Y -


WAYPOINT

AI DESIRED HEADING Desired heading of the AI object. Degrees Y -

AI Time to make a 90 degree turn. Seconds Y -


GROUNDTURNTIME

AI Cruising speed. Knots Y -


GROUNDCRUISESPEED

AI Turning speed. Knots Y -


GROUNDTURNSPEED

AI TRAFFIC ISIFR Request whether this aircraft is Boolean N -


IFR or VFR See Note 1.

AI TRAFFIC STATE English string describing an AI String N -


object's state. If the object is an

91 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

aircraft under ATC control the


string will be one of:
"init"
"sleep"
"flt plan"
"startup"
"preflight support"
"clearance"
"push back 1"
"push back 2"
"pre taxi out"
"taxi out"
"takeoff 1"
"takeoff 2"
"T&G depart"
"enroute"
"pattern"
"landing"
"rollout"
"go around"
"taxi in"
"shutdown"
"postflight support"

If the AI object is not an aircraft


under ATC control, the string is
one of:

"Sleep"
"Waypoint"
"Takeoff"
"Landing"
"Taxi"

92 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

This string also appears in the


State column of the Traffic
Explorer tool dialog. See Note 1.

AI TRAFFIC CURRENT ICAO code of current airport. See String N -


AIRPORT Note 1.

AI TRAFFIC ASSIGNED Assigned runway name (for String N -


RUNWAY example: "32R"). See Note 1.

AI TRAFFIC ASSIGNED English assigned parking name. String N -


PARKING The string is the same as the one
shown in the Parking column of
the Traffic Explorer dialog, and is
made up in the form:

Name + Number, Type ( radius )

For example:

Ramp 1, RAMP sml (10m)


Gate G 4, RAMP lrg (18m)

Refer also to the Taxiway Parking


section of the Compiling BGL
document.
See Note 1.

AI TRAFFIC ICAO code of the departure String N -


FROMAIRPORT airport in the current schedule.
See Note 2.

93 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

AI TRAFFIC ICAO code of the destination String N -


TOAIRPORT airport in the current schedule.
See Note 2.

AI TRAFFIC ETD Estimated time of departure for Seconds N -


the current schedule entry, given
as the number of seconds
difference from the current
simulation time. This can be
negative if ETD is earlier than the
current simulation time. See Note
2.

AI TRAFFIC ETA Estimated time of arrival for the Seconds N -


current schedule entry, given as
the number of seconds difference
from the current simulated time.
This can be negative if ETA is
earlier than the current simulated
time. See Note 2.

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

94 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

Simulation Description Units Settable Multiplayer


Variable

LAUNCHBAR Installed on aircraft before takeoff from a carrier Percent_over_100 N -


POSITION catapult. Note that gear cannot retract with this
extended. 100 = fully extended. Refer to the
document Notes on Aircraft Systems.

LAUNCHBAR If this is set to True the launch bar switch has been Bool N -
SWITCH engaged.

LAUNCHBAR This will be True if the launchbar is fully extended, Bool N -


HELD EXTENDED and can be used, for example, to change the color of
an instrument light.

NUMBER OF Maximum of 4. A model can contain more than 4 Number N -


CATAPULTS catapults, but only the first four will be read and
recognized by the simulation.

CATAPULT Catapults are indexed from 1. This value will be 0 Number N -


STROKE before the catapult fires, and then up to 100 as the
POSITION:index aircraft is propelled down the catapult. The aircraft
may takeoff before the value reaches 100
(depending on the aircraft weight, power applied,
and other factors), in which case this value will not
be further updated. This value could be used to drive
a bogie animation.

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

95 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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.

TAILHOOK True if the tailhook handle is engaged. Bool N -


HANDLE

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

Simulation Variable Description Units Settable Multiplayer

RECIP ENG Indexed from 1. Set to True if the engine is Bool N -


DETONATING:index detonating.

96 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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 engine Number N -


CYLINDERS cylinders.

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. Refer to the Mission Creation Gallons Y -


ANTIDETONATION documentationfor the procedure for refilling
TANK QUANTITY:index tanks.

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 -

97 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

TANK MAX Configuration File.


QUANTITY:index

Environment Data

This data is referenced by E: in XML gauges.

Simulation Variable Description Units Settable Multiplayer

ABSOLUTE TIME Time, as referenced from 12:00 AM January 1, 0000 Seconds N -

ZULU TIME Greenwich Mean Time (GMT) Seconds N -

ZULU DAY OF WEEK GMT day of week Number N -

ZULU DAY OF MONTH GMT day of month Number N -

ZULU MONTH OF YEAR GMT month of year Number N -

ZULU DAY OF YEAR GMT day of year Number N -

ZULU YEAR GMT year Number N -

LOCAL TIME Local time Seconds N -

LOCAL DAY OF WEEK Local day of week Number N -

LOCAL DAY OF MONTH Local day of month Number N -

98 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

LOCAL MONTH OF YEAR Local month of year Number N -

LOCAL DAY OF YEAR Local day of year Number N -

LOCAL YEAR Local year Number N -

TIME ZONE OFFSET Local time difference from GMT Seconds N -

TIME OF DAY General time of day: Enum N -


1 = Day
2 = Dusk/Dawn
3 = Night

Program Data

This data is referenced by P: in XML gauges.

Simulation Variable Description Units Settable Multiplayer

SIMULATION RATE Time acceleration factor Number N -

UNITS OF MEASURE Units of measure: Enum N -


0 = English
1 = Metric (with altitude in feet)
2 = Metric (with altitude in meters)

Units of Measurement

99 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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

100 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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 ~

decimile, decimiles One tenth of a mile

nautical mile, nautical miles, nmile, nmiles Nautical mile, 2024 yards

decinmile, decinmiles One tenth of a nautical mile

foot, feet, ft ~

inch, inches, in ~

yard, yards ~

101 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

Area Details

square inch, square inches, sq in, in2 ~

square feet, square foot, sq ft, ft2 ~

square yard, square yards, sq yd, yd2 ~

square meter, square meters, sq m, m2 ~

square centimeter, square centimeters, sq cm, ~


cm2

square kilometer, square kilometers, sq km, km2 ~

square millimeter, square millimeters, sq mm, ~


mm2

square mile, square miles ~

Volume Details

cubic inch, cubic inches, cu in, in3 ~

102 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

cubic foot, cubic feet, cu ft, ft3 ~

cubic yard, cubic yards, cu yd, yd3 ~

cubic mile, cubic miles ~

cubic millimeter, cubic millimeters, cu mm, mm3 ~

cubic centimeter, cubic centimeters, cu cm, cm3 ~

meter cubed, meters cubed, cubic meter, cubic ~


meters, cu m, m3

cubic kilometer, cubic kilometers, cu km, km3 ~

liter, liters ~

gallon, gallons ~

quart, quarts ~

Temperature Details

kelvin Same graduations as Centigrade but zero degrees Kelvin corresponds to a


temperature of -273.15C (Absolute Zero).

103 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

rankine Same graduations as Farenheit but zero degrees Rankine corresponds to a


temperature of -459.67F

farenheit, fahrenheit ~

celsius ~

Angle Details

radian, radians ~

round, rounds ~

degree, degrees Float

degree latitude ~

degree longitude ~

grad, grads ~

Global position Details

104 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

degree latitude, degrees latitude ~

degree longitude, degrees longitude ~

meter latitude, meters latitude ~

Angular velocity Details

radian per second, radians per second ~

revolution per minute, revolutions per minute, ~


rpm, rpms

minute per round, minutes per round ~

nice minute per round, nice minutes per round ~

degree per second, degrees per second ~

Speed Details

meter per second, meters/second, m/s ~

105 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

meter per minute, meters per minute ~

feet/second ~

feet/minute, ft/min ~

kilometer/hour, kilometers/hour, kilometers per ~


hour, kph

knot, knots Nautical mile per hour

mile per hour, miles per hour, mph ~

mach, machs ~

Acceleration Details

meter per second squared meters per second ~


squared

Gforce, G Force Unit of acceleration equal to the acceleration of gravity.

feet per second squared, foot per second ~


squared

106 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

Time Details

second, seconds ~

minute, minutes ~

hour, hours ~

day, days ~

hour over 10, hours over 10 ~

year, years ~

Power Details

Watt, Watts ~

ft lb per second ~

Volume rate Details

107 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

meter cubed per second, meters cubed per ~


second

gallon per hour, gallons per hour, gph ~

liter per hour, liters per hour ~

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.

pound, pounds, lbs ~

Weight rate Details

kilogram per second, kilograms per second ~

pound per hour, pounds per hour ~

108 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

Electrical Current Details

ampere, amperes, amp, amps ~

Electrical Potential Details

volt, volts ~

Frequency Details

Hertz, Hz, ~

Kilohertz, KHz ~

Megahertz, MHz ~

Frequency BCD32 Frequency in 32 bit binary coded decimal

Frequency BCD16 Frequency in 16 bit binary coded decimal

109 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

Frequency ADF BCD32 ~

Density Details

kilogram per cubic meter, kilograms per cubic ~


meter

Slug per cubic feet, Slugs per cubic feet, ~


Slug/ft3, slug per cubic foot, slugs per cubic
foot

pound per gallon, pounds per gallon, lbs/gallon ~

Pressure Details

pascal, pascals, Pa ~

Newton per square meter, newtons per square ~


meter

kilopascal, kpa ~

kilogram force per square centimeter, KgFSqCm ~

110 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

millimeter of mercury, millimeters of mercury, ~


mmHg

centimeter of mercury, centimeters of mercury, ~


cmHg

inch of mercury, inches of mercury, inHg ~

atmosphere, atmospheres, atm ~

millimeter of water, millimeters of water ~

pound-force per square inch, psi ~

pound-force per square foot, psf ~

bar, bars ~

millibar, millibars, mbar, mbars, hectopascal, ~


hectopascals

boost cmHg ~

boost inHg ~

boost psi ~

slug feet squared, slugs feet squared ~

kilogram meter squared, kilograms meter ~

111 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

squared

millibar, millibars, mbar, mbars, hectopascal, ~


hectopascals

Torque Details

Newton meter, Newton, meters, nm ~

foot-pound, foot pound, ft-lbs, foot-pounds ~

lbf-feet One lbf-foot equals 1.36 Newton meters

kilogram meter, kilogram meters, kgf meter, kgf ~


meters

poundal feet One poundal foot equals 0.042 Newton meters

Miscellaneous Units Details

part ~

half, halfs ~

112 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

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 ~

Enum A positive or negative integer corresponding to the member of the enum

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 ~

113 de 114 12/5/2020 8:46 a. m.


Simulation Variables | Microsoft Docs https://docs.microsoft.com/en-us/previous-versions/microsoft-esp/cc526981(v=msdn.10)?redire...

mask ~

flags ~

string ~

per radian ~

per degree ~

114 de 114 12/5/2020 8:46 a. m.

You might also like