aboutsummaryrefslogtreecommitdiff
path: root/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md
diff options
context:
space:
mode:
authorY. Wang <yw05@forksworld.de>2022-08-11 19:07:42 +0200
committerY. Wang <yw05@forksworld.de>2022-08-11 19:55:30 +0200
commitb4ac74c41911ee7771e88da91208c1eb16c4b752 (patch)
treeb2d9678b8c09260f28ca8ccd1b66f27ca0ae4a96 /assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md
parentbdcd24f6f78ed62f43b418a5bb50553001b5a6ec (diff)
downloadadvtrains-b4ac74c41911ee7771e88da91208c1eb16c4b752.tar.gz
advtrains-b4ac74c41911ee7771e88da91208c1eb16c4b752.tar.bz2
advtrains-b4ac74c41911ee7771e88da91208c1eb16c4b752.zip
Reformat manual pages
Diffstat (limited to 'assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md')
-rw-r--r--assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md b/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md
index 1df5358..1a3bd80 100644
--- a/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md
+++ b/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md
@@ -1,17 +1,20 @@
-% SPEED_SET_RESTRICTION(3ADVTRAINS) | Advtrains Developer's Manual
+---
+title: 'speed_set_restriction(3advtrains)'
+manual: 'Advtrains Developer''s Manual'
+---
-# NAME
+# Name
`set_restriction`, `merge_aspect` - Apply speed limits to trains
-# SYNOPSIS
+# Synopsis
* `set_restriction(train, type, val)`
* `merge_aspect(train, asp)`
-# DESCRIPTION
+# 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
+# Return Value
`set_restriction()` and `merge_aspect()` do not return any value.