command · command.construction

Designate construction

Designates one authored building on the World grid through Settlement and Construction.

command.construction.designate(settlement_id, expected_settlement_revision, definition_id, origin_x, origin_y, orientation) -> command.receipt

Stable ID: command.construction.designate
Owner: game.construction
Authority: request
Timing: fixed_tick
Availability: active-session
Side effects: may create one validated construction project and its normal Work
Determinism: record request and owner result in engine sequence order
Introduced: 1.5.0

Usage

Submit an authored building alternative, current Settlement revision, and World-grid placement. Settlement, content, Construction, Work, Resource, and capacity checks run before one project commits.

Parameters

settlement_id: current Settlement identity.
expected_settlement_revision: current Settlement revision.
definition_id: authored building definition.
origin_x: signed World-grid X cell.
origin_y: signed World-grid Y cell.
orientation: north, east, south, or west as zero through three.

Returns

A fixed-tick command receipt. Rejection retains no partial project.

Cost

Bounded catalog, footprint, Settlement, Resource, Construction, and Work validation.

Fields

ID	Type	Units	Required	Description
`definition_id`	`string`	none	yes	Authored building definition identity.
`expected_settlement_revision`	`revision`	none	yes	Expected Settlement revision.
`orientation`	`unsigned-integer`	none	yes	North, east, south, or west as zero through three.
`origin_x`	`signed-integer`	grid-cells	yes	World-grid X coordinate.
`origin_y`	`signed-integer`	grid-cells	yes	World-grid Y coordinate.
`settlement_id`	`stable-id`	none	yes	Settlement receiving the construction.

Errors

Examples

command.submit("command.construction.designate", {settlement_id = settlement.settlement_id, expected_settlement_revision = settlement.revision, definition_id = project.definition_id, origin_x = cursor.x, origin_y = cursor.y, orientation = 0}, 1)

API history

1.5.0: Revision-checked building designation added for Phase 16D.