diff options
| -rw-r--r-- | advtrains/doc/advtrains_speed_lessp.3advtrains.md | 15 | ||||
| -rw-r--r-- | advtrains/doc/advtrains_speed_set_restriction.3advtrains.md | 18 | ||||
| -rw-r--r-- | advtrains/doc/signal_aspect.7advtrains.md | 24 | ||||
| -rw-r--r-- | advtrains_signals_ks/doc/advtrains_signals_ks.7advtrains.md | 52 | ||||
| -rw-r--r-- | atc_command.txt | 95 |
5 files changed, 0 insertions, 204 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. diff --git a/advtrains_signals_ks/doc/advtrains_signals_ks.7advtrains.md b/advtrains_signals_ks/doc/advtrains_signals_ks.7advtrains.md deleted file mode 100644 index 126ecf0..0000000 --- a/advtrains_signals_ks/doc/advtrains_signals_ks.7advtrains.md +++ /dev/null @@ -1,52 +0,0 @@ -% advtrains_signals_ks(7advtrains) | Advtrains User Guide - -# NAME -`advtrains_signals_ks` - Ks signals for advtrains - -# DESCRIPTION - -This mod includes a modified subset of German rail signals. This page documents the signals implemented by this mod and some differences between this mod and German signals used in real life. - -# SIGNAL ASPECTS - -This section mainly describes the different signal aspects. Please note that the meaning of some signal aspects may differ from their RL counterparts, and that the differences documented in the following section are not comprehensive. - -Due to historical reasons, "ex-DB" and "ex-DR" are used to refer to the former Deutsche Bundesbahn (West Germany) and the former Deutsche Reichsbahn (East Germany), respectively. - -## Ks signals -The Ks signals are used like most other signals in advtrains. It has the following aspects: - -* Hp 0 (red light): Stop -* Ks 1 (green light): Proceed at maximum speed or with the speed limit shown on the Zs 3 indicator directly above the signal (if present) and expect to proceed the next main signal at maximum speed or, if the green light is flashing, with the speed limit shown on the Zs 3v indicator directly below the signal -* Ks 2 (yellow light): Proceed at maximum speed or with the speed limit shown on the Zs 3 indicator directly above the signal (if present) and expect to stop in front of the next main signal. - -In addition, Sh 1 (see below) may also appear with Hp 0, in which case the train continues in shunt mode. - -## Shunt signals -Shunt signals are labeled "Ks Shunting signal" in-game. It has the following aspects: - -* Sh 0 (two horizontally aligned red lights): Stop -* Sh 1/(ex-DR) Ra 12 (two white lights aligned on a slanted line): shunting allowed - -## Signal signs -There are a few signal signs provided by this mod: - -* Zs 3 (white number on a black background): Proceed with the permanent speed limit shown on the sign -* Zs 10 (an sign shaped like an upward-pointing arrow): The speed limit previously set by Zs 3 is lifted -* Lf 1/2 (black number on an orange background): Proceed with the temporary speed limit shown on the sign -* Lf 3 (black letter "E" on a white background): The temporary speed limit previously set by Lf 1/2 is lifted -* Lf 7 (black number on a white background): Proceed with the line speed limit shown on the sign -* Ra 10 (the black text "Halt für Rangierfahrten" on a white semicircle): Do not proceed if in shunt mode -* Proceed as main ("PAM", in-game only) ("S" below a green arrow): Proceed without shunt mode - -# DIFFERENCES FROM REAL-LIFE SIGNALING - -[This document](https://www.bahnstatistik.de/Signale_pdf/SB-DBAG.pdf) is used for reference, - -* The speed is indicated in m/s instead of multiples of 10km/h. -* Due to the potentially large number of nodes, only certain hard-coded values are allowed. -* Certain visual effects, such as making signal signs reflective or lit at night, are not implemented. -* Distant signaling is not yet implemented. -* The location of most signals are not checked. The location of Zs 3 and Zs 3v are only checked relative to the location of the main (Ks) signal. -* The "shunt signals" in this mod are actually known as "Schutzsignale". The word "Rangiersignale" refers to a different set of signals (including acoustic signals) given by the person specifically responsible for train shunting. -* The ex-DB definition of Sh 1 ("Fahrverbot aufgehoben") is that the track section ahead is clear and does not imply that the driver is allowed to proceed. diff --git a/atc_command.txt b/atc_command.txt deleted file mode 100644 index 5a1c8ff..0000000 --- a/atc_command.txt +++ /dev/null @@ -1,95 +0,0 @@ -ATC Command Syntax - -A train runs the current ATC command once it receives it, including delayed instructions. If the train receives a new command, the current command is discarded. -Spaces can be inserted into commands as needed and are ignored. - -# simple commands: - -S<[0-9]+ speed or 'M'> -Set target speed of train to <speed>. Accelerates if slower, rolls if faster. 'M' means maximum speed. -Execution of command continues immediately. - -B<[0-9]+ speed> -Brake until speed is reached. If faster, apply brakes, if slower, do nothing. -Execution of command continues immediately. - -Examples: -SM : accelerate to maximum speed -S0 : roll to stand -B0 : brake to stand -S0B3 or B3S0: brake to 3, then roll to stand. - -W -Wait until S and/or B commands reached the desired speed before continuing execution. - -D<[0-9]+ time> -Delay: Wait for time seconds before continuing execution. - -R -Reverse: change movement direction of train. ONLY WORKS WHEN TRAIN STANDS, else no-op. -Use B0WR to definitely change direction. - -Examples: -B0 W R D10 SM -Subway train stopping in dead end station and returning in opposite direction - -OL -Open left doors -OR -Open right doors -OC -Close Doors -All door commands are relative to the arrow direction, so if a train drives to opposite arrow direction, L will open its right doors from driver perspective. -Execution continues immediately, there is no way to wait for all doors to be opened/closed. - -Example: -B0 W OL D10 OC D1 SM -Subway train: stop in station and open doors, depart after 10 seconds. - -K -Kick all passengers out of the trains -This command kicks all passengers (non-driving players) off the train. This command works only -if the train is stopped and its doors are open. - -Cpl -Temporarily switch the train to "Autocouple" mode and wait for coupling. -This command makes the train continue at its current speed until it hits another standing wagon or train. Then, it couples to this train and ATC command execution continues. - -# conditional statements: - -I<condition><code>; -Execute code only if condition applies -I<condition><code1>E<code2>; -Execute code1 only if condition applies, else execute code2 - -Conditions: -+ / - -Tests the train's movement direction against the arrow on the ATC rail: M+ is true when train drives in direction of arrow. - -[</>/<=/>=][speed] -Test if train's speed is greater or smaller than the given value - -Examples: -I- B0 W R ; S8 -If the train drives in the 'wrong' direction, stop and reverse; independently accelerate to speed 8 afterwards. - -I<8 S8 ; -If the train is slower than 8, accelerate to 8. - -# Interlocking - -With advtrains_interlocking, there's one more available command: - -A0 -Disable ARS on the train. -A1 -Enable ARS on the train. -When disabled, the train will not trigger automatic route setting on signals based on ARS. - -# Persistence -ATC controllers that are configured as 'static' or 'mesecon' are persistent over mapblock unloads and will even command the train when the mapblock is unloaded. This is not possible with digilines since these do not work in unloaded mapchunks. - -# LUA ATC controller (in development) -The LUA ATC Controller will operate by using LUA code. All operations shown above will have a function equivalent. Additionally all LUA ATC controllers share an environment and setting signal and switch status will be possible to allow for complicated railway systems/fully automated subways a.s.o. -Also planned: -- digicompute add-on to allow computer access to the ATC environment (railway maps... ... ... ... ...) |