Object MethodParameter Objects

Tune.grayscaleOn()

From Macro Handler 1.0.51, switches this run’s default (Balanced) image searches to the colour-independent Grayscale engine, as if every template used :gray(); the automatic colour check is skipped. Earlier versions ignore the call. Returns true.

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

Tune is a global table: call its functions with a dot (Tune.<method>(...)), not a colon. From Macro Handler 1.0.51, Tune.grayscaleOn() performs a real colour-independent search; earlier versions ignored it.

When To Use It

Parameter objects work best when prepared in a dedicated variable and reused across search or action calls.

Parameters and Return

Takes no arguments. Returns a boolean (true or false).

Best Combined With

This object is mostly used to prepare input for action APIs such as Region searches, click(), swipe() and Replay playback.

Example Usage

The snippet below is a starter pattern that can be applied directly in runtime flow.

Tune.grayscaleOn()
local match = Region():find(Asset.image("enemy_icon"))
Tune.grayscaleOff()

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
Tune.grayscaleOn()
local match = Region():find(Asset.image("enemy_icon"))
Tune.grayscaleOff()

Simple

Wraps the base call with minimal flow control.

Simple
local stepOk = true
Tune.grayscaleOn()
local match = Region():find(Asset.image("enemy_icon"))
Tune.grayscaleOff()
if stepOk then
  wait(200)
end

Practical Flow

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

Practical Flow
local ok, err = pcall(function()
  Tune.grayscaleOn()
  local match = Region():find(Asset.image("enemy_icon"))
  Tune.grayscaleOff()
end)

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

Detailed

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

Detailed
-- Parameter objects work best when prepared in a dedicated variable and reused across search or action calls.
local function run_grayscaleon_step()
  Tune.grayscaleOn()
  local match = Region():find(Asset.image("enemy_icon"))
  Tune.grayscaleOff()
end

local ok, err = pcall(run_grayscaleon_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
Tune.grayscaleOn()
local match = Region():find(Asset.image("enemy_icon"))
Tune.grayscaleOff()
wait(200)
print("Combined with logging and flow control")