aboutsummaryrefslogtreecommitdiff
path: root/assets/manual/man
diff options
context:
space:
mode:
Diffstat (limited to 'assets/manual/man')
-rw-r--r--assets/manual/man/man7advtrains/node_definition.7advtrains.md27
-rw-r--r--assets/manual/man/man7advtrains/signal_aspects.7advtrains.md25
-rw-r--r--assets/manual/man/man7advtrains/speed.7advtrains.md1
3 files changed, 53 insertions, 0 deletions
diff --git a/assets/manual/man/man7advtrains/node_definition.7advtrains.md b/assets/manual/man/man7advtrains/node_definition.7advtrains.md
new file mode 100644
index 0000000..c662614
--- /dev/null
+++ b/assets/manual/man/man7advtrains/node_definition.7advtrains.md
@@ -0,0 +1,27 @@
+---
+title: 'NODE_DEFINITION(7ADVTRAINS) | Advtrains Developer''s Manual'
+seealso:
+- signal_aspects(7advtrains)
+---
+
+# NAME
+`node_definition` - Advtrains-specific node definition entries
+
+# DESCRIPTION
+This page describes various fields in node definition tables that are used by Advtrains.
+
+# NODE GROUPS
+Advtrains uses node groups to identify certain properties of a node. The following node groups are currently read by Advtrains:
+
+* `advtrains_signal`: When set, this property defines the type of signal this node belongs to. `1` indicates that this node is a static signal, and `2` indicates that this node is a signal with a variable aspect.
+* `not_blocking_trains`: When set to 1, trains can move through this node.
+* `save_in_at_nodedb`: When set to 1, this node should be saved in the internal node database used by Advtrains.
+
+# THE `advtrains` FIELD
+The `advtrains` field in the node definition may contain the following fields:
+
+* `get_aspect(pos, node)`: This function should return the signal aspect of the node at the given position.
+
+* `set_aspect(pos, node, asp)`: This function should set the signal aspect of the node to `asp` if possible. `asp` is not guranteed to be an aspect supported by the node.
+
+* `supported_aspects`: This table should contain a list of supported signal aspects.
diff --git a/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md b/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md
new file mode 100644
index 0000000..0066f7f
--- /dev/null
+++ b/assets/manual/man/man7advtrains/signal_aspects.7advtrains.md
@@ -0,0 +1,25 @@
+---
+title: 'SIGNAL_ASPECTS(7ADVTRAINS) | Advtrains Developer''s Manual'
+seealso:
+- speed(7advtrains)
+---
+
+# NAME
+`signal_aspects` - Signal aspect tables for Advtrains
+
+# DESCRIPTION
+A signal aspect table describes the status of a signal in relation to a train following it.
+
+A signal aspect table may contain the following fields:
+
+* `main`: The main aspect of the signal
+* `type`: The type of speed restriction imposed by the main aspect
+* `dst`: The distant aspect of the signal
+* `shunt`: A boolean indicating whether shunting is allowed
+* `proceed_as_main`: A boolean indicating whether a train in shunt mode should continue with shunt mode disabled
+
+The `main` and `dst` fields may contain
+
+* A non-negative number indicating the current or next speed limit
+* -1, indicating that the speed limit is or will be lifted
+* `nil`, indicating that the speed limit is or will not be changed
diff --git a/assets/manual/man/man7advtrains/speed.7advtrains.md b/assets/manual/man/man7advtrains/speed.7advtrains.md
index 0977546..eefd764 100644
--- a/assets/manual/man/man7advtrains/speed.7advtrains.md
+++ b/assets/manual/man/man7advtrains/speed.7advtrains.md
@@ -3,6 +3,7 @@ title: 'SPEED(7ADVTRAINS) | Advtrains Developer''s Manual'
seealso:
- speed_lessp(3advtrains)
- speed_set_restriction(3advtrains)
+- signal_aspects(7advtrains)
---
# NAME