summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorzeuner <github@quidecco.de>2018-12-18 01:38:39 +0100
committerParamat <paramat@users.noreply.github.com>2018-12-18 00:38:39 +0000
commit7a4d4bc9e6064ca083cd412e678f7d0927819438 (patch)
treeb10ac197b0355a6f2acc14f54de1d7da65e9a414 /doc
parente7367f0fa54b40cf94c2becaa66118906b182099 (diff)
downloadminetest-7a4d4bc9e6064ca083cd412e678f7d0927819438.tar.gz
minetest-7a4d4bc9e6064ca083cd412e678f7d0927819438.tar.bz2
minetest-7a4d4bc9e6064ca083cd412e678f7d0927819438.zip
Lua_api.txt: Document inventory sending behaviour (#7720)
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 5c83ae7ec..2c3e197df 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -1800,6 +1800,9 @@ examples.
Position and size units are inventory slots, `X` and `Y` position the formspec
element relative to the top left of the menu or container. `W` and `H` are its
width and height values.
+Inventories with a `player:<name>` inventory location are only sent to the
+player named `<name>`.
+
When displaying text which can contain formspec code, e.g. text set by a player,
use `minetest.formspec_escape`.
For coloured text you can use `minetest.colorize`.
@@ -1885,11 +1888,13 @@ Elements
### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
-* Show an inventory list
+* Show an inventory list if it has been sent to the client. Nothing will
+ be shown if the inventory list is of size 0.
### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
-* Show an inventory list
+* Show an inventory list if it has been sent to the client. Nothing will
+ be shown if the inventory list is of size 0.
### `listring[<inventory location>;<list name>]`