Skip to main content
GET
/
entities
/
{id}
query single entity
curl --request GET \
  --url http://localhost:3917/entities/{id}
{
  "generation": 1,
  "id": 1,
  "ai": "<string>",
  "collider": {
    "hx": 123,
    "hy": 123,
    "hz": 123,
    "shape": "Aabb"
  },
  "dead": true,
  "gold": 123,
  "health": [
    123
  ],
  "level": 1,
  "mana": [
    123
  ],
  "physics_body": "<string>",
  "projectile": true,
  "role": "<string>",
  "tags": [
    "<string>"
  ],
  "team": 1,
  "transform": {
    "position": [
      123
    ],
    "rotation": [
      123
    ],
    "scale": [
      123
    ]
  },
  "trigger_zone": "<string>",
  "velocity": {
    "linear": [
      123
    ],
    "angular": [
      123
    ]
  },
  "visible_to": [
    1
  ]
}

Path Parameters

id
integer<int32>
required

Entity id

Required range: x >= 0

Response

The entity's full component snapshot.

generation
integer<int32>
required
Required range: x >= 0
id
integer<int32>
required
Required range: x >= 0
ai
string | null
collider
object
dead
boolean | null
gold
integer<int32> | null
health
number<float>[] | null
level
integer<int32> | null
Required range: x >= 0
mana
number<float>[] | null
physics_body
string | null
projectile
boolean | null
role
string | null
tags
string[] | null
team
integer<int32> | null
Required range: x >= 0
transform
object
trigger_zone
string | null
velocity
object
visible_to
integer<int32>[] | null
Required range: x >= 0