aboutsummaryrefslogtreecommitdiff
path: root/advtrains/doc/advtrains_speed_set_restriction.3advtrains.md
diff options
context:
space:
mode:
authorywang <yw05@forksworld.de>2021-11-07 19:01:45 +0100
committerywang <yw05@forksworld.de>2021-11-07 19:01:45 +0100
commit3f6cef730838ed9ab20e445e4078ecc504f1e72e (patch)
tree076fa3be47fb0ed701275664209ec6cd022068c9 /advtrains/doc/advtrains_speed_set_restriction.3advtrains.md
parent3c92fa597cf5b0baf1ccbcb673e51a205ba6dbdb (diff)
downloadadvtrains-3f6cef730838ed9ab20e445e4078ecc504f1e72e.tar.gz
advtrains-3f6cef730838ed9ab20e445e4078ecc504f1e72e.tar.bz2
advtrains-3f6cef730838ed9ab20e445e4078ecc504f1e72e.zip
Add documentation on signal aspects
Diffstat (limited to 'advtrains/doc/advtrains_speed_set_restriction.3advtrains.md')
-rw-r--r--advtrains/doc/advtrains_speed_set_restriction.3advtrains.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/advtrains/doc/advtrains_speed_set_restriction.3advtrains.md b/advtrains/doc/advtrains_speed_set_restriction.3advtrains.md
new file mode 100644
index 0000000..b3183c6
--- /dev/null
+++ b/advtrains/doc/advtrains_speed_set_restriction.3advtrains.md
@@ -0,0 +1,18 @@
+% advtrains_speed_set_restriction(3advtrains) | Advtrains Developer's Manual
+
+# NAME
+`advtrains.speed.set_restriction`, `advtrains.speed.merge_aspect` - modify speed restriction
+
+# SYNOPSIS
+* `advtrains.speed.set_restriction(train, rtype, rval)`
+* `advtrains.speed.merge_aspect(train, asp)`
+
+# DESCRIPTION
+
+The `advtrains.speed.set_restriction` function sets the speed restriction of type `rtype` of `train` to `rval` and updates the speed restriction value to the strictest speed restriction in the table, or `nil` if all speed restrictions are `nil` or `-1`. If the speed restriction table does not exist, it is created with the `"main"` speed restriction being the speed restriction value of `train`.
+
+The `advtrains.speed.merge_aspect` function merges the main aspect of `asp` into the speed restriction table with the same procedure described above. If the signal aspect table does not provide the type of speed restriction, the restriction type `"main"` is assumed.
+
+# SIDE EFFECTS
+
+Both functions modify `train.speed_restriction` and `train.speed_restrictions_t`.