aboutsummaryrefslogtreecommitdiff
path: root/advtrains/api_doc.txt
diff options
context:
space:
mode:
authorBlockhead <jbis1337@hotmail.com>2020-03-13 13:24:11 +1100
committerBlockhead <jbis1337@hotmail.com>2020-03-18 00:35:30 +1100
commit2da11c5a49f39a6b55c411510f44f2f3676efc3a (patch)
tree0d6dcdedac170125427bf9539300e07d853d0109 /advtrains/api_doc.txt
parentfb837a449af3bc3f5d70b10d807fc53982520e9f (diff)
downloadadvtrains-2da11c5a49f39a6b55c411510f44f2f3676efc3a.tar.gz
advtrains-2da11c5a49f39a6b55c411510f44f2f3676efc3a.tar.bz2
advtrains-2da11c5a49f39a6b55c411510f44f2f3676efc3a.zip
Use a standard wagon inventory formspec
This new formspec also allows access to the wagon properties. Once whitelisted in the wagon properties, other players can access its inventory. Note on 'useless use' of OO: I tried passing just the wagon ID and avoiding using the `self` object in order to bypass the need to look up the lua entitie out of the list, but it ended up retrieving nil data. The best way to solve this overhead might be to wait for some kind of better way upstream in minetest's lua API to get entities, or to keep a central record of entities. Either way, the solution is outside the scope of this commit.
Diffstat (limited to 'advtrains/api_doc.txt')
-rw-r--r--advtrains/api_doc.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/advtrains/api_doc.txt b/advtrains/api_doc.txt
index 34f1beb..0256713 100644
--- a/advtrains/api_doc.txt
+++ b/advtrains/api_doc.txt
@@ -101,7 +101,9 @@ advtrains.register_wagon(name, prototype, description, inventory_image)
get_inventory_formspec = function(self, player_name, inventory_name)
return "<a formspec>"
end,
- ^- Function that should return the formspec to be displayed when <player> requests to open the wagon's inventory
+ ^- Function that should return the formspec to be displayed when <player> requests to open the wagon's inventory.
+ ^- advtrains.standard_inventory_formspec can be used for ordinary wagons with inventories to show
+ ^- both the inventory grid and a 'Wagon properties' button.
^- Use "list["..inventory_name..";<list_name>;<X>,<Y>;<W>,<H>;<Start>]" to display a wagon's inventory list.
custom_on_step = function(self, dtime) end