Macro Handler

Macro Handler

Android Automation Platform

Global ObjectTouch and ActionsSingleton GlobalComing soonv1.0.51

Navigation

Steers a joystick along a saved map and route. Navigation.run(options, onCheckpoint?) owns the control loop and returns a table describing how the run ended; Navigation.stop() ends the journey from an observation group after confirmed input release.

Documented for app version 1.0.51 (not on Google Play yet)Updated:

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

Navigation is a singleton global table: call its functions with a dot (Navigation.<method>(...)). Requires Macro Handler 1.0.51 or later.

When To Use It

In automation flow, chain actions with short wait() intervals and use requestStop() or controlled retry on failure paths.

Parameters and Return

Navigation offers 2 methods; each method page lists its parameters and return value.

Best Combined With

It works best together with wait(), Point, SwipeParam, ClickParam, and sometimes a Region result.

Example Usage

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

lua
Try in Editor →
local result = Navigation.run({ profileId = profileId, routeId = routeId, routeType = "one_way", timeoutMs = 120000 })
print(result.state, result.progress)

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 result = Navigation.run({ profileId = profileId, routeId = routeId, routeType = "one_way", timeoutMs = 120000 })
print(result.state, result.progress)

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local result = Navigation.run({ profileId = profileId, routeId = routeId, routeType = "one_way", timeoutMs = 120000 })
print(result.state, result.progress)

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow
lua
Try in Editor →
local result = Navigation.run({ profileId = profileId, routeId = routeId, routeType = "one_way", timeoutMs = 120000 })
print(result.state, result.progress)
local note = "Navigation overview loaded"
print(note)

Detailed

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

Detailed
lua
Try in Editor →
-- In automation flow, chain actions with short wait() intervals and use requestStop() or controlled retry on failure paths.
local function run_navigation_step()
  local result = Navigation.run({ profileId = profileId, routeId = routeId, routeType = "one_way", timeoutMs = 120000 })
  print(result.state, result.progress)
end

local ok, err = pcall(run_navigation_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 →
local target = Point(540, 960)
quickTap(target)
wait(250)
local result = Navigation.run({ profileId = profileId, routeId = routeId, routeType = "one_way", timeoutMs = 120000 })
print(result.state, result.progress)
wait(250)
print("Automation chain completed")