Lua_api.txt: Document inventory sending behaviour (#7720)

master
zeuner 2018-12-18 01:38:39 +01:00 committed by Paramat
parent e7367f0fa5
commit 7a4d4bc9e6
1 changed files with 7 additions and 2 deletions

View File

@ -1800,6 +1800,9 @@ examples.
Position and size units are inventory slots, `X` and `Y` position the formspec 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 element relative to the top left of the menu or container. `W` and `H` are its
width and height values. 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, When displaying text which can contain formspec code, e.g. text set by a player,
use `minetest.formspec_escape`. use `minetest.formspec_escape`.
For coloured text you can use `minetest.colorize`. For coloured text you can use `minetest.colorize`.
@ -1885,11 +1888,13 @@ Elements
### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]` ### `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>]` ### `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>]` ### `listring[<inventory location>;<list name>]`