action · ui.action.settlement
settlement.placement-begin
Begins placement of the displayed authored settlement project.
ui.action.settlement.placement-begin
- Stable ID
ui.action.settlement.placement-begin- 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
Begin package-owned construction placement for the displayed authored project and close the settlement sheet so the world preview remains visible.
Parameters
- None
Returns
No gameplay value until a separate designation action submits the existing command.
Cost
One bounded package action callback.
Fields
This symbol has no fields.
Errors
Examples
ui.button("Place Project", "ui.action.settlement.placement-begin", "Preview this project", 1)
API history
- 1.19.0: Construction placement mode added for Phase 19Q9E.