Skip to main content
POST
/
animation
/
play
start animation on an entity
curl --request POST \
  --url http://localhost:3917/animation/play \
  --header 'Content-Type: application/json' \
  --data '
{
  "clip": 0,
  "entity_id": 5,
  "loop": true,
  "speed": 1
}
'
{
  "ok": true,
  "message": "<string>"
}

Body

application/json

Start a SkeletalAnimator: target entity_id, clip index (default 0), speed (default 1.0), and loop (default true).

The body is of type any.

Response

200 - application/json

Animator attached; ok is false with a message if the entity is missing.

ok
boolean
required
message
string | null