Advanced scripting - Built-in variables

Built-in variables are of two types: either they are event-reference variables created when an event occurs, or they are static variables available at all times.

Event reference variables

Event reference variables can be used in actions to reference event values more flexibly than the #value# reference. Event reference variables are prefixed with "@event_" or "@e_" and are set automatically when the events in the command are evaluated.

  • The event reference variables are set according to the first event for each event type.
  • You can only use event reference variables in actions; you cannot set or reference them in events.
  • You can only use event reference variables in commands where the referenced event is present.

Event reference variables are defined for each event on the Events page.

Static variables

Static variables are accessible at all times, no matter which event triggers the command.

Variable

Description

@e_id

Each button and dial is given a unique ID by the Stream Deck software. This ID is a GUID in the format e10e5eb2-0df2-4104-9bfa-acddda7db364.

@e_row
@e_column

These variables indicate the position of the button or dial. The bottom left position on a device is at row 0, column 0.

Important! Actions in a Multi Action do not have any position data because the Stream Deck software does not provide it. In such cases, row=-1, and column=-1.