GRFSpecs - User contributions [en-gb]

TracktypeLabels

2018-05-20T06:57:38Z

PikkaBird: ToyTrax

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
|-
|WGWY
|Wagonway
|Early Rails set
|-
|LIHT
|Light Rails
|Early Rails set
|-
|TYTX
|ToyTrax
|ToyTrax
|-
|ELTX
|ElecTrax
|ToyTrax
|}

TracktypeLabels

2018-05-10T06:46:10Z

PikkaBird: /* Railtype labels defined outside the standardized scheme */ "early rails" set

Action0/Cargos

2014-10-05T03:33:54Z

PikkaBird: /* CargoClasses (16) */ "express" cargo class osm

== Introduction ==

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

== Properties ==

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

== Descriptions ==

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

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

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

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

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

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

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

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

This textID should refer to the cargo type name in the singular. Currently, this ID is used only in subsidy messages ("First Passenger service..." instead of "First Passengers service...", for example)

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

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

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

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

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

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

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

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

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

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

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

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

The income generated from cargo delivery is calculated as:

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

where

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

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

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

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

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

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

=== CargoClasses (16) ===

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

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

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

<references />

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

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

=== Cargo label (17) ===

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

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

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

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

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

<references />

The incoming cargo amount is multiplied by property 19, then divided by 256 before it is added to the town statistics. This allows you to have smaller or bigger impact than original cargoes do. Please note that cargoes accepted by industries affect the closest town as well; for example, if you have an industry that accepts passengers, every passenger brought to the industry affects the town just like if they were transported to the town directly. Usually, it's not a good idea to have industries that process such cargoes; they should be accepted by towns only.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Example ==

NML:Main

2014-08-31T17:24:03Z

PikkaBird: point industry tile links to the correct page

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

;[[NML:Preface |Preface]]
;[[NML:changes 0.3|Changes between NML 0.2 and head / 0.3]]
;[[NML:changes 0.4|Changes between NML 0.3 and head / 0.4]]
;[[NML:Getting started|Getting started]]
;[[NML:Graphic files|Graphics files]]

;[[NML:Block syntax|Language structure and block syntax]]
*[[NML:GRF|GRF]] and its parameters
*[[NML:Item|Item]] (Properties, graphics, livery overrides)

*;Defining sprites:
**[[NML:Realsprites|Realsprites]]
**[[NML:Template|Template]]
**[[NML:Base Graphics|Base Graphics]]
**[[NML:Spriteset|Spriteset]]
**;Replacing sprites:
***[[NML:Replace TTD sprites|Replace TTD sprites]]
***[[NML:Replace new sprites|Replace new sprites]]
***[[NML:Add font glyphs|Add font glyphs]]
***[[NML:Alternative sprites|Alternative sprites]] (32bpp, zoom levels)
**;Aranging and grouping sprites:
***[[NML:Spritegroup|Spritegroup]] (Vehicles)
***[[NML:Spritelayout|Spritelayout]] (Houses, industries, stations, airports, objects)
***[[NML:Recolour sprites|Recolour sprites]]

*;Flow control
**[[NML:Tilelayout|Tilelayout]]
**[[NML:Switch|Switch]]
**[[NML:Produce|Produce]]
**[[NML:Random switch|Random switch]]

*;Global scope
**[[NML:Cargotable|Cargotable]]
**[[NML:Railtypetable|Railtypetable]]
**[[NML:Snow line|Snow line]]
**[[NML:Setting base costs|Setting base costs]]
**[[NML:Parameter assignment|Parameter assignment]]
**[[NML:If|If/else]]
**[[NML:While|While]]

*;Interaction with other grfs
**[[NML:Error|Error]]
**[[NML:Disable items|Disable items]]
**[[NML:Deactivate other NewGRFs|Deactivate other NewGRFs]]
**[[NML:Testing for other NewGRFs|Testing for other NewGRFs]]
**[[NML:Overriding vehicles in other NewGRFs|Overriding vehicles in other NewGRFs]]

*;Misc
**[[NML:Town names|Town names]]
**[[NML:Town names parts|Town names parts]]

