Key Events

KEY EVENTS

Key Events are used as a way to interface between different systems, with the user at the top level and the various sub-system within the simulation at the bottom. Generally they will be used as part of the Gauge/Panel API, and also when using RPN to generate Model Behavior inputs, although they may also have other uses.

NOTE: if you are using the JavaScript API then you use these variables as "K:" vars, similar to way you call SimVars, using the GetSimVarValue(name, unit, dataSource = "") function.

Due to the massive number of available event IDs, they have been split into smaller related sub-sections to facilitate finding the ones that you need based on the their approximate relevance.

The available sections are:

Key Event Index

Below you can find indexed all the Key Event IDs available, presented this way to facilitate finding the required variable at a glance or through the search system:

F

G

G_LIMITER_OFF
G_LIMITER_ON
G_LIMITER_SET
G_LIMITER_TOGGLE
G1000_MFD_CLEAR_BUTTON
G1000_MFD_CURSOR_BUTTON
G1000_MFD_DIRECTTO_BUTTON
G1000_MFD_ENTER_BUTTON
G1000_MFD_FLIGHTPLAN_BUTTON
G1000_MFD_GROUP_KNOB_DEC
G1000_MFD_GROUP_KNOB_INC
G1000_MFD_MENU_BUTTON
G1000_MFD_PAGE_KNOB_DEC
G1000_MFD_PAGE_KNOB_INC
G1000_MFD_PROCEDURE_BUTTON
G1000_MFD_SOFTKEY1
G1000_MFD_SOFTKEY2
G1000_MFD_SOFTKEY3
G1000_MFD_SOFTKEY4
G1000_MFD_SOFTKEY5
G1000_MFD_SOFTKEY6
G1000_MFD_SOFTKEY7
G1000_MFD_SOFTKEY8
G1000_MFD_SOFTKEY9
G1000_MFD_SOFTKEY10
G1000_MFD_SOFTKEY11
G1000_MFD_SOFTKEY12
G1000_MFD_ZOOMIN_BUTTON
G1000_MFD_ZOOMOUT_BUTTON
G1000_PFD_CLEAR_BUTTON
G1000_PFD_CURSOR_BUTTON
G1000_PFD_DIRECTTO_BUTTON
G1000_PFD_ENTER_BUTTON
G1000_PFD_FLIGHTPLAN_BUTTON
G1000_PFD_GROUP_KNOB_INC
G1000_PFD_GROUP_KNOB_DEC
G1000_PFD_MENU_BUTTON
G1000_PFD_PAGE_KNOB_INC
G1000_PFD_PAGE_KNOB_DEC
G1000_PFD_PROCEDURE_BUTTON
G1000_PFD_SOFTKEY1
G1000_PFD_SOFTKEY2
G1000_PFD_SOFTKEY3
G1000_PFD_SOFTKEY4
G1000_PFD_SOFTKEY5
G1000_PFD_SOFTKEY6
G1000_PFD_SOFTKEY7
G1000_PFD_SOFTKEY8
G1000_PFD_SOFTKEY9
G1000_PFD_SOFTKEY10
G1000_PFD_SOFTKEY11
G1000_PFD_SOFTKEY12
G1000_PFD_ZOOMIN_BUTTON
G1000_PFD_ZOOMOUT_BUTTON
GAUGE_KEYSTROKE
GEAR_DOWN
GEAR_EMERGENCY_HANDLE_TOGGLE
GEAR_PUMP
GEAR_SET
GEAR_TOGGLE
GEAR_UP
GLARESHIELD_LIGHTS_OFF
GLARESHIELD_LIGHTS_ON
GLARESHIELD_LIGHTS_POWER_SETTING_SET
GLARESHIELD_LIGHTS_SET
GLARESHIELD_LIGHTS_TOGGLE
GPS_ACTIVATE_BUTTON
GPS_BUTTON1
GPS_BUTTON2
GPS_BUTTON3
GPS_BUTTON4
GPS_BUTTON5
GPS_CLEAR_BUTTON
GPS_CLEAR_ALL_BUTTON
GPS_CLEAR_BUTTON_DOWN
GPS_CLEAR_BUTTON_UP
GPS_CURSOR_BUTTON
GPS_DIRECTTO_BUTTON
GPS_ENTER_BUTTON
GPS_FLIGHTPLAN_BUTTON
GPS_GROUP_KNOB_DEC
GPS_GROUP_KNOB_INC
GPS_MENU_BUTTON
GPS_MSG_BUTTON
GPS_MSG_BUTTON_DOWN
GPS_MSG_BUTTON_UP
GPS_NEAREST_BUTTON
GPS_OBS
GPS_OBS_BUTTON
GPS_OBS_DEC
GPS_OBS_INC
GPS_OBS_OFF
GPS_OBS_ON
GPS_OBS_SET
GPS_PAGE_KNOB_INC
GPS_PAGE_KNOB_DEC
GPS_PROCEDURE_BUTTON
GPS_POWER_BUTTON
GPS_SETUP_BUTTON
GPS_TERRAIN_BUTTON
GPS_VNAV_BUTTON
GPS_ZOOMIN_BUTTON
GPS_ZOOMOUT_BUTTON
GPWS_SWITCH_TOGGLE
GUNSIGHT_SEL
GUNSIGHT_TOGGLE
GYRO_DRIFT_DEC
GYRO_DRIFT_INC
GYRO_DRIFT_SET

