aboutsummaryrefslogtreecommitdiff
path: root/advtrains_luaautomation/README.md
diff options
context:
space:
mode:
authorMaverick2797 <git.maverick2797@gmail.com>2024-08-17 11:43:35 +0800
committerorwell <orwell@bleipb.de>2024-09-02 22:22:38 +0200
commit55108ae38e467e190abd6f9bf087a9a73f953a08 (patch)
tree691ccfb1d31621033067f3f9dd4f86c16f1a6dbc /advtrains_luaautomation/README.md
parent3b83580faccfbe5b23cea04bd3e6e0810572c7c0 (diff)
downloadadvtrains-55108ae38e467e190abd6f9bf087a9a73f953a08.tar.gz
advtrains-55108ae38e467e190abd6f9bf087a9a73f953a08.tar.bz2
advtrains-55108ae38e467e190abd6f9bf087a9a73f953a08.zip
LuaATC set_fc(): add argument to reset fc index to 1
Diffstat (limited to 'advtrains_luaautomation/README.md')
-rw-r--r--advtrains_luaautomation/README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/advtrains_luaautomation/README.md b/advtrains_luaautomation/README.md
index a885075..0bf56bb 100644
--- a/advtrains_luaautomation/README.md
+++ b/advtrains_luaautomation/README.md
@@ -274,9 +274,11 @@ Each wagon has a current FC, indicating its next destination.
Command: `get_fc()`
Result: `{"", "foo!bar", "testing", "fc_1!fc_2!fc_3!?", "hello_world"}`
- - `set_fc(fc_list)`
+ - `set_fc(fc_list, reset_index)`
Overwrites the FC list according to a table `fc_list`. A false or nil entry will leave the wagon unaffected, however all others will be overwritten.
- Useful for mass-programming freight trains that use FC-shunting instead of walking to each wagon individually.
+ Useful for mass-programming freight trains that use FC-shunting instead of walking to each wagon individually. If the new FC entry for a wagon is shorter than the old entry, the index will clip to the last FC in the new entry.
+ If `reset_index` is true, all Current FC values will reset to the first entry in the list, instead of remaining at the current index.
+
Example: train has FC lists: `"", "foo!bar", "testing", "fc_1!fc_2!fc_3!?", "hello_world"`
Command: `set_fc({"", "foo!turtle", nil, "4tehlulz", false})`
Result: `""` `"foo!turtle"` `"testing"` `"4tehlulz"` `"hello_world"`