Object MethodUI and Dialogs

Hud:show()

Displays the Hud view 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

Hud:show performs one focused job in script flow and can be chained cleanly with other API steps. Displays the Hud view on screen.

When To Use It

In dialog and HUD flow, validate user input and complete the sequence with close/dispose steps to keep the UI stable. 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

You can combine it with Setting.builder(), Dialog, Checkbox, EditText, Hud, and Console to build richer operator-facing flows.

Example Usage

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

lua

-- Hud:show
local result = Hud:show()
-- Use the result in your script flow

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

-- Hud:show
local result = Hud:show()
-- Use the result in your script flow

Simple

Wraps the base call with minimal flow control.

Simple

lua

local stepOk = true
-- Hud:show
local result = Hud:show()
-- Use the result in your script flow
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()
  -- Hud:show
  local result = Hud:show()
  -- Use the result in your script flow
end)

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

Detailed

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

Detailed

lua

-- In dialog and HUD flow, validate user input and complete the sequence with close/dispose steps to keep the UI stable.
local function run_show_step()
  -- Hud:show
  local result = Hud:show()
  -- Use the result in your script flow
end

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

local dialog = Setting.builder()
dialog:add("delay", EditText("500", 1, "Delay"))
dialog:add("enabled", Checkbox(true, "Enabled"))
Setting.setDialog(dialog:build())
Setting.show()
-- Hud:show
local result = Hud:show()
-- Use the result in your script flow