Aircraft Control Variables
The tables below indicate the properties for the Simulation Variables that can be used to get and set properties related to the various aircraft control systems. For information on the units listed for each variable, please see here: Simulation Variable Units
You can find a complete index of all available SimVars here: SimVar Index
Ailerons
| Simulation Variable | Index | Description | Units | Settable |
|---|---|---|---|---|
AILERON AVERAGE DEFLECTION | N/A | Angle deflection for the aileron. | Radians | |
AILERON LEFT DEFLECTION | N/A | Angle deflection of the left aileron. This SimVar will work for AI aircraft, and should be used instead of AILERON POSITION. | Radians | |
AILERON LEFT DEFLECTION PCT | N/A | Percent deflection for the aileron.NOTE: This is available in multiplayer to all near aircraft. See here for more information: Note On SimVars In Multiplayer. | Percent Over 100 | |
AILERON POSITION | N/A | Percent aileron input left/right. Note that this SimVar is exclusively used for the user aircraft. For AI aircraft you should use the AILERON LEFT DEFLECTION and AILERON RIGHT DEFLECTION SimVars. | Position(-16K to 0)-16K = full left | |
AILERON RIGHT DEFLECTION | N/A | Angle deflection of the right aileron. This SimVar will work for AI aircraft, and should be used instead of AILERON POSITION. | Radians | |
AILERON RIGHT DEFLECTION PCT | N/A | Percent deflection.NOTE: This is available in multiplayer to all near aircraft. See here for more information: Note On SimVars In Multiplayer. | Percent Over 100 | |
AILERON TRIM | N/A | Angle deflection. | Radians | |
AILERON TRIM DISABLED | N/A | Whether or not the Aileron Trim has been disabled. | Bool | |
AILERON TRIM MAX | N/A | The maximum angle of deflection of the aileron, set to 0.174533 (10º). | Radians | |
AILERON TRIM MIN | N/A | The minimum angle of deflection of the aileron, set to -0.174533 (-10º). | Radians | |
AILERON TRIM PCT | N/A | Returns the aileron trim position between -1 and 1, where 0 is fully retracted.NOTE: This is available in multiplayer to all near aircraft. See here for more information: Note On SimVars In Multiplayer. | Float | |
AILERON TRIM PCT EX1 | N/A | This returns the trimming ratio between 0 and 1. | Percent Over 100 |
Elevator
| Simulation Variable | Index | Description | Units | Settable |
|---|---|---|---|---|
ELEVATOR DEFLECTION | N/A | Angle deflection. Note that this SimVar can be used for AI aircraft. | Radians | |
ELEVATOR DEFLECTION PCT | N/A | Percent deflection.NOTE: This is available in multiplayer. See here for more information: Note On SimVars In Multiplayer. | Percent Over 100 | |
ELEVATOR POSITION | N/A | Percent elevator input deflection. Note that this SimVar is only for use with user Aircraft. For other aircraft in the simulation, use ELEVATOR DEFLECTION. | Position(-16K to 0)-16K = full down | |
ELEVATOR TRIM DISABLED | N/A | Whether or not the Elevator Trim has been disabled. | Bool | |
ELEVATOR TRIM DOWN LIMIT | N/A | Returns the absolute value of the elevator trim down limit (which corresponds to the +elevator_trim_down_limit in the Flight Model Config file). | Degrees | |
ELEVATOR TRIM INDICATOR | N/A | Percent elevator trim (for indication). | Position(-16K to 0)-16K = full down | |
ELEVATOR TRIM LIMIT RATIO | N/A | Ratio of “up” trim limit and “down” trim limit, calculated as:abs(ELEVATOR_TRIM_UP_LIMIT / ELEVATOR_TRIM_DOWN_LIMIT) | Number | |
ELEVATOR TRIM MAX | N/A | Returns the maximum elevator trim value. This corresponds to the elevator_trim_up_limit in the Flight Model Config file. | Radians | |
ELEVATOR TRIM MIN | N/A | Returns the negative value of the elevator trim down limit (which corresponds to -elevator_trim_down_limit in the Flight Model Config file). | Radians | |
ELEVATOR TRIM NEUTRAL | N/A | Elevator trim neutral. | Radians | |
ELEVATOR TRIM PCT | N/A | Percent elevator trim.Note that this is considered a legacy SimVar and you should be using ELEVATOR TRIM PCT EX1 instead. | Percent Over 100 | |
ELEVATOR TRIM PCT EX1 | N/A | The percentage of elevator trim expressed as a Percent Over 100, where 0 is the down limit, 1 is the up limit, and 0.5 would be the midpoint between the limits (not necessarily an angle of 0). | Percent Over 100 | |
ELEVATOR TRIM POSITION | N/A | Elevator trim deflection. | Radians | |
ELEVATOR TRIM UP LIMIT | N/A | Returns the maximum elevator trim value. This corresponds to the elevator_trim_up_limit in the Flight Model Config file. | Degrees | |
ELEVON DEFLECTION | N/A | Elevon deflection. | Radians |
Flaps
| Simulation Variable | Index | Description | Units | Settable |
|---|---|---|---|---|
FLAPS AVAILABLE | N/A | True if flaps available. | Bool | |
FLAPS CURRENT SPEED LIMITATION | N/A | The maximum allowed speed with the current flaps position.NOTE: This is available in multiplayer to all near aircraft. See here for more information: Note On SimVars In Multiplayer. | Knots | |
FLAP DAMAGE BY SPEED | N/A | True if flaps are damaged by excessive speed. | Bool | |
FLAPS EFFECTIVE HANDLE INDEX | N/A | This returns the effective flaps handle index, after some of the conditions have potentially forced the state to change.NOTE: This is available in multiplayer to all near aircraft. See here for more information: Note On SimVars In Multiplayer. | Number | |
FLAPS HANDLE INDEX | N/A | Index of current flap position.NOTE: This is available in multiplayer to all near aircraft. See here for more information: Note On SimVars In Multiplayer. | Number | |
FLAPS HANDLE PERCENT | N/A | Percent flap handle extended. | Percent Over 100 | |
FLAPS NUM HANDLE POSITIONS | N/A | Number of available flap positions. | Number | |
FLAP POSITION SET | N/A | Set the position of the flaps control.No longer used by the simulation. | Position | |
FLAP SPEED EXCEEDED | N/A | True if safe speed limit for flaps exceeded. | Bool | |
LEADING EDGE FLAPS LEFT ANGLE | N/A | Angle left leading edge flap extended. Use LEADING EDGE FLAPS LEFT PERCENT to set a value. | Radians | |
LEADING EDGE FLAPS LEFT INDEX | N/A | Index of left leading edge flap position. | Number | |
LEADING EDGE FLAPS LEFT PERCENT | N/A | Percent left leading edge flap extended.NOTE: This is available in multiplayer to all near aircraft. See here for more information: Note On SimVars In Multiplayer. | Percent Over 100 | |
LEADING EDGE FLAPS RIGHT ANGLE | N/A | Angle right leading edge flap extended. Use LEADING EDGE FLAPS RIGHT PERCENT to set a value. | Radians | |
LEADING EDGE FLAPS RIGHT INDEX | N/A | Index of right leading edge flap position. | Number | |
LEADING EDGE FLAPS RIGHT PERCENT | N/A | Percent right leading edge flap extended.NOTE: This is available in multiplayer to all near aircraft. See here for more information: Note On SimVars In Multiplayer. | Percent Over 100 | |
NEGATIVE G LIMIT FLAPS DOWN | N/A | Design limit of negative G in a flaps down configuration, as defined by the negative_g_limit_flaps_down parameter. | Gforce | |
NEGATIVE G LIMIT FLAPS UP | N/A | Design limit of negative G in a flaps up configuration, as defined by the negative_g_limit_flaps_up parameter. | Gforce | |
POSITIVE G LIMIT FLAPS DOWN | N/A | Design limit of positive G in a flaps down configuration, as defined by the positive_g_limit_flaps_down parameter. | Gforce | |
POSITIVE G LIMIT FLAPS UP | N/A | Design limit of positive G in a flaps up configuration, as defined by the positive_g_limit_flaps_up parameter. | Gforce | |
TRAILING EDGE FLAPS LEFT ANGLE | N/A | Angle left trailing edge flap extended. Use TRAILING EDGE FLAPS LEFT PERCENT to set a value. | Radians | |
TRAILING EDGE FLAPS LEFT INDEX | N/A | Index of left trailing edge flap position. | Number | |
TRAILING EDGE FLAPS LEFT PERCENT | N/A | Percent left trailing edge flap extended.NOTE: This is available in multiplayer to all near aircraft. See here for more information: Note On SimVars In Multiplayer. | Percent Over 100 | |
TRAILING EDGE FLAPS RIGHT ANGLE | N/A | Angle right trailing edge flap extended. Use TRAILING EDGE FLAPS RIGHT PERCENT to set a value. | Radians | |
TRAILING EDGE FLAPS RIGHT INDEX | N/A | Index of right trailing edge flap position. | Number | |
TRAILING EDGE FLAPS RIGHT PERCENT | N/A | Percent right trailing edge flap extended.NOTE: This is available in multiplayer to all near aircraft. See here for more information: Note On SimVars In Multiplayer. | Percent Over 100 |
Fly By Wire
| Simulation Variable | Index | Description | Units | Settable |
|---|---|---|---|---|
FLY BY WIRE ALPHA PROTECTION | N/A | Returns true if the fly-by-wire alpha protection is enabled or false otherwise. | Bool | |
FLY BY WIRE ELAC FAILED | N/A | True if the Elevators and Ailerons computer has failed. | Bool | |
FLY BY WIRE ELAC SWITCH | N/A | True if the fly by wire Elevators and Ailerons computer is on. | Bool | |
FLY BY WIRE FAC FAILED | N/A | True if the Flight Augmentation computer has failed. | Bool | |
FLY BY WIRE FAC SWITCH | N/A | True if the fly by wire Flight Augmentation computer is on. | Bool | |
FLY BY WIRE SEC FAILED | N/A | True if the Spoilers and Elevators computer has failed. | Bool | |
FLY BY WIRE SEC SWITCH | N/A | True if the fly by wire Spoilers and Elevators computer is on. | Bool |
Folding Wings
| Simulation Variable | Index | Description | Units | Settable |
|---|---|---|---|---|
FOLDING WING HANDLE POSITION | N/A | True if the folding wing handle is engaged. | Bool | |
FOLDING WING LEFT PERCENT | N/A | Left folding wing position, 1.0 is fully folded. | Percent Over 100 | |
FOLDING WING RIGHT PERCENT | N/A | Right folding wing position, 1.0 is fully folded. | Percent Over 100 |
Rudder
| Simulation Variable | Index | Description | Units | Settable |
|---|---|---|---|---|
RUDDER DEFLECTION | N/A | Angle deflection. This SimVar can be used with AI aircraft. | Radians | |
RUDDER DEFLECTION PCT | N/A | Percent deflection.NOTE: This is available in multiplayer. See here for more information: Note On SimVars In Multiplayer. | Percent Over 100 | |
RUDDER PEDAL INDICATOR | N/A | Rudder pedal position. | Position | |
RUDDER PEDAL POSITION | N/A | Percent rudder pedal deflection (for animation). | Position (-16K to 0)-16K = left pedal pushed full in | |
RUDDER POSITION | N/A | Percent rudder input deflection. Note that this SimVar is only for use with user Aircraft. For other aircraft in the simulation, use RUDDER DEFLECTION. | Position (-16K to 0)-16K = full left | |
RUDDER TRIM | N/A | Angle deflection. | Radians | |
RUDDER TRIM MAX | N/A | Returns the positive value of the rudder trim limit (which corresponds to rudder_trim_limit in the Flight Model Config file). | Radians | |
RUDDER TRIM MIN | N/A | Returns the negative value of the rudder trim limit (which corresponds to -rudder_trim_limit in the Flight Model Config file). | Radians | |
RUDDER TRIM DISABLED | N/A | Whether or not the Rudder Trim has been disabled. | Bool | |
RUDDER TRIM PCT | N/A | Returns the trimming position between -1 and 1, where 0 is no trim. | Float | |
RUDDER TRIM PCT EX1 | N/A | This returns the trimming ratio between 0 and 1. | Percent Over 100 |
Spoilers
| Simulation Variable | Index | Description | Units | Settable |
|---|---|---|---|---|
SPOILERS ARMED | N/A | Checks if autospoilers are armed (true) or not (false). | Bool | |
SPOILER AVAILABLE | N/A | True if spoiler system available. | Bool | |
SPOILERS HANDLE POSITION | N/A | Spoiler handle position. | Percent Over 100orPosition(16K = down, 0 = up) | |
SPOILERS LEFT POSITION | N/A | Percent left spoiler deflected.NOTE: This is available in multiplayer. See here for more information: Note On SimVars In Multiplayer. | Percent Over 100orPosition(0 = retracted, 16K fully extended) | |
SPOILERS RIGHT POSITION | N/A | Percent right spoiler deflected.NOTE: This is available in multiplayer. See here for more information: Note On SimVars In Multiplayer. | Percent Over 100orPosition(0 = retracted, 16K fully extended) |
Yoke
| Simulation Variable | Index | Description | Units | Settable |
|---|---|---|---|---|
YOKE X INIDICATOR | N/A | Yoke position in horizontal direction. | Position(-16K to 0) | |
YOKE X POSITION | N/A | Percent control deflection left/right (for animation). | Position(-16K to 0) | |
YOKE X POSITION WITH AP | N/A | Percent control deflection left/right (for animation). Also includes AP’s inputs. | Position(-16K to 0) | |
YOKE Y INIDICATOR | N/A | Yoke position in vertical direction. | Position(-16K to 0) | |
YOKE Y POSITION | N/A | Percent control deflection fore/aft (for animation). | Position(-16K to 0) | |
YOKE Y POSITION WITH AP | N/A | Percent control deflection fore/aft (for animation). Also includes AP’s inputs. | Position(-16K to 0) |
Carrier Operations
| Simulation Variable | Index | Description | Units | Settable |
|---|---|---|---|---|
BLAST SHIELD POSITION:index | N/A | Indexed from 1, 100 is fully deployed, 0 flat on deck | Percent Over 100 | |
CABLE CAUGHT BY TAILHOOK:index | N/A | A number 1 through 4 for the cable number caught by the tailhook. Cable 1 is the one closest to the stern of the carrier. A value of 0 indicates no cable was caught. | Number | |
CATAPULT STROKE POSITION:index | N/A | Catapults are indexed from 1. This value will be 0 before the catapult fires, and then up to 100 as the 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. | Number | |
HOLDBACK BAR INSTALLED | N/A | Holdback bars allow build up of thrust before takeoff from a catapult, and are installed by the deck crew of an aircraft carrier. | Bool | |
LAUNCHBAR HELD EXTENDED | N/A | This will be True if the launchbar is fully extended, and can be used, for example, to change the color of an instrument light. | Bool | |
LAUNCHBAR POSITION | N/A | Installed on aircraft before takeoff from a carrier catapult. Note that gear cannot retract with this extended. 100 = fully extended. | Percent Over 100 | |
LAUNCHBAR SWITCH | N/A | If this is set to True the launch bar switch has been engaged. | Bool | |
NUMBER OF CATAPULTS | N/A | Maximum of 4. A model can contain more than 4 catapults, but only the first four will be read and recognized by the simulation. | Number |
Concorde
| Simulation Variable | Index | Description | Units | Settable |
|---|---|---|---|---|
CONCORDE NOSE ANGLE | N/A | The nose angle, where 0 is fully up. | Radians | |
CONCORDE VISOR NOSE HANDLE | N/A | The visor nose handle position. | Enum:0:[index] visor up, nose down1:[index] visor down, nose up2:[index] visor down, nose 5 degrees3:[index] visor down, nose 12.5 degrees | |
CONCORDE VISOR POSITION PERCENT | N/A | The visor position expressed as a percentage where 0.0 = up and 1.0 = extended/down. | Percent Over 100 |