aboutsummaryrefslogtreecommitdiff
path: root/advtrains/advtrains_luaautomation/passive_api.txt
diff options
context:
space:
mode:
authororwell96 <mono96.mml@gmail.com>2017-02-02 16:40:51 +0100
committerorwell96 <mono96.mml@gmail.com>2017-02-02 17:17:39 +0100
commitb19033b224f4f8ec33f10ba40327f1d811c04fbb (patch)
treef1d6340ef9aab4f93a2e355f544fa0a9ebb65130 /advtrains/advtrains_luaautomation/passive_api.txt
parenta8f9e3d43e1a256e73e1a40c261a7145d3652f5b (diff)
downloadadvtrains-b19033b224f4f8ec33f10ba40327f1d811c04fbb.tar.gz
advtrains-b19033b224f4f8ec33f10ba40327f1d811c04fbb.tar.bz2
advtrains-b19033b224f4f8ec33f10ba40327f1d811c04fbb.zip
LuaAutomation - Basic component implementation
Implements the base code for LuaAutomation, an ATC rail and a punch-operated 'operation panel' as well as interface for passive components. Changes in advtrains code where neccessary. Supported passive components are light signals, switches and mesecon switches
Diffstat (limited to 'advtrains/advtrains_luaautomation/passive_api.txt')
-rw-r--r--advtrains/advtrains_luaautomation/passive_api.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/advtrains/advtrains_luaautomation/passive_api.txt b/advtrains/advtrains_luaautomation/passive_api.txt
new file mode 100644
index 0000000..a735208
--- /dev/null
+++ b/advtrains/advtrains_luaautomation/passive_api.txt
@@ -0,0 +1,23 @@
+Lua Automation - Passive Component API
+
+Passive components are nodes that do not have code running in them. However, active components can query these and request actions from them. Examples:
+Switches
+Signals
+Displays
+Mesecon Transmitter
+
+All passive components have a table called 'luaautomation' in their node definition and have the group 'save_in_nodedb' set, so they work in unloaded chunks.
+Example for a switch:
+luaautomation = {
+ getstate = function(pos, node)
+ return "st"
+ end,
+ -- OR
+ getstate = "st",
+
+ setstate = function(pos, node, newstate)
+ if newstate=="cr" then
+ advtrains.ndb.swap_node(pos, <corresponding switch alt>)
+ end
+ end
+} \ No newline at end of file