GRFSpecs - User contributions [en-gb]

Action8

2024-04-20T16:54:45Z

George: /* Used ranges */

==Introduction==

Define GRFID, Name and Description

There are many new graphic sets available to TTD players. Of course, we need to make sure that we never get sets mixed up. To make sure this will never happen you can set an ID. Another useful feature of Action 8 is the ability to include useful information into the final .grf file. Here, we explain how Action 8 works.

== Syntax ==

Like all other pseudo-sprites, Action 8 consists of hexadecimal bits. There is no limitation in the total amount of hexadecimal bits you can use in Action 8. One term does have a limit though. Let's give an example of what an Action 8 line looks like:

<pre><sprite-number> * <length> 08 <version> <grf-id> <name> <description></pre>

Here is a short overview of what every term means:

{| |-
!'''Element'''!![[GRFActionsDetailed|'''Size''']]!!'''Description'''
|-
|<sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes in the action
|-
|08||B||Action 08
|-
|<version>||B||GRF version
|-
|<grf-id>||4*B||A unique ID for your .grf file
|-
|<name>||S||A short text containing the name of this set
|-
|<description>||S||A longer description of this set
|}

== Descriptions ==

=== Sprite-number ===

The number of this sprite.

Action 8 has to be one of the first pseudosprites in the .NFO file. It is however valid to have other actions before it, except those that define new sprites or vehicle (etc.) properties.

Actions 6, 7, 9, B, C, D (except [[GRFResourceManagement|resource management]] sprites), 10 and 14 are valid before an action 8.

=== Length ===

The total number of bytes in Action 8.

=== GRF Version ===

