function · ui

begin_panel

Begins one bounded backend-neutral semantic panel.

ui.begin_panel(panel_contract)

Stable ID: ui.begin-panel
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.0.0

Usage

Call during composition to append validated semantic presentation state. The panel ID must be unique and stable inside the calling package; the host combines package and local IDs for backend window identity. Floating panels may be movable. A docked panel names one fixed edge and may reserve that space from the world viewport. This function cannot mutate simulation owners.

Parameters

panel_contract: table containing stable id, title, semantic metadata, and either anchored floating geometry or dock, thickness, and optional reserves_space fields.

Returns

No gameplay value. The call appends or updates semantic presentation state for the current composition pass.

Cost

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

Fields

This symbol has no fields.

Errors

None

Examples

ui.begin_panel({id = "addon.status", title = "Status", anchor = "top-right", x = 24, y = 72, width = 300, height = 180, movable = true, semantic_label = "Addon status", semantic_role = "status"})