Hypertube Entrances

Get a list of all Hypertube Entrances.

URL

GET http://localhost:8080/getHyperEntrance

Response Body

Name Type Description

ID

String

Unique ID of the Hypertube Entrances.

Name

String

Name of the Hypertube Entrances.

ClassName

String

Class Name of the Hypertube Entrances.

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.

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_PipeHyperStart_C_2142927173",
    "Name": "Hypertube Entrance",
    "ClassName": "Build_PipeHyperStart_C",
    "location": {
      "x": -254709.78125,
      "y": -44782.69921875,
      "z": -125,
      "rotation": 95.1965333687203
    },
    "BoundingBox": {
      "min": {
        "x": -254709.78125,
        "y": -44782.69921875,
        "z": -125
      },
      "max": {
        "x": -254709.78125,
        "y": -44782.69921875,
        "z": -125
      }
    },
    "ColorSlot": {
      "PrimaryColor": "FA954900",
      "SecondaryColor": "5F668C00"
    },
    "PowerInfo": {
      "CircuitGroupID": 0,
      "CircuitID": 23,
      "PowerConsumed": 10,
      "MaxPowerConsumed": 10
    }
  }
]