Heads Up Display (HUD) elements allow you to show text, images, and other graphical elements.
HUD doesn’t accept user input. For that, you should use a Formspec.
HUD elements are created using a player object. You can get the player object from a username like this:
Once you have the player object, you can create an element:
This attributes in the above table and what they do vary depending on
A number is returned by the hud_add function which is needed to identify the HUD element at a later time, if you wanted to change or delete it.
You can change an attribute after creating a HUD element, such as what the text says:
You can also delete the element:
Screens come in different sizes, and HUD elements need to work well on all sizes. You locate an element using a combination of a position and an offset.
The position is a co-ordinate between (0, 0) and (1, 1) which determines where, relative to the screen width and height, the element goes. For example, an element with a position of (0.5, 0.5) will be in the center of the screen.
The offset applies a pixel offset to the position.
An element with a position of (0, 0) and an offset of (10, 10) will end up at the screen co-ordinates (0 * width + 10, 0 * height + 10).
Please note that offset scales to DPI and a user defined factor.
A text element is the simplest form of a HUD element.
Here is our earlier example, but with comments to explain each part:
You can apply colors to the text, using the
Colors are in Hexadecimal form.
Displays an image on the HUD.
The X co-ordinate of the
scale attribute is the scale of the image, with 1 being the original texture size.
Negative values represent that percentage of the screen it should take; e.g. x=-100 means 100% (width).
text to specify the name of the texture.
Have a look at lua_api.txt for a complete list of HUD elements.