Helicopter Specific Events
The event IDs listed here are those that are specifically tied to helicopter systems.
General
| Key Name | Event ID | Parameters | Description |
|---|---|---|---|
AUTO_HOVER_OFF | KEY_AUTO_HOVER_OFF | N/A | Disable the auto-hover function of the helicopter, if one is available.Not currently implemented in the Simulation |
AUTO_HOVER_ON | KEY_AUTO_HOVER_ON | N/A | Enable the auto-hover function of the helicopter - if one is available.Not currently implemented in the Simulation |
AUTO_HOVER_SET | KEY_AUTO_HOVER_SET | [0]: True/False (1, 0) | Set the auto-hover - if available - to either on (True, 1) or off (False, 0).Not currently implemented in the Simulation |
AUTO_HOVER_TOGGLE | KEY_AUTO_HOVER_TOGGLE | N/A | Toggle the auto-hover - if available - between on (True, 1) and off (False, 0).Not currently implemented in the Simulation |
AXIS_COLLECTIVE_SET | KEY_AXIS_COLLECTIVE_SET | [0]: Set the collective (0 to 16384) | Set the collective pitch angle (a value from 0 to 1 interpolated from the 0 to 16384 input). |
AXIS_STEERING_SET | KEY_AXIS_STEERING_SET | [0]: Set the steering amount (-16384 to 16384) | Set the steering axis value from -1 to 1 (interpolated from the -16384 to 16384 input). |
AXIS_TAIL_ROTOR_SET | KEY_AXIS_TAIL_ROTOR_SET | [0]: Set tail rotor speed (0 to 16384) | Sets the tail rotor speed as a value from 0 to 1 (interpolated from the 0 to 16384 input). |
COLLECTIVE_DECR | KEY_COLLECTIVE_DECR | N/A | Decrease the engine collective by the amount specified for the collective_increment parameter. If the parameter is not set then a default value of 0.05 will be used. Minimum value on decrement is clamped to 0. |
COLLECTIVE_INCR | KEY_COLLECTIVE_INCR | N/A | Increase the engine collective by the amount specified for the collective_increment parameter. If the parameter is not set then a default value of 0.05 will be used. Maximum on increment value is clamped to 1. |
COLLECTIVE_RELATIVE_AXIS | KEY_COLLECTIVE_RELATIVE_AXIS | N/A | Increment or decrement the collective based on the speed and the distance of the interaction from the user device (values are clamped between 0 to 16384).NOTE: This is primarily for the PS5 controller touch-pad, but should work with any touch-input. |
DECREASE_HELO_GOV_BEEP | KEY_HELI_BEEP_DECREASE | [0]: value[1]: engine | If the helicopter has an engine trimmer, this event can be used to decrease the nominal engine/rotor RPM that the governor is trying to maintain for the indexed engine.The amount that the trim will be adjusted by is set using the engine_trim_rate CFG parameter, and the min and max achievable values are set using engine_trim_min and engine_trim_max. Alternatively, you may supply a value that will override that set in the engine_trim_rate CFG parameter (the min and max values will still be used).An engine index of 0 targets all engines, and any other value targets that specific engine. |
HELICOPTER_FORCE_TRIM_RELEASE_BUTTON_SET | KEY_HELICOPTER_FORCE_TRIM_RELEASE_BUTTON_SET | [0]: Bool | Set the helicopter force trim release button on (1) or off (0). When it is true (1) the link between the user joystick and the cyclic is broken, and the user can move the joystick freely while the helicopter cyclic control will be “frozen” at its current position. This allows the user to move the trimmer, press this button and set the joystick to the physical center, then release this button to restore the link between the joystick and the cyclic again - but now from this new point of cyclic-vs-joystick position. |
INCREASE_HELO_GOV_BEEP | KEY_HELI_BEEP_INCREASE | [0]: value[1]: engine | If the helicopter has an engine trimmer, this event can be used to increase the nominal engine/rotor RPM that the governor is trying to maintain for the indexed engine.The amount that the trim will be adjusted by is set using the engine_trim_rate CFG parameter, and the min and max achievable values are set using engine_trim_min and engine_trim_max. Alternatively, you may supply a value that will override that set in the engine_trim_rate CFG parameter (the min and max values will still be used).An engine index of 0 targets all engines, and any other value targets that specific engine. |
QUICK_TRIM | KEY_QUICK_TRIM | [0]: Bool | If true (1) then assistance to automatically trim your helicopter has been enabled, if false (0) then it has not. |
SET_HELO_GOV_BEEP | KEY_HELI_BEEP_SET | [0]: value[1]: engine | This is used to set the helicopter engine trimmer to the given value directly as a negative or positive deviation from 1, where 1 is the rated nominal engine RPM.The final engine trimmer value will be limited according to the engine_trim_min and engine_trim_max settings.An engine index of 0 targets all engines, and any other value targets that specific engine. |
Cyclic
| Key Name | Event ID | Parameters | Description |
|---|---|---|---|
AXIS_CYCLIC_LATERAL_SET | KEY_AXIS_CYCLIC_LATERAL_SET | [0]: Set the lateral cyclic (-16384 to 16384) | Set the lateral cyclic axis as a value between -16384 and 16384. |
AXIS_CYCLIC_LONGITUDINAL_SET | KEY_AXIS_CYCLIC_LONGITUDINAL_SET | [0]: Set the longitudinal cyclic (-16384 to 16384) | Set the longitudinal cyclic axis. |
CYCLIC_LATERAL_LEFT | KEY_CYCLIC_LATERAL_LEFT | N/A | Change the lateral cyclic (left) by -0.098 when pressed. If held down, the change will happen more rapidly. |
CYCLIC_LATERAL_RIGHT | KEY_CYCLIC_LATERAL_RIGHT | N/A | Change the lateral cyclic (right) by 0.098 when pressed. If held down, the change will happen more rapidly. |
CYCLIC_LONGITUDINAL_DOWN | KEY_CYCLIC_LONGITUDINAL_DOWN | N/A | Change the longitudinal cyclic (down) by -0.049 when pressed. If held down, the change will happen more rapidly. |
CYCLIC_LONGITUDINAL_UP | KEY_CYCLIC_LONGITUDINAL_UP | N/A | Change the longitudinal cyclic (up) by 0.049 when pressed. If held down, the change will happen more rapidly. |
Throttle Control
| Key Name | Event ID | Parameters | Description |
|---|---|---|---|
AXIS_HELICOPTER_THROTTLE1_SETAXIS_HELICOPTER_THROTTLE2_SET | KEY_AXIS_HELICOPTER_THROTTLE1_SETKEY_AXIS_HELICOPTER_THROTTLE2_SET | [0]: Throttle value (0 to 16384) | Set the throttle 1 or 2 value from 0 to 1 (interpolated from the 0 to 16384 input). |
AXIS_HELICOPTER_THROTTLE_SET | KEY_AXIS_HELICOPTER_THROTTLE_SET | [0]: Throttle value (0 to 16384) | Set all throttles to a value from 0 to 1 (interpolated from the 0 to 16384 input). |
HELICOPTER_THROTTLE1_CUTHELICOPTER_THROTTLE2_CUT | KEY_HELICOPTER_THROTTLE1_CUTKEY_HELICOPTER_THROTTLE2_CUT | N/A | Cut throttle 1 or 2. |
HELICOPTER_THROTTLE1_DECHELICOPTER_THROTTLE2_DEC | KEY_HELICOPTER_THROTTLE1_DECKEY_HELICOPTER_THROTTLE2_DEC | [0]: Decrement value (0 to 16384) | By default this will decrement throttle 1 or 2 by 1/128, to a minimum of 0. If you provide an input parameter then this will be internally normalised to a value between 0 and 1 and used to decrement instead. |
HELICOPTER_THROTTLE1_FULLHELICOPTER_THROTTLE2_FULL | KEY_HELICOPTER_THROTTLE1_FULLKEY_HELICOPTER_THROTTLE2_FULL | N/A | Set throttle 1 or 2 to full. |
HELICOPTER_THROTTLE1_INCHELICOPTER_THROTTLE2_INC | KEY_HELICOPTER_THROTTLE1_INCKEY_HELICOPTER_THROTTLE2_INC | [0]: Increment value (0 to 16384) | By default this will increment throttle 1 or 2 by 1/128, to a maximum of 1. If you provide an input parameter then this will be internally normalised to a value between 0 and 1 and used to increment instead. |
HELICOPTER_THROTTLE1_SETHELICOPTER_THROTTLE2_SET | KEY_HELICOPTER_THROTTLE1_SETKEY_HELICOPTER_THROTTLE2_SET | [0]: Throttle value (0 to 16384) | Set throttle 1 or 2 based on the input value. The input is between 0 and 16384, which will be normalised to a value between 0 and 1. |
HELICOPTER_THROTTLE_CUT | KEY_HELICOPTER_THROTTLE_CUT | N/A | Cut all throttles. |
HELICOPTER_THROTTLE_DEC | KEY_HELICOPTER_THROTTLE_DEC | [0]: Decrement value (0 to 16384) | By default this will decrement all throttles by 1/128, to a minimum of 0. If you provide an input parameter then this will be internally normalised to a value between 0 and 1 and used to decrement instead. |
HELICOPTER_THROTTLE_FULL | KEY_HELICOPTER_THROTTLE_FULL | N/A | Set all throttles to full. |
HELICOPTER_THROTTLE_INC | KEY_HELICOPTER_THROTTLE_INC | [0]: Increment value (0 to 16384) | By default this will increment all throttles by 1/128, to a maximum of 1. If you provide an input parameter then this will be internally normalised to a value between 0 and 1 and used to increment instead. |
HELICOPTER_THROTTLE_RELATIVE_AXIS | KEY_HELICOPTER_THROTTLE_RELATIVE_AXIS | N/A | Increment or decrement the throttle based on the speed and the distance of the interaction from the user device (values are clamped between 0 to 16384).NOTE: This is primarily for the PS5 controller touch-pad, but should work with any touch-input. |
HELICOPTER_THROTTLE_SET | KEY_HELICOPTER_THROTTLE_SET | [0]: Throttle value (0 to 16384) | Set all throttles based on the input value. The input is between 0 and 16384, which will be normalised to a value between 0 and 1. |
Rotor Control
| Key Name | Event ID | Parameters | Description |
|---|---|---|---|
AXIS_ROTOR_BRAKE_SET | KEY_AXIS_ROTOR_BRAKE_SET | [0]: Brake Lever position (0 to 16384) | Set the rotor brake. This takes a value between 0 to 16384, which will be interpreted by the simulation as a percentage where 0 is fully off and 16384 is fully on. |
ROTOR_AXIS_TAIL_ROTOR_SET | KEY_AXIS_TAIL_ROTOR_SET | [0]: Brake Lever Position (0 to 16384) | Set the tail (or second) rotor brake. This takes a value between 0 to 16384, which will be interpreted by the simulation as a percentage where 0 is fully off and 16384 is fully on. |
ROTOR_BRAKE | KEY_ROTOR_BRAKE | [0]: Bool | Sets rotor brake switch on. Deprecated in favour of ROTOR_BRAKE_ON. |
ROTOR_BRAKE_LOCK_SET | KEY_ROTOR_BRAKE_LOCK_SET | [0]: Bool | Sets the rotor brake lock to on (1) or off (0). |
ROTOR_BRAKE_OFF | KEY_ROTOR_BRAKE_OFF | N/A | Switches off the rotor brake switch . |
ROTOR_BRAKE_ON | KEY_ROTOR_BRAKE_ON | N/A | Switches on the rotor brake switch . |
ROTOR_BRAKE_TOGGLE | KEY_ROTOR_BRAKE_TOGGLE | N/A | Toggle the rotor brake switch between on (1) and off (0). |
ROTOR_CLUTCH_SWITCH_SET | KEY_ROTOR_CLUTCH_SWITCH_SET | [0]: Bool | Sets the rotor clutch switch to on (1) or off (0). |
ROTOR_CLUTCH_SWITCH_TOGGLE | KEY_ROTOR_CLUTCH_SWITCH_TOGGLE | N/A | Toggles the rotor clutch switch between on (1) and off (0). |
ROTOR_GOV_SWITCH_OFF | KEY_ROTOR_GOV_SWITCH_OFF | [0]: engine | Sets the rotor governor switch to off (0).An index of 0 targets all engines, and any other value targets that specific engine. |
ROTOR_GOV_SWITCH_ON | KEY_ROTOR_GOV_SWITCH_ON | [0]: engine | Sets the rotor governor switch to on (1).An index of 0 targets all engines, and any other value targets that specific engine. |
ROTOR_GOV_SWITCH_SET | KEY_ROTOR_GOV_SWITCH_SET | [0]: Bool[1]: engine | Sets the rotor governor switch to on/off (1,0).An index of 0 targets all engines, and any other value targets that specific engine. |
ROTOR_GOV_SWITCH_TOGGLE | KEY_ROTOR_GOV_SWITCH_TOGGLE | [0]: engine | Toggles the rotor governor switch between on (1) and off (0).An index of 0 targets all engines, and any other value targets that specific engine. |
ROTOR_LATERAL_TRIM_DEC | KEY_ROTOR_LATERAL_TRIM_DEC | N/A | Decrements the roll (lateral) rotor trim by the amount specified by the parameter right_trim_step. |
ROTOR_LATERAL_TRIM_INC | KEY_ROTOR_LATERAL_TRIM_INC | N/A | Increments the roll (lateral) rotor trim by the amount specified by the parameter right_trim_step. |
ROTOR_LATERAL_TRIM_SET | KEY_ROTOR_LATERAL_TRIM_SET | [0]: Pitch angle (+/- 16384) | Sets the roll (lateral) rotor trim to a value between -1 and 1 (interpolated from the +/-16384 input value). |
ROTOR_LONGITUDINAL_TRIM_DEC | KEY_ROTOR_LONGITUDINAL_TRIM_DEC | N/A | Decrements the pitch (longitudinal) rotor trim by the amount specified by the parameter front_trim_step. |
ROTOR_LONGITUDINAL_TRIM_INC | KEY_ROTOR_LONGITUDINAL_TRIM_INC | N/A | Increments the pitch (longitudinal) rotor trim by the amount specified by the parameter front_trim_step. |
ROTOR_LONGITUDINAL_TRIM_SET | KEY_ROTOR_LONGITUDINAL_TRIM_SET | [0]: Pitch angle (+/- 16384) | Sets the pitch (longitudinal) rotor trim to a value between -1 and 1 (interpolated from the +/-16384 input value). |
ROTOR_TRIM_RESET | KEY_ROTOR_TRIM_RESET | N/A | Resets the rotor trim values to their default. |
TAIL_ROTOR_DECR | KEY_TAIL_ROTOR_DECR | N/A | Decrements the tail rotor by 0.1. |
TAIL_ROTOR_INCR | KEY_TAIL_ROTOR_INCR | N/A | Increments the tail rotor by 0.1. |
Engine Control
| Key Name | Event ID | Parameters | Description |
|---|---|---|---|
HELICOPTER_ENGINE_1_GOVERNOR_SWITCH_OFFHELICOPTER_ENGINE_2_GOVERNOR_SWITCH_OFF | KEY_HELICOPTER_ENGINE_1_GOVERNOR_SWITCH_OFFKEY_HELICOPTER_ENGINE_2_GOVERNOR_SWITCH_OFF | N/A | For a helicopter, toggle the engine 1/2 governor switch between ON (1) and OFF (0). |
HELICOPTER_ENGINE_1_GOVERNOR_SWITCH_ONHELICOPTER_ENGINE_2_GOVERNOR_SWITCH_ON | KEY_HELICOPTER_ENGINE_1_GOVERNOR_SWITCH_ONKEY_HELICOPTER_ENGINE_2_GOVERNOR_SWITCH_ON | N/A | For a helicopter, set the engine 1/2 governor switch ON. |
HELICOPTER_ENGINE_1_GOVERNOR_SWITCH_TOGGLEHELICOPTER_ENGINE_2_GOVERNOR_SWITCH_TOGGLE | KEY_HELICOPTER_ENGINE_1_GOVERNOR_SWITCH_TOGGLEKEY_HELICOPTER_ENGINE_2_GOVERNOR_SWITCH_TOGGLE | N/A | For a helicopter, set the engine 1/2 governor switch OFF. |
HELICOPTER_ENGINE_1_GOVERNOR_SWITCH_SETHELICOPTER_ENGINE_2_GOVERNOR_SWITCH_SET | KEY_HELICOPTER_ENGINE_1_GOVERNOR_SWITCH_SETKEY_HELICOPTER_ENGINE_2_GOVERNOR_SWITCH_SET | [0]: Bool | For a helicopter, set the engine 1/2 governor switch to either ON (1) or OFF (0). |
HELICOPTER_ENGINE_1_BEEP_TRIM_INCREASEHELICOPTER_ENGINE_2_BEEP_TRIM_INCREASE | KEY_HELICOPTER_ENGINE_1_BEEP_TRIM_INCREASEKEY_HELICOPTER_ENGINE_2_BEEP_TRIM_INCREASE | [0]: value | For a helicopter, increase the engine 1/2 trim RPM by the given value amount. |
HELICOPTER_ENGINE_1_BEEP_TRIM_DECREASEHELICOPTER_ENGINE_2_BEEP_TRIM_DECREASE | KEY_HELICOPTER_ENGINE_1_BEEP_TRIM_DECREASEKEY_HELICOPTER_ENGINE_2_BEEP_TRIM_DECREASE | [0]: value | For a helicopter, decrease the engine 1/2 trim RPM by the given value amount. |
HELICOPTER_ENGINE_1_BEEP_TRIM_SETHELICOPTER_ENGINE_2_BEEP_TRIM_SET | KEY_HELICOPTER_ENGINE_1_BEEP_TRIM_SETKEY_HELICOPTER_ENGINE_2_BEEP_TRIM_SET | [0]: value | For a helicopter, set the engine 1/2 trim RPM to the given value. |