query · world.settlement

Settlement housing executions

Returns the bounded Settlement-owned lifecycle that binds a selected housing method to its Household and authoritative Construction or completed Building outcome.

world.settlement.housing-executions(filters?, cursor?, page_size?) -> query-page
Stable ID
world.settlement.housing-executions
Owner
game.settlement
Authority
read_only
Timing
immediate
Availability
active-session
Side effects
none
Determinism
stable owner order at the current committed tick
Introduced
1.19.0

Usage

Inspect the bounded Settlement-owned lifecycle that binds a selected housing method to one Household and the authoritative Construction or completed Building outcome. Supply settlement_id and optionally household_id. The query cannot start, advance, cancel, or mutate housing work.

Parameters

Returns

Detached execution rows with stable identity, selected method and optional parcel keys, Household, method, target Building, building definition, Construction, resulting Building, lifecycle, source evaluation ticks, source Household revision, latest owner revision, explanation, and creation and update ticks.

Cost

One exact Settlement lookup plus one bounded traversal of the retained execution ledger in stable identity order. Runtime starts and reconciliation use separate authored visit and mutation budgets.

Fields

IDTypeUnitsRequiredDescription
building_definition_idstringnoneyesBuilding definition used.
construction_idstable-id-or-nullnonenoBound Construction identity.
created_at_tickunsigned-integerfixed-ticksyesExecution creation tick.
detailstringnoneyesDirect lifecycle or blocker explanation.
execution_idstable-idnoneyesDurable housing execution identity.
household_idstable-idnoneyesDestination Household identity.
methodenumerationnoneyesSelected housing method.
method_option_keystringnoneyesSelected housing-method identity.
owner_revisionrevisionnoneyesLatest authoritative outcome revision.
parcel_option_keystring-or-nullnonenoSelected parcel identity.
resulting_building_idstable-id-or-nullnonenoCompleted Building identity.
settlement_idstable-idnoneyesSettlement identity.
settlement_revisionrevisionnoneyesCurrent Settlement owner revision.
source_household_revisionrevisionnoneyesHousehold revision selected.
source_method_evaluation_tickunsigned-integerfixed-ticksyesHousing-method evaluation used.
source_parcel_evaluation_tickunsigned-integerfixed-ticksyesParcel evaluation used, or zero for methods without parcels.
statusenumerationnoneyesActive, completed, blocked, cancelled, or failed.
target_building_idstable-id-or-nullnonenoExisting target Building.
updated_at_tickunsigned-integerfixed-ticksyesLatest lifecycle update tick.

Errors

Examples

local executions = world.query("world.settlement.housing-executions", {filters = {settlement_id = 1}, page_size = 16})
for _, execution in ipairs(executions.records) do
    ui.text(execution.method, execution.status .. ": " .. execution.detail)
end

API history

Related symbols

Project references