Skip to main content
POST
/
ui
/
text
add text to HUD
curl --request POST \
  --url http://localhost:3917/ui/text \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "type": "text",
  "x": 123,
  "y": 123,
  "color": "<string>",
  "size": 123
}
'
{
  "ok": true,
  "message": "<string>"
}

Body

application/json

A single HUD element on screen.

text
string
required
type
enum<string>
required
Available options:
text
x
number<float>
required
y
number<float>
required
color
string
size
number<float>

Response

200 - application/json

Text element appended to the HUD canvas.

ok
boolean
required
message
string | null