# Helicopter Variables The tables below indicate the properties for the [Simulation Variables](../simulation-variables/) that can be used to get and set properties related specifically to **helicopters**. 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) ### Collective {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index| Description | Units |Settable | |---|---|---|---|:---:| | {{< anchor id="COLLECTIVE-POSITION" />}}`COLLECTIVE POSITION` | N/A | The position of the helicopter collective. 0 is fully up, 1 fully depressed. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="VORTEX-RING-STATE-PROTECTION-ASSISTANCE-IMPACT" />}}`VORTEX RING STATE PROTECTION ASSISTANCE IMPACT` | N/A | Indicates how much the current collective lever position has been increased by the vortex ring state protection assistance, compared to the user input. See [Note On Helicopter Vortex Ring Protection Assistance](../../../content-configuration/cfg-files/flight-model/additional-flight-model-information/#note-on-helicopter-vortex-ring-protection-assistance) for more information. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | {{< /table-wrapper >}} ### Rotors {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units | Settable | |---|---|---|---|:---:| | {{< anchor id="DISK-BANK-ANGLE" />}}`DISK BANK ANGLE` | Engine Index | Rotor bank angle of the given rotor index.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor.**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). | Radians | {{< check/bad >}} | | {{< anchor id="DISK-BANK-PCT" />}}`DISK BANK PCT` | Engine Index | Rotor bank percent of the given rotor index.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor.**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 >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="DISK-CONING-PCT" />}}`DISK CONING PCT` | Engine Index | Rotor coning percent of the given rotor index.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor.**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 >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="DISK-PITCH-ANGLE" />}}`DISK PITCH ANGLE` | Engine Index | Rotor pitch angle of the given rotor index.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor.**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). | Radians | {{< check/bad >}} | | {{< anchor id="DISK-PITCH-PCT" />}}`DISK PITCH PCT` | Engine Index | Rotor pitch percent of the given rotor index.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor.**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 >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="HOVER-INDUCED-VELOCITY" />}}`HOVER INDUCED VELOCITY` | N/A | The difference between average rotor inflow and outflow velocity (\(Vi\_0\)) in meters per second. | Meters per second | {{< check/bad >}} | | {{< anchor id="NUMBER-OF-MAIN-ROTORS" />}}`NUMBER OF MAIN ROTORS` | N/A | This will return the number of *main* rotors available for the helicopter. This will be 2 if *neither* `[MAINROTOR]` *nor* `[SECONDARYROTOR]` are flagged as tail rotors, or 1 otherwise. | Integer | {{< check/bad >}} | | {{< anchor id="ROTOR-BRAKE-ACTIVE" />}}`ROTOR BRAKE ACTIVE` | N/A | Whether the rotor brake is active (1, `TRUE`) or not (0, `FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="ROTOR-BRAKE-AVAILABLE" />}}`ROTOR BRAKE AVAILABLE` | N/A | Whether the rotor brake is available (`TRUE`) or not (0, `FALSE`). Will only be `TRUE` if one or both of the `rotor_brake_scalar` and `rotor_brake_torque` parameters are > 0. | Bool | {{< check/bad >}} | | {{< anchor id="ROTOR-BRAKE-HANDLE-POS" />}}`ROTOR BRAKE HANDLE POS` | N/A | The percentage actuated of the rotor brake handle. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ROTOR-CHIP-DETECTED" />}}`ROTOR CHIP DETECTED` | N/A | Whether the rotor chip is detected (1,`TRUE`) or not (0, `FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="ROTOR-CLUTCH-ACTIVE" />}}`ROTOR CLUTCH ACTIVE` | N/A | Whether the rotor clutch is active (1, `TRUE`) or not (0, `FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="ROTOR-CLUTCH-SWITCH-POS" />}}`ROTOR CLUTCH SWITCH POS` | N/A | The rotor clutch switch position, either on (1 `TRUE`) or off (0, `FALSE`). | Bool | {{< check/bad >}} | | {{< anchor id="ROTOR-COLLECTIVE-BLADE-PITCH-PCT" />}}`ROTOR COLLECTIVE BLADE PITCH PCT` | N/A | The rotor collective blade pitch.**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 >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ROTOR-CYCLIC-BLADE-MAX-PITCH-POSITION" />}}`ROTOR CYCLIC BLADE MAX PITCH POSITION` | Engine Index | The position (angle) at which blade has the maximum cyclic pitch.**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). | Degrees | {{< check/bad >}} | | {{< anchor id="ROTOR-CYCLIC-BLADE-PITCH-PCT" />}}`ROTOR CYCLIC BLADE PITCH PCT` | N/A | The rotor cyclic blade (maximum) pitch.**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 >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ROTOR-GOV-ACTIVE" />}}`ROTOR GOV ACTIVE` | Engine Index | Whether the rotor governor is active (1, `TRUE`) or not (0, `FALSE`).The SimVar takes an index value, which is the index of the engine to target. Note that an index of 0 will target the first engine (for backwards compatibility since this SimVar was changed to take an index). | Bool | {{< check/bad >}} | | {{< anchor id="ROTOR-GOV-TARGET-PCT" />}}`ROTOR GOV TARGET PCT` | Engine Index | Gets or sets the target {{< glossterm >}}rpm{{< /glossterm >}} as a ratio of nominal RPM for the indexed engine governor. For example, if the helicopter has a nominal RPM of 390 and its idle state RPM is 52% of this value, then setting the target value here to 0.52 will make the governor target the proper 200 RPM when idle.The SimVar takes an index value, which is the index of the engine to target. Note that an index of 0 will target the first engine (for backwards compatibility since this SimVar was changed to take an index). | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/good >}} | | {{< anchor id="ROTOR-GOV-ENGINE-TRIM" />}}`ROTOR GOV ENGINE TRIM` | Engine Index | Retrieves the trim offset percentage for the governor target RPM of the indexed engine.The SimVar takes an index value, which is the index of the engine to target. Note that an index of 0 will target the first engine (for backwards compatibility since this SimVar was changed to take an index). | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ROTOR-GOV-SWITCH-POS" />}}`ROTOR GOV SWITCH POS` | Engine Index | The rotor governor switch position, either on (1 `TRUE`) or off (0, `FALSE`).The SimVar takes an index value, which is the index of the engine to target. Note that an index of 0 will target the first engine (for backwards compatibility since this SimVar was changed to take an index). | Bool | {{< check/bad >}} | | {{< anchor id="ROTOR-LATERAL-TRIM-PCT" />}}`ROTOR LATERAL TRIM PCT` | N/A | The rotor lateral trim percentage.**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 >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ROTOR-LONGITUDINAL-TRIM-PCT" />}}`ROTOR LONGITUDINAL TRIM PCT` | N/A | The rotor longitudinal trim percentage.**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 >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ROTOR-RADIUS" />}}`ROTOR RADIUS` | Engine Index | The radius of the indexed rotor (either 1 for the main rotor, or 2 for the secondary rotor). | {{< glossterm >}}ft{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ROTOR-ROTATION-ANGLE" />}}`ROTOR ROTATION ANGLE` | Engine Index | Rotor rotation angle of the given rotor index.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor.**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). | Radians | {{< check/bad >}} | | {{< anchor id="ROTOR-RPM" />}}`ROTOR RPM` | Engine Index | The indexed rotor {{< glossterm >}}rpm{{< /glossterm >}}.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor.**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 >}}rpm{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ROTOR-RPM-PCT" />}}`ROTOR RPM PCT` | Engine Index | Percent max rated rpm of the given rotor index.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="ROTOR-TEMPERATURE" />}}`ROTOR TEMPERATURE` | N/A | The main rotor transmission temperature. | {{< glossterm >}}rankine{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="STRUCT-ROTOR-POSITION" />}}`STRUCT ROTOR POSITION` | Engine Index | The position of the indexed rotor.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor. | [`SIMCONNECT_DATA_XYZ`](../../simconnect/api-reference/structures-and-enumerations/simconnect_data_xyz/)feet ({{< glossterm >}}ft{{< /glossterm >}}) | {{< check/bad >}} | | {{< anchor id="TAIL-ROTOR-BLADE-PITCH-PCT" />}}`TAIL ROTOR BLADE PITCH PCT` | N/A | The pitch position of the tailrotor blades. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="TAIL-ROTOR-PEDAL-POSITION" />}}`TAIL ROTOR PEDAL POSITION` | N/A | Percent tail rotor pedal deflection. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | {{< /table-wrapper >}} ### Engine {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units | Settable | |---|---|---|---|:---:| | {{< anchor id="ENG-ROTOR-RPM" />}}`ENG ROTOR RPM` | Engine Index | Returns the indexed rotor {{< glossterm >}}rpm{{< /glossterm >}}.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor.**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). | Percent scalar 16K (Max {{< glossterm >}}rpm{{< /glossterm >}} *16384)* | {{< check/bad >}} | | {{< anchor id="ENG-TORQUE-PERCENT" />}}`ENG TORQUE PERCENT` | Engine Index | Returns the indexed rotor torque.The SimVar takes an index value, which is the index of the rotor to target. Note that an index of 0 will target the first rotor. | Percent scalar 16K ({{< glossterm >}}ft{{< /glossterm >}}/{{< glossterm >}}lbs{{< /glossterm >}} 16384) | {{< check/bad >}} | | {{< anchor id="HELICOPTER-MASTER-THROTTLE-POSITION" />}}`HELICOPTER MASTER THROTTLE POSITION` | N/A | Returns the position of the master throttle as a value between 0 and 1. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | {{< /table-wrapper >}} ### Sling {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units | Settable | |---|---|---|---|:---:| | {{< anchor id="IS-ATTACHED-TO-SLING" />}}`IS ATTACHED TO SLING` | N/A | Set to `TRUE` if this object is attached to a sling. | Bool | {{< check/bad >}} | | {{< anchor id="NUM-SLING-CABLES" />}}`NUM SLING CABLES` | N/A | The number of sling cables (*not* hoists) that are configured for the helicopter. | Number | {{< check/bad >}} | | {{< anchor id="SLING-ACTIVE-PAYLOAD-STATION" />}}`SLING ACTIVE PAYLOAD STATION` | Sling Index | The payload station (identified by the value being set) where objects will be placed from the sling (identified by the index). | Number | {{< check/good >}} | | {{< anchor id="SLING-CABLE-BROKEN" />}}`SLING CABLE BROKEN` | Sling Index | THis will be `TRUE` (1) if the indexed cable is broken, or `FALSE` (0) otherwise. | Bool | {{< check/bad >}} | | {{< anchor id="SLING-CABLE-EXTENDED-LENGTH" />}}`SLING CABLE EXTENDED LENGTH` | Sling Index | The length of the indexed sling cable extending from the aircraft. | Feet ({{< glossterm >}}ft{{< /glossterm >}}) | {{< check/good >}} | | {{< anchor id="SLING-HOIST-PERCENT-DEPLOYED" />}}`SLING HOIST PERCENT DEPLOYED` | Sling Index | The percentage of the full length of the indexed sling cable deployed. | {{< glossterm >}}percent_over_100{{< /glossterm >}} | {{< check/bad >}} | | {{< anchor id="SLING-HOIST-SWITCH" />}}`SLING HOIST SWITCH` | Sling Index | This will be `TRUE` (1) if the indexed sling hoist is enabled or `FALSE` (0) otherwise. | Bool | {{< check/good >}} | | {{< anchor id="SLING-HOOK-IN-PICKUP-MODE" />}}`SLING HOOK IN PICKUP MODE` | N/A | This will be `TRUE` (1) if the hook is in pickup mode or `FALSE` (0) otherwise. When `TRUE`, the hook will be capable of picking up another object. | Bool | {{< check/bad >}} | | {{< anchor id="SLING-OBJECT-ATTACHED" />}}`SLING OBJECT ATTACHED` | N/A | If the SimVar units are set as boolean, this will return `TRUE` (1) if a sling object is attached, or `FALSE` (0) otherwise.If the SimVar units are set as a string, this will return the container title of the object.Note that there can be multiple sling positions, indexed from 1. The sling positions are set in the Aircraft Configuration File. | Bool/String | {{< check/bad >}} | {{< /table-wrapper >}} ### Eng {{< table-wrapper "colclass-2=font-size:0.75rem" "200px" "100px" "" "150px" "100px" >}} | Simulation Variable | Index | Description | Units |Settable | |---|---|---|---|:---:| | {{< anchor id="ENG-ELECTRICAL-LOAD" />}}`ENG ELECTRICAL LOAD` | Engine Index | The electrical load on the indexed engine. | Percent scalar 16K (Max load \* 16384) | {{< check/bad >}} | | {{< anchor id="ENG-FUEL-PRESSURE" />}}`ENG FUEL PRESSURE` | Engine Index | The fuel pressure for the indexed engine. | PSI scalar 16K ({{< glossterm >}}psi{{< /glossterm >}} \* 16384) | {{< check/bad >}} | | {{< anchor id="ENG-TRANSMISSION-PRESSURE" />}}`ENG TRANSMISSION PRESSURE` | Engine Index | The transmission pressure of the indexed engine. | PSI scalar 16K ({{< glossterm >}}psi{{< /glossterm >}} \* 16384) | {{< check/bad >}} | | {{< anchor id="ENG-TRANSMISSION-TEMPERATURE" />}}`ENG TRANSMISSION TEMPERATURE` | Engine Index | The transmission temperature of the indexed engine. | Celsius scalar 16K (Degrees \* 16384) | {{< check/bad >}} | | {{< anchor id="ENG-TURBINE-TEMPERATURE" />}}`ENG TURBINE TEMPERATURE` | Engine Index | The tubine temperature for the indexed engine.| Celsius scalar 16K (degrees \* 16384) | {{< check/bad >}} | {{< /table-wrapper >}}