Skip to content

VehicleRef

Read-only ground-vehicle snapshot. Returned by: fleet.vehicles()

MemberReturnsMeaning
.categorystringAlways "vehicle"
.idstringStable component id; use with get_component(id) or charging_station.dispatch_rescue(id)
.namestringDisplay name at snapshot time
.kindstring"rover" or "pioneer"
.statusstringSame value set as Rover/Pioneer .status() at snapshot time
.x / .y / .position()number / PositionCoordinates at snapshot time
.battery_level / .battery_wh / .battery_capacitynumberCharge fraction / Wh / max Wh
.is_dockedbooleanParked inside an outpost’s 2×2-tile footprint including the ~2 m service margin; a moving or merely stopped vehicle with an active route is not docked
.docked_atstringOutpost id, or empty string
.is_being_rescuedbooleanA Vehicle Charging Station rescue was active
.rescue_statusstring"none" / "outbound" / "charging" / "returning"

Re-query for fresh values, or get_component(ref.id) for the live vehicle API.