action · ui.action.settlement

settlement.placement-cancel

Cancels the current construction placement preview.

ui.action.settlement.placement-cancel

Stable ID

ui.action.settlement.placement-cancel

Owner

controls.ControlState

Authority

presentation

Timing

immediate

Availability

Phase 19Q9E spatial interface

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

Cancel package-owned construction placement and clear the detached ghost without submitting a gameplay command.

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("Cancel", "ui.action.settlement.placement-cancel", "Cancel placement", 1)

API history

• 1.19.0: Placement cancellation added for Phase 19Q9E.

Related symbols

• ui.action.settlement.placement-begin
• ui.intent.ghost

Project references

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