diff options
Diffstat (limited to 'advtrains_luaautomation/passive_api.txt')
| -rw-r--r-- | advtrains_luaautomation/passive_api.txt | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/advtrains_luaautomation/passive_api.txt b/advtrains_luaautomation/passive_api.txt new file mode 100644 index 0000000..5ae1df4 --- /dev/null +++ b/advtrains_luaautomation/passive_api.txt @@ -0,0 +1,24 @@ +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 +Those passive components can also be used inside interlocking systems. + +All passive components have a table called 'advtrains' in their node definition and have the group 'save_in_at_nodedb' set, so they work in unloaded chunks. +Example for a switch: +advtrains = { + 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 |