aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPierre-Yves Rollo <dev@pyrollo.com>2019-11-04 09:30:02 +0100
committerrubenwardy <rw@rubenwardy.com>2019-12-06 20:31:26 +0000
commitcf7fda00831372d981415f9a830513b2b28fdf25 (patch)
treead8d856fe0c85f3cb35e205a5df4b286e04bf9aa /doc
parentf6de86ce4b9da21f16d3bcdbc0c55ce4cbe23067 (diff)
downloadminetest-cf7fda00831372d981415f9a830513b2b28fdf25.tar.gz
minetest-cf7fda00831372d981415f9a830513b2b28fdf25.tar.bz2
minetest-cf7fda00831372d981415f9a830513b2b28fdf25.zip
Add z-index management to HUD
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 9ca44747f..697efcdbc 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -1260,6 +1260,11 @@ precisely positioned items in the HUD.
**Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling
factor!
+The `z_index` field specifies the order of HUD elements from back to front.
+Lower z-index elements are displayed behind higher z-index elements. Elements
+with same z-index are displayed in an arbitrary order. Default 0.
+Supports negative values.
+
Below are the specific uses for fields in each type; fields not listed for that
type are ignored.
@@ -7322,6 +7327,9 @@ Used by `Player:hud_add`. Returned by `Player:hud_get`.
size = { x=100, y=100 },
-- Size of element in pixels
+
+ z_index = 0,
+ -- Z index : lower z-index HUDs are displayed behind higher z-index HUDs
}
Particle definition