Key Events Index

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. Due to the different ways that gauges and other intruments and controls can be created, every key event has two different aliases:

• Event ID: This is the string that should be used to reference the event when working with RPN.
• Key Name: This is the name that should be used when working with WebAssembly or the SimConnect SDK.

As such, all the key event tables list both of these alias for every key event, although the index below only lists the RPN version. In general, the RPN Event ID is simply the Key Name minus the KEY_ prefix, but this is not always the case and there can be other differences, which is why they are both listed in the tables.

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:

• Aircraft Autopilot/Flight Assist Events
• Aircraft Electrical Events
• Aircraft Engine Events
• Aircraft Flight Control Events
• Aircraft Fuel System Events
• Aircraft General Systems Events
• Aircraft Instrumentation Events
• Aircraft Misc. Events
• Aircraft Radio Navigation Events
• Helicopter Specific Events
• Balloon And Airship Specific Events
• Miscellaneous Events
• View And Camera Events

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:

0 - 9#

A#

B#

C#

D#

E#

F#

G#

H#

I#

J#

K#

L#

M#

N#

O#

P#

Q#

R#

S#

T#

U#

V#

W#

X#

Y#

Z#

Event IDs 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)

Using Indexed Parameter Names#

Many components in the various systems for an aircraft are indexed and also named. In previous version of the simulation, the index was what you would use in in a key event to refer to the component, however with the introduction of modular SimObjects, indices are no longer reliable as they can change as part of the merge process. To make sure you are referencing the correct component now, you you can (and should) use the name of the component, rather than its index (and components should all be unique).

Using the name instead of an index follows this format:

'COMPONENT_NAME'_n

So, for example, using the PANEL_LIGHTS_POWER_SETTING_SET example given above, we would have something like the following:

50 'MyCircuit'_n (>K:2:PANEL_LIGHTS_POWER_SETTING_SET)