query · world.route

Known regional routes

Returns the observer's bounded route knowledge with topology endpoints and current reported confidence, pressure, and danger.

world.route.known(filters?, cursor?, page_size?) -> query-page
Stable ID
world.route.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 discovered route segments with observer knowledge state, endpoints, coordinates, pressure, and danger for regional presentation.

Parameters

Returns

Detached route rows limited to the observer's current or stale knowledge.

Cost

One bounded ObserverKnowledge scan and indexed topology lookups.

Fields

IDTypeUnitsRequiredDescription
confidenceunsigned-integer-or-nullbasis-pointsnoLatest report confidence.
dangersigned-integer-or-nulldanger-unitsnoLatest reported route danger.
evaluated_at_tickunsigned-integerticksyesKnowledge evaluation tick.
from_site_idstable-idnoneyesOrigin site identity.
from_x_metersnumbermetersyesOrigin World X coordinate.
from_y_metersnumbermetersyesOrigin World Y coordinate.
knowledgeenumerationnoneyesUnknown, discovered, current, or stale state.
pressuresigned-integer-or-nullpressure-unitsnoLatest reported route pressure.
route_idstable-idnoneyesContaining route identity.
segment_idstable-idnoneyesRoute-segment identity.
to_site_idstable-idnoneyesDestination site identity.
to_x_metersnumbermetersyesDestination World X coordinate.
to_y_metersnumbermetersyesDestination World Y coordinate.

Errors

Examples

local routes = world.query("world.route.known", {page_size = 32})

API history

Related symbols

Project references