widget · ui.widget

explain

Full-width wrapped muted explanation paragraph.

ui.explain(text)
Stable ID
ui.widget.explain
Owner
app.ScriptUiWidget
Authority
presentation
Timing
composition
Availability
Phase 19Q9B
Side effects
Records detached presentation intent.
Determinism
Emission order.
Introduced
1.19.0

Usage

Compose this full-width wrapped explanation inside a panel when the player needs the complete reason for a state, decision, or blocker.

Parameters

Returns

A stable widget contract consumed by the interface composition host.

Cost

Counts against the bounded widget and text budgets.

Fields

This symbol has no fields.

Errors

Examples

ui.explain("This villager is resting because fatigue is above the safe work threshold.")

API history

Related symbols

Project references