SoulFire LogoSoulFire

Reset movement

Resets all movement to stopped state. Equivalent to releasing all movement keys. The action is queued and executed on the next game tick.

POST
/v1/instances/p0/bots/p1/movement:reset

Resets all movement to stopped state. Equivalent to releasing all movement keys. The action is queued and executed on the next game tick.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

instance_id*string

The UUID of the SoulFire instance containing the bot.

Formatuuid
bot_id*string

The profile UUID of the bot to stop movement for.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://127.0.0.1:38765/v1/instances/p0/bots/p1/movement:reset"
{
  "success": true,
  "error": "string"
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

How is this page?