H

I

INC_CONCORDE_NOSE_VISOR
INC_COWL_FLAPS
INC_COWL_FLAPS1
INC_COWL_FLAPS2
INC_COWL_FLAPS3
INC_COWL_FLAPS4
INCREASE_AUTOBRAKE_CONTROL
INCREASE_DECISION_ALTITUDE_MSL
INCREASE_DECISION_HEIGHT
INCREASE_THROTTLE
INDUCTOR_COMPASS_REF_INC
INDUCTOR_COMPASS_REF_DEC
INTERCOM_MODE_SET
INVOKE_HELP
ISOLATE_TURBINE_OFF
ISOLATE_TURBINE_ON
ISOLATE_TURBINE_SET
ISOLATE_TURBINE_TOGGLE

J

JET_STARTER
JOYSTICK_CALIBRATE

K

KEYBOARD_OVERLAY
KNEEBOARD_VIEW
KOHLSMAN_INC
KOHLSMAN_DEC
KOHLSMAN_SET

L

M

MAC_CREADY_SETTING_DEC
MAC_CREADY_SETTING_INC
MAC_CREADY_SETTING_SET
MACRO_BEGIN
MACRO_END
MAGNETO
MAGNETO_BOTH
MAGNETO_DECR
MAGNETO_INCR
MAGNETO_LEFT
MAGNETO_OFF
MAGNETO_RIGHT
MAGNETO_SET
MAGNETO_START
MAGNETO1_BOTH
MAGNETO1_DECR
MAGNETO1_INCR
MAGNETO1_LEFT
MAGNETO1_OFF
MAGNETO1_RIGHT
MAGNETO1_SET
MAGNETO1_START
MAGNETO2_BOTH
MAGNETO2_DECR
MAGNETO2_INCR
MAGNETO2_LEFT
MAGNETO2_OFF
MAGNETO2_RIGHT
MAGNETO2_SET
MAGNETO2_START
MAGNETO3_BOTH
MAGNETO3_DECR
MAGNETO3_INCR
MAGNETO3_LEFT
MAGNETO3_OFF
MAGNETO3_RIGHT
MAGNETO3_SET
MAGNETO3_START
MAGNETO4_BOTH
MAGNETO4_DECR
MAGNETO4_INCR
MAGNETO4_LEFT
MAGNETO4_OFF
MAGNETO4_RIGHT
MAGNETO4_SET
MAGNETO4_START
MANUAL_FUEL_PRESSURE_PUMP
MANUAL_FUEL_PRESSURE_PUMP_SET
MANUAL_FUEL_TRANSFER
MAP_ORIENTATION_CYCLE
MAP_ORIENTATION_SET
MAP_ZOOM_FINE_IN
MAP_ZOOM_FINE_OUT
MAP_ZOOM_SET
MARKER_BEACON_SENSITIVITY_HIGH
MARKER_BEACON_TEST_MUTE
MARKER_SOUND_TOGGLE
MARKER_SOUND_SET
MASTER_BATTERY_OFF
MASTER_BATTERY_ON
MASTER_BATTERY_SET
MASTER_CAUTION_ACKNOWLEDGE
MASTER_CAUTION_OFF
MASTER_CAUTION_ON
MASTER_CAUTION_SET
MASTER_CAUTION_TOGGLE
MASTER_WARNING_ACKNOWLEDGE
MASTER_WARNING_OFF
MASTER_WARNING_ON
MASTER_WARNING_SET
MASTER_WARNING_TOGGLE
MINUS
MINUS_SHIFT
MIXTURE_DECR
MIXTURE_DECR_SMALL
MIXTURE_INCR
MIXTURE_INCR_SMALL
MIXTURE_LEAN
MIXTURE_RICH
MIXTURE1_DECR
MIXTURE1_DECR_SMALL
MIXTURE1_INCR
MIXTURE1_INCR_SMALL
MIXTURE1_LEAN
MIXTURE1_RICH
MIXTURE2_DECR
MIXTURE2_DECR_SMALL
MIXTURE2_INCR
MIXTURE2_INCR_SMALL
MIXTURE2_LEAN
MIXTURE2_RICH
MIXTURE3_DECR
MIXTURE3_DECR_SMALL
MIXTURE3_INCR
MIXTURE3_INCR_SMALL
MIXTURE3_LEAN
MIXTURE3_RICH
MIXTURE4_DECR
MIXTURE4_DECR_SMALL
MIXTURE4_INCR
MIXTURE4_INCR_SMALL
MIXTURE4_LEAN
MIXTURE4_RICH
MIXTURE_SET
MIXTURE_SET_BEST
MIXTURE1_SET
MIXTURE2_SET
MIXTURE3_SET
MIXTURE4_SET
MOUSE_LOOK_TOGGLE
MP_ACTIVATE_CHAT
MP_BROADCAST_VOICE_CAPTURE_START
MP_BROADCAST_VOICE_CAPTURE_STOP
MP_CHAT
MP_PAUSE_SESSION
MP_PLAYER_CYCLE
MP_PLAYER_FOLLOW
MP_TRANSFER_CONTROL
MP_VOICE_CAPTURE_START
MP_VOICE_CAPTURE_STOP

