type · ui.layout

sheet

Centered backdrop panel constrained by a bounded viewport margin.

mode = sheet, margin = logical-pixels

Stable ID

ui.layout.sheet

Owner

app.ScriptUiPanel

Authority

presentation

Timing

composition

Availability

Phase 19Q9D

Side effects

Records detached presentation intent.

Determinism

Resolved from the current reserved world viewport.

Introduced

1.19.0

Usage

Set panel_contract.mode to sheet and provide a finite margin from 32 through 320 logical pixels. The renderer centers the sheet inside the reserved world viewport while leaving fixed docks live.

Parameters

• None

Returns

A stable layout contract consumed by the interface renderer.

Cost

Constant-size validation and viewport-relative layout.

Fields

This symbol has no fields.

Errors

• None

Examples

ui.begin_panel({id = "settlement", title = "Settlement", mode = "sheet", margin = 160, semantic_label = "Settlement overview", semantic_role = "region"})

API history

• 1.19.0: Added centered viewport sheets for Phase 19Q9D.

Related symbols

• ui.begin-panel
• ui.tabs
• ui.layout.dock

Project references

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