Macro Handler

Macro Handler

Android Automation Platform

Global ObjectScanning and DetectionSingleton Global

Result

The match a search such as region:find(...) returns. It is not a global name: check the search result for nil first, then call methods such as getX(), getScore() or getEngine() on 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

Result is not a global name; call its methods with a colon on the Result object a search such as region:find(...) returns (nil when nothing matched).

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

Result offers 11 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 match = Region():find(Asset.image("target"), FindParam.timeout(3000))
if match then
  print(match:getX(), match:getY(), match:getScore())
  click(match)
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 match = Region():find(Asset.image("target"), FindParam.timeout(3000))
if match then
  print(match:getX(), match:getY(), match:getScore())
  click(match)
end

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local match = Region():find(Asset.image("target"), FindParam.timeout(3000))
if match then
  print(match:getX(), match:getY(), match:getScore())
  click(match)
end

-- 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 match = Region():find(Asset.image("target"), FindParam.timeout(3000))
if match then
  print(match:getX(), match:getY(), match:getScore())
  click(match)
end
local note = "Result 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_result_step()
  local match = Region():find(Asset.image("target"), FindParam.timeout(3000))
  if match then
    print(match:getX(), match:getY(), match:getScore())
    click(match)
  end
end

local ok, err = pcall(run_result_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 match = Region():find(Asset.image("target"), FindParam.timeout(3000))
if match then
  print(match:getX(), match:getY(), match:getScore())
  click(match)
end
toast("Detection step completed")