N

NAV_LIGHTS_OFF
NAV_LIGHTS_ON
NAV_LIGHTS_SET
NAV_RADIO
NAV1_CLOSE_FREQ_SET
NAV1_RADIO_FRACT_DEC
NAV1_RADIO_FRACT_DEC_CARRY
NAV1_RADIO_FRACT_INC
NAV1_RADIO_FRACT_INC_CARRY
NAV1_RADIO_SET
NAV1_RADIO_SET_HZ
NAV1_RADIO_SWAP
NAV1_RADIO_WHOLE_DEC
NAV1_RADIO_WHOLE_INC
NAV1_STBY_SET
NAV1_STBY_SET_HZ
NAV1_VOLUME_DEC
NAV1_VOLUME_INC
NAV1_VOLUME_SET
NAV1_VOLUME_SET_EX1
NAV2_CLOSE_FREQ_SET
NAV2_RADIO_FRACT_DEC
NAV2_RADIO_FRACT_DEC_CARRY
NAV2_RADIO_FRACT_INC
NAV2_RADIO_FRACT_INC_CARRY
NAV2_RADIO_SET
NAV2_RADIO_SET_HZ
NAV2_RADIO_SWAP
NAV2_RADIO_WHOLE_DEC
NAV2_RADIO_WHOLE_INC
NAV2_STBY_SET
NAV2_STBY_SET_HZ
NAV2_VOLUME_DEC
NAV2_VOLUME_INC
NAV2_VOLUME_SET
NAV2_VOLUME_SET_EX1
NAV3_CLOSE_FREQ_SET
NAV3_RADIO_FRACT_DEC
NAV3_RADIO_FRACT_DEC_CARRY
NAV3_RADIO_FRACT_INC
NAV3_RADIO_FRACT_INC_CARRY
NAV3_RADIO_SET
NAV3_RADIO_SET_HZ
NAV3_RADIO_SWAP
NAV3_RADIO_WHOLE_DEC
NAV3_RADIO_WHOLE_INC
NAV3_STBY_SET
NAV3_STBY_SET_HZ
NAV3_VOLUME_DEC
NAV3_VOLUME_INC
NAV3_VOLUME_SET
NAV3_VOLUME_SET_EX1
NAV4_CLOSE_FREQ_SET
NAV4_RADIO_FRACT_DEC
NAV4_RADIO_FRACT_DEC_CARRY
NAV4_RADIO_FRACT_INC
NAV4_RADIO_FRACT_INC_CARRY
NAV4_RADIO_SET
NAV4_RADIO_SET_HZ
NAV4_RADIO_SWAP
NAV4_RADIO_WHOLE_DEC
NAV4_RADIO_WHOLE_INC
NAV4_STBY_SET
NAV4_STBY_SET_HZ
NAV4_VOLUME_DEC
NAV4_VOLUME_INC
NAV4_VOLUME_SET
NAV4_VOLUME_SET_EX1
NEW_MAP
NEW_VIEW
NEXT_SUB_VIEW
NEXT_VIEW
NITROUS_TANK_VALVE_TOGGLE
NOSE_WHEEL_STEERING_LIMIT_SET

