====== Train Fields ======
This is a guide to the fields that you can configure for the entirety of a train from the onboard computer menu. It is a friendly format for end users.

For fields that are configured for a specific wagon in a train, see [[usage:wagon_fields]].

Developers: you will want to check the documentation on [[dev:core:train]] for all the additional properties on a train that aren't configurable and for technical details.


===== Summary =====

^ Field ^ Description ^
| Outside text | The text visible when you're facing the train from outside |
| Inside text  | The text visible when you're inside the train |
| Line | A single identifier for the line or service that the train is operating |
| Routing Code | One or more identifiers for helping route the train and determine where it may stop |

===== Outside text =====

This text is visible only when outside the train and you are pointing at the train's selection box. The text may be followed by train, wagon and owner information if the setting "Show ID's in infotext" is enabled.

For passenger trains, it is typical to put the service name/number and direction on the outside text. You may also consider updating it at specific stations to give information such as the remaining stops or major stations on the line.

For freight trains, service information may also be given and/or the owner (individual or company) of the train.

For trains that are out of service, a warning about this can be given with the outside text. (There can be other visual hints for an out-of-service train, for example the special Line "X" can display a big red X on the Basic Trains [[usage:trains:basic_trains:advtrains_subway]].

===== Inside text =====

This text is visible only when inside the train. It is most useful for information onboard passengers of the current station, next station and departure times for the next station, or when the train has reached the end of the line or is going out of service (for trains going out of service, one can use the feature of the [[usage:lines:stoprail]] that kicks passengers off the train).

If a train uses the [[usage:lines:stoprail]], it will automatically update the inside text to say what station has been arrived at, and count down to the departure time.

===== Line =====

//Please note that Line Numbers and Routing Codes are case-sensitive, so RC FREIGHT is different from RC Freight.//

Often shortened to LN, especially in the context of [[usage:interlocking:ars]] and sometimes called the line number, the Line is not required to be a number but often is, especially on metro systems. LN is a singular identifier for the line or service that the train is running. 

Though it's often called the line "number", it's not actually required to be a number. For instance, there might be a metro line in a city with LN A. There's nothing stopping you from adding spaces inside of a line number, but that doesn't match with convention and works against the way that ARS works.

One could conceivably have service-pattern specific line numbers though like 1UP, 2DN for the main route in each direction (Wikipedia: [[https://en.wikipedia.org/wiki/Rail_directions|Rail directions]]), or maybe a 1 and 1a for short running.

===== Routing Code =====

Routing Code (RC) is by convention any number of identifying codes that tell signals about where the train would like to be routed. Each separate code is separated by a space in the RC field on the train.

For more information about using LNs and RCs in practice for interlocked trains, see [[usage:interlocking:ars]]