query · world.settlement

Settlement environment

Returns current settlement-region weather, ecology, and the resulting routine adaptation.

world.settlement.environment(filters?, cursor?, page_size?) -> query-page

Stable ID: world.settlement.environment
Owner: sim.world-environment, sim.world-ecology, game.actor-routine, and game.household
Authority: read_only
Timing: immediate
Availability: active-session
Side effects: none
Determinism: stable owner order at the current committed tick
Introduced: 1.14.0

Usage

Read the starter settlement region's current weather, ecology, resulting resident adaptation, and retained household disruption without changing owner state.

Parameters

cursor: optional continuation cursor.
page_size: bounded summary-row limit.

Returns

One detached row with region, biome, weather, pressure, resident adaptation, outdoor-work availability, wildlife populations, renewable availability, and stable, disrupted, or recovering household counts.

Cost

One bounded Environment region traversal, Ecology population and renewable-source traversal, and Household traversal.

Fields

ID	Type	Units	Required	Description
`adaptation`	`enumeration`	none	yes	Current resident routine adaptation.
`biome`	`enumeration`	none	yes	Settlement region biome.
`disrupted_households`	`unsigned-integer`	none	yes	Households retaining environmental strain.
`environmental_household_strain`	`unsigned-integer`	basis-points	yes	Environmental strain retained across all households.
`environmental_pressure`	`signed-integer`	pressure-units	yes	Current combined biome, season, and weather pressure.
`grazer_population`	`unsigned-integer`	population-units	yes	Current regional grazer population.
`household_condition`	`enumeration`	none	yes	Current stable, disrupted, or recovering household condition.
`outdoor_work_available`	`boolean`	none	yes	Whether current conditions permit new outdoor work.
`predator_population`	`unsigned-integer`	population-units	yes	Current regional predator population.
`recovering_households`	`unsigned-integer`	none	yes	Households in the bounded safe-weather recovery window.
`region_id`	`stable-id`	none	yes	Settlement region identity.
`renewable_available`	`unsigned-integer`	resource-units	yes	Available renewable resources in the region.
`renewable_capacity`	`unsigned-integer`	resource-units	yes	Renewable resource capacity in the region.
`weather`	`enumeration`	none	yes	Current settlement weather.

Errors

Examples

local conditions = world.query("world.settlement.environment", {page_size = 1})

API history

1.14.0: Weather and regional ecology now explain routine sheltering and resource conservation for Village Life addendum H.
1.15.0: Hazardous weather now records bounded Household disruption and safe-weather recovery for Village Life addendum I.