Undocumented Key Event IDs

max.paperno · November 24, 2024, 10:27am

Version: SDK v1.0.0 and published ms2024 documentation as of Nov-24-2024.

Frequency: Consistently

Severity: Low

Similar MSFS 2020 issue: The Key IDs listed below with SDK v < 1.0.0 also do not appear in current MSFS 2020 documentation, but should.

Bug description:
Here is a list of key events which are defined in WASM/include/MSFS/Types/MSFS_EventsEnum.h of SDK v1.0.0 but do not appear to be listed anywhere in the documentation, either as the KEY_ macro name nor as any alias that I can map one to.

Note that some documented Event IDs do not match the key macro names (all primarily from old versions of the SDK). I figured out mappings for those as best as I could (also included below), and those are not included in the list of undocumented ones. It is possible my mappings are wrong or incomplete, which may account for a few of these undocumented ones.

In the list/file below, the “SDK_VERSION” column indicates the first version of the SDK in which the event macro appeared, according to my records. SDK_VERSION 0.0.0 means < 0.22.2, before which I didn’t track changes by version.

Undocumented Key Event IDs

Macro_Name,                                        KeyID,   SDK_VERSION
"KEY_3RD_PARTY_WINDOW_MOVE_DOWN",                  67553,   "0.22.3"
"KEY_3RD_PARTY_WINDOW_MOVE_UP",                    67554,   "0.22.3"
"KEY_3RD_PARTY_WINDOW_OPEN_PRIMARY",               67551,   "0.22.3"
"KEY_3RD_PARTY_WINDOW_OPEN_SECONDARY",             67552,   "0.22.3"
"KEY_3RD_PARTY_WINDOW_VALIDATE",                   67555,   "0.22.3"
"KEY_AIRSHIP_VALVE_1_CLOSE",                       67656,   "1.0.0"
"KEY_AIRSHIP_VALVE_1_OPEN",                        67657,   "1.0.0"
"KEY_AIRSHIP_VALVE_1_SET",                         67658,   "1.0.0"
"KEY_AIRSHIP_VALVE_1_TOGGLE",                      67659,   "1.0.0"
"KEY_AIRSHIP_VALVE_2_CLOSE",                       67660,   "1.0.0"
"KEY_AIRSHIP_VALVE_2_OPEN",                        67661,   "1.0.0"
"KEY_AIRSHIP_VALVE_2_SET",                         67662,   "1.0.0"
"KEY_AIRSHIP_VALVE_2_TOGGLE",                      67663,   "1.0.0"
"KEY_AIRSHIP_VALVE_3_CLOSE",                       67664,   "1.0.0"
"KEY_AIRSHIP_VALVE_3_OPEN",                        67665,   "1.0.0"
"KEY_AIRSHIP_VALVE_3_SET",                         67666,   "1.0.0"
"KEY_AIRSHIP_VALVE_3_TOGGLE",                      67667,   "1.0.0"
"KEY_AIRSHIP_VALVE_4_CLOSE",                       67668,   "1.0.0"
"KEY_AIRSHIP_VALVE_4_OPEN",                        67669,   "1.0.0"
"KEY_AIRSHIP_VALVE_4_SET",                         67670,   "1.0.0"
"KEY_AIRSHIP_VALVE_4_TOGGLE",                      67671,   "1.0.0"
"KEY_AIRSHIP_VALVE_CLOSE",                         67672,   "1.0.0"
"KEY_AIRSHIP_VALVE_OPEN",                          67673,   "1.0.0"
"KEY_AIRSHIP_VALVE_SET",                           67674,   "1.0.0"
"KEY_AIRSHIP_VALVE_TOGGLE",                        67675,   "1.0.0"
"KEY_AP_ALT_CURRENT_ALT_SET",                      67677,   "1.0.0"
"KEY_AP_HDG_CURRENT_HDG_SET",                      67678,   "1.0.0"
"KEY_AXIS_CONDITION_LEVER_SET",                    67365,   "0.0.0"
"KEY_AXIS_PC_FPV_ROTATION_X",                      68562,   "1.0.0"
"KEY_AXIS_PC_FPV_ROTATION_Y",                      68563,   "1.0.0"
"KEY_AXIS_PC_MOVE_X",                              68561,   "1.0.0"
"KEY_AXIS_PC_MOVE_Z",                              68560,   "1.0.0"
"KEY_COVER_SET",                                   68550,   "1.0.0"
"KEY_DEMO_RECORD_MESSAGE",                         65587,   "0.0.0"
"KEY_ELECT_FUEL_PUMP_SET",                         67550,   "0.21.0"
"KEY_FIREFIGHTING_SCOOP_DOORS",                    67676,   "1.0.0"
"KEY_FLAPS_DETENTS_SET",                           65760,   "0.0.0"
"KEY_GRAPPLE_HOOK_OFF",                            67654,   "1.0.0"
"KEY_GRAPPLE_HOOK_ON",                             67653,   "1.0.0"
"KEY_GRAPPLE_HOOK_SET",                            68547,   "1.0.0"
"KEY_GRAPPLE_HOOK_TOGGLE",                         67652,   "1.0.0"
"KEY_HELICOPTER_FORCE_TRIM_RELEASE_BUTTON_SET",    68558,   "1.0.0"
"KEY_LEAD_POLE_OFF",                               67651,   "1.0.0"
"KEY_LEAD_POLE_ON",                                67650,   "1.0.0"
"KEY_LEAD_POLE_SET",                               68546,   "1.0.0"
"KEY_LEAD_POLE_TOGGLE",                            67649,   "1.0.0"
"KEY_LIGHT_AMBIENT_COLOR_SET",                     68557,   "1.0.0"
"KEY_MENU_RENO_KICK_PLAYER",                       67428,   "0.0.0"
"KEY_MENU_SR_EFB_TOGGLE",                          68541,   "1.0.0"
"KEY_ORNI_BOOST_SET",                              67565,   "0.23.1"
"KEY_ORNI_DIVE_MODE_OFF",                          67559,   "0.23.1"
"KEY_ORNI_DIVE_MODE_ON",                           67560,   "0.23.1"
"KEY_ORNI_DIVE_MODE_TOGGLE",                       67561,   "0.23.1"
"KEY_ORNI_GLIDE_MODE_OFF",                         67562,   "0.23.1"
"KEY_ORNI_GLIDE_MODE_ON",                          67563,   "0.23.1"
"KEY_ORNI_GLIDE_MODE_TOGGLE",                      67564,   "0.23.1"
"KEY_ORNI_WINGS_BRAKE_SET",                        67566,   "0.23.1"
"KEY_PC_CROUCH_SET",                               68572,   "1.0.0"
"KEY_PC_CROUCH_TOGGLE",                            68556,   "1.0.0"
"KEY_PC_FPV_LOOK_DOWN",                            67629,   "1.0.0"
"KEY_PC_FPV_LOOK_DOWN_LEFT",                       68564,   "1.0.0"
"KEY_PC_FPV_LOOK_DOWN_RIGHT",                      68565,   "1.0.0"
"KEY_PC_FPV_LOOK_LEFT",                            67627,   "1.0.0"
"KEY_PC_FPV_LOOK_RIGHT",                           67626,   "1.0.0"
"KEY_PC_FPV_LOOK_UP",                              67628,   "1.0.0"
"KEY_PC_FPV_LOOK_UP_LEFT",                         68566,   "1.0.0"
"KEY_PC_FPV_LOOK_UP_RIGHT",                        68567,   "1.0.0"
"KEY_PC_MOVE_BACKWARD",                            67625,   "1.0.0"
"KEY_PC_MOVE_BACKWARD_LEFT",                       68568,   "1.0.0"
"KEY_PC_MOVE_BACKWARD_RIGHT",                      68569,   "1.0.0"
"KEY_PC_MOVE_FORWARD",                             67624,   "1.0.0"
"KEY_PC_MOVE_FORWARD_LEFT",                        68570,   "1.0.0"
"KEY_PC_MOVE_FORWARD_RIGHT",                       68571,   "1.0.0"
"KEY_PC_MOVE_LEFT",                                67623,   "1.0.0"
"KEY_PC_MOVE_RIGHT",                               67622,   "1.0.0"
"KEY_PC_RUN_SET",                                  68555,   "1.0.0"
"KEY_PLASMA_OFF",                                  67504,   "0.20.2"
"KEY_PLASMA_ON",                                   67503,   "0.20.2"
"KEY_PLASMA_SET",                                  67505,   "0.20.2"
"KEY_PLASMA_TOGGLE",                               67506,   "0.20.2"
"KEY_QUICK_TRIM",                                  68559,   "1.0.0"
"KEY_ROTOR_BRAKE_LOCK_SET",                        68548,   "1.0.0"
"KEY_THROTTLE_DETENT_NEXT",                        68575,   "1.0.0"
"KEY_THROTTLE_DETENT_PREV",                        68576,   "1.0.0"
"KEY_THROTTLE_INCR_SMALL",                         65600,   "0.0.0"
"KEY_THROTTLE_RANGE_DECR",                         68574,   "1.0.0"
"KEY_THROTTLE_RANGE_INCR",                         68573,   "1.0.0"
"KEY_TOGGLE_ALL_AIRCRAFT_DOORS",                   67655,   "1.0.0"
"KEY_WING_FOLD_OFF",                               67556,   "0.23.1"
"KEY_WING_FOLD_ON",                                67557,   "0.23.1"
"KEY_WING_FOLD_SET",                               67558,   "0.23.1"

