Global ObjectUI and Dialogs

Hud

Hud is used to build dialogs, settings, or HUD overlays.

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 is the main entry point for this object family. Use it to understand the responsibility of the namespace before diving into the methods below it. Hud is used to build dialogs, settings, or HUD overlays.

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 entry is a namespace or helper object overview; the real flow is built with the methods listed below it.

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

local hud = Hud(10, 10, 200, 50, true)
hud:setText("Running")
hud:setTextColor("#FFFFFF")
hud:setBackgroundColor("#80000000")
hud:show()

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

local hud = Hud(10, 10, 200, 50, true)
hud:setText("Running")
hud:setTextColor("#FFFFFF")
hud:setBackgroundColor("#80000000")
hud:show()

Simple

Wraps the base call with minimal flow control.

Simple

lua

local hud = Hud(10, 10, 200, 50, true)
hud:setText("Running")
hud:setTextColor("#FFFFFF")
hud:setBackgroundColor("#80000000")
hud:show()

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow

lua

local hud = Hud(10, 10, 200, 50, true)
hud:setText("Running")
hud:setTextColor("#FFFFFF")
hud:setBackgroundColor("#80000000")
hud:show()
local note = "Hud overview loaded"
print(note)

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_hud_step()
  local hud = Hud(10, 10, 200, 50, true)
  hud:setText("Running")
  hud:setTextColor("#FFFFFF")
  hud:setBackgroundColor("#80000000")
  hud:show()
end

local ok, err = pcall(run_hud_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()
local hud = Hud(10, 10, 200, 50, true)
hud:setText("Running")
hud:setTextColor("#FFFFFF")
hud:setBackgroundColor("#80000000")
hud:show()