Macro Handler

Macro Handler

Android Automation Platform

Object MethodCore Flow

Events.once(eventName, handler)

Adds a listener that runs once and returns its id.

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 global table: call its functions with a dot (Events.<method>(...)), not a colon.

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

Required: eventName, handler. Returns a number.

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.

lua
Try in Editor →
local result = Events.once("level_done", function(payload) print(payload) 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
lua
Try in Editor →
local result = Events.once("level_done", function(payload) print(payload) end)

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local result = Events.once("level_done", function(payload) print(payload) end)
if stepOk then
  wait(200)
end

Practical Flow

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

Practical Flow
lua
Try in Editor →
local ok, err = pcall(function()
  local result = Events.once("level_done", function(payload) print(payload) end)
end)

if not ok then
  print("API step failed: Events.once: " .. tostring(err))
  requestStop()
end

Detailed

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

Detailed
lua
Try in Editor →
-- Core flow APIs are usually the backbone of larger scenarios; keep them anchored to clear checkpoints and readable variables.
local function run_once_step()
  local result = Events.once("level_done", function(payload) print(payload) end)
end

local ok, err = pcall(run_once_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
lua
Try in Editor →
local result = Events.once("level_done", function(payload) print(payload) end)
wait(200)
print("Combined with logging and flow control")