Global ObjectScanning and Detection

Snap

Snap manages screen scanning, image matching, and detection flow.

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

Snap is the main entry point for this object family. Use it to understand the responsibility of the namespace before diving into the methods below it. Snap manages screen scanning, image matching, and detection flow.

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

This entry does not require mandatory parameters. This entry is a namespace or helper object overview; the real flow is built with the methods listed below it.

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 r = Region()
local found = r:find(Asset.image("start_btn"))

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 r = Region()
local found = r:find(Asset.image("start_btn"))

Simple

Wraps the base call with minimal flow control.

Simple

lua

Snap.screenRefresh()
local r = Region()
local found = r:find(Asset.image("start_btn"))

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow

lua

Snap.screenRefresh()
local r = Region()
local found = r:find(Asset.image("start_btn"))
local note = "Snap overview loaded"
print(note)

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_snap_step()
  Snap.screenRefresh()
  local r = Region()
  local found = r:find(Asset.image("start_btn"))
end

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