diff options
| author | Y. Wang <yw05@forksworld.de> | 2022-04-03 12:24:07 +0200 |
|---|---|---|
| committer | Y. Wang <yw05@forksworld.de> | 2022-04-03 12:25:03 +0200 |
| commit | 0fdbf53e5ecdec1ec9cd0162cc6cc0fd86baa8d8 (patch) | |
| tree | b1cc08015e6e232a18879d91e66ebded7ff85aea /advtrains/doc/advtrains_speed_set_restriction.3advtrains.md | |
| parent | f8cd7018a5ee4ad848a4aa78a58e3dab30d8c611 (diff) | |
| download | advtrains-0fdbf53e5ecdec1ec9cd0162cc6cc0fd86baa8d8.tar.gz advtrains-0fdbf53e5ecdec1ec9cd0162cc6cc0fd86baa8d8.tar.bz2 advtrains-0fdbf53e5ecdec1ec9cd0162cc6cc0fd86baa8d8.zip | |
Remove documentation files that are merged into the manual
Diffstat (limited to 'advtrains/doc/advtrains_speed_set_restriction.3advtrains.md')
| -rw-r--r-- | advtrains/doc/advtrains_speed_set_restriction.3advtrains.md | 18 |
1 files changed, 0 insertions, 18 deletions
diff --git a/advtrains/doc/advtrains_speed_set_restriction.3advtrains.md b/advtrains/doc/advtrains_speed_set_restriction.3advtrains.md deleted file mode 100644 index b3183c6..0000000 --- a/advtrains/doc/advtrains_speed_set_restriction.3advtrains.md +++ /dev/null @@ -1,18 +0,0 @@ -% 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`. |