GRFSpecs - User contributions [en-gb]

VariationalAction2/Vehicles

2026-10-14T21:28:43Z

Brickblock1: /* Variables */

<div style="float:right; padding-left:12px; background:none;">{{NFONavVehicles}}</div>

== Variables ==

{|
!Variable!![[GRFActionsDetailed|Size]]!!Version!!Description!!Available in purchase list
|-
|10||D||{{ottdp|1.2|no|ottdrev=r23080}}||Pick sprites for different GUI windows - See [[Action2/Vehicles]].||{{ottdp|1.2|no|ottdrev=r23080}}
|-
|40||D||{{ottdp|0.6|2.5}}||Position in consist and length of consist||no
|-
|41||D||{{ottdp|0.6|2.5}}||Position in and length of chain of consecutive vehicles with same ID||no
|-
|42||D||{{ottdp|0.6|2.5}}||Cargo types transported by consist||no
|-
|43||D||{{ottdp|0.6|2.5}}||Player info||{{ottdp|0.6|2.5|ottdrev=r4611|ttdprev=beta 2}}
|-
|44||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 48}}||Aircraft info||no
|-
|45||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 58}}||Curvature info||no
|-
|46||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 59}}||Motion counter||no
|-
|47||D||{{ottdp|0.6|2.5}}||Vehicle cargo info||{{ottdp|0.7|no|ottdrev=r15542}} <ref name="var47">Variable 47 refers to the default cargo of the vehicle, when in purchase list. This differs from the cargo used in Action 3, which is 0xFF in purchase list. The "refit cycle" (F2) is currently always zero in the purchase list.</ref>
|-
|48||D||{{ottdp|0.6|2.5}}||Vehicle type information||{{ottdp|0.6|2.5|ottdrev=r5338|ttdprev=beta 2}}
|-
|49||D||{{ottdp|0.7|2.6|ottdrev=r13376|ttdprev=r2216}}||Year of construction (long format, 0 based)||{{ottdp|0.7|no|ottdrev=r13376}} <ref name="date">This is the current date</ref>
|-
|4A||D||{{ottdp|1.1|no|ottdrev=r20165}}||Info about current railtype/roadtype/tramtype||no
|-
|4B||D||{{ottdp|1.2|no|ottdrev=r23068}}||Long date of last servicing||{{ottdp|1.2|no|ottdrev=r23068}} <ref name="date" />
|-
|4C||D||{{ottdp|1.3|no|ottdrev=r24246}}||Current max speed including e.g track or timetable speed limits. Only valid for front vehicle. Note, units differ for each vehicle type<ref name="speed">See [[Action0Trains#Speed 09|train property 09]], [[Action0RoadVehicles|road vehicle property 08]] (not 15, even when using realistic acceleration), [[Action0Ships|ship property 0B]] and [[Action0Planes|aircraft property 0C]].</ref>||no
|-
|4D||D||{{ottdp|1.4|no|ottdrev=r26157}}||Position within articulated vehicle||no
|-
|60||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 57}}||Count Veh.ID occurence||no
|-
|61||-<ref>The size of the result matches the size of the queried variable.</ref>||{{ottdp|1.2|no|ottdrev=r22997}}||Query variable of n-th vehicle in chain||no
|-
|62||D||{{ottdp|1.2|no|ottdrev=r22998}}||Curvature/position difference for n-th vehicle in chain||no
|-
|63||D||{{ottdp|1.11|no|ottdrev=g868d84bbf}}||Test track-type of tile against another track-type||no
|-
|64||D||{{ottdp|15|no}}||Count badge occurence||no
|-
|65||D||{{ottdp|15|no}}||Test if rail or road type of the current type occupied by the vehicle has that specific badge attached||no
|-
|7A||D||{{ottdp|15|no}}||Test if the vehicle has that specific badge attached||yes
|-
|97||B||{{ottdp|0.6|2.0}}||Tick counter, increased every engine tick||no
|-
|B2||W||||Vehicle status: bit0 = vehicle invisible (in tunnel/depot), bit1 = stopped, bit7 = crashed||no
|-
|B4||W||{{ottdp|0.6|2.0}}||Current speed. Note, units differ for each vehicle type<ref name="speed" />||no
|-
|B9||B||{{ottdp|0.6|2.0}}||Cargo type (type B from the list at [[CargoTypes]]; climate dependent)||no
|-
|C0||W||{{ottdp|0.6|2.0}}||Engine age in days<br/>{{ottdp|1.2|2.5|ottdrev=r22816|ttdprev=alpha 61}} Valid for wagons and articulated parts as well.||no
|-
|C4||B||{{ottdp|0.6|2.0}}||Year built (counted from 1920), note this is modified when Cht: Year is used||{{ottdp|0.6|no|ottdrev=r4611}} <ref name="date" />
|-
|C6||W||{{ottdp|0.6|2.0}}||Vehicle type ID <ref>{{ottdp|0.7|no}} In OpenTTD 0.7 and newer this is the GRF-local ID of the vehicle. Earlier versions of OpenTTD and TTDPatch report the [[VehicleIDs|TTD ID]]. For trains this is the same; for other vehicle types they differ.</ref> (useful for [[Callbacks#Can wagon be attached (1D)|Callback 1D]])||no
|-
|C8||B||{{ottdp|0.6|2.0}}||Sprite type; FD for trains forward, FE or FF when reversed||no
|-
|C9||B||{{ottdp|0.6|2.0}}||Day counter; increased daily||no
|-
|DA||W||{{ottdp|0.6|2.0}}||Next wagon index, FFFF if last wagon (use shift-num=08 and check for FF)||no
|-
|F2||B||{{ottdp|0.6|2.5}}||Refit cycle, how many times refitted to the same cargo type||{{ottdp|0.7|no|ottdrev=r15542}} <ref name="var47" />
|-
|F4||D||{{ottdp|0.5|2.0|ottdrev=3594}}||Current horsepower of train consist||no
|-
|FE||W||{{ottdp|0.6|2.5}}||Modflags||no
|-
|FF||B||{{ottdp|0.6|2.5}}||Modflags||no
|}

<references />

For other 80+x variables confer the [http://marcin.ttdpatch.net/sv1codec/TTD-locations.html#_VehicleArray TTD vehicle structure].

Variables 40, 41, 42 and 43 are cached. This means that while they are in principle computationally expensive, they can be used without impacting performance. Variables 45 and 60 are also computationally expensive but cannot be cached, and should therefore be used sparingly. If possible 80+x variables are to be preferred.

Cached variables are updated when the game is loaded, when the consist enters or is rearranged in a depot, and when the train reverses.

In the purchase list only a few variables are available. Especially the front vehicle (related object) cannot be accessed, nor other articulated parts.

== Description ==
=== Position and length (40, 41) ===

'''Format:''' 00nnbbff

{| |-
!Variable!!Value
|-
|ff||position of vehicle within the consist counted from the engine (front), e.g. the engine would have ff=0, the 1st wagon or mail compartment of planes would have ff=1, the 2nd wagon or the rotor of helicopters would have ff=2, the 3rd wagon would have ff=3 etc
|-
|bb||same as ff, but counted from the end, i.e. the last wagon has bb=0, the next-to-last wagon has bb=1 etc.
|-
|nn||Total number of vehicles in the consist, including shadow and rotor for aircraft.
* In var 40 this is zero-based. That is, the value returned is one less than the actual number of vehicles. A train with engine and three wagons has nn=3.
* In var 41 this is one-based. That is, the value returned is the actual number of vehicles.
|}

For variable 40, these numbers refer to the whole consist, but for variable 41, they only refer to the chain of consecutive vehicles with the same ID as the current wagon (including itself, but possibly excluding the engine):

[[File:vehicle_var40_41.png]]

Note however, that accessing the "related" object (i.e. the locomotive) doesn´t make much sense for vars 40/41, except for var40 when in a [[Callbacks#Can wagon be attached 1D|callback 1D]] chain.

=== Consist cargo (42) ===

'''Format:''' uuiicctt

{| |-
!Variable!!Value
|-
|tt||a bit mask of all [[Action0Cargos#Cargo classes 16|cargo classes]] transported by the consist
|-
|cc||the most common [[CargoTypes|cargo type]] (from the column for type A)
|-
|ii||the most common refit cycle (var. F2) of cargo type cc
|-
|uu||the result of ORing the bits of prop. 25 from all vehicles in the train
|}

If used with VarAction2 type 81 (vehicle) it returns only cargo from this vehicle on, with type 82 (engine) that of the whole consist.
See also variable 47 for more details on the cargo carried by a vehicle.

{{grfTill|7}} For GRF versions 7 and before "cc" is the untranslated bit number from [[Action0/Cargos#Bit_number_for_bitmasks_.2808.29|cargo property 8]].

{{grfFrom|8}} With GRF version 8 the meaning of "cc" changes. If the grf file has installed a [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]], the value in "cc" is the index of the cargo in that table; or FF if the cargo is not present in the table.

=== Player info (43) ===

'''Format:''' Ccttmmnn

{| |-
!Variable!!Value
|-
|nn||the number of the current player from 0 to 7 (up to E (14) in OpenTTD since r14735)
|-
|mm||the multiplayer player number with the host player (or the single player) being 0 and the client player being 1
|-
|tt||the player type, see below for possible values
|-
|c||the primary player colour
|-
|C||{{ottdp|0.6|2.5|ttdprev=r1405}} the secondary player colour, equal to c if none (since r1405)
|}

{| |-
!tt value!!Meaning
|-
|0||Player is human player (permanent company)
|-
|1||Player is AI player (not managed)
|-
|2||{{ottdp|no|2.5}} Player is a human managing an AI company
|-
|3||{{ottdp|no|2.5}} Player is human player's original company, now temporarily AI controlled
|}

{{ottdp|0.6|2.5|ttdprev=r1497}} Since r1497, when the vehicle sprite is being displayed in an exclusive offer window or new vehicle news message, or in other circumstances when no player is associated with the vehicle, nn will be FF.

=== Aircraft info (44) ===

'''Format:''' xxxxhhtt

hh is the height of the aircraft above ground, or more properly above the height of its shadow. Buildings, including the heliport, don't count as "ground", i.e. to get the height above a heliport, you have to subtract the heliport height from hh.

tt is the type of the current airport: 0=small, 1=large, 2=heliport, 3=oil rig. The current airport is the target airport for aircraft that have finished the ascent and are in flight.

=== Curvature info (45) ===

'''Format:''' xxxTxBxF

This returns the amount of curvature between the adjacent wagon pairs. It is useful for train vehicles that normally tilt in curves. The curvature is the difference in direction between the surrounding vehicles:

F = for the front pair (previous wagon to current wagon, 0 if vehicle is first)

B = for the back pair (current wagon to next wagon, 0 if wagon is last)

T = for the triplet (previous wagon to next wagon; is zero in an S-bend)

Possible values:

{| |-
!Decimal!!Hex!!Meaning
|-
| -4||C||180° curve left (T only)
|-
| -3||D||135° curve left (T only)
|-
| -2||E||90° curve left
|-
| -1||F||45° curve left
|-
|0||0||no curve
|-
|1||1||45° curve right
|-
|2||2||90° curve right
|-
|3||3||135° curve right (T only)
|-
|4||4||180° curve right (T only)
|}

=== Motion counter (46) ===

'''Format:''' 32-bit value

This variable counts the amount of motion that a vehicle has done.  It is only valid for the first vehicle in a consist (i.e. use VarAction2 type 82!).  Its value is in units of 1/4096 of a tile.  A vehicle actually moves visibly every time the motion counter increases by 256, and since a tile consists of 16 such subunits, 16*256=4096 motion units mean motion across one tile.

The most useful way to access it is probably with <shiftnum>=08 and an appropriate <andmask>.  For example, to achieve an animation with one frame per vehicle motion and 16 frames in total for motion across an entire tile, you would use <shiftnum>=08 and <andmask>=0F.  For an animation with one frame every two vehicle motions and 4 frames total, use <shiftnum>=09 and <andmask>=03.

If the vehicle is going very fast (>160 mph for trains), it may move by several 1/16ths of a tile at once, and thus some frames may be skipped, but the animation will still remain in sync with the motion.

Note that vehicle graphics are only updated every time the vehicle actually moves, so checking the lower byte is probably pointless, and only needed internally to achieve sufficient precision.

=== Vehicle cargo info (47) ===

'''Format:''' ccccwwtt

{| |-
!Variable!!Value
|-
|tt||the [[CargoTypes|cargo type]] transported by the vehicle (from the column for type A); translated if a translation table has been installed
|-
|ww||cargo unit weight in 1/16 tons, same as [[Action0Cargos#Weight of one unit of the cargo 0F|cargo prop. 0F]]
|-
|cccc||the [[Action0Cargos#Cargo classes 16|cargo class]] value of the cargo transported by the vehicle
|}

Note that if the grf has installed a [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]], the value in "tt" is the slot number in that table, irrespective of which actual slot or bit the cargo is using in the game. If a table has been installed, but the current cargo is not listed there, "tt" will be set to FF.

Unlike variable 42, this variable returns the info of the current vehicle only, not the consist.

=== Vehicle type information (48) ===

'''Format:''' xxxxxxff

The bits of ff are:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||Vehicle type is available on the market
|-
|1||2||Vehicle type is in the testing phase
|-
|2||4||Exclusive testing offer for a human player active
|}

All other bits in ff are undefined and must be masked out.

=== Information about current railtype/roadtype/tramtype (4A) ===

'''Format:''' xxxxFFrr

The lower byte (rr) contains the (translated) railtype/roadtype/tramtype the vehicle is currently driving on.
If the railtype/roadtype/tramtype has no entry in the railtype/roadtype/tramtype translation table of the GRF, this value will be 0xFF.
If no translation table is present, the raw value will be returned.
Note: only exact matches of rail-/road-/-tram-types are reported. If the translation table of the GRF does not contain the exact track-type 0xFF is returned, even if the translation table contains equivalent track-types (according to rail-/road-/tram-type property 1D). Use variable 63 to test for compatibility/poweredness/equivalency with track-types known to both the vehicle and the track-type NewGRF.

The variable only reports about the tracks the vehicle is using: on a level crossing with rail, road and tram tracks, the vehicle (train, road vehicle, tram) can only query the track type it belongs to.

The second byte (FF) contains the following flags:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||The vehicle is/would be powered on the current railtype (this is independent from powered/non-powered wagon or anything)
|-
|1||2||{{ottdp|1.11|no|ottdrev=gf1bc4d840}} Set, if the track-type has catenary. This is independent of the vehicle: a NewGRF can define an engine as powered on non-electrified track (bit 0), and show a raised pantograph (bit 1) to look like a dual-powered engine. This bit is a simplified as it only checks for "some catenary". To distinguish different types of catenaries, AC and DC voltages, ... use variable 63 instead.
|}

All other bits are reserved, and must be masked.

All other bytes are reserved, and must be masked.

=== Position within articulated vehicle (4D) ===

'''Format:''' xxxxbbff

{| |-
!Variable!!Value
|-
|ff||Position of vehicle (articulated part) within the articulated vehicle, counted from the first part, starting with 0.
|-
|bb||Position of vehicle (articulated part) within the articulated vehicle, counted from the last part, starting with 0.
|-
|xx||Reserved, do not access.
|}

The total number of articulated parts of a vehicle equals ff + 1 + bb.

For road vehicles "ff" and "bb" currently equal var 40, since there are no road vehicle wagons yet.

=== Count Veh.ID occurence (60) ===

'''Format:''' xxxxxxnn

The 60+x parameter is the vehicle ID to look for, and the returned nn is the number of vehicles in the consist that have this ID. If used with VarAction2 type 81, only the current vehicle and onwards will be check, with VarAction2 type 82, all vehicles in the consist will be counted.

=== Query variable of n-th vehicle in chain (61) ===

This is a special variable to get the contents of another variable of a different vehicle in the vehicle chain. It is only supported for trains and road vehicles. It is not supported during a callback that is used to modify vehicle properties to avoid circular dependencies, which currently limits this variable to callbacks 1D, 2D, 31 and 32 plus outside callback scope.

Temporary register 10F is interpreted as a signed integer and specifies the offset in the chain from the current vehicle. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.

The 60+x parameter specifies the variable to access and temporary register 10E is passed as the new 60+x parameter. Passing 61 as the variable is not allowed. Currently only vehicle specific variables listed on this page plus global variable 25 and {{ottdp|1.3|no|ottdrev=r24527}} 5F are accessible through var 61.

The resulting value will have the size of whatever variable is queried.

=== Curvature/position difference for n-th vehicle in chain (62) ===

'''Format:''' zzyyxxFD

This variable is only supported for trains and road vehicles.

The 60+x parameter is interpreted as a signed integer and specifies the offset in the chain from the current vehicle. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.

The lowest nibble (D) contains the direction difference between the selected vehicle and this vehicle, the possible values are identical to those of [[#Curvature_info_.2845.29|variable 45]].

The next nibble (F) has the following meaning:
{| |-
!Bit!!Value!!Meaning
|-
|3||8||The vehicle is currently hidden
|}

The upper three bytes contain the signed difference of the X/Y/Z position between the selected vehicle and this vehicle.

=== Track-type test against another track-type (63) ===

{{ottdp|1.11|no|ottdrev=g868d84bbf}}

'''Format:''' xxxxxxFF

This variable is only supported for trains and road vehicles.

The 60+x parameter is an index into the rail-/road-/tram-type translation table.
The result value reports how vehicles of this type would behave on the current tile.
This allows vehicles to behave or look differently on various track-types independent of their own track-type.

The lower byte (FF) contains some flags:
{|
|-
!Bit!!Value!!Meaning
|-
|0||1||The track-type from the 60+x parameter is known. If unset, all other flags are unset as well, no information can be given.
|-
|1||2||Vehicles with type from the 60+x parameter are compatible with the track on the current tile.
|-
|2||4||Vehicles with type from the 60+x parameter are powered on the track of the current tile.
|-
|3||8||The track-type from the 60+x parameter is identical or equivalent (listed as alternate label in rail-/road-/tram-type property 1D) to the track-type of the current tile.
|}

The remaining bytes are reserved, and must be masked.

=== Count badge occurence (64) ===

{{ottdp|15|no}}

The 60+x parameter is the badge ID to look for, and the returned value is the number of vehicles in the consist that have this badge. If used with VarAction2 type 81, only the current vehicle and onwards will be check, with VarAction2 type 82, all vehicles in the consist will be counted.

=== Test if rail or road type of the current tile occupied by the vehicle has that specific badge attached (65) ===

{{ottdp|15|no}}

This variable only works for trains and road vehicles.
The specifications are the same as for [[#Test_if_the_vehicle_has_that_specific_badge_attached.287A.29|variable 7A]].

=== Test if the vehicle has that specific badge attached (7A) ===

{{ottdp|15|no}}

The 60+x parameter is the index into the badge table.
The returned value is in range [0, 1].

=== Modflags (FE and FF) ===

The bits in FE mostly relate to gradualloading.  A few useful bits for grf authors are;

{| |-
!Bit!!Version!!Value of the bit
|-
|1||{{ottdp|1.5|2.5|ottdrev=r26430}}||Vehicle is still unloading and has not yet started loading new cargo at the current station.
|-
|5||{{ottdp|0.6|2.5}}||Vehicle is powered (engine or powered wagon, mainly useful for the latter)
|-
|6||{{ottdp|0.6|2.5}}||Vehicle would be powered (engine or powered wagon) if there were suitable track. (E.g. electric train in mixed train on normal track)
|-
|8 <ref>This bit is only accurate for the first vehicle in the consist.</ref>||{{ottdp|0.6|2.5}}||This bit is flipped every time the train reverses direction
|-
|10||{{ottdp|0.6|2.5|ttdprev=r1334}}||Vehicle was built during the exclusive preview
|-
|11||{{ottd|16}}||The train is driving backwards (trains only). {{ottd|17}} Applies to ships as well.
|}
<references/>

variable FF is actually the high byte of variable FE, so FE bit 8 is the same as FF bit 0.

Other bits are reserved; most are actually used for TTDPatch internal states.

VariationalAction2/Vehicles

2026-10-14T21:27:32Z

Brickblock1: /* Count badge occurence (64) */

<div style="float:right; padding-left:12px; background:none;">{{NFONavVehicles}}</div>

== Variables ==

{|
!Variable!![[GRFActionsDetailed|Size]]!!Version!!Description!!Available in purchase list
|-
|10||D||{{ottdp|1.2|no|ottdrev=r23080}}||Pick sprites for different GUI windows - See [[Action2/Vehicles]].||{{ottdp|1.2|no|ottdrev=r23080}}
|-
|40||D||{{ottdp|0.6|2.5}}||Position in consist and length of consist||no
|-
|41||D||{{ottdp|0.6|2.5}}||Position in and length of chain of consecutive vehicles with same ID||no
|-
|42||D||{{ottdp|0.6|2.5}}||Cargo types transported by consist||no
|-
|43||D||{{ottdp|0.6|2.5}}||Player info||{{ottdp|0.6|2.5|ottdrev=r4611|ttdprev=beta 2}}
|-
|44||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 48}}||Aircraft info||no
|-
|45||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 58}}||Curvature info||no
|-
|46||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 59}}||Motion counter||no
|-
|47||D||{{ottdp|0.6|2.5}}||Vehicle cargo info||{{ottdp|0.7|no|ottdrev=r15542}} <ref name="var47">Variable 47 refers to the default cargo of the vehicle, when in purchase list. This differs from the cargo used in Action 3, which is 0xFF in purchase list. The "refit cycle" (F2) is currently always zero in the purchase list.</ref>
|-
|48||D||{{ottdp|0.6|2.5}}||Vehicle type information||{{ottdp|0.6|2.5|ottdrev=r5338|ttdprev=beta 2}}
|-
|49||D||{{ottdp|0.7|2.6|ottdrev=r13376|ttdprev=r2216}}||Year of construction (long format, 0 based)||{{ottdp|0.7|no|ottdrev=r13376}} <ref name="date">This is the current date</ref>
|-
|4A||D||{{ottdp|1.1|no|ottdrev=r20165}}||Info about current railtype/roadtype/tramtype||no
|-
|4B||D||{{ottdp|1.2|no|ottdrev=r23068}}||Long date of last servicing||{{ottdp|1.2|no|ottdrev=r23068}} <ref name="date" />
|-
|4C||D||{{ottdp|1.3|no|ottdrev=r24246}}||Current max speed including e.g track or timetable speed limits. Only valid for front vehicle. Note, units differ for each vehicle type<ref name="speed">See [[Action0Trains#Speed 09|train property 09]], [[Action0RoadVehicles|road vehicle property 08]] (not 15, even when using realistic acceleration), [[Action0Ships|ship property 0B]] and [[Action0Planes|aircraft property 0C]].</ref>||no
|-
|4D||D||{{ottdp|1.4|no|ottdrev=r26157}}||Position within articulated vehicle||no
|-
|60||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 57}}||Count Veh.ID occurence||no
|-
|61||-<ref>The size of the result matches the size of the queried variable.</ref>||{{ottdp|1.2|no|ottdrev=r22997}}||Query variable of n-th vehicle in chain||no
|-
|62||D||{{ottdp|1.2|no|ottdrev=r22998}}||Curvature/position difference for n-th vehicle in chain||no
|-
|63||D||{{ottdp|1.11|no|ottdrev=g868d84bbf}}||Test track-type of tile against another track-type||no
|-
|65||D||{{ottdp|15|no}}||Test if rail or road type of the current type occupied by the vehicle has that specific badge attached||no
|-
|7A||D||{{ottdp|15|no}}||Test if the vehicle has that specific badge attached||yes
|-
|97||B||{{ottdp|0.6|2.0}}||Tick counter, increased every engine tick||no
|-
|B2||W||||Vehicle status: bit0 = vehicle invisible (in tunnel/depot), bit1 = stopped, bit7 = crashed||no
|-
|B4||W||{{ottdp|0.6|2.0}}||Current speed. Note, units differ for each vehicle type<ref name="speed" />||no
|-
|B9||B||{{ottdp|0.6|2.0}}||Cargo type (type B from the list at [[CargoTypes]]; climate dependent)||no
|-
|C0||W||{{ottdp|0.6|2.0}}||Engine age in days<br/>{{ottdp|1.2|2.5|ottdrev=r22816|ttdprev=alpha 61}} Valid for wagons and articulated parts as well.||no
|-
|C4||B||{{ottdp|0.6|2.0}}||Year built (counted from 1920), note this is modified when Cht: Year is used||{{ottdp|0.6|no|ottdrev=r4611}} <ref name="date" />
|-
|C6||W||{{ottdp|0.6|2.0}}||Vehicle type ID <ref>{{ottdp|0.7|no}} In OpenTTD 0.7 and newer this is the GRF-local ID of the vehicle. Earlier versions of OpenTTD and TTDPatch report the [[VehicleIDs|TTD ID]]. For trains this is the same; for other vehicle types they differ.</ref> (useful for [[Callbacks#Can wagon be attached (1D)|Callback 1D]])||no
|-
|C8||B||{{ottdp|0.6|2.0}}||Sprite type; FD for trains forward, FE or FF when reversed||no
|-
|C9||B||{{ottdp|0.6|2.0}}||Day counter; increased daily||no
|-
|DA||W||{{ottdp|0.6|2.0}}||Next wagon index, FFFF if last wagon (use shift-num=08 and check for FF)||no
|-
|F2||B||{{ottdp|0.6|2.5}}||Refit cycle, how many times refitted to the same cargo type||{{ottdp|0.7|no|ottdrev=r15542}} <ref name="var47" />
|-
|F4||D||{{ottdp|0.5|2.0|ottdrev=3594}}||Current horsepower of train consist||no
|-
|FE||W||{{ottdp|0.6|2.5}}||Modflags||no
|-
|FF||B||{{ottdp|0.6|2.5}}||Modflags||no
|}

<references />

For other 80+x variables confer the [http://marcin.ttdpatch.net/sv1codec/TTD-locations.html#_VehicleArray TTD vehicle structure].

Variables 40, 41, 42 and 43 are cached. This means that while they are in principle computationally expensive, they can be used without impacting performance. Variables 45 and 60 are also computationally expensive but cannot be cached, and should therefore be used sparingly. If possible 80+x variables are to be preferred.

Cached variables are updated when the game is loaded, when the consist enters or is rearranged in a depot, and when the train reverses.

In the purchase list only a few variables are available. Especially the front vehicle (related object) cannot be accessed, nor other articulated parts.

== Description ==
=== Position and length (40, 41) ===

'''Format:''' 00nnbbff

{| |-
!Variable!!Value
|-
|ff||position of vehicle within the consist counted from the engine (front), e.g. the engine would have ff=0, the 1st wagon or mail compartment of planes would have ff=1, the 2nd wagon or the rotor of helicopters would have ff=2, the 3rd wagon would have ff=3 etc
|-
|bb||same as ff, but counted from the end, i.e. the last wagon has bb=0, the next-to-last wagon has bb=1 etc.
|-
|nn||Total number of vehicles in the consist, including shadow and rotor for aircraft.
* In var 40 this is zero-based. That is, the value returned is one less than the actual number of vehicles. A train with engine and three wagons has nn=3.
* In var 41 this is one-based. That is, the value returned is the actual number of vehicles.
|}

For variable 40, these numbers refer to the whole consist, but for variable 41, they only refer to the chain of consecutive vehicles with the same ID as the current wagon (including itself, but possibly excluding the engine):

[[File:vehicle_var40_41.png]]

Note however, that accessing the "related" object (i.e. the locomotive) doesn´t make much sense for vars 40/41, except for var40 when in a [[Callbacks#Can wagon be attached 1D|callback 1D]] chain.

=== Consist cargo (42) ===

'''Format:''' uuiicctt

{| |-
!Variable!!Value
|-
|tt||a bit mask of all [[Action0Cargos#Cargo classes 16|cargo classes]] transported by the consist
|-
|cc||the most common [[CargoTypes|cargo type]] (from the column for type A)
|-
|ii||the most common refit cycle (var. F2) of cargo type cc
|-
|uu||the result of ORing the bits of prop. 25 from all vehicles in the train
|}

If used with VarAction2 type 81 (vehicle) it returns only cargo from this vehicle on, with type 82 (engine) that of the whole consist.
See also variable 47 for more details on the cargo carried by a vehicle.

{{grfTill|7}} For GRF versions 7 and before "cc" is the untranslated bit number from [[Action0/Cargos#Bit_number_for_bitmasks_.2808.29|cargo property 8]].

{{grfFrom|8}} With GRF version 8 the meaning of "cc" changes. If the grf file has installed a [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]], the value in "cc" is the index of the cargo in that table; or FF if the cargo is not present in the table.

=== Player info (43) ===

'''Format:''' Ccttmmnn

{| |-
!Variable!!Value
|-
|nn||the number of the current player from 0 to 7 (up to E (14) in OpenTTD since r14735)
|-
|mm||the multiplayer player number with the host player (or the single player) being 0 and the client player being 1
|-
|tt||the player type, see below for possible values
|-
|c||the primary player colour
|-
|C||{{ottdp|0.6|2.5|ttdprev=r1405}} the secondary player colour, equal to c if none (since r1405)
|}

{| |-
!tt value!!Meaning
|-
|0||Player is human player (permanent company)
|-
|1||Player is AI player (not managed)
|-
|2||{{ottdp|no|2.5}} Player is a human managing an AI company
|-
|3||{{ottdp|no|2.5}} Player is human player's original company, now temporarily AI controlled
|}

{{ottdp|0.6|2.5|ttdprev=r1497}} Since r1497, when the vehicle sprite is being displayed in an exclusive offer window or new vehicle news message, or in other circumstances when no player is associated with the vehicle, nn will be FF.

=== Aircraft info (44) ===

'''Format:''' xxxxhhtt

hh is the height of the aircraft above ground, or more properly above the height of its shadow. Buildings, including the heliport, don't count as "ground", i.e. to get the height above a heliport, you have to subtract the heliport height from hh.

tt is the type of the current airport: 0=small, 1=large, 2=heliport, 3=oil rig. The current airport is the target airport for aircraft that have finished the ascent and are in flight.

=== Curvature info (45) ===

'''Format:''' xxxTxBxF

This returns the amount of curvature between the adjacent wagon pairs. It is useful for train vehicles that normally tilt in curves. The curvature is the difference in direction between the surrounding vehicles:

F = for the front pair (previous wagon to current wagon, 0 if vehicle is first)

B = for the back pair (current wagon to next wagon, 0 if wagon is last)

T = for the triplet (previous wagon to next wagon; is zero in an S-bend)

Possible values:

{| |-
!Decimal!!Hex!!Meaning
|-
| -4||C||180° curve left (T only)
|-
| -3||D||135° curve left (T only)
|-
| -2||E||90° curve left
|-
| -1||F||45° curve left
|-
|0||0||no curve
|-
|1||1||45° curve right
|-
|2||2||90° curve right
|-
|3||3||135° curve right (T only)
|-
|4||4||180° curve right (T only)
|}

=== Motion counter (46) ===

'''Format:''' 32-bit value

This variable counts the amount of motion that a vehicle has done.  It is only valid for the first vehicle in a consist (i.e. use VarAction2 type 82!).  Its value is in units of 1/4096 of a tile.  A vehicle actually moves visibly every time the motion counter increases by 256, and since a tile consists of 16 such subunits, 16*256=4096 motion units mean motion across one tile.

The most useful way to access it is probably with <shiftnum>=08 and an appropriate <andmask>.  For example, to achieve an animation with one frame per vehicle motion and 16 frames in total for motion across an entire tile, you would use <shiftnum>=08 and <andmask>=0F.  For an animation with one frame every two vehicle motions and 4 frames total, use <shiftnum>=09 and <andmask>=03.

If the vehicle is going very fast (>160 mph for trains), it may move by several 1/16ths of a tile at once, and thus some frames may be skipped, but the animation will still remain in sync with the motion.

Note that vehicle graphics are only updated every time the vehicle actually moves, so checking the lower byte is probably pointless, and only needed internally to achieve sufficient precision.

=== Vehicle cargo info (47) ===

'''Format:''' ccccwwtt

{| |-
!Variable!!Value
|-
|tt||the [[CargoTypes|cargo type]] transported by the vehicle (from the column for type A); translated if a translation table has been installed
|-
|ww||cargo unit weight in 1/16 tons, same as [[Action0Cargos#Weight of one unit of the cargo 0F|cargo prop. 0F]]
|-
|cccc||the [[Action0Cargos#Cargo classes 16|cargo class]] value of the cargo transported by the vehicle
|}

Note that if the grf has installed a [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]], the value in "tt" is the slot number in that table, irrespective of which actual slot or bit the cargo is using in the game. If a table has been installed, but the current cargo is not listed there, "tt" will be set to FF.

Unlike variable 42, this variable returns the info of the current vehicle only, not the consist.

=== Vehicle type information (48) ===

'''Format:''' xxxxxxff

The bits of ff are:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||Vehicle type is available on the market
|-
|1||2||Vehicle type is in the testing phase
|-
|2||4||Exclusive testing offer for a human player active
|}

All other bits in ff are undefined and must be masked out.

=== Information about current railtype/roadtype/tramtype (4A) ===

'''Format:''' xxxxFFrr

The lower byte (rr) contains the (translated) railtype/roadtype/tramtype the vehicle is currently driving on.
If the railtype/roadtype/tramtype has no entry in the railtype/roadtype/tramtype translation table of the GRF, this value will be 0xFF.
If no translation table is present, the raw value will be returned.
Note: only exact matches of rail-/road-/-tram-types are reported. If the translation table of the GRF does not contain the exact track-type 0xFF is returned, even if the translation table contains equivalent track-types (according to rail-/road-/tram-type property 1D). Use variable 63 to test for compatibility/poweredness/equivalency with track-types known to both the vehicle and the track-type NewGRF.

The variable only reports about the tracks the vehicle is using: on a level crossing with rail, road and tram tracks, the vehicle (train, road vehicle, tram) can only query the track type it belongs to.

The second byte (FF) contains the following flags:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||The vehicle is/would be powered on the current railtype (this is independent from powered/non-powered wagon or anything)
|-
|1||2||{{ottdp|1.11|no|ottdrev=gf1bc4d840}} Set, if the track-type has catenary. This is independent of the vehicle: a NewGRF can define an engine as powered on non-electrified track (bit 0), and show a raised pantograph (bit 1) to look like a dual-powered engine. This bit is a simplified as it only checks for "some catenary". To distinguish different types of catenaries, AC and DC voltages, ... use variable 63 instead.
|}

All other bits are reserved, and must be masked.

All other bytes are reserved, and must be masked.

=== Position within articulated vehicle (4D) ===

'''Format:''' xxxxbbff

{| |-
!Variable!!Value
|-
|ff||Position of vehicle (articulated part) within the articulated vehicle, counted from the first part, starting with 0.
|-
|bb||Position of vehicle (articulated part) within the articulated vehicle, counted from the last part, starting with 0.
|-
|xx||Reserved, do not access.
|}

The total number of articulated parts of a vehicle equals ff + 1 + bb.

For road vehicles "ff" and "bb" currently equal var 40, since there are no road vehicle wagons yet.

=== Count Veh.ID occurence (60) ===

'''Format:''' xxxxxxnn

The 60+x parameter is the vehicle ID to look for, and the returned nn is the number of vehicles in the consist that have this ID. If used with VarAction2 type 81, only the current vehicle and onwards will be check, with VarAction2 type 82, all vehicles in the consist will be counted.

=== Query variable of n-th vehicle in chain (61) ===

This is a special variable to get the contents of another variable of a different vehicle in the vehicle chain. It is only supported for trains and road vehicles. It is not supported during a callback that is used to modify vehicle properties to avoid circular dependencies, which currently limits this variable to callbacks 1D, 2D, 31 and 32 plus outside callback scope.

Temporary register 10F is interpreted as a signed integer and specifies the offset in the chain from the current vehicle. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.

The 60+x parameter specifies the variable to access and temporary register 10E is passed as the new 60+x parameter. Passing 61 as the variable is not allowed. Currently only vehicle specific variables listed on this page plus global variable 25 and {{ottdp|1.3|no|ottdrev=r24527}} 5F are accessible through var 61.

The resulting value will have the size of whatever variable is queried.

=== Curvature/position difference for n-th vehicle in chain (62) ===

'''Format:''' zzyyxxFD

This variable is only supported for trains and road vehicles.

The 60+x parameter is interpreted as a signed integer and specifies the offset in the chain from the current vehicle. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.

The lowest nibble (D) contains the direction difference between the selected vehicle and this vehicle, the possible values are identical to those of [[#Curvature_info_.2845.29|variable 45]].

The next nibble (F) has the following meaning:
{| |-
!Bit!!Value!!Meaning
|-
|3||8||The vehicle is currently hidden
|}

The upper three bytes contain the signed difference of the X/Y/Z position between the selected vehicle and this vehicle.

=== Track-type test against another track-type (63) ===

{{ottdp|1.11|no|ottdrev=g868d84bbf}}

'''Format:''' xxxxxxFF

This variable is only supported for trains and road vehicles.

The 60+x parameter is an index into the rail-/road-/tram-type translation table.
The result value reports how vehicles of this type would behave on the current tile.
This allows vehicles to behave or look differently on various track-types independent of their own track-type.

The lower byte (FF) contains some flags:
{|
|-
!Bit!!Value!!Meaning
|-
|0||1||The track-type from the 60+x parameter is known. If unset, all other flags are unset as well, no information can be given.
|-
|1||2||Vehicles with type from the 60+x parameter are compatible with the track on the current tile.
|-
|2||4||Vehicles with type from the 60+x parameter are powered on the track of the current tile.
|-
|3||8||The track-type from the 60+x parameter is identical or equivalent (listed as alternate label in rail-/road-/tram-type property 1D) to the track-type of the current tile.
|}

The remaining bytes are reserved, and must be masked.

=== Count badge occurence (64) ===

{{ottdp|15|no}}

The 60+x parameter is the badge ID to look for, and the returned value is the number of vehicles in the consist that have this badge. If used with VarAction2 type 81, only the current vehicle and onwards will be check, with VarAction2 type 82, all vehicles in the consist will be counted.

=== Test if rail or road type of the current tile occupied by the vehicle has that specific badge attached (65) ===

{{ottdp|15|no}}

This variable only works for trains and road vehicles.
The specifications are the same as for [[#Test_if_the_vehicle_has_that_specific_badge_attached.287A.29|variable 7A]].

=== Test if the vehicle has that specific badge attached (7A) ===

{{ottdp|15|no}}

The 60+x parameter is the index into the badge table.
The returned value is in range [0, 1].

=== Modflags (FE and FF) ===

The bits in FE mostly relate to gradualloading.  A few useful bits for grf authors are;

{| |-
!Bit!!Version!!Value of the bit
|-
|1||{{ottdp|1.5|2.5|ottdrev=r26430}}||Vehicle is still unloading and has not yet started loading new cargo at the current station.
|-
|5||{{ottdp|0.6|2.5}}||Vehicle is powered (engine or powered wagon, mainly useful for the latter)
|-
|6||{{ottdp|0.6|2.5}}||Vehicle would be powered (engine or powered wagon) if there were suitable track. (E.g. electric train in mixed train on normal track)
|-
|8 <ref>This bit is only accurate for the first vehicle in the consist.</ref>||{{ottdp|0.6|2.5}}||This bit is flipped every time the train reverses direction
|-
|10||{{ottdp|0.6|2.5|ttdprev=r1334}}||Vehicle was built during the exclusive preview
|-
|11||{{ottd|16}}||The train is driving backwards (trains only). {{ottd|17}} Applies to ships as well.
|}
<references/>

variable FF is actually the high byte of variable FE, so FE bit 8 is the same as FF bit 0.

Other bits are reserved; most are actually used for TTDPatch internal states.

VariationalAction2/Vehicles

2026-10-14T21:27:00Z

Brickblock1: /* Count badge occurence (64) */

<div style="float:right; padding-left:12px; background:none;">{{NFONavVehicles}}</div>

== Variables ==

{|
!Variable!![[GRFActionsDetailed|Size]]!!Version!!Description!!Available in purchase list
|-
|10||D||{{ottdp|1.2|no|ottdrev=r23080}}||Pick sprites for different GUI windows - See [[Action2/Vehicles]].||{{ottdp|1.2|no|ottdrev=r23080}}
|-
|40||D||{{ottdp|0.6|2.5}}||Position in consist and length of consist||no
|-
|41||D||{{ottdp|0.6|2.5}}||Position in and length of chain of consecutive vehicles with same ID||no
|-
|42||D||{{ottdp|0.6|2.5}}||Cargo types transported by consist||no
|-
|43||D||{{ottdp|0.6|2.5}}||Player info||{{ottdp|0.6|2.5|ottdrev=r4611|ttdprev=beta 2}}
|-
|44||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 48}}||Aircraft info||no
|-
|45||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 58}}||Curvature info||no
|-
|46||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 59}}||Motion counter||no
|-
|47||D||{{ottdp|0.6|2.5}}||Vehicle cargo info||{{ottdp|0.7|no|ottdrev=r15542}} <ref name="var47">Variable 47 refers to the default cargo of the vehicle, when in purchase list. This differs from the cargo used in Action 3, which is 0xFF in purchase list. The "refit cycle" (F2) is currently always zero in the purchase list.</ref>
|-
|48||D||{{ottdp|0.6|2.5}}||Vehicle type information||{{ottdp|0.6|2.5|ottdrev=r5338|ttdprev=beta 2}}
|-
|49||D||{{ottdp|0.7|2.6|ottdrev=r13376|ttdprev=r2216}}||Year of construction (long format, 0 based)||{{ottdp|0.7|no|ottdrev=r13376}} <ref name="date">This is the current date</ref>
|-
|4A||D||{{ottdp|1.1|no|ottdrev=r20165}}||Info about current railtype/roadtype/tramtype||no
|-
|4B||D||{{ottdp|1.2|no|ottdrev=r23068}}||Long date of last servicing||{{ottdp|1.2|no|ottdrev=r23068}} <ref name="date" />
|-
|4C||D||{{ottdp|1.3|no|ottdrev=r24246}}||Current max speed including e.g track or timetable speed limits. Only valid for front vehicle. Note, units differ for each vehicle type<ref name="speed">See [[Action0Trains#Speed 09|train property 09]], [[Action0RoadVehicles|road vehicle property 08]] (not 15, even when using realistic acceleration), [[Action0Ships|ship property 0B]] and [[Action0Planes|aircraft property 0C]].</ref>||no
|-
|4D||D||{{ottdp|1.4|no|ottdrev=r26157}}||Position within articulated vehicle||no
|-
|60||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 57}}||Count Veh.ID occurence||no
|-
|61||-<ref>The size of the result matches the size of the queried variable.</ref>||{{ottdp|1.2|no|ottdrev=r22997}}||Query variable of n-th vehicle in chain||no
|-
|62||D||{{ottdp|1.2|no|ottdrev=r22998}}||Curvature/position difference for n-th vehicle in chain||no
|-
|63||D||{{ottdp|1.11|no|ottdrev=g868d84bbf}}||Test track-type of tile against another track-type||no
|-
|65||D||{{ottdp|15|no}}||Test if rail or road type of the current type occupied by the vehicle has that specific badge attached||no
|-
|7A||D||{{ottdp|15|no}}||Test if the vehicle has that specific badge attached||yes
|-
|97||B||{{ottdp|0.6|2.0}}||Tick counter, increased every engine tick||no
|-
|B2||W||||Vehicle status: bit0 = vehicle invisible (in tunnel/depot), bit1 = stopped, bit7 = crashed||no
|-
|B4||W||{{ottdp|0.6|2.0}}||Current speed. Note, units differ for each vehicle type<ref name="speed" />||no
|-
|B9||B||{{ottdp|0.6|2.0}}||Cargo type (type B from the list at [[CargoTypes]]; climate dependent)||no
|-
|C0||W||{{ottdp|0.6|2.0}}||Engine age in days<br/>{{ottdp|1.2|2.5|ottdrev=r22816|ttdprev=alpha 61}} Valid for wagons and articulated parts as well.||no
|-
|C4||B||{{ottdp|0.6|2.0}}||Year built (counted from 1920), note this is modified when Cht: Year is used||{{ottdp|0.6|no|ottdrev=r4611}} <ref name="date" />
|-
|C6||W||{{ottdp|0.6|2.0}}||Vehicle type ID <ref>{{ottdp|0.7|no}} In OpenTTD 0.7 and newer this is the GRF-local ID of the vehicle. Earlier versions of OpenTTD and TTDPatch report the [[VehicleIDs|TTD ID]]. For trains this is the same; for other vehicle types they differ.</ref> (useful for [[Callbacks#Can wagon be attached (1D)|Callback 1D]])||no
|-
|C8||B||{{ottdp|0.6|2.0}}||Sprite type; FD for trains forward, FE or FF when reversed||no
|-
|C9||B||{{ottdp|0.6|2.0}}||Day counter; increased daily||no
|-
|DA||W||{{ottdp|0.6|2.0}}||Next wagon index, FFFF if last wagon (use shift-num=08 and check for FF)||no
|-
|F2||B||{{ottdp|0.6|2.5}}||Refit cycle, how many times refitted to the same cargo type||{{ottdp|0.7|no|ottdrev=r15542}} <ref name="var47" />
|-
|F4||D||{{ottdp|0.5|2.0|ottdrev=3594}}||Current horsepower of train consist||no
|-
|FE||W||{{ottdp|0.6|2.5}}||Modflags||no
|-
|FF||B||{{ottdp|0.6|2.5}}||Modflags||no
|}

<references />

For other 80+x variables confer the [http://marcin.ttdpatch.net/sv1codec/TTD-locations.html#_VehicleArray TTD vehicle structure].

Variables 40, 41, 42 and 43 are cached. This means that while they are in principle computationally expensive, they can be used without impacting performance. Variables 45 and 60 are also computationally expensive but cannot be cached, and should therefore be used sparingly. If possible 80+x variables are to be preferred.

Cached variables are updated when the game is loaded, when the consist enters or is rearranged in a depot, and when the train reverses.

In the purchase list only a few variables are available. Especially the front vehicle (related object) cannot be accessed, nor other articulated parts.

== Description ==
=== Position and length (40, 41) ===

'''Format:''' 00nnbbff

{| |-
!Variable!!Value
|-
|ff||position of vehicle within the consist counted from the engine (front), e.g. the engine would have ff=0, the 1st wagon or mail compartment of planes would have ff=1, the 2nd wagon or the rotor of helicopters would have ff=2, the 3rd wagon would have ff=3 etc
|-
|bb||same as ff, but counted from the end, i.e. the last wagon has bb=0, the next-to-last wagon has bb=1 etc.
|-
|nn||Total number of vehicles in the consist, including shadow and rotor for aircraft.
* In var 40 this is zero-based. That is, the value returned is one less than the actual number of vehicles. A train with engine and three wagons has nn=3.
* In var 41 this is one-based. That is, the value returned is the actual number of vehicles.
|}

For variable 40, these numbers refer to the whole consist, but for variable 41, they only refer to the chain of consecutive vehicles with the same ID as the current wagon (including itself, but possibly excluding the engine):

[[File:vehicle_var40_41.png]]

Note however, that accessing the "related" object (i.e. the locomotive) doesn´t make much sense for vars 40/41, except for var40 when in a [[Callbacks#Can wagon be attached 1D|callback 1D]] chain.

=== Consist cargo (42) ===

'''Format:''' uuiicctt

{| |-
!Variable!!Value
|-
|tt||a bit mask of all [[Action0Cargos#Cargo classes 16|cargo classes]] transported by the consist
|-
|cc||the most common [[CargoTypes|cargo type]] (from the column for type A)
|-
|ii||the most common refit cycle (var. F2) of cargo type cc
|-
|uu||the result of ORing the bits of prop. 25 from all vehicles in the train
|}

If used with VarAction2 type 81 (vehicle) it returns only cargo from this vehicle on, with type 82 (engine) that of the whole consist.
See also variable 47 for more details on the cargo carried by a vehicle.

{{grfTill|7}} For GRF versions 7 and before "cc" is the untranslated bit number from [[Action0/Cargos#Bit_number_for_bitmasks_.2808.29|cargo property 8]].

{{grfFrom|8}} With GRF version 8 the meaning of "cc" changes. If the grf file has installed a [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]], the value in "cc" is the index of the cargo in that table; or FF if the cargo is not present in the table.

=== Player info (43) ===

'''Format:''' Ccttmmnn

{| |-
!Variable!!Value
|-
|nn||the number of the current player from 0 to 7 (up to E (14) in OpenTTD since r14735)
|-
|mm||the multiplayer player number with the host player (or the single player) being 0 and the client player being 1
|-
|tt||the player type, see below for possible values
|-
|c||the primary player colour
|-
|C||{{ottdp|0.6|2.5|ttdprev=r1405}} the secondary player colour, equal to c if none (since r1405)
|}

{| |-
!tt value!!Meaning
|-
|0||Player is human player (permanent company)
|-
|1||Player is AI player (not managed)
|-
|2||{{ottdp|no|2.5}} Player is a human managing an AI company
|-
|3||{{ottdp|no|2.5}} Player is human player's original company, now temporarily AI controlled
|}

{{ottdp|0.6|2.5|ttdprev=r1497}} Since r1497, when the vehicle sprite is being displayed in an exclusive offer window or new vehicle news message, or in other circumstances when no player is associated with the vehicle, nn will be FF.

=== Aircraft info (44) ===

'''Format:''' xxxxhhtt

hh is the height of the aircraft above ground, or more properly above the height of its shadow. Buildings, including the heliport, don't count as "ground", i.e. to get the height above a heliport, you have to subtract the heliport height from hh.

tt is the type of the current airport: 0=small, 1=large, 2=heliport, 3=oil rig. The current airport is the target airport for aircraft that have finished the ascent and are in flight.

=== Curvature info (45) ===

'''Format:''' xxxTxBxF

This returns the amount of curvature between the adjacent wagon pairs. It is useful for train vehicles that normally tilt in curves. The curvature is the difference in direction between the surrounding vehicles:

F = for the front pair (previous wagon to current wagon, 0 if vehicle is first)

B = for the back pair (current wagon to next wagon, 0 if wagon is last)

T = for the triplet (previous wagon to next wagon; is zero in an S-bend)

Possible values:

{| |-
!Decimal!!Hex!!Meaning
|-
| -4||C||180° curve left (T only)
|-
| -3||D||135° curve left (T only)
|-
| -2||E||90° curve left
|-
| -1||F||45° curve left
|-
|0||0||no curve
|-
|1||1||45° curve right
|-
|2||2||90° curve right
|-
|3||3||135° curve right (T only)
|-
|4||4||180° curve right (T only)
|}

=== Motion counter (46) ===

'''Format:''' 32-bit value

This variable counts the amount of motion that a vehicle has done.  It is only valid for the first vehicle in a consist (i.e. use VarAction2 type 82!).  Its value is in units of 1/4096 of a tile.  A vehicle actually moves visibly every time the motion counter increases by 256, and since a tile consists of 16 such subunits, 16*256=4096 motion units mean motion across one tile.

The most useful way to access it is probably with <shiftnum>=08 and an appropriate <andmask>.  For example, to achieve an animation with one frame per vehicle motion and 16 frames in total for motion across an entire tile, you would use <shiftnum>=08 and <andmask>=0F.  For an animation with one frame every two vehicle motions and 4 frames total, use <shiftnum>=09 and <andmask>=03.

If the vehicle is going very fast (>160 mph for trains), it may move by several 1/16ths of a tile at once, and thus some frames may be skipped, but the animation will still remain in sync with the motion.

Note that vehicle graphics are only updated every time the vehicle actually moves, so checking the lower byte is probably pointless, and only needed internally to achieve sufficient precision.

=== Vehicle cargo info (47) ===

'''Format:''' ccccwwtt

{| |-
!Variable!!Value
|-
|tt||the [[CargoTypes|cargo type]] transported by the vehicle (from the column for type A); translated if a translation table has been installed
|-
|ww||cargo unit weight in 1/16 tons, same as [[Action0Cargos#Weight of one unit of the cargo 0F|cargo prop. 0F]]
|-
|cccc||the [[Action0Cargos#Cargo classes 16|cargo class]] value of the cargo transported by the vehicle
|}

Note that if the grf has installed a [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]], the value in "tt" is the slot number in that table, irrespective of which actual slot or bit the cargo is using in the game. If a table has been installed, but the current cargo is not listed there, "tt" will be set to FF.

Unlike variable 42, this variable returns the info of the current vehicle only, not the consist.

=== Vehicle type information (48) ===

'''Format:''' xxxxxxff

The bits of ff are:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||Vehicle type is available on the market
|-
|1||2||Vehicle type is in the testing phase
|-
|2||4||Exclusive testing offer for a human player active
|}

All other bits in ff are undefined and must be masked out.

=== Information about current railtype/roadtype/tramtype (4A) ===

'''Format:''' xxxxFFrr

The lower byte (rr) contains the (translated) railtype/roadtype/tramtype the vehicle is currently driving on.
If the railtype/roadtype/tramtype has no entry in the railtype/roadtype/tramtype translation table of the GRF, this value will be 0xFF.
If no translation table is present, the raw value will be returned.
Note: only exact matches of rail-/road-/-tram-types are reported. If the translation table of the GRF does not contain the exact track-type 0xFF is returned, even if the translation table contains equivalent track-types (according to rail-/road-/tram-type property 1D). Use variable 63 to test for compatibility/poweredness/equivalency with track-types known to both the vehicle and the track-type NewGRF.

The variable only reports about the tracks the vehicle is using: on a level crossing with rail, road and tram tracks, the vehicle (train, road vehicle, tram) can only query the track type it belongs to.

The second byte (FF) contains the following flags:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||The vehicle is/would be powered on the current railtype (this is independent from powered/non-powered wagon or anything)
|-
|1||2||{{ottdp|1.11|no|ottdrev=gf1bc4d840}} Set, if the track-type has catenary. This is independent of the vehicle: a NewGRF can define an engine as powered on non-electrified track (bit 0), and show a raised pantograph (bit 1) to look like a dual-powered engine. This bit is a simplified as it only checks for "some catenary". To distinguish different types of catenaries, AC and DC voltages, ... use variable 63 instead.
|}

All other bits are reserved, and must be masked.

All other bytes are reserved, and must be masked.

=== Position within articulated vehicle (4D) ===

'''Format:''' xxxxbbff

{| |-
!Variable!!Value
|-
|ff||Position of vehicle (articulated part) within the articulated vehicle, counted from the first part, starting with 0.
|-
|bb||Position of vehicle (articulated part) within the articulated vehicle, counted from the last part, starting with 0.
|-
|xx||Reserved, do not access.
|}

The total number of articulated parts of a vehicle equals ff + 1 + bb.

For road vehicles "ff" and "bb" currently equal var 40, since there are no road vehicle wagons yet.

=== Count Veh.ID occurence (60) ===

'''Format:''' xxxxxxnn

The 60+x parameter is the vehicle ID to look for, and the returned nn is the number of vehicles in the consist that have this ID. If used with VarAction2 type 81, only the current vehicle and onwards will be check, with VarAction2 type 82, all vehicles in the consist will be counted.

=== Query variable of n-th vehicle in chain (61) ===

This is a special variable to get the contents of another variable of a different vehicle in the vehicle chain. It is only supported for trains and road vehicles. It is not supported during a callback that is used to modify vehicle properties to avoid circular dependencies, which currently limits this variable to callbacks 1D, 2D, 31 and 32 plus outside callback scope.

Temporary register 10F is interpreted as a signed integer and specifies the offset in the chain from the current vehicle. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.

The 60+x parameter specifies the variable to access and temporary register 10E is passed as the new 60+x parameter. Passing 61 as the variable is not allowed. Currently only vehicle specific variables listed on this page plus global variable 25 and {{ottdp|1.3|no|ottdrev=r24527}} 5F are accessible through var 61.

The resulting value will have the size of whatever variable is queried.

=== Curvature/position difference for n-th vehicle in chain (62) ===

'''Format:''' zzyyxxFD

This variable is only supported for trains and road vehicles.

The 60+x parameter is interpreted as a signed integer and specifies the offset in the chain from the current vehicle. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.

The lowest nibble (D) contains the direction difference between the selected vehicle and this vehicle, the possible values are identical to those of [[#Curvature_info_.2845.29|variable 45]].

The next nibble (F) has the following meaning:
{| |-
!Bit!!Value!!Meaning
|-
|3||8||The vehicle is currently hidden
|}

The upper three bytes contain the signed difference of the X/Y/Z position between the selected vehicle and this vehicle.

=== Track-type test against another track-type (63) ===

{{ottdp|1.11|no|ottdrev=g868d84bbf}}

'''Format:''' xxxxxxFF

This variable is only supported for trains and road vehicles.

The 60+x parameter is an index into the rail-/road-/tram-type translation table.
The result value reports how vehicles of this type would behave on the current tile.
This allows vehicles to behave or look differently on various track-types independent of their own track-type.

The lower byte (FF) contains some flags:
{|
|-
!Bit!!Value!!Meaning
|-
|0||1||The track-type from the 60+x parameter is known. If unset, all other flags are unset as well, no information can be given.
|-
|1||2||Vehicles with type from the 60+x parameter are compatible with the track on the current tile.
|-
|2||4||Vehicles with type from the 60+x parameter are powered on the track of the current tile.
|-
|3||8||The track-type from the 60+x parameter is identical or equivalent (listed as alternate label in rail-/road-/tram-type property 1D) to the track-type of the current tile.
|}

The remaining bytes are reserved, and must be masked.

=== Count badge occurence (64) ===

The 60+x parameter is the badge ID to look for, and the returned value is the number of vehicles in the consist that have this badge. If used with VarAction2 type 81, only the current vehicle and onwards will be check, with VarAction2 type 82, all vehicles in the consist will be counted.

=== Test if rail or road type of the current tile occupied by the vehicle has that specific badge attached (65) ===

{{ottdp|15|no}}

This variable only works for trains and road vehicles.
The specifications are the same as for [[#Test_if_the_vehicle_has_that_specific_badge_attached.287A.29|variable 7A]].

=== Test if the vehicle has that specific badge attached (7A) ===

{{ottdp|15|no}}

The 60+x parameter is the index into the badge table.
The returned value is in range [0, 1].

=== Modflags (FE and FF) ===

The bits in FE mostly relate to gradualloading.  A few useful bits for grf authors are;

{| |-
!Bit!!Version!!Value of the bit
|-
|1||{{ottdp|1.5|2.5|ottdrev=r26430}}||Vehicle is still unloading and has not yet started loading new cargo at the current station.
|-
|5||{{ottdp|0.6|2.5}}||Vehicle is powered (engine or powered wagon, mainly useful for the latter)
|-
|6||{{ottdp|0.6|2.5}}||Vehicle would be powered (engine or powered wagon) if there were suitable track. (E.g. electric train in mixed train on normal track)
|-
|8 <ref>This bit is only accurate for the first vehicle in the consist.</ref>||{{ottdp|0.6|2.5}}||This bit is flipped every time the train reverses direction
|-
|10||{{ottdp|0.6|2.5|ttdprev=r1334}}||Vehicle was built during the exclusive preview
|-
|11||{{ottd|16}}||The train is driving backwards (trains only). {{ottd|17}} Applies to ships as well.
|}
<references/>

variable FF is actually the high byte of variable FE, so FE bit 8 is the same as FF bit 0.

Other bits are reserved; most are actually used for TTDPatch internal states.

NML:Vehicles

2026-10-08T20:02:11Z

Brickblock1: /* Vehicle callbacks */

{{NMLNavPropVarCB}}
==Properties common to all vehicle types==

{| class="wikitable sortable"
! property
! value range
! available for<br />articulated<br />vehicle
! comment
|-
| <code style="color:green">name</code>
| (string)
| yes
| for example <code style="color:darkgreen">string(STR_NAME_HEREFORD_TRAM)</code>
|-
| <code style="color:green">climates_available</code>
| bitmask(CLIMATE_XXX, CLIMATE_YYY, ...)
| set to <code style="color:green">NO_CLIMATE</code>
|
;CLIMATE_TEMPERATE
;CLIMATE_ARCTIC
;CLIMATE_TROPICAL
;CLIMATE_TOYLAND
;NO_CLIMATE
:Vehicle is availble in no climate (e.g. for articulated parts)
;ALL_CLIMATES
:Vehicle is available irrespective of climate

To make a vehicle available in all climates except toyland you could use: <code style="color:green">ALL_CLIMATES & ~bitmask(CLIMATE_TOYLAND)</code>.
|-
| <code style="color:green">introduction_date</code>
| <code style="color:green">date</code>(yyyy,mm,dd)
| no
| Valid range for yyyy is 0 ... 5000000. In TTDPatch, dates after 2044 will be limited to 2044. Unless the engine is introduced within two years after game-start (always 1920 in TTDPatch), a random number of days between 0 and 511 will be added to this.
|-
| <code style="color:green">model_life</code>
| 0 ... 254 (years) or <code style="color:green">VEHICLE_NEVER_EXPIRES</code>
| no
|
Number of years a model is "supported" by the manufacturer, see [[#Engine life cycle|below]].
|-
| <code style="color:green">retire_early</code>
| -128 ... 127 (years)
| no
|
Retire the vehicle (make it unavailable in the purchase menu) this many years before reliability starts dropping, see [[#Engine life cycle|below]]. May be negative.
|-
| <code style="color:green">vehicle_life</code>
| 0 ... 255 (years)
| no
| Life length of an individual vehicle, before it is considered too old and in need of replacement.
|-
| <code style="color:green">reliability_decay</code>
| 0 ... 255
| no
| Default vehicles use 20. The higher the value the faster reliability decays, the more frequent service is needed. 0 means reliability never decreases if the vehicle is not too old
|-
| <code style="color:green">refittable_cargo_classes</code>
|
bit set of [[NML:Cargos#Cargo classes|cargo classes]]
| yes
| for example: <code style="color:darkgreen">bitmask(CC_BULK, CC_COVERED)</code>
|-
| <code style="color:green">non_refittable_cargo_classes</code>
|
bit set of [[NML:Cargos#Cargo classes|cargo classes]]
| yes
| for example: <code style="color:darkgreen">bitmask(CC_OVERSIZED, CC_SPECIAL)</code>
|-
| <code style="color:green">refittable_cargo_types</code>
| bit mask of entries into the cargo translation table
| yes
| As of NML 0.3, do not use this. Use cargo_[dis]allow_refit (see below) instead.
|-
| <code style="color:green">cargo_allow_refit</code>
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Yes
| {{ottdp|1.2|no|ottdrev=r23291}} A list of cargo types to allow refitting to, irrespective of cargo classes. Example: <code style="color:darkgreen">[COAL, IORE]</code>
|-
| <code style="color:green">cargo_disallow_refit</code>
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Yes
| {{ottdp|1.2|no|ottdrev=r23291}} A list of cargo types to disallow refitting to, irrespective of cargo classes. Example: <code style="color:darkgreen">[MAIL]</code>
|-
| <code style="color:green">loading_speed</code>
| 0 ... 255 (cargo units)
| yes
| Units of cargo loaded per time unit. Default vehicles use 5 for trains and road vehicles, 10 for ships and 20 for aircraft. This amount of cargo is loaded to or unloaded from the vehicle every 40 ticks for trains, every 20 ticks for road vehicles and aircraft and every 10 ticks for ships.
|-
| <code style="color:green">cost_factor</code>
| 0 ... 255
| Set to 0
| multiplier to the base purchase cost
|-
| <code style="color:green">running_cost_factor</code>
| 0 ... 255
| Set to 0
| multiplier to the base running costs
|-
| <code style="color:green">cargo_age_period</code>
| 0 ... 65535
| yes
|
{{ottd|1.2|r22713}} This property specifies after how many ticks cargo is aged. Default value is 185. 74 ticks is equal to 1 day. If set to 0, cargo does not age. Repeated tests have shown that the gameplay effects of this property often do not match the expectations of grf authors. Explaining why requires a detailed understanding of the OpenTTD cargo aging algorithm, and how that works with e.g. different map sizes, vehicle speeds, multi-leg feeder systems, etc. TL;DR avoid using this property unless you absolutely understand the effect it will have.
|-
| <code style="color:green">variant_group</code>
| Vehicle ID or alternatively the vehicle numeric ID (0 ... 65535)
| no
|
{{ottd|13}} This property supports grouping vehicles in the purchase menu (also the autoreplace menu). The property value is the ID of another vehicle in the same GRF which will act as the parent for vehicles in the group.

Groups can also be nested (this is experimental as of December 2022 and may change with testing).

See also vehicle extra_flags which can influence the behaviour of vehicles in variant groups.

See also https://github.com/OpenTTD/OpenTTD/pull/10220
|-
| <code style="color:green">extra_flags</code>
| bitmask(VEHICLE_FLAG_XXX, ...)
| no
| {{ottd|13}}
;VEHICLE_FLAG_DISABLE_NEW_VEHICLE_MESSAGE
: Disable "New Vehicle" news message for this engine
;VEHICLE_FLAG_DISABLE_EXCLUSIVE_PREVIEW
: Disable "Exclusive Preview" for this engine
;VEHICLE_FLAG_SYNC_VARIANT_EXCLUSIVE_PREVIEW
: Variants - Include this variant when primary engine has "Exclusive Preview"
;VEHICLE_FLAG_SYNC_VARIANT_RELIABILITY
: Variants - (Attempt to) Synchronize reliability the primary engine.
|-
| <code style="color:green">badges</code>
| Array of badge labels from the [[NML:Badgetable|badgetable]].
| yes
| {{ottd|15.0}} for example <code style="color:darkgreen">["power/electric", "flag/GB"]</code>
|}

===Refittability===

To determine whether your vehicle can be refitted to a certain cargo, OpenTTD uses the following table

{| class="t"
! Cargo matches refittable_cargo_classes
! Cargo matches non_refittable_cargo_classes
! Cargo in cargo_allow_refit
! Cargo in cargo_disallow_refit
! Result
|-
| Yes
| No
| Doesn't matter
| No
| Refittable
|-
| No
| Doesn't matter
| No
| Doesn't matter
| Not refittable
|-
| Doesn't matter
| Doesn't matter
| Yes
| No
| Refittable
|-
| Doesn't matter
| Doesn't matter
| Doesn't matter
| Yes
| Not refittable
|}

For those that prefer boolean logic, the formula is as follows:

refittable = ((cargo classes in refittable_cargo_classes AND NOT cargo classes in non_refittable_cargo_classes) OR cargo in cargo_allow_refit) AND NOT (cargo in cargo_disallow_refit)

In general, you should use refittable_cargo_classes and non_refittable_cargo_classes to decide to which cargos your vehicle is refittable, and only then use cargo_allow_refit and cargo_disallow_refit to allow/disallow specific cargos.

===Engine life cycle===

The life cycle of a vehicle model consists of three phases, as outlined in the following table. The length of each phase and the starting, peak, and final reliabilities are randomized for each engine when starting a new game. Also note that phase 2 (the vehicle's peak performance) is actually about 8 years shorter than the <code style="color:darkgreen">model_life</code> parameter.

{| class="t"
! phase
! duration
! reliability
|-
| 1
| 7 to 38 months
| increases from 48-73% to 75-100%
|-
| 2
| <code style="color:darkgreen">model_life</code> - 8 years + (0 to 15 months)
| stays constant at peak, 75-100%
|-
| 3
| 10 to 20.6 years
| decreases from peak to 25-50%
|}

If <code style="color:darkgreen">model_life</code> is set to <code style="color:darkgreen">VEHICLE_NEVER_EXPIRES</code>, the engine remains in phase 2 forever.

Normally, the vehicle is removed from the purchase menu at the and of phase 3. However if you set the <code style="color:darkgreen">retire_early</code> property, it will be retired this many years before (or after, if the value is negative) the end of phase 2.

==Train properties==

{| class="wikitable sortable"
! property
! value range
! available for<br />articulated<br />vehicle
! comment
|-
| <code style="color:green">sprite_id</code>
| <code style="color:green">SPRITE_ID_NEW_TRAIN</code>
| yes
| Set this property to enable new graphics
|-
| <code style="color:green">speed</code>
| 0 ... 65000 (float, speed units)
| no
| Max speed for engines, speed limit for wagons
|-
| <code style="color:green">misc_flags</code>
| bitmask(TRAIN_FLAG_XXX, ...)
| FLIP should not be set, TILT and MU TO the same value as the 1st part
|
;TRAIN_FLAG_TILT
: enable the tilt bonus (20% speed in curves, if all vehicles in consist have it set). See also curve_speed_mod property.
;TRAIN_FLAG_2CC
:Enable use of the 2nd company colour
;TRAIN_FLAG_MU
:act as multiple unit (used for livery selection only)
;TRAIN_FLAG_FLIP
:Allow vehicle to be flipped (reversed) in depot. {{ottdp|13|no|no}} this flag is no longer required, flip is always allowed, except for multi-header or articulated vehicles which cannot be flipped. For vehicles shorter than 8/8, see [[Action0/Vehicles/Trains#cite_note-6|this note about sprite offsets]]
;TRAIN_FLAG_AUTOREFIT
:Allow autoreffitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;TRAIN_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
;TRAIN_FLAG_SPRITE_STACK
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]].
|-
| <code style="color:green">extra_flags</code>
| bitmask(VEHICLE_FLAG_XXX, ...)
| yes
| {{ottd|16}}
;VEHICLE_FLAG_TRAIN_HAS_CAB
: Train wagon has a cab and can lead a train when driving backwards, without any speed reduction.
Additionally, trains have the extra flags common to all vehicle types, described above.
|-
| <code style="color:green">refit_cost</code>
| 0 ... 255
| yes
| in 50% units of the purchase price cost base
|-
| <code style="color:green">callback_flags</code>
| bitmask(VEH_CBF_XXX, ...)
| yes
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| <code style="color:green">track_type</code>
|{{ottd|15.0.0}} array of items from railtypetable <br/> {{ottd|<15.0.0}} item from railtypetable
| must be the same as front
| Default railtype table: RAIL, MONO, MGLV. If you install a railtypetable yourself you'll always get the railtype you specified. If you want a vehicle to run on electric rail and you don't have a railtypetable, set <code style="color:green">track_type</code> to RAIL and make sure that you set <code style="color:green">engine_class</code> to <code style="color:green">ENGINE_CLASS_ELECTRIC</code>.
|-
| <code style="color:green">ai_special_flag</code>
| [<code style="color:green">AI_FLAG_PASSENGER</code> <nowiki>|</nowiki> <code style="color:green">AI_FLAG_CARGO</code>]
| no
|
;<code style="color:green">AI_FLAG_PASSENGER</code>
:Tell computer players that it's an engine that should only be used for passenger service.
|-
| <code style="color:green">power</code>
| 0 ... 65000 hp (float, power units)
| Set to 0
|
|-
| <code style="color:green">running_cost_base</code>
| RUNNING_COST_XXX
| Set to RUNNING_COST_NONE
|
;RUNNING_COST_STEAM
;RUNNING_COST_DIESEL
;RUNNING_COST_ELECTRIC
;RUNNING_COST_ROADVEH
;RUNNING_COST_NONE
:no running costs
|-
| <code style="color:green">dual_headed</code>
| [0 <nowiki>|</nowiki> 1]
| Set to 0 for all parts of an articulated vehicle
| 1 = dual_headed, otherwise normal engine
|-
| <code style="color:green">default_cargo_type</code>
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE
| Yes
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).
|-
| <code style="color:green">cargo_capacity</code>
| 0 .. 255
| yes
| By default, passenger capacity is 4x, and mail/goods capacity 2x larger than capacity for other cargoes. The capacity set here is used for the default (i.e. first refittable) cargo. Use the <code style="color:green">cargo_capacity</code> callback to avoid this effect.
|-
| <code style="color:green">weight</code>
| 0 .. 1279 ton (float, mass units)
| Set to 0
|
|-
| <code style="color:green">ai_engine_rank</code>
| 0 ... 255
| no
| TTDPatch only: Higher values make the engine for the TTDPatch AI more attractive
|-
| <code style="color:green">engine_class</code>
| ENGINE_CLASS_XXX
| no
|
Defines which livery colour settings apply to the vehicle. It also sets the corresponding sound effect of the engine, and if visual_effect_and_powered is not set, the visual effect as well.
;ENGINE_CLASS_STEAM
;ENGINE_CLASS_DIESEL
;ENGINE_CLASS_ELECTRIC
;ENGINE_CLASS_MONORAIL
;ENGINE_CLASS_MAGLEV
|-
| <code style="color:green">extra_power_per_wagon</code>
| 0 ... 65000 hp (float, power units)
| Set to 0
| Only wagons with a livery override for this engine will add power
|-
| <code style="color:green">tractive_effort_coefficient</code>
| 0 ... 1 (float)
| Set to 0
| Fraction of the vehicle weight that is available as tractive effort. Tractive effort (in kN) is calculated as (TE coefficient) * 9.8 * weight (in tons), with 9.8 being an approximation of the acceleration of gravity (9.81 m/s).
|-
| <code style="color:green">air_drag_coefficient</code>
| 0 ... 1 (float)
| Set to 0
| Coefficient of the relative air drag, in arbitrary units. The default value is approximately (8 / max_speed), with max_speed in km/h, clamped to the range 0.004 .. 0.75.
|-
| <code style="color:green">length</code>
| 1 ... 8
| yes
| Length of the vehicle in arbitrary units. Use a value of 8 (equal to the predefined constant VEHICLE_LENGTH) for a full-length vehicle.
|-
| <code style="color:green">visual_effect_and_powered</code>
| <code style="color:green">visual_effect_and_powered</code> (VISUAL_EFFECT_XXX, offset, <code style="color:green">ENABLE_WAGON_POWER</code> or <code style="color:green">DISABLE_WAGON_POWER</code>)
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect_and_powered</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model_and_powered</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

Set the type of visual effect for the vehicle and its positional offset with respect to the vehicle. An offset of 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.

;VISUAL_EFFECT_DEFAULT
:No effect, unless for the default vehicles
;VISUAL_EFFECT_STEAM
:Steam like from steam engine
;VISUAL_EFFECT_DIESEL
:Steam from internal combustion engine
;VISUAL_EFFECT_ELECTRIC
:Electric sparks
;VISUAL_EFFECT_DISABLE
:No effect
|-
| <code style="color:green">effect_spawn_model_and_powered</code>
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code> or <code style="color:green">EFFECT_SPAWN_MODEL_XXX <nowiki>|</nowiki> ENABLE_WAGON_POWER</code>
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect_and_powered</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model_and_powered</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.
The visual appearance itself is defined by the callback 'create_effect'.

;EFFECT_SPAWN_MODEL_NONE
: Do not spawn any effects.
;EFFECT_SPAWN_MODEL_STEAM
: Gradually less effects when approaching max speed.
;EFFECT_SPAWN_MODEL_DIESEL
: Effect proportional to acceleration, no effect when idling at top speed.
;EFFECT_SPAWN_MODEL_ELECTRIC
: Random effect, gradually less likely when approaching max speed.
|-
| <code style="color:green">extra_weight_per_wagon</code>
| 0 ... 255 ton (float, mass units)
| Set to 0
| Adds extra weight for powered wagons, see <code style="color:green">extra_power_per_wagon</code>
|-
| <span #id="bitmask_vehicle_info"></span><code style="color:green">bitmask_vehicle_info</code>
| 8-bit bitmask
| yes
|
Used for obtaining [[#bitmask consist info|<code style="color:green">bitmask_consist_info</code>]]
|-
| <code style="color:green">curve_speed_mod</code>
| -128 ... 127.996 (float)
| yes
| {{nml|0.7}} {{ottd|12.0}} Maximum curve speed modifier.

The modifier is applied after the normal curve speed calculation is done using the formula max_curve_speed * (1 + curve_speed_mod). This means that the default property value of 0 is equivalent to no change. Negative values are supported, but the resulting vehicle curve speed is clamped at 2 mph-ish to make sure vehicles don't become permanently stuck.

If different vehicles in a train have different curve speed modifiers, the lowest value wins.

See also TRAIN_FLAG_TILT, which is an older and less flexible way of managing vehicle curve speed.
|}

==Road vehicle properties==

{| class="wikitable sortable"
! property
! value range
! available for<br />articulated<br />vehicle
! comment
|-
| sprite_id
| SPRITE_ID_NEW_ROADVEH
| yes
| Set this property to enable new graphics
|-
| speed
| 0 ... 511km/h (float, speed units)
| no
|
|-
| road_type ''or'' tram_type
| item from [[NML:Railtypetable-Roadtypetable-Tramtypetable|roadtypetable]] or [[NML:Railtypetable-Roadtypetable-Tramtypetable|tramtypetable]]
| must be the same as front
| Only ''one'' of these properties may be set.
If <code style="color:green">tram_type</code> is set, <code style="color:green">ROADVEH_FLAG_TRAM</code> must also be set for the vehicle in <code style="color:green">misc_flags</code>.

If not set, road vehicles will default to ROAD and tram vehicles will default to RAIL (this does not overlap with railtype RAIL).
|-
| misc_flags
| bitmask(ROADVEH_FLAG_XXX, ...)
| partly; tram flag must the same
|
;ROADVEH_FLAG_TRAM
:The vehicle requires tram tracks to run on
;ROADVEH_FLAG_2CC
:Enable 2nd company colour
;ROADVEH_FLAG_AUTOREFIT
:Allow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;ROADVEH_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
;ROADVEH_FLAG_SPRITE_STACK
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]].
|-
| refit_cost
| 0 ... 255
| yes
| in 25% units of the purchase price cost base
|-
| callback_flags
| bitmask(VEH_CBF_XXX, ...)
| yes
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| running_cost_base
| RUNNING_COST_XXX
| set to RUNNING_COST_NONE
|
;RUNNING_COST_STEAM
;RUNNING_COST_DIESEL
;RUNNING_COST_ELECTRIC
;RUNNING_COST_ROADVEH
;RUNNING_COST_NONE
:no running costs
|-
| power
| 0 ... 2550hp (float, power units)
| Set to 0
|
|-
| weight
| 0 ... 63.75ton (float, mass units)
| Set to 0
|
|-
| tractive_effort_coefficient
| 0 ... 1 (float)
| Set to 0
| Fraction of the vehicle weight that is available as tractive effort. Tractive effort (in kN) is calculated as (TE coefficient) * 10 * weight (in tons), with 10 being an approximation of the acceleration of gravity (9.81 m/s). Default value is 0.3.
|-
| air_drag_coefficient
| 0 ... 1 (float)
| Set to 0
| Coefficient of the relative air drag, in arbitrary units. The default value is approximately (8 / max_speed), with max_speed in km/h, clamped to the range 0.004 .. 0.75.
|-
| <code style="color:green">default_cargo_type</code>
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE
| Yes
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).
|-
| cargo_capacity
| 0 ... 255
| yes
| By default, passenger capacity is 4x, and mail/goods capacity 2x larger than capacity for other cargoes. The capacity set here is used for the default (i.e. first refittable) cargo. Use the <code style="color:green">cargo_capacity</code> callback to avoid this effect.
|-
| sound_effect
| SOUND_XXX
| no
|
See available [[NML:List of sound effects|sound effects]].
<br/>{{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also <code style="color:green">sound("sound.wav")</code> and <code style="color:green">import_sound(grfid, number)</code> are valid here.
|-
| visual_effect
| visual_effect( VISUAL_EFFECT_XXX, offset)
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

Set the type of visual effect for the vehicle and its positional offset with respect to the vehicle. An offset of 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.

;VISUAL_EFFECT_DEFAULT
:No effect, unless for the default vehicles
;VISUAL_EFFECT_STEAM
:Steam like from steam engine
;VISUAL_EFFECT_DIESEL
:Steam from internal combustion engine
;VISUAL_EFFECT_ELECTRIC
:Electric sparks
;VISUAL_EFFECT_DISABLE
:No effect
|-
| <code style="color:green">effect_spawn_model</code>
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code>
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.
The visual appearance itself is defined by the callback 'create_effect'.

;EFFECT_SPAWN_MODEL_NONE
: Do not spawn any effects.
;EFFECT_SPAWN_MODEL_STEAM
: Gradually less effects when approaching max speed.
;EFFECT_SPAWN_MODEL_DIESEL
: Effect proportional to acceleration, no effect when idling at top speed.
;EFFECT_SPAWN_MODEL_ELECTRIC
: Random effect, gradually less likely when approaching max speed.
|-
| length
| 1 ... 8
| yes
| Length of the vehicle in arbitrary units. Use a value of 8 (equal to the predefined constant VEHICLE_LENGTH) for a full-length vehicle.
|}

==Ship properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| sprite_id
| SPRITE_ID_NEW_SHIP
| Set this property to enable new graphics
|-
| speed
| 0 ... 127 km/h (float, speed units)
| {{ottd|14}}{{nml|7.5}} 0 .. 32767 km/h (float, speed units)
|-
| misc_flags
| bitmask(SHIP_FLAG_XXX)
| Bitmask with to possible flags, set to 0 to disable all.

;SHIP_FLAG_2CC
:Enable use of the 2nd company colour
;SHIP_FLAG_AUTOREFIT
:llow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;SHIP_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
;SHIP_FLAG_SPRITE_STACK
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]].
|-
| extra_flags
| bitmask(VEHICLE_FLAG_XXX, ...)
| {{ottd|17}}
;VEHICLE_FLAG_SHIP_IS_DOUBLE_ENDED
: Ship can reverse direction without having to turn around.
Additionally, ships have the extra flags common to all vehicle types, described above.
|-
| refit_cost
| 0 ... 255
| in 1/32 of the default refit cost base
|-
| callback_flags
| bitmask(VEH_CBF_XXX, ...)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| is_refittable
| [0 <nowiki>|</nowiki> 1]
| 0=false, 1=true. Note: if you do not set this property to 1, then refittable_cargo_classes / non_refittable_cargo_classes have no effect.
|-
| <code style="color:green">default_cargo_type</code>
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).
|-
| cargo_capacity
| 0 ... 255
| For ships (unlike other vehicle types) the capacity set here is not affected by the cargo type.
|-
| sound_effect
| SOUND_XXX
|
See available [[NML:List of sound effects|sound effects]].
<br/>{{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also <code style="color:green">sound("sound.wav")</code> and <code style="color:green">import_sound(grfid, number)</code> are valid here.
|-
| ocean_speed_fraction
| 0 ... 1 (float)
|
{{ottd|1.2|r22639}} fraction of base speed on ocean tiles (default: 1)
|-
| canal_speed_fraction
| 0 ... 1 (float)
|
{{ottd|1.2|r22639}} fraction of base speed on canal tiles (default: 1)
|-
| visual_effect
| visual_effect(VISUAL_EFFECT_XXX, offset)
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

XXX=[DEFAULT <nowiki>|</nowiki> STEAM <nowiki>|</nowiki> DIESEL <nowiki>|</nowiki> ELECTRIC <nowiki>|</nowiki> DISABLE], it is the type of the visual effect you want for this ship. Default means no effect. Offset is the position of the effect. 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.
|-
| <code style="color:green">effect_spawn_model</code>
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code>
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.
The visual appearance itself is defined by the callback 'create_effect'.

;EFFECT_SPAWN_MODEL_NONE
: Do not spawn any effects.
;EFFECT_SPAWN_MODEL_STEAM
: Gradually less effects when approaching max speed.
;EFFECT_SPAWN_MODEL_DIESEL
: Effect proportional to acceleration, no effect when idling at top speed.
;EFFECT_SPAWN_MODEL_ELECTRIC
: Random effect, gradually less likely when approaching max speed.
|-
| acceleration
| 1 ... 255
| {{ottd|14}} Acceleration in units of ~0.5 km/h per tick. 1 is the default and is the acceleration of default ships.
|}

==Aircraft properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| sprite_id
| SPRITE_ID_NEW_AIRCRAFT
| Set this property to enable new graphics
|-
| speed
| 0 .. 3280 km/h (float, speed units)
|
|-
| range
| 0 .. 2894
| {{nml|0.3}} {{ottdp|1.2|no|ottdrev=r23504}} Maximum (euclidean) distance the aircraft can cover between two airports. Set to 0 for unlimited range.
|-
| misc_flags
| bitmask(AIRCRAFT_FLAG_2CC, AIRCRAFT_FLAG_AUTOREFIT)
| Bitmask with to possible flags, set to 0 to disable all.

;AIRCRAFT_FLAG_2CC
:Enable 2nd company colour
;AIRCRAFT_FLAG_AUTOREFIT
:Allow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;AIRCRAFT_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
;AIRCRAFT_FLAG_SPRITE_STACK
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]]. This also affects custom rotor sprites.
|-
| refit_cost
| 0 ... 255
| in 1/32 of default refit cost base
|-
| callback_flags
| bitmask(VEH_CBF_XXX, ...)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| aircraft_type
| AIRCRAFT_TYPE_XXX
|
;AIRCRAFT_TYPE_HELICOPTER
:Can land on helipad
;AIRCRAFT_TYPE_SMALL
:Can land on all airports with runway
;AIRCRAFT_TYPE_LARGE
:Can land on all airports with runway. But have a high crash chance on small airports
|-
| acceleration
| {{ottd|1.3.1}} 0 ... 255 <br/> {{ottd|<1.3.1}} 0 ... 19
| {{ottd|1.3.1}} Default aircraft use values in the range 18 to 50 (= 6.75 to 18.75 mph/tick = 499.5 to 1387.5 mph/day), which is generally considered quite fast.<br/>
{{ottd|<1.3.1}} In older OpenTTD, aircraft provided by NewGRF accelerate 166% faster than intended.
|-
| passenger_capacity
| 0 ... 65536
| Capacity for the passenger compartment. See also the notes at <code style="color:darkgreen">mail_capacity</code> below.
|-
| mail_capacity
| 0 ... 255
| Capacity for the mail compartment, if refitted to a cargo in the CC_PASSENGERS class. When refitted to other cargoes, this capacity is added to the passenger capacity to determine the base capacity. The actual capacity is set to this base capacity divided by 1 for mail, 2 for goods and 4 for all other cargoes. To override this effect, use the <code style="color:darkgreen">passenger_capacity</code> and <code style="color:darkgreen">mail_capacity</code> callbacks.
|-
| sound_effect
| SOUND_XXX
|
See available [[NML:List of sound effects|sound effects]].
<br/>{{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also <code style="color:green">sound("sound.wav")</code> and <code style="color:green">import_sound(grfid, number)</code> are valid here.
|}

==Vehicle variables==

Below an overview of all vehicle-specific variables. Note that in the purchase list, the vehicle is not built yet and as such many variables are not available. All general variables are available, refer to the table for info on vehicle-specific variables. Trying to access a non-available variable invokes undefined behaviour. Please note that while all variables are available for all vehicles types, some of them only make sense for one or more vehicle types. For example checking current_railtype for a non-rail vehicle doesn't make sense at all, similarly checking current_roadtype for a tram won't return a useful result.

===Variables without parameter===

{| class="wikitable sortable"
! name
! value range
! available in<br />purchase list?
! comment
|-
| position_in_consist
| 0 ... 255
| No
| The position of the current vehicle-part from the start of the vehicle. The engine will get value 0, the first wagon (or second engine) gets value 1, etc.
|-
| position_in_consist_from_end
| 0 ... 255
| No
| Same as position_in_consist but counted from the end. The last wagon will get value 0.
|-
| num_vehs_in_consist
| 1 ... 256
| No
| The total number of vehicles-parts in this vehicle. For aircraft this will include the shadow and the rotor.
|-
| position_in_vehid_chain
| 0 ... 255
| No
| See position_in_consist, but not of the complete vehicle but only all consecutive parts with the same id.
|-
| position_in_vehid_chain_from_end
| 0 ... 255
| No
| See position_in_consist_from_end, but not of the complete vehicle but only all consecutive parts with the same id.
|-
| num_vehs_in_vehid_chain
| 1 ... 256
| No
| See num_vehs_in_consist, but not of the complete vehicle but only all consecutive parts with the same id.
|-
| position_in_articulated_veh
| 0 ... 255
| No
| {{nml|0.3}} {{ottdp|1.4|no|ottdrev=r26157}} The position of the current articulated vehicle from the start of the vehicle. The first will get value 0, the second one gets value 1, etc.
|-
| position_in_articulated_veh_from_end
| 0 ... 255
| No
| {{nml|0.3}} {{ottdp|1.4|no|ottdrev=r26157}} The position of the current articulated vehicle from the end of the vehicle. The last will get value 0, the second last one gets value 1, etc.
|-
| cargo_classes_in_consist
| Bitmask of CC_XXX
| No
|
[[NML:Cargos#Cargo classes|cargo classes]]
|-
| most_common_cargo_type
|
[[NML:Cargos#Cargo properties|Cargo label]]
| No
| The most common cargo type in the consist. Prior to nml r2320 this was known as most_common_refit, and didn't work, and was also incorrectly documented :)
|-
| most_common_cargo_subtype
| 0 ... 255
| No
| The most common cargo subtype for most_common_cargo_type
|-
| bitmask_consist_info
| Bitmask 8 bit
| No
|
Binary OR of the values of [[#bitmask vehicle info|bitmask_vehicle_info]] of all vehicles (engines, wagons) in the consist. Only available for rail vehicles.
|-
| company_num
| 0 ... 14
| Yes
| company number of the vehicle owner. TTDPatch only supports up to 8 companies (0 ... 7)
|-
| company_type
| PLAYERTYPE_XX
| Yes
|
;PLAYERTYPE_HUMAN
:human player
;PLAYERTYPE_AI
:AI player
;PLAYERTYPE_HUMAN_IN_AI
:human managing AI company
;PLAYERTYPE_AI_IN_HUMAN
:AI managing human company

OpenTTD only uses PLAYERTYPE_HUMAN and PLAYERTYPE_AI. If you cheat yourself to be part of an AI company OpenTTD will still report PLAYERTYPE_AI for the company with yourself and the AI and it'll report PLAYERTYPE_HUMAN for the now uncontrolled company.
|-
| company_colour1
| COLOUR_XXX
| Yes
|
Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| company_colour2
| COLOUR_XXX
| Yes
|
Same as company_colour1, if no 2nd company colour is chosen. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| aircraft_height
| 0 ... 255
| No
| Height difference between the aircraft and its shadow. 8 Units are equivalent to one height level on the map.
|-
| airport_type
| AIRPORTTYPE_XX
| No
|
;AIRPORTTYPE_SMALL
;AIRPORTTYPE_LARGE
;AIRPORTTYPE_HELIPORT
;AIRPORTTYPE_OILRIG
|-
| flight_state
| 0 ... 28
| No
| {{nml|0.8.1}} Only for aircrafts.
|-
| curv_info_prev_cur
| -2 ... 2
| No
| Difference in direction between the previous (towards engine) vehicle and this vehicle. Curvature to the right is positive. 1 unit is 45 degrees.
|-
| curv_info_cur_next
| -2 ... 2
| No
| Difference in direction between this vehicle and the next (towards rear end) vehicle. Curvature to the right is positive. 1 unit is 45 degrees.
|-
| curv_info_prev_next
| -4 ... 4
| No
| Difference in direction between the previous (towards engine) and next (towards rear end) vehicle. Curvature to the right is positive. 1 unit is 45 degrees. Equal to <code style="color:darkgreen">curve_invo_prev_cur + curv_info_cur_next</code>.
|-
| curv_info
| vehicle_curv_info(''prev_cur'', ''cur_next'')''''
| No
|
Returns a magic number that represents the curvature state of the prev-cur-next vehicle triplet. Do not try to make sense of this magic number, use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">vehicle_curv_info()</code> instead to make comparisons. <code style="color:darkgreen">curv_info == vehicle_curv_info(a, b)</code> is equivalent to <code style="color:darkgreen">(curv_info_prev_cur == a) && (curv_info_cur_next == b)</code>, however the former can easily be used in a switch-block.
|-
| motion_counter
| 0 ... 0xFFFFFF
| Yes, always 0
| Is increased every time the vehicle moves a single step on the map. Useful for driving animations.
For that, make the animation use a number of frames, which is a power of two, i.e. 2, 4, 8, 16, 32, ... frames, and then use the lower n bits of motion_counter.
|-
| cargo_type_in_veh
| entry in cargo translation table
| Yes, for the default cargo
| 0xFF if not present in the table
|-
| cargo_unit_weight
| weight per unit in 1/16t
| Yes, for the default cargo
|
|-
| cargo_classes
| Bitmask of [[NML:Cargos#Cargo properties|cargo class]]
| Yes, for the default cargo
| class of the currently transported cargo
|-
| vehicle_is_available
| [0 <nowiki>|</nowiki> 1]
| Yes
| Value is 1 if the vehicle is available on the open market
|-
| vehicle_is_testing
| [0 <nowiki>|</nowiki> 1]
| Yes
| Value is 1 if the vehicle is currently being tested
|-
| vehicle_is_offered
| [0 <nowiki>|</nowiki> 1]
| Yes
| Value is 1 if the vehicle is currently being offered for exclusive preview
|-
| build_year
| 0 ... 5000000
| Yes
| 0-based year when the vehicle was built, current year if the vehicle is not built yet
|-
| direction
| DIRECTION_XX
| No
|
See [[NML:List of direction constants|here]] for an overview of possible values and their meaning.
|-
| cargo_capacity
| 0 ... 65535
| No
| Cargo capacity (number of units) of the vehicle
|-
| cargo_count
| 0 ... 65535
| No
| Number of cargo units of cargo in the vehicle
|-
| cargo_subtype
| 0 ... 255
| Yes, always 0
| Cargo subtype, used to provide more than one refit option for the same cargo type. See also the <code style="color:darkgreen">cargo_subtype_text</code> callback.
|-
| vehicle_is_powered
| [0 <nowiki>|</nowiki> 1]
| No
| Vehicle provides power and is on the correct track type
|-
| vehicle_is_not_powered
| [0 <nowiki>|</nowiki> 1]
| No
| Vehicle is either on a wrong track type or it doesn't provide power at all
|-
| vehicle_is_potentially_powered
| [0 <nowiki>|</nowiki> 1]
| No
| Vehicle provides power, if it is on a suitable track type
|-
| vehicle_is_flipped
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the sprite is reversed via flip-vehicle-in-depot (trains only), or if it's the rear-most part of a dual-head engine.
|-
| vehicle_is_reversed
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle has reversed an odd number of times
|-
| train_is_driving_backwards
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottd|16}} Value is 1 if the train is driving backwards (trains only). Deprecated, use vehicle_is_moving_backwards instead.
|-
| vehicle_is_moving_backwards
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottd|17}} Value is 1 if the vehicle is moving backwards (trains and ships only)
|-
| built_during_preview
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle was built during the exclusive preview stage
|-
| current_railtype
| Entry from railtype translation table or 0xFF
| No
| This variable is useless due to equivalent railtypes, use tile_xxx_railtype instead. If you do use this variable, it will not work as expected unless you've defined a railtype translation table. If the train is running on a railtype that is not listed in your railtype translation table this variable will contain 0xFF.
|-
| current_roadtype
| Entry from current_roadtype translation table or 0xFF
| No
| {{nml|0.5}} {{ottdp|1.10|no}} This variable is useless due to equivalent roadtypes, use tile_xxx_roadtype instead. Don't use this variable unless you've defined a roadtype translation table. If the road vehicle is running on a roadtype that is not listed in your roadtype translation table this variable will contain 0xFF. Checking this for a tram is not supported and will not return a useful result.
|-
| current_tramtype
| Entry from tramtype translation table or 0xFF
| No
| {{nml|0.5}} {{ottdp|1.10|no}} This variable is useless due to equivalent tramtypes, use tile_xxx_tramtype instead. Don't use this variable unless you've defined a tramtype translation table. If the road vehicle is running on a tramtype that is not listed in your tramtype translation table this variable will contain 0xFF. Checking this for a road vehicle that is not a tram is not supported and will not return a useful result.
|-
| tile_has_catenary
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottdp|1.11|no}} True if the track_type on the tile has catenary. This is a little simplified as it is intended for sprite changes (e.g. raise/lower pantograph) and only checks for "some catenary". To distinguish different types of electric track, AC and DC voltages etc, ... use tile_xxx_railtype/tile_xxx_roadtype/tile_xxx_tramtype instead.
|-
| waiting_triggers
|
| No
|
Random triggers waiting to be matched. (see [[NML:Random switch|Random switch]])
|-
| random_bits
| 0 ... 255
| No
|
Random data that can be used to randomize certain descisions. (see [[NML:Random switch|Random switch]])
|-
| grfid
| 0 ... 0xFFFFFFFF
| No
|
GRFID that defined the [[NML:Graphics|graphics]]-block for this vehicle. To compare this with other grfids, use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert the other GRFID to a number as well.
|-
| vehicle_type_id
| 0 ... 65535 or a name defined in item block
| No
| GRF-local ID of the vehicle, equal to the item ID. Note that vehicles from other NewGRFs may have the same ID, so you'll generally have to check the <code style="color:darkgreen">grfid</code> as well.
|-
| vehicle_is_hidden
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is hidden in a depot or tunnel.
|-
| vehicle_is_stopped
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is stopped, or if it is braking for a stop (trains only).
|-
| vehicle_is_crashed
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle has crashed.
|-
| vehicle_is_broken
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is broken down.
|-
| date_of_last_service
| date(year, month, day)
| No
|
|-
| breakdowns_since_last_service
| 0 ... 255
| No
| Number of breakdowns since the last service
|-
| reliability
| 0 ... 100
| No
| Reliability (percentage)
|-
| age_in_days
| 0 ... 65535
| No
| Vehicle age in days.
|-
| max_age_in_days
| 0 ... 65535
| No
| Maximum vehicle age in days.
|-
| current_speed
| (speed units)
| No
| The current speed of the vehicle in m/s
|-
| max_speed
| (speed units)
| No
| The maximum speed of the vehicle in m/s
|-
| current_max_speed
| (speed units)
| No
| {{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24246}} Current maximum speed of the vehicle in m/s. This includes e.g. track or timetable limits. Only valid for front vehicle.
|-
| vehicle_is_in_depot
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is inside a depot
|-
| vehicle_is_unloading
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottdp|1.5|2.5|ottdrev=r26430}} Value is 1 if the vehicle is unloading at a station and has not yet started loading new cargo.
|}

===Variables that require an argument===

{| class="wikitable sortable"
! name
! Argument
! value range
! available in<br />purchase list?
! comment
|-
| count_veh_id
| The vehicle ID to look for.
| 0..255
| No
| The number of vehicles in the current consist that have the given ID.
|-
| other_veh_curv_info
| Offset in the chain from the current vehicle.<ref name="offset">Argument range is -128..127. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.</ref>
| -4..4
| No
| Difference in direction between the other vehicle and this vehicle. Curvature to the right is positive. 1 unit is 45 degrees.
|-
| other_veh_is_hidden
| Offset in the chain from the current vehicle.<ref name="offset"/>
| [0 <nowiki>|</nowiki> 1]
| No
| 1 the other vehicle is hidden in a depot or tunnel, 0 otherwise
|-
| other_veh_x_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in X-position (top-right to bottom-left) between the other vehicle and this vehicle.
|-
| other_veh_y_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in Y-position (top-left to bottom-right) between the other vehicle and this vehicle.
|-
| other_veh_z_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in Z-position (upwards) between the other vehicle and this vehicle.
|-
| tile_supports_railtype <br /> tile_supports_roadtype <br /> tile_supports_tramtype
| Entry from rail/road/tram translation table
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottdp|1.11|no}} Vehicles of the track_type label used as parameter are compatible with the rail/road/tram track_type on the current tile. Example: <code style="color:darkgreen">tile_supports_railtype(ELRL)</code>
|-
| tile_powers_railtype <br /> tile_powers_roadtype <br />tile_powers_tramtype
| Entry from rail/road/tram translation table
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottdp|1.11|no}} Vehicles of the track_type label used as parameter are powered on the rail/road/tram track_type on the current tile. Example: <code style="color:darkgreen">tile_powers_railtype(ELRL)</code>
|-
| tile_is_railtype <br /> tile_is_roadtype <br /> tile_is_tramtype
| Entry from rail/road/tram translation table
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottdp|1.11|no}} The track_type label used as parameter is identical or equivalent (listed as alternate label in rail-/road-/tram-type property 1D) to the rail/road/tram track_type on the current tile. Example: <code style="color:darkgreen">tile_is_railtype(ELRL)</code>
|-
| has_badge
| Label from the [[NML:Badgetable|badgetable]].
| [0 <nowiki>|</nowiki> 1]
| yes
| {{ottd|15.0}} {{nml|0.9.0}} Check if the vehicle has that specific badge attached.
|-
| count_has_badge
| Label from the [[NML:Badgetable|badgetable]].
| 0..255
| no
| {{ottd|15.0}} {{nml|0.9.0}} The number of vehicles in the current consist that have that specific badge attached.
|-
| tile_has_railtype_badge <br /> tile_has_roadtype_badge <br /> tile_has_tramtype_badge
| Label from the [[NML:Badgetable|badgetable]].
| [0 <nowiki>|</nowiki> 1]
| no
| {{ottd|15.0}} {{nml|0.9.0}} Check if the rail/road/tram type of the current tile occupied by the vehicle has that specific badge attached. '''Trains/RVs/Trams only.''' <code>tile_has_roadtype_badge</code> also works for trams to allow code reuse.
|}
<references/>

==Vehicle callbacks==
The following table contains a list of available vehicle callbacks. Additionally, it's possible to provide cargo-specific graphics, using the identifier from the [[NML:Cargotable|cargo table]] as callback name. These callbacks will be used if the vehicle is refitted to the corresponding cargo type. If no cargo-specific graphics match the cargo that the vehicle is carrying, the <code style="color:darkgreen">default</code> callback is used instead. Cargo-specific graphics callbacks are never called from the purchase menu, refer to the <code style="color:darkgreen">purchase</code> callback below instead.

Note that the above affects '''graphics only''', other callbacks are unaffected.

{| class="wikitable sortable"
! Name
! Available for
! In purchase menu?
! value range
! comment
|-
| default
| All
| Yes, unless <code style="color:darkgreen">purchase</code> is set separately
| Sprite group
| 'Normal' vehicle graphics, if no cargo-specific graphics apply. See also the section on [[#Sprites in GUI|GUI sprites]].
|-
| purchase
| All
| Yes, only
| Sprite group
| Graphics to show in the buy menu (only the horizontal view is needed, except for dual-headed trains. With the <code>dual_headed</code> property set, special rules for the purchase menu sprite apply: two sprites are drawn (for front and back) as if the vehicle is normally constructed. If you supply one purchase menu sprite, it will be used for both vehicle parts in the purchase menu. Provide a set of 8 sprites, and the 7th resp. 3rd sprite will be drawn; provide a set of 8 blank sprites except the 7th if you want to fully control a single purchase menu sprite for a dual-headed engine. ) See also the section on [[#Sprites in GUI|GUI sprites]].
|-
| rotor
| Aircraft (helicopters)
| No
| Sprite group
| Graphics for the helicopter rotor (4 sprites; 1 stopped and 3 moving)
|-
| random_trigger
| All
| No
| N/A
| See [[NML:Random switch|random switch]] for more information.
|-
| cargo_subtype_text
| All
| No
| String, or CB_RESULT_NO_TEXT
| <b>NOTE: As of OpenTTD 13, this feature is considered deprecated for most uses. Use variants instead.</b> With this callback, you can display extra text after the cargo in the vehicle information window. This callback is called during refitting, with succesively increased values of the <code style="color:darkgreen">cargo_subtype</code> variable, until the callback returns CB_RESULT_NO_TEXT. All returned strings are then displayed as refit options. The chosen refit option is saved in the <code style="color:darkgreen">cargo_subtype</code> variable, so it can be used to select specific sprites for the vehicle's current cargo subtype.
|-
| additional_text
| All
| Yes, only
| String
| Additional text to show in the purchase list.
|-
| colour_mapping
| All
| Yes, unless <code style="color:darkgreen">purchase_colour_mapping</code> is set separately
| Recolour sprite number
|
With this callback, you can use a different recolour sprite instead of the standard 1cc / 2cc company colour remappings. See [[NML:List of default colour translation palettes|here]] for a list of default palettes. See the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">reserve_sprites()</code> for info on how to allocate your own sprite. For performance, the result is cached and only updated if the <code style="color:darkgreen"> every_32_days</code> callback requires so. Add CB_RESULT_COLOUR_MAPPING_ADD_CC to the result to add the company colour to the sprites, this requires 16 (1cc) or 256 (2cc) sprites in total.
|-
| start_stop
| All
| No
| String or CB_RESULT_NO_TEXT
| Called when starting or stopping a vehicle. Mainly useful to prevent vehicles from leaving the depot unless a certain condition is met. Return CB_RESULT_NO_TEXT to allow or a string (containing an error message) to disallow starting/stopping.
|-
| every_32_days
| All
| No
| bitmask(CB_RESULT_32_DAYS_XXX, ...)
| Called every 32 days. Set CB_RESULT_32_DAYS_TRIGGER in the bitmask to trigger TRIGGER_VEHICLE_32_CALLBACK. Set CB_RESULT_32_DAYS_COLOUR_MAPPING in the bitmask to update the colour mapping by re-running the <code style="color:darkgreen">colour_mapping</code> callback.
|-
| sound_effect
| All
| No
| SOUND_XXX, sound("sound.wav"), import_sound(grfid, number) or CB_RESULT_NO_SOUND
|
Called to play various vehicle sounds.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> The sound event, see the [[#Sound events|table]] below.
Return SOUND_XXX (see [[NML:List_of_sound_effects|here]]) to return a default sound. <code style="color:darkgreen">sound("soundfile")</code> imports a sound from a .wav file. <code style="color:darkgreen">import_sound(grfid, number)</code> imports a sound from another grf. A failed (or not implemented) callback will cause the default sound to be played. Return CB_RESULT_NO_SOUND to play no sound at all.
|-
| articulated_part
| Trains, Road Vehicles
| Yes (no separate callback)
| Vehicle ID, or CB_RESULT_NO_MORE_ARTICULATED_PARTS
| With this callback, you can add articulated parts (e.g. tenders) to your vehicle. Called repeatedly, until CB_RESULT_NO_MORE_ARTICULATED_PARTS is returned. After each call, the returned vehicleID is added to your vehicle.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> contains 1 during the first call, 2 during the second, etc.
Note that callback may be called from the purchase list, using vehicle variables is not possible. Or CB_RESULT_REVERSED_VEHICLE to the returned vehicle ID to display the vehicle backwards.

The vehicle ID for the articulated part must be in the range 0 .. 16383.

For NML 0.2 and lower the vehicle ID of the articulated part must be in the range 0 .. 127.

|-
| can_attach_wagon
| Trains
| No
| String or CB_RESULT_ATTACH_XXX
| Called when a wagon is being attached, to allow or disallow attaching. If a wagon is inserted in the middle, all wagons are removed and attached one-by-one in the new order. This callback has to be defined at the engine. The scopes behave different than usual though:
* <code style="color:darkgreen">SELF</code> refers to the wagon being attached. (despite the callback being defined at the engine)
* <code style="color:darkgreen">PARENT</code> refers to the consist of the engine up to the wagon before <code style="color:darkgreen">SELF</code>, i.e. not (yet) including the wagon being attached.
Return a string to disallow with the string as error message. Return CB_RESULT_ATTACH_DISALLOW to disallow with standard message ("incompatible railtypes"), CB_RESULT_ATTACH_ALLOW to allow or CB_RESULT_ATTACH_ALLOW_IF_RAILTYPES to allow if the railtypes match (default).
|-
| refit_cost
| {{ottdp|1.2|no|ottdrev=r23089}} All
| Yes
| -8192 .. 8191 as refit cost. Add <code style="color:darkgreen">CB_RESULT_AUTOREFIT</code> if you want to allow autorefit.
| When returning a negative value, encode the cost as (cost & <code style="color:darkgreen">CB_RESULT_REFIT_COST_MASK</code>) before (possibly) adding <code style="color:darkgreen">CB_RESULT_AUTOREFIT</code>. To allow autorefitting, the corresponding bit in the <code style="color:darkgreen">misc_flags</code> must be set as well.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>: The new cargo type.
* <code style="color:darkgreen">getbits(extra_callback_info1, 8, 8)</code>: The new cargo subtype (see <code style="color:darkgreen">cargo_subtype_text</code>-callback).
* <code style="color:darkgreen">getbits(extra_callback_info1, 16, 16)</code>: A bitmask of the [[NML:Cargos#Cargo_classes|cargo classes]] of the target cargo type.
Note that this callback may also be called when the vehicle does not exist yet, so the available variables are limited.
|-
| create_effect
| {{ottdp|1.5|no|ottdrev=r26747}} Trains, Road Vehicles, Ships
| No
| 0 .. 3 for number of effects. Optionally add <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_CENTER</code> and/or <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>
| Called when a effect spawning model is defined via <code style="color:darkgreen">effect_spawn_model</code> resp. <code style="color:darkgreen">effect_spawn_model_and_powered</code>.

The result specifies how many effects shall be created.
The position and appearance of the individual effects is returned via registers 0x100 to 0x103:
<pre style="color:blue">
switch (FEAT_XXX, SELF, switch_name, [
STORE_TEMP(create_effect(EFFECT_SPRITE_XXX, 8, -3, 10), 0x100), // first effect,
STORE_TEMP(create_effect(EFFECT_SPRITE_YYY, 8, 3, 10), 0x101) // second effect, ...
]) {
return 2; // number of effects
}
</pre>
The register values are created using the <code style="color:darkgreen">create_effect(''effect_sprite'', ''l_x_offset'', ''t_y_offset'', ''z_offset'')</code> function:
* ''effect_sprite'': Sprite for the effect. One of <code style="color:darkgreen">EFFECT_SPRITE_</code>[<code style="color:darkgreen">NONE</code>|<code style="color:darkgreen">STEAM</code>|<code style="color:darkgreen">DIESEL</code>|<code style="color:darkgreen">ELECTRIC</code>|<code style="color:darkgreen">AIRCRAFT_BREAKDOWN_SMOKE</code>].
* ''l_x_offset'': Longitudinal or X position of the effect, depending on callback result <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>.
* ''t_y_offset'': Transversal or Y position of the effect, depending on callback result <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>.
* ''z_offset'': Z position of the effect.

Additional to the number of effects, the callback result may specify these flags:
;<code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_CENTER</code>
:(Train and road vehicle only) If set, position effect relative to vehicle center instead of relative to vehicle sprite. (behaves the same for vehicles with length 8/8)
;<code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>
*If not set, the parameters to <code style="color:darkgreen">effect_sprite</code> describe longitudinal/transversal positions, which are rotate wrt. vehicle orientation.
*If set, the parameters to <code style="color:darkgreen">effect_sprite</code> describe X and Y positions, which are not automatically rotated.
|-
| reverse_build_probability
| {{nml|0.7.5}} {{ottd|14.0}} Trains
| No
| 0 .. 100
| Probability of reversing rail vehicle, i.e. facing forward or backward, when purchased.
|-
| refit
| {{ottd|15.0}} All vehicle types
| Callback runs once, in purchase scope only
|
* 0 Don't change refittability (i.e. use whatever the evaluation of the various refittability vehicle props has determined).
* 1 Allow cargo type as a refit.
* 2 Disallow cargo type as a refit.
|

The custom refit callback allows overriding the refittablity of each cargo as defined by the standard vehicle properties. It will be called for each defined cargo type once after the game has loaded all NewGRF files. The callback is run in purchase list scope, i.e. for cargotype FF. No variables of an actual vehicle are available. Information about the cargo type the callback is called for is available in variables 10 and 18:
'''Note:''' As this callback is not re-evaluated after game initialization, using any dynamic variables like e.g. game date will lead to undefined and faulty behaviour.

This callback is available starting with {{ottdp|15|no|ottdrev=gd2496b6ec4}} OpenTTD 15.

See https://newgrf-specs.tt-wiki.net/wiki/Callbacks#Custom_refit_.28163.29
|}

The following callbacks all have an equivalent property. The property description applies here also, except where otherwise noted.

{| class="wikitable sortable"
! Name
! Available for
! In purchase menu?
! comment
|-
| loading_speed
| All
| No
|
|-
| speed
| All
| Yes, unless <code style="color:darkgreen">purchase_speed</code> is set separately
| Units are not (yet) available
|-
| cost_factor
| All
| Yes, only
|
|-
| running_cost_factor
| All
| Yes, unless <code style="color:darkgreen">purchase_running_cost_factor</code> is set separately
|
|-
| cargo_age_period
| All
| No
|
|-
| cargo_capacity
| All except aircraft
| Yes, unless <code style="color:darkgreen">purchase_cargo_capacity</code> is set separately
|
|-
| passenger_capacity
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_passenger_capacity</code> is set separately
|
|-
| mail_capacity
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_mail_capacity</code> is set separately
|
|-
| range
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_range</code> is set separately
|
|-
| visual_effect_and_powered
| Trains
| No
|
|-
| visual_effect
| Road Vehicles, Ships
| No
|
|-
| effect_spawn_model_and_powered
| Trains
| No
|
|-
| effect_spawn_model
| Road Vehicles, Ships
| No
|
|-
| power
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_power</code> is set separately
| Units are not (yet) available
|-
| weight
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_weight</code> is set separately
| Units are not (yet) available
|-
| length
| Trains, Road vehicles
| No
|
|-
| tractive_effort_coefficient
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_tractive_effort_coefficient</code> is set separately
| Value range is 0 .. 255 instead of 0 .. 1.
|-
| bitmask_vehicle_info
| Trains
| No
|
|-
| curve_speed_mod
| {{nml|0.7}} {{ottd|12.0}} Trains
| No
|
|-
| name
| {{nml|0.7.2}} {{ottd|14.0}} All
| Yes
| Can be used to display vehicle name differently depending on context (purchase menu, depot, nested variant depth etc). <code style="color:darkgreen">extra_callback_info1</code> contains detailed information about context - please see https://newgrf-specs.tt-wiki.net/wiki/Callbacks#Engine_name_.28161.29
|}

===Sprites in GUI===
{{ottdp|1.2|no|ottdrev=r23080}} Since OpenTTD r23080 you can use variable <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> to display different sprites in the GUI and on the map. Currently these cases are available:
{| |-
! getbits(extra_callback_info1, 0, 8) !! Meaning
|-
| 0x00 || Vehicle is drawn in a viewport, i.e. on the map.
|-
| 0x01..0x0F || reserved
|-
| 0x10 || Vehicle is drawn in the depot GUI. <ref>OpenTTD also uses this value with the purchase-list chain (cargotype FF) to determine the gridsize in ship and aircraft depots.</ref>
|-
| 0x11 || Vehicle is drawn in the vehicle details GUI. (This includes the refit GUI.)
|-
| 0x12 || Vehicle is drawn in the vehicle list.
|-
| 0x13..0x1F || reserved for other future GUIs.
|-
| 0x20 || Vehicle is drawn in the purchase list. (This includes the autoreplace GUI.)
|-
| 0x21 || Vehicle is drawn in the exclusive preview GUI or in the advertisement news.
|-
| 0x22..0x2F || reserved for other future GUIs with non-purchased vehicles.
|-
| 0x30..0xFF || reserved
|}
<references/>
The cases 0x20..0x2F are called using the <code style="color:darkgreen">purchase</code>-callback, the other cases are called for the <code style="color:darkgreen">default</code>- or cargo-specific callbacks. Exception is the the special depot-gridsize call, which uses the <code style="color:darkgreen">purchase</code>-callback.

===Composing vehicles from multiple sprites===
{{ottdp|1.7|no|ottdrev=r27668}} Since OpenTTD r27668 you can draw vehicles by drawing multiple sprites on top of each other.
* The sprites can use different recolouring.
* When using 32bpp sprites, the sprites can use the alpha channel to blend with the other sprites. In particular you can use this to alpha-blend company colours over other sprites.

To enable this, you need to set <code style="color:darkgreen">XXX_FLAG_SPRITE_STACK</code> in the <code style="color:darkgreen">misc_flags</code> property.

When enabled, sprites are resolved multiple times while incrementing an iteration number, that can be read via
<code style="color:darkgreen">getbits(extra_callback_info1, 8, 8)</code>

For OpenTTD 1.7 to 12.0, this is limited to at most 4 sprites per articulated part.

Increased to 8 sprites per articulated part for OpenTTD 13.0 {{ottdp|13.0|no}}

In addition you need to set register 100 as additional result:
* <code style="color:darkgreen">STORE_TEMP(CB_FLAG_MORE_SPRITES | recolouring, 0x100)</code> if there are more sprites to draw.
* <code style="color:darkgreen">STORE_TEMP(recolouring, 0x100)</code> if there are no more sprites to draw.
"recolouring" can be:
* <code>PALETTE_USE_DEFAULT</code> to use the default vehicle recolouring.
* <code>PALETTE_IDENTITY</code> to use no recolouring
* Any other default or custom recolouring sprite.

===Sound events===

{| class="wikitable sortable"
! Event
! Description
|-
| SOUND_EVENT_START
| Vehicle leaves station or depot, plane takes off
|-
| SOUND_EVENT_TUNNEL
| Vehicle enters tunnel
|-
| SOUND_EVENT_BREAKDOWN
| Vehicle breaks down (not for planes)
|-
| SOUND_EVENT_RUNNING
| Once per engine tick, but no more than once per vehicle motion
|-
| SOUND_EVENT_TOUCHDOWN
| Aircraft touches down
|-
| SOUND_EVENT_VISUAL_EFFECT
| Visual effect is generated (steam plume, diesel smoke, electric spark)
|-
| SOUND_EVENT_RUNNING_16
| Every 16 engine ticks if in motion
|-
| SOUND_EVENT_STOPPED
| Every 16 engine ticks if stopped
|-
| SOUND_EVENT_LOAD_UNLOAD
| Consist loads or unloads cargo
|}

== Vehicle IDs ==
Picking an item ID requires keeping two cases in mind: OpenTTD with the engine pool enabled and OpenTTD with engine pool disabled / TTDPatch. The status of the engine pool may be checked with the global variable [[NML:General#General_variables|dynamic_engines]].

Note that while vehicle ID affects the order in which vehicles appear in the purchase menu, this can be overridden using the [[NML:Sorting vehicles in the purchase list|sort block]].

=== Engine pool enabled ===
With the engine pool enabled, each NewGRF has its own ID range, NewGRFs don't influence each other. IDs may freely be chosen between 0 and 65535. If the chosen ID belongs to an existing vehicle, this vehicle is overridden by your vehicle. If another NewGRF is already overriding that vehicle, a new vehicle will be allocated, but all the properties will be copied from the old vehicle. If you define an ID for which no original vehicle exists, a new (blank) vehicle is allocated.

This behaviour can be modified using an [[NML:Overriding_vehicles_in_other_NewGRFs|engine_override]], this allows changing the properties of vehicles defined in other NewGRFs instead of allocating a new vehicle.

=== TTDPatch / Engine pool disabled ===
Each new vehicle has to replace an existing vehicle. If multiple NewGRFs try to replace the same vehicle, the last NewGRF loaded 'wins'. [[VehicleIDs|This page]] contains a list of valid vehicle IDs for each vehicle type, look in the 'NML ID' column. Note that IDs are not bound to a specific sort of vehicle (e.g. monorail wagons) but to a feature (e.g. trains, road vehicles).

In general, you should take the following steps:
* If your NewGRF is intended as a complete replacement for the default vehicles, disable the relevant default vehicles using [[NML:Disable_items|disable_item]].
* Re-use IDs of existing vehicles as much as possible.
* If your NewGRF uses IDs outside of the normal range (for example, because you there are more vehicles than slots available), let your code check if dynamic_engies is enabled. If not, skip the vehicles outside the normal range (using an if-statement) and make sure that the remaining vehicles allow for reasonable gameplay. It is recommended to issue a warning to the user about this. Alternatively, it is also possible to disable your entire NewGRF. If you don't do this check and dynamic_engines is off, OpenTTD may disable your NewGRF with the somewhat cryptic message 'Attempt to use invalid ID', which will likely lead to bug reports about your NewGRF and/or your OpenTTD.

Action0/Cargos

2026-07-05T19:13:55Z

Brickblock1: /* TextID for one unit of the type (0A) */

== Introduction ==

The [[ttwiki:NewCargos|NewCargos]] switch of TTDPatch allows modifying the existing 12 cargos per climate, and allows adding 20 new cargos per climate as well. These cargo slots are numbered from 0 to 31, where slots 0-11 are used by default TTD cargos and slots 12-31 contain uninitialized garbage by default (so you can't trust them having meaningful information, you must set all of their properties).

{{ottdp|1.9|no|ottdrev=11ab3c4e}} OpenTTD 1.9 increases the number of cargos to 64.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.5}}||Bit number for bitmasks
|-
|09||W||{{ottdp|0.6|2.5}}||TextID for the cargo type name
|-
|0A||W||{{ottdp|0.6|2.5}}||TextID for the name of one unit from the cargo type
|-
|0B||W||{{ottdp|0.6|2.5}}||TextID to be displayed for 1 unit of cargo
|-
|0C||W||{{ottdp|0.6|2.5}}||TextID to be displayed for multiple units of cargo
|-
|0D||W||{{ottdp|0.6|2.5}}||TextID for cargo type abbreviation
|-
|0E||W||{{ottdp|0.6|2.5}}||Sprite number for the icon of the cargo
|-
|0F||B||{{ottdp|0.6|2.5}}||Weight of one unit of the cargo
|-
|10,11||B||{{ottdp|0.6|2.5}}||Penalty times
|-
|12||D||{{ottdp|0.6|2.5}}||Base price
|-
|13||B||{{ottdp|0.6|2.5}}||Colour for the station list window
|-
|14||B||{{ottdp|0.6|2.5}}||Colour for the cargo payment list window
|-
|15||B||{{ottdp|0.6|2.5}}||Freight status (for freight-weight-multiplier setting); 0=not freight, 1=is freight
|-
|16||W||{{ottdp|0.6|2.5}}||Cargo classes
|-
|17||D||{{ottdp|0.6|2.5}}||Cargo label
|-
|18||B||{{ottdp|0.6|2.5|ttdprev=alpha 72}}||Substitute type for town growth
|-
|19||W||{{ottdp|no|2.5|ttdprev=alpha 72}}||Multiplier for town growth
|-
|1A||B||{{ottdp|0.6|2.5|ttdprev=alpha 72}}||Callback flags
|-
|1B||W||{{ottdp|1.1|no|ottdrev=r21224}}||TextID for displaying the units of a cargo
|-
|1C||W||{{ottdp|1.1|no|ottdrev=r21224}}||TextID for displaying the amount of cargo
|-
|1D||W||{{ottdp|1.2|no|ottdrev=r23860}}||Capacity mulitplier
|-
|1E||B||{{ottdp|14.0|no}}||Town Production effect
|-
|1F||W||{{ottdp|14.0|no}}||Town Production multiplier
|}

== Descriptions ==

=== Bit number for bitmasks (08) ===

This value must be used in [[Action3]] and in cargo bit mask properties such as refit masks. Values 1C-1F should be safe to use (if they aren't already taken, of course) if you intend to maintain compatibility with GRFs unaware of the newcargos switch. Further assuming that no active GRFs support the toyland climate, you can use values 11-1A as well.

Additionally, you can use the value FFh to disable the given cargo slot. This way, it won't appear in cargo type lists, but it won't be removed from things already on the map. If you disable a cargo, you'll probably want to zero out the cargo label (property 17) as well.

This property only affects GRFs which do not have a [[Action0/Global Settings#Cargo_translation_table_.2809.29 | cargo translation table]]. GRFs with such a table generally use the index of the cargo in the table instead of the value of this property to access a cargo. As such this property is more or less a default value for GRFs without cargo translation table. If you are unsure what value to assign to this property, set it to the same value as the cargo slot ID.

=== TextID for the cargo type name (09) ===

This textID should refer to the name of the cargo, capitalized, to match the TTD style (e.g. "Passengers", "Coal", "Gold Ore", "Milk")

You can reuse existing [[TextIDs]] or create custom strings using [[Action4]] with an offset in the DCxx range. Note that you need to set language-id bit 7 as well in the Action4 for a custom string. (Also applies to properties 0A to 0D)

=== TextID for one unit of the type (0A) ===

This textID should refer to the cargo type name in the singular. {{ottd|12.1}} Currently unused, This ID was used only in subsidy messages ("First Passenger service..." instead of "First Passengers service...", for example)

=== TextID for 1 unit of cargo (0B) ===

This textID will be used to display the amount of the cargo if there's exactly 1 unit waiting. Although there's only one unit waiting, you'll still have to use either the special character 7C (print signed word) or 87 (print amount in litres and add suffix " litres") so TTD removes the amount from its internal reference stack. For example, if you have a new cargo named "gold ore", this should be "\7C ton of gold ore", which will expand to "1 ton of gold ore". On the other hand, a liquid cargo named "milk" should be something like "\87 of milk", which will expand to either "100 litres of milk" or "1,000 litres of milk" (The multiplier for liquid cargos depends on miscmods.dontfixlitres. If it's on, the multiplier is 100, otherwise it's 1000)

=== TextID for multiple units of cargo (0C) ===

This textID will be used to display the amount of cargo if the amount waiting isn't exactly 1. You'll need the same special characters as above, but now they will be expanded according to the actual cargo waiting. Sticking to the example above, you'll need "\7C tons of gold ore" and "\87 of milk", which can expand to "42 tons of gold ore" and "42,000 litres of milk", accordingly. You will note that liquid cargos can have the same textID for both property 0B and 0C since they always use the plural form.

=== TextID for cargo type abbreviation (0D) ===

This textID will be used in the station list window to represent the cargo waiting. It should be a two-letter abbreviation prefixed by the special character 0E to switch to the microscopic font. The microscopic font has every letter capitalized, so capitalization isn't important here. Continuing the above example, gold ore could have this as "GO" and milk as "MK" ("ML" is already taken by mail).

=== Sprite number for icon (0E) ===

This is a sprite number of an old TTD sprite to be displayed in the station window for this cargo, or FFFFh if the icon should be found by following the action 3 associated with this cargo. The icon must not be bigger than 10x10 pixels. One icon will be shown for every 10 units of the cargo waiting, up to 23 icons, which is the maximum.

=== Weight of one unit of the cargo (0F) ===

This property defines the weight of 1 unit from the cargo, which will be used to calculate the weight of the vehicles when loaded. The unit is 1/16 ton (which is 62.5 kg). With the examples above, gold ore should have this as 16 (since 1 ton of gold ore should weigh exactly 1 ton), while milk should have this slightly above 16 (milk is denser than water).

=== Penalty times and price factor (10,11,12) ===

These three values define how much is paid for the delivery of the cargo type. The price factor is subject to inflation, but GRFs needn't care about this, the programme will adjust the price for them.

The income generated from cargo delivery is calculated as:

income=((((distance/2) * timefactor * amount_moved) >> 7) * cargopricefactor) >> 13

where

; a >> b : means a is arithmetically shifted right by b bits
; distance : is the Manhattan distance between the two station signs
; amount_moved : is the number of cargo units moved
; cargopricefactor : is the value you set in property 12. Inflation will be applied automatically on it.
; timefactor : is a multiplier in the range 0..255, calculated in the following way: (T1 is the value of property 10, T2 is the value of property 11, t is the time the delivery took, the unit is 185 game ticks (roughly 2.5 game days) )

if t<=T1 then timefactor=255
else if t<=(T1+T2) then timefactor=255-(t-T1)
else timefactor=255-(t-T1)-(t-T1-T2)
if the above rules result in a timefactor less than 31, 31 is used instead.

=== Color for the station list window (13) ===

This color index will be used to draw the rectangle representing the amount waiting from the current cargo type in the station list window. The index should be given for the DOS palette. OpenTTD and TTDPatch will automatically translate the index for the Windows palette, if they use the windows base graphics.

=== Color for the cargo payment list window (14) ===

The graph of the current cargo will be drawn using this color in the cargo payment rates graph. The index should be given for the DOS palette, the Windows version of TTDPatch will automatically translate the index for the Windows palette.

=== CargoClasses (16) ===

See [[Action0Trains#Cargo classes .2828.2C_29.29|train prop. 28/29]] for a description of the utility of this property.

The history of cargo classes is complex, and the meanings here may not be consistent with how classes are actually used by some grfs.

GRFs including FIRS, AXIS, ITI, Sunshine Trains and Iron Horse do not conform to the classes here, and use the FRAX Cargo Class Scheme, please see: https://grf.farm/polar-fox/frax_latest.html

This is a bit mask of all cargo classes to which this cargo could belong.
The following classes are available:

{| class="wikitable
|-
!bit
!value
!class name
!wagon type<ref name=vehicle>Suggestion for vehicle types which transport this cargo</ref>
!usage<ref name=refitusage>Suggestion how to best make use of this class in the refit masks of vehicles<br>OR to be included in the 'allowed classes' (train prop. 28), AND NOT in the 'disallowed classes' (train prop. 29)</ref>
!vehicle tips<ref name=vehicleuse>Suggestions this class should be used in the property which excludes a class of cargos from a vehicle. One specific type of cargo could appear both as liquid or as piece goods (e.g. milk), which depends on the actual representation. Thus excluding the other would disallow refit to that cargo.</ref>
!industry tips
|-
|0
|1
|Passengers
|passenger wagon
|OR
|never exclude
|do not combine with other flags
|-
|1
|2
|Mail
|closed or mail wagon
|OR
|never exclude
|do not combine with other flags
|-
|2
|4
|Express
|closed or mail wagon
|OR
|never exclude, suitable for airplane or maglev
|
|-
|3
|8
|Armored
|armored or mail wagon
|OR
|never exclude
|do not combine with other flags
|-
|4
|10
|Bulk (Uncountable)
|open or hopper wagon
|OR
|never exclude
|may be combined with Piece Goods or Liquid to simulate multiple modes of transport
|-
|5
|20
|Piece Goods (Countable)
|closed or open wagon
|OR
|never exclude
|may be combined with Bulk or Liquid to simulate multiple modes of transport
|-
|6
|40
|Liquid
|tank wagon
|OR
|never exclude
|may be combined with Piece Goods or Bulk to simulate multiple modes of transport
|-
|7
|80
|Refrigerated
|refrigerated wagon
|OR/AND NOT
|only exclude, when Piece Goods included
|also set Piece Goods
|-
|8
|100
|Hazardous
|unknown
|OR/AND NOT
|only exclude, when special wagons are provided.
|combine with Piece Goods, Liquid, Bulk or Express
|-
|9
|200
|Covered (weather protected)
|closed wagon, any other wagon with tarpaulin or weather cover
|OR/AND NOT
|do not exclude for Liquid
|combine with Piece Goods or Bulk
|-
|10
|400
|Oversized
|stake/flatbed wagon
|OR/AND NOT
|only exclude, when Piece Goods included
|combine with Piece Goods
|-
|11
|800
|Powderized (dry powdered materials that flow under air pressure)
|powder/silo vehicle equipped for compressed air unloading
|OR/AND NOT
|only exclude, when Bulk included
|combine with Bulk
|-
|12
|1000
|Non-pourable
|open wagon, but not hopper wagon
|AND NOT
|only exclude, when Bulk included
|combine with Bulk
|-
|13
|2000
|Potable
| exclude from non-food-grade vehicles
| AND NOT
| exclude
| set for all food-grade freight cargos
|-
|14
|4000
|Non-potable.
| exclude from food-grade vehicles
| AND NOT
| exclude
| set for all non-food-grade freight cargos
|-
|15
|8000
|special
|and not
|none
|special use
|do not set
|}

<references />

Only cargos which are in class 0 (passengers) will appear in bus stations. Only cargos which are ''not'' in class 0 will appear in truck stations.

Disclaimer: there is no guarantee that classes won't vary over time or between sets. The classes of a cargo may change between different versions of a specific industry/cargo newgrf, or different classes may be set for the same cargo label by different industry/cargo newgrfs. Feel free to use classes in your set for conveniently refitting to cargos, but if you - the vehicle author - care about specific cargos being transported in specific vehicles, use label based refits (changing labels without a very good reason is considered to be bad practice).

=== Cargo label (17) ===

Cargo labels are globally [[CargoTypes#Cargo Labels|unique identifiers]] for a cargo type. They are used to allow vehicle grfs to easily support many cargo types, whether they are active or not and no matter what slot or bit they are using.

Read about the [[Action0/Global Settings#Cargo translation table 09|cargo translation table]] for further info.

=== Substitute type and multiplier for town growth (18, 19) ===

These properties allow you to modify how a cargo type affects town growth. Property 18 can contain one of the following values:

{| |-
!Value!!Meaning!!{{ottdp|0.7|no}} Details<ref>This is the interpretation of OpenTTD. For TTDPatch see [http://www.tt-wiki.net/wiki/NewTownGrowthSwitches NewTownGrowthMechanism], which is quite different/unrelated.</ref>
|-
|00||Affect towns as passengers do||Cargo produced by houses is added to the statistics in the town GUI.
|-
|02||Affect towns as mail does||Cargo produced by houses is added to the statistics in the town GUI.
|-
|05||Affect towns as goods/candy does||See note about subsidies below.
|-
|09||Affect towns as water does||Second required cargo for towngrowth in the desert
|-
|0B||Affect towns as food/fizzy drinks do||First required cargo for towngrowth in desert/above snowline. Alse see note about subsidies below.
|-
|FF||Don't affect town growth (default)||
|}

<references />

{{ottdp|no|2.5|ttdprev=alpha 72}} The incoming cargo amount is multiplied by property 19, then divided by 256 before it is added to the town statistics. This allows you to have smaller or bigger impact than original cargoes do.

If no cargos in the game are defined as food (0B), towns above the snowline will not require food to grow. If no cargos in the game are defined as food (0B) or water (09), towns in desert will not require food or water to grow. This can be used positively for gameplay purposes, and is otherwise worth being aware of as an unintended side effect when designing cargos.

Please note that cargoes accepted by industries affect the closest town as well; for example, if you have an industry that accepts passengers, every passenger brought to the industry affects the town just like if they were transported to the town directly. Usually, it's not a good idea to have industries that process such cargoes; they should be accepted by towns only.

{{ottdp|0.6-1.1|no}} In OpenTTD up to 1.1 (not 1.2) property 18 also affects the creation of subsidies. Usually subsidies apply to cargo transportation between two industries. For cargos with substitution-type 05 or 0B the destination will be a town instead. Independent of property 18 subsidies from town to town are only created for cargo slot 0 (Passengers).

=== Callback flags (1A) ===

{| |-
!Bit!!Value!!Var. 0C!!Callback
|-
|0||1||39||Custom profit calculation
|-
|1||2||145||Custom station rating calculation
|}

=== TextID for displaying the units of a cargo (1B) ===

This textID is used by OpenTTD to show the "short cargo" form for cargo units, e.g. "10 litres" or "10 tonnes". This textID must be set after property 0B. The text this textID refers to should properly handle plurals, e.g. "\7B item\9A\15\80\9A\10\9A\11s\9A\12".

The default for this textID depends on the default for property 0B; if the default 0B string has "litre", then the default for this textID will be the unit for litres. OpenTTD maps the following textIDs so you don't need to provide translations:

{| |-
!textID!!String
|-
|004f||<num> passenger(s)
|-
|0050||<num> tonne(s)
|-
|0051||<num> bag(s)
|-
|0052||<num> litre(s)
|-
|0053||<num> item(s)
|-
|0054||<num> crate(s)
|}

The "tonne" and "litre" strings (textID 0050 and 0052) are automatically updated based on the user settings of unit display, e.g. they "tonne" might become "kg". The "(s)" is for display purposes; in reality that is a choice list.

=== TextID for displaying the amount of cargo (1C) ===

This textID is used by OpenTTD to show the "long cargo" form for cargo units, e.g. "10 litres of water" or "10 tonnes of coal". This textID must be set after property 0c. The text this textID refers to should properly handle plurals, e.g. "\7B item\9A\15\80\9A\10\9A\11s\9A\12 of livestock".

The default for this textID depends on the default for property 0C, but with support for plurals. For "X litre(s)" or "X tonne(s)" you should respectively use string codes 87 and 9A 0D.

=== Capacity multiplier (1D) ===

This defines the capacity (and indirectly loading speed) of vehicles carrying this cargo type, if the vehicle sets no specific capacity to this specific cargo type.

Set this property to the amount of cargo a vehicle shall carry, which can carry 0x100 (256) tons of coal or 0x100 (256) thousand litres of water (whatever comparison is more suitable for your cargotype). Depending on whether your cargo type is light or heavy you should set this property either comparing the weight or the volume.

The default value of this property is:
{| |-
! Cargo slot !! Default cargo in this slot !! Property 1D !! Meaning
|-
| 00 || PASS || 0x400 || A vehicle carrying 1 ton of coal, can carry 4 passengers.
|-
| 02 || MAIL || 0x200 || A vehicle carrying 1 ton of coal, can carry 2 bags of mail.
|-
| 05 || GOOD, SWET || 0x200 || A vehicle carrying 1 ton of coal, can carry 2 crates of goods/sweets.
|-
| xx || (everything else) || 0x100 || All other slots default to 0x100, i.e. 1 unit of cargo equals 1 ton of coal.
|}

=== Town Production effect (1E) ===

This properties allow you to directly modify how a town produces cargo. Property 1E can contain one of the following values:

{| |-
!Value!!Meaning
|-
|00||Towns produce cargo as passengers
|-
|02||Towns produce cargo as mail
|-
|FF||Towns don't produce cargo (default)
|}

=== Town Production multiplier (1F) ===

Set this property to the amount of cargo a town will produce, relative to the normal amount for that town production effect (passengers or mail.) The default value is 0x100 (256), use a lower value to produce less cargo, or a higher value to produce more cargo.

Properties 1E and 1F are an alternative to the cargo production callback of houses, and allow for cargo to be set up to be produced by towns without having to redefine any houses, although it is not as flexible.

== Example ==

NML:Cargos

2026-07-05T19:10:54Z

Brickblock1: /* Cargo properties */

{{NMLNavPropVarCB}}

==Cargo IDs==
For cargos, the item ID corresponds to the cargo type slot of the cargo. TTD default cargos occupy slots 0-11, so if you want to define a new cargo be sure to set this ID to 12 or higher. It is recommended to set the 'number'-property to the same value as the item ID.

==Cargo properties==

{| class="wikitable sortable"
! name
! value range
! comment
|-
| number
| 0..63
| Number of the cargo for bitmasks. Prior to {{ottd|1.9}} this was clamped to 0..31. This mostly affects old NewGRFs that don't have a cargo translation table.
|-
| type_name
| string
| String to use as cargo type name. Example: "Passengers". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_CARGO_PLURAL_XXX), which may be re-used.
|-
| unit_name
| string
| String to use for the name of one unit from the cargo type. Was used for subsidies only (First Passenger service to..). {{ottd|12.1}} Not used. Example string: "Passenger". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_CARGO_SINGULAR_XXX), which may be re-used.
|-
| units_of_cargo
| string
| String used to show the "short cargo" form for cargo units, e.g. "10 tonnes" or "20.000 litres". Example: "{COMMA} item{P "" s}". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_PASSENGERS and further), which may be re-used.
|-
| items_of_cargo
| string
| String used to show the "long cargo" form for cargo units, e.g. "10 tonnes of coal" or "20.000 litres of water". Example: "{COMMA} item{P "" s} of livestock". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_QUANTITY_XXX), which may be re-used.
|-
| type_abbreviation
| string
| String used for the two-letter cargo type abbreviation. Must start with a {TINYFONT} string-code. Example: "{TINYFONT}XX". Make sure to avoid multiple cargos having the same abbreviation. The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_ABBREV_XXX), which may be re-used.
|-
| sprite
| sprite
| TTD sprite number for the icon of the cargo. Alternatively, set to NEW_CARGO_SPRITE and use a graphics block to define a custom sprite.
|-
| weight
| float 0..255
| Weight of one unit of the cargo (in tons)
|-
| penalty_lowerbound
| 0..255
| Delivery time until penalty is applied. The units depend on the vehicle used (see vehicle property 'cargo_age_period'), by default 1 unit = 2.5 days.
|-
| single_penalty_length
| 0..255
| Length of the interval where a single penalty is applied
|-
| price_factor
| float
| Payment for delivering 10 units of cargo across a distance of 20 squares (in British Pounds), when delivering in less than 'penalty_lowerbound' time (no time penalty).
|-
| station_list_colour
| 0..255
|
Colour for the station list window (index from the [[NML:Graphic files|default (DOS) palette]])
|-
| cargo_payment_list_colour
| 0..255
|
Colour for the cargo payment list window (index from the [[NML:Graphic files|default (DOS) palette]])
|-
| is_freight
| 0 or 1
| Freight status (for the freighttrains switch); 0=not freight, 1=is freight
|-
| cargo_classes
|
bitmask([[#Cargo classes|cargo classes]])
| Cargo classes
|-
| cargo_label
| 4 letters
| [[CargoTypes|Cargo label]], as used in the [[NML:Cargotable|cargo table]]
|-
| town_growth_effect
| TOWNGROWTH_XXX
|
Effect for town growth, see [[#Cargo effects on town growth|Cargo effects on town growth]]
|-
| town_growth_multiplier
| float 0..255
| {{ottd|no}} Multiplier for town growth. To be used in conjuction with town_growth_effect, when that is not TOWNGROWTH_NONE. For example, a value of 4 makes your cargo have the same effect on town growth as 4 units of food/goods/etc.
|-
| callback_flags
| bitmask(flags)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| capacity_multiplier
| float 0 .. 255
| {{ottd|1.2|r22860}} This defines the capacity of vehicles carrying this cargo type, if the vehicle sets no specific capacity to this specific cargo type. Set this property to the amount of cargo a vehicle shall carry, which can carry 1 ton of coal or 1000 thousand litres of water (whatever comparison is more suitable for your cargotype). Depending on whether your cargo type is light or heavy you should set this property either comparing the weight or the volume. Default values are 4 for passengers, 2 for mail, goods and sweets and 1 for all other cargos.
|-
| town_production_effect
| TOWNPRODUCTION_XXX
| {{ottdp|14.0|no}} Effect for town production, see [[#Town production effect|Town production effect]]
|-
| town_production_multiplier
| float 0..255
| {{ottdp|14.0|no}} Multiplier for town production, to be used in conjunction with town_production_effect, when that is not TOWNPRODUCTION_NONE. For example, a value of 4 makes a town produce 4 times as much cargo as normal.
|}

Cargo payment is computed from <code style="color:darkgreen">price_factor</code>, amount of cargo transported, distance, and a time delivery factor. Unit of the delivery time is 185 ticks, roughly 2.5 days. The factor is constant (with value 255) if delivery time is less than <code style="color:darkgreen">penalty_lowerbound</code>. It goes down with rate 1 between <code style="color:darkgreen">penalty_lowerbound + single_penalty_length</code>, and goes down with rate 2 if the delivery time is even longer. Time delivery factor is never less than 31.

===Cargo classes===

Available cargo classes are listed in the following table. Cargos may be in more than one class. Cargo classes are always used as a bitmask, use the built-in function <code>bitmask()</code>. For example, <code style="color:darkgreen">bitmask(CC_EXPRESS, CC_REFRIGERATED)</code>.

The history of cargo classes is complex, and the meanings here may not be consistent with how classes are actually used by some grfs.

FIRS and Iron Horse do not conform to the classes here, and use the FRAX Cargo Class Scheme, please see: https://grf.farm/polar-fox/frax_latest.html

{| class="wikitable sortable"
! name
! type of cargo
|-
| CC_PASSENGERS
| passengers, also tourists (ECS)
|-
| CC_MAIL
| mail
|-
| CC_EXPRESS
| express goods, also tourists (ECS)
|-
| CC_ARMOURED
| valuables, diamonds, gold and alike
|-
| CC_BULK
| coal, ore, grain,...
|-
| CC_PIECE_GOODS
| containers, crates, livestock
|-
| CC_LIQUID
| oil, milk, water, ...
|-
| CC_REFRIGERATED
| food, milk, ...
|-
| CC_HAZARDOUS
| chemicals?, uranium, ...
|-
| CC_COVERED
| grain, cement, fruit, ...
|-
| CC_OVERSIZED
| vehicles, ...
|-
| CC_POWDERIZED
| cement, ...
|-
| CC_NON_POURABLE<br>CC_NEO_BULK
| sugar cane, wool or straw bales, ... (these are synonyms for cargos that are bulk, but can't be handled in e.g. hoppers)
|-
| CC_POTABLE
| exclude from non-food-grade vehicles
|-
| CC_NON_POTABLE
| exclude from food-grade vehicles
|-
| CC_SPECIAL
| Deprecated, do not set.
|-
| NO_CARGO_CLASS
| Special value that you can used to instead of 0.
|-
| ALL_NORMAL_CARGO_CLASSES
| Bitmask of all cargo classes except CC_SPECIAL. This is the same as <code style="color:darkgreen">bitmask(CC_PASSENGERS, CC_MAIL, ..., CC_NON_POTABLE)</code>. Note: This is already a bitmask, don't use the <code style="color:darkgreen">bitmask(..)</code> function with this.
|-
| ALL_CARGO_CLASSES
| Bitmask of all cargo classes. Same as <code style="color:darkgreen">ALL_NORMAL_CARGO_CLASSES | bitmask(CC_SPECIAL)</code> Note: This is already a bitmask, don't use the <code style="color:darkgreen">bitmask(..)</code> function with this.
|}

===Cargo effects on town growth===

{| class="wikitable sortable"
! value
! effect
|-
| TOWNGROWTH_PASSENGERS
| Affect towns as passengers do
|-
| TOWNGROWTH_MAIL
| Affect towns as mail does
|-
| TOWNGROWTH_GOODS
| Affect towns as goods/candy does
|-
| TOWNGROWTH_WATER
| Affect towns as water does (second required cargo for towngrowth in the desert)
|-
| TOWNGROWTH_FOOD
| Affect towns as food/fizzy drinks do (first required cargo for towngrowth in desert/above snowline)
|-
| TOWNGROWTH_NONE
| Don't affect town growth (default)
|}

If no cargos in the game are defined as TOWNGROWTH_FOOD, towns above the snowline will not require food to grow. If no cargos in the game are defined as TOWNGROWTH_FOOD or TOWNGROWTH_WATER, towns in desert will not require food or water to grow. This can be used positively for gameplay purposes, and is otherwise worth being aware of as an unintended side effect when designing cargos.

There are some additional effects of these flags on subsidies and town cargo transport statistics. See the nfo docs for details: https://newgrf-specs.tt-wiki.net/wiki/Action0/Cargos#Substitute_type_and_multiplier_for_town_growth_.2818.2C_19.29

===Town production effect===

{| class="wikitable sortable"
! value
! effect
|-
| TOWNPRODUCTION_PASSENGERS
| Town produces cargo as like passengers
|-
| TOWNPRODUCTION_MAIL
| Town produces cargo as like mail
|-
| TOWNPRODUCTION_NONE
| Town does not produce cargo (default)
|}

==Cargo variables==

Cargos have no variables (yet).

==Cargo callbacks==

{| class="wikitable sortable"
! callback
! return value
! comment
|-
| default
| Sprite set (with 1 sprite)
| Graphics for the cargo icon (only if property <code style="color:darkgreen">sprite</code> is set to NEW_CARGO_SPRITE)
|-
| station_rating
| -16384 .. 16383
| See detailed explanation below
|-
| profit
| -12748 .. 12748
| Called whenever cargo is delivered.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 16):</code> The manhattan distance the cargo was transported.
* <code style="color:darkgreen">getbits(extra_callback_info2, 16, 8):</code> The amount of cargo delivered.
* <code style="color:darkgreen">getbits(extra_callback_info2, 24, 8):</code> The time spent en-route (1 unit = 2.5 days).
The returned value is multiplied by the amount and the <code style="color:darkgreen">price_factor</code> to determine the income the player receives. Returning negative values is possible, it makes players pay for the delivery.
|}

===Station rating callback===

The station rating callback is quite complicated and deserves some detailed explanation. The default station rating calculation works as follows:

Internally, station rating is byte with values 0 .. 255, representing respectively 0% and 100%. Every 2.5 days, the transportation 'performance' is calculated using some factors outlined below. The station rating is then set to this performance value, with the caveat that the rating change cannot exceed 2 points. Therefore, rating changes are always slow, this callback cannot change this. The initial rating is 175 points (69%). The following factors are parts of the performance, their effects are summed.

====Time since the cargo was last picked up====

{| class="wikitable sortable"
! Time units (days)
! Score (%, rounded)
|-
| >21 (>52.5 days)
| 0 (0%)
|-
| 13 .. 21 (32.5 days .. 52.5 days)
| 25 (10%)
|-
| 7 .. 12 (17.5 days .. 32.5 days)
| 50 (20%)
|-
| 4 .. 6 (10 days .. 17.5 days)
| 95 (37%)
|-
| 0..3 (0 days..10 days)
| 130 (51%)
|}

The time unit used equals 185 engine ticks, or 2.5 TTD days. For ships, the time units are divided by 4 before calculating this component, so ships have four times more time before the ratings start dropping.

====Amount of cargo waiting====

{| class="wikitable sortable"
! Amount of cargo
! Score (%, rounded)
|-
| >1500
| -90 (-35%)
|-
| 1001..1500
| -35 (-14%)
|-
| 601..1000
| 0 (0%)
|-
| 301..600
| 10 (4%)
|-
| 101..300
| 30 (12%)
|-
| 0..100
| 40 (16%)
|}

====Max. speed of the last vehicle picking up the cargo====

This calculation is somewhat complicated. The maximum speed of the vehicle is expressed in "speed units". For trains and road vehicles, the speed unit is 1 km/h; for ships, it's 0.5 km/h; for aircraft, it's 8 mph. If the max. speed is above 255 speed units, 255 is used instead. If the vehicle is slower than 85 units, no points are awarded; otherwise, you get (speed_units-85)/4 points. Therefore, the maximum you can get is 42 points, or 16%.

====Age of the last carrier picking up the cargo====

{| class="wikitable sortable"
! Age of vehicle (years)
! Score (%, rounded)
|-
| 2
| 10 (4%)
|-
| 1
| 20 (8%)
|-
| 0
| 33 (13%)
|}

In TTDPatch this changes when the 'newagerating' switch is enabled

====Bonus for AI companies (TTDPatch only)====

{| class="t"
! AI intelligence setting
! Score (%, rounded)
|-
| Low
| 0 (0%)
|-
| Medium
| 31 (12%)
|-
| High
| 63 (25%)
|}

====Bonus for statue in nearest town====

If your company has erected a statue in the nearest town, you get 26 points (10%) bonus to all cargo ratings.

====Callback parameters====

<ul><li>
<code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>:
{| |-
!value!!meaning
|-
|0x10||the last vehicle entering the station was a train
|-
|0x11||the last vehicle entering the station was a road vehicle
|-
|0x12||the last vehicle entering the station was a ship
|-
|0x13||the last vehicle entering the station was an aircraft
|-
|0||no vehicle entered the station yet, or (TTDPatch) the last one entering was sold
|}
Please note that there's only one "last vehicle type" field per station, so the vehicle this refers to may not have picked up any of your cargo.
</li><li>
<code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The time since the cargo was last picked up, in the time units described above (1 unit = 2.5 days independent of vehicle type)
</li><li>
<code style="color:darkgreen">getbits(extra_callback_info2, 8, 16)</code>: The amount of cargo waiting.
</li><li>
<code style="color:darkgreen">getbits(extra_callback_info2, 24, 8)</code>: The speed of the last vehicle picking the cargo up, in the speed units described above (if no vehicle entered the station yet, the value is 0xFF).
</li></ul>

====Effect of callback====

The return value of the callback replaces the first three components (time since pickup, amount of cargo, max speed) of the calculation. The bonus for statues, TTDPatch AIs and new vehicles is always in effect, you cannot (yet) change this.

Action0/Badges

2026-01-14T14:26:34Z

Brickblock1: /* Properties */

''''''Action 0 properties for badges''''''

= Action 0 - Properties for badges =

Defining properties of badges.

== Properties ==

{| class="wikitable"
|-
!'''Number'''
!'''[[GRFActionsDetailed|Size]]'''
!'''Version'''
!'''Description'''
|-
|08
|S
|{{ottdp|15}}
|Badge label. A zero-terminated string.
|-
|09
|D
|{{ottdp|15}}
|Flags.
|}

<references />

== Badge label (08) ==

These are globally unique strings.

Badge labels comprise a badge class, for grouping similar badges, and badge name, separated by a '/'.

Classes and names are arbitrary, but to be useful must follow a standard scheme. For instance, the badge label power/steam will define a badge for steam powered vehicles within the power class.

Proposed initial classes are:

* flag
* role
* manufacturer
* operator
* power
* livery

It is also possible to assign a badge to everything within a NewGRF by defining the badge label `newgrf/<GRFID>`, with the GRFID in full hexadecimal form. This will work even if the badge is defined outside of the NewGRF it is for.

=== Naming Proposal ===

To work consistently, a naming standard needs to be agreed on, e.g.:

/role/passenger
/role/freight

/livery/<country>/<operator>/<name>
/livery/uk/british_rail/blue
/livery/uk/british_rail/swallow
/livery/fr/sncf/tgv

The game could then present these as a filterable list, e.g.:

Role
Passenger
Freight

Livery
UK
British Rail - Blue
British Rail - Swallow
France
SNCF - TGV

== Flags (09) ==

{| class="wikitable"
|-
!'''Bit'''
!'''Value'''
!'''Meaning'''
|-
|0
|1
|Copy. Badge can be copied to related entity (e.g. badge on a railtype can be copied to rail vehicles of that railtype.)
|-
|1
|2
|NameListStop. Stops adding more names to the visible name list.
|-
|2
|4
|NameListFirstOnly. Add this name to the visible name list only if this is the first name.
|-
|3
|8
|UseCompanyColour. Apply appropriate company colour palette to the icon. If the icon is applied to a vehicle with 2CC support, then the 2CC palette will be used.
|-
|4
|16
|NameListSkip. Allow the badge to be excluded from the badge name list.
|}

Action0/Badges

2026-01-14T14:25:58Z

Brickblock1: /* Properties */

''''''Action 0 properties for badges''''''

= Action 0 - Properties for badges =

Defining properties of badges.

== Properties ==

{| class="wikitable"
|-
!'''Number'''
!'''Version'''
!'''[[GRFActionsDetailed|Size]]'''
!'''Description'''
|-
|08
|{{ottdp|15}}
|S
|Badge label. A zero-terminated string.
|-
|09
|{{ottdp|15}}
|D
|Flags.
|}

<references />

== Badge label (08) ==

These are globally unique strings.

Badge labels comprise a badge class, for grouping similar badges, and badge name, separated by a '/'.

Classes and names are arbitrary, but to be useful must follow a standard scheme. For instance, the badge label power/steam will define a badge for steam powered vehicles within the power class.

Proposed initial classes are:

* flag
* role
* manufacturer
* operator
* power
* livery

It is also possible to assign a badge to everything within a NewGRF by defining the badge label `newgrf/<GRFID>`, with the GRFID in full hexadecimal form. This will work even if the badge is defined outside of the NewGRF it is for.

=== Naming Proposal ===

To work consistently, a naming standard needs to be agreed on, e.g.:

/role/passenger
/role/freight

/livery/<country>/<operator>/<name>
/livery/uk/british_rail/blue
/livery/uk/british_rail/swallow
/livery/fr/sncf/tgv

The game could then present these as a filterable list, e.g.:

Role
Passenger
Freight

Livery
UK
British Rail - Blue
British Rail - Swallow
France
SNCF - TGV

== Flags (09) ==

{| class="wikitable"
|-
!'''Bit'''
!'''Value'''
!'''Meaning'''
|-
|0
|1
|Copy. Badge can be copied to related entity (e.g. badge on a railtype can be copied to rail vehicles of that railtype.)
|-
|1
|2
|NameListStop. Stops adding more names to the visible name list.
|-
|2
|4
|NameListFirstOnly. Add this name to the visible name list only if this is the first name.
|-
|3
|8
|UseCompanyColour. Apply appropriate company colour palette to the icon. If the icon is applied to a vehicle with 2CC support, then the 2CC palette will be used.
|-
|4
|16
|NameListSkip. Allow the badge to be excluded from the badge name list.
|}

NML:Properties and variables and callbacks

2026-01-06T14:23:53Z

Brickblock1:

{{NMLNavPropVarCB}}

Select a topic from the table below or use the navigation pane at the right.

{|
|[[NML:General|General]] || || [[NML:General#General variables|variables]] ||
|-
|[[NML:Vehicles|Vehicles]] || [[NML:Vehicles#Properties common to all vehicle types|common properties]] || [[NML:Vehicles#Vehicle variables|variables]] || [[NML:Vehicles#Vehicle callbacks|callbacks]]
|-
| || [[NML:Vehicles#Train properties|train properties]] || ||
|-
| || [[NML:Vehicles#Road vehicle properties|road vehicle properties]] || ||
|-
| || [[NML:Vehicles#Ship properties|ship properties]] || ||
|-
| || [[NML:Vehicles#Plane properties|aircraft properties]] || ||
|-
|[[NML:Stations|Stations]] || [[NML:Stations#Station properties|properties]] || [[NML:Stations#Station variables|variables]] || [[NML:Stations#Station callbacks|callbacks]]
|-
|[[NML:Canals|Canals]] || [[NML:Canals#Canal properties|properties]] || [[NML:Canals#Canal variables|variables]] || [[NML:Canals#Canal callbacks|callbacks]]
|-
|[[NML:Bridges|Bridges]] || [[NML:Bridges#Bridge properties|properties]] || [[NML:Bridges#Bridge variables|variables]] || [[NML:Bridges#Bridge callbacks|callbacks]]
|-
|[[NML:Towns|Towns]] || || [[NML:Towns#Town variables|variables]] ||
|-
|[[NML:Houses|Houses]] || [[NML:Houses#House properties|properties]] || [[NML:Houses#House variables|variables]] || [[NML:Houses#House callbacks|callbacks]]
|-
|[[NML:Industries|Industries]]|| || [[NML:Industries#Common variables|common variables]] ||
|-
| || [[NML:Industries#Industry properties|industry properties]] || [[NML:Industries#Industry variables|industry variables]] || [[NML:Industries#Industry callbacks|industry callbacks]]
|-
| || [[NML:IndustryTiles#Industry tile properties|tile properties]] || [[NML:IndustryTiles#Industry tile variables|tile variables]] || [[NML:IndustryTiles#Industry tile callbacks|tile callbacks]]
|-
|[[NML:Cargos|Cargos]] || [[NML:Cargos#Cargo properties|properties]] || [[NML:Cargos#Cargo variables|variables]] || [[NML:Cargos#Cargo callbacks|callbacks]]
|-
|[[NML:Airports|Airports]] || [[NML:Airports#Airport properties|properties]] || [[NML:Airports#Airport variables|variables]] || [[NML:Airports#Airport callbacks|callbacks]]
|-
| || [[NML:Airports#Airport tile properties|tile properties]] || [[NML:Airports#Airport tile variables|tile variables]] || [[NML:Airports#Airport tile callbacks|tile callbacks]]
|-
|[[NML:Objects|Objects]] || [[NML:Objects#Object properties|properties]] || [[NML:Objects#Object variables|variables]] || [[NML:Objects#Object callbacks|callbacks]]
|-
|[[NML:Railtypes|Railtypes]] || [[NML:Railtypes#Railtype properties|properties]] || [[NML:Railtypes#Railtype variables|variables]] || [[NML:Railtypes#Railtype callbacks|callbacks]]
|-
|[[NML:Roadtypes|Roadtypes]] || [[NML:Roadtypes#Roadtype properties|properties]] || [[NML:Roadtypes#Roadtype variables|variables]] || [[NML:Roadtypes#Roadtype callbacks|callbacks]]
|-
|[[NML:Tramtypes|Tramtypes]] || [[NML:Tramtypes#Tramtype properties|properties]] || [[NML:Tramtypes#Tramtype variables|variables]] || [[NML:Tramtypes#Tramtype callbacks|callbacks]]
|-
|[[NML:Bridges|Bridges]] || [[NML:Bridges#Bridge properties|properties]] || [[NML:Bridges#Bridge variables|variables]] || [[NML:Bridges#Bridge callbacks|callbacks]]
|-
|[[NML:Badges|Badges]] || [[NML:Badges#Badge properties|properties]] || [[NML:Badges#Badge variables|variables]] || [[NML:Badges#Badge callbacks|callbacks]]
|-
|Signals|| || ||
|}

NML:Properties and variables and callbacks

2026-01-06T14:23:30Z

Brickblock1:

{{NMLNavPropVarCB}}

Select a topic from the table below or use the navigation pane at the right.

{|
|[[NML:General|General]] || || [[NML:General#General variables|variables]] ||
|-
|[[NML:Vehicles|Vehicles]] || [[NML:Vehicles#Properties common to all vehicle types|common properties]] || [[NML:Vehicles#Vehicle variables|variables]] || [[NML:Vehicles#Vehicle callbacks|callbacks]]
|-
| || [[NML:Vehicles#Train properties|train properties]] || ||
|-
| || [[NML:Vehicles#Road vehicle properties|road vehicle properties]] || ||
|-
| || [[NML:Vehicles#Ship properties|ship properties]] || ||
|-
| || [[NML:Vehicles#Plane properties|aircraft properties]] || ||
|-
|[[NML:Stations|Stations]] || [[NML:Stations#Station properties|properties]] || [[NML:Stations#Station variables|variables]] || [[NML:Stations#Station callbacks|callbacks]]
|-
|[[NML:Canals|Canals]] || [[NML:Canals#Canal properties|properties]] || [[NML:Canals#Canal variables|variables]] || [[NML:Canals#Canal callbacks|callbacks]]
|-
|[[NML:Bridges|Bridges]] || [[NML:Bridges#Bridge properties|properties]] || [[NML:Bridges#Bridge variables|variables]] || [[NML:Bridges#Bridge callbacks|callbacks]]
|-
|[[NML:Towns|Towns]] || || [[NML:Towns#Town variables|variables]] ||
|-
|[[NML:Houses|Houses]] || [[NML:Houses#House properties|properties]] || [[NML:Houses#House variables|variables]] || [[NML:Houses#House callbacks|callbacks]]
|-
|[[NML:Industries|Industries]]|| || [[NML:Industries#Common variables|common variables]] ||
|-
| || [[NML:Industries#Industry properties|industry properties]] || [[NML:Industries#Industry variables|industry variables]] || [[NML:Industries#Industry callbacks|industry callbacks]]
|-
| || [[NML:IndustryTiles#Industry tile properties|tile properties]] || [[NML:IndustryTiles#Industry tile variables|tile variables]] || [[NML:IndustryTiles#Industry tile callbacks|tile callbacks]]
|-
|[[NML:Cargos|Cargos]] || [[NML:Cargos#Cargo properties|properties]] || [[NML:Cargos#Cargo variables|variables]] || [[NML:Cargos#Cargo callbacks|callbacks]]
|-
|[[NML:Airports|Airports]] || [[NML:Airports#Airport properties|properties]] || [[NML:Airports#Airport variables|variables]] || [[NML:Airports#Airport callbacks|callbacks]]
|-
| || [[NML:Airports#Airport tile properties|tile properties]] || [[NML:Airports#Airport tile variables|tile variables]] || [[NML:Airports#Airport tile callbacks|tile callbacks]]
|-
|[[NML:Objects|Objects]] || [[NML:Objects#Object properties|properties]] || [[NML:Objects#Object variables|variables]] || [[NML:Objects#Object callbacks|callbacks]]
|-
|[[NML:Railtypes|Railtypes]] || [[NML:Railtypes#Railtype properties|properties]] || [[NML:Railtypes#Railtype variables|variables]] || [[NML:Railtypes#Railtype callbacks|callbacks]]
|-
|[[NML:Roadtypes|Roadtypes]] || [[NML:Roadtypes#Roadtype properties|properties]] || [[NML:Roadtypes#Roadtype variables|variables]] || [[NML:Roadtypes#Roadtype callbacks|callbacks]]
|-
|[[NML:Tramtypes|Tramtypes]] || [[NML:Tramtypes#Tramtype properties|properties]] || [[NML:Tramtypes#Tramtype variables|variables]] || [[NML:Tramtypes#Tramtype callbacks|callbacks]]
|-
|[[NML:Bridges|Bridges]] || [[NML:Bridges#Bridge properties|properties]] || [[NML:Bridges#Bridge variables|variables]] || [[NML:Bridges#Bridge callbacks|callbacks]] || FEAT_BRIDGES
|-
|[[NML:Badges|Badges]] || [[NML:Badges#Badge properties|properties]] || [[NML:Badges#Badge variables|variables]] || [[NML:Badges#Badge callbacks|callbacks]] || FEAT_BADGES
|-
|Signals|| || || || FEAT_SIGNALS
|}

Guide to railtypes

2025-12-07T15:48:54Z

Brickblock1: Correct property name

Trains and Railtypes both affect where a train can run and not, on top of this trains also need the correct railtypes to be defined in order to show up. This means that train and railtype sets need to coordinate so that the expected behavior can be reached.

This guide is writen for nml but it should be possible to follow if you subsititute the nml properties with the NFO ones, see below:

WIP

==The railtypetable==
The railtypetable maps the track type specified in the property track_type to a railtype label. NML will only use the RAIL, MONO and MGLV labels if no railtypetable is provided.

For more info see [https://www.tt-wiki.net/wiki/NMLTutorial/Railtypetable NMLTutorial/Railtypetable] and [[NML:Railtypetable-Roadtypetable-Tramtypetable]]

==Railtype properties==
The following properties are relevant for how vehicles and railtypes interact with each other:
{| class="wikitable sortable"
! property
! comment
|-
| label
| names of default rail types: "RAIL", "ELRL", "MONO", "MGLV". See the [[RailtypeLabels|List of railtype labels]] in the NewGRF Specs for currently defined custom labels.
|-
| compatible_railtype_list
| Provide a list of rail types that trains of this type can also run on. e.g. ["RAIL", "ELRL", "MONO"]. Note that when routing trains, the compatibility is only evaluated for the lead engine of a consist. This means that trains will run on incompatible rail types if they are in a consist where the lead engine is compatible with the rail type. This applies to both engines and wagons.
|-
| powered_railtype_list
| Provide a list of rail types that trains of this type are powered on.
|-
| alternative_railtype_list
|
{{ottd|1.2|r23758}} List of rail types which this rail type will act as fallback for, if the corresponding rail type is not defined separately
|}

==Trains with only one track type==

item (FEAT_TRAINS, train) {
properties {
track_type: REF_TO_RAILTYPE_TABLE;
}
}

By default OpenTTD will always make sure the railtypes RAIL, ELRL, MONO and MGLV exist, as such you are free to use these as you see fit.

===Tracks not provided by default===
You may very well want more types of tracks that those provided by OpenTTD for this you will need to use a trackset. They define more tracks with their own labels. We can't possibly know which tracks to use and which tracks exist. To solve this the [[Standardized Railtype Scheme]] was created, it defines generic interpertaions of certain labels so that trainsets and tracksets can trust that things will work as expected. You don't have to use the standard but it is highly recommended as it will allow your set to work with almost all tracksets, else you might have to make your own. There are also a few labels not in the standard which can be found at [[TracktypeLabels]].

A given may not exist at all times however which will mean your train won't show up in game. To solve this you can use the fallback syntax in the trailtype table which is as follows:
railtypetable {
RAILTYPE: [SAAN, RAIL]
}
This is quite powerful, but it does not affect compatibility for that you should instead read the section below about multiple track types on one train. You should also consider if you want and need the track type to have fallbacks, narrow gauge vehicles probably don't need to show up on standard gauge tracks for example.

==Trains with multiple track types==
Some trains of yours might need to have multiple railtypes in order to work. Examples of this include UK thameslink trains and the russian EP10.

For this we need the following railtypetable which uses labels from the standardized railtype scheme.
railtypetable {
DC_3KV: [SAAD, SAAE, ELRL],
AC_25KV: [SAAA, SAAE, ELRL],
DC_3RD: [SAA3, "3RDR"]
}
Thameslink train
item (FEAT_TRAINS, train2) {
properties {
track_type: [AC_25, DC_3RD];
}
}
EP10 train
item (FEAT_TRAINS, train3) {
properties {
track_type: [AC_25, DC_3KV];
}
}
The thameslink train will work without issue in this example however the EP10 will not. This is because if a trackset provides tracks for 25 kv ac (SAAA) and 15 kv ac. In that case the DC_3KV track type would become SAAE which is allowed on 15 kv ac tracks, this isn't intended as we only want the train to use SAAE when both SAAD and SAAA don't exist. This could be eliviated by not including SAAE and ELRL in the track type definition, but then the train will not show up on the default tracks. Another solution is to use [[NML:If|if]] blocks to change the used track type. In the future it may be possible that nmlc is extended to allow testing for both SAAA and SAAD in the railtypetable before falling back, until then the below provided solution will have to be used.

<pre style="color:blue">
railtypetable {
DC_3KV: [SAAD],
AC_25KV: [SAAA],
ACDC: [SAAE, ELRL]
}

if (railtype_available("SAAA") || railtype_available("SAAD")) {
item (FEAT_TRAINS, train3) {
properties {
track_type: [AC_25, DC_3KV];
}
}
} else {
item (FEAT_TRAINS, train3) {
properties {
track_type: ACDC;
}
}
}
</pre>

==Changing speed and/or power of trains based on railtype==
One might be interested in implementing a train which speed and/or power depends on the voltage in the overhead line electrification. In order for this to work properly the newgrf needs to test the track with [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. In practice this will look like the following:

tile_powers_railtype("ELRL")

Below is a more complex example from RUKTS code, where a train with a diesel generator has higher speed on high voltage ac tracks. We need to test for only SAAA if it is avaliable, as otherwise we would have the train gain the benefits on all electrified tracks. If it however isn't avaliable we still want to know if the track is electrified which is why we have the second part. This is only neccesary if your set cares about voltages.

railtype_available("SAAA") ? tile_powers_railtype("SAAA") : (tile_powers_railtype("SAAE") || tile_powers_railtype("ELRL"))

==Rack rail==
There are two different types of rack rail engines, pure rack and rack and adhesion. Pure rack engines may only move on tracks fitted with racks (xRxx) whilst rack and adhesion engines may also move on regular tracks but at a lower tractive effort.

Rack rail is currently implemented in the speed class as a "special type", this is unfurtunate as the speed class would otherwise be trackset private.

===Alternative 1===

====Pure rack engines====
These engines should use *R** as label. A trackset could then prevent these trains from traversing *A** tracks.

====Rack and adhesion engines====
These engines should use *A** as label and test for *R** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. This assumes the trackset will allow *A** on *R**.

====Issues====
*Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.
*French Narrow Gauge Trains Set uses NRAN for rack and adhesion engines so tracksets can not support it as intended and pure rack systems at the same time.

===Alternative 2===

====Pure rack engines====
These engines should use *r** (not in scheme) as label. A trackset would then prevent these trains from traversing *A** tracks but allow them on *R**.

====Rack and adhesion engines====
These engines should use *R** as label and test for *r** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. Tracksets will allow *R** on *A** and *r**.

====Issues====
*Requires more track types than alternative 1.

Guide to railtypes

2025-12-06T19:46:46Z

Brickblock1: /* Tracks not provided by default */

Trains and Railtypes both affect where a train can run and not, on top of this trains also need the correct railtypes to be defined in order to show up. This means that train and railtype sets need to coordinate so that the expected behavior can be reached.

This guide is writen for nml but it should be possible to follow if you subsititute the nml properties with the NFO ones, see below:

WIP

==The railtypetable==
The railtypetable maps the tracktype specified in the property tracktype to a railtype label. NML will only use the RAIL, MONO and MGLV labels if no railtypetable is provided.

For more info see [https://www.tt-wiki.net/wiki/NMLTutorial/Railtypetable NMLTutorial/Railtypetable] and [[NML:Railtypetable-Roadtypetable-Tramtypetable]]

==Railtype properties==
The following properties are relevant for how vehicles and railtypes interact with each other:
{| class="wikitable sortable"
! property
! comment
|-
| label
| names of default rail types: "RAIL", "ELRL", "MONO", "MGLV". See the [[RailtypeLabels|List of railtype labels]] in the NewGRF Specs for currently defined custom labels.
|-
| compatible_railtype_list
| Provide a list of rail types that trains of this type can also run on. e.g. ["RAIL", "ELRL", "MONO"]. Note that when routing trains, the compatibility is only evaluated for the lead engine of a consist. This means that trains will run on incompatible rail types if they are in a consist where the lead engine is compatible with the rail type. This applies to both engines and wagons.
|-
| powered_railtype_list
| Provide a list of rail types that trains of this type are powered on.
|-
| alternative_railtype_list
|
{{ottd|1.2|r23758}} List of rail types which this rail type will act as fallback for, if the corresponding rail type is not defined separately
|}

==Trains with only one tracktype==

item (FEAT_TRAINS, train) {
properties {
tracktype: REF_TO_RAILTYPE_TABLE;
}
}

By default OpenTTD will always make sure the railtypes RAIL, ELRL, MONO and MGLV exist, as such you are free to use these as you see fit.

===Tracks not provided by default===
You may very well want more types of tracks that those provided by OpenTTD for this you will need to use a trackset. They define more tracks with their own labels. We can't possibly know which tracks to use and which tracks exist. To solve this the [[Standardized Railtype Scheme]] was created, it defines generic interpertaions of certain labels so that trainsets and tracksets can trust that things will work as expected. You don't have to use the standard but it is highly recommended as it will allow your set to work with almost all tracksets, else you might have to make your own. There are also a few labels not in the standard which can be found at [[TracktypeLabels]].

A given may not exist at all times however which will mean your train won't show up in game. To solve this you can use the fallback syntax in the trailtype table which is as follows:
railtypetable {
RAILTYPE: [SAAN, RAIL]
}
This is quite powerful, but it does not affect compatibility for that you should instead read the section below about multiple tracktypes on one train. You should also consider if you want and need the tracktype to have fallbacks, narrow gauge vehicles probably don't need to show up on standard gauge tracks for example.

==Trains with multiple tracktypes==
Some trains of yours might need to have multiple railtypes in order to work. Examples of this include UK thameslink trains and the russian EP10.

For this we need the following railtypetable which uses labels from the standardized railtype scheme.
railtypetable {
DC_3KV: [SAAD, SAAE, ELRL],
AC_25KV: [SAAA, SAAE, ELRL],
DC_3RD: [SAA3, "3RDR"]
}
Thameslink train
item (FEAT_TRAINS, train2) {
properties {
tracktype: [AC_25, DC_3RD];
}
}
EP10 train
item (FEAT_TRAINS, train3) {
properties {
tracktype: [AC_25, DC_3KV];
}
}
The thameslink train will work without issue in this example however the EP10 will not. This is because if a trackset provides tracks for 25 kv ac (SAAA) and 15 kv ac. In that case the DC_3KV tracktype would become SAAE which is allowed on 15 kv ac tracks, this isn't intended as we only want the train to use SAAE when both SAAD and SAAA don't exist. This could be eliviated by not including SAAE and ELRL in the tracktype definition, but then the train will not show up on the default tracks. Another solution is to use [[NML:If|if]] blocks to change the used tracktype. In the future it may be possible that nmlc is extended to allow testing for both SAAA and SAAD in the railtypetable before falling back, until then the below provided solution will have to be used.

<pre style="color:blue">
railtypetable {
DC_3KV: [SAAD],
AC_25KV: [SAAA],
ACDC: [SAAE, ELRL]
}

if (railtype_available("SAAA") || railtype_available("SAAD")) {
item (FEAT_TRAINS, train3) {
properties {
tracktype: [AC_25, DC_3KV];
}
}
} else {
item (FEAT_TRAINS, train3) {
properties {
tracktype: ACDC;
}
}
}
</pre>

==Changing speed and/or power of trains based on railtype==
One might be interested in implementing a train which speed and/or power depends on the voltage in the overhead line electrification. In order for this to work properly the newgrf needs to test the track with [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. In practice this will look like the following:

tile_powers_railtype("ELRL")

Below is a more complex example from RUKTS code, where a train with a diesel generator has higher speed on high voltage ac tracks. We need to test for only SAAA if it is avaliable, as otherwise we would have the train gain the benefits on all electrified tracks. If it however isn't avaliable we still want to know if the track is electrified which is why we have the second part. This is only neccesary if your set cares about voltages.

railtype_available("SAAA") ? tile_powers_railtype("SAAA") : (tile_powers_railtype("SAAE") || tile_powers_railtype("ELRL"))

==Rack rail==
There are two different types of rack rail engines, pure rack and rack and adhesion. Pure rack engines may only move on tracks fitted with racks (xRxx) whilst rack and adhesion engines may also move on regular tracks but at a lower tractive effort.

Rack rail is currently implemented in the speed class as a "special type", this is unfurtunate as the speed class would otherwise be trackset private.

===Alternative 1===

====Pure rack engines====
These engines should use *R** as label. A trackset could then prevent these trains from traversing *A** tracks.

====Rack and adhesion engines====
These engines should use *A** as label and test for *R** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. This assumes the trackset will allow *A** on *R**.

====Issues====
*Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.
*French Narrow Gauge Trains Set uses NRAN for rack and adhesion engines so tracksets can not support it as intended and pure rack systems at the same time.

===Alternative 2===

====Pure rack engines====
These engines should use *r** (not in scheme) as label. A trackset would then prevent these trains from traversing *A** tracks but allow them on *R**.

====Rack and adhesion engines====
These engines should use *R** as label and test for *r** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. Tracksets will allow *R** on *A** and *r**.

====Issues====
*Requires more track types than alternative 1.

Guide to railtypes

2025-12-06T19:18:51Z

Brickblock1: /* The railtypetable */

Trains and Railtypes both affect where a train can run and not, on top of this trains also need the correct railtypes to be defined in order to show up. This means that train and railtype sets need to coordinate so that the expected behavior can be reached.

This guide is writen for nml but it should be possible to follow if you subsititute the nml properties with the NFO ones, see below:

WIP

==The railtypetable==
The railtypetable maps the tracktype specified in the property tracktype to a railtype label. NML will only use the RAIL, MONO and MGLV labels if no railtypetable is provided.

For more info see [https://www.tt-wiki.net/wiki/NMLTutorial/Railtypetable NMLTutorial/Railtypetable] and [[NML:Railtypetable-Roadtypetable-Tramtypetable]]

==Railtype properties==
The following properties are relevant for how vehicles and railtypes interact with each other:
{| class="wikitable sortable"
! property
! comment
|-
| label
| names of default rail types: "RAIL", "ELRL", "MONO", "MGLV". See the [[RailtypeLabels|List of railtype labels]] in the NewGRF Specs for currently defined custom labels.
|-
| compatible_railtype_list
| Provide a list of rail types that trains of this type can also run on. e.g. ["RAIL", "ELRL", "MONO"]. Note that when routing trains, the compatibility is only evaluated for the lead engine of a consist. This means that trains will run on incompatible rail types if they are in a consist where the lead engine is compatible with the rail type. This applies to both engines and wagons.
|-
| powered_railtype_list
| Provide a list of rail types that trains of this type are powered on.
|-
| alternative_railtype_list
|
{{ottd|1.2|r23758}} List of rail types which this rail type will act as fallback for, if the corresponding rail type is not defined separately
|}

==Trains with only one tracktype==

item (FEAT_TRAINS, train) {
properties {
tracktype: REF_TO_RAILTYPE_TABLE;
}
}

By default OpenTTD will always make sure the railtypes RAIL, ELRL, MONO and MGLV exist, as such you are free to use these as you see fit.

===Tracks not provided by default===

==Trains with multiple tracktypes==
Some trains of yours might need to have multiple railtypes in order to work. Examples of this include UK thameslink trains and the russian EP10.

For this we need the following railtypetable which uses labels from the standardized railtype scheme.
railtypetable {
DC_3KV: [SAAD, SAAE, ELRL],
AC_25KV: [SAAA, SAAE, ELRL],
DC_3RD: [SAA3, "3RDR"]
}
Thameslink train
item (FEAT_TRAINS, train2) {
properties {
tracktype: [AC_25, DC_3RD];
}
}
EP10 train
item (FEAT_TRAINS, train3) {
properties {
tracktype: [AC_25, DC_3KV];
}
}
The thameslink train will work without issue in this example however the EP10 will not. This is because if a trackset provides tracks for 25 kv ac (SAAA) and 15 kv ac. In that case the DC_3KV tracktype would become SAAE which is allowed on 15 kv ac tracks, this isn't intended as we only want the train to use SAAE when both SAAD and SAAA don't exist. This could be eliviated by not including SAAE and ELRL in the tracktype definition, but then the train will not show up on the default tracks. Another solution is to use [[NML:If|if]] blocks to change the used tracktype. In the future it may be possible that nmlc is extended to allow testing for both SAAA and SAAD in the railtypetable before falling back, until then the below provided solution will have to be used.

<pre style="color:blue">
railtypetable {
DC_3KV: [SAAD],
AC_25KV: [SAAA],
ACDC: [SAAE, ELRL]
}

if (railtype_available("SAAA") || railtype_available("SAAD")) {
item (FEAT_TRAINS, train3) {
properties {
tracktype: [AC_25, DC_3KV];
}
}
} else {
item (FEAT_TRAINS, train3) {
properties {
tracktype: ACDC;
}
}
}
</pre>

==Changing speed and/or power of trains based on railtype==
One might be interested in implementing a train which speed and/or power depends on the voltage in the overhead line electrification. In order for this to work properly the newgrf needs to test the track with [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. In practice this will look like the following:

tile_powers_railtype("ELRL")

Below is a more complex example from RUKTS code, where a train with a diesel generator has higher speed on high voltage ac tracks. We need to test for only SAAA if it is avaliable, as otherwise we would have the train gain the benefits on all electrified tracks. If it however isn't avaliable we still want to know if the track is electrified which is why we have the second part. This is only neccesary if your set cares about voltages.

railtype_available("SAAA") ? tile_powers_railtype("SAAA") : (tile_powers_railtype("SAAE") || tile_powers_railtype("ELRL"))

==Rack rail==
There are two different types of rack rail engines, pure rack and rack and adhesion. Pure rack engines may only move on tracks fitted with racks (xRxx) whilst rack and adhesion engines may also move on regular tracks but at a lower tractive effort.

Rack rail is currently implemented in the speed class as a "special type", this is unfurtunate as the speed class would otherwise be trackset private.

===Alternative 1===

====Pure rack engines====
These engines should use *R** as label. A trackset could then prevent these trains from traversing *A** tracks.

====Rack and adhesion engines====
These engines should use *A** as label and test for *R** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. This assumes the trackset will allow *A** on *R**.

====Issues====
*Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.
*French Narrow Gauge Trains Set uses NRAN for rack and adhesion engines so tracksets can not support it as intended and pure rack systems at the same time.

===Alternative 2===

====Pure rack engines====
These engines should use *r** (not in scheme) as label. A trackset would then prevent these trains from traversing *A** tracks but allow them on *R**.

====Rack and adhesion engines====
These engines should use *R** as label and test for *r** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. Tracksets will allow *R** on *A** and *r**.

====Issues====
*Requires more track types than alternative 1.

Guide to railtypes

2025-12-06T19:18:34Z

Brickblock1: /* The railtypetable */

Trains and Railtypes both affect where a train can run and not, on top of this trains also need the correct railtypes to be defined in order to show up. This means that train and railtype sets need to coordinate so that the expected behavior can be reached.

This guide is writen for nml but it should be possible to follow if you subsititute the nml properties with the NFO ones, see below:

WIP

==The railtypetable==
The railtype table maps the tracktype specified in the property tracktype to a railtype label. NML will only use the RAIL, MONO and MGLV labels if no railtypetable is provided.

For more info see [https://www.tt-wiki.net/wiki/NMLTutorial/Railtypetable NMLTutorial/Railtypetable] and [[NML:Railtypetable-Roadtypetable-Tramtypetable]]

==Railtype properties==
The following properties are relevant for how vehicles and railtypes interact with each other:
{| class="wikitable sortable"
! property
! comment
|-
| label
| names of default rail types: "RAIL", "ELRL", "MONO", "MGLV". See the [[RailtypeLabels|List of railtype labels]] in the NewGRF Specs for currently defined custom labels.
|-
| compatible_railtype_list
| Provide a list of rail types that trains of this type can also run on. e.g. ["RAIL", "ELRL", "MONO"]. Note that when routing trains, the compatibility is only evaluated for the lead engine of a consist. This means that trains will run on incompatible rail types if they are in a consist where the lead engine is compatible with the rail type. This applies to both engines and wagons.
|-
| powered_railtype_list
| Provide a list of rail types that trains of this type are powered on.
|-
| alternative_railtype_list
|
{{ottd|1.2|r23758}} List of rail types which this rail type will act as fallback for, if the corresponding rail type is not defined separately
|}

==Trains with only one tracktype==

item (FEAT_TRAINS, train) {
properties {
tracktype: REF_TO_RAILTYPE_TABLE;
}
}

By default OpenTTD will always make sure the railtypes RAIL, ELRL, MONO and MGLV exist, as such you are free to use these as you see fit.

===Tracks not provided by default===

==Trains with multiple tracktypes==
Some trains of yours might need to have multiple railtypes in order to work. Examples of this include UK thameslink trains and the russian EP10.

For this we need the following railtypetable which uses labels from the standardized railtype scheme.
railtypetable {
DC_3KV: [SAAD, SAAE, ELRL],
AC_25KV: [SAAA, SAAE, ELRL],
DC_3RD: [SAA3, "3RDR"]
}
Thameslink train
item (FEAT_TRAINS, train2) {
properties {
tracktype: [AC_25, DC_3RD];
}
}
EP10 train
item (FEAT_TRAINS, train3) {
properties {
tracktype: [AC_25, DC_3KV];
}
}
The thameslink train will work without issue in this example however the EP10 will not. This is because if a trackset provides tracks for 25 kv ac (SAAA) and 15 kv ac. In that case the DC_3KV tracktype would become SAAE which is allowed on 15 kv ac tracks, this isn't intended as we only want the train to use SAAE when both SAAD and SAAA don't exist. This could be eliviated by not including SAAE and ELRL in the tracktype definition, but then the train will not show up on the default tracks. Another solution is to use [[NML:If|if]] blocks to change the used tracktype. In the future it may be possible that nmlc is extended to allow testing for both SAAA and SAAD in the railtypetable before falling back, until then the below provided solution will have to be used.

<pre style="color:blue">
railtypetable {
DC_3KV: [SAAD],
AC_25KV: [SAAA],
ACDC: [SAAE, ELRL]
}

if (railtype_available("SAAA") || railtype_available("SAAD")) {
item (FEAT_TRAINS, train3) {
properties {
tracktype: [AC_25, DC_3KV];
}
}
} else {
item (FEAT_TRAINS, train3) {
properties {
tracktype: ACDC;
}
}
}
</pre>

==Changing speed and/or power of trains based on railtype==
One might be interested in implementing a train which speed and/or power depends on the voltage in the overhead line electrification. In order for this to work properly the newgrf needs to test the track with [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. In practice this will look like the following:

tile_powers_railtype("ELRL")

Below is a more complex example from RUKTS code, where a train with a diesel generator has higher speed on high voltage ac tracks. We need to test for only SAAA if it is avaliable, as otherwise we would have the train gain the benefits on all electrified tracks. If it however isn't avaliable we still want to know if the track is electrified which is why we have the second part. This is only neccesary if your set cares about voltages.

railtype_available("SAAA") ? tile_powers_railtype("SAAA") : (tile_powers_railtype("SAAE") || tile_powers_railtype("ELRL"))

==Rack rail==
There are two different types of rack rail engines, pure rack and rack and adhesion. Pure rack engines may only move on tracks fitted with racks (xRxx) whilst rack and adhesion engines may also move on regular tracks but at a lower tractive effort.

Rack rail is currently implemented in the speed class as a "special type", this is unfurtunate as the speed class would otherwise be trackset private.

===Alternative 1===

====Pure rack engines====
These engines should use *R** as label. A trackset could then prevent these trains from traversing *A** tracks.

====Rack and adhesion engines====
These engines should use *A** as label and test for *R** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. This assumes the trackset will allow *A** on *R**.

====Issues====
*Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.
*French Narrow Gauge Trains Set uses NRAN for rack and adhesion engines so tracksets can not support it as intended and pure rack systems at the same time.

===Alternative 2===

====Pure rack engines====
These engines should use *r** (not in scheme) as label. A trackset would then prevent these trains from traversing *A** tracks but allow them on *R**.

====Rack and adhesion engines====
These engines should use *R** as label and test for *r** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. Tracksets will allow *R** on *A** and *r**.

====Issues====
*Requires more track types than alternative 1.

Standardized Railtype Scheme

2025-12-06T19:05:34Z

Brickblock1: /* Extensions and best practice */ moved some stuff so needed to update this

This railtype label scheme aims to provide a way to allow players to easily mix and match different train and track sets. It does this by grouping the rail types into what matters from a technical perspective. The scheme provides a standardized way of defining railtype labels, based on track type and gauge, speed class, allowable axle weight and electrification type. To limit combinatorial explosions of rail types, the track properties are abstracted away from strict real-life representations.

It is the explicit intent of this scheme to decouple track sets from vehicle sets to facilitate easy mixing. This way the player can select a track set of choice to go with a train set of choice. It allows the player to play with or without axle load classes, or with or without speed limit classes, simply by loading a track set that does or does not provide these features. In some cases it will also be possible to combine niche track sets, for instance a standard gauge track set with a narrow gauge and a metro track set. Additionally, due to the decoupling, depending on the specific train and track sets used, not all defined vehicles and/or track types might be available in a specific set combination. This is fully intended behaviour.

== When to use the scheme and when ''not'' to use the scheme ==

When to use:
* If you only want to develop a track or a train set.
* If you want players to be able to mix-and-match sets.
* If you are okay with abstractions from real life.

When ''not'' to use:
* If you consider it a crime against humanity when one of your vehicles or track types is not available in a specific game.
* If you want your tracks or vehicles to exactly mirror real-life counterparts down to the last mm of gauge width.
* If your train set is specifically designed to work with your track set only.
* If you feel the compulsory need to fill all 64 railtype slots.

== The Label Scheme ==
A railtype label consists of four characters. In this scheme, each position has a different purpose:
# Track type and gauge class (e.g. standard gauge rail, narrow gauge rail, monorail)
# Speed limit class
# Axle load class (maximum allowed axle weight for this track)
# Energy source type class

In the next sections, each of the four positions will be explained.

=== Track type and gauge class [X***] ===
The first position in the railtype label defines track type and/or track gauge class. The following classes are currently defined:

{|
! !!Track type/gauge
|-
|S ||Standard gauge rail
|-
|B ||Broad gauge rail
|-
|N ||Narrow gauge rail
|-
|n ||Secondary narrow gauge rail (e.g. when providing both metre and cape gauge, always use N in case of just one type of narrow gauge)
|-
|D ||Dual gauge rail, standard/broad gauge
|-
|d ||Dual gauge rail, standard/narrow gauge
|-
|M ||Monorail
|-
|L ||Magnetic Levitation
|}

All track types or gauges are abstractions of real-life types and do not correspond to specific examples used in real-life. For example '''N''' is any gauge that is smaller than standard gauge, but not corresponding to any specific gauge that exists in real life, just like '''n''' is smaller than '''N''', but does not corresponds to a specific real-life gauge.

A train set may define vehicles for gauge '''n''' while not defining vehicles for gauge '''N''', but this is likely only useful for sets that are specifically designed to be used along-side other sets, and the used railtype fallbacks should be carefully considered.

=== Speed limit/appearance class [*X**] ===
The second position in the railtype label defines the speed limit/appearance class. This can be used to provide tracks with different speed limits or appearance variations. The speed limit/appearance class is ''not'' used for trains and a train set should always use the class letter '''A''' in this position.

There is no fixed numeric mapping for this class, but speed limits should start at '''A''' for the lowest speed limit and progress with '''B/C/...''' for higher limits. If you do not want to employ speed limits in your track set, always use the class '''A'''.

Additionally this class can also be used to distinguish different track appearances like normal or full width ballast, grass or concrete ground, etc. Train sets must not define vehicles for appearance classes. If you think you have special vehicles that should only run on the appearance class, it is ''not'' appearance but a separate track type/gauge.

=== Axle load class [**X*] ===
The third position defines the axle weight limit. Heavy trains cannot run on tracks with a low axle weight limit; these trains need more expensive tracks with a higher weight limit. There are five axle load classes '''A''' through '''E'''. '''A''' is for the lowest axle load limit, '''E''' for the highest. The exact axle load attached to each class is relative to the track type/gauge and trains in the set.

A train set should set the appropriate axle weight for each train via the railtype label, as to make the set work with track sets that do provide tracks with different weight limits, even if you don't care about it for your trainset. Ideally, all five standard axle load classes should be used, but a train set may use only some weight classes, as the vehicle rooster might not make it feasible to use all five. The group with the lowest axle weights will get class '''A''', the second lowest class '''B''', etc. up to the group with the highest axle weights which will get class '''E'''. If you do not use all classes, try to spread the classes out (don't use '''A''' and '''B''' for two classes, but e.g. '''B''' and '''D''').

A track set does not have to provide a dedicated track type for each axle weight limit. A track set that does not provide a dedicated track for each axle load class, must make sure to map all undefined axle load classes to a real railtype using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]]. This way a train set can rely on all labels for all axle load classes being available. Example: if you only want to provide 2 axle load classes for standard gauge unelectrified with no speed limits, you can map SA'''A'''N + SA'''B'''N to SA'''C'''N and SA'''D'''N to SA'''E'''N if the cost difference between the two railtypes is high, or SA'''A'''N to SA'''B'''N and SA'''C'''N + SA'''D'''N to SA'''E'''N if the cost difference is low.

If you don't want to provide any axle load classes in your track set, it doesn't really matter what axle load class you choose for the track, as you'll be mapping all other classes to this track anyways. But the lowest or highest class are the obvious choice. Example: if your track set only provides narrow gauge unelectrified track with no speed limits and no axle load limits, you may use NA'''A'''N for the track label, and provide NA'''B'''N, NA'''C'''N, NA'''D'''N, NA'''E'''N in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

If you need more than five axle load class, you may use lowercase letters for very low axle loads and continue the uppercase letters for very high axle loads. Be advised that your train set may not assume the existence of any other class than '''A''' through '''E''', so think about providing appropriate fallbacks in your railtype table. If you make a track set with an extended range, be aware that not all train sets will define trains for these tracks. In general: only do this in case of a train set with a matching track set.

For the lowercase letters, '''b''' is lower than '''a''', so for increasing axle load limits: b < a < A < B < C etc.

Note that the axle load classes never map to a specific weight in tonnes. For that reason it does not make sense to add a numeric value for the axle load to the name of a track type or in the extended purchase info of a train. Instead use the relative expressions 'very low', 'low', 'medium', 'high' and 'very high' or use the class letters directly.

=== Energy source type class [***X] ===
The last position defines the energy source type class. This is split in generic energy source types like overhead wires and third rail and specialized types like alternating and direct current.

A track set that only uses specialized types, should map the generic types to the most suitable specialized type in the set.

A vehicle set that uses specialized types should define a generic type as fallback, via the railtype table. If such a fallback is omitted, please note that certain vehicles may be unavailable depending on track set loaded.

{|
! !!Generic energy type classes
|-
|N ||no electrification
|-
|E ||overhead wires/catenary electrification
|-
|3 ||3rd rail electrification
|}

{|
! !!Specialized energy type classes !!Vehicle set fallback
|-
|Z ||3rd rail and catenary electrification || 3 or E
|-
|4 ||4th rail electrification || 3
|-
|Y ||4th rail and catenary electrification || 4 or E
|-
|T ||[http://en.wikipedia.org/wiki/Three-phase_AC_railway_electrification three phase AC electrification] || E
|-
| colspan="3" |  
|-
|D ||DC catenary electrification || E
|-
|d ||low voltage DC catenary electrification (only when D also used in set) || First D, then E
|-
|A ||AC catenary electrification || E
|-
|a ||low voltage AC catenary electrification (only when A also used in set) || First A then E
|}

All energy source types are abstractions of real-life types and do not correspond to specific examples used in real-life. For example '''D''' and '''d''' are treated as two different DC voltage levels, but do not correspond to any specific real-life voltage level used.

A train set may define vehicles for energy source '''d''' while not defining vehicles for energy source '''D''' (as an example, applies to other energy sources, too), but this is likely only useful for sets that are specifically designed to be used along-side other sets, and the used railtype fallbacks should be carefully considered.

If you want multi-voltage/current vehicles in your set (i.e. a train that can run on both AC and DC current), you have to define a dedicated railtype for those vehicles. Without the railtype, it's not possible to define vehicles with this property. If you only have vehicles that can run on either one type of voltage/current or on all types of voltage/current (e.g. a 2-system if you only have '''A''' and '''D''' tracks, or a 4-system in case of all '''A''', '''a''', '''D''' and '''d'''), then use the generic class '''E''' for vehicles that should be able to run on all different voltage/currents. Also the track set needs to have one at least one railtype with class '''E''' defined.

Note that if you want more than one type of multi-voltage/current, you'll quickly get a combinatory explosion of railtype labels, so plan carefully or do not attempt it. For every different multi-voltage/current vehicle type a dedicated railtype is needed. If you want all possible combinations, then you need to define an additional 8 classes. It is not recommended to make your train/track set this complicated.

Example approach for a 4-system set, with trains that can run on either one or all systems:
* '''E''': generic catenary-powered electric engines. "universal" [4-system] if any of '''D'''/'''d'''/'''A'''/'''a''' are defined.
* '''A''': generic AC catenary electric engines. 25kV only if '''a''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''A''';
* '''a''': 15kV AC catenary electric engines. Only defined if '''A''' also defined. Vehicle sets should use '''A''' and '''E''' as fallback, if defining an engine for '''a''';
* '''D''': generic DC catenary electric engines. 3kV if '''d''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''D''';
* '''d''': 1.5kV DC catenary electric engines. Only defined if '''D''' also defined. Vehicle sets should use '''D''' and '''E''' as fallback, if defining an engine for '''d'''.
For a 2-system set, you can simply drop '''a''' and '''d'''.

=== Standard labels: RAIL, ELRL, MONO, MGLV ===
It's not possible to undefine the standard railtypes RAIL, ELRL, MONO and MGLV. The game will always add those if there are vehicles defined for these track types. As a result, for a track set it's best not to ignore those standard labels, but rather work with them and define them in the set. If your track set does not have monorail or maglev tracks, there of course is no need to define those. But if your track set defines anything that resembles unelectrified or electrified rail, you should use the RAIL and ELRL labels. Matching labels from the above scheme will then be defined in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

As vehicles from NewGRFs that do not use explicit railtypes will end up on these standard railtypes, you should use RAIL instead of whatever type could be regarded as the most commonly used unelectrified type, ELRL instead of the most commonly used electrified type and so on. The label according to this scheme is then set as an alternate.

== Summary and notes for track sets ==
This section summarizes and comments the above for track sets.

; [X***] Track type and gauge class
* Define at least one track type for every track type/gauge class you want in your set.
* If you only provide tracks for one type/gauge, consider leaving some free railtypes so a player can load an additional set for some other type.
; [*X**] Speed limit class
* Make sure class A is always available, either directly or via an alternate label.
* Use only class A if you don't want speed limits;
* With speed limits, A is the lowest speed limit. Continue with B, C, etc. for increasing speed limits;
* The speed class can also be used to implement additional eye-candy track types, use letters higher in the alphabet for this.
; [**X*] Axle load class
* Always define all classes A through E for every track type class / electrification combination, either:
** Directly via a real railtype definition;
** Indirectly via the alternate rail type label list, property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].
* Extend the predefined classes only if you also provide a train set that makes use of these.
; [***X] Energy source type class
* If your set only uses specialized classes, always map the generic classes to the closest matching specialized type via property 1D.
* Don't use specialized sub-types (e.g. d, a) unless you also use the main specialized class (e.g. D, A).
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Always re-define the standard labels when possible, instead of what would be the equivalent of the standard label in this scheme.
* Map the equivalent label(s) from this scheme to the standard labels using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].
; Powered/compatible rail types
* For the speed limit/appearance class, every type should be powered and compatible with each other.
* Axle load classes implemented as real railtypes should be powered and compatible in ascending order, i.e. a lower axle load is compatible with a higher axle load, but not vice versa.
* Different energy sources should be compatible with each other but not powered on each other, expect for multi-system energy source classes.
* Different track type and gauge classes should be neither powered nor compatible with each other.

Or, put differently, for each type/gauge, select one or more energy source types. For each type/energy combination provide all axle load classes for the speed class "A", either as a real type or as an alternate of another type. Provide more types with a different speed letter if you want to provide several different speeds or other eye-candy tracks.

== Summary and notes for train sets ==
This section summarizes and comments the above for train sets.

; [X***] Track type and gauge class
* Use the track type class that matches the vehicle;
* Define a fallback type via the railtype table in case you want the vehicle to be available on a different track if no matching track set is loaded.
** Specialized subtypes like "n" might not always be available. If you want those vehicles to be still available then, fall back the the generic class (e.g. "N").
** Think about your set design and how for example standard gauge and narrow gauge vehicles differ to decide if a fallback from narrow gauge to standard gauge has gameplay meaning.
; [*X**] Speed limit class
* Always use class A for every vehicle.
; [**X*] Axle load class
* Use all classes A through E according to the maximum axle weight of the vehicle.
* Extend the predefined classes only if you also provide a track set that makes use of these;
** When extending the predefined classes A through E, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; [***X] Energy source type class
* Use the energy source type class that matches the vehicle;
* When using specialized classes, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Define a fallback type to the standard labels via the railtype table in case you want the vehicle to be available on the standard tracks if no matching track set is loaded. This is a decision you need to make depending on the design of your train set.

Be as specific as you want when selecting the railtype, it is the job of the track set to select a playable, reduced subset out of all possible type combinations. This can mean that some vehicles may not appear with some set combinations, but if a player does not want to have e.g. narrow gauge tracks, they might not want narrow gauge vehicles either.

== In case you're not convinced by this scheme ==
Adopting this scheme gives the player freedom to use any track set in combination with any train set that follow the scheme.

This means that you can make your train set compatible with track sets that provide axle load classes, and track sets that provide speed limits, and at the same time with track sets that provide none of this. This way, the player can decide to play with or without axle load classes, or with or without speed limits, simply by loading a track set that does or does not provide these features.

And for your track set, it means that you can make it as simple or as complicated as you want (within the 64 track type limit), while not having to worry about compatibility with train sets.

Still not convinced? Feel free to use railtype labels of your own, but know that you will likely come to regret that at some point in the future.

==Forum topic==
If you want to discuss the standardized railtype scheme or have any questions about it, you can visit [http://www.tt-forums.net/viewtopic.php?t=59379 the forum topic].

==Extensions and best practice==
See [https://newgrf-specs.tt-wiki.net/wiki/Standardized_Railtype_Scheme_extensions Standardized Railtype Scheme extensions] and [[Guide to railtypes]]

Guide to railtypes

2025-12-06T19:03:20Z

Brickblock1: Move stuff from standard scheme extended page and add info about having multiple tracktypes

Trains and Railtypes both affect where a train can run and not, on top of this trains also need the correct railtypes to be defined in order to show up. This means that train and railtype sets need to coordinate so that the expected behavior can be reached.

This guide is writen for nml but it should be possible to follow if you subsititute the nml properties with the NFO ones, see below:

WIP

==The railtypetable==
See [https://www.tt-wiki.net/wiki/NMLTutorial/Railtypetable NMLTutorial/Railtypetable] and [[NML:Railtypetable-Roadtypetable-Tramtypetable]]

==Railtype properties==
The following properties are relevant for how vehicles and railtypes interact with each other:
{| class="wikitable sortable"
! property
! comment
|-
| label
| names of default rail types: "RAIL", "ELRL", "MONO", "MGLV". See the [[RailtypeLabels|List of railtype labels]] in the NewGRF Specs for currently defined custom labels.
|-
| compatible_railtype_list
| Provide a list of rail types that trains of this type can also run on. e.g. ["RAIL", "ELRL", "MONO"]. Note that when routing trains, the compatibility is only evaluated for the lead engine of a consist. This means that trains will run on incompatible rail types if they are in a consist where the lead engine is compatible with the rail type. This applies to both engines and wagons.
|-
| powered_railtype_list
| Provide a list of rail types that trains of this type are powered on.
|-
| alternative_railtype_list
|
{{ottd|1.2|r23758}} List of rail types which this rail type will act as fallback for, if the corresponding rail type is not defined separately
|}

==Trains with only one tracktype==

item (FEAT_TRAINS, train) {
properties {
tracktype: REF_TO_RAILTYPE_TABLE;
}
}

By default OpenTTD will always make sure the railtypes RAIL, ELRL, MONO and MGLV exist, as such you are free to use these as you see fit.

===Tracks not provided by default===

==Trains with multiple tracktypes==
Some trains of yours might need to have multiple railtypes in order to work. Examples of this include UK thameslink trains and the russian EP10.

For this we need the following railtypetable which uses labels from the standardized railtype scheme.
railtypetable {
DC_3KV: [SAAD, SAAE, ELRL],
AC_25KV: [SAAA, SAAE, ELRL],
DC_3RD: [SAA3, "3RDR"]
}
Thameslink train
item (FEAT_TRAINS, train2) {
properties {
tracktype: [AC_25, DC_3RD];
}
}
EP10 train
item (FEAT_TRAINS, train3) {
properties {
tracktype: [AC_25, DC_3KV];
}
}
The thameslink train will work without issue in this example however the EP10 will not. This is because if a trackset provides tracks for 25 kv ac (SAAA) and 15 kv ac. In that case the DC_3KV tracktype would become SAAE which is allowed on 15 kv ac tracks, this isn't intended as we only want the train to use SAAE when both SAAD and SAAA don't exist. This could be eliviated by not including SAAE and ELRL in the tracktype definition, but then the train will not show up on the default tracks. Another solution is to use [[NML:If|if]] blocks to change the used tracktype. In the future it may be possible that nmlc is extended to allow testing for both SAAA and SAAD in the railtypetable before falling back, until then the below provided solution will have to be used.

<pre style="color:blue">
railtypetable {
DC_3KV: [SAAD],
AC_25KV: [SAAA],
ACDC: [SAAE, ELRL]
}

if (railtype_available("SAAA") || railtype_available("SAAD")) {
item (FEAT_TRAINS, train3) {
properties {
tracktype: [AC_25, DC_3KV];
}
}
} else {
item (FEAT_TRAINS, train3) {
properties {
tracktype: ACDC;
}
}
}
</pre>

==Changing speed and/or power of trains based on railtype==
One might be interested in implementing a train which speed and/or power depends on the voltage in the overhead line electrification. In order for this to work properly the newgrf needs to test the track with [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. In practice this will look like the following:

tile_powers_railtype("ELRL")

Below is a more complex example from RUKTS code, where a train with a diesel generator has higher speed on high voltage ac tracks. We need to test for only SAAA if it is avaliable, as otherwise we would have the train gain the benefits on all electrified tracks. If it however isn't avaliable we still want to know if the track is electrified which is why we have the second part. This is only neccesary if your set cares about voltages.

railtype_available("SAAA") ? tile_powers_railtype("SAAA") : (tile_powers_railtype("SAAE") || tile_powers_railtype("ELRL"))

==Rack rail==
There are two different types of rack rail engines, pure rack and rack and adhesion. Pure rack engines may only move on tracks fitted with racks (xRxx) whilst rack and adhesion engines may also move on regular tracks but at a lower tractive effort.

Rack rail is currently implemented in the speed class as a "special type", this is unfurtunate as the speed class would otherwise be trackset private.

===Alternative 1===

====Pure rack engines====
These engines should use *R** as label. A trackset could then prevent these trains from traversing *A** tracks.

====Rack and adhesion engines====
These engines should use *A** as label and test for *R** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. This assumes the trackset will allow *A** on *R**.

====Issues====
*Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.
*French Narrow Gauge Trains Set uses NRAN for rack and adhesion engines so tracksets can not support it as intended and pure rack systems at the same time.

===Alternative 2===

====Pure rack engines====
These engines should use *r** (not in scheme) as label. A trackset would then prevent these trains from traversing *A** tracks but allow them on *R**.

====Rack and adhesion engines====
These engines should use *R** as label and test for *r** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. Tracksets will allow *R** on *A** and *r**.

====Issues====
*Requires more track types than alternative 1.

Standardized Railtype Scheme extensions

2025-12-06T18:20:52Z

Brickblock1: Restore extensions to match implementations

== Why use extended schemes and when ''not'' to use them ==
Why use:
* You want to ignore axle loads.
* You want to have more specific definitions than what the standard allows for.

When ''not'' to use:
* If you want immediate payoff; most if not all these possibilities are barely, if ever, used.
* If you do not want this level of complexity in your mod. It ''is'' optional, the extensions are only for edge cases.
* If you want to create a simple set which will be easy to pick up where real life accuracy isn't the goal.

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Maglev extensions==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS, the Maglev Track Set, and in one case JP+, which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback
|-
|S ||Maglevs that use a synchronous linear induction ||N/A
|-
|I ||Maglevs that use a linear induction motor||N/A
|}

==JP+ extensions==
These are extensions to the gauge and energy source type classes currently supported by JP+ tracks and used by JP+ train sets.
===Rail System/Gauge [X***]===
{|
! !!Track type/gauge !!Vehicle set fallback
|-
|s ||Scotch gauge || S
|-
|_ ||Universal || N/A
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback
|-
|I ||linear induction motor|| N/A
|}

==Multi-voltage extensions DEPRECATED==
{{ottdp|15|no|ottdrev=g52e97c981c}} As of openttd 15 it will be possible to use multiple tracktypes for one vehicle, removing the need to create superfluous railtypes for voltages to work out right.

These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

'''CURRENTLY NOT IMPLEMENTED AND MOSTLY NOT OF VALUE'''

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), or 16 in (406 mm)]
|-
|2 ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|N ||Narrow gauge (1067mm)
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge. Use this if you don't mind gameplay abstractions but don't want physically impossible combinations (e.g. rail, monorail and maglev cannot have any level crossings with each other). Specifically, this accommodates B (ultrabroad), g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm).
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use if you want to provide a cheaper alternative to X that doesn't support fictional "supertrain" gauges.
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), and R (1000 mm). Use with minus (<nowiki>-</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use with plus (<nowiki>+</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit/appearance class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The appearance class can be tested for by trains using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] (which the French Set uses to change vehicle properties on rack rail), but this is generally not standardized, limits interoperability and is only useful for co-developed train and track sets.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|S ||subterranean ||eyecandy ||Metro Track Set
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|-
|U ||urban ||eyecandy ||Metro Track Set
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|4 (Formerly d) ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

====Axle Loads by Real World Implementation====
The table below is compatible with those above but functions differently than the ones above. It assumes that, in lieu of a train set that has ever implemented "d" as an axle weight, that instead "4" be used and a "3" placed between C and D for similar reasons. All the same classes are listed, however axle weight guidelines have been run by a research LLM which suggested different ranges of weight and different dates of availability. 4 is identical to d in practice. If "d" is not defined as a lighter axle weight than "c", then **4* should be used alongside it in an alternative_tracktype_list for any **D** track type with axle weight "D". If "d" is defined as a lighter axle weight than "c", only tracktypes with axle weight "4" (**4*) should be listed in the alternative_tracktype list for any **D* tracktype.

Use **4* on all applicable rolling stock going forward, and rely on track sets to define "d" for vehicle sets.

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||5 metric tonnes (5000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||10 metric tonnes (10000kg) per axle; Because reserved by examples || style="text-align:right;"|~1820 (Focused on carrying capacity over speed)
|-
|A ||Very Low (2012 OG Default)||15 metric tonnes (15000kg) per axle || style="text-align:right;"|~1870
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|~1890
|-
|C ||Medium ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|~1910
|-
|3 ||Medium, lightweight "FLEXX Eco" and "FLEXX Eco Commuter" bogies ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|2001 (FLEXX Eco)
|-
|D ||High ||31 metric tonnes (31000kg) per axle || style="text-align:right;"|~1930
|-
|4 (Formerly d) ||High, extra-lean "DYNAFREIGHT" and "FLEXX Eco Regional" bogies ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|2016 (FLEXX Eco, Regional var.)
|-
|E ||Very High ||40 metric tonnes (40000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|1988
|-
|F ||Fortescue/Future-proofed ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|2008
|}

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||[[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] would need to contain literally everything you can think of, so instead developers of track sets should always add "_R_t" to the [[NML:Railtypes#Railtype_properties|compatible_railtype_list and powered_railtype_list (NML)]] of their railtypes.
|-
|<nowiki>-</nowiki> ||Universal "no energy" type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put both "***N" and "***E" in the [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]] of a "***-" label, but neither under the [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]]) ||(''Do not give a fallback to a "***-" label, or add a "***-" label to any [[NML:Railtypes#Railtype_properties|compatible_railtype_list, powered_railtype_list or alternative_railtype_list (NML)]], this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks); improbable, but not physically impossible ||E ||
|-
|8 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, 3-phase catenary (literally had 3 cables) and universal catenary (SA_E); a total of 5 rails (2 for wheels, 3 for electricity; plus 3 overhead catenary lines equals 8) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center) ||U ||
|-
|<nowiki>+</nowiki> ||750v DC catenary ||v, then U ||
|-
|6 ||600v DC catenary ||v, then U ||
|-
|v ||750v & 600v DC catenary ||U ||Combines both necessary voltages of 600mm catenary.
|-
|z ||25kV AC catenary & 750v 3rd Rail ||U ||Used in New York City on the New Haven Line.
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||Not applicable ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||N/A ||
|}

Standardized Railtype Scheme extensions

2025-12-06T18:11:53Z

Brickblock1:

== Why use extended schemes and when ''not'' to use them ==
Why use:
* You want to ignore axle loads.
* You want to have more specific definitions than what the standard allows for.

When ''not'' to use:
* If you want immediate payoff; most if not all these possibilities are barely, if ever, used.
* If you do not want this level of complexity in your mod. It ''is'' optional, the extensions are only for edge cases.
* If you want to create a simple set which will be easy to pick up where real life accuracy isn't the goal.

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Maglev extensions==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS, the Maglev Track Set, and in one case JP+, which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback !!Notes !!Examples
|-
|S ||Maglevs that use a synchronous linear induction motor (EDS) ||V ||(Electrodynamic) Requires onboard supercooling ||SCMaglev (LABS)
|-
|V ||VacTrain with synchronous linear motor track (EDS) ||N/A ||Requires soft vacuum or advanced onboard supercooling ||"JR-VacLev" (fictional, LABV)
|-
|I ||Maglevs that use a linear induction motor (EMS) ||e, then v ||(Electromagnetic) Relies on track power ||Transrapid (TABI), Linimo (LABI)
|-
|e ||Maglevs that use a synchronous linear induction motor (EDS) ||I ||(Electrodynamic) Requires onboard supercooling ||CRRC (TACe)
|-
|W ||VacTrain with linear induction motor track (EMS or EDS) ||N/A ||Requires hard vacuum, relies on track power ||"Vacrapid" (fictional, TABv)
|}

==JP+ extensions==
These are extensions to the gauge and energy source type classes currently supported by JP+ tracks and used by JP+ train sets.
===Rail System/Gauge [X***]===
{|
! !!Track type/gauge !!Vehicle set fallback
|-
|s ||Scotch gauge || S
|-
|_ ||Universal || N/A
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback !!Notes
|-
|I ||Maglevs that use a linear induction motor (EMS) || N/A ||(Electromagnetic Suspension) Relies on track power; Unpublished, likely used for Linimo (JP+)
|}

==Multi-voltage extensions DEPRECATED==
{{ottdp|15|no|ottdrev=g52e97c981c}} As of openttd 15 it will be possible to use multiple tracktypes for one vehicle, removing the need to create superfluous railtypes for voltages to work out right.

These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

'''CURRENTLY NOT IMPLEMENTED AND MOSTLY NOT OF VALUE'''

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), or 16 in (406 mm)]
|-
|2 ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|N ||Narrow gauge (1067mm)
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge. Use this if you don't mind gameplay abstractions but don't want physically impossible combinations (e.g. rail, monorail and maglev cannot have any level crossings with each other). Specifically, this accommodates B (ultrabroad), g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm).
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use if you want to provide a cheaper alternative to X that doesn't support fictional "supertrain" gauges.
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), and R (1000 mm). Use with minus (<nowiki>-</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use with plus (<nowiki>+</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit/appearance class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The appearance class can be tested for by trains using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] (which the French Set uses to change vehicle properties on rack rail), but this is generally not standardized, limits interoperability and is only useful for co-developed train and track sets.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|S ||subterranean ||eyecandy ||Metro Track Set
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|-
|U ||urban ||eyecandy ||Metro Track Set
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|4 (Formerly d) ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

====Axle Loads by Real World Implementation====
The table below is compatible with those above but functions differently than the ones above. It assumes that, in lieu of a train set that has ever implemented "d" as an axle weight, that instead "4" be used and a "3" placed between C and D for similar reasons. All the same classes are listed, however axle weight guidelines have been run by a research LLM which suggested different ranges of weight and different dates of availability. 4 is identical to d in practice. If "d" is not defined as a lighter axle weight than "c", then **4* should be used alongside it in an alternative_tracktype_list for any **D** track type with axle weight "D". If "d" is defined as a lighter axle weight than "c", only tracktypes with axle weight "4" (**4*) should be listed in the alternative_tracktype list for any **D* tracktype.

Use **4* on all applicable rolling stock going forward, and rely on track sets to define "d" for vehicle sets.

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||5 metric tonnes (5000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||10 metric tonnes (10000kg) per axle; Because reserved by examples || style="text-align:right;"|~1820 (Focused on carrying capacity over speed)
|-
|A ||Very Low (2012 OG Default)||15 metric tonnes (15000kg) per axle || style="text-align:right;"|~1870
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|~1890
|-
|C ||Medium ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|~1910
|-
|3 ||Medium, lightweight "FLEXX Eco" and "FLEXX Eco Commuter" bogies ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|2001 (FLEXX Eco)
|-
|D ||High ||31 metric tonnes (31000kg) per axle || style="text-align:right;"|~1930
|-
|4 (Formerly d) ||High, extra-lean "DYNAFREIGHT" and "FLEXX Eco Regional" bogies ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|2016 (FLEXX Eco, Regional var.)
|-
|E ||Very High ||40 metric tonnes (40000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|1988
|-
|F ||Fortescue/Future-proofed ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|2008
|}

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||[[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] would need to contain literally everything you can think of, so instead developers of track sets should always add "_R_t" to the [[NML:Railtypes#Railtype_properties|compatible_railtype_list and powered_railtype_list (NML)]] of their railtypes.
|-
|<nowiki>-</nowiki> ||Universal "no energy" type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put both "***N" and "***E" in the [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]] of a "***-" label, but neither under the [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]]) ||(''Do not give a fallback to a "***-" label, or add a "***-" label to any [[NML:Railtypes#Railtype_properties|compatible_railtype_list, powered_railtype_list or alternative_railtype_list (NML)]], this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks); improbable, but not physically impossible ||E ||
|-
|8 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, 3-phase catenary (literally had 3 cables) and universal catenary (SA_E); a total of 5 rails (2 for wheels, 3 for electricity; plus 3 overhead catenary lines equals 8) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center) ||U ||
|-
|<nowiki>+</nowiki> ||750v DC catenary ||v, then U ||
|-
|6 ||600v DC catenary ||v, then U ||
|-
|v ||750v & 600v DC catenary ||U ||Combines both necessary voltages of 600mm catenary.
|-
|z ||25kV AC catenary & 750v 3rd Rail ||U ||Used in New York City on the New Haven Line.
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||Not applicable ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||N/A ||
|}

Standardized Railtype Scheme extensions

2025-12-06T18:10:11Z

Brickblock1: Multi-voltage extensions is deprecated and the other stuff is better of on a separete page

== Why use extended schemes and when ''not'' to use them ==
Why use:
* You want to ignore axle loads.
* You want to have more specific definitions than what the standard allows for.

When ''not'' to use:
* If you want immediate payoff; most if not all these possibilities are barely, if ever, used.
* If you do not want this level of complexity in your mod. It ''is'' optional, the extensions are only for edge cases.
* If you want to create a simple set which will be easy to pick up where real life accuracy isn't the goal.

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Maglev extensions==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS, the Maglev Track Set, and in one case JP+, which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback !!Notes !!Examples
|-
|S ||Maglevs that use a synchronous linear induction motor (EDS) ||V ||(Electrodynamic) Requires onboard supercooling ||SCMaglev (LABS)
|-
|V ||VacTrain with synchronous linear motor track (EDS) ||N/A ||Requires soft vacuum or advanced onboard supercooling ||"JR-VacLev" (fictional, LABV)
|-
|I ||Maglevs that use a linear induction motor (EMS) ||e, then v ||(Electromagnetic) Relies on track power ||Transrapid (TABI), Linimo (LABI)
|-
|e ||Maglevs that use a synchronous linear induction motor (EDS) ||I ||(Electrodynamic) Requires onboard supercooling ||CRRC (TACe)
|-
|W ||VacTrain with linear induction motor track (EMS or EDS) ||N/A ||Requires hard vacuum, relies on track power ||"Vacrapid" (fictional, TABv)
|}

==JP+ extensions==
These are extensions to the gauge and energy source type classes currently supported by JP+ tracks and used by JP+ train sets.
===Rail System/Gauge [X***]===
{|
! !!Track type/gauge !!Vehicle set fallback
|-
|s ||Scotch gauge || S
|-
|_ ||Universal || N/A
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback !!Notes
|-
|I ||Maglevs that use a linear induction motor (EMS) || N/A ||(Electromagnetic Suspension) Relies on track power; Unpublished, likely used for Linimo (JP+)
|}

==Multi-voltage extensions==
'''DEPRICATED'''
{{ottdp|15|no|ottdrev=g52e97c981c}} As of openttd 15 it will be possible to use multiple tracktypes for one vehicle, removing the need to create superfluous railtypes for voltages to work out right.

These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

'''CURRENTLY NOT IMPLEMENTED AND MOSTLY NOT OF VALUE'''

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), or 16 in (406 mm)]
|-
|2 ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|N ||Narrow gauge (1067mm)
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge. Use this if you don't mind gameplay abstractions but don't want physically impossible combinations (e.g. rail, monorail and maglev cannot have any level crossings with each other). Specifically, this accommodates B (ultrabroad), g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm).
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use if you want to provide a cheaper alternative to X that doesn't support fictional "supertrain" gauges.
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), and R (1000 mm). Use with minus (<nowiki>-</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use with plus (<nowiki>+</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit/appearance class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The appearance class can be tested for by trains using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] (which the French Set uses to change vehicle properties on rack rail), but this is generally not standardized, limits interoperability and is only useful for co-developed train and track sets.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|S ||subterranean ||eyecandy ||Metro Track Set
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|-
|U ||urban ||eyecandy ||Metro Track Set
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|4 (Formerly d) ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

====Axle Loads by Real World Implementation====
The table below is compatible with those above but functions differently than the ones above. It assumes that, in lieu of a train set that has ever implemented "d" as an axle weight, that instead "4" be used and a "3" placed between C and D for similar reasons. All the same classes are listed, however axle weight guidelines have been run by a research LLM which suggested different ranges of weight and different dates of availability. 4 is identical to d in practice. If "d" is not defined as a lighter axle weight than "c", then **4* should be used alongside it in an alternative_tracktype_list for any **D** track type with axle weight "D". If "d" is defined as a lighter axle weight than "c", only tracktypes with axle weight "4" (**4*) should be listed in the alternative_tracktype list for any **D* tracktype.

Use **4* on all applicable rolling stock going forward, and rely on track sets to define "d" for vehicle sets.

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||5 metric tonnes (5000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||10 metric tonnes (10000kg) per axle; Because reserved by examples || style="text-align:right;"|~1820 (Focused on carrying capacity over speed)
|-
|A ||Very Low (2012 OG Default)||15 metric tonnes (15000kg) per axle || style="text-align:right;"|~1870
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|~1890
|-
|C ||Medium ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|~1910
|-
|3 ||Medium, lightweight "FLEXX Eco" and "FLEXX Eco Commuter" bogies ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|2001 (FLEXX Eco)
|-
|D ||High ||31 metric tonnes (31000kg) per axle || style="text-align:right;"|~1930
|-
|4 (Formerly d) ||High, extra-lean "DYNAFREIGHT" and "FLEXX Eco Regional" bogies ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|2016 (FLEXX Eco, Regional var.)
|-
|E ||Very High ||40 metric tonnes (40000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|1988
|-
|F ||Fortescue/Future-proofed ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|2008
|}

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||[[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] would need to contain literally everything you can think of, so instead developers of track sets should always add "_R_t" to the [[NML:Railtypes#Railtype_properties|compatible_railtype_list and powered_railtype_list (NML)]] of their railtypes.
|-
|<nowiki>-</nowiki> ||Universal "no energy" type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put both "***N" and "***E" in the [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]] of a "***-" label, but neither under the [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]]) ||(''Do not give a fallback to a "***-" label, or add a "***-" label to any [[NML:Railtypes#Railtype_properties|compatible_railtype_list, powered_railtype_list or alternative_railtype_list (NML)]], this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks); improbable, but not physically impossible ||E ||
|-
|8 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, 3-phase catenary (literally had 3 cables) and universal catenary (SA_E); a total of 5 rails (2 for wheels, 3 for electricity; plus 3 overhead catenary lines equals 8) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center) ||U ||
|-
|<nowiki>+</nowiki> ||750v DC catenary ||v, then U ||
|-
|6 ||600v DC catenary ||v, then U ||
|-
|v ||750v & 600v DC catenary ||U ||Combines both necessary voltages of 600mm catenary.
|-
|z ||25kV AC catenary & 750v 3rd Rail ||U ||Used in New York City on the New Haven Line.
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||Not applicable ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||N/A ||
|}

Standardized Railtype Scheme extensions

2025-12-06T17:59:41Z

Brickblock1: Clean up when to use. it just restated previous information which was not entierly relevant

== Why use extended schemes and when ''not'' to use them ==
Why use:
* You want to ignore axle loads.
* You want to have more specific definitions than what the standard allows for.

When ''not'' to use:
* If you want immediate payoff; most if not all these possibilities are barely, if ever, used.
* If you do not want this level of complexity in your mod. It ''is'' optional, the extensions are only for edge cases.
* If you want to create a simple set which will be easy to pick up where real life accuracy isn't the goal.

==Multi-voltage Trains==
One might be interested in implementing a train which speed and/or power depends on the voltage in the overhead line electrification. In order for this to work properly the newgrf needs to test the track with [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype].

Below is an example from RUKTS code, where a train with a diesel generator has higher speed on high voltage ac tracks. We need to test for only SAAA if it is avaliable, as otherwise we would have the train gain the benefits on all electrified tracks. If it however isn't avaliable we still want to know if the track is electrified which is why we have the second part.

<code>railtype_available("SAAA") ? tile_powers_railtype("SAAA") : (tile_powers_railtype("SAAE") || tile_powers_railtype("ELRL"))</code>

==Rack rail==
There are two different types of rack rail engines, pure rack and rack and adhesion. Pure rack engines may only move on tracks fitted with racks (xRxx) whilst rack and adhesion engines may also move on regular tracks but at a lower tractive effort.

Rack rail is currently implemented in the speed class as a "special type", this is unfurtunate as the speed class would otherwise be trackset private.

===Alternative 1===

====Pure rack engines====
These engines should use *R** as label. A trackset could then prevent these trains from traversing *A** tracks.

====Rack and adhesion engines====
These engines should use *A** as label and test for *R** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. This assumes the trackset will allow *A** on *R**.

====Issues====
*Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.
*French Narrow Gauge Trains Set uses NRAN for rack and adhesion engines so tracksets can not support it as intended and pure rack systems at the same time.

===Alternative 2===

====Pure rack engines====
These engines should use *r** (not in scheme) as label. A trackset would then prevent these trains from traversing *A** tracks but allow them on *R**.

====Rack and adhesion engines====
These engines should use *R** as label and test for *r** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. Tracksets will allow *R** on *A** and *r**.

====Issues====
*Requires more track types than alternative 1.

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Multi-voltage extensions==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Maglev extensions==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS, the Maglev Track Set, and in one case JP+, which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback !!Notes !!Examples
|-
|S ||Maglevs that use a synchronous linear induction motor (EDS) ||V ||(Electrodynamic) Requires onboard supercooling ||SCMaglev (LABS)
|-
|V ||VacTrain with synchronous linear motor track (EDS) ||N/A ||Requires soft vacuum or advanced onboard supercooling ||"JR-VacLev" (fictional, LABV)
|-
|I ||Maglevs that use a linear induction motor (EMS) ||e, then v ||(Electromagnetic) Relies on track power ||Transrapid (TABI), Linimo (LABI)
|-
|e ||Maglevs that use a synchronous linear induction motor (EDS) ||I ||(Electrodynamic) Requires onboard supercooling ||CRRC (TACe)
|-
|W ||VacTrain with linear induction motor track (EMS or EDS) ||N/A ||Requires hard vacuum, relies on track power ||"Vacrapid" (fictional, TABv)
|}

==JP+ extensions==
These are extensions to the gauge and energy source type classes currently supported by JP+ tracks and used by JP+ train sets.
===Rail System/Gauge [X***]===
{|
! !!Track type/gauge !!Vehicle set fallback
|-
|s ||Scotch gauge || S
|-
|_ ||Universal || N/A
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback !!Notes
|-
|I ||Maglevs that use a linear induction motor (EMS) || N/A ||(Electromagnetic Suspension) Relies on track power; Unpublished, likely used for Linimo (JP+)
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

'''CURRENTLY NOT IMPLEMENTED AND MOSTLY NOT OF VALUE'''

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), or 16 in (406 mm)]
|-
|2 ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|N ||Narrow gauge (1067mm)
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge. Use this if you don't mind gameplay abstractions but don't want physically impossible combinations (e.g. rail, monorail and maglev cannot have any level crossings with each other). Specifically, this accommodates B (ultrabroad), g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm).
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use if you want to provide a cheaper alternative to X that doesn't support fictional "supertrain" gauges.
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), and R (1000 mm). Use with minus (<nowiki>-</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use with plus (<nowiki>+</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit/appearance class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The appearance class can be tested for by trains using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] (which the French Set uses to change vehicle properties on rack rail), but this is generally not standardized, limits interoperability and is only useful for co-developed train and track sets.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|S ||subterranean ||eyecandy ||Metro Track Set
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|-
|U ||urban ||eyecandy ||Metro Track Set
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|4 (Formerly d) ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

====Axle Loads by Real World Implementation====
The table below is compatible with those above but functions differently than the ones above. It assumes that, in lieu of a train set that has ever implemented "d" as an axle weight, that instead "4" be used and a "3" placed between C and D for similar reasons. All the same classes are listed, however axle weight guidelines have been run by a research LLM which suggested different ranges of weight and different dates of availability. 4 is identical to d in practice. If "d" is not defined as a lighter axle weight than "c", then **4* should be used alongside it in an alternative_tracktype_list for any **D** track type with axle weight "D". If "d" is defined as a lighter axle weight than "c", only tracktypes with axle weight "4" (**4*) should be listed in the alternative_tracktype list for any **D* tracktype.

Use **4* on all applicable rolling stock going forward, and rely on track sets to define "d" for vehicle sets.

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||5 metric tonnes (5000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||10 metric tonnes (10000kg) per axle; Because reserved by examples || style="text-align:right;"|~1820 (Focused on carrying capacity over speed)
|-
|A ||Very Low (2012 OG Default)||15 metric tonnes (15000kg) per axle || style="text-align:right;"|~1870
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|~1890
|-
|C ||Medium ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|~1910
|-
|3 ||Medium, lightweight "FLEXX Eco" and "FLEXX Eco Commuter" bogies ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|2001 (FLEXX Eco)
|-
|D ||High ||31 metric tonnes (31000kg) per axle || style="text-align:right;"|~1930
|-
|4 (Formerly d) ||High, extra-lean "DYNAFREIGHT" and "FLEXX Eco Regional" bogies ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|2016 (FLEXX Eco, Regional var.)
|-
|E ||Very High ||40 metric tonnes (40000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|1988
|-
|F ||Fortescue/Future-proofed ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|2008
|}

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||[[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] would need to contain literally everything you can think of, so instead developers of track sets should always add "_R_t" to the [[NML:Railtypes#Railtype_properties|compatible_railtype_list and powered_railtype_list (NML)]] of their railtypes.
|-
|<nowiki>-</nowiki> ||Universal "no energy" type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put both "***N" and "***E" in the [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]] of a "***-" label, but neither under the [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]]) ||(''Do not give a fallback to a "***-" label, or add a "***-" label to any [[NML:Railtypes#Railtype_properties|compatible_railtype_list, powered_railtype_list or alternative_railtype_list (NML)]], this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks); improbable, but not physically impossible ||E ||
|-
|8 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, 3-phase catenary (literally had 3 cables) and universal catenary (SA_E); a total of 5 rails (2 for wheels, 3 for electricity; plus 3 overhead catenary lines equals 8) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center) ||U ||
|-
|<nowiki>+</nowiki> ||750v DC catenary ||v, then U ||
|-
|6 ||600v DC catenary ||v, then U ||
|-
|v ||750v & 600v DC catenary ||U ||Combines both necessary voltages of 600mm catenary.
|-
|z ||25kV AC catenary & 750v 3rd Rail ||U ||Used in New York City on the New Haven Line.
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||Not applicable ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||N/A ||
|}

Guide to railtypes

2025-11-17T19:14:14Z

Brickblock1: Start writing the page

NML:Railtypetable-Roadtypetable-Tramtypetable

2025-11-17T18:53:38Z

Brickblock1: Add referance to new page

{{NMLNavBlocksyntax}}

'''Note:''' The syntax for <code style="color:darkgreen">roadtypetable</code> and <code style="color:darkgreen">tramtypetable</code> are identical to that of <code style="color:darkgreen">railtypetable</code> as described below

railtypetable {
ITEM [, ITEM]*
}

Each <code style="color:darkgreen">ITEM</code> can be either a 4-byte long Identifier or string or it can have this format:

ID : [ ID[, ID]* ]

The first ID is the name (doesn't have to be 4-bytes long), the other IDs are a list of labels that are assigned to the given name if they are available.

<pre style="color:blue">
railtypetable {
RAIL,
ELRL,
"3RDR",
RT_SHINY_RAIL: [SHNY, RAIL]
}
</pre>

The label 3RDR is written as a string because an identifier can't start with a numeric value. To reference it later you can write <code style="color:darkgreen">railtype("3RDR")</code>. If another grf defines a railtype with label SHNY then RT_SHINY_RAIL will refer to that track type. If the railtype SHNY is not available then trains using RT_SHINY_RAIL as track type will fallback to RAIL.

* The default railtype labels are "RAIL", "ELRL", "MONO", "MGLV". See the [[RailtypeLabels|List of railtype labels]] in the NewGRF Specs for currently defined custom labels.
* By default there is only one roadtype "ROAD" defined.
* By default there is only one tramtype "ELRL" defined. By convention tramtypes shall reuse railtype labels for similar types.

Note that labels are not shared between features, so the same label can be used for multiple items. For example, the label "RAIL" can be used for a railtype, roadtype, tramtype, and cargotype simultaneously without conflict.

{{ottdp|15|no|ottdrev=g52e97c981c}} Note that trains may have multiple railtypes at once, this can lead to unexpected behavior see [[Guide_to_railtypes|guide to railtypes]].

Standardized Roadtype Scheme

2025-06-08T14:54:26Z

Brickblock1: Remove confusing additions part

Standardized Railtype Scheme extensions

2025-06-08T14:52:17Z

Brickblock1: Add JP+ extensions, guide on rack rail and multivoltage

==Multi-voltage Trains==
One might be interested in implementing a train which speed and/or power depends on the voltage in the overhead line electrification. In order for this to work properly the newgrf needs to test the track with [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype].

Below is an example from RUKTS code, where a train with a diesel generator has higher speed on high voltage ac tracks. We need to test for only SAAA if it is avaliable, as otherwise we would have the train gain the benefits on all electrified tracks. If it however isn't avaliable we still want to know if the track is electrified which is why we have the second part.

<code>railtype_available("SAAA") ? tile_powers_railtype("SAAA") : (tile_powers_railtype("SAAE") || tile_powers_railtype("ELRL"))</code>

==Rack rail==
There are two different types of rack rail engines, pure rack and rack and adhesion. Pure rack engines may only move on tracks fitted with racks (xRxx) whilst rack and adhesion engines may also move on regular tracks but at a lower tractive effort.

Rack rail is currently implemented in the speed class as a "special type", this is unfurtunate as the speed class would otherwise be trackset private.

===Alternative 1===

====Pure rack engines====
These engines should use *R** as label. A trackset could then prevent these trains from traversing *A** tracks.

====Rack and adhesion engines====
These engines should use *A** as label and test for *R** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. This assumes the trackset will allow *A** on *R**.

====Issues====
*Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.
*French Narrow Gauge Trains Set uses NRAN for rack and adhesion engines so tracksets can not support it as intended and pure rack systems at the same time.

===Alternative 2===

====Pure rack engines====
These engines should use *r** (not in scheme) as label. A trackset would then prevent these trains from traversing *A** tracks but allow them on *R**.

====Rack and adhesion engines====
These engines should use *R** as label and test for *r** using [https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Vehicles#Track-type_test_against_another_track-type_.2863.29 var 63] or [https://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Variables_that_require_an_argument NML tile_powers_railtype]. Tracksets will allow *R** on *A** and *r**.

====Issues====
*Requires more track types than alternative 1.

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Multi-voltage extensions==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Maglev extensions==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS and the Maglev Track Set which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback
|-
|S ||Maglevs that use a synchronous linear motor ||N/A
|-
|I ||Maglevs that use a linear induction motor || N/A
|}

==JP+ extensions==
These are extensions to the gauge and energy source type classes currently supported by JP+ tracks and used by JP+ train sets.
===Rail System/Gauge [X***]===
{|
! !!Track type/gauge !!Vehicle set fallback
|-
|s ||Scotch gauge || S
|-
|_ ||Universal || N/A
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback
|-
|I ||Linear induction motor || D
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

'''CURRENTLY NOT IMPLEMENTED AND MOSTLY NOT OF VALUE'''

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), or 16 in (406 mm)]
|-
|2 ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge. Use this if you don't mind gameplay abstractions but don't want physically impossible combinations (e.g. rail, monorail and maglev cannot have any level crossings with each other). Specifically, this accommodates B (ultrabroad), g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm).
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use if you want to provide a cheaper alternative to X that doesn't support fictional "supertrain" gauges.
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), and R (1000 mm). Use with minus (<nowiki>-</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use with plus (<nowiki>+</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|4 (Formerly d) ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

====Axle Loads by Real World Implementation====
The table below is compatible with those above but functions differently than the ones above. It assumes that, in lieu of a train set that has ever implemented "d" as an axle weight, that instead "4" be used and a "3" placed between C and D for similar reasons. All the same classes are listed, however axle weight guidelines have been run by a research LLM which suggested different ranges of weight and different dates of availability. 4 is identical to d in practice. If "d" is not defined as a lighter axle weight than "c", then **4* should be used alongside it in an alternative_tracktype_list for any **D** track type with axle weight "D". If "d" is defined as a lighter axle weight than "c", only tracktypes with axle weight "4" (**4*) should be listed in the alternative_tracktype list for any **D* tracktype.

Use **4* on all applicable rolling stock going forward, and rely on track sets to define "d" for vehicle sets.

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||5 metric tonnes (5000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||10 metric tonnes (10000kg) per axle; Because reserved by examples || style="text-align:right;"|~1820 (Focused on carrying capacity over speed)
|-
|A ||Very Low (2012 OG Default)||15 metric tonnes (15000kg) per axle || style="text-align:right;"|~1870
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|~1890
|-
|C ||Medium ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|~1910
|-
|3 ||Medium, lightweight "FLEXX Eco" and "FLEXX Eco Commuter" bogies ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|2001 (FLEXX Eco)
|-
|D ||High ||31 metric tonnes (31000kg) per axle || style="text-align:right;"|~1930
|-
|4 (Formerly d) ||High, extra-lean "DYNAFREIGHT" and "FLEXX Eco Regional" bogies ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|2016 (FLEXX Eco, Regional var.)
|-
|E ||Very High ||40 metric tonnes (40000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|1988
|-
|F ||Fortescue/Future-proofed ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|2008
|}

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|<nowiki>+</nowiki> ||750v DC catenary ||U, then E ||
|-
|6 ||600v DC catenary ||U, then E||
|-
|z ||Atypical catenary voltage ||U, then E
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}

Standardized Railtype Scheme

2025-06-08T13:22:18Z

Brickblock1: Add link to separete extensions page

Standardized Railtype Scheme extensions

2025-06-08T13:19:02Z

Brickblock1: /* Possible additions */

Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Extended multivoltage support addition==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Extended maglev support addition==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS and the Maglev Track Set which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback
|-
|S ||Maglevs that use a synchronous linear motor ||N/A
|-
|I ||Maglevs that use a linear induction motor || N/A
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

'''CURRENTLY NOT IMPLEMENTED AND MOSTLY NOT OF VALUE'''

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), or 16 in (406 mm)]
|-
|2 ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge. Use this if you don't mind gameplay abstractions but don't want physically impossible combinations (e.g. rail, monorail and maglev cannot have any level crossings with each other). Specifically, this accommodates B (ultrabroad), g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm).
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use if you want to provide a cheaper alternative to X that doesn't support fictional "supertrain" gauges.
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), and R (1000 mm). Use with minus (<nowiki>-</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use with plus (<nowiki>+</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|4 (Formerly d) ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

====Axle Loads by Real World Implementation====
The table below is compatible with those above but functions differently than the ones above. It assumes that, in lieu of a train set that has ever implemented "d" as an axle weight, that instead "4" be used and a "3" placed between C and D for similar reasons. All the same classes are listed, however axle weight guidelines have been run by a research LLM which suggested different ranges of weight and different dates of availability. 4 is identical to d in practice. If "d" is not defined as a lighter axle weight than "c", then **4* should be used alongside it in an alternative_tracktype_list for any **D** track type with axle weight "D". If "d" is defined as a lighter axle weight than "c", only tracktypes with axle weight "4" (**4*) should be listed in the alternative_tracktype list for any **D* tracktype.

Use **4* on all applicable rolling stock going forward, and rely on track sets to define "d" for vehicle sets.

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||5 metric tonnes (5000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||10 metric tonnes (10000kg) per axle; Because reserved by examples || style="text-align:right;"|~1820 (Focused on carrying capacity over speed)
|-
|A ||Very Low (2012 OG Default)||15 metric tonnes (15000kg) per axle || style="text-align:right;"|~1870
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|~1890
|-
|C ||Medium ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|~1910
|-
|3 ||Medium, lightweight "FLEXX Eco" and "FLEXX Eco Commuter" bogies ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|2001 (FLEXX Eco)
|-
|D ||High ||31 metric tonnes (31000kg) per axle || style="text-align:right;"|~1930
|-
|4 (Formerly d) ||High, extra-lean "DYNAFREIGHT" and "FLEXX Eco Regional" bogies ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|2016 (FLEXX Eco, Regional var.)
|-
|E ||Very High ||40 metric tonnes (40000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|1988
|-
|F ||Fortescue/Future-proofed ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|2008
|}

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|<nowiki>+</nowiki> ||750v DC catenary ||U, then E ||
|-
|6 ||600v DC catenary ||U, then E||
|-
|z ||Atypical catenary voltage ||U, then E
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}

Standardized Railtype Scheme extensions

2025-06-08T13:16:28Z

Brickblock1: /* Extended maglev support addition */

Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Extended multivoltage support addition==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Extended maglev support addition==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS and the Maglev Track Set which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Vehicle set fallback
|-
|S ||Maglevs that use a synchronous linear motor ||N/A
|-
|I ||Maglevs that use a linear induction motor || N/A
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), or 16 in (406 mm)]
|-
|2 ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge. Use this if you don't mind gameplay abstractions but don't want physically impossible combinations (e.g. rail, monorail and maglev cannot have any level crossings with each other). Specifically, this accommodates B (ultrabroad), g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm).
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use if you want to provide a cheaper alternative to X that doesn't support fictional "supertrain" gauges.
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), and R (1000 mm). Use with minus (<nowiki>-</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use with plus (<nowiki>+</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|4 (Formerly d) ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

====Axle Loads by Real World Implementation====
The table below is compatible with those above but functions differently than the ones above. It assumes that, in lieu of a train set that has ever implemented "d" as an axle weight, that instead "4" be used and a "3" placed between C and D for similar reasons. All the same classes are listed, however axle weight guidelines have been run by a research LLM which suggested different ranges of weight and different dates of availability. 4 is identical to d in practice. If "d" is not defined as a lighter axle weight than "c", then **4* should be used alongside it in an alternative_tracktype_list for any **D** track type with axle weight "D". If "d" is defined as a lighter axle weight than "c", only tracktypes with axle weight "4" (**4*) should be listed in the alternative_tracktype list for any **D* tracktype.

Use **4* on all applicable rolling stock going forward, and rely on track sets to define "d" for vehicle sets.

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||5 metric tonnes (5000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||10 metric tonnes (10000kg) per axle; Because reserved by examples || style="text-align:right;"|~1820 (Focused on carrying capacity over speed)
|-
|A ||Very Low (2012 OG Default)||15 metric tonnes (15000kg) per axle || style="text-align:right;"|~1870
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|~1890
|-
|C ||Medium ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|~1910
|-
|3 ||Medium, lightweight "FLEXX Eco" and "FLEXX Eco Commuter" bogies ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|2001 (FLEXX Eco)
|-
|D ||High ||31 metric tonnes (31000kg) per axle || style="text-align:right;"|~1930
|-
|4 (Formerly d) ||High, extra-lean "DYNAFREIGHT" and "FLEXX Eco Regional" bogies ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|2016 (FLEXX Eco, Regional var.)
|-
|E ||Very High ||40 metric tonnes (40000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|1988
|-
|F ||Fortescue/Future-proofed ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|2008
|}

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|<nowiki>+</nowiki> ||750v DC catenary ||U, then E ||
|-
|6 ||600v DC catenary ||U, then E||
|-
|z ||Atypical catenary voltage ||U, then E
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}

Standardized Railtype Scheme extensions

2025-06-08T13:15:10Z

Brickblock1: /* Energy source type class [***X] */ Only include the ones in (F)RIMS

Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Extended multivoltage support addition==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Extended maglev support addition==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS and the Maglev Track Set which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Fallback
|-
|S ||Maglevs that use a synchronous linear motor ||N/A
|-
|I ||Maglevs that use a linear induction motor || N/A
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), or 16 in (406 mm)]
|-
|2 ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge. Use this if you don't mind gameplay abstractions but don't want physically impossible combinations (e.g. rail, monorail and maglev cannot have any level crossings with each other). Specifically, this accommodates B (ultrabroad), g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm).
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use if you want to provide a cheaper alternative to X that doesn't support fictional "supertrain" gauges.
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), and R (1000 mm). Use with minus (<nowiki>-</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use with plus (<nowiki>+</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|4 (Formerly d) ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

====Axle Loads by Real World Implementation====
The table below is compatible with those above but functions differently than the ones above. It assumes that, in lieu of a train set that has ever implemented "d" as an axle weight, that instead "4" be used and a "3" placed between C and D for similar reasons. All the same classes are listed, however axle weight guidelines have been run by a research LLM which suggested different ranges of weight and different dates of availability. 4 is identical to d in practice. If "d" is not defined as a lighter axle weight than "c", then **4* should be used alongside it in an alternative_tracktype_list for any **D** track type with axle weight "D". If "d" is defined as a lighter axle weight than "c", only tracktypes with axle weight "4" (**4*) should be listed in the alternative_tracktype list for any **D* tracktype.

Use **4* on all applicable rolling stock going forward, and rely on track sets to define "d" for vehicle sets.

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||5 metric tonnes (5000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||10 metric tonnes (10000kg) per axle; Because reserved by examples || style="text-align:right;"|~1820 (Focused on carrying capacity over speed)
|-
|A ||Very Low (2012 OG Default)||15 metric tonnes (15000kg) per axle || style="text-align:right;"|~1870
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|~1890
|-
|C ||Medium ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|~1910
|-
|3 ||Medium, lightweight "FLEXX Eco" and "FLEXX Eco Commuter" bogies ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|2001 (FLEXX Eco)
|-
|D ||High ||31 metric tonnes (31000kg) per axle || style="text-align:right;"|~1930
|-
|4 (Formerly d) ||High, extra-lean "DYNAFREIGHT" and "FLEXX Eco Regional" bogies ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|2016 (FLEXX Eco, Regional var.)
|-
|E ||Very High ||40 metric tonnes (40000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|1988
|-
|F ||Fortescue/Future-proofed ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|2008
|}

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|<nowiki>+</nowiki> ||750v DC catenary ||U, then E ||
|-
|6 ||600v DC catenary ||U, then E||
|-
|z ||Atypical catenary voltage ||U, then E
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}

Standardized Railtype Scheme extensions

2025-06-08T13:10:25Z

Brickblock1:

Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Extended multivoltage support addition==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Extended maglev support addition==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS and the Maglev Track Set which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Fallback !!Notes
|-
|S ||Maglevs that use a synchronous linear motor ||N/A ||
|-
|I ||Maglevs that use a linear induction motor || TCAI (the whole label) || If using SCMaglev/"Vanilla" maglev then add MGLV (the whole label) as an extra fallback.
|-
|V ||Vactrains/Hyperloop ||t, then I || If using SCMaglev/"Vanilla" maglev then add MGLV (the whole label) as an extra fallback. See proposed "universal tunnel" electrification below for the "t".
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), or 16 in (406 mm)]
|-
|2 ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge. Use this if you don't mind gameplay abstractions but don't want physically impossible combinations (e.g. rail, monorail and maglev cannot have any level crossings with each other). Specifically, this accommodates B (ultrabroad), g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm).
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use if you want to provide a cheaper alternative to X that doesn't support fictional "supertrain" gauges.
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), and R (1000 mm). Use with minus (<nowiki>-</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use with plus (<nowiki>+</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|4 (Formerly d) ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

====Axle Loads by Real World Implementation====
The table below is compatible with those above but functions differently than the ones above. It assumes that, in lieu of a train set that has ever implemented "d" as an axle weight, that instead "4" be used and a "3" placed between C and D for similar reasons. All the same classes are listed, however axle weight guidelines have been run by a research LLM which suggested different ranges of weight and different dates of availability. 4 is identical to d in practice. If "d" is not defined as a lighter axle weight than "c", then **4* should be used alongside it in an alternative_tracktype_list for any **D** track type with axle weight "D". If "d" is defined as a lighter axle weight than "c", only tracktypes with axle weight "4" (**4*) should be listed in the alternative_tracktype list for any **D* tracktype.

Use **4* on all applicable rolling stock going forward, and rely on track sets to define "d" for vehicle sets.

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||5 metric tonnes (5000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||10 metric tonnes (10000kg) per axle; Because reserved by examples || style="text-align:right;"|~1820 (Focused on carrying capacity over speed)
|-
|A ||Very Low (2012 OG Default)||15 metric tonnes (15000kg) per axle || style="text-align:right;"|~1870
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|~1890
|-
|C ||Medium ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|~1910
|-
|3 ||Medium, lightweight "FLEXX Eco" and "FLEXX Eco Commuter" bogies ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|2001 (FLEXX Eco)
|-
|D ||High ||31 metric tonnes (31000kg) per axle || style="text-align:right;"|~1930
|-
|4 (Formerly d) ||High, extra-lean "DYNAFREIGHT" and "FLEXX Eco Regional" bogies ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|2016 (FLEXX Eco, Regional var.)
|-
|E ||Very High ||40 metric tonnes (40000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|1988
|-
|F ||Fortescue/Future-proofed ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|2008
|}

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|<nowiki>+</nowiki> ||750v DC catenary ||U, then E ||
|-
|6 ||600v DC catenary ||U, then E||
|-
|z ||Atypical catenary voltage ||U, then E
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}

Standardized Railtype Scheme

2025-06-08T13:09:49Z

Brickblock1:

Standardized Railtype Scheme extensions

2025-06-08T13:06:04Z

Brickblock1: Create page

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Extended multivoltage support addition==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Extended maglev support addition==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS and the Maglev Track Set which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Fallback !!Notes
|-
|S ||Maglevs that use a synchronous linear motor ||N/A ||
|-
|I ||Maglevs that use a linear induction motor || TCAI (the whole label) || If using SCMaglev/"Vanilla" maglev then add MGLV (the whole label) as an extra fallback.
|-
|V ||Vactrains/Hyperloop ||t, then I || If using SCMaglev/"Vanilla" maglev then add MGLV (the whole label) as an extra fallback. See proposed "universal tunnel" electrification below for the "t".
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), or 16 in (406 mm)]
|-
|2 ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge. Use this if you don't mind gameplay abstractions but don't want physically impossible combinations (e.g. rail, monorail and maglev cannot have any level crossings with each other). Specifically, this accommodates B (ultrabroad), g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm).
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use if you want to provide a cheaper alternative to X that doesn't support fictional "supertrain" gauges.
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow. Specifically, this accommodates g (2140 mm), V (1600mm), S (1435 mm), and R (1000 mm). Use with minus (<nowiki>-</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow. Specifically, this accommodates V (1600mm), S (1435 mm), R (1000 mm), and n (600 mm). Use with plus (<nowiki>+</nowiki>) if you want to give a bit of a puzzle to players over how to design a network limited by a "one or the other" pair of railtypes.
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|4 (Formerly d) ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

====Axle Loads by Real World Implementation====
The table below is compatible with those above but functions differently than the ones above. It assumes that, in lieu of a train set that has ever implemented "d" as an axle weight, that instead "4" be used and a "3" placed between C and D for similar reasons. All the same classes are listed, however axle weight guidelines have been run by a research LLM which suggested different ranges of weight and different dates of availability. 4 is identical to d in practice. If "d" is not defined as a lighter axle weight than "c", then **4* should be used alongside it in an alternative_tracktype_list for any **D** track type with axle weight "D". If "d" is defined as a lighter axle weight than "c", only tracktypes with axle weight "4" (**4*) should be listed in the alternative_tracktype list for any **D* tracktype.

Use **4* on all applicable rolling stock going forward, and rely on track sets to define "d" for vehicle sets.

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||5 metric tonnes (5000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||10 metric tonnes (10000kg) per axle; Because reserved by examples || style="text-align:right;"|~1820 (Focused on carrying capacity over speed)
|-
|A ||Very Low (2012 OG Default)||15 metric tonnes (15000kg) per axle || style="text-align:right;"|~1870
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|~1890
|-
|C ||Medium ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|~1910
|-
|3 ||Medium, lightweight "FLEXX Eco" and "FLEXX Eco Commuter" bogies ||26 metric tonnes (26000kg) per axle || style="text-align:right;"|2001 (FLEXX Eco)
|-
|D ||High ||31 metric tonnes (31000kg) per axle || style="text-align:right;"|~1930
|-
|4 (Formerly d) ||High, extra-lean "DYNAFREIGHT" and "FLEXX Eco Regional" bogies ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|2016 (FLEXX Eco, Regional var.)
|-
|E ||Very High ||40 metric tonnes (40000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|1988
|-
|F ||Fortescue/Future-proofed ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|2008
|}

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|<nowiki>+</nowiki> ||750v DC catenary ||U, then E ||
|-
|6 ||600v DC catenary ||U, then E||
|-
|z ||Atypical catenary voltage ||U, then E
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}

Standardized Railtype Scheme

2025-06-08T13:05:50Z

Brickblock1: Mostly restore the scheme

Action0/Global Settings

2025-05-24T14:39:44Z

Brickblock1: /* Roadtype translation table (16) */

== Introduction ==

Global variables can be set in one of two ways. (This) action 0 using feature 8, or [[ActionD|Action D]]. Variables in arrays will usually be set using an action 0, whereas action D will most commonly set single variables.

In addition to global variables, this action can also set some general grf-specific variables.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 40}}||Cost base multipliers
|-
|09||D||{{ottdp|0.6|2.5|ttdprev=alpha 66}}||Cargo translation table
|-
|0A||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency display names
|-
|0B||D||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency multipliers
|-
|0C||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency options
|-
|0D,0E||D||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency symbols
|-
|0F||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Euro introduction dates
|-
|10||12*32*B||{{ottdp|0.6|2.5|ttdprev=alpha 74}}||Snow line height table
|-
|11||2*D||{{ottdp|0.7|no|ottdrev=r12924}}||GRFID overrides for engines
|-
|12||D||{{ottdp|0.7|no|ottdrev=r15417}}||Railtype translation table
|-
|13,14||V||{{ottdp|1.1|no|ottdrev=r21208}} {{grfFrom|7}}||Gender/case translation table
|-
|15||B||{{ottdp|1.1|no|ottdrev=r21216}} {{grfFrom|7}}||Plural form
|-
|16,17||D||{{ottdp|1.10|no}}||Road-/tramtype translation table
|-
|18||S||{{ottdp|15}}||Badge translation table
|}

== Descriptions ==

=== Cost base multipliers (08) ===

TTD has 49 [[BaseCosts|base costs]] (66 in OpenTTD currently) which govern how much everything costs. Each cost is calculated from a (fixed) factor times the base cost, which is adjusted by inflation every month.

Setting this property allows changing these base costs by factors of two. The default value of the property is 08 which leaves the base cost unchanged. Adding one to the property doubles the base cost, subtracting one halves it.

Using math: NewBaseCost = OldBaseCost * 2^(n-8), where n is the value of property 08.

Modifying the base costs incurs a small rounding error every time the game is saved, because the costs have to be set back to the default in the savegame. However, this error is unnoticable until many years of inflation have passed and should therefore be of little concern.

{{ottdp|1.0|no}} In OpenTTD rounding happens towards 1 or -1 depending on the old base cost; i.e. if the old base cost is positive round towards 1, if negative round towards -1. This prevents the base cost to be zero.

=== Cargo translation table (09) ===

To aid with coding vehicle grf files that wish to support more than the standard cargo types, the easiest way is to install a cargo translation table using this property.

The cargo translation table is a list of [[Action0Cargos#Cargo label 17|cargo labels]]. Each entry means that the corresponding cargo is meant when using this ID in an [[Action3|action 3]] or for a bit in the vehicle's refit mask.

In other words, if for example the fourth entry (number 03) in the list is "MAIL", then defining graphics for cargo 03 will define graphics for mail, and bit 3 in the refit mask will be for mail as well.

This way, the vehicle grf file doesn't need to know or care which cargo slot and cargo bit a certain cargo type uses, it can define its own ID for each cargo that it wishes to support, and thus be independent of both what cargo types are really available in the game and what slots/bits they use.

Because the refit mask contains only 32 bits, only the first 32 entries in the translation table can make use of the refit mask. Other cargo types have to be added via the cargo classes, so put the cargos that need exceptions to the cargo class based refitting first so that they can go in the refit mask.

Note that this property cannot be set incrementally, you must set all types in a single action 0 starting from ID 0.

See below for an example.

==== Example ====

// Cargo translation table
1 * 169 00 08 01 29 00 09
"COAL" "WATR" "RUBB" "MAIL" "OIL_" // 0-4
"LVST" "GOOD" "CERE" "GRAN" "WHET" // 5-9
"MAIZ" "WOOD" "WODT" "IORE" "CORE" // 10-14
"STEL" "PLAS" "VALU" "GOLD" "DIAM" // 15-19
"PAPR" "FOOD" "FRUT" "FISH" "WOOL" // 20-24
"POTA" "SAND" "GLAS" "WDPR" "DYES" // 25-29
"FERT" "OLSD" "RFPR" "VEHI" "PETR" // 30-34
"BRCK" "SULP" "CMNT" "FICR" "LIME" // 35-39
"MILK" // 40
// Train wagon that has special graphics for grain (8),
// wheat (9), maize (10) and cereals (7)
2 * 29 03 00 01 1B 04
08 <grain-cid> 09 <wheat-cid> 0A <maize-cid>
07 <cereals-cid> <default-cid>
// Train wagon that has graphics for water (1), rubber (2),
// oil (4), petrol (34) and milk (40)
3 * 31 03 00 01 1C 05
01 <water-cid> 02 <rubber-cid> 04 <oil-cid>
22 <petrol-cid> 28 <milk-cid> <default-cid>

=== Currency display names (0A) ===
This and the following properties can be used to modify currencies. Each of them can have IDs 0-18 (decimal), the IDs being ordered the same as in the Currency drop-down list.

This property allows changing currency names that are displayed in the Currency drop-down in the Game Options window. This property is a textID, and if you need to supply your own text, it must be a DCxx one.

=== Currency multipliers (0B) ===

The equivalent of 1 British pound in this currency, multiplied by 1000. For example, 1 GBP=2 USD, so this should be 2000 for US dollars. The multiplication by 1000 allows you to have decimals in the multiplier without requiring floating-point calculations. This value is used for display purposes only, TTD always uses British pounds for internal calculations.

=== Currency options (0C) ===

The low byte of this word specifies the thousands separator to be used for this currency ( usually dot "." or comma ","). The high byte should be zero if the currency symbol should be in front of the number ($123,456) and should be 1 if the currency symbol should be shown after the number (123,456$). The symbol placement can be overridden by the TTDPatch settings.

=== Currency symbols (0D,0E) ===

These doublewords are interpreted as a string of up to 4 characters. If you need fewer characters, the remaining bytes should be zero. Property 0D is printed before the number, property 0E is printed after the number. These two usually differ only if the symbol is separated by a space from the number (for example, "$ " vs. " $"). You should specify both properties since the player can override your preferred symbol placement.

=== Euro introduction dates (0F) ===

This value allows you to have Euro introduced instead the currency at a given time. If this value is zero, the currency is never substituted with the Euro (USD, for example). If it's nonzero, it gives the year when the currency is replaced by Euro (for example, 2002 for DM).

=== Snow line height table (10) ===

This property allows you to specify the snow line height for every day of the year. The only ID you can set is 0, and the value must be 12*32=384 bytes long. To simplify things for the patch, every month has 32 entries, and the impossible combinations (like 32th January or 31th April) will never be read.

{{grfTill|7}} For GRF version 7 and below: The values should be multiple of 8 between 10h and 88h.
Values below 10h and above EFh may result in overflow and should not be used. Since the highest possible land is 78h high, giving 88h or above will effectively disable the snow line.

{{grfFrom|8}} For GRF version 8 and above: The values can be any value between 0 and FFh.
FF means 'no snow'; other values are scaled to the number of possible heightlevels of the map.

{{ottdp|no|2.5}} If the temperate snow line is enabled, this table applies on temperate as well.

'''WARNING:''' Some code in TTD assumes that the snow line will remain constant: Some industries are built only above/below snowline and assume that the snow line won't move when they're already built. Similarly, snowy houses on arctic will still appear snowy even when the snow disappears around them. If you want to use this feature, make sure to counter these effects by overriding arctic houses and industries with snow-aware versions.

=== GRFID overrides for engines (11) ===

Allows you to provide a list of 'source' and 'target' GRFIDs to let vehicles in the source GRF override those in the target GRF, when dynamic engines is enabled. Each entry is 8 bytes, containing two GRFIDs. Multiple entries can be used, and different GRFs can be set to override the same 'target' GRF, but only the last instance of a 'source' GRF is active. GRFIDs that are not present will have no effect.

The scope of this feature is quite limited and it should be used only for sets that modify data of another set, for example the DBSetXL ECS addon for DBSetXL, or the censored version of LV4.

=== Railtype translation table (12) ===

Provides ability to specify railtypes via a translation table, similar to using a cargo translation table. Each railtype label is a DWord. The default labels are RAIL, ELRL, MONO and MGLV. If a table is installed, then changing engine traction type will not affect the railtype.

Note that labels are not shared between features, so the same label can be used for multiple items. For example, the label "RAIL" can be used for a railtype, roadtype, tramtype, and cargotype simultaneously without conflict.

=== Gender/case translation table (13,14) ===

Provides ability to specify genders or cases via a translation table. These map NewGRF internal IDs for the genders or cases to the genders or cases as defined in OpenTTD's language files so NewGRF strings and OpenTTD strings can interact on eachother's gender or cases. Property 13 is for mapping genders whereas property 14 is for mapping cases.

The ID used for these translation tables is the Action 4 (GRF version 7 or higher) language-id, i.e. this mapping only works with GRF version 7 or higher. Language-id 7F (any) is not allowed. You can can define an ID multiple times in which case the new mappings are simply appended to the already known mappings.

The format is simply a 00 terminated list of mappings:

(<id> <name>)+ 00

{| |-
!Size!!Name!!Meaning
|-
|B||id||NewGRF internal ID for the gender or case name, may not be 00
|-
|V||name||A 00 terminated string with the gender or case name as in OpenTTD's translation
|}

An NewGRF internal ID may be mapped multiple times for the same language as may an OpenTTD gender or case name be (reverse) mapped multiple times. This can be used for coping with OpenTTD translators adding or removing genders or cases over time. The NewGRF internal ID may not be 00 as this ID will be used in the Action 4 strings which may not contain 00 except for terminating the string.

These mappings are used for [[StringCodes]] 9A 0E, 9A 0F, 9A 13 and 9A 14. How the mapping is used precisely can be found there.

=== Plural form (15) ===

Defines the plural form for a language. The ID used is the Action 4 (GRF version 7 or higher) language-id, i.e. this only works with GRF version 7 or higher. Language-id 7F (any) is not allowed. More information about the different valid plural forms can be found on the [[StringCodes]] page. This property is used for [[StringCodes|StringCode]] 9A 15.

=== Roadtype translation table (16) ===

Provides ability to specify roadtypes via a translation table, similar to using a cargo translation table. Each roadtype label is a DWord. The default labels are ROAD.

Note that labels are not shared between features, so the same label can be used for multiple items. For example, the label "RAIL" can be used for a railtype, roadtype, tramtype, and cargotype simultaneously without conflict.

=== Tramtype translation table (17) ===

Provides ability to specify tramtypes via a translation table, similar to using a cargo translation table. Each tramtype label is a DWord. The default labels is ELRL.

Note that labels are not shared between features, so the same label can be used for multiple items. For example, the label "RAIL" can be used for a railtype, roadtype, tramtype, and cargotype simultaneously without conflict.

=== Badge translation table (18) ===

Required to allow badges to be assigned to other items. Each badge translation table entry is zero-terminated string corresponding to the badge's label.

Unlike the other DWord label systems, a badge listed in a translation will automatically be created if it is not otherwise provided, and is fully usable internally.

Action0/Global Settings

2025-05-24T14:39:14Z

Brickblock1: /* Tramtype translation table (17) */ RAIL is not provided by the game

== Introduction ==

Global variables can be set in one of two ways. (This) action 0 using feature 8, or [[ActionD|Action D]]. Variables in arrays will usually be set using an action 0, whereas action D will most commonly set single variables.

In addition to global variables, this action can also set some general grf-specific variables.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 40}}||Cost base multipliers
|-
|09||D||{{ottdp|0.6|2.5|ttdprev=alpha 66}}||Cargo translation table
|-
|0A||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency display names
|-
|0B||D||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency multipliers
|-
|0C||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency options
|-
|0D,0E||D||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency symbols
|-
|0F||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Euro introduction dates
|-
|10||12*32*B||{{ottdp|0.6|2.5|ttdprev=alpha 74}}||Snow line height table
|-
|11||2*D||{{ottdp|0.7|no|ottdrev=r12924}}||GRFID overrides for engines
|-
|12||D||{{ottdp|0.7|no|ottdrev=r15417}}||Railtype translation table
|-
|13,14||V||{{ottdp|1.1|no|ottdrev=r21208}} {{grfFrom|7}}||Gender/case translation table
|-
|15||B||{{ottdp|1.1|no|ottdrev=r21216}} {{grfFrom|7}}||Plural form
|-
|16,17||D||{{ottdp|1.10|no}}||Road-/tramtype translation table
|-
|18||S||{{ottdp|15}}||Badge translation table
|}

== Descriptions ==

=== Cost base multipliers (08) ===

TTD has 49 [[BaseCosts|base costs]] (66 in OpenTTD currently) which govern how much everything costs. Each cost is calculated from a (fixed) factor times the base cost, which is adjusted by inflation every month.

Setting this property allows changing these base costs by factors of two. The default value of the property is 08 which leaves the base cost unchanged. Adding one to the property doubles the base cost, subtracting one halves it.

Using math: NewBaseCost = OldBaseCost * 2^(n-8), where n is the value of property 08.

Modifying the base costs incurs a small rounding error every time the game is saved, because the costs have to be set back to the default in the savegame. However, this error is unnoticable until many years of inflation have passed and should therefore be of little concern.

{{ottdp|1.0|no}} In OpenTTD rounding happens towards 1 or -1 depending on the old base cost; i.e. if the old base cost is positive round towards 1, if negative round towards -1. This prevents the base cost to be zero.

=== Cargo translation table (09) ===

To aid with coding vehicle grf files that wish to support more than the standard cargo types, the easiest way is to install a cargo translation table using this property.

The cargo translation table is a list of [[Action0Cargos#Cargo label 17|cargo labels]]. Each entry means that the corresponding cargo is meant when using this ID in an [[Action3|action 3]] or for a bit in the vehicle's refit mask.

In other words, if for example the fourth entry (number 03) in the list is "MAIL", then defining graphics for cargo 03 will define graphics for mail, and bit 3 in the refit mask will be for mail as well.

This way, the vehicle grf file doesn't need to know or care which cargo slot and cargo bit a certain cargo type uses, it can define its own ID for each cargo that it wishes to support, and thus be independent of both what cargo types are really available in the game and what slots/bits they use.

Because the refit mask contains only 32 bits, only the first 32 entries in the translation table can make use of the refit mask. Other cargo types have to be added via the cargo classes, so put the cargos that need exceptions to the cargo class based refitting first so that they can go in the refit mask.

Note that this property cannot be set incrementally, you must set all types in a single action 0 starting from ID 0.

See below for an example.

==== Example ====

// Cargo translation table
1 * 169 00 08 01 29 00 09
"COAL" "WATR" "RUBB" "MAIL" "OIL_" // 0-4
"LVST" "GOOD" "CERE" "GRAN" "WHET" // 5-9
"MAIZ" "WOOD" "WODT" "IORE" "CORE" // 10-14
"STEL" "PLAS" "VALU" "GOLD" "DIAM" // 15-19
"PAPR" "FOOD" "FRUT" "FISH" "WOOL" // 20-24
"POTA" "SAND" "GLAS" "WDPR" "DYES" // 25-29
"FERT" "OLSD" "RFPR" "VEHI" "PETR" // 30-34
"BRCK" "SULP" "CMNT" "FICR" "LIME" // 35-39
"MILK" // 40
// Train wagon that has special graphics for grain (8),
// wheat (9), maize (10) and cereals (7)
2 * 29 03 00 01 1B 04
08 <grain-cid> 09 <wheat-cid> 0A <maize-cid>
07 <cereals-cid> <default-cid>
// Train wagon that has graphics for water (1), rubber (2),
// oil (4), petrol (34) and milk (40)
3 * 31 03 00 01 1C 05
01 <water-cid> 02 <rubber-cid> 04 <oil-cid>
22 <petrol-cid> 28 <milk-cid> <default-cid>

=== Currency display names (0A) ===
This and the following properties can be used to modify currencies. Each of them can have IDs 0-18 (decimal), the IDs being ordered the same as in the Currency drop-down list.

This property allows changing currency names that are displayed in the Currency drop-down in the Game Options window. This property is a textID, and if you need to supply your own text, it must be a DCxx one.

=== Currency multipliers (0B) ===

The equivalent of 1 British pound in this currency, multiplied by 1000. For example, 1 GBP=2 USD, so this should be 2000 for US dollars. The multiplication by 1000 allows you to have decimals in the multiplier without requiring floating-point calculations. This value is used for display purposes only, TTD always uses British pounds for internal calculations.

=== Currency options (0C) ===

The low byte of this word specifies the thousands separator to be used for this currency ( usually dot "." or comma ","). The high byte should be zero if the currency symbol should be in front of the number ($123,456) and should be 1 if the currency symbol should be shown after the number (123,456$). The symbol placement can be overridden by the TTDPatch settings.

=== Currency symbols (0D,0E) ===

These doublewords are interpreted as a string of up to 4 characters. If you need fewer characters, the remaining bytes should be zero. Property 0D is printed before the number, property 0E is printed after the number. These two usually differ only if the symbol is separated by a space from the number (for example, "$ " vs. " $"). You should specify both properties since the player can override your preferred symbol placement.

=== Euro introduction dates (0F) ===

This value allows you to have Euro introduced instead the currency at a given time. If this value is zero, the currency is never substituted with the Euro (USD, for example). If it's nonzero, it gives the year when the currency is replaced by Euro (for example, 2002 for DM).

=== Snow line height table (10) ===

This property allows you to specify the snow line height for every day of the year. The only ID you can set is 0, and the value must be 12*32=384 bytes long. To simplify things for the patch, every month has 32 entries, and the impossible combinations (like 32th January or 31th April) will never be read.

{{grfTill|7}} For GRF version 7 and below: The values should be multiple of 8 between 10h and 88h.
Values below 10h and above EFh may result in overflow and should not be used. Since the highest possible land is 78h high, giving 88h or above will effectively disable the snow line.

{{grfFrom|8}} For GRF version 8 and above: The values can be any value between 0 and FFh.
FF means 'no snow'; other values are scaled to the number of possible heightlevels of the map.

{{ottdp|no|2.5}} If the temperate snow line is enabled, this table applies on temperate as well.

'''WARNING:''' Some code in TTD assumes that the snow line will remain constant: Some industries are built only above/below snowline and assume that the snow line won't move when they're already built. Similarly, snowy houses on arctic will still appear snowy even when the snow disappears around them. If you want to use this feature, make sure to counter these effects by overriding arctic houses and industries with snow-aware versions.

=== GRFID overrides for engines (11) ===

Allows you to provide a list of 'source' and 'target' GRFIDs to let vehicles in the source GRF override those in the target GRF, when dynamic engines is enabled. Each entry is 8 bytes, containing two GRFIDs. Multiple entries can be used, and different GRFs can be set to override the same 'target' GRF, but only the last instance of a 'source' GRF is active. GRFIDs that are not present will have no effect.

The scope of this feature is quite limited and it should be used only for sets that modify data of another set, for example the DBSetXL ECS addon for DBSetXL, or the censored version of LV4.

=== Railtype translation table (12) ===

Provides ability to specify railtypes via a translation table, similar to using a cargo translation table. Each railtype label is a DWord. The default labels are RAIL, ELRL, MONO and MGLV. If a table is installed, then changing engine traction type will not affect the railtype.

Note that labels are not shared between features, so the same label can be used for multiple items. For example, the label "RAIL" can be used for a railtype, roadtype, tramtype, and cargotype simultaneously without conflict.

=== Gender/case translation table (13,14) ===

Provides ability to specify genders or cases via a translation table. These map NewGRF internal IDs for the genders or cases to the genders or cases as defined in OpenTTD's language files so NewGRF strings and OpenTTD strings can interact on eachother's gender or cases. Property 13 is for mapping genders whereas property 14 is for mapping cases.

The ID used for these translation tables is the Action 4 (GRF version 7 or higher) language-id, i.e. this mapping only works with GRF version 7 or higher. Language-id 7F (any) is not allowed. You can can define an ID multiple times in which case the new mappings are simply appended to the already known mappings.

The format is simply a 00 terminated list of mappings:

(<id> <name>)+ 00

{| |-
!Size!!Name!!Meaning
|-
|B||id||NewGRF internal ID for the gender or case name, may not be 00
|-
|V||name||A 00 terminated string with the gender or case name as in OpenTTD's translation
|}

An NewGRF internal ID may be mapped multiple times for the same language as may an OpenTTD gender or case name be (reverse) mapped multiple times. This can be used for coping with OpenTTD translators adding or removing genders or cases over time. The NewGRF internal ID may not be 00 as this ID will be used in the Action 4 strings which may not contain 00 except for terminating the string.

These mappings are used for [[StringCodes]] 9A 0E, 9A 0F, 9A 13 and 9A 14. How the mapping is used precisely can be found there.

=== Plural form (15) ===

Defines the plural form for a language. The ID used is the Action 4 (GRF version 7 or higher) language-id, i.e. this only works with GRF version 7 or higher. Language-id 7F (any) is not allowed. More information about the different valid plural forms can be found on the [[StringCodes]] page. This property is used for [[StringCodes|StringCode]] 9A 15.

=== Roadtype translation table (16) ===

Provides ability to specify roadtypes via a translation table, similar to using a cargo translation table. Each roadtype label is a DWord. The default labels are ROAD and ELRD.

Note that labels are not shared between features, so the same label can be used for multiple items. For example, the label "RAIL" can be used for a railtype, roadtype, tramtype, and cargotype simultaneously without conflict.

=== Tramtype translation table (17) ===

Provides ability to specify tramtypes via a translation table, similar to using a cargo translation table. Each tramtype label is a DWord. The default labels is ELRL.

Note that labels are not shared between features, so the same label can be used for multiple items. For example, the label "RAIL" can be used for a railtype, roadtype, tramtype, and cargotype simultaneously without conflict.

=== Badge translation table (18) ===

Required to allow badges to be assigned to other items. Each badge translation table entry is zero-terminated string corresponding to the badge's label.

Unlike the other DWord label systems, a badge listed in a translation will automatically be created if it is not otherwise provided, and is fully usable internally.

User:Brickblock1

2025-04-15T13:31:08Z

Brickblock1:

{| class="wikitable sortable"
|-
!nr !!litt !!lev. år !!leverantör !!ombyggd år !!anm.
|-
|851 ||Bp ||1961 ||ASJ(A) || ||Fd SJ Bop. "Skivpass". Omb. till manövervagn UBp 104 1985.
|-
|852 ||Bp ||1961 ||ASJ(A) || ||Fd SJ Bop. "Skivpass". Omb. till manövervagn BUp 100 1984.
|-
|853-857||Bp ||1961 ||ASJ(A) || ||Fd SJ Bop. "Skivpass". Omb. till manövervagnar UBp 103, 106. 102, 107 resp. 105 1985.
|-
|859 ||Bp ||1913 ||ASJ(L) ||1949 ||Fd SJ Bop, fd SRJ Co 22. Ur trafik 1988-93.
|-
|863 ||Bp ||1899 ||Atlas/ASJ(L) ||1947 ||Fd SJ Bop, fd SRJ Co 35. Ur trafik 1988-93.
|-
|868 ||Bp ||1906 ||Fole ||1941 ||Fd SJ Bop, fd SRJ Co 50. Ur trafik 1988-93.
|-
|876 ||Bp ||1908 ||Fole ||1945 ||Fd SJ Bop, fd SRJ Co 64. Ur trafik 1988-93.
|-
|878 ||Bp ||1911 ||Södertälje ||1944 ||Fd SJ Bop, fd SRJ Co 66. Ur trafik 1988-93.
|-
|879 ||Bp ||1911 ||Södertälje ||1945 ||Fd SJ Bop, fd SRJ Co 67. Ur trafik 1988-93.
|-
|880 ||Bp ||1914 ||ASEA || ||Öppna plattformar. Fd SJ Bop, fd SRJ Co 68 Museivagn (veterantåg) 1993.
|-
|886 ||Bp ||1920 ||Bautzen ||1948 ||Fd SJ Bop, fd SRJ Co 74. Ur trafik 1988-93.
|-
|887 ||Bp ||1920 ||Bautzen ||1953 ||Fd SJ Bop, fd SRJ Co 75. Ur trafik 1988-93.
|-
|888-889||Bp ||1920 ||Bautzen ||1952 ||Fd SJ Bop, fd SRJ Co 76-77. Ur trafik 1988-93.
|-
|890 ||Bp ||1921 ||Bautzen ||1953 ||Fd SJ Bop, fd SRJ Co 78. Ur trafik 1988-93.
|-
|891-893||Bp ||1921 ||Bautzen || ||Öppna plattformar. Fd SJ Bop, fd SRJ Co 79-81. Ur trafik 1988-93.
|-
|894 ||Bp ||1921 ||Bautzen ||1952 ||Fd SJ Bop, fd SRJ Co 82. Ur trafik 1988.
|-
|895-897||Bp ||1954 ||ASJ(L) || ||Fd SJ Bop, fd SRJ Co 83-85. Ur trafik 1988-93.
|-
|898-901||Bp ||1936 ||ASEA || ||Fd SJ Bop, fd SRJ Co 86-89. "Djursholmspass". Ur trafik 1988-92.
|-
|902-904||Bp ||1937 ||Bautzen ||1948 ||Fd SJ Bop, fd SRJ Co 90-92. Ur trafik 1988-93.
|-
|905-906||Bp ||1937 ||Bautzen ||1949 ||Fd SJ Bop, fd SRJ Co 93-94. Ur trafik 1988-93.
|-
|907 ||Bp ||1939 ||ASEA || ||Fd SJ Bop, fd SRJ Co 95. "Djursholmspass". Ur trafik 1988-93.
|-
|909-910||Bp ||1939 ||Bautzen || ||Öppna plattformar. Fd SJ Bop, fd SRJ Co 97-98. Ur trafik 1988-92.
|-
|911 ||Bp ||1954 ||ASJ(L) || ||Fd SJ Bop, fd SRJ Co 99. "Stålpass". Omb. till manövervagn UBp 118 1986.
|-
|912 ||Bp ||1954 ||ASJ(L) || ||Fd SJ Bop, fd SRJ Co 100. "Stålpass". Ur trafik 1988-93.
|-
|913-914||Bp ||1941 ||Bautzen || ||Fd SJ Bop, fd SRJ Co 101-102. "Bautzenpass". Ur trafik 1988-93.
|-
|915-916||Bp ||1941 ||Maskinverken || ||Fd SJ Bop, fd SRJ Co 103-104. "Södertäljepass". Ur trafik 1988-93.
|-
|917-918||Bp ||1943 ||Bautzen || ||Fd SJ Bop, fd SRJ Co 106-107. "Bautzenpass". Ur trafik 1988-93.
|-
|919-922||Bp ||1944 ||Bautzen || ||Fd SJ Bop, fd SRJ Co 108-111. "Bautzenpass". Ur trafik 1988-93.
|-
|923-925||Bp ||1948 ||ASJ(L) || ||Fd SJ Bop, fd SRJ Co 112-114. "Norrtäljepass". Ur trafik 1988-93.
|-
|926-930||Bp ||1949 ||ASJ(L) || ||Fd SJ Bop, fd SRJ Co 115-119. "Norrtäljepass". Ur trafik 1988-93.
|-
|931-940||Bp ||1956 ||ASJ(A) || ||Fd SJ Bop, fd SRJ Bo 120-129. "Stålpass". Omb. Till Manövervagnar UBp 113, 109, 111, 115, 117, 110, 108, 116, 114 resp. 112 1985-86.
|}
Grindvagn = wagon with open end

{| class="wikitable sortable"
! '''Litt'''
! '''Typ'''
! '''I trafik'''
! '''Ombyggd'''
! '''Omlittrerad'''
! '''Ny ägare'''
! '''Ur trafik'''
|-
| [[#A7 - A8|A7]]
| Sittvagn
| 1979
| [[#AB9|AB9]] & [[#B9|B9]] & [[#BFS9|BFS9]] (1994), [[#A11|A11]] (2001), [[#B7|B7A]] (2009)
|
| SSRT
|
|-
| [[#A11|A11]]
| Sittvagn
| 2001
|
|
|
|
|-
| [[#AB7|AB7]]
| Sittvagn
| 2009
|
|
|
|
|-
| [[#AB9|AB9]]
| Sittvagn
| 1994
| [[#AB7|AB7]] (2009)
|
|
| 2009
|-
| [[#B2R|B2R]]
| Sittvagn
| 1988
| [[#B10|B10]] (2001)
|
| SSRT
| 2003 (SJ)
|-
| [[#B4|B4]]
| Sitt- och resgodsvagn
| 1985
| BF7 (2010)
| BF4 (1994)
| SSRT
| 2010 (SJ BF4)
|-
| [[#B7|B7]]
| Sittvagn
| 1979
| [[#B7B|B8]] (1990), [[#AB9|AB9]] & [[#B9|B9]] & [[#BFS9|BFS9]] (1994), [[#B11|B11]] (2001), [[#BF8|BF8]] (2017)
|
| TÅGAB (2014)
|
|-
| [[#B7B|B7B]]
| Familjevagn
| 1990
| [[#BFS9|BFS9]] (1994), [[#B7|B7B]] (2009)
| B8
|
| 2010
|-
| [[#B9|B9]]
| Sittvagn
| 1994
| [[#B7|B7C]] (2009)
|
| SSRT
| 2010 (SJ)
|-
| [[#B10|B10]]
| Sittvagn
| 2001
|
|
|
| 2025
|-
| [[#B11|B11]]
| Sittvagn
| 2001
|
|
|
|
|-
| [[#BC4|BC4]]
| Liggvagn
| 1985
|
|
| SSRT (2001)
|
|-
| [[#BF8|BF8]]
| Sittvagn
| 2017
|
|
|
|
|-
| [[#BFS9|BFS9]]
| Sittvagn, kiosk
| 1994
| [[#RB7|RB7]] (2013)
|
|
|
|-
| [[#R4R|R4R]]
| Restaurangvagn
| 1987
| [[#S12|S12]] (1994), [[#RB11|RB11]] (2001)
|
|
|
|-
| [[#RB7|RB7]]
| Bistro- och lekvagn
| 2013
|
|
|
|
|-
| [[#RB11|RB11]]
| Bistrovagn
| 2001
|
|
|
|
|-
| [[#S1|S1]]
| Konferensvagn
| 1981
|
|
| Blå tåget (2014), TÅGAB (2014)
| 2014 (SJ)
|-
| [[#S4|S4]]
| Kontorsvagn
| 1986 (ASEA)
|
|
| SJ (1989)
| ?
|-
| [[#S12|S12]]
| Bistro- och biovagn
| 1994
|
|
|
|
|-
| [[#UA7R|UA7R]]
| Manövervagn
| 1988
|
| AF7X (1994), AFM7
|
| 2022
|-
| [[#WL4|WL4]]
| Sovvagn
| 1990
|
|
| SSRT (2001)
|
|-
| [[#WL6|WL6]]
| Sovvagn
| 1993
|
|
| SSRT (2001)
|
|-
|}

User:Brickblock1

2025-04-15T13:29:00Z

Brickblock1:

{| class="wikitable sortable"
|-
!nr !!litt !!lev. år !!leverantör !!ombyggd år !!anm.
|-
|851 ||Bp ||1961 ||ASJ(A) || ||Fd SJ Bop. "Skivpass". Omb. till manövervagn UBp 104 1985.
|-
|852 ||Bp ||1961 ||ASJ(A) || ||Fd SJ Bop. "Skivpass". Omb. till manövervagn BUp 100 1984.
|-
|853-857||Bp ||1961 ||ASJ(A) || ||Fd SJ Bop. "Skivpass". Omb. till manövervagnar UBp 103, 106. 102, 107 resp. 105 1985.
|-
|859 ||Bp ||1913 ||ASJ(L) ||1949 ||Fd SJ Bop, fd SRJ Co 22. Ur trafik 1988-93.
|-
|863 ||Bp ||1899 ||Atlas/ASJ(L) ||1947 ||Fd SJ Bop, fd SRJ Co 35. Ur trafik 1988-93.
|-
|868 ||Bp ||1906 ||Fole ||1941 ||Fd SJ Bop, fd SRJ Co 50. Ur trafik 1988-93.
|-
|876 ||Bp ||1908 ||Fole ||1945 ||Fd SJ Bop, fd SRJ Co 64. Ur trafik 1988-93.
|-
|878 ||Bp ||1911 ||Södertälje ||1944 ||Fd SJ Bop, fd SRJ Co 66. Ur trafik 1988-93.
|-
|879 ||Bp ||1911 ||Södertälje ||1945 ||Fd SJ Bop, fd SRJ Co 67. Ur trafik 1988-93.
|-
|880 ||Bp ||1914 ||ASEA || ||Öppna plattformar. Fd SJ Bop, fd SRJ Co 68 Museivagn (veterantåg) 1993.
|-
|886 ||Bp ||1920 ||Bautzen ||1948 ||Fd SJ Bop, fd SRJ Co 74. Ur trafik 1988-93.
|-
|887 ||Bp ||1920 ||Bautzen ||1953 ||Fd SJ Bop, fd SRJ Co 75. Ur trafik 1988-93.
|-
|888-889||Bp ||1920 ||Bautzen ||1952 ||Fd SJ Bop, fd SRJ Co 76-77. Ur trafik 1988-93.
|-
|890 ||Bp ||1921 ||Bautzen ||1953 ||Fd SJ Bop, fd SRJ Co 78. Ur trafik 1988-93.
|-
|891-893||Bp ||1921 ||Bautzen || ||Öppna plattformar. Fd SJ Bop, fd SRJ Co 79-81. Ur trafik 1988-93.
|-
|894 ||Bp ||1921 ||Bautzen ||1952 ||Fd SJ Bop, fd SRJ Co 82. Ur trafik 1988.
|-
|895-897||Bp ||1954 ||ASJ(L) || ||Fd SJ Bop, fd SRJ Co 83-85. Ur trafik 1988-93.
|-
|898-901||Bp ||1936 ||ASEA || ||Fd SJ Bop, fd SRJ Co 86-89. "Djursholmspass". Ur trafik 1988-92.
|-
|902-904||Bp ||1937 ||Bautzen ||1948 ||Fd SJ Bop, fd SRJ Co 90-92. Ur trafik 1988-93.
|-
|905-906||Bp ||1937 ||Bautzen ||1949 ||Fd SJ Bop, fd SRJ Co 93-94. Ur trafik 1988-93.
|-
|907 ||Bp ||1939 ||ASEA || ||Fd SJ Bop, fd SRJ Co 95. "Djursholmspass". Ur trafik 1988-93.
|-
|909-910||Bp ||1939 ||Bautzen || ||Öppna plattformar. Fd SJ Bop, fd SRJ Co 97-98. Ur trafik 1988-92.
|-
|911 ||Bp ||1954 ||ASJ(L) || ||Fd SJ Bop, fd SRJ Co 99. "Stålpass". Omb. till manövervagn UBp 118 1986.
|-
|912 ||Bp ||1954 ||ASJ(L) || ||Fd SJ Bop, fd SRJ Co 100. "Stålpass". Ur trafik 1988-93.
|-
|913-914||Bp ||1941 ||Bautzen || ||Fd SJ Bop, fd SRJ Co 101-102. "Bautzenpass". Ur trafik 1988-93.
|-
|915-916||Bp ||1941 ||Maskinverken || ||Fd SJ Bop, fd SRJ Co 103-104. "Södertäljepass". Ur trafik 1988-93.
|-
|917-918||Bp ||1943 ||Bautzen || ||Fd SJ Bop, fd SRJ Co 106-107. "Bautzenpass". Ur trafik 1988-93.
|-
|919-922||Bp ||1944 ||Bautzen || ||Fd SJ Bop, fd SRJ Co 108-111. "Bautzenpass". Ur trafik 1988-93.
|-
|923-925||Bp ||1948 ||ASJ(L) || ||Fd SJ Bop, fd SRJ Co 112-114. "Norrtäljepass". Ur trafik 1988-93.
|-
|926-930||Bp ||1949 ||ASJ(L) || ||Fd SJ Bop, fd SRJ Co 115-119. "Norrtäljepass". Ur trafik 1988-93.
|-
|931-940||Bp ||1956 ||ASJ(A) || ||Fd SJ Bop, fd SRJ Bo 120-129. "Stålpass". Omb. Till Manövervagnar UBp 113, 109, 111, 115, 117, 110, 108, 116, 114 resp. 112 1985-86.
|}
Grindvagn = wagon with open end

{| class="wikitable sortable"
| '''Litt'''
| '''Typ'''
| '''I trafik'''
| '''Ombyggd'''
| '''Omlittrerad'''
| '''Ny ägare'''
| '''Ur trafik'''
|-
| [[#A7 - A8|A7]]
| Sittvagn
| 1979
| [[#AB9|AB9]] & [[#B9|B9]] & [[#BFS9|BFS9]] (1994), [[#A11|A11]] (2001), [[#B7|B7A]] (2009)
|
| SSRT
|
|-
| [[#A11|A11]]
| Sittvagn
| 2001
|
|
|
|
|-
| [[#AB7|AB7]]
| Sittvagn
| 2009
|
|
|
|
|-
| [[#AB9|AB9]]
| Sittvagn
| 1994
| [[#AB7|AB7]] (2009)
|
|
| 2009
|-
| [[#B2R|B2R]]
| Sittvagn
| 1988
| [[#B10|B10]] (2001)
|
| SSRT
| 2003 (SJ)
|-
| [[#B4|B4]]
| Sitt- och resgodsvagn
| 1985
| BF7 (2010)
| BF4 (1994)
| SSRT
| 2010 (SJ BF4)
|-
| [[#B7|B7]]
| Sittvagn
| 1979
| [[#B7B|B8]] (1990), [[#AB9|AB9]] & [[#B9|B9]] & [[#BFS9|BFS9]] (1994), [[#B11|B11]] (2001), [[#BF8|BF8]] (2017)
|
| TÅGAB (2014)
|
|-
| [[#B7B|B7B]]
| Familjevagn
| 1990
| [[#BFS9|BFS9]] (1994), [[#B7|B7B]] (2009)
| B8
|
| 2010
|-
| [[#B9|B9]]
| Sittvagn
| 1994
| [[#B7|B7C]] (2009)
|
| SSRT
| 2010 (SJ)
|-
| [[#B10|B10]]
| Sittvagn
| 2001
|
|
|
| 2025
|-
| [[#B11|B11]]
| Sittvagn
| 2001
|
|
|
|
|-
| [[#BC4|BC4]]
| Liggvagn
| 1985
|
|
| SSRT (2001)
|
|-
| [[#BF8|BF8]]
| Sittvagn
| 2017
|
|
|
|
|-
| [[#BFS9|BFS9]]
| Sittvagn, kiosk
| 1994
| [[#RB7|RB7]] (2013)
|
|
|
|-
| [[#R4R|R4R]]
| Restaurangvagn
| 1987
| [[#S12|S12]] (1994), [[#RB11|RB11]] (2001)
|
|
|
|-
| [[#RB7|RB7]]
| Bistro- och lekvagn
| 2013
|
|
|
|
|-
| [[#RB11|RB11]]
| Bistrovagn
| 2001
|
|
|
|
|-
| [[#S1|S1]]
| Konferensvagn
| 1981
|
|
| Blå tåget (2014), TÅGAB (2014)
| 2014 (SJ)
|-
| [[#S4|S4]]
| Kontorsvagn
| 1986 (ASEA)
|
|
| SJ (1989)
| ?
|-
| [[#S12|S12]]
| Bistro- och biovagn
| 1994
|
|
|
|
|-
| [[#UA7R|UA7R]]
| Manövervagn
| 1988
|
| AF7X (1994), AFM7
|
| 2022
|-
| [[#WL4|WL4]]
| Sovvagn
| 1990
|
|
| SSRT (2001)
|
|-
| [[#WL6|WL6]]
| Sovvagn
| 1993
|
|
| SSRT (2001)
|
|-
|}

Standardized Railtype Scheme

2024-12-28T22:06:47Z

Brickblock1: /* Speed limit class [*X**] */

This railtype label scheme aims to bring order to the uncontrolled growth of railtype labels. It groups the rail types into what matters from a technical perspective. The scheme provides a standardized way of defining railtype labels, based on track gauge and type, speed class, allowable axle weight and electrification type.

It is the explicit intent of this scheme to decouple track sets from vehicle sets to facilitate easy mixing. This way the player can select a track set of choice to go with a train set of choice. It allows the player to play with or without axle load classes, or with or without speed limit classes, simply by loading a track set that does or does not provide these features. In some cases it will also be possible to combine niche track sets, for instance a standard gauge track set with a narrow gauge and a metro track set.

== The Label Scheme ==
A railtype label consists of four characters. In this scheme, each position has a different purpose:
# Track gauge and type class (e.g. standard gauge rail, narrow gauge rail, monorail)
# Speed limit class
# Axle load class (maximum allowed axle weight for this track)
# Energy source type class

In the next sections, each of the four positions will be explained.

=== Track gauge and type class [X***] ===
The first position in the railtype label defines track gauge and/or track type class. The following classes are currently defined:

{|
! !!Track type/gauge
|-
|S ||Standard gauge rail
|-
|B ||Broad gauge rail
|-
|N ||Narrow gauge rail
|-
|n ||Secondary narrow gauge rail (e.g. when providing both metre and cape gauge, always use N in case of just one type of narrow gauge)
|-
|D ||Dual gauge rail, standard/broad gauge
|-
|d ||Dual gauge rail, standard/narrow gauge
|-
|M ||Monorail
|-
|L ||Magnetic Levitation
|}

=== Speed limit class [*X**] ===
The second position in the railtype label defines the speed limit class. These classes do not map to a fixed numeric value, but are used to define an internal speed limit order for the track set. This means that if your track set has two different speed limits for track types that are otherwise identical, you'll use letters A and B here. In case of three different speed limits, use A, B and C. In case your track set does not employ speed limits, always use A. Train sets do not care about the speed limit, and will always set the lowest speed class, i.e. A.

This gives for instance the following options:

<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||no speed limits
|}
</div>
<div style="float:left;">
 OR 
</div>
</div>
<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||low speed
|-
|B ||high speed
|}
</div>
<div style="float:left;">
 OR 
</div>
</div>
<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||low speed
|-
|B ||medium speed
|-
|C ||high speed
|}
</div>
<div style="float:left;">
 etc. 
</div>
</div>
<div style="clear:left;"></div>

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|R ||rack rail, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|S ||subterranean ||eyecandy ||Metro Track Set
|-
|U ||urban ||eyecandy ||Metro Track Set
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack-rail set) implements compatibility both ways which makes pure rack systems impossible.

=== Axle load class [**X*] ===
The third position defines the axle weight limit. Heavy trains cannot run on tracks with a low axle weight limit; these trains need more expensive tracks with a heigher weight limit. There are five axle load classes '''A''' through '''E'''. '''A''' is for the lowest axle load limit, '''E''' for the highest. The exact axle load attached to each class is relative to the track gauge/type and trains in the set.

A train set should set the appropriate axle weight for each train via the railtype label, as to make the set work with track sets that do provide tracks with different weight limits, even if you don't care about it for your trainset. Split all vehicles of a certain track gauge/type into five groups of similar axle weight. The group with the lowest axle weights will get class '''A''', the second lowest class '''B''', etc. up to the group with the highest axle weights which will get class '''E'''. Do the same for the other track gauge/types if your train set has those.

A track set does not have to provide a dedicated track type for each axle weight limit. A track set that does not provide a dedicated track for each axle load class, must make sure to map all undefined axle load classes to a real railtype using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]]. This way a train set can rely on all labels for all axle load classes being available. Example: if you only want to provide 2 axle load classes for standard gauge unelectrified with no speed limits, you can map SA'''A'''N + SA'''B'''N to SA'''C'''N and SA'''D'''N to SA'''E'''N if the cost difference between the two railtypes is high, or SA'''A'''N to SA'''B'''N and SA'''C'''N + SA'''D'''N to SA'''E'''N if the cost difference is low.

If you don't want to provide any axle load classes in your track set, it doesn't really matter what axle load class you choose for the track, as you'll be mapping all other classes to this track anyways. But the lowest or highest class are the obvious choice. Example: if your track set only provides narrow gauge unelectrified track with no speed limits and no axle load limits, you may use NA'''A'''N for the track label, and provide NA'''B'''N, NA'''C'''N, NA'''D'''N, NA'''E'''N in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

If you need more than five axle load class, you may use lowercase letters for very low axle loads and continue the uppercase letters for very high axle loads. Be advised that your train set may not assume the existance of any other class than '''A''' through '''E''', so when the range make sure to program your railtype table such that trains with such a class will fall back to class '''A''' or '''E'''. If you make a track set with an extended range, be aware that not all train sets will define trains for these tracks. In general: only do this in case of a train set with a matching track set.

For the lowercase letters, '''b''' is lower than '''a''', so for increasing axle load limits: b < a < A < B < C etc.

Note that the axle load classes never map to a specific weight in tonnes. For that reason it does not make sense to add a numeric value for the axle load to the name of a track type or in the extended purchase info of a train. Instead use the relative expressions 'very low', 'low', 'medium', 'high' and 'very high' or use the class letters directly.

If a guideline is needed for updating a set to use axle loads in a train set where they don't yet exist, the following might serve as a basic "generic" guideline...

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|F ||Future-proofing ||No limit per axle (update in 2030 or so?) || style="text-align:right;"|~2028
|}

=== Energy source type class [***X] ===
The last position defines the energy source type class. This is split in generic energy source types like overhead wires and third rail and specialized types like alternating and direct current.

A track set that only uses specialized types, should map the generic types to the most suitable specialized type in the set.

A vehicle set that uses specialized types should define a generic type as fallback, via the railtype table. If such a fallback is omitted, please note that certain vehicles may be unavailable depending on track set loaded.

{|
! !!Generic energy type classes
|-
|N ||no electrification
|-
|E ||overhead wires/catenary electrification
|-
|3 ||3rd rail electrification
|}

{|
! !!Specialized energy type classes !!Vehicle set fallback
|-
|Z ||3rd rail and catenary electrification || 3 or E
|-
|4 ||4th rail electrification || 3
|-
|Y ||4th rail and catenary electrification || 4 or E
|-
|T ||[http://en.wikipedia.org/wiki/Three-phase_AC_railway_electrification three phase AC electrification] || E
|-
| colspan="3" |  
|-
|D ||DC catenary electrification || E
|-
|d ||low voltage DC catenary electrification (only when D also used in set) || First A then E
|-
|A ||AC catenary electrification || E
|-
|a ||low voltage AC catenary electrification (only when A also used in set) || First A then E
|}

If you want multi-voltage/current vehicles in your set (i.e. a train that can run on both AC and DC current), you have to define a dedicated railtype for those vehicles. Without the railtype, it's not possible to define vehicles with this property. If you only have vehicles that can run on either one type of voltage/current or on all types of voltage/current (e.g. a 2-system if you only have '''A''' and '''D''' tracks, or a 4-system in case of all '''A''', '''a''', '''D''' and '''d'''), then use the generic class '''E''' for vehicles that should be able to run on all different voltage/currents. Also the track set needs to have one at least one railtype with class '''E''' defined.

Note that if you want more than one type of multi-voltage/current, you'll quickly get a combinatory explosion of railtype labels, so plan carefully or do not attempt it. For every different multi-voltage/current vehicle type a dedicated railtype is needed. If you want all possible combinations, then you need to define an additional 8 classes. It is not recommended to make your train/track set this complicated.

Example approach for a 4-system set, with trains that can run on either one or all systems:
* '''E''': generic catenary-powered electric engines. "universal" [4-system] if any of '''D'''/'''d'''/'''A'''/'''a''' are defined.
* '''A''': generic AC catenary electric engines. 25kV only if '''a''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''A''';
* '''a''': 15kV AC catenary electric engines. Only defined if '''A''' also defined. Vehicle sets should use '''A''' and '''E''' as fallback, if defining an engine for '''a''';
* '''D''': generic DC catenary electric engines. 3kV if '''d''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''D''';
* '''d''': 1.5kV DC catenary electric engines. Only defined if '''D''' also defined. Vehicle sets should use '''D''' and '''E''' as fallback, if defining an engine for '''d'''.
For a 2-system set, you can simply drop '''a''' and '''d'''.

=== Standard labels: RAIL, ELRL, MONO, MGLV ===
It's not possible to undefine the standard railtypes RAIL, ELRL, MONO and MGLV. The game will always add those if there are vehicles defined for these track types. As a result, for a track set it's best not to ignore those standard labels, but rather work with them and define them in the set. If your track set does not have monorail or maglev tracks, there of course is no need to define those. But if your track set defines anything that resembles unelectrified or electrified rail, you should use the RAIL and ELRL labels. Matching labels from the above scheme will then be defined in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

As vehicles from NewGRFs that do not use explicit railtypes will end up on these standard railtypes, you should use RAIL instead of whatever type could be regarded as the most commonly used unelectrified type, ELRL instead of the most commonly used electrified type and so on. The label according to this scheme is then set as an alternate.

== Summary for track sets ==
This section summarizes the above for track sets.

; [X***] Track gauge and type class
* Define at least one track type for every track gauge/type class you want in your set.
* If you only provide tracks for one gauge/type, consider leaving some free railtypes so a player can load an additional set for some other type.
; [*X**] Speed limit class
* Make sure class A is always available, either directly or via an alternate label.
* Use only class A if you don't want speed limits;
* With speed limits, A is the lowest speed limit. Continue with B, C, etc. for increasing speed limits;
* The speed class can also be used to implement additional eye-candy track types, use letters higher in the alphabet for this.
; [**X*] Axle load class
* Always define all classes A through E for every track type class / electrification combination, either:
** Directly via a real railtype definition;
** Indirectly via the alternate rail type label list, property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].
* Extend the predefined classes only if you also provide a train set that makes use of these.
; [***X] Energy source type class
* If your set only uses specialized classes, always map the generic classes to the closest matching specialized type via property 1D.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Always define the standard labels when possible, instead of what would be the equivalent of the standard label in this scheme.
* Map the equivalent labels from this scheme to the standard labels using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

Or, put differently, for each gauge/type, select one or more energy source types. For each type/energy combination provide all axle load classes for the speed class "A", either as a real type or as an alternate of another type. Provide more types with a different speed letter if you want to provide several different speeds or other eye-candy tracks.

== Summary for train sets ==
This section summarizes the above for train sets.

; [X***] Track gauge and type class
* Use the track type class that matches the vehicle;
* Define a fallback type via the railtype table in case you want the vehicle to be available on a different track if no matching track set is loaded.
** Specialized subtypes like "n" might not always be available. If you want those vehicles to be still available then, fall back the the generic class (e.g. "N").
; [*X**] Speed limit class
* Always use class A for every vehicle.
; [**X*] Axle load class
* Use all classes A through E according to the maximum axle weight of the vehicle.
* Extend the predefined classes only if you also provide a track set that makes use of these;
** When extending the predefined classes A through E, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; [***X] Energy source type class
* Use the energy source type class that matches the vehicle;
* When using specialized classes, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Define a fallback type to the standard labels via the railtype table in case you want the vehicle to be available on the standard tracks if no matching track set is loaded.

Be as specific as you want when selecting the railtype, it is the job of the track set to select a playable, reduced subset out of all possible type combinations.

== In case you're not convinced by this scheme ==
Adopting this scheme gives the player freedom to use any track set in combination with any train set that follow the scheme.

This means that you can make your train set compatible with track sets that provide axle load classes, and track sets that provide speed limits, and at the same time with track sets that provide none of this. This way, the player can decide to play with or without axle load classes, or with or without speed limits, simply by loading a track set that does or does not provide these features.

And for your track set, it means that you can make it as simple or as complicated as you want (within the 64 track type limit), while not having to worry about compatibility with train sets.

Still not convinced? Feel free to use railtype labels of your own, but know that you will likely come to regret that at some point in the future.

==Forum topic==
If you want to discuss the standardized railtype scheme or have any questions about it, you can visit [http://www.tt-forums.net/viewtopic.php?t=59379 the forum topic].

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Extended multivoltage support addition==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Extended maglev support addition==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS and the Maglev Track Set which allow trainsets to code trains which use different, incompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Fallback !!Notes
|-
|S ||Maglevs that use a synchronous linear motor ||N/A ||
|-
|I ||Maglevs that use a linear induction motor || TCAI (the whole label) || If using SCMaglev/"Vanilla" maglev then add MGLV (the whole label) as an extra fallback.
|-
|V ||Vactrains/Hyperloop ||t, then I || If using SCMaglev/"Vanilla" maglev then add MGLV (the whole label) as an extra fallback. See proposed "universal tunnel" electrification below for the "t".
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), 16 in (406 mm), 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1422+ mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SAbN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|d ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}

NML:Cargos

2024-12-28T11:29:57Z

Brickblock1: /* Cargo properties */

{{NMLNavPropVarCB}}

==Cargo IDs==
For cargos, the item ID corresponds to the cargo type slot of the cargo. TTD default cargos occupy slots 0-11, so if you want to define a new cargo be sure to set this ID to 12 or higher. It is recommended to set the 'number'-property to the same value as the item ID.

==Cargo properties==

{| class="wikitable sortable"
! name
! value range
! comment
|-
| number
| 0..63
| Number of the cargo for bitmasks. Prior to {{ottd|1.9}} this was clamped to 0..31. This mostly affects old NewGRFs that don't have a cargo translation table.
|-
| type_name
| string
| String to use as cargo type name. Example: "Passengers". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_CARGO_PLURAL_XXX), which may be re-used.
|-
| unit_name
| string
| String to use for the name of one unit from the cargo type. Currently used for subsidies only (First Passenger service to..). Example string: "Passenger". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_CARGO_SINGULAR_XXX), which may be re-used.
|-
| units_of_cargo
| string
| String used to show the "short cargo" form for cargo units, e.g. "10 tonnes" or "20.000 litres". Example: "{COMMA} item{P "" s}". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_PASSENGERS and further), which may be re-used.
|-
| items_of_cargo
| string
| String used to show the "long cargo" form for cargo units, e.g. "10 tonnes of coal" or "20.000 litres of water". Example: "{COMMA} item{P "" s} of livestock". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_QUANTITY_XXX), which may be re-used.
|-
| type_abbreviation
| string
| String used for the two-letter cargo type abbreviation. Must start with a {TINYFONT} string-code. Example: "{TINYFONT}XX". Make sure to avoid multiple cargos having the same abbreviation. The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_ABBREV_XXX), which may be re-used.
|-
| sprite
| sprite
| TTD sprite number for the icon of the cargo. Alternatively, set to NEW_CARGO_SPRITE and use a graphics block to define a custom sprite.
|-
| weight
| float 0..255
| Weight of one unit of the cargo (in tons)
|-
| penalty_lowerbound
| 0..255
| Delivery time until penalty is applied. The units depend on the vehicle used (see vehicle property 'cargo_age_period'), by default 1 unit = 2.5 days.
|-
| single_penalty_length
| 0..255
| Length of the interval where a single penalty is applied
|-
| price_factor
| float
| Payment for delivering 10 units of cargo across a distance of 20 squares (in British Pounds), when delivering in less than 'penalty_lowerbound' time (no time penalty).
|-
| station_list_colour
| 0..255
|
Colour for the station list window (index from the [[NML:Graphic files|default (DOS) palette]])
|-
| cargo_payment_list_colour
| 0..255
|
Colour for the cargo payment list window (index from the [[NML:Graphic files|default (DOS) palette]])
|-
| is_freight
| 0 or 1
| Freight status (for the freighttrains switch); 0=not freight, 1=is freight
|-
| cargo_classes
|
bitmask([[#Cargo classes|cargo classes]])
| Cargo classes
|-
| cargo_label
| 4 letters
| [[CargoTypes|Cargo label]], as used in the [[NML:Cargotable|cargo table]]
|-
| town_growth_effect
| TOWNGROWTH_XXX
|
Effect for town growth, see [[#Cargo effects on town growth|Cargo effects on town growth]]
|-
| town_growth_multiplier
| float 0..255
| {{ottd|no}} Multiplier for town growth. To be used in conjuction with town_growth_effect, when that is not TOWNGROWTH_NONE. For example, a value of 4 makes your cargo have the same effect on town growth as 4 units of food/goods/etc.
|-
| callback_flags
| bitmask(flags)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| capacity_multiplier
| float 0 .. 255
| {{ottd|1.2|r22860}} This defines the capacity of vehicles carrying this cargo type, if the vehicle sets no specific capacity to this specific cargo type. Set this property to the amount of cargo a vehicle shall carry, which can carry 1 ton of coal or 1000 thousand litres of water (whatever comparison is more suitable for your cargotype). Depending on whether your cargo type is light or heavy you should set this property either comparing the weight or the volume. Default values are 4 for passengers, 2 for mail, goods and sweets and 1 for all other cargos.
|-
| town_production_effect
| TOWNPRODUCTION_XXX
| {{ottdp|14.0|no}} Effect for town production, see [[#Town production effect|Town production effect]]
|-
| town_production_multiplier
| float 0..255
| {{ottdp|14.0|no}} Multiplier for town production, to be used in conjunction with town_production_effect, when that is not TOWNPRODUCTION_NONE. For example, a value of 4 makes a town produce 4 times as much cargo as normal.
|}

Cargo payment is computed from <code style="color:darkgreen">price_factor</code>, amount of cargo transported, distance, and a time delivery factor. Unit of the delivery time is 185 ticks, roughly 2.5 days. The factor is constant (with value 255) if delivery time is less than <code style="color:darkgreen">penalty_lowerbound</code>. It goes down with rate 1 between <code style="color:darkgreen">penalty_lowerbound + single_penalty_length</code>, and goes down with rate 2 if the delivery time is even longer. Time delivery factor is never less than 31.

===Cargo classes===

Available cargo classes are listed in the following table. Cargos may be in more than one class. Cargo classes are always used as a bitmask, use the built-in function <code>bitmask()</code>. For example, <code style="color:darkgreen">bitmask(CC_EXPRESS, CC_REFRIGERATED)</code> is used for food.

The history of cargo classes is complex, and the meanings here may not be consistent with how classes are actually used by some grfs.

FIRS and Iron Horse do not conform to the classes here, and use the FRAX Cargo Class Scheme, please see: https://grf.farm/polar_fox/frax_latest.html

{| class="wikitable sortable"
! name
! type of cargo
|-
| CC_PASSENGERS
| passengers, also tourists (ECS)
|-
| CC_MAIL
| mail
|-
| CC_EXPRESS
| express goods, also tourists (ECS)
|-
| CC_ARMOURED
| valuables, diamonds, gold and alike
|-
| CC_BULK
| coal, ore, grain,...
|-
| CC_PIECE_GOODS
| containers, crates, livestock
|-
| CC_LIQUID
| oil, milk, water, ...
|-
| CC_REFRIGERATED
| food, milk, ...
|-
| CC_HAZARDOUS
| chemicals?, uranium, ...
|-
| CC_COVERED
| grain, cement, fruit, ...
|-
| CC_OVERSIZED
| vehicles, ...
|-
| CC_POWDERIZED
| cement, ...
|-
| CC_NON_POURABLE<br>CC_NEO_BULK
| sugar cane, wool or straw bales, ... (these are synonyms for cargos that are bulk, but can't be handled in e.g. hoppers)
|-
| CC_POTABLE
| exclude from non-food-grade vehicles
|-
| CC_NON_POTABLE
| exclude from food-grade vehicles
|-
| CC_SPECIAL
| Deprecated, do not set.
|-
| NO_CARGO_CLASS
| Special value that you can used to instead of 0.
|-
| ALL_NORMAL_CARGO_CLASSES
| Bitmask of all cargo classes except CC_SPECIAL. This is the same as <code style="color:darkgreen">bitmask(CC_PASSENGERS, CC_MAIL, ..., CC_OVERSIZED)</code>. Note: This is already a bitmask, don't use the <code style="color:darkgreen">bitmask(..)</code> function with this.
|-
| ALL_CARGO_CLASSES
| Bitmask of all cargo classes. Same as <code style="color:darkgreen">ALL_NORMAL_CARGO_CLASSES | bitmask(CC_SPECIAL)</code> Note: This is already a bitmask, don't use the <code style="color:darkgreen">bitmask(..)</code> function with this.
|}

===Cargo effects on town growth===

{| class="wikitable sortable"
! value
! effect
|-
| TOWNGROWTH_PASSENGERS
| Affect towns as passengers do
|-
| TOWNGROWTH_MAIL
| Affect towns as mail does
|-
| TOWNGROWTH_GOODS
| Affect towns as goods/candy does
|-
| TOWNGROWTH_WATER
| Affect towns as water does (second required cargo for towngrowth in the desert)
|-
| TOWNGROWTH_FOOD
| Affect towns as food/fizzy drinks do (first required cargo for towngrowth in desert/above snowline)
|-
| TOWNGROWTH_NONE
| Don't affect town growth (default)
|}

If no cargos in the game are defined as TOWNGROWTH_FOOD, towns above the snowline will not require food to grow. If no cargos in the game are defined as TOWNGROWTH_FOOD or TOWNGROWTH_WATER, towns in desert will not require food or water to grow. This can be used positively for gameplay purposes, and is otherwise worth being aware of as an unintended side effect when designing cargos.

There are some additional effects of these flags on subsidies and town cargo transport statistics. See the nfo docs for details: https://newgrf-specs.tt-wiki.net/wiki/Action0/Cargos#Substitute_type_and_multiplier_for_town_growth_.2818.2C_19.29

===Town production effect===

{| class="wikitable sortable"
! value
! effect
|-
| TOWNPRODUCTION_PASSENGERS
| Town produces cargo as like passengers
|-
| TOWNPRODUCTION_MAIL
| Town produces cargo as like mail
|-
| TOWNPRODUCTION_NONE
| Town does not produce cargo (default)
|}

==Cargo variables==

Cargos have no variables (yet).

==Cargo callbacks==

{| class="wikitable sortable"
! callback
! return value
! comment
|-
| default
| Sprite set (with 1 sprite)
| Graphics for the cargo icon (only if property <code style="color:darkgreen">sprite</code> is set to NEW_CARGO_SPRITE)
|-
| station_rating
| -16384 .. 16383
| See detailed explanation below
|-
| profit
| -12748 .. 12748
| Called whenever cargo is delivered.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 16):</code> The manhattan distance the cargo was transported.
* <code style="color:darkgreen">getbits(extra_callback_info2, 16, 8):</code> The amount of cargo delivered.
* <code style="color:darkgreen">getbits(extra_callback_info2, 24, 8):</code> The time spent en-route (1 unit = 2.5 days).
The returned value is multiplied by the amount and the <code style="color:darkgreen">price_factor</code> to determine the income the player receives. Returning negative values is possible, it makes players pay for the delivery.
|}

===Station rating callback===

The station rating callback is quite complicated and deserves some detailed explanation. The default station rating calculation works as follows:

Internally, station rating is byte with values 0 .. 255, representing respectively 0% and 100%. Every 2.5 days, the transportation 'performance' is calculated using some factors outlined below. The station rating is then set to this performance value, with the caveat that the rating change cannot exceed 2 points. Therefore, rating changes are always slow, this callback cannot change this. The initial rating is 175 points (69%). The following factors are parts of the performance, their effects are summed.

====Time since the cargo was last picked up====

{| class="wikitable sortable"
! Time units (days)
! Score (%, rounded)
|-
| >21 (>52.5 days)
| 0 (0%)
|-
| 13 .. 21 (32.5 days .. 52.5 days)
| 25 (10%)
|-
| 7 .. 12 (17.5 days .. 32.5 days)
| 50 (20%)
|-
| 4 .. 6 (10 days .. 17.5 days)
| 95 (37%)
|-
| 0..3 (0 days..10 days)
| 130 (51%)
|}

The time unit used equals 185 engine ticks, or 2.5 TTD days. For ships, the time units are divided by 4 before calculating this component, so ships have four times more time before the ratings start dropping.

====Amount of cargo waiting====

{| class="wikitable sortable"
! Amount of cargo
! Score (%, rounded)
|-
| >1500
| -90 (-35%)
|-
| 1001..1500
| -35 (-14%)
|-
| 601..1000
| 0 (0%)
|-
| 301..600
| 10 (4%)
|-
| 101..300
| 30 (12%)
|-
| 0..100
| 40 (16%)
|}

====Max. speed of the last vehicle picking up the cargo====

This calculation is somewhat complicated. The maximum speed of the vehicle is expressed in "speed units". For trains and road vehicles, the speed unit is 1 km/h; for ships, it's 0.5 km/h; for aircraft, it's 8 mph. If the max. speed is above 255 speed units, 255 is used instead. If the vehicle is slower than 85 units, no points are awarded; otherwise, you get (speed_units-85)/4 points. Therefore, the maximum you can get is 42 points, or 16%.

====Age of the last carrier picking up the cargo====

{| class="wikitable sortable"
! Age of vehicle (years)
! Score (%, rounded)
|-
| 2
| 10 (4%)
|-
| 1
| 20 (8%)
|-
| 0
| 33 (13%)
|}

In TTDPatch this changes when the 'newagerating' switch is enabled

====Bonus for AI companies (TTDPatch only)====

{| class="t"
! AI intelligence setting
! Score (%, rounded)
|-
| Low
| 0 (0%)
|-
| Medium
| 31 (12%)
|-
| High
| 63 (25%)
|}

====Bonus for statue in nearest town====

If your company has erected a statue in the nearest town, you get 26 points (10%) bonus to all cargo ratings.

====Callback parameters====

<ul><li>
<code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>:
{| |-
!value!!meaning
|-
|0x10||the last vehicle entering the station was a train
|-
|0x11||the last vehicle entering the station was a road vehicle
|-
|0x12||the last vehicle entering the station was a ship
|-
|0x13||the last vehicle entering the station was an aircraft
|-
|0||no vehicle entered the station yet, or (TTDPatch) the last one entering was sold
|}
Please note that there's only one "last vehicle type" field per station, so the vehicle this refers to may not have picked up any of your cargo.
</li><li>
<code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The time since the cargo was last picked up, in the time units described above (1 unit = 2.5 days independent of vehicle type)
</li><li>
<code style="color:darkgreen">getbits(extra_callback_info2, 8, 16)</code>: The amount of cargo waiting.
</li><li>
<code style="color:darkgreen">getbits(extra_callback_info2, 24, 8)</code>: The speed of the last vehicle picking the cargo up, in the speed units described above (if no vehicle entered the station yet, the value is 0xFF).
</li></ul>

====Effect of callback====

The return value of the callback replaces the first three components (time since pickup, amount of cargo, max speed) of the calculation. The bonus for statues, TTDPatch AIs and new vehicles is always in effect, you cannot (yet) change this.

Standardized Roadtype Scheme

2024-12-01T00:45:32Z

Brickblock1:

Standardized Roadtype Scheme

2024-12-01T00:44:56Z

Brickblock1:

Standardized Roadtype Scheme

2024-12-01T00:35:54Z

Brickblock1: Undo revision 4813 by Desertbus95 (talk)

Standardized Roadtype Scheme

2024-12-01T00:35:39Z

Brickblock1: Undo revision 4872 by Desertbus95 (talk)

This scheme was originally conceived in order to decrease the amount of necessary hidden road and tramtrack types. This is done by standardizing which labels vehicles and infrastructure should use. The standard also allows for more gameplay depth by having the option to limit vehicles to certain types of roads. It does similarly to the railtype scheme allow mixing of any vehicle set with any infrastructure set. It does however not allow multiple infrastructure sets to be used at the same time. It does not prevent it but all of the sets used have to be made to be used with each other, or use different surfaces/types which don't conflict with each other. The standard sets no limit on how vehicle sets can be used.

It is ultimately up to the infrastructure set to chose what roadtypes are available and thereby what vehicles are available. Infrastructure and vehicles can both be in the same set, it is however recommended to be able to disable the infrastructure with parameters (preferably on an individual basis per roadtype) in case the player wants to use a different set for their infrastructure.

* While this is a guide rather than a hard rule, it is recommended to think of standardized roadtypes vs. "fancy" roadtypes (not a default - ROAD for roadtypes, ELRL for tramtypes - and not to this standard; for example "FNCY", "HAUL" and "NSTD" would be fancy labels) as a microcosm of the difference between a base set (OpenGFX) and a NewGRF that provides new graphics; The goal is for a basic roadtype set to cover as many standardized labels as is appropriate, and leave the more niche uses of the system to another set. This reduces the number of necessary roadtypes to a bare minimum, allowing optional roadtypes more room to cover corner cases.
** The reason to keep the above in mind is that if done in this way the effect works very differently than railtypes, where the primary concern is to allow gauge, energy source and so on to exist and bind trains from all sets to only the logically compatible railtypes. Roads and, by extension, streetcar tracks are more compatible with vehicles but also have much more variation. This is complicated by game engine limitations; only 60 - or 61 without ELRL - tracktype slots exist in recent versions of OpenTTD, but reaching that limit is usually a non-issue. Roadtypes and Tramtypes are considered the same on that front by the game engine, leaving 62 tramtypes - 64, including ROAD and ELRL - to be split in a pool between the two.

----

=== Surface / Type [X***] ===
Describes the road surface / rail type and thus the vehicle type.

'''Roadtype:'''

{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Road)
! Powered Roadtypes
! Recomended vehicle set fallbacks
|-
| R
| Regular Road
| RI(S)
|
|-
| P
| Passenger-only
| RPI(S)
| R
|-
| G
| Guided busway
| RPG
| P then R
|-
| I
| Industrial Site (ISR)
| I
| R
|-
| B
| Bicycle Lane
| RB(Z)
| R
|-
| W
| Waterway
| W
|-
| A
| Amphibious on road (hidden)
| RPI(S)W
| R
|-
| S
| Snowy or Iced Track
| S
|-
| a
| Amphibious on snow (hidden)
| SW
| S
|-
| Z
| Pedestrian Zone
| Z
|
|-
| E
| Eyecandy
| E
|
|-
| p
| Pump/Pipeline
| p
|
|}

'''Tramtype:'''

{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Tram)
! Powered Tramtypes
! Recomended vehicle set fallbacks
|-
| R
| Regular Rail
| RI(M)
|
|-
| P
| Passenger-only
| RPI(M)
| R
|-
| I
| Industrial Site (ISR)
| I
| R
|-
| B
| Bicycle Lane
| (R)B
| R
|-
| S
| Suspended Monorail
| S
|
|-
| M
| Metro
| M(RP)
|
|-
| O
| Trackless trams
| O
|
|-
| E
| Eyecandy/Electrical infrastructure
| E
|
|}

It is the vehicle set's responsibility to implement fallbacks to other appropriate surfaces. It is also up to the author to decide if they want to do it or not. This means that road/tramtrack sets shouldn't add these to their [[NML:Roadtypes#Roadtype_properties|alternative_roadtype_list (NML)]] and [[NML:Tramtypes#Tramtype_properties|alternative_tramtype_list (NML)]]

It is up to the track set to implement all powered roadtypes in the [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]]. The same goes for tramtypes: [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]]. It is further advised to implement support for the roadtypes/tramtypes in brackets, if applicable.

Hidden roadtypes for compatibility should be implemented by road sets. It is up to the author to decide if they want to implement it as a hidden roadtype or not.

=== Speed / Feature [*X**] ===
Any character may be used for roads, but at least one road must have "A".

Vehicles should use "A".

=== Terrain / Stability [**X*] ===
Describes the roughness of the road surface / trackbed stability, and thus the vehicle tier.
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning
! Powered Roadtypes
|-
| a
| Very slow / rough / light
| a
|-
| A
| Slow / rough / light
| aAB
|-
| B
| Regular
| ABC
|-
| C
| Fast / stable
| BCc
|-
| c
| Very fast / stable
| c
|}

If all classes aren't defined by the road set, the other ones should be in the [[NML:Roadtypes#Roadtype_properties|alternative_roadtype_list (NML)]]. The same goes for tramtypes: [[NML:Tramtypes#Tramtype_properties|alternative_tramtype_list (NML)]].

Road vehicle sets should not implement fallbacks for terrain / stability.

Classes "a" and "c" are entirely optional for road/tramtype sets and should under no circumstances be used by vehicles.

=== Energy [***X] ===
Describes the energy source of the track / vehicle.

'''Generic classes:'''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Road)
! Meaning (Tram)
! Vehicle set fallback
|-
| N
| None
| None
|
|-
| E
| Overhead electrified (Catenary)
| Overhead electrified (Catenary)
|
|-
| G
| Ground electrified
| Ground electrified
|
|-
| Z
| Ground and overhead electrified
| Ground and overhead electrified
| E or G
|}
'''Specialized classes:'''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Road)
! Meaning (Tram)
! Vehicle set fallback
|-
| 3
| n/a
| Third Rail
| G
|-
| 4
| n/a
| Fourth Rail
| 3 then G
|-
| C
| n/a
| Cable
| G
|}
A tramtrack set that only uses specialized types, should map the generic types to the most suitable specialized type in the set with the help of the [[NML:Tramtypes#Tramtype_properties|alternative_tramtype_list (NML)]].

=== The default labels (ROAD, ELRL) and non-standard labels===
OpenTTD will allways define ROAD and ELRL incase there are vehicles for them. It is therefore recomended to have these present in the set so that you can map them to appropriete labels from the standard. There are a few ways of doing this:
*Replacing one of the standardised types with the default label and putting the standardised label in the [[NML:Roadtypes#Roadtype_properties|alternative_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|alternative_tramtype_list (NML)]].
*Defining ROAD and/or ELRL separately from the standardised labels and adding the standard ones to the [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]]. The main advantage of this is that you can use a parameter to map ROAD and/or ELRL to the standardised labels. This allows the player to chose where there non standardised vehicles will be able to go.

Vehicle set authors might want to add the default labels and non-standard labels as a fallback. If not implemented for the defualt labels, their vehicles won't show up on the default roads and/or tracks, leading to countless bug reports from players. Non standard labels that might be worth adding fallbacks too are: ELRD, RAIL, HAUL and probably some more.

== Summary for Road/Tramtrack sets ==
This section summarizes the above for road/tramtrack sets.

; [X***] Surface / Type
* Chose which Surfaces and types you want in your set and give them the correct [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]].
* If you only provide roads/tramtracks for one surface/type, consider leaving some free road/tramtypes so a player can load an additional set for some other type.
; [*X**] Speed / Feature
* Make sure class A is always available.
* Use B, C and so on if you have multible roads/tramtracks with the otherwise the same label.
; [**X*] Terrain / Stability
* Always define classes A through C for every road/tramtrack surface/type energy combination, either:
** Directly via a real road/tramtype definition;
** Indirectly via the alternate road/tramtype label list, [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]].
; [***X] Energy source type class
* If your set only uses specialized classes, always map the generic classes to the closest matching specialized type via [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]].
; Default labels [ROAD, ELRL] and non-standard labels
* Always define the default labels when possible, instead of what would be the equivalent of the default label in this scheme.
* Map the equivalent labels from this scheme to the default labels using [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]].
* Map common non-standard labels to the most similar label in this scheme using [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]].

== Summary for vehicle sets ==
This section summarizes the above for vehicle sets.

; [X***] Surface / Type
* Use the surface / type class that matches the vehicle;
* Define a fallback type via the road/tramtype table in case you want the vehicle to be available on a different road or tramtrack if no matching road/tramtrack set is loaded.
** Specialized subtypes like "G" might not always be available. If you want those vehicles to be still available then, fall back the the generic class (e.g. "P" or "R").
; [*X**] Speed / Feature
* Always use class A for every vehicle.
; [**X*] Terrain / Stability
* Use A, B or C depending on where you want your vehicles to be able to drive.
** A is used for slow offroad capable vehicles which aren't allowed on Motorways and similar Roads
** B is used for vehicles which can drive offroad but are also allowed on Motorways.
** C is used for vehicles which can't go offroad or similar.
** Use B if you aren't sure what to chose.
* Never use a or c.
; [***X] Energy source type class
* Use the energy source type class that matches the vehicle;
* When using specialized classes, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; Default labels [ROAD, ELRL] and non-standard labels
* Define a fallback type to the default labels via the road/tramtype table in case you want the vehicle to be available on the default roads/track if no matching set is loaded.
* Do the same for any non-standard labels that may be relevant.

Be as specific as you want when selecting the road/tramtype, it is the job of the road/track set to select a playable, reduced subset out of all possible type combinations.
=== Example of fallback order for vehicle sets ===
{| class="wikitable"
|- style="font-style:italic;"
! Unchanged label
! Fallback order
|-
| GACE (road)
| GACE -> PACE -> RACE -> (ROAD)
|-
| PAB4 (tram)
| PAB4 -> PAB3 -> PABG -> RAB4 -> RAB3 -> RABG
|-
| IAAG (road)
| IAAG -> RAAG
|-
| AACE (road)
| AACE -> RAAE -> (ELRD)
|-
| RABE (tram)
| RABE -> (ELRL)
|-
| PAAN (tram)
| PAAN -> RAAN -> (RAIL)
|}
== Forum topic ==
Feel free to discuss and ask questions about the scheme at the forum topic [https://www.tt-forums.net/viewtopic.php?t=90715 Here].

=== Possible additions ===
To be discussed in the forum topic...

==== Surface / Type [X***] ====
Describes the road surface / rail type and thus the vehicle type.

'''Tramtype:'''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Tram)
! Powered Tramtypes
! Recomended vehicle set fallbacks
|-
| Z
| Deep-Bore Metro
| (For subsurface logistics systems that are normally never visible on the surface)
|
|-
| z
| Passenger-only (Deep-Bore Metro)
| (For subsurface metro systems that are normally never visible on the surface)
|
|-
| X or x
| Multiple guidance systems or guages
| (Depends on intent; only two tramtype rail system combinations can exist for a given set of standardized labels - i.e. XABE and xABE - making it necessary to plan accordingly)
|
|-
| 0 (#)
| Invisible
| For invisible tramtypes; Fallback for INVI, BKVI, 0000 and other "null" tramtypes
|
|-
| s
| Regular Rail (Standard Gauge)
| r
|
|-
| p
| Passenger-only (Standard Gauge)
| r
|
|-
| r
| Multi-gauge Rail (Standard Gauge, Metre Gauge, 600mm Gauge)
| s, R, p, P
| P or p, depending on the vehicle's gauge (City tram); R, s or 6, depending on the vehicle's gauge (Cargo tram)
|-
| 6
| Industrial Tramway (600mm Gauge - default tramway rails graphics)
| r
|
|-
|}

==== Terrain / Stability [**X*] ====
Describes the roughness of the road surface / trackbed stability, and thus the vehicle tier. ''(This is edited to include the potential "Low Clearance" hidden roadtype.)''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning
! Powered Roadtypes
|-
| a
| Very slow / rough / light
| aA
|-
| A
| Slow / rough / light
| aAB
|-
| B
| Regular
| ABC
|-
| b
| Regular (Low clearance)
| ABC
|-
| C
| Fast / stable
| BCc
|-
| c
| Very fast / stable
| Cc
|}

If all classes aren't defined by the road set, the other ones should be in the [[NML:Roadtypes#Roadtype_properties|alternative_roadtype_list (NML)]]. The same goes for tramtypes: [[NML:Tramtypes#Tramtype_properties|alternative_tramtype_list (NML)]].

Road vehicle sets should not implement fallbacks for terrain / stability. Class "b" should only be used for a hidden roadtype, such as "RAbN", "PAbN" and electrified variants. This is optional, but if used it should be applied to the [[NML:Vehicles#Road_vehicle_properties|roadtype (NML) or tram_type (NML)]] property of all vehicles able to travel under the relevant low-clearance obstacles.

* ''As a frame of reference, realistically "RAbN" should be used for all eye-candy cars small cargo vans and single-decker non-electrified cargo trams, while trucks (excluding trolleytrucks) and non-electrified double-decker trams should default to "RABN". "RAbE" and other powered vehicles should be used by trolleytrucks and electric cargo trams (excluding double-decker trams). "PAbN" should be used by double-decker busses, and most non-electric trams (excluding double-decker trams). "PAbE" should be used by most passenger trams, excluding double-decker passenger trams. For other energy sources, the instructions for"RAbE" and "PAbE" can easily be adapted for any other power source ("RAbG" and "PAbG", "RAbI" and "PAbI", etc.).''

Classes "a" and "c" are entirely optional for road/tramtype sets and should under no circumstances be used by vehicles.

Class "b" is also optional for road/tramtype sets but should have ROADTYPE_FLAG_HIDDEN set in the bitmask of [[NML:Roadtypes#Roadtype_properties|roadtype_flags (NML)]]. Instead, a low-clearance variant of a standardized roadtype or tramtype should be compatible with all other standard classes ("a", "A", B", "C" and "c") using the [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] in a road/tramtype set that sets the standardized labels (i.e. "RAbN" should be used for small cargo vans and must fallback to "RAaN, RAAN, RABN, RACN, RAcN", and "PAbE" should be used by all busses and must fallback to "PAaN, PAAN, PABN, PACN, PAcN"). If a complex roadtype (i.e. RAaN) needs a low-clearance variant, create a non-standard label (i.e. XMPL), then define the relevant standard labels (RAaN in this case, and RAbN in turn) in the [[NML:Roadtypes#Roadtype_properties|alternative_roadtype_list (NML)]] of the non-standard label (XMPL), and define the entire class of labels (RAaN, RAAN, RABN, RAbN, RACN, RAcN) in the [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] of the non-standard label (XMPL).

==== Energy [***X] ====
Describes the energy source of the track / vehicle.

'''Generic classes:'''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Road)
! Meaning (Tram)
! Vehicle set fallback
|-
| I
| Induction-charge electrified
| Induction-charge electrified
| Z then G then N
|-
| i
| Eyecandy/Pipeline Infrastructure
| Eyecandy/Electric & Telecom Infrastructure
| Z then E then G then I
|-
| L
| Reclaimed Elevated Rail Eco-Park
| Elevated Rail
| I then Z then G then N (Roadtype); E then Z then G then I (Tramtype)
|-
| P
| No Commercial Vehicles/Parking Lot (restricted roads for RABN-compatible cars that busses and trucks cannot use; eye candy cars should use RAbP as the primary label if intended to support this)
| "PneuMetro" (Pneumatic Metro/Subway)
| I then N then i (Roadtype); N/A (Tramtype)
|-
| S
| "SolaRoad" (Solar Roadway) or "SmartStreet" (smartgrid network-enabled roads)
| Superscience/Supernatural/Special (For anything that isn't fuel and isn't based on any real energy source; psychokinetic, mana, creative energy, etc.)
| I then Z then E then G then N
|-
| V
| Viaduct/Voltaic Variant (For a second bridge variant of a road, or a trolleybus variant of a road with limited overhead clearance)
| "VacTube" (VacTrain Metro/Subway)
| P (Roadtype); N/A (Tramtype)
|-
|}

'''Specialized classes:'''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Road)
! Meaning (Tram)
! Vehicle set fallback
|-
| -
| N/A
| Cheat-like "electrification" for unified tramtype tunnels, to save on roadtype/tramtype labels make a single tramtype labelled EAbt and provide catenary sprites that place a "roof" but no (visible) rails (see [https://www.tt-forums.net/viewtopic.php?t=90804&hilit=Quast65+metro&start=60 Quast65's tramtypes] for potential graphics, GPL v2 license), and then provide a version with tram rails using a ??bt type. You should define one or two tramtypes with speed "t" ("Tunnel") and surface "0" ("Invisible") to provide road tunnels (e.g. 0tbt for single-height tunnels and 0tBt for high-clearance tunnels) as a decorative tramtype, whose catenary should override the trolleybus catenary with the eyecandy tram catenary. Use a, A, B, C, or c as stability if you plan to include a "tall tunnel" for double-decker vehicles.
| N/A; Do not set powered_railtype_list for these, instead use its' alternative_railtype_list to link compatible tramtypes to it.
|-
| X
| Multiple systems of electricity
| Multiple systems of electricity
| E; Use with surface X or x (e.g. XABX and xABX) or surface R (road, or a rail-based tramtype). For use only when at least one standardized label is an energy supply and multiple non-conflicting energy types are all at the same level, such as electrified, ground electrified and induction-charging overlap; Do not set powered_railtype_list for these, instead use alternative_railtype_list.
|-
| x
| N/A
| Multiple systems of guidance, height-incompatible
| N/A; Use this with surface x (e.g. xABx) or the surface systems (e.g. SABx, RABx, MABx). For use when tramtypes are at different heights but all are fundamentally incompatible (i.e. suspended monorail, trackless tram and pneumatic metro all on the same tile); Do not set powered_railtype_list for these, instead use alternative_railtype_list to link other railtypes to it.
|-
| +
| N/A
| Multiple systems of guidance, mix of compatible/height-incompatible
| For use when tramtypes are a mix of compatible and height-incompatible (i.e. electrified, ground electrified, trackless tram, suspended monorail, tram and pneumatic metro) tramtypes, provided their presence is possible in real life; Do not set powered_railtype_list for these, instead use alternative_railtype_list, or define these in another label's powered_railtype_list (i.e. XAB+ for XABN/XABE/XABX and RAB+ for RABN/RABE/RABX).
|-
| c
| "Cheat electrification" for network conversion; Arguably unneeded currently as there is only one type of road electrification as of this writing.
| "Cheat electrification" for network conversion; Anything where all instances of the real life systems co-existing in the real world are physically impossible, which obviously doesn't have much bearing on imaginary tramtypes but could be inferred that typical trains and monorails are not fictional and don't go well together.
| Define the "RA_c" for both roadtype and tramtype, totaling 2 label IDs. Define non-standard roadtypes in [[Roadtypes#Roadtype_properties alternative_roadtype_list]]/[[Tramtypes#Tramtype_properties|alternative_tramtype_list]] of "RA_c", and define "RA_c" in powered_roadtype_list for all other standardized roadtypes.
|}

Standardized Roadtype Scheme

2024-12-01T00:35:19Z

Brickblock1: Undo revision 4873 by Desertbus95 (talk)

This scheme was originally conceived in order to decrease the amount of necessary hidden road and tramtrack types. This is done by standardizing which labels vehicles and infrastructure should use. The standard also allows for more gameplay depth by having the option to limit vehicles to certain types of roads. It does similarly to the railtype scheme allow mixing of any vehicle set with any infrastructure set. It does however not allow multiple infrastructure sets to be used at the same time. It does not prevent it but all of the sets used have to be made to be used with each other, or use different surfaces/types which don't conflict with each other. The standard sets no limit on how vehicle sets can be used.

It is ultimately up to the infrastructure set to chose what roadtypes are available and thereby what vehicles are available. Infrastructure and vehicles can both be in the same set, it is however recommended to be able to disable the infrastructure with parameters (preferably on an individual basis per roadtype) in case the player wants to use a different set for their infrastructure.

* While this is a guide rather than a hard rule, it is recommended to think of standardized roadtypes vs. "fancy" roadtypes (not a default and not to this standard; for example "FNCY", "HAUL" and "NSTD" would be fancy labels but ROAD for roadtypes, and ELRL for tramtypes, would not) as a microcosm of the difference between a base set (OpenGFX) and a NewGRF that provides new graphics; The goal is for a basic roadtype set to cover as many standardized labels as is appropriate, and leave the more niche uses of the system to another set. This reduces the number of necessary roadtypes to a bare minimum, allowing optional roadtypes more room to cover corner cases.
** The reason to keep the above in mind is that if done in this way the effect works very differently than railtypes, where the primary concern is to allow gauge, energy source and so on to exist and bind trains from all sets to only the logically compatible railtypes. Roads and, by extension, streetcar tracks are more compatible with vehicles but also have much more variation. This is complicated by game engine limitations; only 60 - or 61 without ELRL - tracktype slots exist in recent versions of OpenTTD, but reaching that limit is usually a non-issue. Roadtypes and Tramtypes are considered the same on that front by the game engine, leaving 62 tramtypes - 64, including ROAD and ELRL - to be split in a pool between the two.

----

=== Surface / Type [X***] ===
Describes the road surface / rail type and thus the vehicle type.

'''Roadtype:'''

{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Road)
! Powered Roadtypes (Optional Powered)
! Recommended vehicle set fallbacks
! Notes
|-
| R
| Regular Road
| R, I, (S)
| R
| RABN = ROAD
|-
| P
| Passenger-only (busses, cars, bikes)
| R, P, (I), (S)
| P, then R
| HOV lane, public parking, or town road. Relevant non-standard types include TOWN, TRD_ and _TRD
|-
| g
| Bus lane (no AI street traffic)
| R, P
| P, then R
| Bus-exclusive road, or privately-owned parking lot. No guided bus sets or roadtypes exist yet but existing busses should be updated to use g and guided busses should also use it; for busses only.
|-
| G
| Guided busway (Specialized busses only)
| R, P, G
| P, then R
| Once g has been integrated into existing vehicle sets, new guided busses should use both g and G. Existing busses should NOT be updated to use G once roadtype sets provide it, guided busways are only for specially-equipped guided busses.
|-
| I
| Industrial Site (ISR)
| I
| R
| For tiles with concrete underneath, usually for use with Industrial Stations Renewal.
|-
| B
| Bicycle Lane
| B, b, P, R, (Z)
| R and b
| For bicycles that can serve as AI traffic
|-
| b
| Bus Lane with Bicycle Lane
| b
| R and B
| For bicycles that can serve as AI traffic crossing paths with a bus lane (see "g")
|-
| W
| Waterway
| W
| W and w
| For gondolas and other urban waterways.
|-
| A
| Amphibious on road (hidden)
| R, P, I, (S), W
| R and W
| Optionally, for amphibious road vehicles that are allowed on high speed roads with stability labels B (and possibly b), C or c (e.g. RABN, RACN and RAcN, and possibly RAbN) but not low speed roads.
|-
| S
| Snowy or Iced Track
| S
| R
| A road which is not plowed in winter, or an ice road.
|-
| a
| Amphibious on snow (hidden)
| SW
| S
| Optionally, for amphibious road vehicles that are allowed on rough roads with stability labels a, A or B (e.g. RAaN, RAAN and RABN, and possibly RAbN) but not highways or limited access motorways.
|-
| Z
| Pedestrian Zone
| Z
|
| Dedicated pedestrian zone, for use with some AI traffic eyecandy vehicle sets.
|-
| E
| Eyecandy
| E
|
| EAbi is the only label that should be defined for this. Set all eyecandy roadtypes to have custom labels and to be powered on EAbi.
|-
| p
| Pump/Pipeline
| p
|
| EAbi, EBbi, ECbi, EDbi and EEbi are the only labels that should be defined for this. These are for utility pipeline "vehicles" such as "pumps" which exclusively move liquid and gaseous cargo classes.
|}

'''Tramtype:'''

{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Tram)
! Powered Tramtypes (Optional Powered)
! Recommended vehicle set fallbacks
! Notes
|-
| R
| Regular Rail (1000 mm to 1067 mm)
| R, I, (M)
| R, then the ELRL label.
| Most mixed-use tramways are actually meter gauge, with standard gauge and similar widths of track making up the remainder.
|-
| P
| Passenger-only (1000 mm to 1067 mm)
| RPI(M)
| R
| Most streetcars are actually meter gauge, with standard gauge and similar widths of track making up the remainder.
|-
| I
| (ISR) Industrial Site (1000 mm to 1067 mm)
| I
| R
| Most mixed-use tramways are actually meter gauge, with standard gauge and similar widths of track making up the remainder.
|-
| B
| Bicycle Lane
| (R)B
| R
| For North American style bicycle lanes and cycling trails; does not allow U-Turns as it is a tramtype.
|-
| S
| Suspended Monorail
| S
|
| JP+ suspended monorail tracks. SABN is the only type that needs compatibility to be implemented.
|-
| M
| Metro (1000 mm to 1067 mm)
| If vehicle carries passengers, P then R; if vehicle carries freight, R.
|
| Some metro systems are actually meter gauge, with standard gauge and similar widths of track making up the majority. Sets should define both M?Bc and M?bc speed variants.
|-
| O
| Trackless trams
| Do not set fallbacks
|
| These use an optical guidance system to create a "virtual" tram track as a line painted on a road or a series of LED beacons. Sets should define (depending on which electrification methods will be desired in a vehicle roster) both O?BN/O?BE/O?BG/O?BZ and O?bN/O?bE/O?bG/O?bZ speed variants with both A-H road speeds and K-R high-friction speeds.
|-
| V
| Vacuum Tube Capsules
| Do not set fallbacks
|
| A futuristic tramway from the VacTram set, consisting of pneumatic tubes which propel small VacBalls at high speeds using pressure or lack of it. VEBi a as buildable type and and VACT as a hidden type are the only types that need to be implemented.
|-
| v
| Deep-Bore VacMetro
| Do not set fallbacks
|
| A futuristic metro system, in a more realistic manner than VacTrains and VacTrams. Ideally, would be implemented as vSbV and vUbV (narrow tube for single-deck trains), and as vSBV and vUBV (broad tube for the double-deck futuristic subway) with similar graphics to the Fake Subways Set and not the existing metro tunnels.
|-
| E
| Eyecandy/Electrical infrastructure (hidden)
| Do not set fallbacks
| Eyecandy, the only standardized type that should be defined is EEbc. Use as a fallback for i when a tramtype is decorative and electrical infrastructure could exist within it, to make bridges unnecessary for intersecting utility lines. These should be given graphics meant to be decorative but functional, such as
|
|-
| i
| Electrical infrastructure
| E, then the ELRL label
| Infrastructure, the only standardized type that should be defined is iEbi. Use for non-decorative "eyecandy" roadtypes meant to potentially carry electricity, phone, internet, etc.
|}

It is the vehicle set's responsibility to implement fallbacks to other appropriate surfaces. It is also up to the author to decide if they want to do it or not. This means that road/tramtrack sets shouldn't add these to their [[NML:Roadtypes#Roadtype_properties|alternative_roadtype_list (NML)]] and [[NML:Tramtypes#Tramtype_properties|alternative_tramtype_list (NML)]]

It is up to the track set to implement all powered roadtypes in the [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]]. The same goes for tramtypes: [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]]. It is further advised to implement support for the roadtypes/tramtypes in brackets, if applicable.

Hidden roadtypes for compatibility should be implemented by road sets. It is up to the author to decide if they want to implement it as a hidden roadtype or not.

=== Speed / Feature [*X**] ===
Any character may be used for roads, but at least one road must have "A". It has been proposed that speeds from A to H are reserved for standardized roadtype and tramtype labels. Speeds from K to R and from k-r would only be reserved for tramtypes which have comparable surface friction to a road vehicle, and would not need to be dedicated to special traction in a roadtype set that does not include tramtypes.
{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved (road & tram)
|-
|a-h ||fixed-route transport, that allows a vehicle to not slow down going uphill but requires dedicated tracks or infrastructure; use for ski chair lifts, industrial cable lifts, and the Wuppertal monorail. ||special ||none yet
|-
|I-J ||general use ||colspan="2"| unreserved
|-
|K-R ||high-friction with unfixed position, that allows a tram vehicle to go uphill and downhill under the same mechanics as road vehicles; use for cable-drawn streetcars, conveyor belts and trackless trams. ||special ||none yet
|-
|k-r ||high-friction with unfixed position, that allows a tram vehicle to go uphill under the same mechanics as road vehicles but requires a dedicated Right-of-Way; Rubber-tired rail transport, including Paris/Quebec metro and some suspended monorails, goes here. ||colspan="2"| unreserved
|-
|S ||suburban tunnel ||eyecandy ||Metro Tram Set
|-
|T ||general use ||colspan="2"| unreserved
|-
|U ||urban ||eyecandy ||Metro Tram Set
|-
|V-Z ||general use ||colspan="2"| unreserved
|-
|s-z ||general use ||colspan="2"| unreserved
|-
|0-9 ||general use ||colspan="2"| unreserved
|}
All other characters which are valid (you'll get a warning from nmlc if they aren't) are also currently unrserved and are likely to remain so.

High-friction and fixed-route need a bit greater of a explanation. They are based on the intended system for rack rails in the [[Standardized_Railtype_Scheme#Speed_limit_class_.5B.2AX.2A.2A.5D Standardized Railtype Scheme]]. As of 2024, the French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

In this case the problem is similar but worse. Ideally it would be coded in a way where all systems are only supported if such would be possible in real life. This can be partly achieved by making regular trams powered on a rackrail-equivalent such as a cablecar track (i.e. San Francisco cablecars) without the opposite being true, and by making others such as rubber-tired metros only run on rubber-tire compatible tracks. This means vehicles defined for RABC (SFBA cablecar) can't go on RABN (like a pure rack system) but RABN vehicles (meter-gauge steam/deisel/battery trams) can go on RABC (like a rack-and-adhesion system). However, there is no way to force a tram to adhere to the speed limits of the roadtype (rather than just the tramtype) it is currently on, nor any way to bar a tramtype from overlapping on roadtypes.

''Should this be implemented, K-R would be equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only. Finally, a-h would be equivalent to A-H for systems where the "vehicles" are adjoined to a cable or propelled via outside factors, such as pipelines, electrical/phone/internet lines, ski lifts and industrial bucket lifts.''

Vehicles should use "A", "a", "K" or "k" accordingly; if in doubt, assume "A".

=== Terrain / Stability [**X*] ===
Describes the roughness of the road surface / trackbed stability, and thus the vehicle tier.
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning
! Powered Roadtypes
|-
| a
| Very slow / rough / light
| a
|-
| A
| Slow / rough / light
| aAB
|-
| B
| Regular
| ABC
|-
| C
| Fast / stable
| BCc
|-
| c
| Very fast / stable
| c
|}

If all classes aren't defined by the road set, the other ones should be in the [[NML:Roadtypes#Roadtype_properties|alternative_roadtype_list (NML)]]. The same goes for tramtypes: [[NML:Tramtypes#Tramtype_properties|alternative_tramtype_list (NML)]].

Road vehicle sets should not implement fallbacks for terrain / stability.

Classes "a" and "c" are entirely optional for road/tramtype sets and should under no circumstances be used by vehicles.

=== Energy [***X] ===
Describes the energy source of the track / vehicle.

'''Generic classes:'''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Road)
! Meaning (Tram)
! Vehicle set fallback
|-
| N
| None
| None
|
|-
| E
| Overhead electrified (Catenary)
| Overhead electrified (Catenary)
|
|-
| G
| Ground electrified
| Ground electrified
|
|-
| Z
| Ground and overhead electrified
| Ground and overhead electrified
| E or G
|}
'''Specialized classes:'''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Road)
! Meaning (Tram)
! Vehicle set fallback
|-
| 3
| n/a
| Third Rail
| G
|-
| 4
| n/a
| Fourth Rail
| 3 then G
|-
| C
| n/a
| Cable
| G
|}
A tramtrack set that only uses specialized types, should map the generic types to the most suitable specialized type in the set with the help of the [[NML:Tramtypes#Tramtype_properties|alternative_tramtype_list (NML)]].

=== The default labels (ROAD, ELRL) and non-standard labels===
OpenTTD will allways define ROAD and ELRL incase there are vehicles for them. It is therefore recomended to have these present in the set so that you can map them to appropriete labels from the standard. There are a few ways of doing this:
*Replacing one of the standardised types with the default label and putting the standardised label in the [[NML:Roadtypes#Roadtype_properties|alternative_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|alternative_tramtype_list (NML)]].
*Defining ROAD and/or ELRL separately from the standardised labels and adding the standard ones to the [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]]. The main advantage of this is that you can use a parameter to map ROAD and/or ELRL to the standardised labels. This allows the player to chose where there non standardised vehicles will be able to go.

Vehicle set authors might want to add the default labels and non-standard labels as a fallback. If not implemented for the defualt labels, their vehicles won't show up on the default roads and/or tracks, leading to countless bug reports from players. Non standard labels that might be worth adding fallbacks too are: ELRD, RAIL, HAUL and probably some more.

== Summary for Road/Tramtrack sets ==
This section summarizes the above for road/tramtrack sets.

; [X***] Surface / Type
* Chose which Surfaces and types you want in your set and give them the correct [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]].
* If you only provide roads/tramtracks for one surface/type, consider leaving some free road/tramtypes so a player can load an additional set for some other type.
; [*X**] Speed / Feature
* Make sure class A is always available.
* Use B, C and so on if you have multible roads/tramtracks with the otherwise the same label.
; [**X*] Terrain / Stability
* Always define classes A through C for every road/tramtrack surface/type energy combination, either:
** Directly via a real road/tramtype definition;
** Indirectly via the alternate road/tramtype label list, [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]].
; [***X] Energy source type class
* If your set only uses specialized classes, always map the generic classes to the closest matching specialized type via [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]].
; Default labels [ROAD, ELRL] and non-standard labels
* Always define the default labels when possible, instead of what would be the equivalent of the default label in this scheme.
* Map the equivalent labels from this scheme to the default labels using [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]].
* Map common non-standard labels to the most similar label in this scheme using [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] or [[NML:Tramtypes#Tramtype_properties|powered_tramtype_list (NML)]].

== Summary for vehicle sets ==
This section summarizes the above for vehicle sets.

; [X***] Surface / Type
* Use the surface / type class that matches the vehicle;
* Define a fallback type via the road/tramtype table in case you want the vehicle to be available on a different road or tramtrack if no matching road/tramtrack set is loaded.
** Specialized subtypes like "G" might not always be available. If you want those vehicles to be still available then, fall back the the generic class (e.g. "P" or "R").
; [*X**] Speed / Feature
* Always use class A for every vehicle, unless you are absolutely certain you will be introducing something cable-drawn, with tires as traction, or with a rack rail.
; [**X*] Terrain / Stability
* Use A, B or C depending on where you want your vehicles to be able to drive.
** A is used for slow offroad capable vehicles which aren't allowed on Motorways and similar Roads
** B is used for vehicles which can drive offroad but are also allowed on Motorways.
** C is used for vehicles which can't go offroad or similar.
** Use B if you aren't sure what to chose.
* Never use a or c.
; [***X] Energy source type class
* Use the energy source type class that matches the vehicle;
* When using specialized classes, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; Default labels [ROAD, ELRL] and non-standard labels
* Define a fallback type to the default labels via the road/tramtype table in case you want the vehicle to be available on the default roads/track if no matching set is loaded.
* Do the same for any non-standard labels that may be relevant.

Be as specific as you want when selecting the road/tramtype, it is the job of the road/track set to select a playable, reduced subset out of all possible type combinations.
=== Example of fallback order for vehicle sets ===
{| class="wikitable"
|- style="font-style:italic;"
! Unchanged label
! Fallback order
|-
| GACE (road)
| GACE -> PACE -> RACE -> (ROAD)
|-
| PAB4 (tram)
| PAB4 -> PAB3 -> PABG -> RAB4 -> RAB3 -> RABG
|-
| IAAG (road)
| IAAG -> RAAG
|-
| AACE (road)
| AACE -> RAAE -> (ELRD)
|-
| RABE (tram)
| RABE -> (ELRL)
|-
| PAAN (tram)
| PAAN -> RAAN -> (RAIL)
|}
== Forum topic ==
Feel free to discuss and ask questions about the scheme at the forum topic [https://www.tt-forums.net/viewtopic.php?t=90715 Here].

=== Possible additions ===
To be discussed in the forum topic...

==== Surface / Type [X***] ====
Describes the road surface / rail type and thus the vehicle type.

'''Tramtype:'''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Tram)
! Powered Tramtypes
! Recomended vehicle set fallbacks
|-
| Z
| Deep-Bore Metro
| (For subsurface logistics systems that are normally never visible on the surface)
|
|-
| z
| Passenger-only (Deep-Bore Metro)
| (For subsurface metro systems that are normally never visible on the surface)
|
|-
| X or x
| Multiple guidance systems or gauges
| (Depends on intent; only two tramtype rail system combinations can exist for a given set of standardized labels - i.e. XABE and xABE - making it necessary to plan accordingly)
|
|-
| 0 (#)
| Invisible
| For invisible tramtypes; Fallback for INVI, BKVI, 0000 and other "null" tramtypes
|
|-
| s
| Regular Rail (Standard Gauge)
| r
|
|-
| p
| Passenger-only (Standard Gauge)
| r
|
|-
| r
| Multi-gauge Rail (Standard Gauge, Metre Gauge, 600mm Gauge)
| s, R, p, P
| P or p, depending on the vehicle's gauge (City tram); R, s or 6, depending on the vehicle's gauge (Cargo tram)
|-
| 6
| Industrial Tramway (600mm Gauge - default tramway rails graphics)
| r
|
|-
|}

==== Terrain / Stability [**X*] ====
Describes the roughness of the road surface / trackbed stability, and thus the vehicle tier. ''(This is edited to include the potential "Low Clearance" hidden roadtype.)''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning
! Powered Roadtypes
|-
| a
| Very slow / rough / light
| aA
|-
| A
| Slow / rough / light
| aAB
|-
| B
| Regular
| ABC
|-
| b
| Regular (Low clearance)
| ABC
|-
| C
| Fast / stable
| BCc
|-
| c
| Very fast / stable
| Cc
|}

If all classes aren't defined by the road set, the other ones should be in the [[NML:Roadtypes#Roadtype_properties|alternative_roadtype_list (NML)]]. The same goes for tramtypes: [[NML:Tramtypes#Tramtype_properties|alternative_tramtype_list (NML)]].

Road vehicle sets should not implement fallbacks for terrain / stability. Class "b" should only be used for a hidden roadtype, such as "RAbN", "PAbN" and electrified variants. This is optional, but if used it should be applied to the [[NML:Vehicles#Road_vehicle_properties|roadtype (NML) or tram_type (NML)]] property of all vehicles able to travel under the relevant low-clearance obstacles.

* ''As a frame of reference, realistically "RAbN" should be used for all eye-candy cars small cargo vans and single-decker non-electrified cargo trams, while trucks (excluding trolleytrucks) and non-electrified double-decker trams should default to "RABN". "RAbE" and other powered vehicles should be used by trolleytrucks and electric cargo trams (excluding double-decker trams). "PAbN" should be used by double-decker busses, and most non-electric trams (excluding double-decker trams). "PAbE" should be used by most passenger trams, excluding double-decker passenger trams. For other energy sources, the instructions for"RAbE" and "PAbE" can easily be adapted for any other power source ("RAbG" and "PAbG", "RAbI" and "PAbI", etc.).''

Classes "a" and "c" are entirely optional for road/tramtype sets and should under no circumstances be used by vehicles.

Class "b" is also optional for road/tramtype sets but should have ROADTYPE_FLAG_HIDDEN set in the bitmask of [[NML:Roadtypes#Roadtype_properties|roadtype_flags (NML)]]. Instead, a low-clearance variant of a standardized roadtype or tramtype should be compatible with all other standard classes ("a", "A", B", "C" and "c") using the [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] in a road/tramtype set that sets the standardized labels (i.e. "RAbN" should be used for small cargo vans and must fallback to "RAaN, RAAN, RABN, RACN, RAcN", and "PAbE" should be used by all busses and must fallback to "PAaN, PAAN, PABN, PACN, PAcN"). If a complex roadtype (i.e. RAaN) needs a low-clearance variant, create a non-standard label (i.e. XMPL), then define the relevant standard labels (RAaN in this case, and RAbN in turn) in the [[NML:Roadtypes#Roadtype_properties|alternative_roadtype_list (NML)]] of the non-standard label (XMPL), and define the entire class of labels (RAaN, RAAN, RABN, RAbN, RACN, RAcN) in the [[NML:Roadtypes#Roadtype_properties|powered_roadtype_list (NML)]] of the non-standard label (XMPL).

==== Energy [***X] ====
Describes the energy source of the track / vehicle.

'''Generic classes:'''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Road)
! Meaning (Tram)
! Vehicle set fallback
|-
| I
| Induction-charge electrified
| Induction-charge electrified
| Z then G then N
|-
| i
| Eyecandy/Pipeline Infrastructure
| Eyecandy/Electric & Telecom Infrastructure
| Z then E then G then I
|-
| L
| Reclaimed Elevated Rail Eco-Park
| Elevated Rail
| I then Z then G then N (Roadtype); E then Z then G then I (Tramtype)
|-
| P
| No Commercial Vehicles/Parking Lot (restricted roads for RABN-compatible cars that busses and trucks cannot use; eye candy cars should use RAbP as the primary label if intended to support this)
| "PneuMetro" (Pneumatic Metro/Subway)
| I then N then i (Roadtype); N/A (Tramtype)
|-
| S
| "SolaRoad" (Solar Roadway) or "SmartStreet" (smartgrid network-enabled roads)
| Superscience/Supernatural/Special (For anything that isn't fuel and isn't based on any real energy source; psychokinetic, mana, creative energy, etc.)
| I then Z then E then G then N
|-
| V
| Viaduct/Voltaic Variant (For a second bridge variant of a road, or a trolleybus variant of a road with limited overhead clearance)
| "VacTube" (VacTrain Metro/Subway)
| P (Roadtype); N/A (Tramtype)
|-
|}

'''Specialized classes:'''
{| class="wikitable"
|- style="font-style:italic;"
! Letter
! Meaning (Road)
! Meaning (Tram)
! Vehicle set fallback
|-
| -
| N/A
| Cheat-like "electrification" for unified tramtype tunnels, to save on roadtype/tramtype labels make a single tramtype labelled EAbt and provide catenary sprites that place a "roof" but no (visible) rails (see [https://www.tt-forums.net/viewtopic.php?t=90804&hilit=Quast65+metro&start=60 Quast65's tramtypes] for potential graphics, GPL v2 license), and then provide a version with tram rails using a ?Abt tramtype. You should define one or two tramtypes with speed "t" ("Tunnel") and surface "0" ("Invisible") to provide road tunnels (e.g. 0tbt for single-height tunnels and 0tBt for high-clearance tunnels) as a decorative tramtype, whose catenary should override the trolleybus catenary with the eyecandy tram catenary. Use a, A, B, C, or c as stability if you plan to include a "tall tunnel" for double-decker vehicles.
| N/A; Do not set powered_railtype_list for these, instead use its' alternative_railtype_list to link compatible tramtypes to it.
|-
| X
| Multiple systems of electricity
| Multiple systems of electricity
| E; Use with surface X or x (e.g. XABX and xABX) or surface R (road, or a rail-based tramtype). For use only when at least one standardized label is an energy supply and multiple non-conflicting energy types are all at the same level, such as electrified, ground electrified and induction-charging overlap; Do not set powered_railtype_list for these, instead use alternative_railtype_list.
|-
| x
| N/A
| Multiple systems of guidance, height-incompatible
| N/A; Use this with surface x (e.g. xABx) or the surface systems (e.g. SABx, RABx, MABx). For use when tramtypes are at different heights but all are fundamentally incompatible (i.e. suspended monorail, trackless tram and pneumatic metro all on the same tile); Do not set powered_railtype_list for these, instead use alternative_railtype_list to link other railtypes to it.
|-
| +
| N/A
| Multiple systems of guidance, mix of compatible/height-incompatible
| For use when tramtypes are a mix of compatible and height-incompatible (i.e. electrified, ground electrified, trackless tram, suspended monorail, tram and pneumatic metro) tramtypes, provided their presence is possible in real life; Do not set powered_railtype_list for these, instead use alternative_railtype_list, or define these in another label's powered_railtype_list (i.e. XAB+ for XABN/XABE/XABX and RAB+ for RABN/RABE/RABX).
|-
| c
| "Cheat electrification" for network conversion; Arguably unneeded currently as there is only one type of road electrification as of this writing.
| "Cheat electrification" for network conversion; Anything where all instances of the real life systems co-existing in the real world are physically impossible, which obviously doesn't have much bearing on imaginary tramtypes but could be inferred that typical trains and monorails are not fictional and don't go well together.
| Define the "RA_c" for both roadtype and tramtype, totaling 2 label IDs. Define non-standard roadtypes in [[Roadtypes#Roadtype_properties alternative_roadtype_list]]/[[Tramtypes#Tramtype_properties|alternative_tramtype_list]] of "RA_c", and define "RA_c" in powered_roadtype_list for all other standardized roadtypes.
|}

CargoTypes

2024-11-16T16:38:53Z

Brickblock1: /* Cargo Labels */ Remove firs and link to firs docs instead by request from Andythenorth

'''Cargo labels in OpenTTD'''

{{grfFrom|8}} In GRF version 8 the value to be used in all vehicle and industry properties, and in [[Action3|action 3]], is the position of the cargo label in the [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]] included in the GRF.

{{grfTill|7}} GRF version 7 and below used different cargo properties for different properties (called "Type A" or "translated" and "Type B" or "untranslated" cargo slots), for historical reasons. This method is deprecated as it meant relying solely on cargos always using the same slots. You can see the table of Type A and Type B slots [http://newgrf-specs.tt-wiki.net/index.php?title=CargoTypes&oldid=2861 here] if you really want to.

{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate (see [[CargoDefaultProps]]) is used if one is not provided.<br/>
{{grfFrom|8}} In GRF version 8, the default translation table is 32 entries long and maps "Type B" slots to each cargo label.<br/>
{{grfTill|7}} In GRF version 7, the default translation table is 12 entries long and uses "Type A" slots to each cargo label.<br/>
The default translation table works just like a GRF provided table: If a cargo label is redefined in a different slot this is correctly translated, and if the cargo label is replaced the cargo type is mapped to invalid.

== Cargo Labels ==

The following cargo labels have been defined so far:

{|class="wikitable"
|-
! Label
! Cargo Description
! [[Action0Cargos#CargoClasses_.2816.29|Cargo classes]]
! colspan="7" | Usage
! Notes
|-
| align="center" colspan="2" | '''Basic Cargos'''
| align="center" colspan="9" | These cargos are present when no NewGRF is used, or in some common Industry NewGRFs
|-
| PASS
| Passengers
| 0001 Passengers
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
|
|-
| COAL
| Coal
| 0010 Bulk
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
|
|-
| MAIL
| Mail
| 0002 Mail
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
|
|-
| OIL_
| Oil
| 0040 Liquid
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| GOOD
| Goods
| 0004 Express
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
|
|-
| GRAI
| Grain
| 0010 Bulk
| style="background: #CC00CC; color: black" | TTD
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
| Temperate; see also WHEA, MAIZ, CERE. YETI & OTIS: 0210 Covered, bulk
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
| Named Logs in some industry sets (2TT)
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
| YETI: Renamed "Balls of Steel", OTIS: Renamed "Metal"
|-
| VALU
| Valuables
| 0008 Armoured
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
| Temperate; see also GOLD, DIAM
|-
| PAPR
| Paper
| 0020 Piece goods
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
| OTIS: 0220 Covered, piece goods
|-
| WHEA
| Wheat
| 0010 Bulk
| style="background: #CC00CC; color: black" | TTD
|
|
|
|
|
|
| Arctic; see also GRAI, MAIZ, CERE
|-
| FOOD
| Food
| 0084 Express, refrigerated
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
| YETI: 00A0 Refrigerated, piece goods
|-
| GOLD
| Gold
| 0008 Armoured
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|
|
| Arctic; see also VALU, DIAM
|-
| RUBR
| Rubber
| 0040 Liquid
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| XIS: 00A4 Express, piece goods, refrigerated, YETI: 00A0 Piece goods, covered.
|-
| MAIZ
| Maize
| 0010 Bulk
| style="background: #CC00CC; color: black" | TTD
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
| Tropic; see also GRAI, WHEA, CERE. OTIS: Renamed "Animal Feed"
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
| OTIS: 0044 Express, liquid
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #CC00CC; color: black" | TTD
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
| Tropic; see also VALU, GOLD
|-
| SUGR
| Sugar
| 0010 Bulk
| style="background: #CC00CC; color: black" | TTD
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Toyland
|-
| AORE
| Bauxite (Aluminium ore)
| 0010 Bulk
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| BDMT
| Building Materials
| 0220 Piece goods, covered/sheltered
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| XIS: 0030 Bulk, piece goods. YETI: 0020 Piece goods.
|-
| BEAN
| Beans
| 0010 Bulk
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| CZIS renamed to Potatoes
|-
| BEER
| Alcohol
| 0064 Express, piece goods, liquids
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
|
|-
| BOOM
| Explosives
| 0024 Express, piece goods
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
| OTIS: 0124 Express, Piece goods, hazardous
|-
| BRCK
| Bricks
| 0020 Piece goods
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|
|
|
|-
| CBLK
| Carbon Black
| 0230 Piece goods, bulk, covered/sheltered
|
|
|
|
|
|
|
|
|-
| CERA
| Ceramics
| 0020 Piece goods
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|
|
|
|-
| CERE
| Cereals
| 0210 Bulk, covered/sheltered
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|
|
| ECS: <ref name="ecs_cargo_change" />
|-
| CLAY
| Clay
| 0210 Bulk covered/sheltered
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| CMNT
| Cement
| 0210 Bulk covered/sheltered
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| COPR
| Copper
| 0020 Piece goods
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| CSTI
| Cast Iron
| 0020 Piece goods
|
|
|
|
|
|
|
|
|-
| CTAR
| Coal Tar
| 0140 Liquids, hazardous
|
|
|
|
|
|
|
|
|-
| DYES
| Dyes
| 0060 Piece goods, liquids
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|
|
|
|-
| ENSP
| Engineering Supplies
| 0024 Express, piece goods
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
| 2TT Industries of the Caribbean: named Machinery
|-
| FECR
| Ferrochrome
| 0010 Bulk
|
|
|
|
|
|
|
|
|-
| FERT
| Fertiliser
| 0030 Bulk, piece goods
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| OTIS: 0034 Express, piece goods, bulk. XIS: 0230 Covered, piece goods, bulk. ECS: <ref name="ecs_cargo_change" />
|-
| FICR
| Fibre crops
| 0030 Bulk, piece goods
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
| OTIS: 0230 Piece goods, bulk, covered/sheltered, renamed "Cotton"
|-
| FISH
| Fish
| 0084 Express, refrigerated
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
|
|-
| FMSP
| Farm Supplies
| 0024 Express, piece goods
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| GLAS
| Glass
| 0420 Piece goods, oversized
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
| style="background: #FF0000; color: white" | CZIS
| OTIS: 0410 Piece goods, bulk
|-
| GRVL
| Stone
| 0010 Bulk
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| Renamed from "Gravel / Ballast" XIS: Renamed "Aggregate"
|-
| JAVA
| Coffee
| 0024 Piece goods, express
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
|
|-
| KAOL
| Kaolin (China Clay)
| 0250 Bulk, liquids, covered
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
| XIS: Renamed "Lithium"
|-
| LIME
| Lime stone
| 0010 Bulk
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| MILK
| Milk
| 00C4 Express, liquid, refrigerated
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| OLSD
| Oil seed
| 0210 Bulk, covered/sheltered
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|
|
| ECS: <ref name="ecs_cargo_change" />
|-
| PEAT
| Peat
| 0010 Bulk
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
| XIS: Renamed "Biomass"
|-
| PETR
| Petrol / Fuel Oil
| 0040 Liquid
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| OTIS: 0130 Hazardous, liquid
|-
| PHOS
| Phosphate
| 0010 Bulk
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
| XIS: Renamed "Oil sands"
|-
| PLAS
| Plastic
| 0060 Piece goods, liquid
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| PORE
| Pyrite Ore
| 0010 Bulk
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
| XIS: Renamed "Zinc ore"
|-
| POTA
| Potash
| 0210 Bulk, covered/sheltered
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|
|
| ECS: <ref name="ecs_cargo_change" />
|-
| RFPR
| Refined products
| 0040 Liquid
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
| OTIS: renamed "Sewage", XIS: renamed "Petrochemicals"
|-
| SAND
| Sand
| 0010 Bulk
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| SCMT
| Scrap Metal
| 1010 Bulk, non-pourable
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| OTIS: Renamed "Waste/Garbage"
|-
| SULP
| Sulphur
| 0250 Bulk, liquid, covered/sheltered.
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| ECS: 0210 Bulk, covered/sheltered <ref name="ecs_cargo_change">ECS cargo classes changed as of Dec 31, 2010</ref>
|-
| TOUR
| Tourists
| 0005 Passengers, express
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| ECS; see also OTI2
|-
| TYRE
| Tyres
| 0020 Piece goods
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| URAN
| Uranium
| 0110 Bulk, hazardous
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| 2TT: Piece goods, hazardous
|-
| VEHI
| Vehicles
| 0420 Piece goods, oversized
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| XIS: 0020 Piece goods. OTIS: 0020 Piece goods, renamed "Cars"
|-
| WDPR
| Wood Products
| 0030 Bulk, piece goods
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
| XIS & OTIS: Renamed "Timber"
|-
| WOOL
| Wool
| 0220 Piece goods, covered/sheltered
|
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
| ECS: <ref name="ecs_cargo_change" />
|-
| ZINC
| Zinc
| 0020 Piece goods
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
|
|-
| align="center" colspan="2" | '''Extended Cargos'''
| align="center" colspan="9" | these cargos are only present in rare/specialized situations
|-
| ACID
| Acid
| 0140 Liquids, hazardous
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| ALUM
| Aluminium
| 0020 Piece goods
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
| See also METL
|-
| BAKE
| Flour
| 0A30 Bulk, powderized, piece goods, covered
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| CASS
| Cassava
| 0010 Bulk
|
|
|
|
|
|
|
|
|-
| CHLO
| Chlorine
| 0140 Liquids, hazardous
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
|
|-
| CHSE
| Cheese
| 00C4 Express, liquid, refrigerated
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| CIGR
| Cigars
| 0024 Piece goods, express
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Industries of the Caribbean
|-
| COAT
| Paints & Coatings
| 0060 Piece goods, liquids
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| 2TT Lumberjack Industries: renamed Varnish
|-
| COBL
| Cobalt
| 0020 Piece goods
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Industries of the Caribbean
|-
| COKE
| Coke
| 0010 Bulk
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| ELTR
| Electricity
| 8000 Special
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|CZIS uses its own labels... see ELEC and NODC
|-
| EOIL
| Edible Oil
| 0060 Piece goods, liquids
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
|
|-
| FRVG
| Fruit (and optionally Vegetables)
| 00A4 Express, piece goods, refrigerated
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
| See also FRUT
|-
| FUEL
| Natural Gas
| 0140 Liquid, hazardous
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Use PETR for refined-oil fuel
|-
| FURN
| Furniture
| 0230 Piece goods, bulk, covered
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| IRON
| Pig Iron
| 0020 Piece goods
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
|
|-
| LYE_
| Sodium Hydroxide (Lye)
| 0140 Liquids, hazardous
|
|
|
|
|
|
|
|
|-
| MEAT
| Meat
| 00A4 Express, piece goods, refrigerated
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| METL
| Metal
| 0020 Piece goods
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
| XIS: Renamed "Aluminium"; See also ALUM
|-
| MNO2
| Manganese
| 0010 Bulk
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
|
|-
| MNSP
| Manufacturing Supplies
| 0024 Piece goods, express
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| XIS: Renamed "Packaging"
|-
| MOLS
| Molasses
| 0040 Liquid
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Industries of the Caribbean
|-
| MPTS
| Machine parts
| 0220 Covered, piece goods
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| NH3_
| Ammonia
| 0140 Liquids, hazardous
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| NHNO
| [https://en.wikipedia.org/wiki/Ammonium_nitrate NH4NO3 chemical]
| 0130 Hazardous, bulk, piece goods
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| NUTS
| Nuts
| 0020 Piece goods
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
|
|-
| NICK
| Nickel
| 0010 Bulk
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
|
|-
| NITR
| Nitrate
| 0010 Bulk
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| NKOR
| Nickel ore
| 0010 Bulk
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| OTIS: Renamed "Nickel"
|-
| NUKF
| Nuclear fuel
| Piece goods, hazardous
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Improved Town Industries
|-
| NUKW
| Nuclear waste
| Piece goods, hazardous
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Improved Town Industries
|-
| OILI
| Oil (imported)
| 0040 Liquid
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Industries of the Caribbean
|-
| OILD
| Oil (domestic)
| 0040 Liquid
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Industries of the Caribbean
|-
| OTI1
| Workers
| 0001 Passengers
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| OTI2
| Tourists
| 0001 Passengers
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| OYST
| Oysters
| 00A4 Express, piece goods, refrigerated
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| O2__
| Oxygen
| 0040 Liquids
|
|
|
|
|
|
|
|
|-
| PACK
| Packaging
| 0020 Piece goods
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
|Packaging used mostly for food production.
|-
| PCL_
| Parcels
| 0006 Express, mail
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| PIPE
| Pipe
| 0020 Piece goods
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
| style="background: #FF0000; color: white" | CZIS
|
|-
| POWR
| Electrical Parts
| 0020 Piece goods
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| OTIS: 0220 Covered, piece goods, renamed "Electrical Machines". XIS and CZIS: Renamed "Electrical Machines"
|-
| QLME
| Quicklime
| 0210 Bulk, covered/sheltered
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| RCYC
| Recyclables
| 0030 Bulk, piece goods
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
|
|-
| SALT
| Salt
| 0010 Bulk
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
|
|-
| SASH
| Soda Ash
| 0210 Bulk, covered/sheltered
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
|
|
|-
| SEED
| Seed
| 0230 Piece goods, bulk, covered
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| SESP
| Marine Supplies
| 0024 Express, piece goods
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| SGBT
| Sugar beet
| 0010 Bulk
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| not in tropical
|-
| SGCN
| Sugarcane
| 1010 Bulk, non-pourable
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| only tropical
|-
| SLAG
| Slag
| 0010 Bulk
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| SOAP
| Cleaning Agents
| 0060 Piece goods, liquids
|
|
|
|
|
|
|
|
|-
| STAL
| Alloy Steel
| 0020 Piece goods
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| STCB
| Carbon Steel
| 0020 Piece goods
|
|
|
|
|
|
|
|
|-
| STSE
| Steel Sections
| 0020 Piece goods
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| STSH
| Steel Sheet
| 0020 Piece goods
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| STST
| Stainless Steel
| 0020 Piece goods
|
|
|
|
|
|
|
|
|-
| STWR
| Steel Wire Rod
| 0020 Piece goods
|
|
|
|
|
|
|
|
|-
| TATO
| Potatoes
| 00A4 Express, piece goods, refrigerated
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
| CZIS uses renamed Beans
|-
| TEXT
| Textile
| 0220 Piece goods, covered
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
|
|-
| TBCO
| Tobacco
| 1010 Bulk, non-pourable
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Industries of the Caribbean
|-
| TWOD
| Tropic Wood
| 0020 Piece goods
|
|
|
| style="background: #D1D1D1; color: black" | [[ttwiki:OTIS|OTIS]]
|
|
|
| formerly intended as a default cargo
|-
| VBOD
| Vehicle bodies
| 0020 Piece goods
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| VENG
| Vehicle Engines
| 0020 Piece goods
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
|
|-
| VPTS
| Vehicle Parts
| 0024 Piece goods, express
|
|
|
|
| style="background: #80A0D0; color: white" | [[ttwiki:XIS|XIS]]
|
| style="background: #FF0000; color: white" | CZIS
| XIS: 0020 Piece goods, renamed "Parts"
|-
| WSTE
| Waste
| 0230 Piece goods, bulk, covered
|
|
|
|
|
| style="background: #B4A7D6; color: white" | [[ttwiki:2TT|2TT]]
|
| Used by Improved Town Industries.
|-
| align="center" colspan="2" | '''Fantasy Cargos'''
| align="center" colspan="9" | these cargos are for use in fantasy or science fiction settings
|-
| BATT
| Batteries
| 0020 Piece goods
| style="background: #CC00CC; color: black" | TTD
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|
|
|
| Toyland
|-
| BUBL
| Bubbles
| 0020 Piece goods
| style="background: #CC00CC; color: black" | TTD
|
|
|
|
|
|
| Toyland
|-
| COLA
| Cola
| 0040 Liquid
| style="background: #CC00CC; color: black" | TTD
|
|
|
|
|
|
| Toyland
|-
| CTCD
| Cotton Candy (Candyfloss)
| 0010 Bulk
| style="background: #CC00CC; color: black" | TTD
|
|
|
|
|
|
| Toyland
|-
| FZDR
| Fizzy Drinks
| 0020 Piece goods
| style="background: #CC00CC; color: black" | TTD
|
|
|
|
|
|
| Toyland
|-
| PLST
| Plastic
| 0040 Liquid
| style="background: #CC00CC; color: black" | TTD
|
|
|
|
|
|
| Toyland; see also PLAS
|-
| SWET
| Sweets (Candy)
| 0004 Express
| style="background: #CC00CC; color: black" | TTD
|
|
|
|
|
|
| Toyland
|-
| TOFF
| Toffee
| 0010 Bulk
| style="background: #CC00CC; color: black" | TTD
|
|
|
|
|
|
| Toyland
|-
| TOYS
| Toys
| 0020 Piece goods
| style="background: #CC00CC; color: black" | TTD
|
|
|
|
|
|
| Toyland
|-
| YETI
| Workers, YETI dudes
| 0404 Express, oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|
|
|
|
|-
| YETY
| Tired Workers, Tired YETI dudes
| 0404 Express, oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|
|
|
|
|-
| ELEC
| Charged Batteries (electricity from PP)
| 0020 Piece goods
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
| Used as means of electricity transportation.
|-
| NODC
| Uncharged Batteries (return of batteries) aka No Direct Current
| 0020 Piece goods
|
|
|
|
|
|
| style="background: #FF0000; color: white" | CZIS
|Used as means of electricity transportation.
|-
| align="center" colspan="2" | '''Special Cargos'''
| align="center" colspan="9" | these cargos are for use outside industry sets and do not represent transporting anything
|-
| GEAR
| Locomotive regearing
| 8000 Special
|
|
|
|
|
|
|
| Using this cargo may make your vehicle set incompatible with some industry sets
use CB36 instead to set capacity to 0
|-
| align="center" colspan="2" | '''Deprecated Cargos'''
| align="center" colspan="9" | these cargos are not used by any current industry set, and are listed here for backwards compatibility
|-
| RSGR
| Raw Sugar
| 0010 Bulk
|
|
|
|
|
|
|
| Deprecated see SGBT and SGCN
|-
| SCRP
| Scrap Metal
| 0010 Piece goods
|
|
|
|
|
|
|
| Deprecated see SCMT instead
|}

<references />

An overview of FIRS cargos is avaliable [https://grf.farm/firs/code_reference_latest.html here] for the latest version.

If you write or publish a NewGRF which introduces a new cargo label, please also add a comment where the new label is used.

Standardized Railtype Scheme

2024-09-24T08:01:51Z

Brickblock1: /* Rail System/Gauge [X***] */

This railtype label scheme aims to bring order to the uncontrolled growth of railtype labels. It groups the rail types into what matters from a technical perspective. The scheme provides a standardized way of defining railtype labels, based on track gauge and type, speed class, allowable axle weight and electrification type.

It is the explicit intent of this scheme to decouple track sets from vehicle sets to facilitate easy mixing. This way the player can select a track set of choice to go with a train set of choice. It allows the player to play with or without axle load classes, or with or without speed limit classes, simply by loading a track set that does or does not provide these features. In some cases it will also be possible to combine niche track sets, for instance a standard gauge track set with a narrow gauge and a metro track set.

== The Label Scheme ==
A railtype label consists of four characters. In this scheme, each position has a different purpose:
# Track gauge and type class (e.g. standard gauge rail, narrow gauge rail, monorail)
# Speed limit class
# Axle load class (maximum allowed axle weight for this track)
# Energy source type class

In the next sections, each of the four positions will be explained.

=== Track gauge and type class [X***] ===
The first position in the railtype label defines track gauge and/or track type class. The following classes are currently defined:

{|
! !!Track type/gauge
|-
|S ||Standard gauge rail
|-
|B ||Broad gauge rail
|-
|N ||Narrow gauge rail
|-
|n ||Secondary narrow gauge rail (e.g. when providing both metre and cape gauge, always use N in case of just one type of narrow gauge)
|-
|D ||Dual gauge rail, standard/broad gauge
|-
|d ||Dual gauge rail, standard/narrow gauge
|-
|M ||Monorail
|-
|L ||Magnetic Levitation
|}

=== Speed limit class [*X**] ===
The second position in the railtype label defines the speed limit class. These classes do not map to a fixed numeric value, but are used to define an internal speed limit order for the track set. This means that if your track set has two different speed limits for track types that are otherwise identical, you'll use letters A and B here. In case of three different speed limits, use A, B and C. In case your track set does not employ speed limits, always use A. Train sets do not care about the speed limit, and will always set the lowest speed class, i.e. A.

This gives for instance the following options:

<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||no speed limits
|}
</div>
<div style="float:left;">
 OR 
</div>
</div>
<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||low speed
|-
|B ||high speed
|}
</div>
<div style="float:left;">
 OR 
</div>
</div>
<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||low speed
|-
|B ||medium speed
|-
|C ||high speed
|}
</div>
<div style="float:left;">
 etc. 
</div>
</div>
<div style="clear:left;"></div>

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|S ||subterranean ||eyecandy ||Metro Track Set
|-
|U ||urban ||eyecandy ||Metro Track Set
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

''Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.'' (See proposals below.)

=== Axle load class [**X*] ===
The third position defines the axle weight limit. Heavy trains cannot run on tracks with a low axle weight limit; these trains need more expensive tracks with a heigher weight limit. There are five axle load classes '''A''' through '''E'''. '''A''' is for the lowest axle load limit, '''E''' for the highest. The exact axle load attached to each class is relative to the track gauge/type and trains in the set.

A train set should set the appropriate axle weight for each train via the railtype label, as to make the set work with track sets that do provide tracks with different weight limits, even if you don't care about it for your trainset. Split all vehicles of a certain track gauge/type into five groups of similar axle weight. The group with the lowest axle weights will get class '''A''', the second lowest class '''B''', etc. up to the group with the highest axle weights which will get class '''E'''. Do the same for the other track gauge/types if your train set has those.

A track set does not have to provide a dedicated track type for each axle weight limit. A track set that does not provide a dedicated track for each axle load class, must make sure to map all undefined axle load classes to a real railtype using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]]. This way a train set can rely on all labels for all axle load classes being available. Example: if you only want to provide 2 axle load classes for standard gauge unelectrified with no speed limits, you can map SA'''A'''N + SA'''B'''N to SA'''C'''N and SA'''D'''N to SA'''E'''N if the cost difference between the two railtypes is high, or SA'''A'''N to SA'''B'''N and SA'''C'''N + SA'''D'''N to SA'''E'''N if the cost difference is low.

If you don't want to provide any axle load classes in your track set, it doesn't really matter what axle load class you choose for the track, as you'll be mapping all other classes to this track anyways. But the lowest or highest class are the obvious choice. Example: if your track set only provides narrow gauge unelectrified track with no speed limits and no axle load limits, you may use NA'''A'''N for the track label, and provide NA'''B'''N, NA'''C'''N, NA'''D'''N, NA'''E'''N in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

If you need more than five axle load class, you may use lowercase letters for very low axle loads and continue the uppercase letters for very high axle loads. Be advised that your train set may not assume the existance of any other class than '''A''' through '''E''', so when the range make sure to program your railtype table such that trains with such a class will fall back to class '''A''' or '''E'''. If you make a track set with an extended range, be aware that not all train sets will define trains for these tracks. In general: only do this in case of a train set with a matching track set.

For the lowercase letters, '''b''' is lower than '''a''', so for increasing axle load limits: b < a < A < B < C etc.

Note that the axle load classes never map to a specific weight in tonnes. For that reason it does not make sense to add a numeric value for the axle load to the name of a track type or in the extended purchase info of a train. Instead use the relative expressions 'very low', 'low', 'medium', 'high' and 'very high' or use the class letters directly.

If a guideline is needed for updating a set to use axle loads in a train set where they don't yet exist, the following might serve as a basic "generic" guideline...

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|F ||Future-proofing ||No limit per axle (update in 2030 or so?) || style="text-align:right;"|~2028
|}

=== Energy source type class [***X] ===
The last position defines the energy source type class. This is split in generic energy source types like overhead wires and third rail and specialized types like alternating and direct current.

A track set that only uses specialized types, should map the generic types to the most suitable specialized type in the set.

A vehicle set that uses specialized types should define a generic type as fallback, via the railtype table. If such a fallback is omitted, please note that certain vehicles may be unavailable depending on track set loaded.

{|
! !!Generic energy type classes
|-
|N ||no electrification
|-
|E ||overhead wires/catenary electrification
|-
|3 ||3rd rail electrification
|}

{|
! !!Specialized energy type classes !!Vehicle set fallback
|-
|Z ||3rd rail and catenary electrification || 3 or E
|-
|4 ||4th rail electrification || 3
|-
|Y ||4th rail and catenary electrification || 4 or E
|-
|T ||[http://en.wikipedia.org/wiki/Three-phase_AC_railway_electrification three phase AC electrification] || E
|-
| colspan="3" |  
|-
|D ||DC catenary electrification || E
|-
|d ||low voltage DC catenary electrification (only when D also used in set) || First A then E
|-
|A ||AC catenary electrification || E
|-
|a ||low voltage AC catenary electrification (only when A also used in set) || First A then E
|}

If you want multi-voltage/current vehicles in your set (i.e. a train that can run on both AC and DC current), you have to define a dedicated railtype for those vehicles. Without the railtype, it's not possible to define vehicles with this property. If you only have vehicles that can run on either one type of voltage/current or on all types of voltage/current (e.g. a 2-system if you only have '''A''' and '''D''' tracks, or a 4-system in case of all '''A''', '''a''', '''D''' and '''d'''), then use the generic class '''E''' for vehicles that should be able to run on all different voltage/currents. Also the track set needs to have one at least one railtype with class '''E''' defined.

Note that if you want more than one type of multi-voltage/current, you'll quickly get a combinatory explosion of railtype labels, so plan carefully or do not attempt it. For every different multi-voltage/current vehicle type a dedicated railtype is needed. If you want all possible combinations, then you need to define an additional 8 classes. It is not recommended to make your train/track set this complicated.

Example approach for a 4-system set, with trains that can run on either one or all systems:
* '''E''': generic catenary-powered electric engines. "universal" [4-system] if any of '''D'''/'''d'''/'''A'''/'''a''' are defined.
* '''A''': generic AC catenary electric engines. 25kV only if '''a''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''A''';
* '''a''': 15kV AC catenary electric engines. Only defined if '''A''' also defined. Vehicle sets should use '''A''' and '''E''' as fallback, if defining an engine for '''a''';
* '''D''': generic DC catenary electric engines. 3kV if '''d''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''D''';
* '''d''': 1.5kV DC catenary electric engines. Only defined if '''D''' also defined. Vehicle sets should use '''D''' and '''E''' as fallback, if defining an engine for '''d'''.
For a 2-system set, you can simply drop '''a''' and '''d'''.

=== Standard labels: RAIL, ELRL, MONO, MGLV ===
It's not possible to undefine the standard railtypes RAIL, ELRL, MONO and MGLV. The game will always add those if there are vehicles defined for these track types. As a result, for a track set it's best not to ignore those standard labels, but rather work with them and define them in the set. If your track set does not have monorail or maglev tracks, there of course is no need to define those. But if your track set defines anything that resembles unelectrified or electrified rail, you should use the RAIL and ELRL labels. Matching labels from the above scheme will then be defined in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

As vehicles from NewGRFs that do not use explicit railtypes will end up on these standard railtypes, you should use RAIL instead of whatever type could be regarded as the most commonly used unelectrified type, ELRL instead of the most commonly used electrified type and so on. The label according to this scheme is then set as an alternate.

== Summary for track sets ==
This section summarizes the above for track sets.

; [X***] Track gauge and type class
* Define at least one track type for every track gauge/type class you want in your set.
* If you only provide tracks for one gauge/type, consider leaving some free railtypes so a player can load an additional set for some other type.
; [*X**] Speed limit class
* Make sure class A is always available, either directly or via an alternate label.
* Use only class A if you don't want speed limits;
* With speed limits, A is the lowest speed limit. Continue with B, C, etc. for increasing speed limits;
* The speed class can also be used to implement additional eye-candy track types, use letters higher in the alphabet for this.
; [**X*] Axle load class
* Always define all classes A through E for every track type class / electrification combination, either:
** Directly via a real railtype definition;
** Indirectly via the alternate rail type label list, property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].
* Extend the predefined classes only if you also provide a train set that makes use of these.
; [***X] Energy source type class
* If your set only uses specialized classes, always map the generic classes to the closest matching specialized type via property 1D.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Always define the standard labels when possible, instead of what would be the equivalent of the standard label in this scheme.
* Map the equivalent labels from this scheme to the standard labels using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

Or, put differently, for each gauge/type, select one or more energy source types. For each type/energy combination provide all axle load classes for the speed class "A", either as a real type or as an alternate of another type. Provide more types with a different speed letter if you want to provide several different speeds or other eye-candy tracks.

== Summary for train sets ==
This section summarizes the above for train sets.

; [X***] Track gauge and type class
* Use the track type class that matches the vehicle;
* Define a fallback type via the railtype table in case you want the vehicle to be available on a different track if no matching track set is loaded.
** Specialized subtypes like "n" might not always be available. If you want those vehicles to be still available then, fall back the the generic class (e.g. "N").
; [*X**] Speed limit class
* Always use class A for every vehicle.
; [**X*] Axle load class
* Use all classes A through E according to the maximum axle weight of the vehicle.
* Extend the predefined classes only if you also provide a track set that makes use of these;
** When extending the predefined classes A through E, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; [***X] Energy source type class
* Use the energy source type class that matches the vehicle;
* When using specialized classes, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Define a fallback type to the standard labels via the railtype table in case you want the vehicle to be available on the standard tracks if no matching track set is loaded.

Be as specific as you want when selecting the railtype, it is the job of the track set to select a playable, reduced subset out of all possible type combinations.

== In case you're not convinced by this scheme ==
Adopting this scheme gives the player freedom to use any track set in combination with any train set that follow the scheme.

This means that you can make your train set compatible with track sets that provide axle load classes, and track sets that provide speed limits, and at the same time with track sets that provide none of this. This way, the player can decide to play with or without axle load classes, or with or without speed limits, simply by loading a track set that does or does not provide these features.

And for your track set, it means that you can make it as simple or as complicated as you want (within the 64 track type limit), while not having to worry about compatibility with train sets.

Still not convinced? Feel free to use railtype labels of your own, but know that you will likely come to regret that at some point in the future.

==Forum topic==
If you want to discuss the standardized railtype scheme or have any questions about it, you can visit [http://www.tt-forums.net/viewtopic.php?t=59379 the forum topic].

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Extended multivoltage support addition==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Extended maglev support addition==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS and the Maglev Track Set which allow trainsets to code trains which use different, ncompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{|
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Fallback !!Notes
|-
|S ||Maglevs that use a synchronous linear motor ||N/A ||
|-
|I ||Maglevs that use a linear induction motor ||MGLV (the whole label) ||
|-
|V ||Vactrains/Hyperloop ||t, then I, then MGLV (the whole label) ||
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), 16 in (406 mm), 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1432 mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SABN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|d ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}

Standardized Railtype Scheme

2024-09-24T08:01:32Z

Brickblock1: /* Energy source type class [***X] */

This railtype label scheme aims to bring order to the uncontrolled growth of railtype labels. It groups the rail types into what matters from a technical perspective. The scheme provides a standardized way of defining railtype labels, based on track gauge and type, speed class, allowable axle weight and electrification type.

It is the explicit intent of this scheme to decouple track sets from vehicle sets to facilitate easy mixing. This way the player can select a track set of choice to go with a train set of choice. It allows the player to play with or without axle load classes, or with or without speed limit classes, simply by loading a track set that does or does not provide these features. In some cases it will also be possible to combine niche track sets, for instance a standard gauge track set with a narrow gauge and a metro track set.

== The Label Scheme ==
A railtype label consists of four characters. In this scheme, each position has a different purpose:
# Track gauge and type class (e.g. standard gauge rail, narrow gauge rail, monorail)
# Speed limit class
# Axle load class (maximum allowed axle weight for this track)
# Energy source type class

In the next sections, each of the four positions will be explained.

=== Track gauge and type class [X***] ===
The first position in the railtype label defines track gauge and/or track type class. The following classes are currently defined:

{|
! !!Track type/gauge
|-
|S ||Standard gauge rail
|-
|B ||Broad gauge rail
|-
|N ||Narrow gauge rail
|-
|n ||Secondary narrow gauge rail (e.g. when providing both metre and cape gauge, always use N in case of just one type of narrow gauge)
|-
|D ||Dual gauge rail, standard/broad gauge
|-
|d ||Dual gauge rail, standard/narrow gauge
|-
|M ||Monorail
|-
|L ||Magnetic Levitation
|}

=== Speed limit class [*X**] ===
The second position in the railtype label defines the speed limit class. These classes do not map to a fixed numeric value, but are used to define an internal speed limit order for the track set. This means that if your track set has two different speed limits for track types that are otherwise identical, you'll use letters A and B here. In case of three different speed limits, use A, B and C. In case your track set does not employ speed limits, always use A. Train sets do not care about the speed limit, and will always set the lowest speed class, i.e. A.

This gives for instance the following options:

<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||no speed limits
|}
</div>
<div style="float:left;">
 OR 
</div>
</div>
<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||low speed
|-
|B ||high speed
|}
</div>
<div style="float:left;">
 OR 
</div>
</div>
<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||low speed
|-
|B ||medium speed
|-
|C ||high speed
|}
</div>
<div style="float:left;">
 etc. 
</div>
</div>
<div style="clear:left;"></div>

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|S ||subterranean ||eyecandy ||Metro Track Set
|-
|U ||urban ||eyecandy ||Metro Track Set
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

''Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.'' (See proposals below.)

=== Axle load class [**X*] ===
The third position defines the axle weight limit. Heavy trains cannot run on tracks with a low axle weight limit; these trains need more expensive tracks with a heigher weight limit. There are five axle load classes '''A''' through '''E'''. '''A''' is for the lowest axle load limit, '''E''' for the highest. The exact axle load attached to each class is relative to the track gauge/type and trains in the set.

A train set should set the appropriate axle weight for each train via the railtype label, as to make the set work with track sets that do provide tracks with different weight limits, even if you don't care about it for your trainset. Split all vehicles of a certain track gauge/type into five groups of similar axle weight. The group with the lowest axle weights will get class '''A''', the second lowest class '''B''', etc. up to the group with the highest axle weights which will get class '''E'''. Do the same for the other track gauge/types if your train set has those.

A track set does not have to provide a dedicated track type for each axle weight limit. A track set that does not provide a dedicated track for each axle load class, must make sure to map all undefined axle load classes to a real railtype using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]]. This way a train set can rely on all labels for all axle load classes being available. Example: if you only want to provide 2 axle load classes for standard gauge unelectrified with no speed limits, you can map SA'''A'''N + SA'''B'''N to SA'''C'''N and SA'''D'''N to SA'''E'''N if the cost difference between the two railtypes is high, or SA'''A'''N to SA'''B'''N and SA'''C'''N + SA'''D'''N to SA'''E'''N if the cost difference is low.

If you don't want to provide any axle load classes in your track set, it doesn't really matter what axle load class you choose for the track, as you'll be mapping all other classes to this track anyways. But the lowest or highest class are the obvious choice. Example: if your track set only provides narrow gauge unelectrified track with no speed limits and no axle load limits, you may use NA'''A'''N for the track label, and provide NA'''B'''N, NA'''C'''N, NA'''D'''N, NA'''E'''N in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

If you need more than five axle load class, you may use lowercase letters for very low axle loads and continue the uppercase letters for very high axle loads. Be advised that your train set may not assume the existance of any other class than '''A''' through '''E''', so when the range make sure to program your railtype table such that trains with such a class will fall back to class '''A''' or '''E'''. If you make a track set with an extended range, be aware that not all train sets will define trains for these tracks. In general: only do this in case of a train set with a matching track set.

For the lowercase letters, '''b''' is lower than '''a''', so for increasing axle load limits: b < a < A < B < C etc.

Note that the axle load classes never map to a specific weight in tonnes. For that reason it does not make sense to add a numeric value for the axle load to the name of a track type or in the extended purchase info of a train. Instead use the relative expressions 'very low', 'low', 'medium', 'high' and 'very high' or use the class letters directly.

If a guideline is needed for updating a set to use axle loads in a train set where they don't yet exist, the following might serve as a basic "generic" guideline...

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|F ||Future-proofing ||No limit per axle (update in 2030 or so?) || style="text-align:right;"|~2028
|}

=== Energy source type class [***X] ===
The last position defines the energy source type class. This is split in generic energy source types like overhead wires and third rail and specialized types like alternating and direct current.

A track set that only uses specialized types, should map the generic types to the most suitable specialized type in the set.

A vehicle set that uses specialized types should define a generic type as fallback, via the railtype table. If such a fallback is omitted, please note that certain vehicles may be unavailable depending on track set loaded.

{|
! !!Generic energy type classes
|-
|N ||no electrification
|-
|E ||overhead wires/catenary electrification
|-
|3 ||3rd rail electrification
|}

{|
! !!Specialized energy type classes !!Vehicle set fallback
|-
|Z ||3rd rail and catenary electrification || 3 or E
|-
|4 ||4th rail electrification || 3
|-
|Y ||4th rail and catenary electrification || 4 or E
|-
|T ||[http://en.wikipedia.org/wiki/Three-phase_AC_railway_electrification three phase AC electrification] || E
|-
| colspan="3" |  
|-
|D ||DC catenary electrification || E
|-
|d ||low voltage DC catenary electrification (only when D also used in set) || First A then E
|-
|A ||AC catenary electrification || E
|-
|a ||low voltage AC catenary electrification (only when A also used in set) || First A then E
|}

If you want multi-voltage/current vehicles in your set (i.e. a train that can run on both AC and DC current), you have to define a dedicated railtype for those vehicles. Without the railtype, it's not possible to define vehicles with this property. If you only have vehicles that can run on either one type of voltage/current or on all types of voltage/current (e.g. a 2-system if you only have '''A''' and '''D''' tracks, or a 4-system in case of all '''A''', '''a''', '''D''' and '''d'''), then use the generic class '''E''' for vehicles that should be able to run on all different voltage/currents. Also the track set needs to have one at least one railtype with class '''E''' defined.

Note that if you want more than one type of multi-voltage/current, you'll quickly get a combinatory explosion of railtype labels, so plan carefully or do not attempt it. For every different multi-voltage/current vehicle type a dedicated railtype is needed. If you want all possible combinations, then you need to define an additional 8 classes. It is not recommended to make your train/track set this complicated.

Example approach for a 4-system set, with trains that can run on either one or all systems:
* '''E''': generic catenary-powered electric engines. "universal" [4-system] if any of '''D'''/'''d'''/'''A'''/'''a''' are defined.
* '''A''': generic AC catenary electric engines. 25kV only if '''a''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''A''';
* '''a''': 15kV AC catenary electric engines. Only defined if '''A''' also defined. Vehicle sets should use '''A''' and '''E''' as fallback, if defining an engine for '''a''';
* '''D''': generic DC catenary electric engines. 3kV if '''d''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''D''';
* '''d''': 1.5kV DC catenary electric engines. Only defined if '''D''' also defined. Vehicle sets should use '''D''' and '''E''' as fallback, if defining an engine for '''d'''.
For a 2-system set, you can simply drop '''a''' and '''d'''.

=== Standard labels: RAIL, ELRL, MONO, MGLV ===
It's not possible to undefine the standard railtypes RAIL, ELRL, MONO and MGLV. The game will always add those if there are vehicles defined for these track types. As a result, for a track set it's best not to ignore those standard labels, but rather work with them and define them in the set. If your track set does not have monorail or maglev tracks, there of course is no need to define those. But if your track set defines anything that resembles unelectrified or electrified rail, you should use the RAIL and ELRL labels. Matching labels from the above scheme will then be defined in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

As vehicles from NewGRFs that do not use explicit railtypes will end up on these standard railtypes, you should use RAIL instead of whatever type could be regarded as the most commonly used unelectrified type, ELRL instead of the most commonly used electrified type and so on. The label according to this scheme is then set as an alternate.

== Summary for track sets ==
This section summarizes the above for track sets.

; [X***] Track gauge and type class
* Define at least one track type for every track gauge/type class you want in your set.
* If you only provide tracks for one gauge/type, consider leaving some free railtypes so a player can load an additional set for some other type.
; [*X**] Speed limit class
* Make sure class A is always available, either directly or via an alternate label.
* Use only class A if you don't want speed limits;
* With speed limits, A is the lowest speed limit. Continue with B, C, etc. for increasing speed limits;
* The speed class can also be used to implement additional eye-candy track types, use letters higher in the alphabet for this.
; [**X*] Axle load class
* Always define all classes A through E for every track type class / electrification combination, either:
** Directly via a real railtype definition;
** Indirectly via the alternate rail type label list, property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].
* Extend the predefined classes only if you also provide a train set that makes use of these.
; [***X] Energy source type class
* If your set only uses specialized classes, always map the generic classes to the closest matching specialized type via property 1D.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Always define the standard labels when possible, instead of what would be the equivalent of the standard label in this scheme.
* Map the equivalent labels from this scheme to the standard labels using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

Or, put differently, for each gauge/type, select one or more energy source types. For each type/energy combination provide all axle load classes for the speed class "A", either as a real type or as an alternate of another type. Provide more types with a different speed letter if you want to provide several different speeds or other eye-candy tracks.

== Summary for train sets ==
This section summarizes the above for train sets.

; [X***] Track gauge and type class
* Use the track type class that matches the vehicle;
* Define a fallback type via the railtype table in case you want the vehicle to be available on a different track if no matching track set is loaded.
** Specialized subtypes like "n" might not always be available. If you want those vehicles to be still available then, fall back the the generic class (e.g. "N").
; [*X**] Speed limit class
* Always use class A for every vehicle.
; [**X*] Axle load class
* Use all classes A through E according to the maximum axle weight of the vehicle.
* Extend the predefined classes only if you also provide a track set that makes use of these;
** When extending the predefined classes A through E, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; [***X] Energy source type class
* Use the energy source type class that matches the vehicle;
* When using specialized classes, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Define a fallback type to the standard labels via the railtype table in case you want the vehicle to be available on the standard tracks if no matching track set is loaded.

Be as specific as you want when selecting the railtype, it is the job of the track set to select a playable, reduced subset out of all possible type combinations.

== In case you're not convinced by this scheme ==
Adopting this scheme gives the player freedom to use any track set in combination with any train set that follow the scheme.

This means that you can make your train set compatible with track sets that provide axle load classes, and track sets that provide speed limits, and at the same time with track sets that provide none of this. This way, the player can decide to play with or without axle load classes, or with or without speed limits, simply by loading a track set that does or does not provide these features.

And for your track set, it means that you can make it as simple or as complicated as you want (within the 64 track type limit), while not having to worry about compatibility with train sets.

Still not convinced? Feel free to use railtype labels of your own, but know that you will likely come to regret that at some point in the future.

==Forum topic==
If you want to discuss the standardized railtype scheme or have any questions about it, you can visit [http://www.tt-forums.net/viewtopic.php?t=59379 the forum topic].

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Extended multivoltage support addition==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Extended maglev support addition==
These are extensions to the rail system and energy source type classes currently supported by RIMS, FRIMS and the Maglev Track Set which allow trainsets to code trains which use different, ncompatible maglev variations. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for all maglevs in trainsets for ideal functionality with tracksets which support the extended labels.

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|L ||Maglevs that have a u-shaped track (SCMaglev)
|-
|T ||Maglevs that have a monorail track (Transrapid/China)
|}

=== Energy source type class [***X] ===
{|
! !!Electrification !!Fallback !!Notes
|-
|S ||Maglevs that use a synchronous linear motor ||N/A ||
|-
|I ||Maglevs that use a linear induction motor ||MGLV (the whole label) ||
|-
|V ||Vactrains/Hyperloop ||t, then I, then MGLV (the whole label) ||
|}

==Possible additions==

There are a number of proposed labels for standardization of non-standardized labels...

===Rail System/Gauge [X***]===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_H_c" and "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|compatible_railtype_list (NML)]], and ALWAYS add "_S_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]] if you intend to support this
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|A ||Alweg-based Monorail
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), 16 in (406 mm), 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1432 mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SABN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm), Dresden (1450 mm) and Leipzig (1458 mm) gauges are all based on streetcar/tram systems and may be better grouped here
|-
|t ||Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

=== Speed limit class [*X**] ===

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|K-R ||rack rail with speed limits, that allows rack-equipped vehicle to not slow down going uphill ||special ||French Set Rails
|-
|k-r ||rack rail with speed limits, that powers a rack-only vehicle ||special ||
|-
|s ||subterranean (low-clearance) ||eyecandy, should not be supported by double-deck passenger carriages or double-stack container wagons ||
|}
Rack rail needs a bit greater of a explanation, ideally it would be coded in a way where both pure rack and rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails (the most popular rack set) implements compatibility both ways which makes pure rack systems impossible.

Should another rack rail set be implemented, it might be prudent to make K-R equivalent to A-H for rack-and-adhesion, and k-r equivalent to A-H for rack rail only.

=== Axle load class [**X*] ===
{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|d ||High, extra-lean freight bogies ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle (update in 2030 or so?)|| style="text-align:right;"|~2028
|-
|F ||Future-proofing ||No limit per axle (update in 2050 or so?) || style="text-align:right;"|~2048
|}

If the above scheme is used, "d" should NEVER be used as the axle weight of a railtype. Instead, if your train set supports axle weights, use SAdN/SAdE/etc. as a vehicle's axle weight if they are a freight car available between 2008 and 2028 but are more than 40 metric tonnes (40000kg) per axle, and add the railtype to the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of SADN or equivalent.

=== Energy source type class [***X] ===
{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}

TracktypeLabels

2024-04-05T12:55:37Z

Brickblock1:

== Labels for rail types, road types and tram type ==
All track types are identified via 4-byte labels.
The labels are unique within their type, but it is common that rail types and tram types use the same label for similar types.

Vehicles can check for their track type on a tile, but they only have access to their own type: On a level-crossing with all three tracks (rail, road, tram) trains can only check rail types, buses/trucks can only check road types, and trams can only check tram types.

=== Rail vs. tram ===
Rail and tram are very different wrt. game-play, but both are kind of rails.
To unify labels, rail and tram should use the same labels, if the tracks are similar.
* RAIL for unelectrified rail and tram.
* ELRL for electrified rail and tram.
* FNCY for fancy-powered rail and tram.

== Default labels ==

=== Rail type ===
These labels are used for the trains and tracks in the base game, as well as for train sets that are not rail-type-aware. Consequently, track NewGRFs should always override their properties, or at least make their tracks compatible to them.

{| class="wikitable"
|-
!'''Label'''
!'''Rail Type'''
|-
|RAIL
|Normal rail
|-
|ELRL
|electrified rail
|-
|MONO
|Monorail tracks
|-
|MGLV
|Maglev tracks
|}

=== Road types ===
By default there is only a single road type defined:
{| class="wikitable"
|-
!'''Label'''
!'''Road Type'''
|-
|ROAD
|Normal road
|}
However, if a NewGRF requires electrified "ELRD", an Action0 is sufficient to add this type and make it use the default road-ground and catenary sprites.

=== Tram types ===
By default there is only a single tram type defined:
{| class="wikitable"
|-
!'''Label'''
!'''Tram Type'''
|-
|ELRL
|Electrified rail
|}
However, if a NewGRF requires unelectrified "RAIL", an Action0 is sufficient to add this type and make it use the default tram-ground sprites.

Note: Please use the same label for tram types which already exist as rail types.

== Standardized Railtype Scheme ==
Several members of the TT Forums have collaborated to define a rail type label scheme that allows for compatibility between train and track sets by different authors. At the same time it allows fancy stuff like axle weight limits, speed limits, different track and electrification types, etc. See [[Standardized Railtype Scheme]].

The Standardized Railtype Scheme is not mandatory, and authors providing both trains and railtypes may have valid reasons to use labels outside the scheme. The Standardized Scheme cannot cover all possible cases, by design, as it would be too complex.

However even when using custom labels, it may be worth using Standardized Railtype labels:
* as fallbacks for trains when the custom label is not available (via NML railtypetable fallback lists)
* as alternates handled by a railtype with a custom label (via NML alternative_railtype_list or NFO prop 1D)
This will provide wider compatibility with other train and railtype grfs.

=== Non-standard railtype labels ===

The following labels were defined before the Standardized Railtype Scheme existed. Using these or not is at the discretion of individual grf authors, but generally, if an equivalent label exists in the Standardized Railtype Scheme, it's better to use that.

{| class="mw-collapsible mw-collapsed wikitable"
|-
! scope="col" | '''Label'''
! scope="col" | '''Rail Type'''
! scope="col" | '''Notes'''
|-
|_040
|speed limit 40 km/h
|Slowrails, SwedishRails
|-
|_080
|speed limit 80 km/h
|Slowrails, SwedishRails
|-
|E040
|speed limit 40 km/h, with catenary
|Slowrails, SwedishRails
|-
|E080
|speed limit 80 km/h, with catenary
|Slowrails, SwedishRails
|-
|3RDR
|Tracks with third rail
|MetroTracks, NuTracks, UK Railway Set tracks, Japanese Track Set
|-
|3RDC
|Tracks with third rail and catenary
|MetroTracks, NuTracks, UK Railway Set tracks, Japanese Track Set
|-
|RLOW
|Low speed tracks
|NuTracks, SwedishRails, Japanese Track Set
|-
|ELOW
|Low speed tracks with catenary
|NuTracks, SwedishRails, Japanese Track Set
|-
|3LOW
|Low speed tracks with 3rd rail
|NuTracks,
|-
|CLOW
|Low speed tracks, 3rd rail and catenary
|NuTracks
|-
|RMED
|Medium speed tracks
|NuTracks, SwedishRails
|-
|EMED
|Medium speed tracks with catenary
|NuTracks, SwedishRails
|-
|3MED
|Medium speed tracks with 3rd rail
|NuTracks
|-
|CMED
|Medium speed tracks, 3rd rail and catenary
|NuTracks
|-
|RHIG
|High speed tracks
|NuTracks, SwedishRails, Japanese Track Set
|-
|EHIG
|High speed tracks with catenary
|NuTracks, SwedishRails, Japanese Track Set
|-
|HSTR
|Very high speed tracks with catenary
|NuTracks, SwedishRails, Japanese Track Set
|-
|NGRL
|Narrow gauge tracks
|Narrow Gauge Track Types, Japanese Track Set
|-
|ELNG
|Narrow gauge tracks with catenary
|Narrow Gauge Track Types, Japanese Track Set
|-
|PLAN
|Planning tracks (blue dotted lines)
|NuTracks
|-
|MTRO
|Metro tracks
|NuTracks
|-
|MTRC
|Metro tracks with concrete edges
|NuTracks
|-
|MTRS
|Metro tracks with suburban buildings on top
|NuTracks
|-
|MTRU
|Metro tracks with 'downtown' buildings on top
|NuTracks
|-
|MTRT
|Metro tracks with plain landscape on top
|NuTracks
|-
|DBNN
|branch line
|DBRails
|-
|DBNE
|branch line, electrified
|DBRails
|-
|DBHN
|main line
|DBRails
|-
|DBHE
|main line, electrified
|DBRails
|-
|DBHS
|high speed line electrified (NBS)
|DBRails
|-
|TRPD
|transrapid track
|Transrapid track type
|-
|NLOW
|Low speed narrow gauge tracks
|Japanese Track Set
|-
|ENLW
|Low speed narrow gauge tracks with catenary
|Japanese Track Set
|-
|ENHI
|Modern narrow gauge tracks with catenary
|Japanese Track Set
|-
|RLA0
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 60 km/h
|xUSSR train set
|-
|RLA1
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 100 km/h
|xUSSR train set
|-
|RLA2
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 140 km/h
|xUSSR train set
|-
|RLA3
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 250 km/h
|xUSSR train set
|-
|ERd0
|Broad (1520 mm) gauge tracks with generic DC catenary 1,5kV. Speed limit 60 km/h
|xUSSR train set
|-
|ERd1
|Broad (1520 mm) gauge tracks with generic DC catenary 1,5kV. Speed limit 100 km/h
|xUSSR train set
|-
|ERd2
|Broad (1520 mm) gauge tracks with generic DC catenary 1,5kV. Speed limit 140 km/h
|xUSSR train set add-on
|-
|ERd3
|Broad (1520 mm) gauge tracks with generic DC catenary 1,5kV. Speed limit 250 km/h
|xUSSR train set add-on
|-
|ERD1
|Broad (1520 mm) gauge tracks with generic DC catenary 3kV. Speed limit 100 km/h
|xUSSR train set
|-
|ERD2
|Broad (1520 mm) gauge tracks with generic DC catenary 3kV. Speed limit 140 km/h
|xUSSR train set
|-
|ERD3
|Broad (1520 mm) gauge tracks with generic DC catenary 3kV. Speed limit 250 km/h
|xUSSR train set
|-
|ERA1
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. Speed limit 100 km/h
|xUSSR train set
|-
|ERA2
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. Speed limit 140 km/h
|xUSSR train set
|-
|ERA3
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. Speed limit 250 km/h
|xUSSR train set
|-
|ERA4
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. No speed limit
|xUSSR train set
|-
|ERa0
|Broad (1520 mm) gauge tracks with generic AC catenary 15kV. Speed limit 60 km/h
|xUSSR train set
|-
|ERa1
|Broad (1520 mm) gauge tracks with generic AC catenary 15kV. Speed limit 100 km/h
|xUSSR train set add-on
|-
|ERa2
|Broad (1520 mm) gauge tracks with generic AC catenary 15kV. Speed limit 140 km/h
|xUSSR train set add-on
|-
|ERa3
|Broad (1520 mm) gauge tracks with generic AC catenary 15kV. Speed limit 250 km/h
|xUSSR train set add-on
|-
|ERa4
|Broad (1520 mm) gauge tracks with generic AC catenary 15kV. No speed limit
|xUSSR train set add-on
|-
|ER2D
|Broad (1520 mm) gauge tracks with DC 1,5kV / 3kV catenary. Speed limit 100 km/h
|xUSSR train set
|-
|ER2S
|Broad (1520 mm) gauge tracks with AC 25kV / DC 3kV catenary. Speed limit 120 km/h
|xUSSR train set
|-
|ER2s
|Broad (1520 mm) gauge tracks with AC 25kV / DC 1,5kV catenary. Speed limit 120 km/h
|xUSSR train set add-on
|-
|ER3a
|Broad (1520 mm) gauge tracks with AC 25kV / 15kV / DC 1,5kV catenary. Speed limit 120 km/h
|xUSSR train set add-on
|-
|ER3D
|Broad (1520 mm) gauge tracks with AC 25kV / DC 3kV / 1,5kV catenary. Speed limit 120 km/h
|xUSSR train set add-on
|-
|ER4S
|Broad (1520 mm) gauge tracks with AC 25kV / 15kV / DC 3kV / 1,5kV catenary. Speed limit 120 km/h
|xUSSR train set add-on
|-
|SW1L
|Broad (1520 mm) gauge tracks with DC 700V third rail on the left. Speed limit 100 km/h
|xUSSR train set
|-
|SW1R
|Broad (1520 mm) gauge tracks with DC 700V third rail on the right. Speed limit 100 km/h
|xUSSR train set
|-
|WWAY
|Wagonway
|Early Rails set
|-
|WGWY
|Wagonway
|Recycled Tracktype Set
|-
|LTRL
|Light Rails
|Early Rails set
|-
|LIHT
|Light Rails
|Recycled Tracktype Set
|-
|TYTX
|ToyTrax
|ToyTrax
|-
|ELTX
|ElecTrax
|ToyTrax
|-
|DPRK
|North Korean Urban Ground
|Trackless Trackset
|-
|JPU1
|Japanese Urban Ground
|Trackless Trackset
|-
|ISR1
|Industrial Stations Renewal Ground
|Trackless Trackset
|-
|ISR2
|CHIPS Dirt Ground
|Trackless Trackset
|-
|ISR3
|CHIPS Asphalt Ground
|Trackless Trackset
|-
|ISR4
|CHIPS Cobblestone Ground
|Trackless Trackset
|-
|NORD
|Standard gauge AC electrified 15 and 25 kv (hidden) Depriciated use SAA$ instead
|SMITS rails
|-
|IHBA
|Standard gauge, AC electrified, dedicated high speed standard gauge rail
|Iron Horse 3
|-
|IHB_
|Standard gauge, AC electrified
|Iron Horse 3
|-
|IHC_
|Standard gauge metro
|Iron Horse 3
|}

== Standardized Roadtype Scheme ==
Same story as the railtype one, also covers trams. See [[Standardized Roadtype Scheme]]

=== Non-standard roadtype labels ===

The following labels were defined before the Standardized Roadtype Scheme existed, but after alternative_roadtype_list and alternative_tramtype_list existed (meaning compatibility options allowed for quicker proliferation. Using these or not is at the discretion of individual grf authors, but generally, if an equivalent label exists in the Standardized Roadtype Scheme, it's better to use that. Ditto for tramtypes, but note that a label can be used twice, once for a roadtype and once for a tramtype.

==== Non-standard roadtypes ====
{| class="mw-collapsible mw-collapsed wikitable"
|-
! scope="col" | '''Label'''
! scope="col" | '''Road Type'''
! scope="col" | '''Notes'''
|-
|ELRD
|Road with catenary
|Very commonly used
|-
|_TRD
|Town Roads
|Ufiby's U&ReRMM (1st version only)
|-
|SMRT
|SmartRoad
|Various unattributed roadtype sets
|-
|SMTS
|SmartStreet
|Various unattributed roadtype sets
|-
|HAUL
|Heavy duty vehicles
|Docklands
|-
|ELHL
|Electric heavy duty vehicles
|Docklands
|}

==== Non-standard tramtypes ====
{| class="mw-collapsible mw-collapsed wikitable"
|-
! scope="col" | '''Label'''
! scope="col" | '''Road Type'''
! scope="col" | '''Notes'''
|-
|RAIL
|Non-electrified tramtrack
|Very commonly used
|-
|Auto
|Trackless Tram
|An unattributed roadtype set (GRC?)
|}

Standardized Railtype Scheme

2024-03-30T15:28:21Z

Brickblock1: /* Extended multivoltage support addition */

This railtype label scheme aims to bring order to the uncontrolled growth of railtype labels. It groups the rail types into what matters from a technical perspective. The scheme provides a standardized way of defining railtype labels, based on track gauge and type, speed class, allowable axle weight and electrification type.

It is the explicit intent of this scheme to decouple track sets from vehicle sets to facilitate easy mixing. This way the player can select a track set of choice to go with a train set of choice. It allows the player to play with or without axle load classes, or with or without speed limit classes, simply by loading a track set that does or does not provide these features. In some cases it will also be possible to combine niche track sets, for instance a standard gauge track set with a narrow gauge and a metro track set.

== The Label Scheme ==
A railtype label consists of four characters. In this scheme, each position has a different purpose:
# Track gauge and type class (e.g. standard gauge rail, narrow gauge rail, monorail)
# Speed limit class
# Axle load class (maximum allowed axle weight for this track)
# Energy source type class

In the next sections, each of the four positions will be explained.

=== Track gauge and type class [X***] ===
The first position in the railtype label defines track gauge and/or track type class. The following classes are currently defined:

{|
! !!Track type/gauge
|-
|S ||Standard gauge rail
|-
|B ||Broad gauge rail
|-
|N ||Narrow gauge rail
|-
|n ||Secondary narrow gauge rail (e.g. when providing both metre and cape gauge, always use N in case of just one type of narrow gauge)
|-
|D ||Dual gauge rail, standard/broad gauge
|-
|d ||Dual gauge rail, standard/narrow gauge
|-
|M ||Monorail
|-
|L ||Magnetic Levitation
|}

=== Speed limit class [*X**] ===
The second position in the railtype label defines the speed limit class. These classes do not map to a fixed numeric value, but are used to define an internal speed limit order for the track set. This means that if your track set has two different speed limits for track types that are otherwise identical, you'll use letters A and B here. In case of three different speed limits, use A, B and C. In case your track set does not employ speed limits, always use A. Train sets do not care about the speed limit, and will always set the lowest speed class, i.e. A.

This gives for instance the following options:

<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||no speed limits
|}
</div>
<div style="float:left;">
 OR 
</div>
</div>
<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||low speed
|-
|B ||high speed
|}
</div>
<div style="float:left;">
 OR 
</div>
</div>
<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||low speed
|-
|B ||medium speed
|-
|C ||high speed
|}
</div>
<div style="float:left;">
 etc. 
</div>
</div>
<div style="clear:left;"></div>

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|R ||rack rail, that allows this vehicle to not slow down going uphill ||special ||French Set Rails
|-
|S ||subterranean ||eyecandy ||Metro Track Set
|-
|U ||urban ||eyecandy ||Metro Track Set
|}
Rack rail needs a bit greater of a explanation, idealy it would be coded in a way where both Pure rack and Rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails implements compatiblility both ways which makes pure rack systems impossible.

=== Axle load class [**X*] ===
The third position defines the axle weight limit. Heavy trains cannot run on tracks with a low axle weight limit; these trains need more expensive tracks with a heigher weight limit. There are five axle load classes '''A''' through '''E'''. '''A''' is for the lowest axle load limit, '''E''' for the highest. The exact axle load attached to each class is relative to the track gauge/type and trains in the set.

A train set should set the appropriate axle weight for each train via the railtype label, as to make the set work with track sets that do provide tracks with different weight limits, even if you don't care about it for your trainset. Split all vehicles of a certain track gauge/type into five groups of similar axle weight. The group with the lowest axle weights will get class '''A''', the second lowest class '''B''', etc. up to the group with the highest axle weights which will get class '''E'''. Do the same for the other track gauge/types if your train set has those.

A track set does not have to provide a dedicated track type for each axle weight limit. A track set that does not provide a dedicated track for each axle load class, must make sure to map all undefined axle load classes to a real railtype using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]]. This way a train set can rely on all labels for all axle load classes being available. Example: if you only want to provide 2 axle load classes for standard gauge unelectrified with no speed limits, you can map SA'''A'''N + SA'''B'''N to SA'''C'''N and SA'''D'''N to SA'''E'''N if the cost difference between the two railtypes is high, or SA'''A'''N to SA'''B'''N and SA'''C'''N + SA'''D'''N to SA'''E'''N if the cost difference is low.

If you don't want to provide any axle load classes in your track set, it doesn't really matter what axle load class you choose for the track, as you'll be mapping all other classes to this track anyways. But the lowest or highest class are the obvious choice. Example: if your track set only provides narrow gauge unelectrified track with no speed limits and no axle load limits, you may use NA'''A'''N for the track label, and provide NA'''B'''N, NA'''C'''N, NA'''D'''N, NA'''E'''N in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

If you need more than five axle load class, you may use lowercase letters for very low axle loads and continue the uppercase letters for very high axle loads. Be advised that your train set may not assume the existance of any other class than '''A''' through '''E''', so when the range make sure to program your railtype table such that trains with such a class will fall back to class '''A''' or '''E'''. If you make a track set with an extended range, be aware that not all train sets will define trains for these tracks. In general: only do this in case of a train set with a matching track set.

For the lowercase letters, '''b''' is lower than '''a''', so for increasing axle load limits: b < a < A < B < C etc.

Note that the axle load classes never map to a specific weight in tonnes. For that reason it does not make sense to add a numeric value for the axle load to the name of a track type or in the extended purchase info of a train. Instead use the relative expressions 'very low', 'low', 'medium', 'high' and 'very high' or use the class letters directly.

If a guideline is needed for updating a set to use axle loads in a train set where they don't yet exist, the following might serve as a basic "generic" guideline...

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|F ||Future-proofing ||No limit per axle (update in 2030 or so?) || style="text-align:right;"|~2028
|}

=== Energy source type class [***X] ===
The last position defines the energy source type class. This is split in generic energy source types like overhead wires and third rail and specialized types like alternating and direct current.

A track set that only uses specialized types, should map the generic types to the most suitable specialized type in the set.

A vehicle set that uses specialized types should define a generic type as fallback, via the railtype table. If such a fallback is omitted, please note that certain vehicles may be unavailable depending on track set loaded.

{|
! !!Generic energy type classes
|-
|N ||no electrification
|-
|E ||overhead wires/catenary electrification
|-
|3 ||3rd rail electrification
|}

{|
! !!Specialized energy type classes !!Vehicle set fallback
|-
|Z ||3rd rail and catenary electrification || 3 or E
|-
|4 ||4th rail electrification || 3
|-
|Y ||4th rail and catenary electrification || 4 or E
|-
|T ||[http://en.wikipedia.org/wiki/Three-phase_AC_railway_electrification three phase AC electrification] || E
|-
| colspan="3" |  
|-
|D ||DC catenary electrification || E
|-
|d ||low voltage DC catenary electrification (only when D also used in set) || First A then E
|-
|A ||AC catenary electrification || E
|-
|a ||low voltage AC catenary electrification (only when A also used in set) || First A then E
|}

If you want multi-voltage/current vehicles in your set (i.e. a train that can run on both AC and DC current), you have to define a dedicated railtype for those vehicles. Without the railtype, it's not possible to define vehicles with this property. If you only have vehicles that can run on either one type of voltage/current or on all types of voltage/current (e.g. a 2-system if you only have '''A''' and '''D''' tracks, or a 4-system in case of all '''A''', '''a''', '''D''' and '''d'''), then use the generic class '''E''' for vehicles that should be able to run on all different voltage/currents. Also the track set needs to have one at least one railtype with class '''E''' defined.

Note that if you want more than one type of multi-voltage/current, you'll quickly get a combinatory explosion of railtype labels, so plan carefully or do not attempt it. For every different multi-voltage/current vehicle type a dedicated railtype is needed. If you want all possible combinations, then you need to define an additional 8 classes. It is not recommended to make your train/track set this complicated.

Example approach for a 4-system set, with trains that can run on either one or all systems:
* '''E''': generic catenary-powered electric engines. "universal" [4-system] if any of '''D'''/'''d'''/'''A'''/'''a''' are defined.
* '''A''': generic AC catenary electric engines. 25kV only if '''a''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''A''';
* '''a''': 15kV AC catenary electric engines. Only defined if '''A''' also defined. Vehicle sets should use '''A''' and '''E''' as fallback, if defining an engine for '''a''';
* '''D''': generic DC catenary electric engines. 3kV if '''d''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''D''';
* '''d''': 1.5kV DC catenary electric engines. Only defined if '''D''' also defined. Vehicle sets should use '''D''' and '''E''' as fallback, if defining an engine for '''d'''.
For a 2-system set, you can simply drop '''a''' and '''d'''.

=== Standard labels: RAIL, ELRL, MONO, MGLV ===
It's not possible to undefine the standard railtypes RAIL, ELRL, MONO and MGLV. The game will always add those if there are vehicles defined for these track types. As a result, for a track set it's best not to ignore those standard labels, but rather work with them and define them in the set. If your track set does not have monorail or maglev tracks, there of course is no need to define those. But if your track set defines anything that resembles unelectrified or electrified rail, you should use the RAIL and ELRL labels. Matching labels from the above scheme will then be defined in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

As vehicles from NewGRFs that do not use explicit railtypes will end up on these standard railtypes, you should use RAIL instead of whatever type could be regarded as the most commonly used unelectrified type, ELRL instead of the most commonly used electrified type and so on. The label according to this scheme is then set as an alternate.

== Summary for track sets ==
This section summarizes the above for track sets.

; [X***] Track gauge and type class
* Define at least one track type for every track gauge/type class you want in your set.
* If you only provide tracks for one gauge/type, consider leaving some free railtypes so a player can load an additional set for some other type.
; [*X**] Speed limit class
* Make sure class A is always available, either directly or via an alternate label.
* Use only class A if you don't want speed limits;
* With speed limits, A is the lowest speed limit. Continue with B, C, etc. for increasing speed limits;
* The speed class can also be used to implement additional eye-candy track types, use letters higher in the alphabet for this.
; [**X*] Axle load class
* Always define all classes A through E for every track type class / electrification combination, either:
** Directly via a real railtype definition;
** Indirectly via the alternate rail type label list, property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].
* Extend the predefined classes only if you also provide a train set that makes use of these.
; [***X] Energy source type class
* If your set only uses specialized classes, always map the generic classes to the closest matching specialized type via property 1D.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Always define the standard labels when possible, instead of what would be the equivalent of the standard label in this scheme.
* Map the equivalent labels from this scheme to the standard labels using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

Or, put differently, for each gauge/type, select one or more energy source types. For each type/energy combination provide all axle load classes for the speed class "A", either as a real type or as an alternate of another type. Provide more types with a different speed letter if you want to provide several different speeds or other eye-candy tracks.

== Summary for train sets ==
This section summarizes the above for train sets.

; [X***] Track gauge and type class
* Use the track type class that matches the vehicle;
* Define a fallback type via the railtype table in case you want the vehicle to be available on a different track if no matching track set is loaded.
** Specialized subtypes like "n" might not always be available. If you want those vehicles to be still available then, fall back the the generic class (e.g. "N").
; [*X**] Speed limit class
* Always use class A for every vehicle.
; [**X*] Axle load class
* Use all classes A through E according to the maximum axle weight of the vehicle.
* Extend the predefined classes only if you also provide a track set that makes use of these;
** When extending the predefined classes A through E, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; [***X] Energy source type class
* Use the energy source type class that matches the vehicle;
* When using specialized classes, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Define a fallback type to the standard labels via the railtype table in case you want the vehicle to be available on the standard tracks if no matching track set is loaded.

Be as specific as you want when selecting the railtype, it is the job of the track set to select a playable, reduced subset out of all possible type combinations.

== In case you're not convinced by this scheme ==
Adopting this scheme gives the player freedom to use any track set in combination with any train set that follow the scheme.

This means that you can make your train set compatible with track sets that provide axle load classes, and track sets that provide speed limits, and at the same time with track sets that provide none of this. This way, the player can decide to play with or without axle load classes, or with or without speed limits, simply by loading a track set that does or does not provide these features.

And for your track set, it means that you can make it as simple or as complicated as you want (within the 64 track type limit), while not having to worry about compatibility with train sets.

Still not convinced? Feel free to use railtype labels of your own, but know that you will likely come to regret that at some point in the future.

==Forum topic==
If you want to discuss the standardized railtype scheme or have any questions about it, you can visit [http://www.tt-forums.net/viewtopic.php?t=59379 the forum topic].

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Extended multivoltage support addition==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E or just E
|-
|= ||Equivilent to D and d || First D then E or just E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Possible additions==

{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_A_-" and "_A_N" to EVERY [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] (as well as the equivalent electrified/pneumatic railtype that is powered on your electrified/pneumatic railtype to support it if you are making a new railtype set, older sets can be covered by fix or patch grfs) and "_A_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]]
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), 16 in (406 mm), 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1432 mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SABN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm) and Dresden (1450 mm) gauges may be better grouped here
|-
|t ||Leipzig trams (1458 mm) and Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|L ||Maglevs that have a u-shaped track
|-
|T ||Maglevs that have a monorail track
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|S ||Maglevs that use a synchronous linear motor ||N/A ||
|-
|I ||Maglevs that use a linear induction motor ||MGLV (the whole label) ||
|-
|V ||Vactrains/Hyperloop ||t, then I, then MGLV (the whole label) ||
|-
|t ||"Universal custom tunnel" (for diagonal sub-surface "rail tunnels" that use decorative track types to complete the illusion) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}

TracktypeLabels

2024-03-30T15:26:46Z

Brickblock1: /* Non-standard roadtypes */

== Labels for rail types, road types and tram type ==
All track types are identified via 4-byte labels.
The labels are unique within their type, but it is common that rail types and tram types use the same label for similar types.

Vehicles can check for their track type on a tile, but they only have access to their own type: On a level-crossing with all three tracks (rail, road, tram) trains can only check rail types, buses/trucks can only check road types, and trams can only check tram types.

=== Rail vs. tram ===
Rail and tram are very different wrt. game-play, but both are kind of rails.
To unify labels, rail and tram should use the same labels, if the tracks are similar.
* RAIL for unelectrified rail and tram.
* ELRL for electrified rail and tram.
* FNCY for fancy-powered rail and tram.

== Default labels ==

=== Rail type ===
These labels are used for the trains and tracks in the base game, as well as for train sets that are not rail-type-aware. Consequently, track NewGRFs should always override their properties, or at least make their tracks compatible to them.

{| class="wikitable"
|-
!'''Label'''
!'''Rail Type'''
|-
|RAIL
|Normal rail
|-
|ELRL
|electrified rail
|-
|MONO
|Monorail tracks
|-
|MGLV
|Maglev tracks
|}

=== Road types ===
By default there is only a single road type defined:
{| class="wikitable"
|-
!'''Label'''
!'''Road Type'''
|-
|ROAD
|Normal road
|}
However, if a NewGRF requires electrified "ELRD", an Action0 is sufficient to add this type and make it use the default road-ground and catenary sprites.

=== Tram types ===
By default there is only a single tram type defined:
{| class="wikitable"
|-
!'''Label'''
!'''Tram Type'''
|-
|ELRL
|Electrified rail
|}
However, if a NewGRF requires unelectrified "RAIL", an Action0 is sufficient to add this type and make it use the default tram-ground sprites.

Note: Please use the same label for tram types which already exist as rail types.

== Standardized Railtype Scheme ==
Several members of the TT Forums have collaborated to define a rail type label scheme that allows for compatibility between train and track sets by different authors. At the same time it allows fancy stuff like axle weight limits, speed limits, different track and electrification types, etc. See [[Standardized Railtype Scheme]].

The Standardized Railtype Scheme is not mandatory, and authors providing both trains and railtypes may have valid reasons to use labels outside the scheme. The Standardized Scheme cannot cover all possible cases, by design, as it would be too complex.

However even when using custom labels, it may be worth using Standardized Railtype labels:
* as fallbacks for trains when the custom label is not available (via NML railtypetable fallback lists)
* as alternates handled by a railtype with a custom label (via NML alternative_railtype_list or NFO prop 1D)
This will provide wider compatibility with other train and railtype grfs.

=== Non-standard railtype labels ===

The following labels were defined before the Standardized Railtype Scheme existed. Using these or not is at the discretion of individual grf authors, but generally, if an equivalent label exists in the Standardized Railtype Scheme, it's better to use that.

{| class="mw-collapsible mw-collapsed wikitable"
|-
! scope="col" | '''Label'''
! scope="col" | '''Rail Type'''
! scope="col" | '''Notes'''
|-
|_040
|speed limit 40 km/h
|Slowrails, SwedishRails
|-
|_080
|speed limit 80 km/h
|Slowrails, SwedishRails
|-
|E040
|speed limit 40 km/h, with catenary
|Slowrails, SwedishRails
|-
|E080
|speed limit 80 km/h, with catenary
|Slowrails, SwedishRails
|-
|3RDR
|Tracks with third rail
|MetroTracks, NuTracks, UK Railway Set tracks, Japanese Track Set
|-
|3RDC
|Tracks with third rail and catenary
|MetroTracks, NuTracks, UK Railway Set tracks, Japanese Track Set
|-
|RLOW
|Low speed tracks
|NuTracks, SwedishRails, Japanese Track Set
|-
|ELOW
|Low speed tracks with catenary
|NuTracks, SwedishRails, Japanese Track Set
|-
|3LOW
|Low speed tracks with 3rd rail
|NuTracks,
|-
|CLOW
|Low speed tracks, 3rd rail and catenary
|NuTracks
|-
|RMED
|Medium speed tracks
|NuTracks, SwedishRails
|-
|EMED
|Medium speed tracks with catenary
|NuTracks, SwedishRails
|-
|3MED
|Medium speed tracks with 3rd rail
|NuTracks
|-
|CMED
|Medium speed tracks, 3rd rail and catenary
|NuTracks
|-
|RHIG
|High speed tracks
|NuTracks, SwedishRails, Japanese Track Set
|-
|EHIG
|High speed tracks with catenary
|NuTracks, SwedishRails, Japanese Track Set
|-
|HSTR
|Very high speed tracks with catenary
|NuTracks, SwedishRails, Japanese Track Set
|-
|NGRL
|Narrow gauge tracks
|Narrow Gauge Track Types, Japanese Track Set
|-
|ELNG
|Narrow gauge tracks with catenary
|Narrow Gauge Track Types, Japanese Track Set
|-
|PLAN
|Planning tracks (blue dotted lines)
|NuTracks
|-
|MTRO
|Metro tracks
|NuTracks
|-
|MTRC
|Metro tracks with concrete edges
|NuTracks
|-
|MTRS
|Metro tracks with suburban buildings on top
|NuTracks
|-
|MTRU
|Metro tracks with 'downtown' buildings on top
|NuTracks
|-
|MTRT
|Metro tracks with plain landscape on top
|NuTracks
|-
|DBNN
|branch line
|DBRails
|-
|DBNE
|branch line, electrified
|DBRails
|-
|DBHN
|main line
|DBRails
|-
|DBHE
|main line, electrified
|DBRails
|-
|DBHS
|high speed line electrified (NBS)
|DBRails
|-
|TRPD
|transrapid track
|Transrapid track type
|-
|NLOW
|Low speed narrow gauge tracks
|Japanese Track Set
|-
|ENLW
|Low speed narrow gauge tracks with catenary
|Japanese Track Set
|-
|ENHI
|Modern narrow gauge tracks with catenary
|Japanese Track Set
|-
|RLA0
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 60 km/h
|xUSSR train set
|-
|RLA1
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 100 km/h
|xUSSR train set
|-
|RLA2
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 140 km/h
|xUSSR train set
|-
|RLA3
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 250 km/h
|xUSSR train set
|-
|ERd0
|Broad (1520 mm) gauge tracks with generic DC catenary 1,5kV. Speed limit 60 km/h
|xUSSR train set
|-
|ERd1
|Broad (1520 mm) gauge tracks with generic DC catenary 1,5kV. Speed limit 100 km/h
|xUSSR train set
|-
|ERd2
|Broad (1520 mm) gauge tracks with generic DC catenary 1,5kV. Speed limit 140 km/h
|xUSSR train set add-on
|-
|ERd3
|Broad (1520 mm) gauge tracks with generic DC catenary 1,5kV. Speed limit 250 km/h
|xUSSR train set add-on
|-
|ERD1
|Broad (1520 mm) gauge tracks with generic DC catenary 3kV. Speed limit 100 km/h
|xUSSR train set
|-
|ERD2
|Broad (1520 mm) gauge tracks with generic DC catenary 3kV. Speed limit 140 km/h
|xUSSR train set
|-
|ERD3
|Broad (1520 mm) gauge tracks with generic DC catenary 3kV. Speed limit 250 km/h
|xUSSR train set
|-
|ERA1
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. Speed limit 100 km/h
|xUSSR train set
|-
|ERA2
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. Speed limit 140 km/h
|xUSSR train set
|-
|ERA3
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. Speed limit 250 km/h
|xUSSR train set
|-
|ERA4
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. No speed limit
|xUSSR train set
|-
|ERa0
|Broad (1520 mm) gauge tracks with generic AC catenary 15kV. Speed limit 60 km/h
|xUSSR train set
|-
|ERa1
|Broad (1520 mm) gauge tracks with generic AC catenary 15kV. Speed limit 100 km/h
|xUSSR train set add-on
|-
|ERa2
|Broad (1520 mm) gauge tracks with generic AC catenary 15kV. Speed limit 140 km/h
|xUSSR train set add-on
|-
|ERa3
|Broad (1520 mm) gauge tracks with generic AC catenary 15kV. Speed limit 250 km/h
|xUSSR train set add-on
|-
|ERa4
|Broad (1520 mm) gauge tracks with generic AC catenary 15kV. No speed limit
|xUSSR train set add-on
|-
|ER2D
|Broad (1520 mm) gauge tracks with DC 1,5kV / 3kV catenary. Speed limit 100 km/h
|xUSSR train set
|-
|ER2S
|Broad (1520 mm) gauge tracks with AC 25kV / DC 3kV catenary. Speed limit 120 km/h
|xUSSR train set
|-
|ER2s
|Broad (1520 mm) gauge tracks with AC 25kV / DC 1,5kV catenary. Speed limit 120 km/h
|xUSSR train set add-on
|-
|ER3a
|Broad (1520 mm) gauge tracks with AC 25kV / 15kV / DC 1,5kV catenary. Speed limit 120 km/h
|xUSSR train set add-on
|-
|ER3D
|Broad (1520 mm) gauge tracks with AC 25kV / DC 3kV / 1,5kV catenary. Speed limit 120 km/h
|xUSSR train set add-on
|-
|ER4S
|Broad (1520 mm) gauge tracks with AC 25kV / 15kV / DC 3kV / 1,5kV catenary. Speed limit 120 km/h
|xUSSR train set add-on
|-
|SW1L
|Broad (1520 mm) gauge tracks with DC 700V third rail on the left. Speed limit 100 km/h
|xUSSR train set
|-
|SW1R
|Broad (1520 mm) gauge tracks with DC 700V third rail on the right. Speed limit 100 km/h
|xUSSR train set
|-
|WWAY
|Wagonway
|Early Rails set
|-
|WGWY
|Wagonway
|Recycled Tracktype Set
|-
|LTRL
|Light Rails
|Early Rails set
|-
|LIHT
|Light Rails
|Recycled Tracktype Set
|-
|TYTX
|ToyTrax
|ToyTrax
|-
|ELTX
|ElecTrax
|ToyTrax
|-
|DPRK
|North Korean Urban Ground
|Trackless Trackset
|-
|JPU1
|Japanese Urban Ground
|Trackless Trackset
|-
|ISR1
|Industrial Stations Renewal Ground
|Trackless Trackset
|-
|ISR2
|CHIPS Dirt Ground
|Trackless Trackset
|-
|ISR3
|CHIPS Asphalt Ground
|Trackless Trackset
|-
|ISR4
|CHIPS Cobblestone Ground
|Trackless Trackset
|-
|NORD
|Standard gauge AC electrified 15 and 25 kv (hidden) Depriciated use SAA$ instead
|SMITS rails
|}

== Standardized Roadtype Scheme ==
Same story as the railtype one, also covers trams. See [[Standardized Roadtype Scheme]]

=== Non-standard roadtype labels ===

The following labels were defined before the Standardized Roadtype Scheme existed, but after alternative_roadtype_list and alternative_tramtype_list existed (meaning compatibility options allowed for quicker proliferation. Using these or not is at the discretion of individual grf authors, but generally, if an equivalent label exists in the Standardized Roadtype Scheme, it's better to use that. Ditto for tramtypes, but note that a label can be used twice, once for a roadtype and once for a tramtype.

==== Non-standard roadtypes ====
{| class="mw-collapsible mw-collapsed wikitable"
|-
! scope="col" | '''Label'''
! scope="col" | '''Road Type'''
! scope="col" | '''Notes'''
|-
|ELRD
|Road with catenary
|Very commonly used
|-
|_TRD
|Town Roads
|Ufiby's U&ReRMM (1st version only)
|-
|SMRT
|SmartRoad
|Various unattributed roadtype sets
|-
|SMTS
|SmartStreet
|Various unattributed roadtype sets
|-
|HAUL
|Heavy duty vehicles
|Docklands
|-
|ELHL
|Electric heavy duty vehicles
|Docklands
|}

==== Non-standard tramtypes ====
{| class="mw-collapsible mw-collapsed wikitable"
|-
! scope="col" | '''Label'''
! scope="col" | '''Road Type'''
! scope="col" | '''Notes'''
|-
|RAIL
|Non-electrified tramtrack
|Very commonly used
|-
|Auto
|Trackless Tram
|An unattributed roadtype set (GRC?)
|}

Standardized Railtype Scheme

2024-03-13T21:52:41Z

Brickblock1: /* Speed limit class [*X**] */

This railtype label scheme aims to bring order to the uncontrolled growth of railtype labels. It groups the rail types into what matters from a technical perspective. The scheme provides a standardized way of defining railtype labels, based on track gauge and type, speed class, allowable axle weight and electrification type.

It is the explicit intent of this scheme to decouple track sets from vehicle sets to facilitate easy mixing. This way the player can select a track set of choice to go with a train set of choice. It allows the player to play with or without axle load classes, or with or without speed limit classes, simply by loading a track set that does or does not provide these features. In some cases it will also be possible to combine niche track sets, for instance a standard gauge track set with a narrow gauge and a metro track set.

== The Label Scheme ==
A railtype label consists of four characters. In this scheme, each position has a different purpose:
# Track gauge and type class (e.g. standard gauge rail, narrow gauge rail, monorail)
# Speed limit class
# Axle load class (maximum allowed axle weight for this track)
# Energy source type class

In the next sections, each of the four positions will be explained.

=== Track gauge and type class [X***] ===
The first position in the railtype label defines track gauge and/or track type class. The following classes are currently defined:

{|
! !!Track type/gauge
|-
|S ||Standard gauge rail
|-
|B ||Broad gauge rail
|-
|N ||Narrow gauge rail
|-
|n ||Secondary narrow gauge rail (e.g. when providing both metre and cape gauge, always use N in case of just one type of narrow gauge)
|-
|D ||Dual gauge rail, standard/broad gauge
|-
|d ||Dual gauge rail, standard/narrow gauge
|-
|M ||Monorail
|-
|L ||Magnetic Levitation
|}

=== Speed limit class [*X**] ===
The second position in the railtype label defines the speed limit class. These classes do not map to a fixed numeric value, but are used to define an internal speed limit order for the track set. This means that if your track set has two different speed limits for track types that are otherwise identical, you'll use letters A and B here. In case of three different speed limits, use A, B and C. In case your track set does not employ speed limits, always use A. Train sets do not care about the speed limit, and will always set the lowest speed class, i.e. A.

This gives for instance the following options:

<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||no speed limits
|}
</div>
<div style="float:left;">
 OR 
</div>
</div>
<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||low speed
|-
|B ||high speed
|}
</div>
<div style="float:left;">
 OR 
</div>
</div>
<div style="float:left;">
<div style="float:left;">
{|
! !!Speed limit class
|-
|A ||low speed
|-
|B ||medium speed
|-
|C ||high speed
|}
</div>
<div style="float:left;">
 etc. 
</div>
</div>
<div style="clear:left;"></div>

The speed limit class may also be used for some advanced features of the label scheme, like specialized track types and eyecandy purposes. Be careful not to break the compatibility with other sets when using the speed limit class for these purposes.

An example of a special use is rack rail. In the French set it is used to give rack rail engines a higher speed and TE than normal rail engines when used on rack rail. When defining trains with a special speed limit class, always allow a fallback to speed limit class A via the railtype table.

An example of eyecandy use are urban tracks. These are a variation of regular tracks, but with concrete ground tiles to better match the urban environment. Train sets must not define vehicles for eyecandy classes. If you think you have special vehicles that should only run on the eyecandy class, it is ''not'' eyecandy but a separate track gauge/type.

The following special and eyecandy classes have been defined so far:

{|
! !!Description !!Type !!Used by
|-
|A-H ||speed limits ||colspan="2"| reserved
|-
|R ||rack rail, that allows this vehicle to not slow down going uphill ||special ||French Set Rails
|-
|S ||subterranean ||eyecandy ||Metro Track Set
|-
|U ||urban ||eyecandy ||Metro Track Set
|}
Rack rail needs a bit greater of a explanation, idealy it would be coded in a way where both Pure rack and Rack-and-adhesion systems are supported.
This can be achieved by making regular tracks powered on rackrail without the opposite being true. This means vehicles defined for NRAN can't go on NAAN (like a pure rack system) but NAAN vehicles can go on NRAN (like a rack-and-adhesion system). Currently French Set Rails implements compatiblility both ways which makes pure rack systems impossible.

=== Axle load class [**X*] ===
The third position defines the axle weight limit. Heavy trains cannot run on tracks with a low axle weight limit; these trains need more expensive tracks with a heigher weight limit. There are five axle load classes '''A''' through '''E'''. '''A''' is for the lowest axle load limit, '''E''' for the highest. The exact axle load attached to each class is relative to the track gauge/type and trains in the set.

A train set should set the appropriate axle weight for each train via the railtype label, as to make the set work with track sets that do provide tracks with different weight limits, even if you don't care about it for your trainset. Split all vehicles of a certain track gauge/type into five groups of similar axle weight. The group with the lowest axle weights will get class '''A''', the second lowest class '''B''', etc. up to the group with the highest axle weights which will get class '''E'''. Do the same for the other track gauge/types if your train set has those.

A track set does not have to provide a dedicated track type for each axle weight limit. A track set that does not provide a dedicated track for each axle load class, must make sure to map all undefined axle load classes to a real railtype using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]]. This way a train set can rely on all labels for all axle load classes being available. Example: if you only want to provide 2 axle load classes for standard gauge unelectrified with no speed limits, you can map SA'''A'''N + SA'''B'''N to SA'''C'''N and SA'''D'''N to SA'''E'''N if the cost difference between the two railtypes is high, or SA'''A'''N to SA'''B'''N and SA'''C'''N + SA'''D'''N to SA'''E'''N if the cost difference is low.

If you don't want to provide any axle load classes in your track set, it doesn't really matter what axle load class you choose for the track, as you'll be mapping all other classes to this track anyways. But the lowest or highest class are the obvious choice. Example: if your track set only provides narrow gauge unelectrified track with no speed limits and no axle load limits, you may use NA'''A'''N for the track label, and provide NA'''B'''N, NA'''C'''N, NA'''D'''N, NA'''E'''N in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

If you need more than five axle load class, you may use lowercase letters for very low axle loads and continue the uppercase letters for very high axle loads. Be advised that your train set may not assume the existance of any other class than '''A''' through '''E''', so when the range make sure to program your railtype table such that trains with such a class will fall back to class '''A''' or '''E'''. If you make a track set with an extended range, be aware that not all train sets will define trains for these tracks. In general: only do this in case of a train set with a matching track set.

For the lowercase letters, '''b''' is lower than '''a''', so for increasing axle load limits: b < a < A < B < C etc.

Note that the axle load classes never map to a specific weight in tonnes. For that reason it does not make sense to add a numeric value for the axle load to the name of a track type or in the extended purchase info of a train. Instead use the relative expressions 'very low', 'low', 'medium', 'high' and 'very high' or use the class letters directly.

If a guideline is needed for updating a set to use axle loads in a train set where they don't yet exist, the following might serve as a basic "generic" guideline...

{| class="mw-collapsible mw-collapsed"
! !!Indefinite !!Generic !! First usage
|-
|c ||Horse-drawn Wagonway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1594
|-
|b ||Iron Plateway ||1 metric tonne (1000kg) per axle || style="text-align:right;"|1799
|-
|a ||Prototype Rails ||5 metric tonnes (5000kg) per axle; Because reserved by examples || style="text-align:right;"|1820
|-
|A ||Very Low (2012 OG Default)||10 metric tonnes (10000kg) per axle || style="text-align:right;"|1828
|-
|B ||Low (2024 "New" Default) ||20 metric tonnes (20000kg) per axle || style="text-align:right;"|1968
|-
|C ||Medium ||30 metric tonnes (30000kg) per axle || style="text-align:right;"|~1978
|-
|D ||High ||40 metric tonnes (40000kg) per axle || style="text-align:right;"|1988
|-
|E ||Very High ||50 metric tonnes (50000kg) per axle || style="text-align:right;"|2008
|-
|F ||Future-proofing ||No limit per axle (update in 2030 or so?) || style="text-align:right;"|~2028
|}

=== Energy source type class [***X] ===
The last position defines the energy source type class. This is split in generic energy source types like overhead wires and third rail and specialized types like alternating and direct current.

A track set that only uses specialized types, should map the generic types to the most suitable specialized type in the set.

A vehicle set that uses specialized types should define a generic type as fallback, via the railtype table. If such a fallback is omitted, please note that certain vehicles may be unavailable depending on track set loaded.

{|
! !!Generic energy type classes
|-
|N ||no electrification
|-
|E ||overhead wires/catenary electrification
|-
|3 ||3rd rail electrification
|}

{|
! !!Specialized energy type classes !!Vehicle set fallback
|-
|Z ||3rd rail and catenary electrification || 3 or E
|-
|4 ||4th rail electrification || 3
|-
|Y ||4th rail and catenary electrification || 4 or E
|-
|T ||[http://en.wikipedia.org/wiki/Three-phase_AC_railway_electrification three phase AC electrification] || E
|-
| colspan="3" |  
|-
|D ||DC catenary electrification || E
|-
|d ||low voltage DC catenary electrification (only when D also used in set) || First A then E
|-
|A ||AC catenary electrification || E
|-
|a ||low voltage AC catenary electrification (only when A also used in set) || First A then E
|}

If you want multi-voltage/current vehicles in your set (i.e. a train that can run on both AC and DC current), you have to define a dedicated railtype for those vehicles. Without the railtype, it's not possible to define vehicles with this property. If you only have vehicles that can run on either one type of voltage/current or on all types of voltage/current (e.g. a 2-system if you only have '''A''' and '''D''' tracks, or a 4-system in case of all '''A''', '''a''', '''D''' and '''d'''), then use the generic class '''E''' for vehicles that should be able to run on all different voltage/currents. Also the track set needs to have one at least one railtype with class '''E''' defined.

Note that if you want more than one type of multi-voltage/current, you'll quickly get a combinatory explosion of railtype labels, so plan carefully or do not attempt it. For every different multi-voltage/current vehicle type a dedicated railtype is needed. If you want all possible combinations, then you need to define an additional 8 classes. It is not recommended to make your train/track set this complicated.

Example approach for a 4-system set, with trains that can run on either one or all systems:
* '''E''': generic catenary-powered electric engines. "universal" [4-system] if any of '''D'''/'''d'''/'''A'''/'''a''' are defined.
* '''A''': generic AC catenary electric engines. 25kV only if '''a''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''A''';
* '''a''': 15kV AC catenary electric engines. Only defined if '''A''' also defined. Vehicle sets should use '''A''' and '''E''' as fallback, if defining an engine for '''a''';
* '''D''': generic DC catenary electric engines. 3kV if '''d''' also defined. Vehicle sets should use '''E''' as fallback, if defining an engine for '''D''';
* '''d''': 1.5kV DC catenary electric engines. Only defined if '''D''' also defined. Vehicle sets should use '''D''' and '''E''' as fallback, if defining an engine for '''d'''.
For a 2-system set, you can simply drop '''a''' and '''d'''.

=== Standard labels: RAIL, ELRL, MONO, MGLV ===
It's not possible to undefine the standard railtypes RAIL, ELRL, MONO and MGLV. The game will always add those if there are vehicles defined for these track types. As a result, for a track set it's best not to ignore those standard labels, but rather work with them and define them in the set. If your track set does not have monorail or maglev tracks, there of course is no need to define those. But if your track set defines anything that resembles unelectrified or electrified rail, you should use the RAIL and ELRL labels. Matching labels from the above scheme will then be defined in property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

As vehicles from NewGRFs that do not use explicit railtypes will end up on these standard railtypes, you should use RAIL instead of whatever type could be regarded as the most commonly used unelectrified type, ELRL instead of the most commonly used electrified type and so on. The label according to this scheme is then set as an alternate.

== Summary for track sets ==
This section summarizes the above for track sets.

; [X***] Track gauge and type class
* Define at least one track type for every track gauge/type class you want in your set.
* If you only provide tracks for one gauge/type, consider leaving some free railtypes so a player can load an additional set for some other type.
; [*X**] Speed limit class
* Make sure class A is always available, either directly or via an alternate label.
* Use only class A if you don't want speed limits;
* With speed limits, A is the lowest speed limit. Continue with B, C, etc. for increasing speed limits;
* The speed class can also be used to implement additional eye-candy track types, use letters higher in the alphabet for this.
; [**X*] Axle load class
* Always define all classes A through E for every track type class / electrification combination, either:
** Directly via a real railtype definition;
** Indirectly via the alternate rail type label list, property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].
* Extend the predefined classes only if you also provide a train set that makes use of these.
; [***X] Energy source type class
* If your set only uses specialized classes, always map the generic classes to the closest matching specialized type via property 1D.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Always define the standard labels when possible, instead of what would be the equivalent of the standard label in this scheme.
* Map the equivalent labels from this scheme to the standard labels using property [[Action0/Railtypes#Alternate_rail_type_labels_.281D.29|1D (NFO)]] or [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]].

Or, put differently, for each gauge/type, select one or more energy source types. For each type/energy combination provide all axle load classes for the speed class "A", either as a real type or as an alternate of another type. Provide more types with a different speed letter if you want to provide several different speeds or other eye-candy tracks.

== Summary for train sets ==
This section summarizes the above for train sets.

; [X***] Track gauge and type class
* Use the track type class that matches the vehicle;
* Define a fallback type via the railtype table in case you want the vehicle to be available on a different track if no matching track set is loaded.
** Specialized subtypes like "n" might not always be available. If you want those vehicles to be still available then, fall back the the generic class (e.g. "N").
; [*X**] Speed limit class
* Always use class A for every vehicle.
; [**X*] Axle load class
* Use all classes A through E according to the maximum axle weight of the vehicle.
* Extend the predefined classes only if you also provide a track set that makes use of these;
** When extending the predefined classes A through E, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; [***X] Energy source type class
* Use the energy source type class that matches the vehicle;
* When using specialized classes, define a fallback type via the railtype table in case you want the vehicle to be available if no matching track set is loaded.
; Standard labels [RAIL, ELRL, MONO, MGLV]
* Define a fallback type to the standard labels via the railtype table in case you want the vehicle to be available on the standard tracks if no matching track set is loaded.

Be as specific as you want when selecting the railtype, it is the job of the track set to select a playable, reduced subset out of all possible type combinations.

== In case you're not convinced by this scheme ==
Adopting this scheme gives the player freedom to use any track set in combination with any train set that follow the scheme.

This means that you can make your train set compatible with track sets that provide axle load classes, and track sets that provide speed limits, and at the same time with track sets that provide none of this. This way, the player can decide to play with or without axle load classes, or with or without speed limits, simply by loading a track set that does or does not provide these features.

And for your track set, it means that you can make it as simple or as complicated as you want (within the 64 track type limit), while not having to worry about compatibility with train sets.

Still not convinced? Feel free to use railtype labels of your own, but know that you will likely come to regret that at some point in the future.

==Forum topic==
If you want to discuss the standardized railtype scheme or have any questions about it, you can visit [http://www.tt-forums.net/viewtopic.php?t=59379 the forum topic].

=="Innsbruck 2022 Convention" for partial compliance==

This is really esoteric, but eh. It was the product of long discussion / debate / argument / reasoning between grf authors.

1. The Standardized Railtype Scheme '''is a useful tool''' for providing reliable compatibility between train grfs and railtype grfs.

2. The '''axle load class''' in the scheme presents a number of issues for compliance.

2.1. Over 10 years since the scheme was standardised, not many train grfs implement multiple axle load classes '''as required by the scheme'''. Known examples that '''do''' comply include Dutch Train Set, French Narrow Gauge Trains, and Finnish Trains.

2.2. Elements of the axle load rules have proven hard to interpret. For example:

* is it compliant to use ''fewer'' than 5 classes in a train grf? There is a lack of consensus on this.
* axle load is only one of many factors that govern whether a vehicle is compatible with a route, for example loading gauge, minimum curve, signalling types etc

2.3. Meanwhile ''multiple existing train grfs use class ''A'' for the axle load for all trains'' (except where relying on default railtypes such as RAIL and ELRL).

'''3. The Innsbruck 2022 Convention uses class ''A'' for axle load for '''all''' trains in a train grf (except where relying on default railtypes such as RAIL and ELRL).'''

This is '''not''' fully compliant with the Standardized Railtype Scheme and does not claim to be.

However train grfs using the Innsbruck 2022 Convention are ''broadly compatible'' with railtype grfs using the Standardized Railtype Scheme.

Obligatory XKCD link about 'standards': https://xkcd.com/927/

===Known issues===

Known problems are that trains using only class 'A' may limit the ability of railtype grf authors to achieve their design goals for separating railtypes by axle load.
But on reflection, it can be seen that a train grf might not be able to provide a broad enough range of vehicles to cover at least 5 axle load classes.

3.1. The Innsbruck 2022 Convention is '''not''' appropriate for train grf authors who wish to provide more than one axle load class.

3.2. The Innsbruck 2022 Convention treats the meaning of class ''A'' as ''undefined'', ''ignored'' or ''compatible with most restricted railtype'' for axle load.

Axle load class ''A'' '''cannot''' be safely interpreted as ''universal'' because from the perspective of a railtype grf ''A'' is ''most restricted railtype'', where ''universal'' is better represented as ''least restricted railtype''. Depending how many axle load classes are in use by the railtype grf, this could be class ''B'', ''C'', ''D'', ''E'' etc. To illustrate this issue, take the following scenario

* railtype grf defines axle loads ''A'' to ''E''. In this case the railtype grf author intends that ''A'' is compatible with the smallest range of vehicles, ''E'' is compatible with the largest range of vehicles, and ''B'', ''C'' and ''D'' are compatible with some intermediate ranges of vehicles
* but the vehicle grf author has defined all vehicles to be axle load ''A'' in an attempt to express this vehicle is ''universal''. The result in the game is that an identical range of vehicles will be compatible with railtypes ''A'' to ''E''.

This is clearly '''not''' the intended outcome of the railtype author. But nor is it clear within the spec that the vehicle author has particularly done anything wrong.

It ''would'' be possible to use railtype availability testing to adjust the vehicle property 05 (track_type) to fit the highest defined axle load (''E'' in this example case), but this is not insignificant work, and it's unlikely to be widely adopted by vehicle grf authors. Nor would this solution achieve ''universal'' as all vehicles in vehicle grf then would be incompatible with types ''A'' through ''D''.

3.3. When the Innsbruck 2022 Convention is used, this '''does not prevent''' a train grf being extended in some future release to achieve full compliance with Standardized Railtype Scheme. ''That choice remains with train grf authors''.

3.4. If 2012 could be revisited, providing an optional ''_'' axle load class in the Standardized Railtype Scheme for ''undefined'' would have been preferable, but as of 2022, ''A'' is already widely used for this purpose, and time travel is not known to be possible.

==Extended multivoltage support addition==
These are extensions to the energy source type class currently supported by SETS and xUSSR Rails which allow trainsets to code trains which are limited to a certain selection of voltages. As stated in the energy source type class section this might not be of use for all sets, as such it is optional but still recommended for trainsets for ideal functionality with tracksets which support the extended labels.
{|
! colspan="2" | Specialized energy type classes !!Vehicle set fallback
|-
|* ||Equivilent to A, a, D and d || E
|-
| colspan="3" |  
|-
|' ||Equivilent to A, a and D || E
|-
|^ ||Equivilent to A, a and d || E
|-
|_ ||Equivilent to A, D and d || E
|-
|, ||Equivilent to a, D and d || E
|-
| colspan="3" |  
|-
|$ ||Equivilent to A and a || First A then E
|-
|= ||Equivilent to D and d || First D then E
|-
|) ||Equivilent to A and D || E
|-
|( ||Equivilent to A and d || E
|-
|] ||Equivilent to a and D || E
|-
|[ ||Equivilent to a and d || E
|}

==Possible additions==

{| class="mw-collapsible mw-collapsed wikitable"
! !!Track type/gauge
|-
|_ ||Universal "cheat" rail; ALWAYS add "_A_-" and "_A_N" to EVERY [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] (as well as the equivalent electrified/pneumatic railtype that is powered on your electrified/pneumatic railtype to support it if you are making a new railtype set, older sets can be covered by fix or patch grfs) and "_A_t" to EVERY [[NML:Railtypes#Railtype_properties|powered_railtype_list (NML)]]
|-
|0 ||(A number zero, not a letter "Oh") No track, eyecandy-use only
|-
|U ||[https://perma.cc/93VE-8JQZ "Ukrainian monorail" or Şaropoí̈zd (Шаропоїзд)], a u-shaped concrete "monorail trench" from 1920's Soviet Union; see [https://www.tt-forums.net/viewtopic.php?f=26&t=47432 the Yarmanchuk Express] for graphics
|-
|1 ||Early Monorail; See [https://perma.cc/6BVS-2P2X here] and [https://perma.cc/VCG2-ATUA here]
|-
|G ||Gyrail; [https://en.wikipedia.org/wiki/Gyro_monorail Gyro monorail/Gyroscopic monorail/Gyro-stabilized monorail] for description and IRL example, and [https://wikimon.net/Trailmon here] ([https://web.archive.org/web/20240227205547/https://wikimon.net/Trailmon archived]) for good fictional examples
|-
|m ||Minimum gauge rail; [https://en.wikipedia.org/wiki/Minimum-gauge_railway 15 in (381 mm), 400 mm (15+3⁄4 in), 16 in (406 mm), 18 in (457 mm), 19 in (483 mm), 500 mm (19+3⁄4 in) or 20 in (508 mm)]
|-
|n ||600mm "Decauville" or "Feldsbahn", formerly labelled "NG60" before standardization; the most common narrow gauge track type in OpenTTD other than metre gauge, 600mm gauge is thus ideal for taking up the "n" gauge, though this is an ultimately optional distinction
|-
|7 ||750mm, Bosnian gauge (760 mm), and 762mm; all start with 7 and are close in size
|-
|3 ||Swedish 3 foot (891 mm), 900mm, 3 foot (914 mm) and Italian Metre (950mm) gauges
|-
|R ||Metre gauge; potentially compatible with base tramtype "RABN", most early tramways were metre gauge
|-
|4 ||4 foot gauge (1219 mm), and possibly 4'6" in. (1372 mm) if standardization is needed for 1372mm
|-
|s ||Scotch gauge (1372 mm)
|-
|S ||Standard gauge; already implemented in original standardized railtype scheme, but could include near-standard (1432 mm) as well as existing true standard (1435 mm) and is also potentially compatible with the SABN tramtype
|-
|X ||Omni-gauge rail (for at-grade multi-gauge crossings and stations); ultrabroad/secondary broad/primary broad/standard/primary narrow/secondary narrow gauge
|-
|x ||Multi-gauge rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow/secondary narrow
|-
|<nowiki>+</nowiki> ||Quad-gauge (Four-gauge) rail (for at-grade multi-gauge crossings and stations); secondary broad/primary broad/standard/primary narrow
|-
|<nowiki>-</nowiki> ||Four-gauge rail (for at-grade multi-gauge crossings and stations); primary broad/standard/primary narrow/secondary narrow
|-
|b ||Broad gauge rail - As broad gauge is a rare tracktype, it may still be feasible to cement B and b as broad gauges of two differing sizes, but the rarity among gauges in the real world would need to match; Italian (1445 mm) and Dresden (1450 mm) gauges may be better grouped here
|-
|t ||Leipzig trams (1458 mm) and Greater Toronto Area streetcars (1495 mm)
|-
|5 ||1520mm and 5 foot (1524 mm) gauges
|-
|V ||Pennsylvanian (1581 mm and 1588 mm) and Australian "Victorian" (1600 mm) gauges
|-
|6 ||6 foot (1829 mm) broad gauge
|-
|g ||Brunel's Great Western Railway gauge (2140 mm)
|-
|B ||Biggest Broad gauge rail - As broad gauge is a rare tracktype, and the variation in common real life track types too wide, it may be desirable to cement B and b as broad gauges of two differing sizes; With no real life examples that match the usage frequency of "B", the gauge might best draw inspiration from the infamous [https://en.wikipedia.org/wiki/Breitspurbahn Breitspurbahn] (3000 mm) and [https://perma.cc/KQ2Z-5RCR the never-built vehicles designed for it], or from the [https://en.wikipedia.org/wiki/Brighton_and_Rottingdean_Seashore_Electric_Railway Brighton & Rottingdean Seashore Electric Railway] (18 ft/5,486 mm)
|-
|L ||Maglevs that have a u-shaped track
|-
|T ||Maglevs that have a monorail track
|-
|F ||Flightrail; A [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ system capable of high speeds and steep hill grades] that uses a pneumatic pipe for propulsion (see "P" under energy sources), and ''wheels pointed inwards at a 45-degree angle''
|}

It might be preferred to instead use/keep "B" for "all (current) broad gauges" (mostly Victorian gauge) instead using lowercase "b" for Brunel/GWR broad gauge. This wouldn't be to different from narrow gauge since the lesser used ones are lowercase and fallback to the uppercase ones.

{| class="mw-collapsible mw-collapsed wikitable"
! !!Electrification !!Fallback !!Notes
|-
|1 ||Unspecified monorail electrification |||MONO (the whole label) ||
|-
|S ||Maglevs that use a synchronous linear motor ||N/A ||
|-
|I ||Maglevs that use a linear induction motor ||MGLV (the whole label) ||
|-
|V ||Vactrains/Hyperloop ||t, then I, then MGLV (the whole label) ||
|-
|t ||"Universal custom tunnel" (for electrified sub-surface rail tunnels) ||c, then p, then 7, then U (mandatory) ||
|-
|<nowiki>-</nowiki> ||Universal energy type (''not'' meant to replace "***N"; use for vehicles such as driving cabs which cannot move under their own power regardless, if desired) ||N/A (Be sure to put "***E" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***-" label) ||(''Do not give a fallback or use for railtypes, this is for unpowered "locomotives" only!'')
|-
|5 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3") and 630v DC Inner 3rd/4th Rail; a total of 5 rails (2 for wheels, 3 for electricity), plausible in the London Underground network ||3 or 4 ||
|-
|U ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail and universal catenary (SAEE); a total of 5 rails (2 for wheels, 3 for electricity) if only one gauge, plausible in the London Underground network and an "ultimate" dual rail electrification without being a cheat (make it expensive or toggle-able?) as SAEU or as XAEU (universal dual rail electrified tracks) ||E ||
|-
|7 ||750v DC Outer 3rd Rail ("MTRO" or "SA_3"), 630v DC Inner 3rd/4th Rail, Three-phase AC (SA_T) 3rd/4th rail & catenary, and universal catenary (SA_E); a total of 7 rails (2 for wheels, 5 for electricity) if only one gauge, a truly universal dual rail electrification without being impossible (make it VERY expensive or toggle-able so it isn't cheat-y?) as SAE7, XAE7 or even as XRE7 (combination of ALL two-rail track gauges with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible) ||U ||
|-
|P ||Pneumatic tube with physical piston slit, or closed pneumatic tube with magnetic piston (i.e. that used by [https://web.archive.org/web/20231213122530/http://www.flightrail.com/ Flightrail]) ||N/A ||
|-
|p ||Pneumatic and universal electrical power ||P or 7 (Be sure to put "***_" and ***P" in the [[NML:Railtypes#Railtype_properties|alternative_railtype_list (NML)]] of a "***p" label) || XREp is a combination of ALL two-rail track gauges with improbably high axle load with universally-compatible electrification including an outer 3rd rail and a paired set of inner 3rd/4th rails, and a rack rail in the exact center; improbable, but not physically impossible)
|-
|c ||Cheat electrification type; use solely for the "_R_c" and "_R_t" railtype labels specifically (runs everything if coded properly), the latter ("_R_t") is for tunnels, while the former ("_R_c") is for "cheat rail upgrade" newgrfs ||p, then 7, then U, then E, then N, then "SA_-" (the whole label) ||
|}