Global FunctionCore Flow

requestStop()

Requests a graceful stop for the current macro.

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

requestStop() performs one focused job in script flow and can be chained cleanly with other API steps. Requests a graceful stop for the current macro.

When To Use It

Core flow APIs are usually the backbone of larger scenarios; keep them anchored to clear checkpoints and readable variables. This API becomes most valuable in multi-step chained scenarios.

Parameters and Return

This entry does not require mandatory parameters. This API is primarily side-effect driven; the important result is the device state change rather than the raw return value.

Best Combined With

Using this API with logging, error handling, and next-step control produces much more professional results than calling it in isolation.

Example Usage

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

lua

if not License.isValid() then
  requestStop()
end

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

if not License.isValid() then
  requestStop()
end

Simple

Wraps the base call with minimal flow control.

Simple

lua

local stepOk = true
if not License.isValid() then
  requestStop()
end
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()
  if not License.isValid() then
    requestStop()
  end
end)

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

Detailed

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

Detailed

lua

-- Core flow APIs are usually the backbone of larger scenarios; keep them anchored to clear checkpoints and readable variables.
local function run_requeststop_step()
  if not License.isValid() then
    requestStop()
  end
end

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

if not License.isValid() then
  requestStop()
end
wait(200)
print("Combined with logging and flow control")