function · ui
list
Records one bounded selectable list with stable row identities.
ui.list(action_id, rows, options?)- Stable ID
ui.list- 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
Compose a scroll-bounded selectable list. Give every row a stable ID so selection remains meaningful when visible labels or detached values change.
Parameters
- action_id: logical action dispatched when a row is selected.
- rows: ordered row tables containing unique id and label fields plus optional value, color, selected, and progress fields.
- options: optional table containing visible_rows.
Returns
No gameplay value. Selecting a row dispatches action_id and the row ID to lifecycle.handle-action.
Cost
The list and each row count against the bounded widget budget; row text counts against the text budget.
Fields
This symbol has no fields.
Errors
- None
Examples
ui.list("ui.action.work.select", {{id = "job:42", label = "Gather timber", value = "Ready", selected = true}}, {visible_rows = 6})API history
- 1.19.0: Added stable selectable lists for Phase 19Q9B.