aboutsummaryrefslogtreecommitdiff
path: root/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md
diff options
context:
space:
mode:
Diffstat (limited to 'assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md')
-rw-r--r--assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md b/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md
new file mode 100644
index 0000000..1df5358
--- /dev/null
+++ b/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md
@@ -0,0 +1,17 @@
+% SPEED_SET_RESTRICTION(3ADVTRAINS) | Advtrains Developer's Manual
+
+# NAME
+`set_restriction`, `merge_aspect` - Apply speed limits to trains
+
+# SYNOPSIS
+
+* `set_restriction(train, type, val)`
+* `merge_aspect(train, asp)`
+
+# DESCRIPTION
+`set_restriction()` sets the speed restriction of the given type of the given train to `val` and updates train object correspondingly.
+
+`merge_aspect()` sets the speed restriction of the given train based on the value of the signal aspect.
+
+# RETURN VALUE
+`set_restriction()` and `merge_aspect()` do not return any value.