query · world.expedition

Expedition records

Returns bounded ScoutingOrder-owned expedition state with Party, supply, route, and discovery facts.

world.expedition.records(filters?, cursor?, page_size?) -> query-page
Stable ID
world.expedition.records
Owner
game.scouting-order, game.party, and sim.world
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 current scouting orders with Party membership, objective, travel progress, provisions, field condition, destination, and discovery counts.

Parameters

Returns

Detached records composed from ScoutingOrder, Party, and World owners, or unavailable when those owners are absent.

Cost

One bounded scouting-order scan with indexed Party, traveler, and site lookups.

Fields

IDTypeUnitsRequiredDescription
conditionenumerationnoneyesLatest field decision or ready state.
destination_site_idstable-idnoneyesDestination site identity.
destination_x_metersnumbermetersyesDestination World X coordinate.
destination_y_metersnumbermetersyesDestination World Y coordinate.
expedition_idstable-idnoneyesScouting-order identity.
leader_actor_idstable-idnoneyesExpedition leader identity.
member_countunsigned-integernoneyesCurrent Party membership.
objectiveenumerationnoneyesCurrent expedition objective.
party_idstable-idnoneyesExpedition Party identity.
reported_route_countunsigned-integernoneyesDiscovery routes returned.
reported_site_countunsigned-integernoneyesDiscovery sites returned.
revisionrevisionnoneyesScouting-order revision.
stateenumerationnoneyesCurrent expedition state.
supply_unitsunsigned-integerresource-unitsyesConserved departure provisions.
travel_progressunsigned-integerbasis-pointsyesCurrent route-segment progress.
updated_at_tickunsigned-integerticksyesLatest expedition update.

Errors

Examples

local expeditions = world.query("world.expedition.records", {page_size = 16})

API history

Related symbols

Project references