Global ObjectCore FlowSingleton Global

Events

In-script events: add listeners with Events.on and emit with Events.emit. At most 128 listeners in total and 32 per event.

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

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

When To Use It

Core flow APIs are usually the backbone of larger scenarios; keep them anchored to clear checkpoints and readable variables.

Parameters and Return

Events offers 6 methods; each method page lists its parameters and return value.

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.

Events.on("level_done", function(level) print("cleared " .. level) end)
Events.emit("level_done", 3)

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
Events.on("level_done", function(level) print("cleared " .. level) end)
Events.emit("level_done", 3)

Simple

Wraps the base call with minimal flow control.

Simple
Events.on("level_done", function(level) print("cleared " .. level) end)
Events.emit("level_done", 3)

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow
Events.on("level_done", function(level) print("cleared " .. level) end)
Events.emit("level_done", 3)
local note = "Events overview loaded"
print(note)

Detailed

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

Detailed
-- Core flow APIs are usually the backbone of larger scenarios; keep them anchored to clear checkpoints and readable variables.
local function run_events_step()
  Events.on("level_done", function(level) print("cleared " .. level) end)
  Events.emit("level_done", 3)
end

local ok, err = pcall(run_events_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
Events.on("level_done", function(level) print("cleared " .. level) end)
Events.emit("level_done", 3)
wait(200)
print("Combined with logging and flow control")