BRNSystems/minetest
1
0
Fork 0
forked from Mirrorlandia_minetest/minetest
Code Pull Requests 1 Activity

Add more documentation for the list[] fs element (#11979)

Browse Source
This commit is contained in:
DS 2022-02-03 11:43:28 +01:00 committed by GitHub
parent 163d3547e6
commit d387e9b6d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/lua_api.txt
View File

@ -2388,21 +2388,23 @@ Elements
* End of a scroll_container, following elements are no longer bound to this * End of a scroll_container, following elements are no longer bound to this
container. container.
### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]` ### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
* Show an inventory list if it has been sent to the client. Nothing will * Show an inventory list if it has been sent to the client.
be shown if the inventory list is of size 0. * If the inventory list changes (eg. it didn't exist before, it's resized, or its items
are moved) while the formspec is open, the formspec element may (but is not guaranteed
to) adapt to the new inventory list.
* Item slots are drawn in a grid from left to right, then up to down, ordered
according to the slot index.
* `W` and `H` are in inventory slots, not in coordinates.
* `starting item index` (Optional): The index of the first (upper-left) item to draw.
Indices start at `0`. Default is `0`.
* The number of shown slots is the minimum of `W*H` and the inventory list's size minus
`starting item index`.
* **Note**: With the new coordinate system, the spacing between inventory * **Note**: With the new coordinate system, the spacing between inventory
slots is one-fourth the size of an inventory slot by default. Also see slots is one-fourth the size of an inventory slot by default. Also see
[Styling Formspecs] for changing the size of slots and spacing. [Styling Formspecs] for changing the size of slots and spacing.
### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
* Show an inventory list if it has been sent to the client. Nothing will
be shown if the inventory list is of size 0.
* **Note**: With the new coordinate system, the spacing between inventory
slots is one-fourth the size of an inventory slot.
### `listring[<inventory location>;<list name>]` ### `listring[<inventory location>;<list name>]`
* Allows to create a ring of inventory lists * Allows to create a ring of inventory lists