summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLars Müller <34514239+appgurueu@users.noreply.github.com>2022-03-05 22:16:17 +0100
committerGitHub <noreply@github.com>2022-03-05 22:16:17 +0100
commitb9e886726c68613d39459acc8cb1a2f663b0362c (patch)
tree64fa90ee6201c209d28d0f7697728f4c1852f8e1 /doc
parent44fc888bd64cc00836b0fea0666aa763b2565513 (diff)
downloadminetest-b9e886726c68613d39459acc8cb1a2f663b0362c.tar.gz
minetest-b9e886726c68613d39459acc8cb1a2f663b0362c.tar.bz2
minetest-b9e886726c68613d39459acc8cb1a2f663b0362c.zip
Readd basic_debug as a HUD flag (#12020)
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt21
1 files changed, 11 insertions, 10 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 8af261e0c..89bc7dc4b 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -6772,17 +6772,18 @@ object you are working with still exists.
* `hud_get(id)`: gets the HUD element definition structure of the specified ID
* `hud_set_flags(flags)`: sets specified HUD flags of player.
* `flags`: A table with the following fields set to boolean values
- * hotbar
- * healthbar
- * crosshair
- * wielditem
- * breathbar
- * minimap
- * minimap_radar
+ * `hotbar`
+ * `healthbar`
+ * `crosshair`
+ * `wielditem`
+ * `breathbar`
+ * `minimap`: Modifies the client's permission to view the minimap.
+ The client may locally elect to not view the minimap.
+ * `minimap_radar`: is only usable when `minimap` is true
+ * `basic_debug`: Allow showing basic debug info that might give a gameplay advantage.
+ This includes map seed, player position, look direction, the pointed node and block bounds.
+ Does not affect players with the `debug` privilege.
* If a flag equals `nil`, the flag is not modified
- * `minimap`: Modifies the client's permission to view the minimap.
- The client may locally elect to not view the minimap.
- * `minimap_radar` is only usable when `minimap` is true
* `hud_get_flags()`: returns a table of player HUD flags with boolean values.
* See `hud_set_flags` for a list of flags that can be toggled.
* `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar