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
- cursor: optional continuation cursor.
- page_size: bounded source-row limit.
Returns
Detached resource-source rows limited to retained observer knowledge.
Cost
One bounded ObserverKnowledge resource scan.
Fields
| ID | Type | Units | Required | Description |
|---|---|---|---|---|
available | unsigned-integer | resource-units | yes | Reported available quantity. |
capacity | unsigned-integer | resource-units | yes | Reported source capacity. |
confidence | unsigned-integer | basis-points | yes | Report confidence. |
kind | enumeration | none | yes | Reported renewable resource kind. |
knowledge | enumeration | none | yes | Current or stale knowledge state. |
site_id | stable-id | none | yes | Reported site identity. |
site_x_meters | number | meters | yes | Reported World X coordinate. |
site_y_meters | number | meters | yes | Reported World Y coordinate. |
source_id | stable-id | none | yes | Renewable source identity. |
Errors
error.capability-unavailableerror.invalid-queryerror.query-budget-exhaustederror.query-contract-violation
Examples
local sources = world.query("world.resource.known", {page_size = 32})
API history
- 1.19.0: Observer-bounded resource reports added for Phase 19Q9F.