From 80f2f33bfb2b9bf8d38db86aa7b1a982fd7a548d Mon Sep 17 00:00:00 2001 From: "Y. Wang" Date: Wed, 10 Aug 2022 11:16:05 +0200 Subject: Reformat advtrains.speed docs as manual pages; minor formatting changes --- .../man3advtrains/speed_set_restriction.3advtrains.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md (limited to 'assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md') 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. -- cgit v1.2.3