Macro Handler

Macro Handler

Android Automation Platform

Global ObjectScanning and DetectionSingleton Global

Asset

Creates search templates: Asset.image(name), Asset.color(hex) and Asset.text(text) return a template (AssetTemplate) you tune with methods such as :mScore() and :gray().

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

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

When To Use It

In detection flow, refresh the screen with Snap.screenRefresh() first, then narrow the search area and confidence using Region and FindParam.

Parameters and Return

Asset offers 9 methods; each method page lists its parameters and return value.

Best Combined With

It is typically combined with Snap, Region, Asset, and FindParam; you can feed the result into quickTap(), click(), or a follow-up OCR step.

Example Usage

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

lua
Try in Editor →
local template = Asset.image("play_button"):mScore(0.85)
local region = Region()
local match = region:find(template)

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 template = Asset.image("play_button"):mScore(0.85)
local region = Region()
local match = region:find(template)

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local template = Asset.image("play_button"):mScore(0.85)
local region = Region()
local match = region:find(template)

-- 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 template = Asset.image("play_button"):mScore(0.85)
local region = Region()
local match = region:find(template)
local note = "Asset overview loaded"
print(note)

Detailed

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

Detailed
lua
Try in Editor →
-- In detection flow, refresh the screen with Snap.screenRefresh() first, then narrow the search area and confidence using Region and FindParam.
local function run_asset_step()
  local template = Asset.image("play_button"):mScore(0.85)
  local region = Region()
  local match = region:find(template)
end

local ok, err = pcall(run_asset_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 →
Snap.screenRefresh()
local template = Asset.image("play_button"):mScore(0.85)
local region = Region()
local match = region:find(template)
toast("Detection step completed")