Macro Handler

Macro Handler

Android Automation Platform

Global ObjectScanning and DetectionSingleton Global

VisualTarget

Visual target tracking: describe several views of one target with profile, find it on each frame with step, and follow its moving or lost status.

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

VisualTarget is a singleton global table: call its functions with a dot (VisualTarget.<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

VisualTarget offers 7 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 profile = VisualTarget.profile("enemy", { { name = "front", template = Asset.image("enemy_front") } })
local state = VisualTarget.step(profile, Region())
if state.found then VisualTarget.click(profile) 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 profile = VisualTarget.profile("enemy", { { name = "front", template = Asset.image("enemy_front") } })
local state = VisualTarget.step(profile, Region())
if state.found then VisualTarget.click(profile) end

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local profile = VisualTarget.profile("enemy", { { name = "front", template = Asset.image("enemy_front") } })
local state = VisualTarget.step(profile, Region())
if state.found then VisualTarget.click(profile) 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 profile = VisualTarget.profile("enemy", { { name = "front", template = Asset.image("enemy_front") } })
local state = VisualTarget.step(profile, Region())
if state.found then VisualTarget.click(profile) end
local note = "VisualTarget 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_visualtarget_step()
  local profile = VisualTarget.profile("enemy", { { name = "front", template = Asset.image("enemy_front") } })
  local state = VisualTarget.step(profile, Region())
  if state.found then VisualTarget.click(profile) end
end

local ok, err = pcall(run_visualtarget_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 profile = VisualTarget.profile("enemy", { { name = "front", template = Asset.image("enemy_front") } })
local state = VisualTarget.step(profile, Region())
if state.found then VisualTarget.click(profile) end

local target = Region():find(Asset.image("target"), FindParam.timeout(3000))
if target then
  quickTap(target)
end
toast("Detection step completed")