Global ObjectScanning and DetectionSingleton Global

AssetTemplate

The search template Asset.image/color/text returns. It is not a global name; its methods chain and return the template (for example Asset.image("x"):mScore(0.9):gray()).

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

AssetTemplate is not a global name; call its methods with a colon on a template from Asset.image(...), Asset.color(...) or Asset.text(...).

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

AssetTemplate offers 21 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.

local template = Asset.image("target"):mScore(0.9):gray()
local match = Region():find(template)

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
local template = Asset.image("target"):mScore(0.9):gray()
local match = Region():find(template)

Simple

Wraps the base call with minimal flow control.

Simple
local template = Asset.image("target"):mScore(0.9):gray()
local match = Region():find(template)

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow
local template = Asset.image("target"):mScore(0.9):gray()
local match = Region():find(template)
local note = "AssetTemplate overview loaded"
print(note)

Detailed

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

Detailed
-- In detection flow, refresh the screen with Snap.screenRefresh() first, then narrow the search area and confidence using Region and FindParam.
local function run_assettemplate_step()
  local template = Asset.image("target"):mScore(0.9):gray()
  local match = Region():find(template)
end

local ok, err = pcall(run_assettemplate_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
Snap.screenRefresh()
local template = Asset.image("target"):mScore(0.9):gray()
local match = Region():find(template)
toast("Detection step completed")