aboutsummaryrefslogtreecommitdiff
path: root/advtrains/api_doc.txt
diff options
context:
space:
mode:
authorGabriel Pérez-Cerezo <gabriel@gpcf.eu>2020-06-08 13:50:08 +0200
committerGabriel Pérez-Cerezo <gabriel@gpcf.eu>2020-06-08 13:50:08 +0200
commitd61c2145a0f28438b0f85345bc7808ce0b6161c6 (patch)
tree98a7df9e1205babfacf90ccabfd4d034ef9c9ebb /advtrains/api_doc.txt
parent15be5006627f7ff1b81dc376ebf12ea7a0a7f86a (diff)
parente57c1eaa7fed32d12a3427735bda500e38006686 (diff)
downloadadvtrains-d61c2145a0f28438b0f85345bc7808ce0b6161c6.tar.gz
advtrains-d61c2145a0f28438b0f85345bc7808ce0b6161c6.tar.bz2
advtrains-d61c2145a0f28438b0f85345bc7808ce0b6161c6.zip
Merge branch 'wagon_prop_formspec' of https://github.com/Montandalar/advtrains
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