diff options
| author | Y. Wang <yw05@forksworld.de> | 2022-08-10 11:16:05 +0200 |
|---|---|---|
| committer | Y. Wang <yw05@forksworld.de> | 2022-08-10 11:16:05 +0200 |
| commit | 80f2f33bfb2b9bf8d38db86aa7b1a982fd7a548d (patch) | |
| tree | 1baaae42bfd67c3c6b1084acbcaa1a9cfa1773dc /assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md | |
| parent | 764f7d42913698d9c46f6b1adcff4f0fd73a86b0 (diff) | |
| download | advtrains-80f2f33bfb2b9bf8d38db86aa7b1a982fd7a548d.tar.gz advtrains-80f2f33bfb2b9bf8d38db86aa7b1a982fd7a548d.tar.bz2 advtrains-80f2f33bfb2b9bf8d38db86aa7b1a982fd7a548d.zip | |
Reformat advtrains.speed docs as manual pages; minor formatting changes
Diffstat (limited to 'assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md')
| -rw-r--r-- | assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md | 17 |
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. |