aboutsummaryrefslogtreecommitdiff
path: root/advtrains
diff options
context:
space:
mode:
Diffstat (limited to 'advtrains')
-rw-r--r--advtrains/doc/advtrains_speed_lessp.3advtrains.md15
-rw-r--r--advtrains/doc/advtrains_speed_set_restriction.3advtrains.md18
-rw-r--r--advtrains/doc/signal_aspect.7advtrains.md24
3 files changed, 0 insertions, 57 deletions
diff --git a/advtrains/doc/advtrains_speed_lessp.3advtrains.md b/advtrains/doc/advtrains_speed_lessp.3advtrains.md
deleted file mode 100644
index 663aa42..0000000
--- a/advtrains/doc/advtrains_speed_lessp.3advtrains.md
+++ /dev/null
@@ -1,15 +0,0 @@
-% advtrains_speed_lessp(3advtrains) | Advtrains Developer's Manual
-
-# NAME
-`advtrains.speed.lessp`, `advtrains.speed.greaterp`, `advtrains.speed.not_lessp`, `advtrains.speed_not_greaterp`, `advtrains.speed.equalp`, `advtrains.speed.not_equalp`, `advtrains.speed.max`, `advtrains.speed.min` - speed restriction comparison functions
-
-# SYNOPSIS
-Each function takes two arguments and returns a boolean or (for `advtrains.speed.max` and `advtrains.speed.min`) a valid speed limit
-
-# DESCRIPTION
-
-The functions above correspond to the arithmetic `<`, `>`, `>=`, `<=`, `==`, `~=` operators and the `math.max` and `math.min` functions, respectively. The constants `nil` and `false` are treated as -1.
-
-# NOTES
-
-These functions are trivial to implement and the implementation can be easily embedded into existing code. They are simply provided for convenience.
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`.
diff --git a/advtrains/doc/signal_aspect.7advtrains.md b/advtrains/doc/signal_aspect.7advtrains.md
deleted file mode 100644
index 827760d..0000000
--- a/advtrains/doc/signal_aspect.7advtrains.md
+++ /dev/null
@@ -1,24 +0,0 @@
-% signal_aspect(7advtrains) | Advtrains Developer's Manual
-
-# DESCRIPTION
-
-The signal aspect table used by advtrains has the following fields:
-
-* `main`: The main speed restriction
-* `dst`: The `main` aspect of the distant signal (not implemented)
-* `type`: The type of speed restriction given by the signal
-* `shunt`: Whether shunting is allowed
-* `proceed_as_main`: Whether to proceed without shunting
-
-The `main` and `dst` fields may contain the following values:
-* `-1`: No speed restriction
-* `nil`: No information is available
-
-The `type` field can be any valid table index, but it should usually be one of the following values:
-* "main": The main signal aspect used before the introduction of speed restriction types. This is the default value if the `type` field is absent.
-* "line": The speed limit for the physical line.
-* "temp": The speed limit that is temporarily introduced.
-
-# NOTES
-
-A signal with the `main` aspect of zero should not provide distant signal aspect.