action · ui.action.settlement

settlement.open-sheet

Opens the settlement overview sheet.

ui.action.settlement.open-sheet

Stable ID

ui.action.settlement.open-sheet

Owner

controls.ControlState

Authority

presentation

Timing

immediate

Availability

Phase 19Q9D settlement sheet

Side effects

Invokes the package action callback; gameplay requests still use commands.

Determinism

Action identity is stable and independent of physical input.

Introduced

1.9.0

Usage

Open the standard settlement overview using package-owned transient view state.

Parameters

• None

Returns

No gameplay value.

Cost

One bounded package action callback.

Fields

This symbol has no fields.

Errors

• error.invalid-action

Examples

ui.button("Settlement", "ui.action.settlement.open-sheet", "Open settlement overview", 1)

API history

• 1.19.0: Settlement sheet open action added for Phase 19Q9D.

Related symbols

• ui.action.settlement.close-sheet
• ui.layout.sheet

Project references

• Game Development Phase 19
• Engine extension contract
• Source: src/app/script_package_host.cpp