O

OVERLAYMENU
OTHER_AIRCRAFT_VIEW
OIL_COOLING_FLAPS_DOWN
OIL_COOLING_FLAPS_SET
OIL_COOLING_FLAPS_TOGGLE
OIL_COOLING_FLAPS_UP

P

R

RADIATOR_COOLING_FLAPS_DOWN
RADIATOR_COOLING_FLAPS_SET
RADIATOR_COOLING_FLAPS_TOGGLE
RADIATOR_COOLING_FLAPS_UP
RADIO_COMM1_AUTOSWITCH_TOGGLE
RADIO_COMM2_AUTOSWITCH_TOGGLE
RADIO_COMMNAV1_TEST_TOGGLE
RADIO_COMMNAV2_TEST_TOGGLE
RADIO_COMMNAV3_TEST_TOGGLE
RADIO_DME1_IDENT_DISABLE
RADIO_DME1_IDENT_ENABLE
RADIO_DME1_IDENT_SET
RADIO_DME1_IDENT_TOGGLE
RADIO_DME2_IDENT_DISABLE
RADIO_DME2_IDENT_ENABLE
RADIO_DME2_IDENT_SET
RADIO_DME2_IDENT_TOGGLE
RADIO_NAV1_AUTOSWITCH_TOGGLE
RADIO_NAV2_AUTOSWITCH_TOGGLE
RADIO_SELECTED_DME_IDENT_ENABLE
RADIO_SELECTED_DME_IDENT_DISABLE
RADIO_SELECTED_DME_IDENT_SET
RADIO_SELECTED_DME_IDENT_TOGGLE
RADIO_VOR1_IDENT_DISABLE
RADIO_VOR1_IDENT_ENABLE
RADIO_VOR1_IDENT_SET
RADIO_VOR1_IDENT_TOGGLE
RADIO_VOR2_IDENT_DISABLE
RADIO_VOR2_IDENT_ENABLE
RADIO_VOR2_IDENT_SET
RADIO_VOR2_IDENT_TOGGLE
RADIO_VOR3_IDENT_DISABLE
RADIO_VOR3_IDENT_ENABLE
RADIO_VOR3_IDENT_SET
RADIO_VOR3_IDENT_TOGGLE
RADIO_VOR4_IDENT_DISABLE
RADIO_VOR4_IDENT_ENABLE
RADIO_VOR4_IDENT_SET
RADIO_VOR4_IDENT_TOGGLE
READOUTS_FLIGHT
READOUTS_SLEW
RECOGNITION_LIGHTS_SET
REFRESH_SCENERY
RELEASE_DROP_TANK_ALL
RELEASE_DROP_TANK_1
RELEASE_DROP_TANK_2
RELEASE_DROPPABLE_OBJECTS
RELOAD_PANELS
RELOAD_USER_AIRCRAFT
REPAIR_AND_REFUEL
REPLAY_STOP
REQUEST_CATERING
REQUEST_FUEL_KEY
REQUEST_LUGGAGE
REQUEST_POWER_SUPPLY
RESET_G_FORCE_INDICATOR
RESET_MAX_RPM_INDICATOR
RETRACT_FLOAT_SWITCH_DEC
RETRACT_FLOAT_SWITCH_INC
ROTOR_AXIS_TAIL_ROTOR_SET
ROTOR_BRAKE
ROTOR_BRAKE_OFF
ROTOR_BRAKE_ON
ROTOR_BRAKE_SET
ROTOR_BRAKE_TOGGLE
ROTOR_CLUTCH_SWITCH_SET
ROTOR_CLUTCH_SWITCH_TOGGLE
ROTOR_GOV_SWITCH_OFF
ROTOR_GOV_SWITCH_ON
ROTOR_GOV_SWITCH_SET
ROTOR_GOV_SWITCH_TOGGLE
ROTOR_LATERAL_TRIM_DEC
ROTOR_LATERAL_TRIM_INC
ROTOR_LATERAL_TRIM_SET
ROTOR_LONGITUDINAL_TRIM_DEC
ROTOR_LONGITUDINAL_TRIM_INC
ROTOR_LONGITUDINAL_TRIM_SET
ROTOR_TRIM_RESET
RPM_SLOT_INDEX_SET

