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
- filters.settlement_id: required stable Settlement identity.
- cursor: optional continuation cursor over options in stable policy-key order.
- page_size: bounded option-row limit.
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
| ID | Type | Units | Required | Description |
|---|---|---|---|---|
available_quantity | unsigned-integer | none | yes | Available supply. |
commitment_status | enumeration | none | yes | Retained commitment lifecycle. |
demand_quantity | unsigned-integer | none | yes | Unsatisfied demand. |
detail | string | none | yes | Direct selection, rejection, or lifecycle detail. |
evaluation_tick | unsigned-integer | fixed-ticks | yes | Fixed tick evaluated. |
kind | enumeration | none | yes | Production or trade commitment. |
owner_id | stable-id-or-null | none | no | Bound domain owner. |
owner_kind | enumeration | none | yes | Production or Trade owner kind. |
owner_revision | revision-or-null | none | no | Bound owner revision. |
policy_key | string | none | yes | Authored enterprise opportunity identity. |
rejection | enumeration | none | yes | Direct rejection or none. |
required_quantity | unsigned-integer | none | yes | Required supply. |
resource_id | stable-id | none | yes | Primary resource identity. |
score | signed-integer | basis-points | yes | Deterministic score. |
selected | boolean | none | yes | Whether Settlement selected this commitment. |
settlement_id | stable-id | none | yes | Settlement identity. |
settlement_revision | revision | none | yes | Current Settlement revision. |
source_settlement_revision | revision | none | yes | Revision evaluated. |
Errors
error.capability-unavailableerror.invalid-queryerror.query-budget-exhaustederror.query-contract-violation
Examples
local options = world.query("world.settlement.enterprise-options", {filters = {settlement_id = 1}, page_size = 16})
API history
- 1.19.0: Retained enterprise selection, authoritative Production and Trade bindings, reconsideration, and direct lifecycle evidence added for Phase 19Q7.