# Aircraft Miscellaneous Variables The tables below indicate the properties for the [Simulation Variables](../../simulation-variables/) that can be used to get and set properties various miscellaneous properties related to the aircraft. For information on the units listed for each variable, please see here: [Simulation Variable Units](../../simulation-variable-units/) You can find a complete index of all available SimVars here: [SimVar Index](../../simulation-variables/#simvar-index) ### Aircraft States {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units | Settable | |---|---|---|---|:---:| | {{< anchor id="CONTRAILS-CONDITIONS-MET" />}}`CONTRAILS CONDITIONS MET` | N/A | `TRUE` if the aircraft has met the conditions required to spawn the contrail VFX. | Bool | {{< check/bad >}} | | {{< anchor id="COVER-GENERIC-ON" />}}`COVER GENERIC ON` | Cover Index | Whether the indexed aircraft part has the covers on (1, `TRUE`) or off (0, `FALSE`). Generic covers are indexed from 1, however you can use 0 for the index to get/set *all* generic covers if required. For more information, please see here: [Preflight](../../../../content-configuration/careers/general-career-information/preflight/) | Bool | {{< check/good >}} | | {{< anchor id="COVER-ON" />}}`COVER ON` | Cover ID | Whether the given aircraft part has the covers on (1, `TRUE`) or off (0, `FALSE`). The index can be one of the following to define the part being checked:{{< params/smallfont >}}0 - Chocks1 - Engines2 - Pitot3 - StaticPorts4 - Rotors5 - LandingGear6 - Propellers7 - Windshield{{< /params/smallfont >}}For more information, please see here: [Preflight](../../../../content-configuration/careers/general-career-information/preflight/) | Bool | {{< check/good >}} | | {{< anchor id="IS-SLEW-ACTIVE" />}}`IS SLEW ACTIVE` | N/A | `TRUE` if slew is active. | Bool | {{< check/good >}} | | {{< anchor id="IS-SLEW-ALLOWED" />}}`IS SLEW ALLOWED` | N/A | `TRUE` if slew is enabled. | Bool | {{< check/good >}} | | {{< anchor id="IS-USER-SIM" />}}`IS USER SIM` | N/A | Is this the user loaded aircraft. | Bool | {{< check/bad >}} | | {{< anchor id="ON-ANY-RUNWAY" />}}`ON ANY RUNWAY` | N/A | Whether or not the plane is currently on a runway. | Bool | {{< check/bad >}} | | {{< anchor id="PLANE-IN-PARKING-STATE" />}}`PLANE IN PARKING STATE` | N/A | Whether or not the plane is currently parked (`TRUE`) or not (`FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="SURFACE-CONDITION" />}}`SURFACE CONDITION` | N/A | The state of the surface directly under the aircraft.**NOTE**: This SimVar will always be calculated from the user aircraft position, regardless of where the camera is, or what aircraft is selected. | Enum:{{< params/smallfont >}}0 = Normal1 = Wet2 = Icy3 = Snow{{< /params/smallfont >}} | {{< check/bad >}} | | {{< anchor id="SURFACE-INFO-VALID" />}}`SURFACE INFO VALID` | N/A | `TRUE` indicates that the `SURFACE CONDITION` return value is meaningful. | Bool | {{< check/bad >}} | | {{< anchor id="SURFACE-TYPE" />}}`SURFACE TYPE` | N/A | The type of surface under the aircraft.**NOTE**: This SimVar will always be calculated from the user aircraft position, regardless of where the camera is, or what aircraft is selected. | Enum:{{< params/smallfont >}}0 = Concrete1 = Grass2 = Water3 = Grass_bumpy4 = Asphalt5 = Short_grass6 = Long_grass7 = Hard_turf8 = Snow9 = Ice10 = Urban11 = Forest12 = Dirt13 = Coral14 = Gravel15 = Oil_treated16 = Steel_mats17 = Bituminus18 = Brick19 = Macadam20 = Planks21 = Sand22 = Shale23 = Tarmac24 = Wright flyer track{{< /params/smallfont >}} | {{< check/bad >}} | | {{< anchor id="STRUCTURAL-ICE-PCT" />}}`STRUCTURAL ICE PCT` | N/A | Amount of ice on aircraft structure. 100 is fully iced. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="TITLE" />}}`TITLE` | N/A | Title from [aircraft.cfg](../../../../content-configuration/cfg-files/aircraft.cfg/). | String{{< params/smallfont >}}(max 128 chars){{< /params/smallfont >}} | {{< check/bad >}} | | {{< anchor id="LIVERY-NAME" />}}`LIVERY NAME` | N/A | Name from [livery.cfg](../../../../content-configuration/cfg-files/livery.cfg/). | String{{< params/smallfont >}}(max 128 chars){{< /params/smallfont >}} | {{< check/bad >}} | | {{< anchor id="LIVERY-FOLDER" />}}`LIVERY FOLDER` | N/A | Folder where [livery.cfg](../../../../content-configuration/cfg-files/livery.cfg/) is stored. | String{{< params/smallfont >}}(max 128 chars){{< /params/smallfont >}} | {{< check/bad >}} | | {{< anchor id="WINDSHIELD-RAIN-EFFECT-AVAILABLE" />}}`WINDSHIELD RAIN EFFECT AVAILABLE` | N/A | Is visual effect available on this aircraft. | Bool | {{< check/bad >}} | {{< /table-wrapper >}} ### Aircraft Position, Direction And Speed {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units | Settable | |---|---|---|---|:---:| | {{< anchor id="ACCELERATION-BODY-X" />}}`ACCELERATION BODY X` | N/A | Acceleration relative to aircraft X axis, in east/west direction. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second squared | {{< check/bad >}} | | {{< anchor id="ACCELERATION-BODY-Y" />}}`ACCELERATION BODY Y` | N/A | Acceleration relative to aircraft Y axis, in vertical direction. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second squared | {{< check/bad >}} | | {{< anchor id="ACCELERATION-BODY-Z" />}}`ACCELERATION BODY Z` | N/A | Acceleration relative to aircraft Z axis, in north/south direction. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second squared | {{< check/bad >}} | | {{< anchor id="ACCELERATION-WORLD-X" />}}`ACCELERATION WORLD X` | N/A | Acceleration relative to the earth X axis, in east/west direction. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second squared | {{< check/bad >}} | | {{< anchor id="ACCELERATION-WORLD-Y" />}}`ACCELERATION WORLD Y` | N/A | Acceleration relative to the earth Y axis, in vertical direction. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second squared | {{< check/bad >}} | | {{< anchor id="ACCELERATION-WORLD-Z" />}}`ACCELERATION WORLD Z` | N/A | Acceleration relative to the earth Z axis, in north/south direction. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second squared | {{< check/bad >}} | | {{< anchor id="AIRCRAFT-AGL" />}}`AIRCRAFT AGL` | N/A | The altitude of the aircraft above the surface of the world terrain. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) | {{< check/bad >}} | | {{< anchor id="AIRCRAFT-ALTITUDE-ABOVE-OBSTACLES" />}}`AIRCRAFT ALTITUDE ABOVE OBSTACLES` | N/A | The altitude of the aircraft above the surface of the world terrain, including any obstacles like buildings. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) | {{< check/bad >}} | | {{< anchor id="SURFACE-RELATIVE-GROUND-SPEED" />}}`SURFACE RELATIVE GROUND SPEED` | N/A | The speed of the aircraft relative to the speed of the first surface directly underneath it. Use this to 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`](#GROUND-VELOCITY) if the first surface beneath it is not moving. | Feet per second | {{< check/bad >}} | | {{< anchor id="GROUND-VELOCITY" />}}`GROUND VELOCITY` | N/A | Speed relative to the earths surface.**NOTE**: This is available in multiplayer to all **far** aircraft. See here for more information: [Note On SimVars In Multiplayer](../../simulation-variables/#note-on-simvars-in-multiplayer). | {{< glossterm >}}knot{{< /glossterm >}}s | {{< check/bad >}} | | {{< anchor id="PLANE-ALTITUDE" />}}`PLANE ALTITUDE` | N/A | Altitude of aircraft. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) | {{< check/good >}} | | {{< anchor id="PLANE-ALT-ABOVE-GROUND" />}}`PLANE ALT ABOVE GROUND` | N/A | Altitude above the surface of the world, *including obstacles like buildings*. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) | {{< check/good >}} | | {{< anchor id="PLANE-ALT-ABOVE-GROUND-MINUS-CG" />}}`PLANE ALT ABOVE GROUND MINUS CG` | N/A | Altitude above the surface, *including obstacles like buildings*, minus CG. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) | {{< check/bad >}} | | {{< anchor id="PLANE-BANK-DEGREES" />}}`PLANE BANK DEGREES` | N/A | Bank angle, although the name mentions degrees the units used are radians. | Radians | {{< check/good >}} | | {{< anchor id="PLANE-HEADING-DEGREES-GYRO" />}}`PLANE HEADING DEGREES GYRO` | N/A | Heading indicator taken from the aircraft gyro. | Degrees | {{< check/good >}} | | {{< anchor id="PLANE-HEADING-DEGREES-MAGNETIC" />}}`PLANE HEADING DEGREES MAGNETIC` | N/A | Heading relative to magnetic north - although the name mentions degrees the units used are radians. | Radians | {{< check/good >}} | | {{< anchor id="PLANE-HEADING-DEGREES-TRUE" />}}`PLANE HEADING DEGREES TRUE` | N/A | Heading relative to true north - although the name mentions degrees the units used are radians. | Radians | {{< check/good >}} | | {{< anchor id="PLANE-LATITUDE" />}}`PLANE LATITUDE` | N/A | Latitude of aircraft, North is positive, South negative. | Radians | {{< check/good >}} | | {{< anchor id="PLANE-LONGITUDE" />}}`PLANE LONGITUDE` | N/A | Longitude of aircraft, East is positive, West negative. | Radians | {{< check/good >}} | | {{< anchor id="PLANE-PITCH-DEGREES" />}}`PLANE PITCH DEGREES` | N/A | Pitch angle, although the name mentions degrees the units used are radians. | Radians | {{< check/good >}} | | {{< anchor id="PLANE-TOUCHDOWN-BANK-DEGREES" />}}`PLANE TOUCHDOWN BANK DEGREES` | N/A | This float represents the bank of the player's plane from the last touchdown. | Degrees | {{< check/bad >}} | | {{< anchor id="PLANE-TOUCHDOWN-HEADING-DEGREES-MAGNETIC" />}}`PLANE TOUCHDOWN HEADING DEGREES MAGNETIC` | N/A | This float represents the magnetic heading of the player's plane from the last touchdown. | Degrees | {{< check/bad >}} | | {{< anchor id="PLANE-TOUCHDOWN-HEADING-DEGREES-TRUE" />}}`PLANE TOUCHDOWN HEADING DEGREES TRUE` | N/A | This float represents the true heading of the player's plane from the last touchdown. | Degrees | {{< check/bad >}} | | {{< anchor id="PLANE-TOUCHDOWN-LATITUDE" />}}`PLANE TOUCHDOWN LATITUDE` | N/A | This float represents the plane latitude for the last touchdown. | Radians | {{< check/bad >}} | | {{< anchor id="PLANE-TOUCHDOWN-LONGITUDE" />}}`PLANE TOUCHDOWN LONGITUDE` | N/A | This float represents the plane longitude for the last touchdown. | Radians | {{< check/bad >}} | | {{< anchor id="PLANE-TOUCHDOWN-NORMAL-VELOCITY" />}}`PLANE TOUCHDOWN NORMAL VELOCITY` | N/A | This float represents the player's plane speed according to ground normal from the last touchdown. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second | {{< check/bad >}} | | {{< anchor id="PLANE-TOUCHDOWN-PITCH-DEGREES" />}}`PLANE TOUCHDOWN PITCH DEGREES` | N/A | This float represents the pitch of the player's plane from the last touchdown. | Degrees | {{< check/bad >}} | | {{< anchor id="RELATIVE-WIND-VELOCITY-BODY-X" />}}`RELATIVE WIND VELOCITY BODY X` | N/A | Lateral (X axis) speed relative to wind. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second | {{< check/bad >}} | | {{< anchor id="RELATIVE-WIND-VELOCITY-BODY-Y" />}}`RELATIVE WIND VELOCITY BODY Y` | N/A | Vertical (Y axis) speed relative to wind. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second | {{< check/bad >}} | | {{< anchor id="RELATIVE-WIND-VELOCITY-BODY-Z" />}}`RELATIVE WIND VELOCITY BODY Z` | N/A | Longitudinal (Z axis) speed relative to wind. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second | {{< check/bad >}} | | {{< anchor id="ROTATION-ACCELERATION-BODY-X" />}}`ROTATION ACCELERATION BODY X` | N/A | Rotation acceleration relative to aircraft X axis. | Radians per second squared | {{< check/good >}} | | {{< anchor id="ROTATION-ACCELERATION-BODY-Y" />}}`ROTATION ACCELERATION BODY Y` | N/A | Rotation acceleration relative to aircraft Y axis. | Radians per second squared | {{< check/good >}} | | {{< anchor id="ROTATION-ACCELERATION-BODY-Z" />}}`ROTATION ACCELERATION BODY Z` | N/A | Rotation acceleration relative to aircraft Z axis. | Radians per second squared | {{< check/good >}} | | {{< anchor id="ROTATION-VELOCITY-BODY-X" />}}`ROTATION VELOCITY BODY X` | N/A | Rotation velocity relative to aircraft X axis. | Radians per second | {{< check/good >}} | | {{< anchor id="ROTATION-VELOCITY-BODY-Y" />}}`ROTATION VELOCITY BODY Y` | N/A | Rotation velocity relative to aircraft Y axis. | Radians per second | {{< check/good >}} | | {{< anchor id="ROTATION-VELOCITY-BODY-Z" />}}`ROTATION VELOCITY BODY Z` | N/A | Rotation velocity relative to aircraft Z axis. | Radians per second | {{< check/good >}} | | {{< anchor id="SLOPE-TO-ATC-RUNWAY" />}}`SLOPE TO ATC RUNWAY` | N/A | The slope between the plane and the expected landing position of the runway. Returns 0 if no runway is assigned. | Radians | {{< check/bad >}} | | {{< anchor id="VELOCITY-BODY-X" />}}`VELOCITY BODY X` | N/A | True lateral speed, relative to aircraft X axis. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second | {{< check/good >}} | | {{< anchor id="VELOCITY-BODY-Y" />}}`VELOCITY BODY Y` | N/A | True vertical speed, relative to aircraft Y axis. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second | {{< check/good >}} | | {{< anchor id="VELOCITY-BODY-Z" />}}`VELOCITY BODY Z` | N/A | True longitudinal speed, relative to aircraft Z axis. Note that this is {{< glossterm >}}tas{{< /glossterm >}} not {{< glossterm >}}ias{{< /glossterm >}}, so altitude will influence the value. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second | {{< check/good >}} | | {{< anchor id="VERTICAL-SPEED" />}}`VERTICAL SPEED` | N/A | The current indicated vertical speed for the aircraft. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) per second | {{< check/good >}} | {{< /table-wrapper >}} ### Aircraft Warnings {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units |Settable | |---|---|---|---|:---:| | {{< anchor id="WARNING-FUEL" />}}`WARNING FUEL` | N/A | This is the current state of the fuel warning, either on (`TRUE`) or off (`FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="WARNING-FUEL-LEFT" />}}`WARNING FUEL LEFT` | N/A | This is the current state of the left fuel tank warning, either on (`TRUE`) or off (`FALSE`).| Bool | {{< check/bad >}} | | {{< anchor id="WARNING-FUEL-RIGHT" />}}`WARNING FUEL RIGHT` | N/A | This is the current state of the right fuel tank warning, either on (`TRUE`) or off (`FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="WARNING-LOW-HEIGHT" />}}`WARNING LOW HEIGHT` | N/A | This is the current state of the low height warning, either on (`TRUE`) or off (`FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="WARNING-OIL-PRESSURE" />}}`WARNING OIL PRESSURE` | N/A | This is the current state of the oil pressure warning, either on (`TRUE`) or off (`FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="WARNING-VACUUM" />}}`WARNING VACUUM` | N/A | This is the current state of the vacuum system warning, either on (`TRUE`) or off (`FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="WARNING-VACUUM-LEFT" />}}`WARNING VACUUM LEFT` | N/A | This is the current state of the left vacuum system warning, either on (`TRUE`) or off (`FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="WARNING-VACUUM-RIGHT" />}}`WARNING VACUUM RIGHT` | N/A | This is the current state of the right vacuum system warning, either on (`TRUE`) or off (`FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="WARNING-VOLTAGE" />}}`WARNING VOLTAGE` | N/A | This is the current state of the electrical system voltage warning, either on (`TRUE`) or off (`FALSE`). | Bool | {{< check/bad >}} | {{< /table-wrapper >}} ### Aircraft Wear And Tear States The SimVars listed here are all related to the . Most of the SimVars in this section require an *ID* value or name, as well as an (optional in some cases) *index* value. For example, if you are targeting the first piston engine of a two engine aircraft, then you could access it using the following formats: ``` xml 1 (A:1:WEAR AND TEAR LEVEL:'PISTON_ENGINE'_n, percent) 1 (A:1:WEAR AND TEAR LEVEL:39, percent) ``` In both cases the wear and tear level check is being done on the 1st piston engine. {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units | Settable | |---|---|---|---|:---:| | {{< anchor id="WEAR-AND-TEAR-CHECK-PROGRESSION" />}}`WEAR AND TEAR CHECK PROGRESSION` | [0] Component ID[1] Optional Component Index | This SimVar is *only* valid during the **pre-flight inspection phase** of a flight, it is used to get (or set) the timer used for the inspection interaction (the circular progress bar) with a particular component. The component is identified by the given component ID/name and index.See the [Wear And Tear Component IDs](#wear-and-tear-component-ids) section for a full list of component names/IDs. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/good >}} | | {{< anchor id="WEAR-AND-TEAR-EXPOSED-PARTS-LEVEL" />}}`WEAR AND TEAR EXPOSED PARTS LEVEL` | N/A | This SimVar returns the ***average*** wear and tear level of the exposed parts of the aircraft. The SimVar does not take any ID or index, as it is based on an internal calculation which takes data from multiple different sources, like the control surfaces, engines, etc... The SimVar returns a value between 0 and 1 where a 1 means that the aircraft is fully functional and undamaged, and a value of 0 means that the aircraft is seriously damaged and potentially unflyable. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="WEAR-AND-TEAR-EXPOSED-PARTS-LOWEST-LEVEL" />}}`WEAR AND TEAR EXPOSED PARTS LOWEST LEVEL` | N/A | This SimVar returns the ***lowest*** wear and tear level of the exposed parts of the aircraft. The SimVar does not take any ID or index, as it is based on an internal calculation which takes data from multiple different sources, like the control surfaces, engines, etc... The SimVar returns a value between 0 and 1 where a 1 means that the aircraft is fully functional and undamaged, and a value of 0 means that the aircraft is seriously damaged and potentially unflyable. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="WEAR-AND-TEAR-IS-FAILED" />}}`WEAR AND TEAR IS FAILED` | [0] Component ID[1] Optional Component Index | This SimVar will return `TRUE` (1) if the given component ID/name has failed completely, ie: it's "health" has fallen to zero and the component is considered by the simulation as "broken". If the component is still functioning, regardless of how "weak" it may be, then this will return `FALSE` (1).See the [Wear And Tear Component IDs](#wear-and-tear-component-ids) section for a full list of component names/IDs. | Bool | {{< check/bad >}} | | {{< anchor id="WEAR-AND-TEAR-IS-WEAK" />}}`WEAR AND TEAR IS WEAK` | [0] Component ID[1] Optional Component Index | This SimVar will return `TRUE` (1) if the given component ID/name is considered as being "weak", ie: it's "health" has fallen to a point where it could fail or break, and the compònent may have reduced functionality. If the component is not considered as "weak" (even if its wear and tear value is less than 1), then this will return `FALSE` (1).See the [Wear And Tear Component IDs](#wear-and-tear-component-ids) section for a full list of component names/IDs. | Bool | {{< check/bad >}} | | {{< anchor id="WEAR-AND-TEAR-LEVEL" />}}`WEAR AND TEAR LEVEL` | [0] Component ID[1] Optional Component Index | This SimVar returns the current wear and tear level of the component or system being referenced, where a value of 1 is a fully functional and undamaged component, and a value of 0 means that the component has failed. The SimVar requires an ID value or name, and may also use an additional index value to tell the simulation exactly which one of the components of the given type you are targeting.See the [Wear And Tear Component IDs](#wear-and-tear-component-ids) section for a full list of component names/IDs. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="WEAR-AND-TEAR-WEAK-VALUE" />}}`WEAR AND TEAR WEAK VALUE` | [0] Component ID[1] Optional Component Index | This SimVar returns the current "weakness" level of the component or system being referenced, where a value of 1 is a fully functional (but not necessarily undamaged) component, and a value of 0 means that the component has failed. If this value is less than 1, then the component will experience reduced functionality and may also be more prone to failure and breaking.The SimVar requires an ID value or name, and may also use an additional index value to tell the simulation exactly which one of the components of the given type you are targeting. See the [Wear And Tear Component IDs](#wear-and-tear-component-ids) section for a full list of component names/IDs. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | {{< /table-wrapper >}} #### Wear And Tear Component IDs Below is the list of **components IDs** that can be used in the Wear And Tear SimVars as the ID or name of the component to check. {{< params/columns columns="3" >}} 0: FUEL TANK 1: FUEL PUMP 2: FUEL VALVE 3: FUEL JUNCTION 4: FUEL LINE 5: FLAPS LEFT 6: FLAPS RIGHT 7: FLAPS LEFT CABLE 8: FLAPS RIGHT CABLE 9: AILERONS LEFT 10: AILERONS RIGHT 11: AILERONS LEFT CABLE 12: AILERONS RIGHT CABLE 13: ELEVATOR 14: ELEVATOR CABLE 19: RUDDER 20: RUDDER CABLE 21: HYDRAULIC RESERVOIR 22: HYDRAULIC PUMP 23: HYDRAULIC VALVE 24: HYDRAULIC ACTUATOR 25: HYDRAULIC PTU 26: HYDRAULIC ACCUMULATOR 27: HYDRAULIC LINE 28: ELECTRICAL ALTERNATOR 29: ELECTRICAL BATTERY 30: ELECTRICAL IDG 31: ELECTRICAL RAT 32: ELECTRICAL BUS 33: ELECTRICAL CIRCUIT 34: ELECTRICAL RECTIFIERS 35: LANDING_GEAR 36: BRAKE 37: TIRE 38: TIRE_PRESSURE 39: PISTON ENGINE 40: TURBINE_ENGINE 41: OIL_TANK_INTEGRITY 42: OIL_TANK_AMOUNT 43: AUTOPILOT_BANK 44: AUTOPILOT_PITCH 45: AUTOPILOT_YAW 46: GENERAL 47: TAILWHEEL LANDING GEAR 48: TAILWHEEL TIRE 49: TAILWHEEL TIRE PRESSURE {{< /params/columns >}} {{% tagged "internal" %}} #### Failure IDs The table below shows the different possible failure ID's along with a brief description of what the failure represents, as well as any value that could be associated with the failure: {{< table-wrapper "colclass-2=font-size:0.75rem" "150px" "150px" "150px" "" "100px" >}} | Failure ID | Name | Requires Index | Description | Units | |:---:|---|---|---|:---:| | 0 | Fuel Tank Leak | Yes | There is a leak in the indexed fuel tank.The ` ` SimVar value represents the percentage of how much of the fuel leaks out of the tank per second. | Percent | | 1 | Fuel Pump Failed | Yes | Whether the indexed pump has failed or not.***Currently not enabled in the simulation.*** | N/A | | 2 | Fuel Pump Weak | Yes | The indexed fuel pump pressure has been reduced.The ` ` SimVar value represents the factor by how much the pressure is reduced.***Currently not enabled in the simulation.*** | Number | | 3 | Fuel Line Leak | Yes | There is a leak in the indexed fuel line.***Currently not enabled in the simulation.*** | N/A | | 4 | Fuel Valve Stuck | Yes | The indexed valve is stuck.***Currently not enabled in the simulation.*** | N/A | | 5 | Fuel Valve Permeable | Yes | Value represents how open the valve will always be. This will eventually affect the fuel flow.***Currently not enabled in the simulation.*** | {{< glossterm >}}percent_over_100{{< /glossterm >}} | | 6 | Hydraulics Tank Leak | Yes | The indexed hydraulics tank has a leak. | N/A | | 7 | Hydraulics Pump Failed | Yes | Whether the indexed pump has failed or not. | N/A | | 8 | Hydraulics Pump Weak | Yes | The indexed hydraulic pump has been weakened due to a leak.The ` ` SimVar value represents the percentage of how much available hydraulic fluid gets leaked by the pump (this also affects the hydraulic pressure in if no accumulators are present). | Percent | | 9 | Hydraulics Line Leak | Yes | The indexed hydraulics line has a leak.***Currently not enabled in the simulation.*** | N/A | | 10 | Hydraulics PTU Failed | Yes | Whether the indexed PTU has failed or not.***Currently not enabled in the simulation.*** | N/A | | 11 | Hydraulics PTU Weak | - | ***Currently not implemented in the simulation.*** | - | | 12 | Hydraulics Valve Stuck | Yes | The indexed valve is stuck.***Currently not enabled in the simulation.*** | N/A | | 13 | Hydraulics Valve Permeable | - | ***Currently not implemented in the simulation.*** | - | | 14 | Hydraulics Accumulator Leak | Yes | The indexed hydraulic accumulator has a leak.The ` ` SimVar value represents the Factor on how much the volume of liquid leaks (which is affected by pressure differential).***Currently not enabled in the simulation.*** | Number | | 15 | Hydraulics Actuator Failed | Yes | Whether the actuator has failed or not.***Currently not enabled in the simulation.*** | N/A | | 16 | Flaps Left Stuck | Yes | Whether the indexed left flap is stuck in place or not. | N/A | | 17 | Flaps Right Stuck | Yes | Whether the indexed right flap is stuck in place or not. | N/A | | 18 | Flaps Left Hard Over | Yes | The indexed left flap is currently experiencing movement issues and is hard to move.The ` ` SimVar value represents the factor of "stiffness" which is affecting the flap. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | | 19 | Flaps Right Hard Over | Yes | The indexed right flap is currently experiencing movement issues and is hard to move.The ` ` SimVar value represents the factor of "stiffness" which is affecting the flap. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | | 20 | Flaps Left Free | Yes | Whether the indexed left flap surface is "free" and controlled only by the movement of the plane. | N/A | | 21 | Flaps Right Free | Yes | Whether the indexed right flap surface is "free" and controlled only by the movement of the plane. | N/A | | 22 | Ailerons Left Stuck | No | Whether the left aileron surface is stuck in place or not. | N/A | | 23 | Ailerons Right Stuck | No | Whether the right aileron surface is stuck in place or not. | N/A | | 24 | Ailerons Left Hard Over | No | The left aileron is currently experiencing movement issues and is hard to move.The ` ` SimVar value represents the factor of "stiffness" which is affecting the left aileron. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | | 25 | Ailerons Right Hard Over | No | The right aileron is currently experiencing movement issues and is hard to move.The ` ` SimVar value represents the factor of "stiffness" which is affecting the right aileron. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | | 26 | Ailerons Left Free | No | Whether the left aileron surface is "free" and controlled only by the movement of the plane. | N/A | | 27 | Ailerons Right Free | No | Whether the right aileron surface is "free" and controlled only by the movement of the plane. | N/A | | 28 | Elevator Stuck | No | Whether the elevator surface is stuck in place or not. | N/A | | 29 | Elevator Hard Over | No | The elevator is currently experiencing movement issues and is hard to move.The ` ` SimVar value represents the factor of "stiffness" which is affecting the elevator. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | | 30 | Elevator Free | No | Whether the elevator surface is "free" and controlled only by the movement of the plane. | N/A | | 31 | Rudder Stuck | No | Whether the rudder surface is stuck in place or not. | N/A | | 32 | Rudder Hard Over | No | The rudder is currently experiencing movement issues and is hard to move.The ` ` SimVar value represents the factor of "stiffness" which is affecting the rudder. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | | 33 | Rudder Free | No | Whether the rudder surface is "free" and controlled only by the movement of the plane. | N/A | | 34 | Battery Failed | Yes | Whether the indexed battery has failed or not. If it has failed it will be unable to provide any power. | N/A | | 35 | Battery Weak | | | | | 36 | Electrical Bus Failed | Yes | Whether the indexed bus has failed or not. A failed bus cannot transmit power.***Currently not enabled in the simulation.*** | N/A | | 37 | Electrical Circuit Failed | Yes | Whether the indexed circuit has failed or not. A failed circuit will no longer provide power to the corresponding system component. | N/A | | 38 | Alternator Failed | Yes | Whether the indexed alternator has failed or not. If it has failed it will no longer provide any power. | N/A | | 39 | Alternator Weak | Yes | | | | 40 | Landing Gear Collapse | Yes | Whether the indexed landing gear has collapsed or not (index is the [Contact Point](../../../../content-configuration/cfg-files/flight_model.cfg/flight_model.cfg/#contact_points) index associated with the gear). | | | 41 | Brake Weak | Yes | | | | 42 | Brake Failed | Yes | Whether the indexed brake has failed or not (index is the [Contact Point](../../../../content-configuration/cfg-files/flight_model.cfg/flight_model.cfg/#contact_points) index associated with the gear that has the brake). | N/A | | 43 | Tire Worn | Yes | | | | 44 | Tire Blown | Yes | Whether the indexed tire has blown or not (index is the [Contact Point](../../../../content-configuration/cfg-files/flight_model.cfg/flight_model.cfg/#contact_points) index associated with the gear that has the wheel). | N/A | | 45 | Tire Low Pressure | Yes | | | | 46 | Piston Engine Weak | Yes | A piston engine has been weakened by damage.The ` ` SimVar value represents the degradation factor of the engine performance. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | | 47 | Piston Engine Failed | Yes | Whether the engine has failed or not. | N/A | | 48 | Turbine Engine Weak | Yes | A piston engine has been weakened by damage.The ` ` SimVar value represents the degradation factor of the engine performance. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | | 49 | Turbine Engine Failed | Yes | Whether the indexed turbine has failed or not. | N/A | | 50 | Oil Tank Leaking | Yes | Whether the indexed engine's oil tank has a leak or not. | N/A | | 51 | Oil Tank Low | Yes | Whether the level of oil contained in the indexed engine's oil tank is too low or not. | N/A | {{< /table-wrapper >}} {{% /tagged %}} ### Aircraft Structs {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units | Settable | |---|---|---|---|:---:| | {{< anchor id="EYEPOINT-POSITION" />}}`EYEPOINT POSITION` | N/A | The eyepoint position relative to the reference datum position for the aircraft. | [Struct `XYZ`](../../simulation-variable-units/#XYZ)feet | {{< check/bad >}} | | {{< anchor id="STRUCT-BODY-ROTATION-VELOCITY" />}}`STRUCT BODY ROTATION VELOCITY` | N/A | The body rotation velocity. | [Struct `XYZ`](../../simulation-variable-units/#XYZ)radians per second | {{< check/bad >}} | | {{< anchor id="STRUCT-BODY-VELOCITY" />}}`STRUCT BODY VELOCITY` | N/A | The object body velocity. | [Struct `XYZ`](../../simulation-variable-units/#XYZ)feet per second | {{< check/bad >}} | | {{< anchor id="STRUCT-EYEPOINT-DYNAMIC-ANGLE" />}}`STRUCT EYEPOINT DYNAMIC ANGLE` | N/A | The angle of the eyepoint view. Zero, zero, zero is straight ahead. | [Struct `XYZ`](../../simulation-variable-units/#XYZ)radians | {{< check/bad >}} | | {{< anchor id="STRUCT-EYEPOINT-DYNAMIC-OFFSET" />}}`STRUCT EYEPOINT DYNAMIC OFFSET` | N/A | A variable offset away from the EYEPOINT POSITION. | [Struct `XYZ`](../../simulation-variable-units/#XYZ)feet | {{< check/bad >}} | | {{< anchor id="STRUCT-LATLONALT" />}}`STRUCT LATLONALT` | N/A | Returns the latitude, longitude and altitude of the user aircraft. | [Struct `latlonalt`](../../simulation-variable-units/#latlonalt) | {{< check/bad >}} | | {{< anchor id="STRUCT-LATLONALTPBH" />}}`STRUCT LATLONALTPBH` | N/A | Returns the latitude, longitude, altitude, pitch, bank and heading of the user aircraft. | [Struct `latlonaltpbh`](../../simulation-variable-units/#latlonaltpbh) | {{< check/bad >}} | {{< /table-wrapper >}} ### Airspeed {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units | Settable | |---|---|---|---|:---:| | {{< anchor id="AIRCRAFT-CATEGORY" />}}`AIRCRAFT CATEGORY` | N/A | Returns the category of the aircraft as defined by the [`ui_typerole`](../../../../content-configuration/cfg-files/aircraft.cfg/#ui_typerole) parameter. | String | {{< check/bad >}} | | {{< anchor id="AIRCRAFT-OBJECT-CLASS" />}}`AIRCRAFT OBJECT CLASS` | N/A | Returns the aircraft class. This will either be a string interpreted from the [`object_class`](../../../../content-configuration/cfg-files/aircraft.cfg/#object_class) parameter, or an inferred value based on the [`AIRCRAFT CATEGORY`](#AIRCRAFT-CATEGORY) if the class parameter is missing. | String:{{< params/smallfont >}}AIRPLANEHELICOPTERGLIDERLIGHTERTHANAIR{{< params/smallfont >}}("Balloon" or "Airship" object_class){{< /params/smallfont >}}OTHER{{< params/smallfont >}}(all other object_class){{< /params/smallfont >}}{{< /params/smallfont >}} | {{< check/bad >}} | | {{< anchor id="AIRCRAFT-WIND-X" />}}`AIRCRAFT WIND X` | N/A | The wind hitting the aircraft on the lateral (X) axis. It should be noted that if the user has rudder assitance options enabled, then the simulation will force this to 0 in takeoff situations. It can also be modified using the [`ground_crosswind_effect_zero_speed`](../../../../content-configuration/cfg-files/flight_model.cfg/#ground_crosswind_effect_zero_speed) and [`ground_crosswind_effect_max_speed`](../../../../content-configuration/cfg-files/flight_model.cfg/#ground_crosswind_effect_max_speed) parameters to ease taxiing and takeoff by design for an aircraft. | {{< glossterm >}}knot{{< /glossterm >}}s | {{< check/bad >}} | | {{< anchor id="AIRCRAFT-WIND-Y" />}}`AIRCRAFT WIND Y` | N/A | The wind hitting the aircraft on the vertical (Y) axis. | {{< glossterm >}}knot{{< /glossterm >}}s | {{< check/bad >}} | | {{< anchor id="AIRCRAFT-WIND-Z" />}}`AIRCRAFT WIND Z` | N/A | The wind hitting the aircraft on the longitudinal (Z) axis. | {{< glossterm >}}knot{{< /glossterm >}}s | {{< check/bad >}} | | {{< anchor id="AIRSPEED-BARBER-POLE" />}}`AIRSPEED BARBER POLE` | N/A | Redline airspeed (dynamic on some aircraft). | {{< glossterm >}}knot{{< /glossterm >}}s | {{< check/bad >}} | | {{< anchor id="AIRSPEED-INDICATED" />}}`AIRSPEED INDICATED` | N/A | Indicated airspeed. | {{< glossterm >}}knot{{< /glossterm >}}s | {{< check/good >}} | | {{< anchor id="AIRSPEED-INDICATED-THEORETICAL" />}}`AIRSPEED INDICATED THEORETICAL` | N/A | The *theoretical* indicated airspeed, ignoring things like the pitot cover and icing. | {{< glossterm >}}knot{{< /glossterm >}}s | {{< check/bad >}} | | {{< anchor id="AIRSPEED-MACH" />}}`AIRSPEED MACH` | N/A | Current mach. | {{< glossterm >}}mach{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="AIRSPEED-SELECT-INDICATED-OR-TRUE" />}}`AIRSPEED SELECT INDICATED OR TRUE` | N/A | The airspeed, whether true or indicated airspeed has been selected. | {{< glossterm >}}knot{{< /glossterm >}}s | {{< check/bad >}} | | {{< anchor id="AIRSPEED-TRUE" />}}`AIRSPEED TRUE` | N/A | True airspeed. | {{< glossterm >}}knot{{< /glossterm >}}s | {{< check/good >}} | | {{< anchor id="AIRSPEED-TRUE-RAW" />}}`AIRSPEED TRUE RAW` | N/A | Equivalent to [`AIRSPEED TRUE`](#AIRSPEED-TRUE), but does not account for wind when used to set the airspeed value | {{< glossterm >}}knot{{< /glossterm >}}s | {{< check/good >}} | | {{< anchor id="BARBER-POLE-MACH" />}}`BARBER POLE MACH` | N/A | Mach associated with maximum airspeed. | {{< glossterm >}}mach{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="TOTAL-VELOCITY" />}}`TOTAL VELOCITY` | N/A | Velocity regardless of direction. For example, if a helicopter is ascending vertically at 100 fps, getting this variable will return 100. | Feet ({{< glossterm >}}ft{{< /glossterm >}} per second | {{< check/bad >}} | | {{< anchor id="WINDSHIELD-WIND-VELOCITY" />}}`WINDSHIELD WIND VELOCITY` | N/A | Longitudinal speed of wind on the "windshield". The testing location is not actually the windshield and is instead based on the [Physics Groups](../../../../content-configuration/cfg-files/flight-model/physics-objects-information/#note-on-physics-groups) setup for the aircraft. | Feet ({{< glossterm >}}ft{{< /glossterm >}} per second | {{< check/bad >}} | {{< /table-wrapper >}} ### Temperature {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index| Description | Units |Settable | |---|---|---|---|:---:| | {{< anchor id="STANDARD-ATM-TEMPERATURE" />}}`STANDARD ATM TEMPERATURE` | N/A | Outside temperature on the standard ATM scale. | {{< glossterm >}}rankine{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="TOTAL-AIR-TEMPERATURE" />}}`TOTAL AIR TEMPERATURE` | N/A | Total air temperature is the air temperature at the front of the aircraft where the ram pressure from the speed of the aircraft is taken into account. | Celsius | {{< check/bad >}} | {{< /table-wrapper >}} ### Ornithopter {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units | Settable | |---|---|---|---|:---:| | {{< anchor id="ORNITHOPTER-CONTROL-LEVERS-X" />}}`ORNITHOPTER CONTROL LEVERS X` | N/A | The deflection control left / right, usually used for animation. | Position 16k | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-CONTROL-LEVERS-Y" />}}`ORNITHOPTER CONTROL LEVERS Y` | N/A | The deflection control fore / aft, usually used for animation. | Position 16k | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-DIVE-MODE-ENABLED" />}}`ORNITHOPTER DIVE MODE ENABLED` | N/A | Returns whether the ornithopter dive mode is enabled (`TRUE`) or not (`FALSE`). | Boolean | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-GLIDE-MODE-ENABLED" />}}`ORNITHOPTER GLIDE MODE ENABLED` | N/A | Returns whether the ornithopter glide mode is enabled (`TRUE`) or not (`FALSE`). | Boolean | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-WINGS-BRAKE-ENABLED" />}}`ORNITHOPTER WINGS BRAKE ENABLED` | N/A | Returns whether the ornithopter wing brake is enabled (`TRUE`) or not (`FALSE`). | Boolean | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-WINGS-BRAKE-ACTIVE" />}}`ORNITHOPTER WINGS BRAKE ACTIVE` | N/A | Returns whether the ornithopter wing brake is active (`TRUE`) or not (`FALSE`). | Boolean | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-WING-HORIZONTAL-TILT" />}}`ORNITHOPTER WING HORIZONTAL TILT` | Wing Index | The horizontal tilt of the indexed wing expressed as a value between 0 and 1. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-WING-PITCH" />}}`ORNITHOPTER WING PITCH` | Wing Index | The pitch of the indexed wing expressed as a value between 0 and 1. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-WING-VERTICAL-TILT" />}}`ORNITHOPTER WING VERTICAL TILT` | Wing Index | The vertical tilt of the indexed wing expressed as a value between 0 and 1. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-WINGS-BLUR" />}}`ORNITHOPTER WINGS BLUR` | N/A | The current amount of blur applied to the animation of the ornithopter wings when flapping, expressed as a value between 0 (none) and 1 (maximum). | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-WINGS-CLUTCH-STATE" />}}`ORNITHOPTER WINGS CLUTCH STATE` | N/A | The current progress of engaging/disengaging the clutch on the wings when entering or leaving glide mode, expressed as a value between 0 and 1. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-WINGS-FOLDING-OPERATION-ID" />}}`ORNITHOPTER WINGS FOLDING OPERATION ID` | N/A | Returns a value that defines the current folding operation of the wings, where:{{< params/smallfont >}}0 - stand by1 - parking (slow mode)2 - setting up (slow mode)3 - folding for diving (fast mode)4 - unfolding from a dive (fast mode){{< /params/smallfont >}} | Number | {{< check/bad >}} | | {{< anchor id="ORNITHOPTER-WORLD-LIFT" />}}`ORNITHOPTER WORLD LIFT` | N/A | Returns the current total lift of the ornithopter. | Pounds ({{< glossterm >}}lbs{{< /glossterm >}}) | {{< check/bad >}} | {{< /table-wrapper >}}