Skip to main content
POST
/
script
/
load
attach a Lua script to an entity
curl --request POST \
  --url http://localhost:3917/script/load \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity_id": 1,
  "path": "<string>"
}
'
{
  "ok": true,
  "message": "<string>"
}

Body

application/json

Request body for POST /script/load.

​
entity_id
integer<int32>
required

Entity ID to attach the script to.

Required range: x >= 0
​
path
string
required

Path to the .lua script file.

Response

200 - application/json

Script loaded and attached to the entity (or an error message).

​
ok
boolean
required
​
message
string | null