Get Elevators

Get a list of all elevators.

URL

GET http://localhost:8080/getElevators

Response Body

Name Type Description

ID

String

Unique ID of the Elevator.

ClassName

String

ClassName of the Elevator.

Status

String

Status of the Elevator (Available statuses: Idle, Arrived, PauseBeforeDoorOpen, Waiting, DoorsOpening, DoorsClosing, PauseBeforeMove, Moving, NoPower, SafetyStopping).

ReadableStatus

String

Human-readable Status of the Elevator.

Speed

Float

Speed of the Elevator in centimetre (cm).

DurationOfCurrentState

Float

Duration in Seconds that the elevator will remain in its current state (-1 indicates Completed/Idle).

Height

Float

Height of the Elevator in centimetre (cm).

CurrentFloorStep

Integer

Current Floor Stop of the Elevator Cabin.

NumFloorStops

Integer

Amount of Floor Stops of the Elevator.

NumOccupyingCharacters

Integer

Amount of Players in the Elevator Cabin.

HasPower

Boolean

Indicates whether the elevator has power.

IsOccupied

Boolean

Indicates if any player is inside the Elevator Cabin.

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

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

OccupyingCharacters

Object[]

List of all players inside the Elevator Cabin.

  ID

String

ID of the Player.

  Name

String

Name of the Player.

FloorStops

Object[]

List of all the Elevator’s Floor Stops.

  Name

String

Name of the Stop.

  Height

Integer

Height of the Stop relative to the floor in centimetre (cm).

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_Elevator_C_2147471560",
    "ClassName": "Build_Elevator_C",
    "Status": "Idle",
    "ReadableStatus": "Idle",
    "Speed": 800,
    "DurationOfCurrentState": -1,
    "Height": 20000,
    "CurrentFloorStep": 0,
    "NumFloorStops": 1,
    "NumOccupyingCharacters": 1,
    "HasPower": false,
    "IsOccupied": true,
    "location": {
      "x": -64499.25390625,
      "y": 258740.546875,
      "z": -3938.2197265625,
      "rotation": 170.00000263622633
    },
    "OccupyingCharacters": [
      {
        "ID": "Char_Player_C_2147464253",
        "Name": "derpierre65"
      }
    ],
    "FloorStops": [
      {
        "Name": "0m",
        "Height": 0
      }
    ],
    "features": {
      "properties": {
        "name": "Personnel Elevator",
        "type": "Personnel Elevator"
      },
      "geometry": {
        "coordinates": {
          "x": -64499.25390625,
          "y": 258740.546875,
          "z": -3938.2197265625
        },
        "type": "Point"
      }
    }
  }
]