Get Truck Station

Gets a list of all truck stations.

Similar

Resource

Endpoint

Game Thread

Description

Stations

getDroneStation

No

Gets a list of all drone stations.

Stations

getTrainStation

No

Gets a list of all train stations.

URL

GET http://localhost:8080/getTruckStation

Response Body

Name Type Description

ID

String

Unique ID of the Truck Station.

Name

String

Name of the Truck Station.

ClassName

String

ClassName of the Truck Station.

ColorSlot

Object

Color/Decoration information about the Actor.

  PrimaryColor

String

Hex Code of Primary Color

  SecondaryColor

String

Hex Code of Secondary Color

BoundingBox

Object

Bounding Box information about the Actor.

  min

Object

The minimum boundary of the bounding box in the corresponding axis.

    x

Float

Value along the X-axis.

    y

Float

Value along the Y-axis.

    z

Float

Value along the Z-axis.

  max

Object

The maximum boundary of the bounding box in the corresponding axis.

    x

Float

Value along the X-axis.

    y

Float

Value along the Y-axis.

    z

Float

Value along the Z-axis.

location

Object

Location details of the Truck Station.

  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).

DockVehicleCount

Integer

# of vehicles docked

LoadMode

String

Load/Unload Mode Set

TransferRate

Float

Rate of item stacks transferred

MaxTransferRate

Float

Combined Max Stacks/Sec for All Vehicles at station

StationStatus

String

Status of Station (Idle/Loading/Unloading)

FuelRate

Float

Amount of fuel used per vehicle

Inventory

Object[]

List of items in the inventory.

  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.

FuelInventory

Object[]

List of items in the fuel inventory.

  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.

PowerInfo

Object

Power Information Object.

  CircuitGroupID

Integer

The group this circuit belongs too. (-1 = not connected)

  CircuitID

Integer

This circuit’s unique identifier. (-1 = not connected)

  FuseTriggered

Boolean

Has the fuse tripped?

  PowerConsumed

Float

Current power consumption.

  MaxPowerConsumed

Float

Current maximum power consumption.

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": "Build_TruckStation_C_2147108415",
    "Name": "Truck Station",
    "ClassName": "Build_TruckStation_C",
    "location": {
      "x": 137500,
      "y": 222000,
      "z": -4899.98885664623,
      "rotation": 90
    },
    "BoundingBox": {
      "min": {
        "x": 136900,
        "y": 220700,
        "z": -4899.98885664623
      },
      "max": {
        "x": 138600,
        "y": 222200,
        "z": -3654.98885664623
      }
    },
    "ColorSlot": {
      "PrimaryColor": "FA954900",
      "SecondaryColor": "5F668C00"
    },
    "DockVehicleCount": 0,
    "LoadMode": "Idle",
    "TransferRate": 0,
    "MaxTransferRate": 0,
    "StationStatus": "Error",
    "FuelRate": 0,
    "Inventory": [
      {
        "Name": "Encased Industrial Beam",
        "ClassName": "Desc_SteelPlateReinforced_C",
        "Amount": 54,
        "MaxAmount": 100
      }
    ],
    "FuelInventory": [
      {
        "Name": "Solid Biofuel",
        "ClassName": "Desc_Biofuel_C",
        "Amount": 171,
        "MaxAmount": 200
      }
    ],
    "features": {
      "properties": {
        "name": "Truck Station",
        "type": "Truck Station"
      },
      "geometry": {
        "coordinates": {
          "x": 137500,
          "y": 222000,
          "z": -4899.98885664623
        },
        "type": "Point"
      }
    },
    "PowerInfo": {
      "CircuitGroupID": -1,
      "CircuitID": -1,
      "FuseTriggered": false,
      "PowerConsumed": 0,
      "MaxPowerConsumed": 0
    }
  }
]