This should be the graphics version that your file is written for. This is the version of the [[Version_numbers#GRF_version|GRF format]], not the [[Version_numbers#Version_of_a_specific_NewGRF|version of your GRF]]!
It is also not the "[[Version_numbers#NFO_version|NFO version]]" you put at the top of ".nfo" files to announce the used syntax for GRFCodec.

Valid values are:

{| |-
!'''Value'''!!'''Compatibility'''!!'''[[Version_numbers#TTDPatch_version|TTDPatch version]]'''!!'''[[Version_numbers#OpenTTD_version|OpenTTD support]]'''
|-
|08||02..08|| - || {{ottd|1.2|r23159}}
|-
|07||02..07||2.5 beta 1 or higher|| {{ottd|0.6}}
|-
|06||02..06||2.0.1 alpha 13 or higher|| {{ottd|0.6}}
|-
|05||02..05||2.0r1 Stable TTDPatch + TTDPatch 2.0.1 alphas up to 12|| {{ottd|0.6}}
|-
|04||02..04||2.0 Stable TTDPatch||{{ottd|0.6}}
|-
|01||00..01||1.9.1 alpha 28 or higher||{{ottd|no}}
|-
|00||00||1.9.1 alphas up to 27||{{ottd|no}}
|}

Entries for 00 and 01 are included only for completeness, and to aid with updating existing graphics. They should not be used with new graphics, because they will be incompatible with current TTDPatch and OpenTTD versions. OpenTTD 1.1.0 and later will disable NewGRFs with non-supported GRF versions.

Make sure to set a version number no lower than the minimum version that supports all features which are used by your file.

The compatibility column means how low a version number is supported by the given TTDPatch version, e.g. TTDPatch 2.0r1 supports graphics files with any version from 02 to 05, but not for example 01 or 06.

Version 07 and 08 introduce a few minor semantic changes to some graphics features, i.e. the file will behave slightly differently depending on whether it's declared as version 06, 07 or 08. These changes are described in more detail in the pages for the features they affect.

=== GRFID ===

This is a series of 4 bytes. It's a convention to
* use the first '''three bytes''' for the creator's '''initials''' in ASCII code, e.g. 54 57 48 for "TWH".
* The last (fourth) byte typically identies which of the author's sets this is. See the next subsection for grfID ranges that are already in use.
* Version numbers for NewGRFs are communicated via preceeding [[Action14]].

In principle, you are free what to use for the GRFID as long as you are sure it is unique, but generally it is best to follow the above guidelines. See the last subsection for locations where to find already used GRFIDs.

Note that GRFIDs starting with FF (i.e. the first byte is FF, such as in FF123456) are reserved for internal purposes and should not be used by regular .grf files. These GRFs can't be disabled; TTDPatch displays them with a blue flag in the GRF Status Window.

The extra newgrf file, part of OpenTTD base sets, have to have a GRFID starting with FF "OT".
See the table below:

{|
!GRFID!!purposes
|-
|00 00 00 00||reserved (used as invalid NewGRF Id, for example when explicitly referencing original industry types etc.)
|-
|00 00 00 01 .. FE FF FF FF||normal NewGRFs
|-
|FF 00 00 00 .. FF FF FF FF||reserved
|-
|FF "OT" 00 .. FF "OT" FF
|extra base GRFs
{|
|FF "OT" 01|| OpenGFX
|-
|FF "OT" 11|| NoGFX
|-
|FF "OTD"|| OpenTTD (extra) base graphics: openttdd.grf (OpenTTD 0.6 - 1.0)
|-
|FF "OTN"|| NightGFX
|-
|FF "OTT"|| OpenTTD (extra) base graphics: openttd.grf (OpenTTD >= 1.1)
|-
|FF "OTW"|| OpenTTD (extra) base graphics: openttdw.grf (OpenTTD 0.6 - 1.0)
|-
|FF "OTz"|| zBase
|}
|-
|FF FF FF FF|| TTDPatch (extra) base graphics
|}

==== Used ranges ====

The following table shows ranges of GRFIDs that are in use by several authors of NewGRFs. People choosing new GRFIDs are asked to not use a GRFID that falls within the ranges of one of the following. This list is in no way exhaustive; if you want to claim your own range, please update the table. For legacy reasons there are some broader ranges of GRFIDs reserved by some people. When you want to reserve a broader range than a variation in only the last byte, think twice and consider how long it will take you to write 255 sensible completely different NewGRFs (as the version of a single grf is encoded in the action14, thus a new ID will even hurt and kill your backward compatibility with older versions).

{|
!Range (hex)!!ASCII!!Usage
|-
|43 41 XX XX||C A _ _||OzTrans; 1st generation Canadian and some North American sets
|-
|48 57 XX XX||H W _ _||SwissFan91; TARS Swiss themed newobjects
|-
|4A 56 XX XX||J V _ _||juzza1; Various Finnish sets
|-
|4D 65 6F XX||M e o _||George; ECS, Long vehicles, xUSSR railways
|-
|4D 46 47 XX||M F G _||Yoshi; DACh, ...
|-
|4D 47 XX XX||M G _ _||Ammler, #openttdcoop
|-
|4E 57 XX XX||N W _ _||Norwegian projects
|-
|4F 47 2B XX||O G + _||OpenGFX+ sets
|-
|4F 7A XX XX||O z _ _||OzTrans; Various non-Canadian projects
|-
|50 43 XX XX||P C _ _||PaulC; Town names, various mini GRFs
|-
|53 43 XX XX||S C _ _||SAC; INFRA projects
|-
|54 57 46 XX||T W F _||Timberwolf; Road Vehicles, Tracks, Trains, Stations
|-
|57 42 XX XX||W B _ _||wallyweb; NewObjects, Various features, GRF development
|-
|6D 62 XX XX||m b _ _||Michael Blunck; DBsetXL, NewStations, MariCo
|-
|97 85 XX XX||? ? _ _||OzTrans; Canadian Theme Pack (under development)
|-
|97 87 XX XX||? ? _ _||OzTrans; 2nd generation Canadian graphics
|-
|FB FB XX XX||? ? _ _||FooBar; Dutch sets, Transrapid/metro tracks
|-
|FF XX XX XX||? _ _ _||System reserved
|}

==== Used GRFIDs ====

There are several places that have/show lists of GRFIDs that are definitely in use by someone. Absence of a GRFID in any of these lists is not proof that it is not used though.

* [https://bananas.openttd.org/package/newgrf Bananas] shows the GRFIDs of all currently active NewGRFs that are distributed by the system
* [http://grfcrawler.tt-forums.net/index.php?do=search&mode=advanced GRFCrawler] allows one to search on GRFIDs of NewGRFs in its system

=== Name ===
This short field should contain the name of the set. See [[GRFActionsDetailed#Strings|GRFActionsDetailed]] for instructions to generate the necessary byte codes, and for restrictions on what characters you may use.
The name must be short because it should fit on one line of the GRF Status window ([[ttwiki:GRFStatusWindow|TTDPatch]], [[ottdwiki:NewGRF|OpenTTD]]).

=== Description ===
This is a longer description of the set. Typically it contains the name of the author and a copyright notice or other attribution. See [[GRFActionsDetailed#Strings|GRFActionsDetailed]] for instructions to generate the necessary byte codes, and for restrictions on what characters you may use.
The description may be quite long, but should be short enough to fit in the description part of the GRF Status window ([[ttwiki:GRFStatusWindow|TTDPatch]], [[ottdwiki:NewGRF|OpenTTD]]), or a part of it may be cut off.

== Example ==

Below is an example of what a real Action 8 pseudo-sprite could look like.

1 * 43 '''08''' 07 "TW" 01 06 "Tutorial Example" 00 "Changes nothing. Author: A kind person" 00

Let's clarify it bit by bit. In order to understand what the bits say you could use a hexadecimal editor.

{| |-
!'''Byte'''!!'''Meaning'''
|-
|1||<sprite-number>
|-
|43||<length> of the action in bytes; start counting at 08 (<action>)
|-
|08||<action>: sets this pseudo-sprite to function as action 8
|-
|07||<version>: GRF format version 7 (this is the version of the used GRF format, not of your GRF)
|-
|54 57 01 06||<-grf-id>: ASCII code for TW, then the numbers 1 and 6 to indicate version 6 of TW's first set
|-
|"Tutorial..." 00||<name>: Name of the NewGRF
|-
|"Changes..." 00||<description>: Description of the NewGRF
|}

Action8

2024-04-20T16:53:06Z

George: /* Used ranges */

==Introduction==

Define GRFID, Name and Description

There are many new graphic sets available to TTD players. Of course, we need to make sure that we never get sets mixed up. To make sure this will never happen you can set an ID. Another useful feature of Action 8 is the ability to include useful information into the final .grf file. Here, we explain how Action 8 works.

== Syntax ==

Like all other pseudo-sprites, Action 8 consists of hexadecimal bits. There is no limitation in the total amount of hexadecimal bits you can use in Action 8. One term does have a limit though. Let's give an example of what an Action 8 line looks like:

<pre><sprite-number> * <length> 08 <version> <grf-id> <name> <description></pre>

Here is a short overview of what every term means:

{| |-
!'''Element'''!![[GRFActionsDetailed|'''Size''']]!!'''Description'''
|-
|<sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes in the action
|-
|08||B||Action 08
|-
|<version>||B||GRF version
|-
|<grf-id>||4*B||A unique ID for your .grf file
|-
|<name>||S||A short text containing the name of this set
|-
|<description>||S||A longer description of this set
|}

== Descriptions ==

=== Sprite-number ===

The number of this sprite.

Action 8 has to be one of the first pseudosprites in the .NFO file. It is however valid to have other actions before it, except those that define new sprites or vehicle (etc.) properties.

Actions 6, 7, 9, B, C, D (except [[GRFResourceManagement|resource management]] sprites), 10 and 14 are valid before an action 8.

=== Length ===

The total number of bytes in Action 8.

=== GRF Version ===

This should be the graphics version that your file is written for. This is the version of the [[Version_numbers#GRF_version|GRF format]], not the [[Version_numbers#Version_of_a_specific_NewGRF|version of your GRF]]!
It is also not the "[[Version_numbers#NFO_version|NFO version]]" you put at the top of ".nfo" files to announce the used syntax for GRFCodec.

Valid values are:

{| |-
!'''Value'''!!'''Compatibility'''!!'''[[Version_numbers#TTDPatch_version|TTDPatch version]]'''!!'''[[Version_numbers#OpenTTD_version|OpenTTD support]]'''
|-
|08||02..08|| - || {{ottd|1.2|r23159}}
|-
|07||02..07||2.5 beta 1 or higher|| {{ottd|0.6}}
|-
|06||02..06||2.0.1 alpha 13 or higher|| {{ottd|0.6}}
|-
|05||02..05||2.0r1 Stable TTDPatch + TTDPatch 2.0.1 alphas up to 12|| {{ottd|0.6}}
|-
|04||02..04||2.0 Stable TTDPatch||{{ottd|0.6}}
|-
|01||00..01||1.9.1 alpha 28 or higher||{{ottd|no}}
|-
|00||00||1.9.1 alphas up to 27||{{ottd|no}}
|}

Entries for 00 and 01 are included only for completeness, and to aid with updating existing graphics. They should not be used with new graphics, because they will be incompatible with current TTDPatch and OpenTTD versions. OpenTTD 1.1.0 and later will disable NewGRFs with non-supported GRF versions.

Make sure to set a version number no lower than the minimum version that supports all features which are used by your file.

The compatibility column means how low a version number is supported by the given TTDPatch version, e.g. TTDPatch 2.0r1 supports graphics files with any version from 02 to 05, but not for example 01 or 06.

Version 07 and 08 introduce a few minor semantic changes to some graphics features, i.e. the file will behave slightly differently depending on whether it's declared as version 06, 07 or 08. These changes are described in more detail in the pages for the features they affect.

=== GRFID ===

This is a series of 4 bytes. It's a convention to
* use the first '''three bytes''' for the creator's '''initials''' in ASCII code, e.g. 54 57 48 for "TWH".
* The last (fourth) byte typically identies which of the author's sets this is. See the next subsection for grfID ranges that are already in use.
* Version numbers for NewGRFs are communicated via preceeding [[Action14]].

In principle, you are free what to use for the GRFID as long as you are sure it is unique, but generally it is best to follow the above guidelines. See the last subsection for locations where to find already used GRFIDs.

Note that GRFIDs starting with FF (i.e. the first byte is FF, such as in FF123456) are reserved for internal purposes and should not be used by regular .grf files. These GRFs can't be disabled; TTDPatch displays them with a blue flag in the GRF Status Window.

The extra newgrf file, part of OpenTTD base sets, have to have a GRFID starting with FF "OT".
See the table below:

{|
!GRFID!!purposes
|-
|00 00 00 00||reserved (used as invalid NewGRF Id, for example when explicitly referencing original industry types etc.)
|-
|00 00 00 01 .. FE FF FF FF||normal NewGRFs
|-
|FF 00 00 00 .. FF FF FF FF||reserved
|-
|FF "OT" 00 .. FF "OT" FF
|extra base GRFs
{|
|FF "OT" 01|| OpenGFX
|-
|FF "OT" 11|| NoGFX
|-
|FF "OTD"|| OpenTTD (extra) base graphics: openttdd.grf (OpenTTD 0.6 - 1.0)
|-
|FF "OTN"|| NightGFX
|-
|FF "OTT"|| OpenTTD (extra) base graphics: openttd.grf (OpenTTD >= 1.1)
|-
|FF "OTW"|| OpenTTD (extra) base graphics: openttdw.grf (OpenTTD 0.6 - 1.0)
|-
|FF "OTz"|| zBase
|}
|-
|FF FF FF FF|| TTDPatch (extra) base graphics
|}

==== Used ranges ====

The following table shows ranges of GRFIDs that are in use by several authors of NewGRFs. People choosing new GRFIDs are asked to not use a GRFID that falls within the ranges of one of the following. This list is in no way exhaustive; if you want to claim your own range, please update the table. For legacy reasons there are some broader ranges of GRFIDs reserved by some people. When you want to reserve a broader range than a variation in only the last byte, think twice and consider how long it will take you to write 255 sensible completely different NewGRFs (as the version of a single grf is encoded in the action14, thus a new ID will even hurt and kill your backward compatibility with older versions).

{|
!Range (hex)!!ASCII!!Usage
|-
|43 41 XX XX||C A _ _||OzTrans; 1st generation Canadian and some North American sets
|-
|48 57 XX XX||H W _ _||SwissFan91; TARS Swiss themed newobjects
|-
|4A 56 XX XX||J V _ _||juzza1; Various Finnish sets
|-
|4D 65 6F XX||M e o _||George; ECS, Long vehicles
|-
|4D 46 47 XX||M F G _||Yoshi; DACh, ...
|-
|4D 47 XX XX||M G _ _||Ammler, #openttdcoop
|-
|4E 57 XX XX||N W _ _||Norwegian projects
|-
|4F 47 2B XX||O G + _||OpenGFX+ sets
|-
|4F 7A XX XX||O z _ _||OzTrans; Various non-Canadian projects
|-
|50 43 XX XX||P C _ _||PaulC; Town names, various mini GRFs
|-
|53 43 XX XX||S C _ _||SAC; INFRA projects
|-
|54 57 46 XX||T W F _||Timberwolf; Road Vehicles, Tracks, Trains, Stations
|-
|57 42 XX XX||W B _ _||wallyweb; NewObjects, Various features, GRF development
|-
|6D 62 XX XX||m b _ _||Michael Blunck; DBsetXL, NewStations, MariCo
|-
|97 85 XX XX||? ? _ _||OzTrans; Canadian Theme Pack (under development)
|-
|97 87 XX XX||? ? _ _||OzTrans; 2nd generation Canadian graphics
|-
|FB FB XX XX||? ? _ _||FooBar; Dutch sets, Transrapid/metro tracks
|-
|FF XX XX XX||? _ _ _||System reserved
|}

==== Used GRFIDs ====

There are several places that have/show lists of GRFIDs that are definitely in use by someone. Absence of a GRFID in any of these lists is not proof that it is not used though.

* [https://bananas.openttd.org/package/newgrf Bananas] shows the GRFIDs of all currently active NewGRFs that are distributed by the system
* [http://grfcrawler.tt-forums.net/index.php?do=search&mode=advanced GRFCrawler] allows one to search on GRFIDs of NewGRFs in its system

=== Name ===
This short field should contain the name of the set. See [[GRFActionsDetailed#Strings|GRFActionsDetailed]] for instructions to generate the necessary byte codes, and for restrictions on what characters you may use.
The name must be short because it should fit on one line of the GRF Status window ([[ttwiki:GRFStatusWindow|TTDPatch]], [[ottdwiki:NewGRF|OpenTTD]]).

=== Description ===
This is a longer description of the set. Typically it contains the name of the author and a copyright notice or other attribution. See [[GRFActionsDetailed#Strings|GRFActionsDetailed]] for instructions to generate the necessary byte codes, and for restrictions on what characters you may use.
The description may be quite long, but should be short enough to fit in the description part of the GRF Status window ([[ttwiki:GRFStatusWindow|TTDPatch]], [[ottdwiki:NewGRF|OpenTTD]]), or a part of it may be cut off.

== Example ==

Below is an example of what a real Action 8 pseudo-sprite could look like.

1 * 43 '''08''' 07 "TW" 01 06 "Tutorial Example" 00 "Changes nothing. Author: A kind person" 00

Let's clarify it bit by bit. In order to understand what the bits say you could use a hexadecimal editor.

{| |-
!'''Byte'''!!'''Meaning'''
|-
|1||<sprite-number>
|-
|43||<length> of the action in bytes; start counting at 08 (<action>)
|-
|08||<action>: sets this pseudo-sprite to function as action 8
|-
|07||<version>: GRF format version 7 (this is the version of the used GRF format, not of your GRF)
|-
|54 57 01 06||<-grf-id>: ASCII code for TW, then the numbers 1 and 6 to indicate version 6 of TW's first set
|-
|"Tutorial..." 00||<name>: Name of the NewGRF
|-
|"Changes..." 00||<description>: Description of the NewGRF
|}

TracktypeLabels

2024-03-23T21:31:58Z

George: /* Non-standard railtype labels */

== 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
|}

==== 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?)
|}

TracktypeLabels

2020-08-25T15:29:26Z

George: Added ERa0

== 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 Rail Type 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. It is strongly encouraged to follow this scheme in train and track NewGRFs.

See [[Standardized Railtype Scheme]].

== Non-standard railtype labels ==

The following labels were defined before the adoption of the Standardized Rail Type Scheme. They should no longer be used nor supported, and recent versions of the respective NewGRFs generally have dropped them.

{| class="wikitable"
|-
!'''Label'''
!'''Rail Type'''
!'''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
|-
|NAAN
|Narrow gauge, unelectrified
|French Set Rails
|-
|NAAE
|Narrow gauge, catenary powered
|French Set Rails
|-
|NAA3
|Narrow gauge, third-rail powered
|French Set Rails
|-
|NRAN
|Narrow gauge, unelectrified, rack rail
|French Set Rails
|-
|NRAE
|Narrow gauge, catenary powered, rack rail
|French Set Rails
|-
|NBAN
|Narrow gauge, unelectrified, high speed
|French Set Rails
|-
|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
|-
|WGWY
|Wagonway
|Early Rails set
|-
|LIHT
|Light Rails
|Early Rails set
|-
|TYTX
|ToyTrax
|ToyTrax
|-
|ELTX
|ElecTrax
|ToyTrax
|}

TracktypeLabels

2020-08-07T21:54:27Z

George: Added more DC 1,5 KV and AC 15 kV

== 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 Rail Type 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. It is strongly encouraged to follow this scheme in train and track NewGRFs.

See [[Standardized Railtype Scheme]].

== Non-standard railtype labels ==

The following labels were defined before the adoption of the Standardized Rail Type Scheme. They should no longer be used nor supported, and recent versions of the respective NewGRFs generally have dropped them.

{| class="wikitable"
|-
!'''Label'''
!'''Rail Type'''
!'''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
|-
|NAAN
|Narrow gauge, unelectrified
|French Set Rails
|-
|NAAE
|Narrow gauge, catenary powered
|French Set Rails
|-
|NAA3
|Narrow gauge, third-rail powered
|French Set Rails
|-
|NRAN
|Narrow gauge, unelectrified, rack rail
|French Set Rails
|-
|NRAE
|Narrow gauge, catenary powered, rack rail
|French Set Rails
|-
|NBAN
|Narrow gauge, unelectrified, high speed
|French Set Rails
|-
|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
|-
|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
|-
|WGWY
|Wagonway
|Early Rails set
|-
|LIHT
|Light Rails
|Early Rails set
|-
|TYTX
|ToyTrax
|ToyTrax
|-
|ELTX
|ElecTrax
|ToyTrax
|}

TracktypeLabels

2020-08-02T11:44:44Z

George: Added DC 1,5/3 KV

TracktypeLabels

2020-08-02T11:43:04Z

George: Undo revision 4048 by George (talk)

TracktypeLabels

2020-08-02T11:41:43Z

George: Added DC 1,5/3 KV

TracktypeLabels

2020-07-31T13:36:46Z

George: Added DC 1,5 KV to ER2S

TracktypeLabels

2020-07-31T13:34:57Z

George: Added DC 1,5 KV

TracktypeLabels

2017-02-01T00:03:27Z

George: /* Railtype labels defined outside the standardized scheme */

This page lists existing railtype labels.

== Standardized railtype scheme ==
Several members of the TT-Forums came up with a railtype 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. It is not mandatory to follow this scheme.

See [[Standardized Railtype Scheme]].

== Railtype labels defined outside the standardized scheme ==

The following railtype labels have been defined so far:

{| class="wikitable"
|-
!'''Label'''
!'''Rail Type'''
!'''Notes'''
|-
| align="center" colspan="3" | OpenTTD Default Railtypes
|-
|RAIL
|Normal rail
|
|-
|ELRL
|electrified rail
|
|-
|MONO
|Monorail tracks
|
|-
|MGLV
|Maglev tracks
|
|-
| align="center" colspan="3" | New Railtypes
|-
|_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
|-
|NAAN
|Narrow gauge, unelectrified
|French Set Rails
|-
|NAAE
|Narrow gauge, catenary powered
|French Set Rails
|-
|NAA3
|Narrow gauge, third-rail powered
|French Set Rails
|-
|NRAN
|Narrow gauge, unelectrified, rack rail
|French Set Rails
|-
|NRAE
|Narrow gauge, catenary powered, rack rail
|French Set Rails
|-
|NBAN
|Narrow gauge, unelectrified, high speed
|French Set Rails
|-
|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
|-
|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
|-
|ER2S
|Broad (1520 mm) gauge tracks with AC/DC catenary 25kV/3kV. Speed limit 120 km/h
|xUSSR train set
|}

CargoTypes

2011-08-19T14:51:43Z

George: ECS would support BDMT (Building Materials)

'''Cargo types in TTD'''

Definitions of cargo types used in TTD and the Patch

For setting the various action 0 properties of vehicles, various way of specifying the cargo type are used. Typically, there is one property that sets the default cargo type, and another property that sets the cargo types available for refitting in a bit mask.

The following table lists the values to use for these properties, as well as the values to use for [[Action3|action 3]].

{| class="wikitable
|-
! Column
! Name
! Usage
|-
| Type A
| Cargo bit
| Use this cargo type in action 3. When using a [[Action0GeneralVariables#Cargo translation table 09|cargo translation table]], this is the

position in the translation table. If there is no cargo translation table, the cargo bit is defined by property 08 for new cargos.
|-
| Bit value
|
| Add these bit values to find the value to give the refit mask property (this is -+1 << cargobit+-)
|-
| Type B
| Cargo slot
| Use this cargo type to set the default cargo type of vehicles (note, this is climate dependent!). For new cargos this is the ID used in Action 0 and Action 3 of the cargo-defining NewGRF.
|}

Note, when New Cargos are being used, you can only rely on Type A values when using a cargo translation table. Type B values depend on the actual NewGRF (and its version) defining the new cargos; so, unless you test for a specific (industry) NewGRF you cannot rely on any value for Type B.

That means, to be compatible to any new cargos, you have to set the default cargo of refittable vehicles to "first refittable". However, you can kind of rely on passengers being slot 0 and mail being slot 2.

{| class="wikitable
|-
! Type A
! Bit Value
! Type B
! Cargo
! style="background: #FFA020; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
! style="background: #0000C0; color: white" | Type B
! style="background: #0CDDA0; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|-
| 00
| 1
| 00
| Passengers
| +
| 00
| +
|-
| 01
| 2
| 01
| Coal
| +
| 01
| +
|-
| 02
| 4
| 02
| Mail
| +
| 02
| +
|-
| 03
| 8
| 03
| Oil
| +
| 03
| +
|-
| 04
| 10
| 04
| Livestock
| +
| 04
| +
|-
| 05
| 20
| 05
| Goods
| +
| 05
| +
|-
| 06
| 40
| 06
| Grain/Wheat/Maize
| +
| 06
| +
|-
| 07
| 80
| 07
| Wood
| +
| 07
| +
|-
| 08
| 100
| 08
| Iron Ore
| +
| 08
| +
|-
| 09
| 200
| 09
| Steel
| +
| 09
| + (Metal)
|-
| 0A
| 400
| 0A
| Valuables/Gold/Diamonds
| +
| 0A
| Milk
|-
| 0B
| 800
| 09
| Paper
| Food
| 0B
| Food
|-
| 0C
| 1000
| 0B
| Food
| Paper
| 0C
| Raw Sugar
|-
| 0D
| 2000
| 04
| Fruit
| +
| 0D
| Fruit and Vegetables
|-
| 0E
| 4000
| 08
| Copper Ore
| Fish
| 0E
| Fish
|-
| 0F
| 8000
| 09
| Water
| Wool
| 0F
| Wool
|-
| 10
| 10000
| 01
| Rubber
| Potash
| 10
| Clay
|-
| 11
| 20000
| 01
| Sugar
| Sand
| 11
| Sand
|-
| 12
| 40000
| 03
| Toys
| Glass/Ceramics
| 12
| Manufacturing Supplies
|-
| 13
| 80000
| 04
| Batteries
| Wood products
| 13
| Lumber
|-
| 14
| 100000
| 05
| Candy (Sweets)
| Dyes
| 14
| Scrap Metal
|-
| 15
| 200000
| 06
| Toffee
| Fertiliser
| 15
| Farm Supplies
|-
| 16
| 400000
| 07
| Cola
| Oil seeds
| 16
| Plant Fibres
|-
| 17
| 800000
| 08
| Cotton Candy (Candyfloss)
| Refined products
| 17
| Chemicals
|-
| 18
| 1000000
| 09
| Bubbles
| Vehicles
| 18
| Engineering Supplies
|-
| 19
| 2000000
| 0A
| Plastic
| Petrol
| 19
| Petrol
|-
| 1A
| 4000000
| 0B
| Fizzy Drinks
| Bricks
| 1A
| Gravel
|-
| 1B
| 8000000
| 0B
| Paper<ref name="moreindustries">Only in temperate climate, with the "moreindustriesperclimate" switch, i.e. disabled when "newcargos" is switched on.</ref>
| Sulphur
| 1B
| Bauxite
|-
| 1C
| 10000000
| 08
| undefined; unused slot in arctic climate
| Cement
| 1C
| Building Materials
|-
| 1D
| 20000000
| -
| undefined; unused slot
| Fibre crops
| 1D
| Alcohol
|-
| 1E
| 40000000
| -
| undefined; unused slot
| Lime stone
| 1E
| Reserved1
|-
| 1F
| 80000000
| -
| undefined; unused slot
| Tourists
| 1F
| Reserved2
|-
| n/a
| n/a
| FF
| colspan="4" | Use first <ref name="firstrefittable">"first" means first wrt. cargo slot, type B. I.e. this is purely up to the cargo-defining NewGRF and cannot be influenced by the vehicle NewGRF.</ref> refittable cargo type as default cargo. See also [[VehicleRefitting|vehicle refitting]].
|-
| FE
| n/a
| n/a
| colspan="4" | Used in action 3 for stations to disable default
|-
| FF
| n/a
| n/a
| colspan="4" | Shown in purchase list
|}

<references />

== Cargo Labels ==

The following cargo labels have been defined so far:

{| class="wikitable
|-
! Label
! Cargo Description
! [[Action0Cargos#Cargo classes 16|Cargo classes]]
! colspan="3" | Notes
|-
| align="center" colspan="6" | '''TTD Default Cargos'''
|-
| PASS
| Passengers
| 0001 Passengers
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| COAL
| Coal
| 0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| MAIL
| Mail
| 0002 Mail
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
|OIL_
| Oil
| 0040 Liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| GOOD
| Goods
| 0004 Express
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| GRAI
| Grain
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
| Temperate; see also WHEA, MAIZ, CERE
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
| Renamed "Metal" in FIRS.
|-
| VALU
| Valuables
| 0008 Armoured
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
| Temperate; see also GOLD, DIAM
|-
| PAPR
| Paper
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| WHEA
| Wheat
| 0010 Bulk
|
|
| Arctic; see also GRAI, MAIZ, CERE
|-
| FOOD
| Food
| 0084 Express, refrigerated
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| GOLD
| Gold
| 0008 Armoured
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
| Arctic; see also VALU, DIAM
|-
| RUBR
|Rubber
|0040 Liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| MAIZ
| Maize
| 0010 Bulk
|
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
| Tropic; see also VALU, GOLD
|-
| SUGR
| Sugar
| 0010 Bulk
|
|
|
|-
| TOYS
| Toys
| 0020 Piece goods
|
|
|
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
|
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
|
|-
| TOFF
|Toffee
|0010 Bulk
|
|
|
|-
| COLA
|Cola
|0040 Liquid
|
|
|
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
|
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
|
|-
| PLST
|Plastic
|0040 Liquid
|
|
|Toyland; see also PLAS
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
|
|-
| align="center" colspan="6" | '''NewCargos'''
|-
| AORE
|Bauxite (Aluminium ore)
|0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| BEER
|Alcohol
|0064 Express, piece goods, liquids
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| BDMT
|Building Materials
|0220 Piece goods, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| CERA
|Ceramics
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| CERE
|Cereals
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|<ref name="ecs_cargo_change" />
|-
| CARB
|Carbon Brick
|0010 Bulk
|
|
|
|-
| CLAY
|Clay
|0210 Bulk covered/sheltered
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| CMNT
|Cement
| 0210 Bulk covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| COPR
|Copper
|0020 Piece goods
|
|
|
|-
| DURA
|Depleted Uranium
|0100 Hazardous
|
|
|
|-
| DYES
|Dyes
| 0060 Piece goods, liquids
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| ENSP
|Engineering Supplies
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| FERT
|Fertiliser
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|<ref name="ecs_cargo_change" />
|-
| FICR
|Fibre crops
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| FISH
|Fish
| 0084 Express, refrigerated
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| FMSP
|Farm Supplies
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| FUEL
|Fuel
|0040 Liquid
|
|
|Use PETR for refined-oil fuel
|-
| GEAR
|Locomotive regearing
|8000 Special
|
|
|
|-
| GLAS
|Glass
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| GRVL
|Gravel / Ballast
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| MATE
|Materials
|0020 Piece goods
|
|
|
|-
| MILK
|Milk
|00C4 Express, liquid, refrigerated
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| MNSP
|Manufacturing Supplies
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| OLSD
|Oil seed
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|<ref name="ecs_cargo_change" />
|-
| OXYG
|Oxygen
|0040 Liquid
|
|
|
|-
| PETR
|Petrol / Fuel Oil
| 0040 Liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| POTA
|Potash
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|<ref name="ecs_cargo_change" />
|-
| RCYC
|Recyclables
|0220 Piece Goods, covered
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| RCKT
|Rockets
|0000 None
|
|
|
|-
| RFPR
|Refined products
| 0040 Liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| RSGR
|Raw Sugar
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
| Sugar cane in tropic, sugar beet in other climates
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| SCRP
|Scrap Metal
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| SILI
|Silicate
|0010 Bulk
|
|
|
|-
| SULP
|Sulphur
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|<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" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| TWOD
|Tropic Wood
|0020 Piece goods
|
|
|
|-
| UORE
|Uranium Ore
|0110 Hazardous, Bulk
|
|
|
|-
| URAN
|Uranium
|0100 Hazardous
|
|
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| WATT
|Electricity
|0000 None
|
|
|
|-
| WDPR
|Wood Products
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| WOOL
|Wool
| 0220 Piece goods, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|<ref name="ecs_cargo_change" />
|-
| WSTE
|Waste
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|}

<references />

CargoTypes

2011-08-18T07:55:57Z

George: ECS would support Bauxite (Aluminium ore)

'''Cargo types in TTD'''

Definitions of cargo types used in TTD and the Patch

For setting the various action 0 properties of vehicles, various way of specifying the cargo type are used. Typically, there is one property that sets the default cargo type, and another property that sets the cargo types available for refitting in a bit mask.

The following table lists the values to use for these properties, as well as the values to use for [[Action3|action 3]].

{| class="wikitable
|-
! Column
! Name
! Usage
|-
| Type A
| Cargo bit
| Use this cargo type in action 3. When using a [[Action0GeneralVariables#Cargo translation table 09|cargo translation table]], this is the

position in the translation table. If there is no cargo translation table, the cargo bit is defined by property 08 for new cargos.
|-
| Bit value
|
| Add these bit values to find the value to give the refit mask property (this is -+1 << cargobit+-)
|-
| Type B
| Cargo slot
| Use this cargo type to set the default cargo type of vehicles (note, this is climate dependent!). For new cargos this is the ID used in Action 0 and Action 3 of the cargo-defining NewGRF.
|}

Note, when New Cargos are being used, you can only rely on Type A values when using a cargo translation table. Type B values depend on the actual NewGRF (and its version) defining the new cargos; so, unless you test for a specific (industry) NewGRF you cannot rely on any value for Type B.

That means, to be compatible to any new cargos, you have to set the default cargo of refittable vehicles to "first refittable". However, you can kind of rely on passengers being slot 0 and mail being slot 2.

{| class="wikitable
|-
! Type A
! Bit Value
! Type B
! Cargo
! style="background: #FFA020; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
! style="background: #0000C0; color: white" | Type B
! style="background: #0CDDA0; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|-
| 00
| 1
| 00
| Passengers
| +
| 00
| +
|-
| 01
| 2
| 01
| Coal
| +
| 01
| +
|-
| 02
| 4
| 02
| Mail
| +
| 02
| +
|-
| 03
| 8
| 03
| Oil
| +
| 03
| +
|-
| 04
| 10
| 04
| Livestock
| +
| 04
| +
|-
| 05
| 20
| 05
| Goods
| +
| 05
| +
|-
| 06
| 40
| 06
| Grain/Wheat/Maize
| +
| 06
| +
|-
| 07
| 80
| 07
| Wood
| +
| 07
| +
|-
| 08
| 100
| 08
| Iron Ore
| +
| 08
| +
|-
| 09
| 200
| 09
| Steel
| +
| 09
| + (Metal)
|-
| 0A
| 400
| 0A
| Valuables/Gold/Diamonds
| +
| 0A
| Milk
|-
| 0B
| 800
| 09
| Paper
| Food
| 0B
| Food
|-
| 0C
| 1000
| 0B
| Food
| Paper
| 0C
| Raw Sugar
|-
| 0D
| 2000
| 04
| Fruit
| +
| 0D
| Fruit and Vegetables
|-
| 0E
| 4000
| 08
| Copper Ore
| Fish
| 0E
| Fish
|-
| 0F
| 8000
| 09
| Water
| Wool
| 0F
| Wool
|-
| 10
| 10000
| 01
| Rubber
| Potash
| 10
| Clay
|-
| 11
| 20000
| 01
| Sugar
| Sand
| 11
| Sand
|-
| 12
| 40000
| 03
| Toys
| Glass/Ceramics
| 12
| Manufacturing Supplies
|-
| 13
| 80000
| 04
| Batteries
| Wood products
| 13
| Lumber
|-
| 14
| 100000
| 05
| Candy (Sweets)
| Dyes
| 14
| Scrap Metal
|-
| 15
| 200000
| 06
| Toffee
| Fertiliser
| 15
| Farm Supplies
|-
| 16
| 400000
| 07
| Cola
| Oil seeds
| 16
| Plant Fibres
|-
| 17
| 800000
| 08
| Cotton Candy (Candyfloss)
| Refined products
| 17
| Chemicals
|-
| 18
| 1000000
| 09
| Bubbles
| Vehicles
| 18
| Engineering Supplies
|-
| 19
| 2000000
| 0A
| Plastic
| Petrol
| 19
| Petrol
|-
| 1A
| 4000000
| 0B
| Fizzy Drinks
| Bricks
| 1A
| Gravel
|-
| 1B
| 8000000
| 0B
| Paper<ref name="moreindustries">Only in temperate climate, with the "moreindustriesperclimate" switch, i.e. disabled when "newcargos" is switched on.</ref>
| Sulphur
| 1B
| Bauxite
|-
| 1C
| 10000000
| 08
| undefined; unused slot in arctic climate
| Cement
| 1C
| Building Materials
|-
| 1D
| 20000000
| -
| undefined; unused slot
| Fibre crops
| 1D
| Alcohol
|-
| 1E
| 40000000
| -
| undefined; unused slot
| Lime stone
| 1E
| Reserved1
|-
| 1F
| 80000000
| -
| undefined; unused slot
| Tourists
| 1F
| Reserved2
|-
| n/a
| n/a
| FF
| colspan="4" | Use first <ref name="firstrefittable">"first" means first wrt. cargo slot, type B. I.e. this is purely up to the cargo-defining NewGRF and cannot be influenced by the vehicle NewGRF.</ref> refittable cargo type as default cargo. See also [[VehicleRefitting|vehicle refitting]].
|-
| FE
| n/a
| n/a
| colspan="4" | Used in action 3 for stations to disable default
|-
| FF
| n/a
| n/a
| colspan="4" | Shown in purchase list
|}

<references />

== Cargo Labels ==

The following cargo labels have been defined so far:

{| class="wikitable
|-
! Label
! Cargo Description
! [[Action0Cargos#Cargo classes 16|Cargo classes]]
! colspan="3" | Notes
|-
| align="center" colspan="6" | '''TTD Default Cargos'''
|-
| PASS
| Passengers
| 0001 Passengers
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| COAL
| Coal
| 0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| MAIL
| Mail
| 0002 Mail
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
|OIL_
| Oil
| 0040 Liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| GOOD
| Goods
| 0004 Express
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| GRAI
| Grain
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
| Temperate; see also WHEA, MAIZ, CERE
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
| Renamed "Metal" in FIRS.
|-
| VALU
| Valuables
| 0008 Armoured
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
| Temperate; see also GOLD, DIAM
|-
| PAPR
| Paper
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| WHEA
| Wheat
| 0010 Bulk
|
|
| Arctic; see also GRAI, MAIZ, CERE
|-
| FOOD
| Food
| 0084 Express, refrigerated
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| GOLD
| Gold
| 0008 Armoured
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
| Arctic; see also VALU, DIAM
|-
| RUBR
|Rubber
|0040 Liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| MAIZ
| Maize
| 0010 Bulk
|
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
| Tropic; see also VALU, GOLD
|-
| SUGR
| Sugar
| 0010 Bulk
|
|
|
|-
| TOYS
| Toys
| 0020 Piece goods
|
|
|
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
|
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
|
|-
| TOFF
|Toffee
|0010 Bulk
|
|
|
|-
| COLA
|Cola
|0040 Liquid
|
|
|
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
|
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
|
|-
| PLST
|Plastic
|0040 Liquid
|
|
|Toyland; see also PLAS
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
|
|-
| align="center" colspan="6" | '''NewCargos'''
|-
| AORE
|Bauxite (Aluminium ore)
|0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| BEER
|Alcohol
|0064 Express, piece goods, liquids
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| BDMT
|Building Materials
|0220 Piece goods, covered/sheltered
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| CERA
|Ceramics
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| CERE
|Cereals
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|<ref name="ecs_cargo_change" />
|-
| CARB
|Carbon Brick
|0010 Bulk
|
|
|
|-
| CLAY
|Clay
|0210 Bulk covered/sheltered
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| CMNT
|Cement
| 0210 Bulk covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| COPR
|Copper
|0020 Piece goods
|
|
|
|-
| DURA
|Depleted Uranium
|0100 Hazardous
|
|
|
|-
| DYES
|Dyes
| 0060 Piece goods, liquids
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| ENSP
|Engineering Supplies
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| FERT
|Fertiliser
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|<ref name="ecs_cargo_change" />
|-
| FICR
|Fibre crops
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| FISH
|Fish
| 0084 Express, refrigerated
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| FMSP
|Farm Supplies
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| FUEL
|Fuel
|0040 Liquid
|
|
|Use PETR for refined-oil fuel
|-
| GEAR
|Locomotive regearing
|8000 Special
|
|
|
|-
| GLAS
|Glass
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| GRVL
|Gravel / Ballast
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| MATE
|Materials
|0020 Piece goods
|
|
|
|-
| MILK
|Milk
|00C4 Express, liquid, refrigerated
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| MNSP
|Manufacturing Supplies
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| OLSD
|Oil seed
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|<ref name="ecs_cargo_change" />
|-
| OXYG
|Oxygen
|0040 Liquid
|
|
|
|-
| PETR
|Petrol / Fuel Oil
| 0040 Liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| POTA
|Potash
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|<ref name="ecs_cargo_change" />
|-
| RCYC
|Recyclables
|0220 Piece Goods, covered
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| RCKT
|Rockets
|0000 None
|
|
|
|-
| RFPR
|Refined products
| 0040 Liquid
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| RSGR
|Raw Sugar
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
| Sugar cane in tropic, sugar beet in other climates
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| SCRP
|Scrap Metal
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| SILI
|Silicate
|0010 Bulk
|
|
|
|-
| SULP
|Sulphur
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|<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" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| TWOD
|Tropic Wood
|0020 Piece goods
|
|
|
|-
| UORE
|Uranium Ore
|0110 Hazardous, Bulk
|
|
|
|-
| URAN
|Uranium
|0100 Hazardous
|
|
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
|
|
|-
| WATT
|Electricity
|0000 None
|
|
|
|-
| WDPR
|Wood Products
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|-
| WOOL
|Wool
| 0220 Piece goods, covered/sheltered
| style="background: #FFCC00; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|<ref name="ecs_cargo_change" />
|-
| WSTE
|Waste
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|
|}

<references />

PalettesAndCoordinates

2011-06-17T09:28:02Z

George: fixed layout

==Palettes==

Since TTD is a palette-based game, you have to be careful that the graphics program you use can deal with that properly. Also, TTD uses some palette entries for palette cycling to do some colour-animation, don't use these as regular colours. These entries are often called "action colours".

Below is an explanation by Oskar Eisemuth of the various colour ranges in the DOS and Windows palettes. Both palettes work similarly, but some of the colours are in different places. If unsure which palette to use, use the DOS palette as it contains a handful of additional colours over the windows palette.

[[File:windowspal.png]]
[[File:dospal.png]]

Info on the image: The colors you '''can use normally''' are marked in '''green'''. The colors which '''have special purposes/are color cycles''' are marked '''yellow'''. '''Don't use''' the '''red''' marked colors.

The colours in the "company" range are often (but not always) changed to the current player colours. In some instances, they may be changed to colours specified by the .grf file, or random colours, or not changed at all.

Here is a list, provided by [[George]], of the shades of player colours that will be used:

[[File:playercolours.png]]

The "Company 2" range is normally not a special colour range, but since TTDPatch 2.0.1 alpha 67 it is possible to activate it as a second company colour for vehicles and town houses.

The palette cycling ranges listed are the water cycle (used for the blinking dots in the water), the block cycle, fire cycle, exchange red (better called crossing red; used for the flashing crossing lights), and the yellow cycle (used for lights in the runway of the large airport).

The following table presents more detailed info on differences between DOS and Windows colours and colour indices:

[[File:TTD_Palettes.png]]

== Coordinates ==

TTD internally uses a 3D engine, which then uses an isometric projection to display graphics on a 2D screen. The 3D engine uses so-called "bounding boxes" for each sprite, which are then sorted by the sprite sorter to get drawn in (what it thinks is) the right order.

To get a certain sprite drawn at the right place, it needs to have a proper bounding box (which is provided by the game for the most part), and the correct 2D offsets, here called "xofs" and "yofs" (see [[RealSprites]] for more information). The following picture by Oskar Eisemuth should help in figuring out how the 3D and 2D coordinates relate to each other:

[[File:coordinates3d.png]]

For 3D coordinates, X goes from top right to bottom left, Y goes from top left to bottom right, and Z (height) from down to up. For 2D coordinates, X goes from left to right, and Y from top to bottom. Usually, the top side of the screen is referred to as "north", and thus "east", "south" and "west" are the right, bottom and left side of the screen.

For vehicles, the center of the bounding box (shown with a red dot in the yellow boxframe) is the reference point from which the xofs and yofs are counted. This means that in most cases, xofs and yofs need to be negative to get the sprite to fit on the box. Normally, as indicated above, this means xofs is approximately the negative value of half the sprite width, and yofs is approximately the negative value of half the sprite height.

ReadingPatchVariables

2009-12-20T19:50:47Z

George:

=Reading Patch variables=

-=Introduction=-

Since 2.0.1 alpha 48, it has been possible to use action D to read various special Patch variables. These are usually switch values, but there are also a few other useful values.

-=Format=-

<pre> -+<Sprite-number> * <Length> 0D <target> <operation> <variable> FE FF FF 00 00+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

0D|B|Defines action 0D

<target>|B|Target parameter

<operation>|B|As for ActionD, but only assignment is valid.

<variable>|B|Patch variable number to read. See below.

FE|B|Defines a special variable access

FF FF 00 00|D|Indicates that a patch variable is being read||

==variable==

The following patch variables are defined:

||variable|Switch|Value

00|miscmods/-Yo|Bit switch

01|experimentalfeatures/-XF|Bit switch

02|morevehicles/-x|Vehicle array multiplier

03|mountains&curves;/-mc|Two bytes with four sets of two bits

04|planecrashcontrol/-Xc|Bit switch

05|autorenew/-Xa|Signed value

06|multihead/-M|Speed increase, in percent

07|disasters/-XD|Bit switch

08|unifiedmaglev/-XM|Unified maglev mode

09|bridgespeedlimits/-XX|Speed fraction, in percent

0A|---|TTD Language, see the "new scheme" for [[Action4#language_id|action 4]]

0B|startyear/-XY|Year-1920

0C|morebuildoptions/-YB|Bit switch

0D|moresteam/-YM|value=LF (two hex digits), L=length, F=frequency

0E|freighttrains/-Yf|weight factor

0F|wagonspeedlimits/-YL|Speed increase for empty wagons

10|planespeed/-YP|speed factor

11|dual company colors|2CC colormap base sprite (since r1404)

12|miscmods2/-Zm|Bit switch (since r1738)

13|map size information|Bit switch Format = -MABXYSS (since r11961 and r1817)

| | M  : the type of map

| |bit 0 set : squared map. Clear : rectangular map

| |bit 1 set   : Y is the bigger edge(bit 0 is clear).Clear : X is the bigger edge.

| |A  : minimum edge(log2) of the map

| |B  : maximum edge(log2) of the map

| |XY : edges(log2) of each side of the map.

| |SS : combination of both X and Y, thus giving the size(log2) of the map

| |All map sizes will be substracted by 6, as to keep the size 64 the smallest one, thus zero based

14|---|-Reserved- for day length data, format would be defined later. Not supported yet||

If experimentalfeatures, miscmods, or miscmods2 are off, the corresponding value will be zero. For all other switches, the value is unspecified if the switch is off, so [[TTDPatchFlags|action 7 variable 85]] should be checked first.

TTDPatchFlags

2009-12-20T19:31:17Z

George:

'''''TTDPatch Flags for Action 7/9 Variable 85'''''

=TTDPatch Flags for Action 7/9 Variable 85=

Additional Information

In the table below you find all the TTDPatch flags that belong to <-+Param-num+-> = 85 in Action 7 & Action 9.

||'''Bit'''|'''Switch (bit set = switch on)'''

0C|keepsmallairport

0D|newairports

0E|largestations

0F|longbridges

10|loadtime

12|presignals

13|extpresignals

16|enginespersist

1B|multihead

1D|lowmemory

1E|generalfixes

27|moreairports

28|mammothtrains

29|trainrefit

2B|subsidiaries

2C|gradualloading

32|(Set to bit 0 of unifiedmaglev mode)

33|(Set to bit 1 of unifiedmaglev mode)

34|bridgespeedlimits

36|eternalgame

37|newtrains

38|newrvs

39|newships

3A|newplanes

3B|signalsontrafficside

3C|electrifiedrailway

41 *|loadallgraphics

43|semaphores

4B|enhancegui

4C|newagerating

4D|buildonslopes

4E|fullloadany

4F|planespeed

50 *|moreindustriesperclimate

51|moretoylandfeatures

52|newstations

53|tracktypecostdiff

54|manualconvert

55|buildoncoasts

56|canals

57|newstartyear

58|freighttrains

59|newhouses

5A|newbridges

5B|newtownnames

5C|moreanimation

5D|wagonspeedlimits

5E|newshistory

5F|custombridgeheads

60|newcargodistribution

61|windowsnap

62|townbuildnoroads

63|pathbasedsignalling

64|aichoosechances

65|resolutionwidth

66|resolutionheight

67|newindustries

68|fifoloading

69|townroadbranchprob

6A|tempsnowline

6B|newcargos

6C|enhancemultiplayer

6D|onewayroads

6E|irregularstations

6F|morestatistics

70|newsounds

71|autoreplace

72|autoslope

73|followvehicle

74|trams

75|enhancetunnels

76|shortrvs

77|articulatedrvs

78|dynamicengines (OpenTTD, since r12924)

79|-Reserved- for day length patch

7E|variablerunningcosts (since r1421)

7F|set if any switches are on||

<nowiki><nowiki>* loadallgraphics is obsolete (and its bit unused) since revision 401. The next official versions were the 5/Jun/2006 nightly (402) and 2.5 beta 6 (472)</nowiki></nowiki>

<nowiki><nowiki><nowiki>*</nowiki> moreindustriesperclimate is obsolete (and its bit unused) since 2.5 beta 2.</nowiki></nowiki>

VariationalAction2

2009-12-20T18:56:27Z

George:

'''''Variational Action 2'''''

=Variational Action 2=

Defining a choice between several action 2 entries

-=Introduction=-

To support changes in graphics based on other factors than just the load states, you use a variational action 2. This provides a sophisticated way of deciding what graphics to use.

A variational action 2 can be used like any other action 2, but it provides an additional step in-between: instead of defining the action 1 sets right away, it instead specifies a list of additional action 2 entry, one of which is used depending on the kind of variation that is defined. These action 2 entries that are referred can in turn be variational or random (to provide chains of decisions), or they can be the final element, that is a regular action 2 which contains definitions of action 1 sets, or a callback result.

-=Format=-

The data looks as follows:

<pre> -+<Sprite-number> * <Length> 02 <feature> <set-id> <type> <variable> <varadjust> <nvar> (<set-id> <low-range> <high-range>){n} <default>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

<Sprite-number>|dec|A sequential sprite number

<length>|dec|The total number of bytes used in this action.

02|B|Defines action 02

<feature>|B|For what type of vehicle/station should this definition be used?

<set-id>|B|The ID of this action 2 (used like a cargo ID)

<type>|B|Type of variational action 2, see below

<variable>|B|Which variable we base the decision on

<varadjust>|V|How to manipulate the value before deciding.

<nvar>|B|Number of different ranges of the value (not counting the default)

<set-id>|W|Action 2 set-id to use for the following range.

<low-range>|B/W/D|Minimum (inclusive) of the range for which to use the above set-id

<high-range>|B/W/D|Maximum (inclusive) of the range

<default>|W|Action 2 set-id to use if no range matches||

You repeat the sequence of <set-id> <low-range> <high-range> as often as <nvar> specifies.

<low-range> and <high-range> have a size of B, W, or D, depending on <type>. See that entry for more information.

-=Filling in the terms=-

===Sprite-number===

This is just the number you are at.

===Length===

Count the number of bytes in this action.

===feature===

This sets the type of feature that you wish to change. Set it to:

00 for trains

01 for road vehicles

02 for ships

03 for planes

04 for stations

05 for canals

06 for bridges

07 for houses

09 for industry tiles

0A for industries

0B for cargos

0E for signals

0F for objects

===Set-ID===

This defines the number of this action 2.  The ID can then be used as target in an action 3 or another variational/random action 2.

===type===

The access type specifies both the size of the variable access, and selects between general variables and the object's innate variables, or variables of a specific "related" object.

Use 81/85/89 to decide upon a general variable, or a variable of the object in question.

Use 82/86/8A to refer to the "related" object:

||Feature|Related object

Vehicles (00-03)|First vehicle of consist

Stations (04)|Town to which station belongs

Canals (05)|N/A

Bridges (06)|Town of bridge

Houses (07)|Town of building

Generic (08)|(no action 2 support)

Industry tiles (09)|Industry containing tile

Industries (0A)|Town to which industry belongs

Cargos (0B)|N/A

Sounds (0C)|(no action 2 support)

Airports (0D)|Town of airport

Signals (0E)|N/A

Objects (0F)|N/A||

This number also tells what size the checked variable is:

For 81/82, the lowest byte of the value is accessed

For 85/86, the lowest word is accessed

For 89/8A, the lowest doubleword is accessed.

If the accessed variable is smaller than the size given here, the extra bits may contain junk, and should probably be <and-masked> out.

On this page, the size B/W/D means the field is byte-sized for types 81 and 82, word-sized for types 85 and 86, and doubleword-sized for types 89 and 8A.

===Variable===

Which variable to use for this decision. The following variables are always available:

||'''Number'''|[[GRFActionsDetailed|'''Size''']]|'''Meaning'''

00|W|current date (counted as days from 1920)

01|B|current year (count from 1920, max. 2175 even with eternalgame)

02|B/D|current month (0-11) in bits 0-7; the higher bytes contain unusable junk. Since OTTD r13594 'day of month' (0-30) is stored in bits 8-12, bit 15 is set in leapyears and 'day of year'(0-364 resp. 365) is stored in bits 16-24. All other bits are reserved and should be masked.

03|B|current climate, 0=temp, 1=arctic, 2=trop, 3=toyland

09|W|date fraction, incremented by 0x375 every engine tick

0A|W|animation counter, incremented every tick

0C|W|current [[Callbacks|callback]] ID (feature-specific), set to 00 when not in a callback

10|D|extra callback info 1, as described in the callback specs

11|B|current rail tool type (for station callbacks)

12|B|Game mode, 0 in title screen, 1 in game and 2 in editor

18|D|extra callback info 2, as described in the callback specs

1A|D|always -1 (that is, all bits are set). Useful to create constants (see [[VarAction2Advanced]])

1B|B|display options; bit 0=town names, 1=station names, 2=signs, 3=animation, 4=transparency, 5=full detail

1C|D|result from most recent variational action 2

20|B|snow line height, FFh if snow isn't present at all

23|D|current date; long format, since OpenTTD r13376, 2.6 r2049

24|D|current year; long format, year zero based since OpenTTD r13376, 2.6 r2049

25|D|GrfID of the grf that contains the corresponding Action3. Useful when accessing the "related" object. Currently only supported for vehicles (OpenTTD r15739)

26|D|Reserved for day length data, format would be defined later. Not supported yet

40+x|D|specially calculated feature-specific variable, see following feature-specific pages

5F|D|Feature-specific random data: triggers in low byte, bits in other three bytes. Bits of the variable not associated with random or trigger bits are reserved. (2.5 r1927, 2.6 r1928)

60+x|D|similar to 40+x variables, but the variable number must be followed by a byte, which will be given to the variable handler as parameter.

7C|D|A special 60+x variable that contains persistent data written by [[VarAction2Advanced#operator|operator 10]], for the features that support it. (The list of supported features can be found on that page.) Available since 2.6 r1315. Should not be read if the current feature doesn't support it. If the given slot hasn't been written yet, it contains zero.

7D|D|A special 60+x variable that contains up to 256 values stored by [[VarAction2Advanced#operator|operator 0E]]. Available since 2.6 r1246. Available in the purchase list. These values are undefined unless written by a var2 earlier in the same chain.

7E|D|A special 60+x variable indicating a [[VarAction2Advanced#Using_procedures|procedure call]]. Available in the purchase list.

7F|D|A special 60+x variable that reads GRF parameter whose number is given by the 60+x parameter. Available in the purchase list.

80+x| |feature-specific variable, see following feature-specific pages||

The definition of variable 1B is slightly feature-dependent. For features that can be drawn transparently (stations, bridges, houses, industry tiles and objects) bit 4 is set if the current feature will be drawn normally, and clear if the current feature will be drawn transparently. For these purposes, airports are stations. For all other features, bit 4 is undefined.

For all features, the 80+x variables are offsets into the corresponding structure in TTD's game data.  The 40+x and 60+x variables are special variables that are computed on-the-fly, and aren't actually stored anywhere in memory, unless stated otherwise. Therefore they should be used as little as necessary so as not to slow down the game too much with the calculation of these variables (which can be called thousands of times per second, whenever any vehicle moves).

When displaying a vehicle (etc.) in the purchase list, the game will show those variations based on external variables (dates etc.) correctly, but variations based on vehicle variables (variables 40+x, 60+x and 80+x) will always show the first (not the default) cargo-ID unless otherwise specified for the given variable. If you do a calculation, the first cargo-ID will be selected if any of the needed variables is inaccessible.

The lists of 80+x variables on the following pages are not exhaustive; only the useful variables are listed there. For a full list check the definition of corresponding structures in TTD. Marcin Grzegorczyk has a pretty good list of the structure definitions on his [http://marcin.ttdpatch.net/sv1codec/TTD-locations.html|savegame internals page].

{toc}

===varadjust===

Adjust variable to a more useful range. It has the following format:

<pre> -+ <shift-num> <and-mask> <nowiki><nowiki>[<add-val> <divide-val>/<modulo-val>]</nowiki></nowiki>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

shift-num|B|value to right-shift the variable, and some special bits. See below.

and-mask|B/W/D|value with which to AND the variable after shifting. Return this value if neither bit 6 nor bit 7 of shift-num are set.

add-val|B/W/D|value to add to the variable after ANDing. Only present if bits 6 or 7 are set in shift-num.

divide-val|B/W/D|return the sum divided by this value. Only present if bit 6 is set in shift-num.

modulo-val|B/W/D|return the sum modulo (remainder of division by) this value. Only present if bit 7 is set in shift-num.||

<shift-num> is a partial bit-mask; its bits have the following meanings:

||Bit(s)|value|meaning

0..4|0..1F|number of bits to right shift <variable>

5|20|This is an [[VarAction2Advanced|advanced var.action 2]]

6|40|This is a shift-and-add-divide adjustment.

7|80|This is a shift-and-add-modulo adjustment.||

Bits 6 and 7 may not both be set. If neither are set, this varadjust is a shift-and adjustment.

Note that for the add and divide operations, both the variable and the divisor are taken to be signed numbers. This means that if the high bit is set, the number is taken to be negative, so you may need to mask out the most significant bit to do an unsigned division.

===nvar===

Here you set how many different ranges to check for. If the value of the variable, after the above manipulations, is not within one of these ranges, the default will be used.  When displayed in the purchase window, the game will always show the first range if the variable is of the 40+x or 80+x type (because the variable is undefined since the vehicle doesn't exist yet).

Since 2.0.1 alpha 57, nvar=0 is a special case. Instead of using ranges, nvar=0 means that the result of an [[VarAction2Advanced|advanced]] calculation (or, if no calculation is performed, the adjusted variable value itself) is returned as callback result, with bit 15 set.  This is useful for those callbacks where many different return values are possible and it is easier to calculate them than list them in ranges.  The default value must still be specified, and will be used in case the variable(s) used are not available.

===sets and ranges===

For each of the ranges to check, you give the set-id as a '''WORD''' value (i.e. with a 00 following, e.g. set-id 5 becomes -+05 00+-, or - in case of a callback result - by setting the high bit, e.g. -+05 80+-), followed by the low and high limits of this range.  The first range that matches will be used.

The various \b, \w, and \d escape sequences can be useful for <min-range> and <max-range>. See [[GRFActionsDetailed#Byte_order|the discussion of escape sequences]] for further information.

===default===

The set-id to use if none of the ranges matches.

-=Example=-

<span style='color:#808080'>Something to go here</span>