function · ui

stat

Records one compact figure with a caption.

ui.stat(value, label)
Stable ID
ui.stat
Owner
app.ScriptPackageHost
Authority
presentation
Timing
composition
Availability
Phase 14 package callbacks
Side effects
records bounded detached presentation intent
Determinism
Host-created package identity and per-callback budgets.
Introduced
1.19.0

Usage

Append a compact persistent HUD figure with its caption beneath it. Use detached values captured through existing queries.

Parameters

Returns

No gameplay value. The call appends one bounded semantic presentation intent.

Cost

Counts as one widget against the package composition budget.

Fields

This symbol has no fields.

Errors

Examples

ui.stat(tostring(settlement.actor_count), "Residents")

API history

Related symbols

Project references