Document how to make nametags background disappear on players' head (#10783)

Co-authored-by: Zughy <4279489-marco_a@users.noreply.gitlab.com>

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index ba4d6312cc7d0c5638ba8a54679a214b714bd442..4ef67261a1187d5a7b857ef4028eb664c8b1bfc3 100644 (file)
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -6938,7 +6938,11 @@ Player properties need to be saved manually.
         -- in mods.
 
         nametag = "",
-        -- By default empty, for players their name is shown if empty
+        -- The name to display on the head of the object. By default empty.
+        -- If the object is a player, a nil or empty nametag is replaced by the player's name.
+        -- For all other objects, a nil or empty string removes the nametag.
+        -- To hide a nametag, set its color alpha to zero. That will disable it entirely.
+
 
         nametag_color = <ColorSpec>,
         -- Sets color of nametag