Global ObjectSystem ControlSingleton Global

Event

Information about the trigger that started this run (source, app, title, text, time). Event.exists() tells whether the run was started by a trigger.

Documented for app version 1.0.51Updated:

Detailed Explanation

This section explains when to use the API, how to call it, and which structures it works best with in production flow.

How To Call It

Event is a singleton global table: call its functions with a dot (Event.<method>(...)).

When To Use It

In system flow, design steps as observe first and act second when the API can affect device state.

Parameters and Return

Event offers 11 methods; each method page lists its parameters and return value.

Options and Limits

Rate limit: Event calls are limited to 30 per second; past the limit the call raises an error.

Best Combined With

Using this API with logging, error handling, and next-step control produces much more professional results than calling it in isolation.

Example Usage

The snippet below is a starter pattern that can be applied directly in runtime flow.

if Event.exists() then
  print(Event.appName() .. ": " .. Event.title())
end

Copyable Progressive Examples

From foundation to combined usage, each level is provided as a separate code block so you can copy the level you need and adapt it directly.

Foundation

Shows the shortest direct way to call the API.

Foundation
if Event.exists() then
  print(Event.appName() .. ": " .. Event.title())
end

Simple

Wraps the base call with minimal flow control.

Simple
if Event.exists() then
  print(Event.appName() .. ": " .. Event.title())
end

-- Continue with one focused method on the object.

Practical Flow

A practical pattern for real macros with pcall, logging, and guards.

Practical Flow
if Event.exists() then
  print(Event.appName() .. ": " .. Event.title())
end
local note = "Event overview loaded"
print(note)

Detailed

This level packages the API into a reusable helper with error reporting.

Detailed
-- In system flow, design steps as observe first and act second when the API can affect device state.
local function run_event_step()
  if Event.exists() then
    print(Event.appName() .. ": " .. Event.title())
  end
end

local ok, err = pcall(run_event_step)
if not ok then
  toast("Step failed")
  print(err)
end

Combined

Combines the API with related structures to form a more realistic workflow.

Combined
if Event.exists() then
  print(Event.appName() .. ": " .. Event.title())
end
wait(200)
print("Combined with logging and flow control")