Table of Contents

ATC controller

Unleash the full power of Advtrains by sending Automatic Train Control commands.

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

Mod: advtrains_train_track
Node name: advtrains:dtrack_atc_placer
Other names:

Craft recipe

This node has no craft recipe.

Extended description

2019-01-01 15:00:00: WARNING[Server]: [advtrains]500000 ATC command parse error: Unknown command: malformed ATC 1

ATC command syntax

In ATC commands, spaces are ignored and can be inserted as needed.

Speed commands

S<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:

Execution of the ATC command continues immediately.

B<speed>

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 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.

W

Pauses execution of the ATC command until S and B directives reached the desired speed.

Please use with caution. If the train is never able to reach the desired speed, this directive will probably break your ATC command.

R

Reverses movement direction of train. Has only effect while the train is standing.

Door commands

OL, OR

Open left or right doors. Whether doors are left or right are relative to ATC controller arrow direction. So if you try to drive in wrong direction (the “right” direction being when you placed the rail towards driving direction), the OL command will open right doors compared to driver perspective.

If you open left doors with OL, however, you will not be able to open right doors using OR, and vice-versa.

Execution of the ATC command continues immediately.

OC

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

Advtrains only supports the if conditional statement. Such statements are expressed as follows:

I<condition><code>;

where <condition> is one of the conditions described below, and <code> is a regular ATC command. Notice the semi-colon which is required, otherwise you get two warnings like this:

2019-01-01 15:00:00: WARNING[Server]: Undeclared global variable “id” accessed at /home/username/.minetest/mods/advtrains/advtrains/atc.lua:274
2019-01-01 15:00:00: WARNING[Server]: [advtrains]nil ATC command syntax error: I statement not closed: I+S2 1

If you want to add an else branch, you can use this variant:

I<condition><ifcode>E<elsecode>;

+, -

Tests whether the train is driving in the right direction. + becomes true when it drives in direction of arrow; otherwise it is false. - is the opposite of +.

<, <=, >, >=

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.

Although there is no direct command, it is possible to use nested conditional commands to test for equality or inequality:

I<8
 Not equal to 8
E
 I>8
  Not equal to 8
 E
  Equal to 8
;;

Unfortunately the command

I+I<=8I>=8B0;;;

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 luaatc-extensions branch of Advtrains.

Examples

S, B

W, R

Cpl

OL, OR, OC

I, +/-, </<=/>/>=

Trivia