query · world.resource

Known regional resources

Returns bounded renewable-resource reports with their known site and map position.

world.resource.known(filters?, cursor?, page_size?) -> query-page
Stable ID
world.resource.known
Owner
game.observer-knowledge and sim.world-topology
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 observer-known renewable source reports with site, kind, available quantity, capacity, and confidence.

Parameters

Returns

Detached resource-source rows limited to retained observer knowledge.

Cost

One bounded ObserverKnowledge resource scan.

Fields

IDTypeUnitsRequiredDescription
availableunsigned-integerresource-unitsyesReported available quantity.
capacityunsigned-integerresource-unitsyesReported source capacity.
confidenceunsigned-integerbasis-pointsyesReport confidence.
kindenumerationnoneyesReported renewable resource kind.
knowledgeenumerationnoneyesCurrent or stale knowledge state.
site_idstable-idnoneyesReported site identity.
site_x_metersnumbermetersyesReported World X coordinate.
site_y_metersnumbermetersyesReported World Y coordinate.
source_idstable-idnoneyesRenewable source identity.

Errors

Examples

local sources = world.query("world.resource.known", {page_size = 32})

API history

Related symbols

Project references