S

SCRIPT_EVENT_1
SCRIPT_EVENT_2
SEE_OWN_AC_OFF
SEE_OWN_AC_ON
SEE_OWN_AC_SET
SEE_OWN_AC_TOGGLE
SELECT_1
SELECT_2
SELECT_3
SELECT_4
SELECT_NEXT_TARGET
SELECT_PREV_TARGET
SET_AUTOBRAKE_CONTROL
SET_DECISION_ALTITUDE_MSL
SET_EXTERNAL_POWER
SET_FUEL_TRANSFER_AFT
SET_FUEL_TRANSFER_AUTO
SET_FUEL_TRANSFER_CUSTOM
SET_FUEL_TRANSFER_FORWARD
SET_FUEL_TRANSFER_OFF
SET_FUEL_VALVE_ENG1
SET_FUEL_VALVE_ENG2
SET_FUEL_VALVE_ENG3
SET_FUEL_VALVE_ENG4
SET_HELO_GOV_BEEP
SET_LAUNCH_BAR_SWITCH
SET_STARTER_ALL_HELD
SET_STARTER1_HELD
SET_STARTER2_HELD
SET_STARTER3_HELD
SET_STARTER4_HELD
SET_TAIL_HOOK_HANDLE
SET_THROTTLE1_REVERSE_THRUST_OFF
SET_THROTTLE2_REVERSE_THRUST_OFF
SET_THROTTLE3_REVERSE_THRUST_OFF
SET_THROTTLE4_REVERSE_THRUST_OFF
SET_THROTTLE1_REVERSE_THRUST_ON
SET_THROTTLE2_REVERSE_THRUST_ON
SET_THROTTLE3_REVERSE_THRUST_ON
SET_THROTTLE4_REVERSE_THRUST_ON
SET_WING_FOLD
SHUTOFF_VALVE_OFF
SHUTOFF_VALVE_ON
SHUTOFF_VALVE_TOGGLE
SIM_RATE
SIM_RATE_DECR
SIM_RATE_INCR
SIM_RATE_SET
SIM_RESET
SIMUI_WINDOW_HIDESHOW
SITUATION_SAVE
SITUATION_RESET
SKIP_ACTION
SKYDIVE_DOORLIGHTS_DEC
SKYDIVE_DOORLIGHTS_GETREADY
SKYDIVE_DOORLIGHTS_INC
SKYDIVE_DOORLIGHTS_JUMP
SKYDIVE_DOORLIGHTS_OFF
SLEW_AHEAD_MINUS
SLEW_AHEAD_PLUS
SLEW_ALTIT_DN_FAST
SLEW_ALTIT_DN_SLOW
SLEW_ALTIT_FREEZE
SLEW_ALTIT_MINUS
SLEW_ALTIT_PLUS
SLEW_ALTIT_UP_FAST
SLEW_ALTIT_UP_SLOW
SLEW_BANK_MINUS
SLEW_BANK_PLUS
SLEW_FREEZE
SLEW_HEADING_MINUS
SLEW_HEADING_PLUS
SLEW_LEFT
SLEW_OFF
SLEW_ON
SLEW_PITCH_DN_FAST
SLEW_PITCH_DN_SLOW
SLEW_PITCH_FREEZE
SLEW_PITCH_MINUS
SLEW_PITCH_PLUS
SLEW_PITCH_UP_FAST
SLEW_PITCH_UP_SLOW
SLEW_RESET
SLEW_RIGHT
SLEW_SET
SLEW_TOGGLE
SLING_PICKUP_RELEASE
SMOKE_OFF
SMOKE_ON
SMOKE_SET
SMOKE_TOGGLE
SNAP_VIEW
SOUND_OFF
SOUND_ON
SOUND_SET
SOUND_TOGGLE
SP_MULTIPLAYER_SCORE_DISPLAY
SPEED_SLOT_INDEX_SET
SPOILERS_ARM_OFF
SPOILERS_ARM_ON
SPOILERS_ARM_SET
SPOILERS_ARM_TOGGLE
SPOILERS_DEC
SPOILERS_INC
SPOILERS_OFF
SPOILERS_ON
SPOILERS_SET
SPOILERS_TOGGLE
SPRAY_OFF
SPRAY_ON
SPRAY_TOGGLE
SPRAY_SET
STARTER_GEN
STARTER_OFF
STARTER_SET
STARTER_START
STARTER1_SET
STARTER2_SET
STARTER3_SET
STARTER4_SET
STEERING_INC
STEERING_DEC
STEERING_SET
STOP_ALL_GUNS
STOP_PRIMARY_GUNS
STOP_SECONDARY_GUNS
STROBES_OFF
STROBES_ON
STROBES_SET
STROBES_TOGGLE
SYNC_FLIGHT_DIRECTOR_PITCH

