Get Vehicles

Gets a list of all vehicles (tractors, trucks, trains, factory carts, etc.).

getExplorer only retrieves Explorers
getTractor only retrieves Tractors
getTruck only retrieves Trucks
getFactoryCart only retrieves Factory Carts

URL

GET http://localhost:8080/getVehicles

Response Body

Name Type Description

ID

String

Unique ID of the vehicle type.

Name

String

Name of the vehicle type.

ClassName

String

ClassName of the vehicle type.

location

Object

Location details of the Vehicle.

  x

Float

X Location in the World.

  y

Float

Y Location in the World.

  z

Float

Z Location in the World.

  rotation

Float

Rotation of the Actor (0 - 359, 0 = North, 90 = East, 180 = South, 270 = West).

PathName

String

Name of Saved Path Assigned

Status

String

Vehicle Status

Driver

String

Player Name of Vehicle Driver

ForwardSpeed

Float

Current Speed in km/h

CurrentGear

Integer

Transmission Gear

EngineRPM

Integer

RPM of Engine

Airborne

Boolean

Is the truck making a jump

AutoPilot

Boolean

Auto pilot engaged?

Storage

Object[]

A list of items.

  Name

String

Name of the item.

  ClassName

String

Class Name of the item.

  Amount

Integer

Amount of the item.

  MaxAmount

Integer

Stack size of the item.

Fuel

Object[]

A list of Fuel.

  Name

String

Name of the item.

  ClassName

String

Class Name of the item.

  Amount

Integer

Amount of the item.

  MaxAmount

Integer

Stack size of the item.

features

Object

An object with actor coordinates and name information.

  properties

Object

Name information about the actor.

    name

String

Display Name of the Actor.

    type

String

Type of the Object.

  geometry

Object

Geometry information about the Actor.

    coordinates

Object

The Actor coordinates.

      x

Float

X Location of the Actor.

      y

Float

Y Location of the Actor.

      z

Float

Z Location of the Actor.

    type

String

It’s always "Point".

Example Response

[
  {
    "ID": 0,
    "VehicleType": "Explorer",
    "location":
    {
      "x": -52341.4375,
      "y": -162543.21875,
      "z": -904.133544921875,
      "rotation": 313
    },
    "PathName": "Test Path",
    "Status": "Operational",
    "Driver": "porisius",
    "CurrentGear": 1,
    "ForwardSpeed": 11.1579312744141,
    "EngineRPM": 2244.17504882813,
    "ThrottlePercent": 0.400730907917023,
    "Airborne": false,
    "AutoPilot": false,
    "Storage": [
      {
        "Name": "Battery",
        "ClassName": "Desc_Battery_C",
        "Amount": 200
      },
      {
        "Name": "Battery",
        "ClassName": "Desc_Battery_C",
        "Amount": 200
      }
    ],
    "Fuel": [
      {
        "Name": "Battery",
        "ClassName": "Desc_Battery_C",
        "Amount": 199
      }
    ],
    "FollowingPath": false,
    "features":
    {
      "properties":
      {
        "name": "Explorer",
        "type": "Explorer"
      },
      "geometry":
      {
        "coordinates":
        {
          "X": -52341.4375,
          "Y": -162543.21875,
          "Z": -904.133544921875
        },
        "type": "Point"
      }
    }
  }
]