Macro Handler

Macro Handler

Android Automation Platform

Object MethodUI and Dialogs

Hud:setBackgroundImage(value)

Shows one of the macro’s images as the background, by the name Asset.image takes; the image replaces the background colour, border and corners. An empty string removes it.

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

This is an object method: call it with a colon on a Hud object created with Hud(x, y, w, h, clickable) (hud:<method>(...)). The global Hud table does not have this 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

Required: value. Returns nothing.

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:setBackgroundImage("hud_background")

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:setBackgroundImage("hud_background")

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local hud = Hud(20, 20, 320, 64, false)
hud:setBackgroundImage("hud_background")
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 hud = Hud(20, 20, 320, 64, false)
  hud:setBackgroundImage("hud_background")
end)

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

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_setbackgroundimage_step()
  local hud = Hud(20, 20, 320, 64, false)
  hud:setBackgroundImage("hud_background")
end

local ok, err = pcall(run_setbackgroundimage_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:setBackgroundImage("hud_background")