Undocumented_KeyEventIDs_sdk-v1.0.0.csv.zip (1.2 KB)

Published Name to KEY_IDs Mapping

_{“KEY_” prefix omitted in macro names.}

Published Name                         KEY_ Macro Name
------------------------------------|---------------------------------
ADF1_WHOLE_DEC                        ADF_WHOLE_DEC
ADF1_WHOLE_INC                        ADF_WHOLE_INC
ALTITUDE_SLOT_INDEX_SET               AP_ALTITUDE_SLOT_INDEX_SET
ANTIDETONATION_TANK_VALVE_TOGGLE      TOGGLE_ANTIDETONATION_TANK_VALVE
AP_HEADING_BUG_SET_EX1                HEADING_BUG_SET_EX1
AP_PANEL_MACH_HOLD_TOGGLE             AUTOPILOT_MACH_HOLD_CURRENT
AP_PANEL_SPEED_HOLD_TOGGLE            AUTOPILOT_AIRSPEED_HOLD_CURRENT
ATTITUDE_BARS_POSITION_DOWN           ATTITUDE_BARS_POSITION_DEC
ATTITUDE_BARS_POSITION_UP             ATTITUDE_BARS_POSITION_INC
ATTITUDE_CAGE_BUTTON                  TOGGLE_ATTITUDE_CAGE
AUTORUDDER_TOGGLE                     AUTOCOORD_TOGGLE
BACK_TO_FLY                           ????
COM_STBY_RADIO_SWAP                   COM_STBY_RADIO_SWITCH_TO
DECREASE_AUTOBRAKE_CONTROL            DEC_AUTOBRAKE_CONTROL
DECREASE_DECISION_ALTITUDE_MSL        DECISION_ALTITUDE_MSL_DEC
DECREASE_DECISION_HEIGHT              DECISION_HEIGHT_DEC
DECREASE_HELO_GOV_BEEP                HELI_BEEP_DECREASE
FLIGHT_LEVEL_CHANGE                   AP_FLIGHT_LEVEL_CHANGE
FLIGHT_LEVEL_CHANGE_OFF               AP_FLIGHT_LEVEL_CHANGE_OFF
FLIGHT_LEVEL_CHANGE_ON                AP_FLIGHT_LEVEL_CHANGE_ON
HEADING_SLOT_INDEX_SET                AP_HEADING_SLOT_INDEX_SET
INCREASE_AUTOBRAKE_CONTROL            INC_AUTOBRAKE_CONTROL
INCREASE_DECISION_ALTITUDE_MSL        DECISION_ALTITUDE_MSL_INC
INCREASE_DECISION_HEIGHT              DECISION_HEIGHT_INC
INCREASE_HELO_GOV_BEEP                HELI_BEEP_INCREASE
KNEEBOARD_VIEW                        KNEEBOARD
LIQUID_DROPPINGSYSTEM_SCOOP_TOGGLE    LIQUID_DROPPING_SYSTEM_SCOOP_TOGGLE
MP_ACTIVATE_CHAT                      MULTIPLAYER_ACTIVATE_CHAT
MP_BROADCAST_VOICE_CAPTURE_START      MULTIPLAYER_BROADCAST_VOICE_CAPTURE_START
MP_BROADCAST_VOICE_CAPTURE_STOP       MULTIPLAYER_BROADCAST_VOICE_CAPTURE_STOP
MP_CHAT                               MULTIPLAYER_CHAT
MP_PAUSE_SESSION                      MULTIPLAYER_PAUSE_SESSION
MP_PLAYER_CYCLE                       MULTIPLAYER_PLAYER_CYCLE
MP_PLAYER_FOLLOW                      MULTIPLAYER_PLAYER_FOLLOW
MP_TRANSFER_CONTROL                   MULTIPLAYER_TRANSFER_CONTROL
MP_VOICE_CAPTURE_START                MULTIPLAYER_VOICE_CAPTURE_START
MP_VOICE_CAPTURE_STOP                 MULTIPLAYER_VOICE_CAPTURE_STOP
NITROUS_TANK_VALVE_TOGGLE             TOGGLE_NITROUS_TANK_VALVE
PRESSURIZATION_PRESSURE_DUMP_SWTICH   PRESSURIZATION_PRESSURE_DUMP_SWITCH
RELOAD_USER_AIRCRAFT                  CONTROL_RELOAD_USER_AIRCRAFT
REQUEST_FUEL_KEY                      REQUEST_FUEL
ROTOR_AXIS_TAIL_ROTOR_SET             AXIS_TAIL_ROTOR_SET
ROTOR_BRAKE_SET                       AXIS_ROTOR_BRAKE_SET
RPM_SLOT_INDEX_SET                    AP_RPM_SLOT_INDEX_SET
SET_DECISION_ALTITUDE_MSL             DECISION_ALTITUDE_MSL_SET
SET_HELO_GOV_BEEP                     HELI_BEEP_SET
SET_REVERSE_THRUST_OFF                SET_THROTTLE_REVERSE_THRUST_OFF
SET_REVERSE_THRUST_ON                 SET_THROTTLE_REVERSE_THRUST_ON
SPEED_SLOT_INDEX_SET                  AP_SPEED_SLOT_INDEX_SET
TOGGLE_AUTOFEATHER_ARM                TOGGLE_ARM_AUTOFEATHER
TOGGLE_DME                            DME_TOGGLE
TOGGLE_PROPELLER_SYNC                 TOGGLE_PROP_SYNC
TOGGLE_PUSHBACK                       PUSHBACK_SET
TOW_PLANE_REQUEST                     REQUEST_TOW_PLANE
TRUE_AIRSPEED_CAL_DEC                 TRUE_AIRSPEED_CALIBRATE_DEC
TRUE_AIRSPEED_CAL_INC                 TRUE_AIRSPEED_CALIBRATE_INC
VARIOMETER_SOUND_TOGGLE               TOGGLE_VARIOMETER_SWITCH
VERTICAL_SPEED_SET                    AP_VS_SET
VIEW_AXIS_INDICATOR_CYCLE             AXIS_INDICATOR_CYCLE
VIEW_CAMERA_SELECT_START              VIEW_CAMERA_SELECT_STARTING
VIEW_WINDOW_TITLES_TOGGLE             WINDOW_TITLES_TOGGLE
VS_SLOT_INDEX_SET                     AP_VS_SLOT_INDEX_SET

