query · world.region

Known regions

Returns the observer's bounded current or stale regional environment reports.

world.region.known(filters?, cursor?, page_size?) -> query-page
Stable ID
world.region.known
Owner
game.observer-knowledge
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

Read discovered regions with knowledge confidence, biome, weather, and environmental pressure for the Empire view.

Parameters

Returns

Detached region rows limited to retained observer reports.

Cost

One bounded ObserverKnowledge scan and indexed World environment lookups.

Fields

IDTypeUnitsRequiredDescription
biomeenumerationnoneyesReported regional biome.
confidenceunsigned-integerbasis-pointsyesReport confidence.
environmental_pressuresigned-integerpressure-unitsyesReported environmental pressure.
knowledgeenumerationnoneyesCurrent or stale knowledge state.
observed_at_tickunsigned-integerticksyesSource observation tick.
region_idstable-idnoneyesRegion identity.
weatherenumerationnoneyesReported regional weather.

Errors

Examples

local regions = world.query("world.region.known", {page_size = 16})

API history

Related symbols

Project references