function · ui
tabs
Records one bounded tab strip before a panel's widgets.
ui.tabs(action_id, labels, active_index)- Stable ID
ui.tabs- 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
Declare one bounded tab strip before the first widget in an open panel. Lua retains the active tab and receives the selected label as row_id.
Parameters
- action_id: logical action dispatched on selection.
- labels: two through eight unique non-empty labels.
- active_index: one-based index of the active label.
Returns
No gameplay value. The call appends detached tab presentation intent.
Cost
Every tab counts against the widget budget and its label counts against the text budget.
Fields
This symbol has no fields.
Errors
- None
Examples
ui.tabs("ui.action.settlement.select-tab", {"Production", "Buildings"}, 1)API history
- 1.19.0: Added bounded tab strips for Phase 19Q9D.