Macro Handler

Macro Handler

Android Automation Platform

Global ObjectUI and DialogsFactory Global

Hud(x, y, w, h, clickable)

A floating info box on screen. Hud(x, y, w, h, clickable) creates a Hud object; text and style methods are called on that object, and Hud.off() closes every box.

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

Hud is a callable factory table: object methods are called as hud:<method>(...), and the table’s own functions as Hud.<method>(...).

When To Use It

In dialog and HUD flow, validate user input and complete the sequence with close/dispose steps to keep the UI stable.

Parameters and Return

Hud offers 37 methods; each method page lists its parameters and return value.

Best Combined With

You can combine it with Setting.builder(), Dialog, Checkbox, EditText, Hud, and Console to build richer operator-facing flows.

Example Usage

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

lua
Try in Editor →
local hud = Hud(20, 20, 320, 64, false)
hud:setText("Running")
hud:setTextColor("#FFFFFF")
hud:setBackgroundColor("#80000000")
hud:show()

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 hud = Hud(20, 20, 320, 64, false)
hud:setText("Running")
hud:setTextColor("#FFFFFF")
hud:setBackgroundColor("#80000000")
hud:show()

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local hud = Hud(20, 20, 320, 64, false)
hud:setText("Running")
hud:setTextColor("#FFFFFF")
hud:setBackgroundColor("#80000000")
hud:show()

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow
lua
Try in Editor →
local hud = Hud(20, 20, 320, 64, false)
hud:setText("Running")
hud:setTextColor("#FFFFFF")
hud:setBackgroundColor("#80000000")
hud:show()
local note = "Hud overview loaded"
print(note)

Detailed

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

Detailed
lua
Try in Editor →
-- In dialog and HUD flow, validate user input and complete the sequence with close/dispose steps to keep the UI stable.
local function run_hud_step()
  local hud = Hud(20, 20, 320, 64, false)
  hud:setText("Running")
  hud:setTextColor("#FFFFFF")
  hud:setBackgroundColor("#80000000")
  hud:show()
end

local ok, err = pcall(run_hud_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 dialog = Setting.builder()
dialog:add("delay", EditText("500", 1, "Delay"))
dialog:add("enabled", Checkbox(true, "Enabled"))
Setting.setDialog(dialog:build())
Setting.show()
local hud = Hud(20, 20, 320, 64, false)
hud:setText("Running")
hud:setTextColor("#FFFFFF")
hud:setBackgroundColor("#80000000")
hud:show()