HELICOPTER VARIABLES
The tables below indicate the properties for the 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
NOTE: When Microsoft Flight Simulator 2024 is running in multiplayer mode, only a small number of variables are communicated between aircraft. Those variables that are available will say so in the description as being either for "All Aircraft" or for "Shared Cockpit".
You can find a complete index of all available SimVars here: SimVar Index
Collective
Simulation Variable | Description | Units | Settable |
---|---|---|---|
COLLECTIVE POSITION |
The position of the helicopter collective. 0 is fully up, 100 fully depressed. | Percent Over 100 |
Rotors
Simulation Variable | Parameters | Description | Units | Settable |
---|---|---|---|---|
DISK BANK ANGLE |
[0] 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. |
Radians | |
DISK BANK PCT |
[0] 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. |
Percent Over 100 | |
DISK CONING PCT |
[0] 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. |
Percent Over 100 | |
DISK PITCH ANGLE |
[0] 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. |
Radians | |
DISK PITCH PCT |
[0] 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. |
Percent Over 100 | |
HOVER INDUCED VELOCITY |
N/A | The difference between average rotor inflow and outflow velocity (\(Vi_0\)) in meters per second. | Meters per second | |
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 | |
ROTOR BRAKE ACTIVE |
N/A |
Whether the rotor brake is active (1, TRUE) or not (0, FALSE). |
Bool | |
ROTOR BRAKE HANDLE POS |
N/A |
The percentage actuated of the rotor brake handle. |
Percent Over 100 | |
ROTOR CHIP DETECTED |
N/A |
Whether the rotor chip is detected (1,TRUE) or not (0, FALSE). |
Bool | |
ROTOR CLUTCH ACTIVE |
N/A |
Whether the rotor clutch is active (1, TRUE) or not (0, FALSE). |
Bool | |
ROTOR CLUTCH SWITCH POS |
N/A |
The rotor clutch switch position, either on (1 TRUE) or off (0, FALSE). |
Bool | |
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. |
Percent Over 100 | |
ROTOR CYCLIC BLADE MAX PITCH POSITION |
[0] 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. |
Degrees | |
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. |
Percent Over 100 | |
ROTOR GOV ACTIVE |
[0] 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 | |
ROTOR GOV TARGET PCT |
[0] Index [1] Value |
Sets a target RPM 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). |
Percent Over 100 | |
ROTOR GOV ENGINE TRIM |
[0] 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). |
Percent Over 100 | |
ROTOR GOV SWITCH POS |
[0] 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 | |
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. |
Percent Over 100 | |
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. |
Percent Over 100 | |
ROTOR ROTATION ANGLE |
[0] 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. |
Radians | |
ROTOR RPM |
[0] Index |
The indexed rotor RPM. 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. |
RPM | |
ROTOR RPM PCT |
[0] 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. |
Percent Over 100 | |
ROTOR TEMPERATURE |
N/A |
The main rotor transmission temperature. |
Rankine | |
STRUCT ROTOR POSITION |
[0] 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. |
feet |
|
TAIL ROTOR BLADE PITCH PCT |
N/A | The pitch position of the tailrotor blades. | Percent Over 100 | |
TAIL ROTOR PEDAL POSITION |
N/A | Percent tail rotor pedal deflection. | Percent Over 100 |
Engine
Simulation Variable | Parameters | Description | Units | Settable |
---|---|---|---|---|
ENG ROTOR RPM:index |
[0] Index |
Returns the indexed rotor RPM. 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. |
Percent scalar 16K (Max rpm * 16384) | |
ENG TORQUE PERCENT:index |
[0] 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 (Ft/lbs * 16384) | |
HELICOPTER_MASTER_THROTTLE_POSITION |
N/A | Returns the position of the master throttle as a value between 0 and 1. | Percent Over 100 |
Sling
Simulation Variable | Parameters | Description | Units | Settable |
---|---|---|---|---|
IS ATTACHED TO SLING |
N/A | Set to true if this object is attached to a sling. | Bool | |
NUM SLING CABLES |
N/A | The number of sling cables (not hoists) that are configured for the helicopter. | Number | |
SLING ACTIVE PAYLOAD STATION |
[0] Index [1] Value |
The payload station (identified by the value) where objects will be placed from the sling (identified by the index). | Number | |
SLING CABLE BROKEN:index |
[0] Index |
THis will be True (1) if the indexed cable is broken, or False (0) otherwise. | Bool | |
SLING CABLE EXTENDED LENGTH |
[0] Index [1] Value |
The length of the indexed cable extending from the aircraft. | Feet (ft) | |
SLING HOIST PERCENT DEPLOYED |
[0] Index |
The percentage of the full length of the sling cable deployed. | Percent Over 100 | |
SLING HOIST SWITCH:index |
[0] Index [1] Value |
This will be True (1) if the hoist is enabled or False (0) otherwise. | Bool | |
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 | |
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, tis 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 |