sim/
sim/aircraft/
sim/aircraft/weight/
sim/aircraft/weight/acf_stations_ref_x[9]
float
in meters
N'th payload station's X arm to acft origin
sim/aircraft/weight/acf_stations_ref_y[9]
float
in meters
N'th payload station's Y arm to acft origin
sim/aircraft/weight/acf_stations_ref_z[9]
float
in meters
N'th payload station's Z arm to acft origin
sim/aircraft2/
This section contains dataref access to the aircraft that has been auditied by LR for maintenance. Unlike sim/aircraft/, if you can write these datarefs, it is safe to do so, and reading these datarefs makes sense.
sim/aircraft2/body/
sim/aircraft2/body/kill_body[39]
int
as a boolean
if 1, X-Plane treats the body as having been removed from the aircraft for physics.
2024-03-14pbuck:
Index corresponds to the "Bodies" defined in Planemaker. Does not change visuals.Physics remains for airfoils.
sim/aircraft2/engine/
sim/aircraft2/engine/engine_friction_ratio
float
in multiplier
The drag ratio for an engine's own internal friction and pumping losses. 1.0 for a recip engine provides default behavior of a Continental IO-550; this can be any number greater than zero.
sim/aircraft2/engine/exhaust_dirtiness_ratio
float
as a ratio
dirtiness of built-in exhaust effects, 1.0 is default, positive numbers are more dirty
sim/aircraft2/engine/flap_extension_time_sec
float
in second
Time for flaps to go from full retraction to full extension
sim/aircraft2/engine/flap_retraction_time_sec
float
in second
Time for flaps to go from full extension to full retraction
sim/aircraft2/engine/high_idle_ratio
float
in multiplier
The idle ratio for the engines at high idle. 1.0 provides default behavior; this can be any number greater than zero.
sim/aircraft2/engine/low_idle_ratio
float
in multiplier
The idle ratio for the engines at low idle. 1.0 provides default behavior; this can be any number greater than zero.
sim/aircraft2/engine/max_power_limited_watts
float
in watts
The maximum power output of the engine at sea level. Note that if the engine has a waste gate this is the same as max power at critical altitude.
sim/aircraft2/metadata/
This section contains read-only views of some of the current user's aircraft meta-data.
sim/aircraft2/metadata/is_airliner
int
as a boolean
1 if the vehicle is categorized as an airliner, 0 if it is not.
sim/aircraft2/metadata/is_cargo
int
as a boolean
1 if the vehicle is categorized as a cargo aircraft, 0 if it is not.
sim/aircraft2/metadata/is_experimental
int
as a boolean
1 if the vehicle is categorized as experimental, 0 if it is not.
sim/aircraft2/metadata/is_general_aviation
int
as a boolean
1 if the vehicle is categorized as a general aviation aircraft, 0 if it is not.
sim/aircraft2/metadata/is_glider
int
as a boolean
1 if the vehicle is categorized as a glider, 0 if it is not.
sim/aircraft2/metadata/is_helicopter
int
as a boolean
1 if the vehicle is categorized as a helicopter, 0 if it is not.
sim/aircraft2/metadata/is_military
int
as a boolean
1 if the vehicle is categorized as a military aircraft, 0 if it is not.
sim/aircraft2/metadata/is_sci_fi
int
as a boolean
1 if the vehicle is categorized as a science fiction aircraft, 0 if it is not.
sim/aircraft2/metadata/is_seaplane
int
as a boolean
1 if the vehicle is categorized as a seaplane, 0 if it is not.
sim/aircraft2/metadata/is_ultralight
int
as a boolean
1 if the vehicle is categorized as an ultralight, 0 if it is not.
sim/aircraft2/metadata/is_vtol
int
as a boolean
1 if the vehicle is categorized as a VTOL, 0 if it is not.
sim/airfoils/
sim/airfoils/afl_almax_array[224]
float
in unspecified units
Dimension is 224.
sim/airfoils/afl_almin_array[224]
float
in unspecified units
Dimension is 224.
sim/airfoils/afl_cd[161504]
float
in unspecified units
Dimension is 161504.
sim/airfoils/afl_cl[161504]
float
in unspecified units
Dimension is 161504.
sim/airfoils/afl_clB[224]
float
in unspecified units
Dimension is 224.
sim/airfoils/afl_clM[224]
float
in unspecified units
Dimension is 224.
sim/airfoils/afl_cm[161504]
float
in unspecified units
Dimension is 161504.
sim/airfoils/afl_mach_div[112]
float
in unspecified units
Dimension is 112.
sim/airfoils/afl_re_num[224]
float
in unspecified units
Dimension is 224.
sim/airfoils/afl_t_rat[112]
float
in unspecified units
Dimension is 112.
sim/atc/
sim/atc/atis_enabled
int
as a boolean
Is the ATIS system enabled? If not, no ATIS text or audio will appear even when tuned to a proper frequency.
sim/atc/com1_active
int
as a boolean
Is the user's COM1 radio tuned to a freq that's actively being transmitted on by a pilot or ATC?
sim/atc/com1_rx
int
as a boolean
Is COM1 currently receiving ATC transmission, ATIS, or plugin transmission?
sim/atc/com1_rx_override
int
as a boolean
Set if your plugin currently receives voice on COM1
sim/atc/com1_tuned_facility
int
in enum
The ATC facility type that the user's aircraft is tuned to. 0=None, 1=Del, 2=Gnd, 3=Twr, 4=Tracon, 5=Ctr
sim/atc/com1_tx
int
as a boolean
Is COM1 currently transmitting the pilot's voice to ATC or a plugin?
sim/atc/com1_tx_override
int
as a boolean
Set if your plugin currently transmits voice on COM1
sim/atc/com2_active
int
as a boolean
Is the user's COM1 radio tuned to a freq that's actively being transmitted on by a pilot or ATC?
sim/atc/com2_rx
int
as a boolean
Is COM2 currently receiving ATC transmission, ATIS, or plugin transmission?
sim/atc/com2_rx_override
int
as a boolean
Set if your plugin currently receives voice on COM2
sim/atc/com2_tuned_facility
int
in enum
The ATC facility type that the user's aircraft is tuned to. 0=None, 1=Del, 2=Gnd, 3=Twr, 4=Tracon, 5=Ctr
sim/atc/com2_tx
int
as a boolean
Is COM2 currently transmitting the pilot's voice to ATC or a plugin?
sim/atc/com2_tx_override
int
as a boolean
Set if your plugin currently transmits voice on COM2
sim/atc/user_aircraft_transmitting
int
as a boolean
Is the Users/P0 aircraft currently transmitting on the radio?
sim/cockpit/
sim/cockpit/autopilot/
sim/cockpit/autopilot/airspeed
float
in knots_mach
Airspeed to hold, this changes from knots to a mach number
sim/cockpit/autopilot/airspeed_is_mach
int
as a boolean
Is our airspeed a mach number (this is writable if the panel has the button, otherwise sim controls)
sim/cockpit/autopilot/airspeed_mode
int
in enum
Airspeed mode for the autopilot. DEPRECATED
sim/cockpit/autopilot/alt_hold_ft_fms
float
in unspecified units
sim/cockpit/autopilot/altitude
float
in ftmsl
Altitude dialed into the AP
sim/cockpit/autopilot/altitude_mode
int
in enum
Vertical navigation (alt hold, VVI hold, V-Nav approach). DEPRECATED
sim/cockpit/autopilot/approach_selector
int
in enum
Nav1 or Nav2 approach selection
sim/cockpit/autopilot/autopilot_mode
int
in enum
The autopilot master mode (off=0, flight director=1, on=2)
sim/cockpit/autopilot/autopilot_state
int
in flags
Various autopilot engage modes, etc. See docs for flags
sim/cockpit/autopilot/backcourse_on
int
as a boolean
Back course selection
sim/cockpit/autopilot/current_altitude
float
in ftmsl
Currently held altitude (remembered until you hit flchg)
sim/cockpit/autopilot/flight_director_pitch
float
in degrees
The recommended pitch from the Flight Director. Use override_flightdir
sim/cockpit/autopilot/flight_director_roll
float
in degrees
The recommended roll from the Flight Director. Use override_flightdir
sim/cockpit/autopilot/heading
float
in degt
The heading to fly (true, legacy)
sim/cockpit/autopilot/heading_mag
float
in degm
The heading to fly (magnetic, preferred) pilot
sim/cockpit/autopilot/heading_mag2
float
in degm
The heading to fly (magnetic, preferred) copilot
sim/cockpit/autopilot/heading_mode
int
in enum
Lateral navigation mode (GPS, heading, L-Nav approach). DEPRECATED
sim/cockpit/autopilot/heading_roll_mode
int
in enum
Bank limit - 0 = auto, 1-6 = 5-30 degrees of bank
sim/cockpit/autopilot/mode_gls
int
in enum
Glide-slope mode (off, armed, engaged). DEPRECATED
sim/cockpit/autopilot/mode_hnav
int
in enum
Localizer mode (off, armed, engaged). DEPRECATED
sim/cockpit/autopilot/nav_steer_deg_mag
float
in degrees
Heading to fly in nav mode - write this when override_nav_heading is set. Useful for making a custom GPS that flies arcs.
sim/cockpit/autopilot/syn_hold_deg
float
in degrees
The pitch held when in pitch-hold mode.
sim/cockpit/autopilot/vertical_velocity
float
in fpm
Vertical speed to hold
sim/cockpit/avidyne/
sim/cockpit/avidyne/alt_hil
int
in unspecified units
sim/cockpit/avidyne/hsi_mode
int
in unspecified units
sim/cockpit/avidyne/lft_hil
int
in unspecified units
sim/cockpit/avidyne/map_range_sel
int
in unspecified units
sim/cockpit/avidyne/rgt_hil
int
in unspecified units
sim/cockpit/avidyne/src[3]
int
in unspecified units
sim/cockpit/electrical/
sim/cockpit/electrical/ah_bar
float
in unspecified units
Cockpit light rheostat - this appears to be legacy and no longer used.
sim/cockpit/electrical/avionics_EQ
int
as a boolean
Does this cockpit have an avionics switch
sim/cockpit/electrical/avionics_on
int
as a boolean
Is there power to the avionics
sim/cockpit/electrical/battery_array_on[8]
int
as a boolean
Is the battery selected on
sim/cockpit/electrical/battery_charge_watt_hr[8]
float
in watt/hours
Current charge of each of the 8 batteries in watt-hours.
sim/cockpit/electrical/battery_EQ
int
as a boolean
Does this cockpit have a battery switch
sim/cockpit/electrical/battery_on
int
as a boolean
Is the main battery on
sim/cockpit/electrical/beacon_lights_on
int
as a boolean
Beacon Light
sim/cockpit/electrical/cockpit_lights
float
as a ratio
Cockpit light level
sim/cockpit/electrical/cockpit_lights_on
int
as a boolean
Are cockpit lights on. (NOTE - previous docs were wrong, this is always read-only)
sim/cockpit/electrical/generator_apu_amps
float
in amps
APU Generator amps
sim/cockpit/electrical/generator_apu_on
int
as a boolean
Is the APU Generator on
sim/cockpit/electrical/generator_EQ
int
as a boolean
Does this cockpit have generator switches? This is not actually writable - writes have no effect
sim/cockpit/electrical/generator_on[8]
int
as a boolean
Is the generator on (to charge batteries) - one for each engine
sim/cockpit/electrical/gpu_amps
float
in amps
GPU Amps
sim/cockpit/electrical/gpu_on
int
as a boolean
Is the GPU on
sim/cockpit/electrical/HUD_brightness
float
as a ratio
HUD brightness level (0-1)
sim/cockpit/electrical/HUD_on
int
as a boolean
Is the HUD on
sim/cockpit/electrical/instrument_brightness
float
as a ratio
Instrument LED lighting level
sim/cockpit/electrical/landing_lights_on
int
as a boolean
Landing Light
sim/cockpit/electrical/nav_lights_on
int
as a boolean
Navigation Light
sim/cockpit/electrical/night_vision_on
int
as a boolean
Night vision goggles on?
sim/cockpit/electrical/strobe_lights_on
int
as a boolean
Strobe Light