Get Storage Inv

This is inventory of the world broken up by their storage containers. This does not include pipes/belts/factory buildings, only buildings whom purpose is to provide storage except Fluid Buffers.

Similar

Resource

Endpoint

Description

Inventory

getCloudInv

Gets a list of the cloud inventory.

Inventory

getCrateInv

Gets a list of all crate inventories.

Inventory

getWorldInv

Gets a list of the world inventory.

URL

GET http://localhost:8080/getStorageInv

Response Body

Name Type Description

ID

String

Unique ID of the Storage Container.

Name

String

Name of the Storage Container.

ClassName

String

Class Name of the Storage Container.

location

Object

Location details of the Storage Container.

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

Inventory

Object[]

List of items in the Storage Container.

  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.

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.

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_StorageContainerMk1_C_2147395408",
    "Name": "Storage Container",
    "ClassName": "Build_StorageContainerMk1_C",
    "location": {
      "x": -63207.6484375,
      "y": 262781.53125,
      "z": -3207.024658203125,
      "rotation": 150.00000089058409
    },
    "Inventory": [
      {
        "Name": "Iron Plate",
        "ClassName": "Desc_IronPlate_C",
        "Amount": 164,
        "MaxAmount": 200
      }
    ],
    "features": {
      "properties": {
        "name": "Storage Container",
        "type": "Storage Container"
      },
      "geometry": {
        "coordinates": {
          "x": -63207.6484375,
          "y": 262781.53125,
          "z": -3207.024658203125
        },
        "type": "Point"
      }
    }
  }
]