Object MethodScanning and Detection

Region:find(target, param?)

Searches targets in Region scope and returns a match result.

Detailed Explanation

This section explains when to use the API, how to call it, and which structures it works best with in production flow.

What It Does

Region:find performs one focused job in script flow and can be chained cleanly with other API steps. Searches targets in Region scope and returns a match result.

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. This API becomes most valuable in screen-driven decision scenarios.

Parameters and Return

target, param define the purpose of the call; preparing them in clearly named variables before execution makes production debugging easier. On success it returns a match/result object; when nothing is found it usually resolves to nil or a false-like 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

Snap.screenRefresh()
local region = Region()
local result = region:find(Asset.image("target"))

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

Snap.screenRefresh()
local region = Region()
local result = region:find(Asset.image("target"))

Simple

Wraps the base call with minimal flow control.

Simple

lua

local stepOk = true
Snap.screenRefresh()
local region = Region()
local result = region:find(Asset.image("target"))
if stepOk then
  wait(200)
end

Practical Flow

A practical pattern for real macros with pcall, logging, and guards.

Practical Flow

lua

local ok, result = pcall(function()
  Snap.screenRefresh()
  local region = Region()
  local result = region:find(Asset.image("target"))
end)

if not ok then
  print("API step failed: Region:find")
  requestStop()
end

Detailed

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

Detailed

lua

-- In detection flow, refresh the screen with Snap.screenRefresh() first, then narrow the search area and confidence using Region and FindParam.
local function run_find_step()
  Snap.screenRefresh()
  local region = Region()
  local result = region:find(Asset.image("target"))
end

local ok, err = pcall(run_find_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

Snap.screenRefresh()
local region = Region()
local param = FindParam()
param:timeout(3000)

local result = region:find(Asset.image("target"), param)
if result then
  quickTap(result)
  wait(250)
  toast("Detection step completed")
end