;[[NML:Units|Units]]
;[[NML:Expressions|Expressions]]
*[[NML:Elementary values|Elementary values]]
*[[NML:Builtin functions|Builtin functions]]
;[[NML:Language files|Language files]]
;[[NML:Properties and variables and callbacks|Lists of properties, variables and callbacks]]
{|
|[[NML:General|General]] || || [[NML:General#General variables|variables]] ||
|-
|[[NML:Vehicles|Vehicles]] || [[NML:Vehicles#Properties common to all vehicle types|common properties]] || [[NML:Vehicles#Vehicle variables|variables]] || [[NML:Vehicles#Vehicle callbacks|callbacks]]
|-
| || [[NML:Vehicles#Train properties|train properties]] || ||
|-
| || [[NML:Vehicles#Road vehicle properties|road vehicle properties]] || ||
|-
| || [[NML:Vehicles#Ship properties|ship properties]] || ||
|-
| || [[NML:Vehicles#Aircraft properties|aircraft properties]] || ||
|-
|[[NML:Stations|Stations]] || [[NML:Stations#Station properties|properties]] || [[NML:Stations#Station variables|variables]] || [[NML:Stations#Station callbacks|callbacks]]
|-
|[[NML:Canals|Canals]] || [[NML:Canals#Canal properties|properties]] || [[NML:Canals#Canal variables|variables]] || [[NML:Canals#Canal callbacks|callbacks]]
|-
|[[NML:Bridges|Bridges]] || [[NML:Bridges#Bridge properties|properties]] || [[NML:Bridges#Bridge variables|variables]] || [[NML:Bridges#Bridge callbacks|callbacks]]
|-
|[[NML:Towns|Towns]] || || ||
|-
|[[NML:Houses|Houses]] || [[NML:Houses#House properties|properties]] || [[NML:Houses#House variables|variables]] || [[NML:Houses#House callbacks|callbacks]]
|-
|[[NML:Industries|Industries]]|| || [[NML:Industries#Common variables|common variables]] ||
|-
| || [[NML:Industries#Industry properties|industry properties]] || [[NML:Industries#Industry variables|industry variables]] || [[NML:Industries#Industry callbacks|industry callbacks]]
|-
| || [[NML:IndustryTiles#Industry tile properties|tile properties]] || [[NML:IndustryTiles#Industry tile variables|tile variables]] || [[NML:IndustryTiles#Industry tile callbacks|tile callbacks]]
|-
|[[NML:Cargos|Cargos]] || [[NML:Cargos#Cargo properties|properties]] || [[NML:Cargos#Cargo variables|variables]] || [[NML:Cargos#Cargo callbacks|callbacks]]
|-
|[[NML:Airports|Airports]] || [[NML:Airports#Airport properties|properties]] || [[NML:Airports#Airport variables|variables]] || [[NML:Airports#Airport callbacks|callbacks]]
|-
| || [[NML:Airports#Airport tile properties|tile properties]] || [[NML:Airports#Airport tile variables|tile variables]] || [[NML:Airports#Airport tile callbacks|tile callbacks]]
|-
|[[NML:Objects|Objects]] || [[NML:Objects#Object properties|properties]] || [[NML:Objects#Object variables|variables]] || [[NML:Objects#Object callbacks|callbacks]]
|-
|[[NML:Railtypes|Railtypes]] || [[NML:Railtypes#Railtype properties|properties]] || [[NML:Railtypes#Railtype variables|variables]] || [[NML:Railtypes#Railtype callbacks|callbacks]]
|}
;[[NML:Warnings|Compiler Warnings]]
;[[NML:Additional references|Additional references]]
*[[NML:Animation speed|Animation speed]]
*[[NML:Default industries|Default industries]]
*[[NML:Default industry tiles|Default industry tiles]]
*[[NML:Base cost table|Base cost table]]
*[[NML:List of sound effects|List of sound effects]]
*[[NML:List of default vehicle IDs|List of default vehicle IDs]]
*[[NML:List of default house properties|List of default house properties]]
*[[NML:List of town zones|List of town zones]]
*[[NML:List of tile classes|List of tile classes]]
*[[NML:List of default colour translation palettes|List of default colour translation palettes]]
*[[NML:List of direction constants|List of direction constants]]
*[[NML:List of tile slopes|List of tile slopes]]
*[[NML:List of tiles|List of tiles]]
*[[NML:Default TTD strings|Default TTD strings]]
*[[NML:Deprecated syntax|Deprecated syntax]]
;[[NML:NewGRF compatibility|NewGRF compatibility]]
;[[NML:Old style callbacks|Old-style callbacks]]

[[NML:Manual of style|Manual of style]]

Action8

2014-06-24T21:58:44Z

PikkaBird: /* 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||n/a
|-
|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 "OTD"|| OpenTTD (extra) base graphics: openttdd.grf (OpenTTD 0.6 - 1.0)
|-
|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 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
|-
|41 4E XX XX||A N _ _||FISH ship set
|-
|41 50 XX XX||A P _ _||HEQS (Heavy Equipment Set)
|-
|43 41 XX XX||C A _ _||OzTrans; older versions of Canadian and some North American sets
|-
|43 48 XX XX||C H _ _||CHIPS Has Improved Players' Stations
|-
|4A 56 XX XX||J V _ _||juzza1; Various Finnish sets
|-
|4F 47 2B XX||O G + _||OpenGFX+ sets
|-
|4D 65 XX XX||M e _ _||George; ECS, Long vehicles
|-
|57 42 XX XX||W B _ _||wallyweb; NewObjects, Various features, GRF development
|-
|6D 62 XX XX||m b _ _||Michael Blunck; DBsetXL, NewStations, MariCo
|-
|97 87 XX XX||? ? _ _||OzTrans; newer versions of Canadian sets
|-
|F1 25 00 XX||? ? ? _||FIRS Industry Replacement Set
|-
|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.

* [http://bananas.openttd.org/en/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
* [http://devs.openttd.org/~rubidium/newgrf.html] OpenTTD generates a list that shows all NewGRFs that were ever used in a multiplayer game

=== 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 [[GRFStatusWindow|GRF Status window]].

=== 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 [[GRFStatusWindow|GRF Status window]], 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
|}

Action0/Global Settings

2014-02-01T10:54:47Z

PikkaBird: /* GRFID overrides for engines (11) */ leaving the name of the property as-is for hysterical reasons, but "engines" -> "vehicles" in the description for clarity.

== Introduction ==

Global variables can be set in one of two ways. (This) action 0 using feature 8, or [[ActionD|Action D]]. Variables in arrays will usually be set using an action 0, whereas action D will most commonly set single variables.

In addition to global variables, this action can also set some general grf-specific variables.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 40}}||Cost base multipliers
|-
|09||D||{{ottdp|0.6|2.5|ttdprev=alpha 66}}||Cargo translation table
|-
|0A||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency display names
|-
|0B||D||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency multipliers
|-
|0C||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency options
|-
|0D,0E||D||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency symbols
|-
|0F||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Euro introduction dates
|-
|10||12*32*B||{{ottdp|0.6|2.5|ttdprev=alpha 74}}||Snow line height table
|-
|11||2*D||{{ottdp|0.7|no|ottdrev=r12924}}||GRFID overrides for engines
|-
|12||D||{{ottdp|0.7|no|ottdrev=r15417}}||Rail type translation table
|-
|13,14||V||{{ottdp|1.1|no|ottdrev=r21208}} {{grfFrom|7}}||Gender/case translation table
|-
|15||B||{{ottdp|1.1|no|ottdrev=r21216}} {{grfFrom|7}}||Plural form
|}

== Descriptions ==

=== Cost base multipliers (08) ===

TTD has 49 [[BaseCosts|base costs]] (66 in OpenTTD currently) which govern how much everything costs. Each cost is calculated from a (fixed) factor times the base cost, which is adjusted by inflation every month.

Setting this property allows changing these base costs by factors of two. The default value of the property is 08 which leaves the base cost unchanged. Adding one to the property doubles the base cost, subtracting one halves it.

Using math: NewBaseCost = OldBaseCost * 2^(n-8), where n is the value of property 08.

Modifying the base costs incurs a small rounding error every time the game is saved, because the costs have to be set back to the default in the savegame. However, this error is unnoticable until many years of inflation have passed and should therefore be of little concern.

{{ottdp|1.0|no}} In OpenTTD rounding happens towards 1 or -1 depending on the old base cost; i.e. if the old base cost is positive round towards 1, if negative round towards -1. This prevents the base cost to be zero.

=== Cargo translation table (09) ===

To aid with coding vehicle grf files that wish to support more than the standard cargo types, the easiest way is to install a cargo translation table using this property.

The cargo translation table is a list of [[Action0Cargos#Cargo label 17|cargo labels]]. Each entry means that the corresponding cargo is meant when using this ID in an [[Action3|action 3]] or for a bit in the vehicle's refit mask.

In other words, if for example the fourth entry (number 03) in the list is "MAIL", then defining graphics for cargo 03 will define graphics for mail, and bit 3 in the refit mask will be for mail as well.

This way, the vehicle grf file doesn't need to know or care which cargo slot and cargo bit a certain cargo type uses, it can define its own ID for each cargo that it wishes to support, and thus be independent of both what cargo types are really available in the game and what slots/bits they use.

Because the refit mask contains only 32 bits, only the first 32 entries in the translation table can make use of the refit mask. Other cargo types have to be added via the cargo classes, so put the cargos that need exceptions to the cargo class based refitting first so that they can go in the refit mask.

Note that this property cannot be set incrementally, you must set all types in a single action 0 starting from ID 0.

See below for an example.

==== Example ====

// Cargo translation table
1 * 169 00 08 01 29 00 09
"COAL" "WATR" "RUBB" "MAIL" "OIL_" // 0-4
"LVST" "GOOD" "CERE" "GRAN" "WHET" // 5-9
"MAIZ" "WOOD" "WODT" "IORE" "CORE" // 10-14
"STEL" "PLAS" "VALU" "GOLD" "DIAM" // 15-19
"PAPR" "FOOD" "FRUT" "FISH" "WOOL" // 20-24
"POTA" "SAND" "GLAS" "WDPR" "DYES" // 25-29
"FERT" "OLSD" "RFPR" "VEHI" "PETR" // 30-34
"BRCK" "SULP" "CMNT" "FICR" "LIME" // 35-39
"MILK" // 40
// Train wagon that has special graphics for grain (8),
// wheat (9), maize (10) and cereals (7)
2 * 29 03 00 01 1B 04
08 <grain-cid> 09 <wheat-cid> 0A <maize-cid>
07 <cereals-cid> <default-cid>
// Train wagon that has graphics for water (1), rubber (2),
// oil (4), petrol (34) and milk (40)
3 * 31 03 00 01 1C 05
01 <water-cid> 02 <rubber-cid> 04 <oil-cid>
22 <petrol-cid> 28 <milk-cid> <default-cid>

=== Currency display names (0A) ===
This and the following properties can be used to modify currencies. Each of them can have IDs 0-18 (decimal), the IDs being ordered the same as in the Currency drop-down list.

This property allows changing currency names that are displayed in the Currency drop-down in the Game Options window. This property is a textID, and if you need to supply your own text, it must be a DCxx one.

=== Currency multipliers (0B) ===

The equivalent of 1 British pound in this currency, multiplied by 1000. For example, 1 GBP=2 USD, so this should be 2000 for US dollars. The multiplication by 1000 allows you to have decimals in the multiplier without requiring floating-point calculations. This value is used for display purposes only, TTD always uses British pounds for internal calculations.

=== Currency options (0C) ===

The low byte of this word specifies the thousands separator to be used for this currency ( usually dot "." or comma ","). The high byte should be zero if the currency symbol should be in front of the number ($123,456) and should be 1 if the currency symbol should be shown after the number (123,456$). The symbol placement can be overridden by the TTDPatch settings.

=== Currency symbols (0D,0E) ===

These doublewords are interpreted as a string of up to 4 characters. If you need fewer characters, the remaining bytes should be zero. Property 0D is printed before the number, property 0E is printed after the number. These two usually differ only if the symbol is separated by a space from the number (for example, "$ " vs. " $"). You should specify both properties since the player can override your preferred symbol placement.

=== Euro introduction dates (0F) ===

This value allows you to have Euro introduced instead the currency at a given time. If this value is zero, the currency is never substituted with the Euro (USD, for example). If it's nonzero, it gives the year when the currency is replaced by Euro (for example, 2002 for DM).

=== Snow line height table (10) ===

This property allows you to specify the snow line height for every day of the year. The only ID you can set is 0, and the value must be 12*32=384 bytes long. To simplify things for the patch, every month has 32 entries, and the impossible combinations (like 32th January or 31th April) will never be read.

{{grfTill|7}} For GRF version 7 and below: The values should be multiple of 8 between 10h and 88h.
Values below 10h and above EFh may result in overflow and should not be used. Since the highest possible land is 78h high, giving 88h or above will effectively disable the snow line.

{{grfFrom|8}} For GRF version 8 and above: The values can be any value between 0 and FFh.
FF means 'no snow'; other values are scaled to the number of possible heightlevels of the map.

{{ottdp|no|2.5}} If the temperate snow line is enabled, this table applies on temperate as well.

'''WARNING:''' Some code in TTD assumes that the snow line will remain constant: Some industries are built only above/below snowline and assume that the snow line won't move when they're already built. Similarly, snowy houses on arctic will still appear snowy even when the snow disappears around them. If you want to use this feature, make sure to counter these effects by overriding arctic houses and industries with snow-aware versions.

=== GRFID overrides for engines (11) ===

Allows you to provide a list of 'source' and 'target' GRFIDs to let vehicles in the source GRF override those in the target GRF, when dynamic engines is enabled. Each entry is 8 bytes, containing two GRFIDs. Multiple entries can be used, and different GRFs can be set to override the same 'target' GRF, but only the last instance of a 'source' GRF is active. GRFIDs that are not present will have no effect.

The scope of this feature is quite limited and it should be used only for sets that modify data of another set, for example the DBSetXL ECS addon for DBSetXL, or the censored version of LV4.

=== Rail type translation table (12) ===

Provides ability to specify rail types via a translation table, similar to using a cargo translation table. Each rail type label is a DWord. The default labels are RAIL, ELRL, MONO and MGLV. If a table is installed, then changing engine traction type will not affect the rail type.

=== Gender/case translation table (13,14) ===

Provides ability to specify genders or cases via a translation table. These map NewGRF internal IDs for the genders or cases to the genders or cases as defined in OpenTTD's language files so NewGRF strings and OpenTTD strings can interact on eachother's gender or cases. Property 13 is for mapping genders whereas property 14 is for mapping cases.

The ID used for these translation tables is the Action 4 (GRF version 7 or higher) language-id, i.e. this mapping only works with GRF version 7 or higher. Language-id 7F (any) is not allowed. You can can define an ID multiple times in which case the new mappings are simply appended to the already known mappings.

The format is simply a 00 terminated list of mappings:

(<id> <name>)+ 00

{| |-
!Size!!Name!!Meaning
|-
|B||id||NewGRF internal ID for the gender or case name, may not be 00
|-
|V||name||A 00 terminated string with the gender or case name as in OpenTTD's translation
|}

An NewGRF internal ID may be mapped multiple times for the same language as may an OpenTTD gender or case name be (reverse) mapped multiple times. This can be used for coping with OpenTTD translators adding or removing genders or cases over time. The NewGRF internal ID may not be 00 as this ID will be used in the Action 4 strings which may not contain 00 except for terminating the string.

These mappings are used for [[StringCodes]] 9A 0E, 9A 0F, 9A 13 and 9A 14. How the mapping is used precisely can be found there.

=== Plural form (15) ===

Defines the plural form for a language. The ID used is the Action 4 (GRF version 7 or higher) language-id, i.e. this only works with GRF version 7 or higher. Language-id 7F (any) is not allowed. More information about the different valid plural forms can be found on the [[StringCodes]] page. This property is used for [[StringCodes|StringCode]] 9A 15.

== Example ==

Action0/Vehicles/Planes

2013-03-01T11:32:18Z

PikkaBird: Speed unit for aircraft is "mph/8", not "mph*8".

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

== Introduction ==

Defining properties of planes.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.0}}||Sprite (FF for new graphics)
|-
|09||B||{{ottdp|0.6|2.0}}||Is helicopter? 2=no, 0=yes
|-
|0A||B||{{ottdp|0.6|2.0}}||Is large? 0=no, 1=yes (i.e. can't safely land on small airports)
|-
|0B||B||{{ottdp|0.6|2.0}}||Cost factor
|-
|0C||B||{{ottdp|0.6|2.0}}||Speed in mph/8
|-
|0D||B||{{ottdp|0.6|2.0}}||Acceleration
|-
|0E||B||{{ottdp|0.6|2.0}}||Running cost factor
|-
|0F||W||{{ottdp|0.6|2.0}}||Primary cargo capacity (passenger or refitted cargo)
|-
|11||B||{{ottdp|0.6|2.0}}||Secondary cargo capacity (mail)
|-
|12||B||{{ottdp|0.6|2.0}}||Sound effect
|-
|13||D||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Bit mask of cargo types available for refitting, see column 2 (Bit Value) in [[CargoTypes]]
|-
|14||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Callback flags bit mask, see below
|-
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Refit cost, using 1/32 of the default refit cost base
|-
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||Retire vehicle early, this many years before the end of phase 2 (see [[Action0General]])
|-
|17||B||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Miscellaneous vehicle flags
|-
|18||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Refittable cargo classes, see [[Action0Trains#Cargo classes 28 29|train prop. 28]]
|-
|19||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Non-refittable cargo classes, see [[Action0Trains#Cargo classes 28 29|train prop. 29]]
|-
|1A||D||{{ottdp|0.6|2.5|ttdprev=r1210|ottdrev=r7191}}||Long format introduction date
|-
|1B||B*||{{ottdp|0.7|no|ottdrev=r13831}}||Sort the purchase list
|-
|1C||W||{{ottdp|1.2|no|ottdrev=r22713}}||Custom cargo ageing period
|-
|1D||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of always refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2C]]
|-
|1E||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of never refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2D]]
|-
|1F||W||{{ottdp|1.2|no|ottdrev=r23504}}||Aircraft range in tiles. Distance is euclidean, a value of 0 means range is unlimited
|}

== Descriptions ==

=== Primary (0F) and secondary (11) cargo capacity ===
Aircraft can transport up to two cargo types.
The first (primary) cargo type can be changed when refitting the aircraft.

The secondary cargo type is always mail, and is only present when the primary cargo type is part of the [[Action0/Cargos#CargoClasses_.2816.29|passenger cargo class]].

See also the page about [[VehicleRefitting|vehicle refitting]].

=== Sound effect (12) ===

The following sound effects are used by planes (note, the setting is ignored for helicopters):

{| |-
!Number!!Sound
|-
|06||Propeller sound 1
|-
|07||Jet sound 1
|-
|3B||Supersonic
|-
|3D||Jet sound 2
|-
|45||Propeller sound 2
|-
|46||Jet sound 3
|}

=== Callbacks (14) ===
For planes, the following [[callbacks]] have to be enabled by setting the corresponding bit in property 14 (certain other, not as frequently used callbacks are available without setting a bit here)::

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|2||4||12||Load amount
|-
|3||8||15||Set refitted capacity
|-
|5||20||19||show a suffix after the cargo type name
|-
|6||40||2D||Select color mapping for vehicle
|-
|7||80||33||Sound effect callbacks
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the VarAction2 for callbacks.

=== Refit cost (15) ===

Refit cost, using 1/32 of the default refit cost base. This property can be overridden by callback 15E.

{{ottdp|1.2|no|ottdrev=r23087}} If the refit cost factor is set to zero and bit 4 of the miscellaneous flags (17) is set, auto-refitting is allowed.

=== Miscellaneous flags (17) ===

This is a bit mask, with the following bits:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||reserved, do not use
|-
|1||2||Uses two company colors
|-
|2||4||reserved, do not use
|-
|3||8||reserved, do not use
|-
|4||10||{{ottdp|1.2|no|ottdrev=r23087}} Auto-refitting is enabled for refits where callback 15E allows it or prop 15 specifies zero cost.
|-
|5||20||{{ottdp|1.2|no|ottdrev=r23861}} Use cargo multiplier for default cargo. See page about [[VehicleRefitting#Misc._vehicle_flag_5_.27use_of_capacity_multiplier_for_default_cargo.27_set|vehicle refitting]].
|-
|6||40||{{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect.
|}

=== Long format introduction date (1A) ===

Set the vehicle introduction date, in days since the year 0. This takes account of leap years; dividable by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). This property must be set after property 00 to take effect.

{{ottdp|no|}} In TTDPatch, dates after 2044 will be limited to 2044.

=== Sort vehicle list (1B) ===
See sort vehicle list for [[Action0Trains#Sort vehicle list 1A|trains]] for details.

=== Custom cargo ageing period (1C) ===
See custom cargo ageing period for [[Action0Trains#Custom_cargo_ageing_period_.282B.29|trains]] for details.

== Example ==

To be written

Action2/Single Set

2012-04-06T04:19:50Z

PikkaBird: /* Introduction */ point the railtype action 3 link straight to the railtype action 3 page instead of the general action 3 page.

== Introduction ==
{| |-
!Feature !! Version !! Associated graphics
|-
|Canals || {{ottdp|0.6|2.5}} || Depends on [[Action3#ids | Action3 ID]]; see [[Action0/Canals | Action0]]
|-
|Cargos || {{ottdp|0.6|2.5}} || Single icon sprite
|-
|Airports || {{ottdp|1.1|no}} || Single preview image
|-
|Railtypes || {{ottdp|1.0|no|ottdrev=r19056}} || Depends on [[Action3/Railtypes#cargo-type| Action3 'cargo' type]]
|}

The Action2 for these features defines only a single spriteset, therefore the action2 you need isn't too complicated.

The only graphics associated to cargoes is their icon that is shown in the station window.

The graphics associated with railtypes are somewhat more complicated, but all their logic is in variational action2s and the action3; the standard action2 is again not complicated.

The only graphics associated with airports is their preview sprite. The default size for the preview sprite is 230x140. The airport build GUI will automatically scale if you have a smaller or larger image, but it will probably look best if you make sure it is no larger than the default size.

Do not skip an Action2 using [[Action9]] (unless it skips the whole file). Action2 must not be skipped by Action9 or TTDPatch will most likely crash. Skip or modify [[Action3]] instead. Skipping an Action2 with an [[Action7]] has no effect.

== Syntax ==

<Sprite-number> * <Length> 02 <feature> <set-id> 01 00 <set>

{|
!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 action2
|-
|<feature>||B||[[Features | Feature]] being defined
|-
|<set-id>||B||What set-ID this action2 defines
|-
|01||B||A literal 01 byte
|-
|00||B||A literal 00 byte
|-
|<set>||W||Number of set to use from the last action 1
|}

You may note that this is the same as the action2 entry for vehicles, but with num_loadtypes=1 and num_loadingtypes=0, and only one set number.

== Description ==

=== Sprite-number ===

This is just the number you are at.

=== Length ===

Count the number of bytes in this action.

=== set-id ===

This defines the ID of the current action 2. This ID will later be referred to by [[Action3|action 3]], or a variational/random action 2.

You can reuse action 2 IDs, and there's no restriction on the order in which they are defined.

=== set ===

The sprite set to use for displaying. Entry is a WORD value in little endian format, and refers to the most recent action1 set. For example, action1 set 3 would be encoded as 03 00. Note the additional 00 which is needed because it must be a word value here.
(Don't forget that sprite set numbering starts from zero)

VariationalAction2/Vehicles

2012-03-25T12:08:52Z

PikkaBird: /* Variables */

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

==Introduction==

== Variables ==

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

<references />

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

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

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

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

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

'''Format:''' 00nnbbff

{| |-
!Variable!!Value
|-
|ff||position of vehicle within the consist counted from the engine (front), e.g. the engine would have ff=0, the 1st wagon or mail compartment of planes would have ff=1, the 2nd wagon or the rotor of helicopters would have ff=2, the 3rd wagon would have ff=3 etc
|-
|bb||same as ff, but counted from the end, i.e. the last wagon has bb=0, the next-to-last wagon has bb=1 etc.
|-
|nn||total number of vehicles in the consist minus one (i.e. a train with engine and three wagons has nn=3), including shadow and rotor for aircraft.
|}

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

[[File:vehicle_var40_41.png]]

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

=== Consist cargo (42) ===

'''Format:''' uuiicctt

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

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

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

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

=== Player info (43) ===

'''Format:''' Ccttmmnn

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

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

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

=== Aircraft info (44) ===

'''Format:''' xxxxhhtt

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

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

=== Curvature info (45) ===

'''Format:''' xxxTxBxF

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

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

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

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

Possible values:

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

=== Motion counter (46) ===

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

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

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

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

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

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

'''Format:''' ccccwwtt

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

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

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

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

'''Format:''' xxxxxxff

The bits of ff are:

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

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

=== Information about current rail type for trains (4A) ===

'''Format:''' xxxxFFrr

The lower byte (rr) contains the (translated) rail type the train vehicle is currently driving on. If the rail type has no entry in the rail type translation table of the GRF, this value will be 0xFF. If no translation table is present, the raw value will be returned.

The next byte (FF) contains the following flags:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||The vehicle is/would be powered on the current rail type (this is independent from powered/non-powered wagon or anything)
|}

All other bits are undefined.

All other bytes and the result for non-rail vehicles are undefined.

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

'''Format:''' xxxxxxnn

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

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

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

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

The 60+x parameter specifies the variable to access and temporary register 10E is passed as the new 60+x parameter. Passing 61 as the variable is not allowed. Currently only vehicle specific variables listed on this page plus global variable 25 are accessible through var 61. Esp. variable 5F is currently not supported.

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

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

'''Format:''' zzyyxxFD

This variable is only supported for trains and road vehicles.

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

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

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

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

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

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

{| |-
!Bit!!Version!!Value of the bit
|-
|5||{{ottdp|0.6|2.5}}||Vehicle is powered (engine or powered wagon, mainly useful for the latter)
|-
|6||{{ottdp|0.6|2.5}}||Vehicle would be powered (engine or powered wagon) if there were suitable track. (E.g. electric train in mixed train on normal track)
|-
|8 <ref>This bit is only accurate for the first vehicle in the consist.</ref>||{{ottdp|0.6|2.5}}||This bit is flipped every time the train reverses direction
|-
|10||{{ottdp|0.6|2.5|ttdprev=r1334}}||Vehicle was built during the exclusive preview
|}
<references/>

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

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

==Examples==

VariationalAction2/Vehicles

2012-03-25T12:05:25Z

PikkaBird: /* Variables */

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

==Introduction==

== Variables ==

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

<references />

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

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

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

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

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

'''Format:''' 00nnbbff

{| |-
!Variable!!Value
|-
|ff||position of vehicle within the consist counted from the engine (front), e.g. the engine would have ff=0, the 1st wagon or mail compartment of planes would have ff=1, the 2nd wagon or the rotor of helicopters would have ff=2, the 3rd wagon would have ff=3 etc
|-
|bb||same as ff, but counted from the end, i.e. the last wagon has bb=0, the next-to-last wagon has bb=1 etc.
|-
|nn||total number of vehicles in the consist minus one (i.e. a train with engine and three wagons has nn=3), including shadow and rotor for aircraft.
|}

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

[[File:vehicle_var40_41.png]]

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

=== Consist cargo (42) ===

'''Format:''' uuiicctt

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

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

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

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

=== Player info (43) ===

'''Format:''' Ccttmmnn

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

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

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

=== Aircraft info (44) ===

'''Format:''' xxxxhhtt

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

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

=== Curvature info (45) ===

'''Format:''' xxxTxBxF

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

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

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

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

Possible values:

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

=== Motion counter (46) ===

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

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

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

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

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

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

'''Format:''' ccccwwtt

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

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

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

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

'''Format:''' xxxxxxff

The bits of ff are:

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

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

=== Information about current rail type for trains (4A) ===

'''Format:''' xxxxFFrr

The lower byte (rr) contains the (translated) rail type the train vehicle is currently driving on. If the rail type has no entry in the rail type translation table of the GRF, this value will be 0xFF. If no translation table is present, the raw value will be returned.

The next byte (FF) contains the following flags:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||The vehicle is/would be powered on the current rail type (this is independent from powered/non-powered wagon or anything)
|}

All other bits are undefined.

All other bytes and the result for non-rail vehicles are undefined.

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

'''Format:''' xxxxxxnn

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

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

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

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

The 60+x parameter specifies the variable to access and temporary register 10E is passed as the new 60+x parameter. Passing 61 as the variable is not allowed. Currently only vehicle specific variables listed on this page plus global variable 25 are accessible through var 61. Esp. variable 5F is currently not supported.

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

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

'''Format:''' zzyyxxFD

This variable is only supported for trains and road vehicles.

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

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

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

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

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

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

{| |-
!Bit!!Version!!Value of the bit
|-
|5||{{ottdp|0.6|2.5}}||Vehicle is powered (engine or powered wagon, mainly useful for the latter)
|-
|6||{{ottdp|0.6|2.5}}||Vehicle would be powered (engine or powered wagon) if there were suitable track. (E.g. electric train in mixed train on normal track)
|-
|8 <ref>This bit is only accurate for the first vehicle in the consist.</ref>||{{ottdp|0.6|2.5}}||This bit is flipped every time the train reverses direction
|-
|10||{{ottdp|0.6|2.5|ttdprev=r1334}}||Vehicle was built during the exclusive preview
|}
<references/>

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

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

==Examples==

AirportTypes

2012-03-05T13:20:43Z

PikkaBird:

== Overview ==
OpenTTD allows to define airports; new airports can override the existing airports and in that case inherit all properties for the default airport which they override.

{|
!ID
!Name
!Size<ref>On heliports only helicopters ([[Action0/Vehicles/Planes|prop. 09 aircraft]]) can land. Large planes ([[Action0/Vehicles/Planes|prop. 0A aircraft]]) have a higher crash chance on airports of size 'small'</ref>
!Dimensions
!Avail. dates (0C)
!Catchment (0E)
!Noise (0F)
!Compatible (0D)
!Inf. Maint. Cost (11)
|-
|0
|Small airport
|small
|4x3
|0 - 1959
|4
|3
|Small
|7
|-
|1
|City airport
|large
|6x6
|1955 - MAX
|5
|5
|Large
|24
|-
|2
|Heli port
|heli
|1x1
|1963 - MAX
|4
|1
|Heliport
|4
|-
|3
|Metropolitan
|large
|6x6
|1980 - MAX
|6
|8
|Large
|28
|-
|4
|International
|hub
|7x7
|1990 - MAX
|8
|17
|Large
|42
|-
|5
|Commuter
|small
|5x4
|1983 - MAX
|4
|4
|Small
|20
|-
|6
|Heli depot
|heli
|2x2
|1976 - MAX
|4
|2
|Small
|7
|-
|7
|Intercontinental
|hub
|9x11
|2002 - MAX
|10
|25
|Large
|72
|-
|8
|Heli station
|heli
|4x3
|1980 - MAX
|4
|3
|Large
|14
|-
|9
|Oil rig
|heli
|1x1
|0 - 0
|0
|4
|Oilrig
|0
|}

<references />

CargoTypes

2012-02-24T13:51:13Z

PikkaBird:

'''Cargo labels in OpenTTD'''

{{grf|8}} In GRF version 8 the value to be used in all vehicle and industry properties, and in [[Action3|action 3]], is the position of the cargo label in the [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]] included in the GRF.

{{grf|7}} GRF version 7 and below used different cargo properties for different properties (called "Type A" or "translated" and "Type B" or "untranslated" cargo slots), for historical reasons. This method is deprecated as it meant relying blindly on cargos always using the same slots. You can see the table of Type A and Type B slots [http://newgrf-specs.tt-wiki.net/index.php?title=CargoTypes&oldid=2861 here] if you really want to.

== 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="2" | '''TTD Default Cargos'''
| align="center" colspan="4" | These cargos are present when no NewGRF is used
|-
| PASS
| Passengers
| 0001 Passengers
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| COAL
| Coal
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| MAIL
| Mail
| 0002 Mail
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
|OIL_
| Oil
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GOOD
| Goods
| 0004 Express
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GRAI
| Grain
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| Temperate; see also WHEA, MAIZ, CERE
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| Renamed "Metal" in FIRS.
|-
| VALU
| Valuables
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| Temperate; see also GOLD, DIAM
|-
| PAPR
| Paper
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| WHEA
| Wheat
| 0010 Bulk
|
|
| Arctic; see also GRAI, MAIZ, CERE
|-
| FOOD
| Food
| 0084 Express, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GOLD
| Gold
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| Arctic; see also VALU, DIAM
|-
| RUBR
|Rubber
|0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| MAIZ
| Maize
| 0010 Bulk
|
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| Tropic; see also VALU, GOLD
|-
| SUGR
| Sugar
| 0010 Bulk
|
|
| Toyland
|-
| TOYS
| Toys
| 0020 Piece goods
|
|
| Toyland
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
| Toyland
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
| Toyland
|-
| TOFF
|Toffee
|0010 Bulk
|
|
| Toyland
|-
| COLA
|Cola
|0040 Liquid
|
|
| Toyland
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
| Toyland
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
| Toyland
|-
| PLST
|Plastic
|0040 Liquid
|
|
| Toyland; see also PLAS
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
| Toyland
|-
| align="center" colspan="2" | '''New Cargos'''
| align="center" colspan="4" | these cargos are only present when NewGRF industry sets are used
|-
| AORE
|Bauxite (Aluminium ore)
|0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| BEER
|Alcohol
|0064 Express, piece goods, liquids
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| BDMT
|Building Materials
|0220 Piece goods, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| CERA
|Ceramics
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| CERE
|Cereals
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| CLAY
|Clay
|0210 Bulk covered/sheltered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| CMNT
|Cement
| 0210 Bulk covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| COPR
|Copper
|0020 Piece goods
|
|
|
|-
| DYES
|Dyes
| 0060 Piece goods, liquids
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| ENSP
|Engineering Supplies
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FERT
|Fertiliser
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| FICR
|Fibre crops
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FISH
|Fish
| 0084 Express, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FMSP
|Farm Supplies
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GLAS
|Glass
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| GRVL
|Gravel / Ballast
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| MILK
|Milk
|00C4 Express, liquid, refrigerated
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| MNSP
|Manufacturing Supplies
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| OLSD
|Oil seed
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| PETR
|Petrol / Fuel Oil
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| POTA
|Potash
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| RCYC
|Recyclables
|0220 Piece Goods, covered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| RFPR
|Refined products
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| SCMT
|Scrap Metal
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| SGBT
|Sugar beet
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| not in tropical
|-
| SGCN
|Sugarcane
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| only tropical
|-
| SULP
|Sulphur
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki: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" | [[ttwiki:ECS|ECS]]
|
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| WDPR
|Wood Products
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| WOOL
|Wool
| 0220 Piece goods, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|<ref name="ecs_cargo_change" />
|-
| align="center" colspan="2" |'''Special Cargos'''
| align="center" colspan="4" | these cargos are for use outside industry sets and do not represent transporting anything
|-
| GEAR
|Locomotive regearing
|8000 Special
|
|
| Using this cargo may make your vehicle set incompatible with some industry sets

use CB36 instead to set capacity to 0
|-
| align="center" colspan="2" |'''Deprecated Cargos'''
| align="center" colspan="4" | these cargos are not used by any current industry set, and are listed here for backwards compatibility
|-
| FUEL
|Fuel
|0040 Liquid
|
|
|Use PETR for refined-oil fuel
|-
| RSGR
|Raw Sugar
|0010 Bulk
|
|
| Deprecated in FIRS. See SGBT and SGCN
|-
| SCRP
|Scrap Metal
|0010 Piece Goods
|
|
| Deprecated in FIRS, use SCMT instead
|-
| TWOD
|Tropic Wood
|0020 Piece goods
|
|
| formerly intended as a default cargo
|-
| WSTE
|Waste
|0010 Bulk
|
|
| Deprecated in FIRS.
|}

<references />

If you write or publish a NewGRF which introduces a new cargo label, please also add a comment where the new label is used.

CargoTypes

2012-02-24T12:06:48Z

PikkaBird: rv - by all means remove the ECS and FIRS info if that is out of date, but the table of original cargos is still useful, especially for those of us updating older GRFs.

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

{{grf|8}} In GRF version 8 and above this type is also used for the 'default cargo type' of vehicles.

When using a [[Action0/Global Settings#Cargo_translation_table_.2809.29|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
| {{grf|7}} For GRF version 7 an below use this cargo type to set the default cargo type of vehicles (note, this is climate dependent!).

{{grf|8}} For GRF version 8 and above this type is used nowhere, except in the cargo definition itself.

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.

{{grf|7}} For GRF version 7 and below 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
|-
| FF
| n/a
| FF
| colspan="4" | Use first <ref name="firstrefittable">{{grf|7}} For GRF version 7 and below "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.<br/>{{grf|8}}For GRF version 8 and above "first" means the first wrt. (translated) cargo bit, type A. Thus the cargo translation table of the vehicle GRF defines the order.</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="2" | '''TTD Default Cargos'''
| align="center" colspan="4" | These cargos are present when no NewGRF is used
|-
| PASS
| Passengers
| 0001 Passengers
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| COAL
| Coal
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| MAIL
| Mail
| 0002 Mail
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
|OIL_
| Oil
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GOOD
| Goods
| 0004 Express
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GRAI
| Grain
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| Temperate; see also WHEA, MAIZ, CERE
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| Renamed "Metal" in FIRS.
|-
| VALU
| Valuables
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| Temperate; see also GOLD, DIAM
|-
| PAPR
| Paper
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| WHEA
| Wheat
| 0010 Bulk
|
|
| Arctic; see also GRAI, MAIZ, CERE
|-
| FOOD
| Food
| 0084 Express, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GOLD
| Gold
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| Arctic; see also VALU, DIAM
|-
| RUBR
|Rubber
|0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| MAIZ
| Maize
| 0010 Bulk
|
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| Tropic; see also VALU, GOLD
|-
| SUGR
| Sugar
| 0010 Bulk
|
|
| Toyland
|-
| TOYS
| Toys
| 0020 Piece goods
|
|
| Toyland
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
| Toyland
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
| Toyland
|-
| TOFF
|Toffee
|0010 Bulk
|
|
| Toyland
|-
| COLA
|Cola
|0040 Liquid
|
|
| Toyland
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
| Toyland
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
| Toyland
|-
| PLST
|Plastic
|0040 Liquid
|
|
| Toyland; see also PLAS
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
| Toyland
|-
| align="center" colspan="2" | '''New Cargos'''
| align="center" colspan="4" | these cargos are only present when NewGRF industry sets are used
|-
| AORE
|Bauxite (Aluminium ore)
|0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| BEER
|Alcohol
|0064 Express, piece goods, liquids
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| BDMT
|Building Materials
|0220 Piece goods, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| CERA
|Ceramics
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| CERE
|Cereals
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| CLAY
|Clay
|0210 Bulk covered/sheltered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| CMNT
|Cement
| 0210 Bulk covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| COPR
|Copper
|0020 Piece goods
|
|
|
|-
| DYES
|Dyes
| 0060 Piece goods, liquids
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| ENSP
|Engineering Supplies
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FERT
|Fertiliser
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| FICR
|Fibre crops
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FISH
|Fish
| 0084 Express, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FMSP
|Farm Supplies
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GLAS
|Glass
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| GRVL
|Gravel / Ballast
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| MILK
|Milk
|00C4 Express, liquid, refrigerated
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| MNSP
|Manufacturing Supplies
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| OLSD
|Oil seed
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| PETR
|Petrol / Fuel Oil
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| POTA
|Potash
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| RCYC
|Recyclables
|0220 Piece Goods, covered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| RFPR
|Refined products
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| SCMT
|Scrap Metal
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| SGBT
|Sugar beet
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| not in tropical
|-
| SGCN
|Sugarcane
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| only tropical
|-
| SULP
|Sulphur
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki: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" | [[ttwiki:ECS|ECS]]
|
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| WDPR
|Wood Products
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| WOOL
|Wool
| 0220 Piece goods, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|<ref name="ecs_cargo_change" />
|-
| align="center" colspan="2" |'''Special Cargos'''
| align="center" colspan="4" | these cargos are for use outside industry sets and do not represent transporting anything
|-
| GEAR
|Locomotive regearing
|8000 Special
|
|
| Using this cargo may make your vehicle set incompatible with some industry sets

use CB36 instead to set capacity to 0
|-
| align="center" colspan="2" |'''Deprecated Cargos'''
| align="center" colspan="4" | these cargos are not used by any current industry set, and are listed here for backwards compatibility
|-
| FUEL
|Fuel
|0040 Liquid
|
|
|Use PETR for refined-oil fuel
|-
| RSGR
|Raw Sugar
|0010 Bulk
|
|
| Deprecated in FIRS. See SGBT and SGCN
|-
| SCRP
|Scrap Metal
|0010 Piece Goods
|
|
| Deprecated in FIRS, use SCMT instead
|-
| TWOD
|Tropic Wood
|0020 Piece goods
|
|
| formerly intended as a default cargo
|-
| WSTE
|Waste
|0010 Bulk
|
|
| Deprecated in FIRS.
|}

<references />

If you write or publish a NewGRF which introduces a new cargo label, please also add a comment where the new label is used.