T

U

UNLOCK_TARGET
USERINTERRUPT

V

W

WAR_EMERGENCY_POWER
WINDOW_TITLES_SET
WINDSHIELD_DEICE_OFF
WINDSHIELD_DEICE_ON
WINDSHIELD_DEICE_SET
WINDSHIELD_DEICE_TOGGLE
WING_LIGHTS_OFF
WING_LIGHTS_ON
WING_LIGHTS_SET

X

XPNDR
XPNDR_1_DEC
XPNDR_10_DEC
XPNDR_100_DEC
XPNDR_1000_DEC
XPNDR_1_INC
XPNDR_10_INC
XPNDR_100_INC
XPNDR_1000_INC
XPNDR_DEC_CARRY
XPNDR_INC_CARRY
XPNDR_IDENT_OFF
XPNDR_IDENT_ON
XPNDR_IDENT_SET
XPNDR_IDENT_TOGGLE
XPNDR_SET

Y

YAW_DAMPER_TOGGLE
YAW_DAMPER_ON
YAW_DAMPER_OFF
YAW_DAMPER_SET
YAXIS_INVERT_TOGGLE

Z

ZOOM_1X
ZOOM_IN
ZOOM_IN_FINE
ZOOM_MINUS
ZOOM_OUT
ZOOM_OUT_FINE
ZOOM_PLUS
ZULU_DAY_SET
ZULU_HOURS_SET
ZULU_MINUTES_SET
ZULU_YEAR_SET

Event ID's As Key Events

Key events permit you to change the state of a component or other aspect of the simulation based on some form of input, which is received from some event. When checking for a key event, you would use the following RPN format:

[0] (>K:[EVENT_ID])
[1] [0] (>K:2:[EVENT_ID])

There are two formats showing for accessing key events because many of them require not just one but two parameters, and so the formatting above shows how this is achieved. Below are two "real world" examples, one with a single parameter and the other with 2 parameters:

1 (>K:TOGGLE_EXTERNAL_POWER)
50 1 (>K:2:PANEL_LIGHTS_POWER_SETTING_SET)