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-08-04 21:30:23 +0200
commit69d0ad475feff06b6c8c551303b7ea29ee101561 (patch)
tree1948d737478103c4e031fe24628bda5e8c41129a /advtrains/api_doc.txt
parent4989da3663cbc91ccd283a20f40bb4031687aacf (diff)
downloadadvtrains-69d0ad475feff06b6c8c551303b7ea29ee101561.tar.gz
advtrains-69d0ad475feff06b6c8c551303b7ea29ee101561.tar.bz2
advtrains-69d0ad475feff06b6c8c551303b7ea29ee101561.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