function · ui

explain

Records one wrapped full-width explanation paragraph.

ui.explain(text)

Stable ID

ui.explain

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

Show one complete reason as a full-width wrapped paragraph inside the current panel. Use this for decision explanations and blockers that should not be clipped into a key-value row.

Parameters

• text: complete player-facing explanation.

Returns

No gameplay value. The call appends one bounded explanation intent.

Cost

Counts as one widget and its text against the package composition budgets.

Fields

This symbol has no fields.

Errors

• None

Examples

ui.explain("The workshop is waiting for split logs before construction can resume.")

API history

• 1.19.0: Added wrapped explanation paragraphs for Phase 19Q9B.

Related symbols

• ui.widget.explain
• ui.list

Project references

• Game Development Phase 19
• Engine extension contract
• Source: src/app/script_package_host.cpp