Get Creatures

Gets a list of all Creatures.

URL

GET http://localhost:8080/getCreatures

Response Body

Name Type Description

ID

String

Unique ID of the Creature.

ClassName

String

ClassName of the Creature.

location

Object

Location details of the Creature.

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

Spawn Distance

Float

Creature’s Spawn Distance

State

String

Creature’s State
- RT_Default: Default
- CS_Roam: Roaming
- CS_Alert: Alerted
- CS_Fight: In Combat
- CS_Flee: Fleeing
- CS_Investigate: Investigating

Roaming

Object

Creature Roaming Object

  MinRoaming

Float

Max Roaming Radius

  MaxRoaming

Float

Max Roaming Radius

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": "Char_Hog_C_2147466694",
    "ClassName": "Char_Hog_C",
    "Roaming": {
      "MinRoaming": 500,
      "MaxRoaming": 1000
    },
    "SpawnDistance": 10000,
    "State": "CS_Default",
    "location": {
      "x": -109600.786401125,
      "y": 219064.349969713,
      "z": 720.205171512911,
      "rotation": 132.556407928467
    },
    "features": {
      "properties": {
        "name": "Char_Hog_C",
        "type": "Char_Hog_C"
      },
      "geometry": {
        "coordinates": {
          "x": -109600.786401125,
          "y": 219064.349969713,
          "z": 720.205171512911
        },
        "type": "Point"
      }
    }
  },
  {
    "ID": "Char_SpaceGiraffe_C_2147475977",
    "ClassName": "Char_SpaceGiraffe_C",
    "Roaming": {
      "MinRoaming": 1000,
      "MaxRoaming": 6000
    },
    "SpawnDistance": 20000,
    "State": "CS_Default",
    "location": {
      "x": -102999.879346438,
      "y": 205214.50708689,
      "z": 1110.40994600986,
      "rotation": 0.438751220703068
    },
    "features": {
      "properties": {
        "name": "Char_SpaceGiraffe_C",
        "type": "Char_SpaceGiraffe_C"
      },
      "geometry": {
        "coordinates": {
          "x": -102999.879346438,
          "y": 205214.50708689,
          "z": 1110.40994600986
        },
        "type": "Point"
      }
    }
  }
]