summaryrefslogtreecommitdiff
path: root/doc/lua_api.txt
diff options
context:
space:
mode:
authorZughy <63455151+Zughy@users.noreply.github.com>2021-01-11 17:03:46 +0000
committerGitHub <noreply@github.com>2021-01-11 18:03:46 +0100
commit1946835ee87bdd20c586f6bb79c422da1cad4685 (patch)
treea965df6618c59c51c93d37c912b9251e1eb4bb4d /doc/lua_api.txt
parent08ee9794fbc0960a8aab1af21d34f40685809e75 (diff)
downloadminetest-1946835ee87bdd20c586f6bb79c422da1cad4685.tar.gz
minetest-1946835ee87bdd20c586f6bb79c422da1cad4685.tar.bz2
minetest-1946835ee87bdd20c586f6bb79c422da1cad4685.zip
Document how to make nametags background disappear on players' head (#10783)
Co-authored-by: Zughy <4279489-marco_a@users.noreply.gitlab.com>
Diffstat (limited to 'doc/lua_api.txt')
-rw-r--r--doc/lua_api.txt6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index ba4d6312c..4ef67261a 100644
--- 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