Global FunctionCore Flow

toast(message)

Shows in-app runtime messages on screen.

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

toast(message) performs one focused job in script flow and can be chained cleanly with other API steps. Shows in-app runtime messages on screen.

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

message define the purpose of the call; preparing them in clearly named variables before execution makes production debugging easier. The safest usage pattern is to store the call result in a variable, wrap it with pcall, and pass it into later steps in a controlled way.

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

toast("Macro started")

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

toast("Macro started")

Simple

Wraps the base call with minimal flow control.

Simple

lua

local stepOk = true
toast("Macro started")
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()
  toast("Macro started")
end)

if not ok then
  print("API step failed: toast(message)")
  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_toast_step()
  toast("Macro started")
end

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

toast("Macro started")
wait(200)
print("Combined with logging and flow control")