aboutsummaryrefslogtreecommitdiff
path: root/advtrains/api_doc.txt
diff options
context:
space:
mode:
authorywang <yw05@forksworld.de>2021-02-14 15:44:42 +0100
committerY. Wang <yw05@forksworld.de>2022-03-12 18:23:30 +0100
commit9a19d8222d193bd9784325176b24ed94c10d95ab (patch)
tree397240596e602662e4e6a62486b5133af8465fe6 /advtrains/api_doc.txt
parent744aee2cdd319bc19e83cc9efb52a07ae6adbb06 (diff)
downloadadvtrains-9a19d8222d193bd9784325176b24ed94c10d95ab.tar.gz
advtrains-9a19d8222d193bd9784325176b24ed94c10d95ab.tar.bz2
advtrains-9a19d8222d193bd9784325176b24ed94c10d95ab.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 5668ba3..864e292 100644
--- a/advtrains/api_doc.txt
+++ b/advtrains/api_doc.txt
@@ -120,6 +120,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