FlyingRaccoon · December 20, 2024, 9:44am

Hello @max.paperno

Thank you for the detailed bug report.
This is a long standing issue we already had on MSFS 2020, a lot of these are inherited from FSX and no longer in use and MSFS 2024 introduced a bunch of new ones that did not make it into the doc yet.
I will have this reviewed.

Regarding the mismatch between macros and published names, we raised awareness of this among our devs so it should not occur on newly added events.
For the existing cases, not much we can do for the moment. We cannot create aliases in the current system and changing it would introduce regressions.
I would like this to be clearly visible in the documentation at least.

Regards,
Sylvain

max.paperno · December 20, 2024, 10:20am

Hi Sylvain, thanks for your concise reply.

Understood on the undocumented ones, and makes sense you folks would need time to catch the docs up with actual. Looking through the scores of new input bindings in FS24 I wonder if all the KEY events are even properly defined as macros in the SDK at this point (in the new MSFS_EventsEnum.h, and yay for moving them out of gauges.h!).

For the name mismatches, documentation is what is missing. The old style FSX docs (img below) actually had a separate column for name vs. ID (and P3D ones are still the same). Which I think is a waste of space for most of the events since they match (besides “KEY_” prefix). But a note in the “details” section of the affected events would be helpful.

Cheers,
-Max

FlyingRaccoon · December 20, 2024, 1:25pm

We talked with @Nocturne about having something like this at some point.