Macro Handler

Macro Handler

Android Automation Platform

Object MethodScanning and Detection

VisualTarget.refresh(previous, name, views, options?)

Rebuilds the profile with new name, views or options; the tracked state is kept when the stateKey is unchanged.

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 global table: call its functions with a dot (VisualTarget.<method>(...)), not a colon.

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

Required: previous, name, views. Optional: options (omit to pass nil and use the runtime default). Returns a Lua table.

Options and Limits

profile(name, views, options): views holds 1-32 views; each view is { name, template } or { name, matcher = function } with an optional findParam. Options: engine (default "hybrid"), acquireThreshold (0-1, default 0.82), retainThreshold (at most acquireThreshold, default 0.72), maxDriftPx (default 160), lostFrameLimit (1-120, default 4), reacquire (default true), movementThresholdPx (default 4), stillFrameLimit (1-120, default 3), adaptiveScan (default true), maxCandidatesPerView (1-16, default 8), findParam and stateKey. step returns a copy of the state: found, status ("acquired", "tracking", "moving", "still", "reacquired", "searching", "lost" or "error"), x, y, w, h, centerX, centerY, score, viewIndex, viewName, velocityX, velocityY, moving and lostFrames.

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 result = VisualTarget.refresh(profile, "enemy", { { name = "front", template = Asset.image("enemy_front") } })

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 result = VisualTarget.refresh(profile, "enemy", { { name = "front", template = Asset.image("enemy_front") } })

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local profile = VisualTarget.profile("enemy", { { name = "front", template = Asset.image("enemy_front") } })
local result = VisualTarget.refresh(profile, "enemy", { { name = "front", template = Asset.image("enemy_front") } })
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 profile = VisualTarget.profile("enemy", { { name = "front", template = Asset.image("enemy_front") } })
  local result = VisualTarget.refresh(profile, "enemy", { { name = "front", template = Asset.image("enemy_front") } })
end)

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

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_refresh_step()
  local profile = VisualTarget.profile("enemy", { { name = "front", template = Asset.image("enemy_front") } })
  local result = VisualTarget.refresh(profile, "enemy", { { name = "front", template = Asset.image("enemy_front") } })
end

local ok, err = pcall(run_refresh_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 →
-- Follow a moving target and tap it while it is visible
local profile = VisualTarget.profile("enemy", {
  { name = "front", template = Asset.image("enemy_front") },
  { name = "side", template = Asset.image("enemy_side") },
}, { acquireThreshold = 0.85 })
local area = Region()
for frame = 1, 20 do
  local state = VisualTarget.step(profile, area)
  if state.found and state.status ~= "moving" then
    VisualTarget.click(profile)
  elseif state.status == "lost" then
    break
  end
  wait(150)
end