type · ui.layout

dock

Fixed edge dock that may reserve world viewport space.

top | bottom | left | right

Stable ID

ui.layout.dock

Owner

app.ScriptUiDock

Authority

presentation

Timing

composition

Availability

Phase 19Q9A

Side effects

Records detached presentation intent.

Determinism

Declaration order determines edge stacking.

Introduced

1.19.0

Usage

Set panel_contract.dock to one registered edge and panel_contract.thickness to a finite value from 24 through 720 logical pixels. Docked panels are fixed. reserves_space defaults to true and removes the dock area from the world viewport.

Parameters

• None

Returns

A stable type contract consumed by the interface composition host.

Cost

Constant-size validation and declaration-order edge layout.

Fields

This symbol has no fields.

Errors

• None

Examples

ui.begin_panel({id = "status", title = "Status", dock = "top", thickness = 92, semantic_label = "Village status", semantic_role = "status"})

API history

• 1.19.0: Added fixed edge docks and world viewport reservation.

Related symbols

• ui.begin-panel
• ui.layout

Project references

• Game Development Phase 19
• Engine extension contract
• Source: src/app/script_ui_intent.hpp