From d65c4916ceaeed6eec5fe3f344d4e71b3c96a80b Mon Sep 17 00:00:00 2001
From: rubenwardy <rubenwardy@gmail.com>
Date: Wed, 20 Sep 2017 17:05:04 +0100
Subject: Remove zip release files, move mod to root, exclude assets from
 Makefile (#92)

---
 advtrains_luaautomation/passive_api.txt | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 advtrains_luaautomation/passive_api.txt

(limited to 'advtrains_luaautomation/passive_api.txt')

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
-- 
cgit v1.2.3