Guide 1 Docs 2 Reference 3
6

Hud type

A layout on one player's screen, from player.ui.show. hud.<id> is the item with that id.

Functions 4

hud:set(values: { [string]: number | string | boolean })

A value per id: a number is a fill, a string a label's words, true or false whether it shows. An unknown id is an error that lists the ids.

hud:destroy()

Takes it off the player's screen.

hud.on_hover((id: string?) -> ()) → ?

hud.on_click((id: string?, button: "left" | "right") -> ()) → ?

Fields 2

hud.hover: string?

With cursor = true: the id under the pointer, and what fires when it changes and on a click.

hud.cursor: { x: number, y: number }?

Where the pointer is, in the layout's pixels from its top left.