Advanced Trains

User Tools

Site Tools

You are here: Advanced Trains » User Guide » Advtrains Nodes » ATC controller
usage:nodes:atc_controller

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
usage:nodes:atc_controller [2019-07-02 10:30]
82.67.173.193 changed bold to monospace 		usage:nodes:atc_controller [2022-06-27 02:32] (current)
blockhead [Speed commands] grammar
Line 1: Line 1:
 ====== ATC controller ====== ====== ATC controller ======
-{{ http://git.bananach.space/advtrains.git/plain/advtrains_train_track/textures/advtrains_dtrack_atc_placer.png?nolink&50 }}+{{ :usage:nodes:advtrains_dtrack_atc_placer.png?80 }}
 //Unleash the full power of Advtrains by sending Automatic Train Control commands.// //Unleash the full power of Advtrains by sending Automatic Train Control commands.//
  
-//Note: this page has been written for Advtrains 2.0.1 TSS and Minetest 5.1.0. Examples and practices described in this page don't take advantage of improvements introduced in later releases.//+//Note: this page has been written for Advtrains 2.1.0 and Minetest 5.1.0. Examples and practices described in this page don't take advantage of improvements introduced in later releases.//
  
 ===== Properties ===== ===== Properties =====
 Mod: ''advtrains_train_track'' \\  Mod: ''advtrains_train_track'' \\ 
-Node name: **advtrains:dtrack_atc_placer'' \\ +Node name: ''advtrains:dtrack_atc_placer'' \\ 
 Other names: Other names:
   * ''advtrains:dtrack_atc_st''   * ''advtrains:dtrack_atc_st''
Line 35: Line 35:
 In ATC commands, spaces are ignored and can be inserted as needed. In ATC commands, spaces are ignored and can be inserted as needed.
  
-==== Simple directives ====+==== Speed commands ====
 === S<speed> === === S<speed> ===
  
-Sets the target speed of driving train to ''<speed>''. The train accelerates if faster than current speed, rolls if slower, and does nothing if at the same speed.+Sets the target speed of driving train to ''<speed>''. The train accelerates if slower than target speed, rolls down to a slower speed if faster, and does nothing if at the same speed.
  
 ''<speed>'' can be either: ''<speed>'' can be either:
-  * a number constituted only of digits. This represents an [[usage:trains#advtrains_speed_unit|Advtrains speed unit]], or +  * a number constituted only of digits. This represents the speed in metres per second (1 m/s = 3.6 km/h), or 
-  * the special value **M**, which represents the maximal speed of the train as defined by the entity definition passed to [[reference:advtrains:register_wagon|advtrains.register_wagon]].+  * the special value **M**, which represents the maximal speed of the train as defined by the entity definition passed to [[dev:core:funref:register_wagon|advtrains.register_wagon]].
  
 Execution of the ATC command continues **immediately**. Execution of the ATC command continues **immediately**.
Line 50: Line 50:
 Brakes until the train speed reaches ''<speed>''. The train applies brakes if slower than current speed, and does nothing if not. Brakes until the train speed reaches ''<speed>''. The train applies brakes if slower than current speed, and does nothing if not.
  
-''<speed>'' should be a number constituted only of digits, representing an [[usage:trains#advtrains_speed_unit|Advtrains speed unit]].+''<speed>'' should be a number constituted only of digits, representing a speed in metres per second. 
 + 
 +Execution of the ATC command continues **immediately**. 
 + 
 +=== BB === 
 + 
 +Activates the emergency brake. In this mode, the deceleration is higher than with standard brake (i.e. ''B0'').
  
 Execution of the ATC command continues **immediately**. Execution of the ATC command continues **immediately**.
Line 63: Line 69:
  
 Reverses movement direction of train. Has only effect while the train is standing. Reverses movement direction of train. Has only effect while the train is standing.
 +
 +==== Door commands ====
  
 === OL, OR === === OL, OR ===
Line 75: Line 83:
  
 Close doors previously opened by ''OL'' or ''OR''. Close doors previously opened by ''OL'' or ''OR''.
 +
 +=== K ===
 +
 +Kicks all passengers (except drivers) out of the train. Door must be opened to do this. Useful at terminal stations.
 +
 +==== Other Commands ====
 +
 +=== 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.
 +
 +After coupling, the train retains its current target speed. If you do not include a ''B0'' command after ''Cpl'', the train will immediately start moving again.
 +
 +**Note to LuaATC users:** When using this command, the train running the ATC command is guaranteed to retain its Train ID. The Train ID of the standing train that it is coupled to becomes invalid.
 +
 +//Note: This command is unique in that its command code is a 3-letter code. Future ATC extensions should also introduce multi-letter codes to avoid exhaustion of letter space for single-letter codes.//
  
 ==== Conditional statements ==== ==== Conditional statements ====
Line 98: Line 124:
 === <, <=, >, >= === === <, <=, >, >= ===
  
-Compares the current train speed to the given speed. That speed should be a number constituted only of digits, representing an [[usage:trains#advtrains_speed_unit|Advtrains speed unit]].+Compares the current train speed to the given speed. That speed should be a number constituted only of digits, and in metres per second.
  
 It is not currently possible to test directly the speed for equality or inequality. It is not currently possible to test directly the speed for equality or inequality.
  
-==== Examples ==== +Although there is no direct command, it is possible to use nested conditional commands to test for equality or inequality: 
-=== S, B ===+<code> 
 +I<8 
 + Not equal to 8 
 +E 
 + I>8 
 +  Not equal to 8 
 + E 
 +  Equal to 8 
 +;; 
 +</code> 
 + 
 +Unfortunately the command <code>I+I<=8I>=8B0;;;</code> can't be parsed and the parser complains. For now you will have to not nest I+ commands inside I< commands. 
 + 
 +==== Specific commands ==== 
 + 
 +=== A<enable_interlocking> === 
 +Either enables (''A1'') or disables (''A0'') interlocking on the train.   
 +When disabled, the train will not trigger automatic route setting on signals based on ARS. 
 + 
 +**This command is available only in the ''[[http://git.bananach.space/advtrains.git/tree/?h=luaatc-extensions|luaatc-extensions]]'' branch of Advtrains.** 
 + 
 +===== Examples ===== 
 + 
 +==== S, B ====
  
   * ''SM'': accelerate to maximum speed   * ''SM'': accelerate to maximum speed
Line 111: Line 160:
   * ''S0 B3'' or ''B3 S0'': brake to 3, then roll to stand.   * ''S0 B3'' or ''B3 S0'': brake to 3, then roll to stand.
  
-=== W, R ===+==== W, R ====
  
   * ''S5 W'': set target speed to 5 (~ 18 km/h), and wait for speed to be 5   * ''S5 W'': set target speed to 5 (~ 18 km/h), and wait for speed to be 5
Line 117: Line 166:
   * ''B0 W D10 SM'': brake to stand, wait 10 seconds after the train stopped, and reverse direction of train   * ''B0 W D10 SM'': brake to stand, wait 10 seconds after the train stopped, and reverse direction of train
  
-=== OL, OR, OC ===+==== Cpl ==== 
 + 
 +  * ''S2 Cpl B0 W D2 R S4'': Drives a locomotive towards a group of wagons, couple to them, wait 2 seconds and then pull the wagons in the opposite direction with speed 4. 
 + 
 +==== OL, OR, OC ====
  
   * ''B0 W OL D10 OC D1 SM'': example of train stopping at a standard station with doors opening on the left   * ''B0 W OL D10 OC D1 SM'': example of train stopping at a standard station with doors opening on the left
   * ''B0 W OL R D20 OC D1 SM'': example of train stopping at a terminus station, with returning in opposite direction   * ''B0 W OL R D20 OC D1 SM'': example of train stopping at a terminus station, with returning in opposite direction
  
-=== I, +/-, </<=/>/>= ===+==== I, +/-, </<=/>/>= ====
  
-  * ''I + S2;'': if the train is going in the right direction, set target speed to 2 +  * ''I+S2;'': if the train is going in the right direction, set target speed to 2 
-  * ''I + SM E B0;'': if the train is going in the right direction, accelerate, otherwise stop +  * ''I+SMEB0;'': if the train is going in the right direction, accelerate, otherwise stop 
-  * ''I <8 S8;'': if the train is slower than 8 (~ 30 km/h), set target speed to 8+  * ''I<8S8;'': if the train is slower than 8 (~ 30 km/h), set target speed to 8
  
 ===== Trivia ===== ===== Trivia =====
usage/nodes/atc_controller.1562063417.txt.gz · Last modified: 2019-07-02 10:30 by 82.67.173.193

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki