function · ui

select_provider

Requests one declared provider for a replaceable UI surface.

ui.select_provider(surface_id, provider_id)
Stable ID
ui.select-provider
Owner
app.ScriptPackageHost
Authority
presentation
Timing
immediate
Availability
Phase 14 package callbacks
Side effects
records bounded detached presentation intent
Determinism
Host-created package identity and per-callback budgets.
Introduced
1.0.0

Usage

Select a registered provider for a replaceable surface. The compiled recovery surface is not selectable or replaceable.

Parameters

Returns

No value. A valid selection changes the active provider at the host boundary.

Cost

Counts against the package composition instruction and surface work budgets; it does not traverse simulation ownership.

Fields

This symbol has no fields.

Errors

Examples

ui.select_provider("ui.surface.player-hud", "worldforge.standard.player-hud")

API history

Related symbols

Project references