query · world.settlement

Settlement enterprise options

Returns the latest Settlement-owned production and trade portfolio, direct viability evidence, selection, and authoritative commitment lifecycle.

world.settlement.enterprise-options(filters?, cursor?, page_size?) -> query-page
Stable ID
world.settlement.enterprise-options
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 Settlement-owned enterprise portfolio that selects and reconsiders real production and trade commitments. The query is detached and cannot create, advance, cancel, or replace a domain owner.

Parameters

Returns

Detached production and trade rows with current supply, demand, score, rejection, selection, and the exact Production order or Trade shipment identity, revision, and retained commitment lifecycle when bound.

Cost

One exact Settlement lookup plus one bounded traversal of the latest retained enterprise portfolio. Recurring assessment, execution, reconciliation, and cancellation use authored cadence, visit, selection, and mutation budgets.

Fields

IDTypeUnitsRequiredDescription
available_quantityunsigned-integernoneyesAvailable supply.
commitment_statusenumerationnoneyesRetained commitment lifecycle.
demand_quantityunsigned-integernoneyesUnsatisfied demand.
detailstringnoneyesDirect selection, rejection, or lifecycle detail.
evaluation_tickunsigned-integerfixed-ticksyesFixed tick evaluated.
kindenumerationnoneyesProduction or trade commitment.
owner_idstable-id-or-nullnonenoBound domain owner.
owner_kindenumerationnoneyesProduction or Trade owner kind.
owner_revisionrevision-or-nullnonenoBound owner revision.
policy_keystringnoneyesAuthored enterprise opportunity identity.
rejectionenumerationnoneyesDirect rejection or none.
required_quantityunsigned-integernoneyesRequired supply.
resource_idstable-idnoneyesPrimary resource identity.
scoresigned-integerbasis-pointsyesDeterministic score.
selectedbooleannoneyesWhether Settlement selected this commitment.
settlement_idstable-idnoneyesSettlement identity.
settlement_revisionrevisionnoneyesCurrent Settlement revision.
source_settlement_revisionrevisionnoneyesRevision evaluated.

Errors

Examples

local options = world.query("world.settlement.enterprise-options", {filters = {settlement_id = 1}, page_size = 16})

API history

Related symbols

Project references