aboutsummaryrefslogtreecommitdiff
path: root/advtrains_luaautomation/passive_api.txt
diff options
context:
space:
mode:
authorrubenwardy <rubenwardy@gmail.com>2017-09-20 17:05:04 +0100
committerorwell96 <mono96.mml@gmail.com>2017-09-20 18:05:04 +0200
commitd65c4916ceaeed6eec5fe3f344d4e71b3c96a80b (patch)
treeae2a4a1ca5bdbcb0a2a867287d4556f92478405a /advtrains_luaautomation/passive_api.txt
parentb75c83ea43bb9f6e3bee2b4db955e2a9e7be885e (diff)
downloadadvtrains-d65c4916ceaeed6eec5fe3f344d4e71b3c96a80b.tar.gz
advtrains-d65c4916ceaeed6eec5fe3f344d4e71b3c96a80b.tar.bz2
advtrains-d65c4916ceaeed6eec5fe3f344d4e71b3c96a80b.zip
Remove zip release files, move mod to root, exclude assets from Makefile (#92)
Diffstat (limited to 'advtrains_luaautomation/passive_api.txt')
-rw-r--r--advtrains_luaautomation/passive_api.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/advtrains_luaautomation/passive_api.txt b/advtrains_luaautomation/passive_api.txt
new file mode 100644
index 0000000..a735208
--- /dev/null
+++ b/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