query · world.project

Authored project alternatives

Returns the settlement's authored building alternatives and immutable construction facts without selecting or proposing a project.

world.project.alternatives(filters?, cursor?, page_size?) -> query-page

Stable ID: world.project.alternatives
Owner: game.runtime-settlement-definition and assets.runtime-content-catalog
Authority: read_only
Timing: immediate
Availability: active-session
Side effects: none
Determinism: stable owner order at the current committed tick
Introduced: 1.3.0

Usage

List the active scenario's authored building alternatives in authored order. This query exposes immutable choices but does not propose, score, or select a project.

Parameters

cursor: optional continuation cursor.
page_size: bounded alternative count.

Returns

Detached project alternatives with building identity, name, function, material summary, work requirement, capacity, and footprint size.

Cost

One bounded content-catalog visit per alternative and required material.

Fields

ID	Type	Units	Required	Description
`base_capacity`	`unsigned-integer`	none	yes	Authored base capacity.
`choice_ordinal`	`unsigned-integer`	none	yes	Authored one-based choice order.
`definition_id`	`string`	none	yes	Building definition identity.
`display_name`	`string`	none	yes	Player-facing building name.
`footprint_cells`	`unsigned-integer`	none	yes	Occupied footprint cell count.
`footprint_height_cells`	`unsigned-integer`	World-grid cells	yes	Bounding footprint height.
`footprint_width_cells`	`unsigned-integer`	World-grid cells	yes	Bounding footprint width.
`function`	`enumeration`	none	yes	Building function.
`materials`	`string`	none	yes	Required material summary.
`required_work_units`	`unsigned-integer`	work-units	yes	Required physical work.

Errors

Examples

local projects = world.query("world.project.alternatives", {page_size = 8})

API history

1.3.0: Authored settlement project alternatives exposed for Phase 16D.