aboutsummaryrefslogtreecommitdiff
path: root/advtrains/api_doc.txt
diff options
context:
space:
mode:
authorywang <yw05@forksworld.de>2021-02-14 15:44:42 +0100
committerywang <yw05@forksworld.de>2021-06-09 15:31:46 +0200
commitb80ca7f67e773c74e0b5c279c1a7dc1497d5daec (patch)
treec4555746630247fc0c445f57b07fc550cc449368 /advtrains/api_doc.txt
parent17d1308241bfb13790285ca1df7a58cce7505150 (diff)
downloadadvtrains-b80ca7f67e773c74e0b5c279c1a7dc1497d5daec.tar.gz
advtrains-b80ca7f67e773c74e0b5c279c1a7dc1497d5daec.tar.bz2
advtrains-b80ca7f67e773c74e0b5c279c1a7dc1497d5daec.zip
[WIP] Allow wagon-dependent train HUD
Diffstat (limited to 'advtrains/api_doc.txt')
-rw-r--r--advtrains/api_doc.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/advtrains/api_doc.txt b/advtrains/api_doc.txt
index 8ac4986..72b69e9 100644
--- a/advtrains/api_doc.txt
+++ b/advtrains/api_doc.txt
@@ -106,6 +106,12 @@ advtrains.register_wagon(name, prototype, description, inventory_image)
^- 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.
+ text_hud = function(train, flip) end
+ ^- optional: Text HUD to show to the driver. The inside display is automatically prepended.
+ graphical_hud = function(train, flip) end
+ ^- optional: Graphical HUD to show to the driver.
+ The HUD formats defined by advtrains are used by default.
+
custom_on_step = function(self, dtime) end
^- optional: Execute custom code on every step
custom_on_activate = function(self, dtime_s) end