GRFSpecs - User contributions [en-gb]

Talk:ActionD

2018-08-12T12:30:41Z

Alberth: GRM wasn't missing, just obfuscatedly hidden

Talk:ActionD

2018-07-28T09:27:28Z

Alberth:

Apparently, https://newgrf-specs.tt-wiki.net/wiki/GRFResourceManagement can be used too in Action D, but is not mentioned here

Alberth, 20180728
----

Talk:ActionD

2018-07-28T09:26:19Z

Alberth: note about missing GRM link

Apparently, https://newgrf-specs.tt-wiki.net/wiki/GRFResourceManagement can be used too in Action D, but is not mentioned here

Alberth, 20180728
~~

CargoTypes

2017-04-29T12:11:15Z

Alberth: Removing PULP (was removed from FIRS)

'''Cargo labels in OpenTTD'''

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

{{grfTill|7}} GRF version 7 and below used different cargo properties for different properties (called "Type A" or "translated" and "Type B" or "untranslated" cargo slots), for historical reasons. This method is deprecated as it meant relying 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#CargoClasses_.2816.29|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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Temperate; see also WHEA, MAIZ, CERE. YETI also adds 0200 Covered.
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Renamed "Metal" in FIRS, "Balls of Steel" in YETI
|-
| 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]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| YETI food has Refrigerated and Piece goods
|-
| GOLD
| Gold
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Arctic; see also VALU, DIAM
|-
| RUBR
|Rubber
|0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 00A4 Express, piece goods, refrigerated. In YETI: Piece goods, Covered.
|-
| MAIZ
| Maize
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Tropic; see also VALU, GOLD
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Toyland
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
|
| Toyland
|-
| COLA
|Cola
|0040 Liquid
|
|
|
| Toyland
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
|
| Toyland
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
|
| Toyland
|-
| PLST
|Plastic
|0040 Liquid
|
|
|
| Toyland; see also PLAS
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
|
| Toyland
|-
| SUGR
| Sugar
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Toyland. In FIRS 0030 Bulk, Piece Goods
|-
| TOFF
|Toffee
|0010 Bulk
|
|
|
| Toyland
|-
| TOYS
| Toys
| 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]]
|
|
|-
| BEAN
|Beans
|0010 Bulk
|
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 0030 Bulk, piece goods. In YETI only Piece goods.
|-
| BOOM
|Explosives
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| CASS
|Cassava
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| CMNT
|Cement
| 0210 Bulk covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| COKE
|Coke
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| COPR
|Copper
|0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| EOIL
|Edible Oil
| 0060 Piece goods, liquids
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| FERT
|Fertiliser
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| FIRS: 0024 Express, piece goods. 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]]
|
|
|-
| GLAS
|Glass
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| GRVL
|Stone
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|Was "Gravel / Ballast"
|-
| IRON
|Pig Iron
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| JAVA
|Coffee
| 0020 Piece Goods
|
| style="background: #1AD74C; color: black" | [[ttwiki:FIRS|FIRS]]
|
| FIRS: 0024 Piece goods, express. Units in FIRS are 'bags'
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| METL
|Metal
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| MNO2
|Manganese
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| NICK
|Nickel
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| NITR
|Nitrate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| NUTS
| Nuts
| 0020 Piece goods
|
| 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]]
|
|
|-
| PHOS
|Phosphate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| PIPE
|Pipe
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| PORE
|Pyrite Ore
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| POTA
|Potash
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|FIRS: 0010 Bulk. ECS: <ref name="ecs_cargo_change" />
|-
| QLME
|Quicklime
| 0210 Bulk covered/sheltered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| RCYC
|Recyclables
|0220 Piece Goods, covered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|FIRS: 0030 Bulk, Piece Goods
|-
| RFPR
|Refined products
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SASH
|Soda Ash
| 0210 Bulk, covered/sheltered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SCMT
|Scrap Metal
|1010 Bulk, non-pourable
|
| 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
|1010 Bulk, non-pourable
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| only tropical
|-
| SLAG
|Slag
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SULP
|Sulphur
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|FIRS: 0250 Bulk, Liquid, Covered/sheltered. 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]]
|
|
|
|-
| URAN
|Uranium
|0110 Bulk, Hazardous
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VBOD
|Vehicle bodies
|0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VPTS
|Vehicle Parts
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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" />
|-
| YETI
|Workers, YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| YETY
|Tired Workers, Tired YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| align="center" colspan="2" |'''Special Cargos'''
| align="center" colspan="4" | these cargos are for use outside industry sets and do not represent transporting anything
|-
| DFLT
|'Default'
| ---- None
|
|
|
| Used by andythenorth to identify default cargo graphics in newgrfs that use code/graphics generation.

Not intended to be used as an actual cargo in translation tables.
|-
| 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
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
|
|
| Deprecated FIRS cargo. Replaced by FRUT for FIRS > v1.3.0
|-
| 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

2017-04-18T20:12:54Z

Alberth: Quick lime is written as QLME

'''Cargo labels in OpenTTD'''

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

{{grfTill|7}} GRF version 7 and below used different cargo properties for different properties (called "Type A" or "translated" and "Type B" or "untranslated" cargo slots), for historical reasons. This method is deprecated as it meant relying 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#CargoClasses_.2816.29|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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Temperate; see also WHEA, MAIZ, CERE. YETI also adds 0200 Covered.
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Renamed "Metal" in FIRS, "Balls of Steel" in YETI
|-
| 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]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| YETI food has Refrigerated and Piece goods
|-
| GOLD
| Gold
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Arctic; see also VALU, DIAM
|-
| RUBR
|Rubber
|0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 00A4 Express, piece goods, refrigerated. In YETI: Piece goods, Covered.
|-
| MAIZ
| Maize
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Tropic; see also VALU, GOLD
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Toyland
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
|
| Toyland
|-
| COLA
|Cola
|0040 Liquid
|
|
|
| Toyland
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
|
| Toyland
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
|
| Toyland
|-
| PLST
|Plastic
|0040 Liquid
|
|
|
| Toyland; see also PLAS
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
|
| Toyland
|-
| SUGR
| Sugar
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Toyland. In FIRS 0030 Bulk, Piece Goods
|-
| TOFF
|Toffee
|0010 Bulk
|
|
|
| Toyland
|-
| TOYS
| Toys
| 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]]
|
|
|-
| BEAN
|Beans
|0010 Bulk
|
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 0030 Bulk, piece goods. In YETI only Piece goods.
|-
| BOOM
|Explosives
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| CASS
|Cassava
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| CMNT
|Cement
| 0210 Bulk covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| COKE
|Coke
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| COPR
|Copper
|0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| EOIL
|Edible Oil
| 0060 Piece goods, liquids
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| FERT
|Fertiliser
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| FIRS: 0024 Express, piece goods. 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]]
|
|
|-
| GLAS
|Glass
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| GRVL
|Stone
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|Was "Gravel / Ballast"
|-
| IRON
|Pig Iron
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| JAVA
|Coffee
| 0020 Piece Goods
|
| style="background: #1AD74C; color: black" | [[ttwiki:FIRS|FIRS]]
|
| FIRS: 0024 Piece goods, express. Units in FIRS are 'bags'
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| METL
|Metal
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| MNO2
|Manganese
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| NICK
|Nickel
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| NITR
|Nitrate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| NUTS
| Nuts
| 0020 Piece goods
|
| 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]]
|
|
|-
| PHOS
|Phosphate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| PIPE
|Pipe
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| PORE
|Pyrite Ore
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| POTA
|Potash
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|FIRS: 0010 Bulk. ECS: <ref name="ecs_cargo_change" />
|-
| PULP
|Pulpwood
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| QLME
|Quicklime
| 0210 Bulk covered/sheltered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| RCYC
|Recyclables
|0220 Piece Goods, covered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|FIRS: 0030 Bulk, Piece Goods
|-
| RFPR
|Refined products
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SASH
|Soda Ash
| 0210 Bulk, covered/sheltered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SCMT
|Scrap Metal
|1010 Bulk, non-pourable
|
| 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
|1010 Bulk, non-pourable
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| only tropical
|-
| SLAG
|Slag
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SULP
|Sulphur
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|FIRS: 0250 Bulk, Liquid, Covered/sheltered. 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]]
|
|
|
|-
| URAN
|Uranium
|0110 Bulk, Hazardous
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VBOD
|Vehicle bodies
|0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VPTS
|Vehicle Parts
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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" />
|-
| YETI
|Workers, YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| YETY
|Tired Workers, Tired YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| align="center" colspan="2" |'''Special Cargos'''
| align="center" colspan="4" | these cargos are for use outside industry sets and do not represent transporting anything
|-
| DFLT
|'Default'
| ---- None
|
|
|
| Used by andythenorth to identify default cargo graphics in newgrfs that use code/graphics generation.

Not intended to be used as an actual cargo in translation tables.
|-
| 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
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
|
|
| Deprecated FIRS cargo. Replaced by FRUT for FIRS > v1.3.0
|-
| 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

2017-04-18T19:44:28Z

Alberth: Updated FIRS cargos

'''Cargo labels in OpenTTD'''

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

{{grfTill|7}} GRF version 7 and below used different cargo properties for different properties (called "Type A" or "translated" and "Type B" or "untranslated" cargo slots), for historical reasons. This method is deprecated as it meant relying 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#CargoClasses_.2816.29|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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Temperate; see also WHEA, MAIZ, CERE. YETI also adds 0200 Covered.
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Renamed "Metal" in FIRS, "Balls of Steel" in YETI
|-
| 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]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| YETI food has Refrigerated and Piece goods
|-
| GOLD
| Gold
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Arctic; see also VALU, DIAM
|-
| RUBR
|Rubber
|0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 00A4 Express, piece goods, refrigerated. In YETI: Piece goods, Covered.
|-
| MAIZ
| Maize
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Tropic; see also VALU, GOLD
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Toyland
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
|
| Toyland
|-
| COLA
|Cola
|0040 Liquid
|
|
|
| Toyland
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
|
| Toyland
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
|
| Toyland
|-
| PLST
|Plastic
|0040 Liquid
|
|
|
| Toyland; see also PLAS
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
|
| Toyland
|-
| SUGR
| Sugar
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Toyland. In FIRS 0030 Bulk, Piece Goods
|-
| TOFF
|Toffee
|0010 Bulk
|
|
|
| Toyland
|-
| TOYS
| Toys
| 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]]
|
|
|-
| BEAN
|Beans
|0010 Bulk
|
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 0030 Bulk, piece goods. In YETI only Piece goods.
|-
| BOOM
|Explosives
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| CASS
|Cassava
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| CMNT
|Cement
| 0210 Bulk covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| COKE
|Coke
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| COPR
|Copper
|0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| EOIL
|Edible Oil
| 0060 Piece goods, liquids
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| FERT
|Fertiliser
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| FIRS: 0024 Express, piece goods. 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]]
|
|
|-
| GLAS
|Glass
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| GRVL
|Stone
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|Was "Gravel / Ballast"
|-
| IRON
|Pig Iron
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| JAVA
|Coffee
| 0020 Piece Goods
|
| style="background: #1AD74C; color: black" | [[ttwiki:FIRS|FIRS]]
|
| FIRS: 0024 Piece goods, express. Units in FIRS are 'bags'
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| METL
|Metal
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| MNO2
|Manganese
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| NICK
|Nickel
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| NITR
|Nitrate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| NUTS
| Nuts
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| OLME
|Quicklime
| 0210 Bulk covered/sheltered
|
| 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]]
|
|
|-
| PHOS
|Phosphate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| PIPE
|Pipe
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| PORE
|Pyrite Ore
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| POTA
|Potash
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|FIRS: 0010 Bulk. ECS: <ref name="ecs_cargo_change" />
|-
| PULP
|Pulpwood
| 0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| RCYC
|Recyclables
|0220 Piece Goods, covered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|FIRS: 0030 Bulk, Piece Goods
|-
| RFPR
|Refined products
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SASH
|Soda Ash
| 0210 Bulk, covered/sheltered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SCMT
|Scrap Metal
|1010 Bulk, non-pourable
|
| 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
|1010 Bulk, non-pourable
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| only tropical
|-
| SLAG
|Slag
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SULP
|Sulphur
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|FIRS: 0250 Bulk, Liquid, Covered/sheltered. 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]]
|
|
|
|-
| URAN
|Uranium
|0110 Bulk, Hazardous
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VBOD
|Vehicle bodies
|0020 Piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VPTS
|Vehicle Parts
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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" />
|-
| YETI
|Workers, YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| YETY
|Tired Workers, Tired YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| align="center" colspan="2" |'''Special Cargos'''
| align="center" colspan="4" | these cargos are for use outside industry sets and do not represent transporting anything
|-
| DFLT
|'Default'
| ---- None
|
|
|
| Used by andythenorth to identify default cargo graphics in newgrfs that use code/graphics generation.

Not intended to be used as an actual cargo in translation tables.
|-
| 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
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
|
|
| Deprecated FIRS cargo. Replaced by FRUT for FIRS > v1.3.0
|-
| 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

2017-04-18T18:43:12Z

Alberth: Added COKE, different cargo class for FIRS JAVA

'''Cargo labels in OpenTTD'''

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

{{grfTill|7}} GRF version 7 and below used different cargo properties for different properties (called "Type A" or "translated" and "Type B" or "untranslated" cargo slots), for historical reasons. This method is deprecated as it meant relying 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#CargoClasses_.2816.29|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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Temperate; see also WHEA, MAIZ, CERE. YETI also adds 0200 Covered.
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Renamed "Metal" in FIRS, "Balls of Steel" in YETI
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| YETI food has Refrigerated and Piece goods
|-
| 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]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 00A4 Express, piece goods, refrigerated. In YETI: Piece goods, Covered.
|-
| MAIZ
| Maize
| 0010 Bulk
|
|
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Tropic; see also VALU, GOLD
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Toyland
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
|
| Toyland
|-
| COLA
|Cola
|0040 Liquid
|
|
|
| Toyland
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
|
| Toyland
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
|
| Toyland
|-
| PLST
|Plastic
|0040 Liquid
|
|
|
| Toyland; see also PLAS
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
|
| Toyland
|-
| SUGR
| Sugar
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Toyland. In FIRS 0030 Bulk, Piece Goods
|-
| TOFF
|Toffee
|0010 Bulk
|
|
|
| Toyland
|-
| TOYS
| Toys
| 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]]
|
|
|-
| BEAN
|Beans
|0010 Bulk
|
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 0030 Bulk, piece goods. In YETI only Piece goods.
|-
| BOOM
|Explosives
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| CASS
|Cassava
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| CMNT
|Cement
| 0210 Bulk covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| COKE
|Coke
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| EOIL
|Edible Oil
| 0060 Piece goods, liquids
|
| 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]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|Renamed "Stone" for YETI
|-
| JAVA
|Coffee
| 0020 Piece Goods
|
| style="background: #1AD74C; color: black" | [[ttwiki:FIRS|FIRS]]
|
| FIRS: 0024 Piece goods, express. Units in FIRS are 'bags'
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| MNO2
|Manganese
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| NITR
|Nitrate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| NUTS
| Nuts
| 0020 Piece goods
|
| 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]]
|
|
|-
| PHOS
|Phosphate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| PORE
|Pyrite Ore
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SCMT
|Scrap Metal
|1010 Bulk, non-pourable
|
| 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
|1010 Bulk, non-pourable
|
| 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]]
|
|
|
|-
| URAN
|Uranium
|0110 Bulk, Hazardous
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VPTS
|Vehicle Parts
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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" />
|-
| YETI
|Workers, YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| YETY
|Tired Workers, Tired YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| align="center" colspan="2" |'''Special Cargos'''
| align="center" colspan="4" | these cargos are for use outside industry sets and do not represent transporting anything
|-
| DFLT
|'Default'
| ---- None
|
|
|
| Used by andythenorth to identify default cargo graphics in newgrfs that use code/graphics generation.

Not intended to be used as an actual cargo in translation tables.
|-
| 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
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
|
|
| Deprecated FIRS cargo. Replaced by FRUT for FIRS > v1.3.0
|-
| 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

2017-04-18T18:36:41Z

Alberth: Added cement to FIRS

'''Cargo labels in OpenTTD'''

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

{{grfTill|7}} GRF version 7 and below used different cargo properties for different properties (called "Type A" or "translated" and "Type B" or "untranslated" cargo slots), for historical reasons. This method is deprecated as it meant relying 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#CargoClasses_.2816.29|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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Temperate; see also WHEA, MAIZ, CERE. YETI also adds 0200 Covered.
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Renamed "Metal" in FIRS, "Balls of Steel" in YETI
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| YETI food has Refrigerated and Piece goods
|-
| 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]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 00A4 Express, piece goods, refrigerated. In YETI: Piece goods, Covered.
|-
| MAIZ
| Maize
| 0010 Bulk
|
|
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Tropic; see also VALU, GOLD
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Toyland
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
|
| Toyland
|-
| COLA
|Cola
|0040 Liquid
|
|
|
| Toyland
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
|
| Toyland
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
|
| Toyland
|-
| PLST
|Plastic
|0040 Liquid
|
|
|
| Toyland; see also PLAS
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
|
| Toyland
|-
| SUGR
| Sugar
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Toyland. In FIRS 0030 Bulk, Piece Goods
|-
| TOFF
|Toffee
|0010 Bulk
|
|
|
| Toyland
|-
| TOYS
| Toys
| 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]]
|
|
|-
| BEAN
|Beans
|0010 Bulk
|
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 0030 Bulk, piece goods. In YETI only Piece goods.
|-
| BOOM
|Explosives
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| CASS
|Cassava
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| CMNT
|Cement
| 0210 Bulk covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| EOIL
|Edible Oil
| 0060 Piece goods, liquids
|
| 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]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|Renamed "Stone" for YETI
|-
| JAVA
|Coffee
| 0020 Piece Goods
|
| style="background: #1AD74C; color: black" | [[ttwiki:FIRS|FIRS]]
|
| Units in FIRS are 'bags'
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| MNO2
|Manganese
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| NITR
|Nitrate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| NUTS
| Nuts
| 0020 Piece goods
|
| 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]]
|
|
|-
| PHOS
|Phosphate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| PORE
|Pyrite Ore
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SCMT
|Scrap Metal
|1010 Bulk, non-pourable
|
| 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
|1010 Bulk, non-pourable
|
| 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]]
|
|
|
|-
| URAN
|Uranium
|0110 Bulk, Hazardous
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VPTS
|Vehicle Parts
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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" />
|-
| YETI
|Workers, YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| YETY
|Tired Workers, Tired YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| align="center" colspan="2" |'''Special Cargos'''
| align="center" colspan="4" | these cargos are for use outside industry sets and do not represent transporting anything
|-
| DFLT
|'Default'
| ---- None
|
|
|
| Used by andythenorth to identify default cargo graphics in newgrfs that use code/graphics generation.

Not intended to be used as an actual cargo in translation tables.
|-
| 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
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
|
|
| Deprecated FIRS cargo. Replaced by FRUT for FIRS > v1.3.0
|-
| 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.

Callback: Cargo sub-type display for industries

2017-02-26T15:43:02Z

Alberth: Updated cb37 with new return values for openttd r27551

== Cargo sub-type display for industries (37) ==

This callback allows you to display some text after the cargo name in the industry fund window and in industry windows.

{{grfTill|7}} For GRF version 7 and below the valid return values are:
{| |-
|00..FE|| Display D0xx (D000..D0FE) text.
|-
|FF|| Display no text.
|-
|100..1FE|| Display D0xx (D100..D1FE) text.
|-
|200..2FE|| Display D0xx (D200..D2FE) text.
|-
|300..3FE|| Display D0xx (D300..D3FE) text.
|}

{{grfFrom|8}} For GRF version 8 and above the valid return values are:
{| |-
|00..3FF|| Display D0xx (D000..D3FF) text.
|-
|400|| Display no text.
|-
|401|| Display no amount and no text (needs OpenTTD r27751 or newer).
|-
|800..BFF|| Display D0xx (D00..D3FF) text without amount (needs OpenTTD r27751 or newer).
|}

During the callback, the lowest byte of var. 18 can have the following values:

{| |-
!Number!!Meaning
|-
|00||Return subtext for first accepted cargo type
|-
|01||Return subtext for second accepted cargo type
|-
|02||Return subtext for third accepted cargo type
|-
|03||Return subtext for first produced cargo type
|-
|04||Return subtext for second produced cargo type
|}

Bits 8..15 of var. 18 can have the following values:

{| |-
!Number!!Meaning
|-
|00||The text is to be displayed in the industry fund window. The industry isn't built yet, so you can't access the industry variables
|-
|01||The text is to be displayed in the window of the industry. You can use the industry variables here.
|-
|02||The text is to be displayed in the industry directory window. You can use the industry variables here.
|-
|other values||Reserved for future use
|}

Other bits of var. 18 are reserved for future use.

{{ottdp|1.0|no|ottdrev=r17802}} Since OpenTTD r17802, the contents of registers 100h..105h are copied onto the text reference stack.
[[Category:Callbacks]]

CargoTypes

2016-04-08T19:15:18Z

Alberth: Added FIRS to VEHI label

'''Cargo labels in OpenTTD'''

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

{{grfTill|7}} GRF version 7 and below used different cargo properties for different properties (called "Type A" or "translated" and "Type B" or "untranslated" cargo slots), for historical reasons. This method is deprecated as it meant relying 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#CargoClasses_.2816.29|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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Temperate; see also WHEA, MAIZ, CERE. YETI also adds 0200 Covered.
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Renamed "Metal" in FIRS, "Balls of Steel" in YETI
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| YETI food has Refrigerated and Piece goods
|-
| 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]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 00A4 Express, piece goods, refrigerated. In YETI: Piece goods, Covered.
|-
| MAIZ
| Maize
| 0010 Bulk
|
|
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Tropic; see also VALU, GOLD
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| Toyland
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
|
| Toyland
|-
| COLA
|Cola
|0040 Liquid
|
|
|
| Toyland
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
|
| Toyland
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
|
| Toyland
|-
| PLST
|Plastic
|0040 Liquid
|
|
|
| Toyland; see also PLAS
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
|
| Toyland
|-
| SUGR
| Sugar
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
| Toyland. In FIRS 0030 Bulk, Piece Goods
|-
| TOFF
|Toffee
|0010 Bulk
|
|
|
| Toyland
|-
| TOYS
| Toys
| 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]]
|
|
|-
| BEAN
|Beans
|0010 Bulk
|
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
| In FIRS: 0030 Bulk, piece goods. In YETI only Piece goods.
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| CASS
|Cassava
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| 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]]
|
|
|-
| EOIL
|Edible Oil
| 0060 Piece goods, liquids
|
| 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]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|Renamed "Stone" for YETI
|-
| JAVA
|Coffee
| 0020 Piece Goods
|
| style="background: #1AD74C; color: black" | [[ttwiki:FIRS|FIRS]]
|
| Units in FIRS are 'bags'
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| MNO2
|Manganese
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
|
|
|-
| NITR
|Nitrate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| NUTS
| Nuts
| 0020 Piece goods
|
| 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]]
|
|
|-
| PHOS
|Phosphate
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|
|-
| PORE
|Pyrite Ore
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| SCMT
|Scrap Metal
|1010 Bulk, non-pourable
|
| 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
|1010 Bulk, non-pourable
|
| 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]]
|
|
|
|-
| URAN
|Uranium
|0110 Bulk, Hazardous
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| VPTS
|Vehicle Parts
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|
|-
| 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" />
|-
| YETI
|Workers, YETI dudes
|0404 Express, Oversized
|
|
| style="background: #009fe3; color: black" | [[ttwiki:YETI|YETI]]
|
|-
| align="center" colspan="2" |'''Special Cargos'''
| align="center" colspan="4" | these cargos are for use outside industry sets and do not represent transporting anything
|-
| DFLT
|'Default'
| ---- None
|
|
|
| Used by andythenorth to identify default cargo graphics in newgrfs that use code/graphics generation.

Not intended to be used as an actual cargo in translation tables.
|-
| 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
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
|
|
| Deprecated FIRS cargo. Replaced by FRUT for FIRS > v1.3.0
|-
| 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.

NML:Industries

2015-11-14T10:47:09Z

Alberth: Added prob_map_gen property

{{NMLNavPropVarCB}}

This page contains information on industry properties, variables and callbacks. [[NML:IndustryTiles|Industry tiles]] are closely related.

== Industry ID allocation ==
Industry IDs are local to the NewGRF, you are free to choose any ID in the 0..127-range. You should start your item definition with the 'substitute'-property, which allocates a new industry. The value of this property should be the ID of a [[IndustryDefaultProps|default industry]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).

Furthermore, you can set the 'override'-property, which will cause the existing industry to be replaced with your item. You should use this if you are for example defining a coal mine which changes production more dynamically. If your type is not a direct replacement of an existing item, don't set this property.

==Industry properties==

Industry properties. Default industry type numbers can be found at [[NML:Default industries|default industries]].

{| class="t"
! property
! value range
! comment
|-
| substitute
| industry type
| Number of the original industry type that replaces this one, should it not be available for some reason (e.g. missing NewGRF). '''This property ''must'' be set first, before any other properties or graphics.''' All properties of the old type are copied to your new industry.
|-
| override
| industry type
| Number of the original industry type overridden. This will cause other grfs / industries to consider your industry type the same as the old type. Only set this property if your type is (more or less) the same as the old type.
|-
| layouts
| Array of tilelayouts
|
See [[NML:Tilelayout|Tilelayout]] syntax.
|-
| life_type
| One of IND_LIFE_TYPE_XXX, XXX = BLACK_HOLE <nowiki>|</nowiki> EXTRACTIVE <nowiki>|</nowiki> ORGANIC <nowiki>|</nowiki> PROCESSING
| The generic type of industry. This determines the production changes that occur by default (when not using the callback). Examples are respectively power plants, coal mines, forests en steel mills.
|-
| closure_msg
| string
|
Message displayed when the industry announces closure. Use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].
|-
| prod_increase_msg
| string
|
Message displayed when industry increases production. Use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].
|-
| prod_decrease_msg
| string
|
Message displayed when industry decreases production. Use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].
|-
| fund_cost_multiplier
| 0..255
| Fund cost multiplier. Note that in OpenTTD the unmodified base cost is 8x higher for building (not prospecting) raw (=extractive / organic, see life_type) industries.
|-
| prod_cargo_types
| array of up to 2 ints
| Types of cargo produced. Use the cargotype(<label>) built-in function to specify a label from the cargotable.
|-
| accept_cargo_types
| array of up to 3 ints
| Types of cargo accepted. Use the cargotype(<label>) built-in function to specify a label from the cargotable
|-
| prod_multiplier
| array of up to 2 ints (0..255)
| Amount of each output cargo to produce every 256 ticks (8 or 9 times a month)
|-
| min_cargo_distr
| 0..255
| Minimal amount of cargo before transporting to stations.
|-
| random_sound_effects
| array of ints
| Sound effect numbers that are played some times.
|-
| conflicting_ind_types
| array of up to 3x industry_type(IND_TYPE_OLD <nowiki>|</nowiki> IND_TYPE_NEW, id)
|
Three industry types that should not be nearby. Use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">industry_type(..)</code> to define either an old industry (using the global ID) or a new industry from your grf (using the grf-local ID).
|-
| prob_random
| 0..255
| (up to NML v5796-418, use prob_map_gen otherwise) Probability of occurring while generating initial industries. If the random game probability value is nonzero and IND_FLAG_DO_NOT_FORCE_INSTANCE_AT_MAP_GENERATION is not set, at least one instance of this type is guaranteed to appear on the map.
|-
| prob_map_gen
| 0..255
| (NML v5796-418 or newer) Probability of occurring while generating initial industries. If the random game probability value is nonzero and IND_FLAG_DO_NOT_FORCE_INSTANCE_AT_MAP_GENERATION is not set, at least one instance of this type is guaranteed to appear on the map.
|-
| prob_in_game
| 0..255
| Probability of occurring while creating industries during the game.
|-
| map_colour
| 0..255
|
Colour index from the [[NML:Graphic files|DOS palette]] to use on the minimap for this industry.
|-
| spec_flags
| bitmask(flags)
|
for flag values see [[#industry_special_flags|Industry special flags]]
|-
| new_ind_msg
| string
| Message displayed when industry gets built during game play.
|-
| input_multiplier_1
| array of up to 2 floats (0..255)
| Output cargo multiplication factors for getting a unit of the first accepted cargo.
|-
| input_multiplier_2
| array of up to 2 floats (0..255)
| Output cargo multiplication factors for getting a unit of the second accepted cargo.
|-
| input_multiplier_3
| array of up to 2 floats (0..255)
| Output cargo multiplication factors for getting a unit of the third accepted cargo.
|-
| name
| string
|
Name of the industry, use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].
|-
| prospect_chance
| 0 .. 1 (float)
| Chance of successful prospecting.
|-
| callback_flags
| bitmask(flags)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| remove_cost_multiplier
| int
| Cost multiplier for removing the industry (currently only possible with magic bulldozer).
|-
| nearby_station_name
| string
| Default additional name for a nearby station
|}

===Industry special flags===

{| class="t"
! flag
! meaning
|-
| IND_FLAG_PLANT_FIELDS_PERIODICALLY
| The industry periodically plants fields around itself (temperate and arctic farms)
|-
| IND_FLAG_CUT_TREES
| The industry cuts trees around itself and produces its first output cargo from them (lumber mill)
|-
| IND_FLAG_BUILT_ON_WATER
| The industry is built on water (oil rig)
|-
| IND_FLAG_ONLY_IN_LARGE_TOWNS
| The industry can only be built in towns (i.e. it has to replace houses) with population larger than 1200 (temperate bank)
|-
| IND_FLAG_ONLY_IN_TOWNS
| The industry can only be built in towns (i.e. it has to replace houses) (arctic and tropic banks, water tower)
|-
| IND_FLAG_BUILT_NEAR_TOWN
| The industry is always built near towns (i.e. near town sign; additionally the industry is allowed to replace houses) (toy shop)
|-
| IND_FLAG_PLANT_FIELDS_WHEN_BUILT
| Fields are planted around the industry when it's built (all farms)
|-
| IND_FLAG_NO_PRODUCTION_INCREASE
| The industry cannot increase its production on the temperate climate (oil wells)
|-
| IND_FLAG_BUILT_ONLY_BEFORE_1950
| The industry is built only before 1950 (oil wells)
|-
| IND_FLAG_BUILT_ONLY_AFTER_1960
| The industry is built only after 1960 (oil rig)
|-
| IND_FLAG_AI_CREATES_AIR_AND_SHIP_ROUTES
| AI players will attempt to establish air and ship routes going to this industry (oil rig)
|-
| IND_FLAG_MILITARY_AIRPLANE_CAN_EXPLODE
| The industry can be exploded by a military airplane (oil refinery)
|-
| IND_FLAG_MILITARY_HELICOPTER_CAN_EXPLODE
| The industry can be exploded by a military helicopter (factory)
|-
| IND_FLAG_CAN_CAUSE_SUBSIDENCE
| The industry can cause a subsidence (coal mine)
|-
| IND_FLAG_AUTOMATIC_PRODUCTION_MULTIPLIER
| Automatic production multiplier handing (No industry has this bit set by default.).
|-
| IND_FLAG_RANDOM_BITS_IN_PRODUCTION_CALLBACK
| The production callback needs random bits in var. 10 (No industry has this bit set by default.)
|-
| IND_FLAG_DO_NOT_FORCE_INSTANCE_AT_MAP_GENERATION
| Do not force one instance of this type to appear during initial map generation (No industry has this bit set by default.)
|-
| IND_FLAG_ALLOW_CLOSING_LAST_INSTANCE
| Allow closing down the last instance of this type (No industry has this bit set by default.)
|}

{{NML:IndustryCommonVariables}}

==Industry variables==

{| class="t"
! name
! value range
! comment
|-
| production_level
| 0, or 4 .. 128
| Current production level of the industry. Usually in range 4 .. 128, default starting level is 16. A level of 0 indicates imminent closure.
|-
| waiting_cargo_1
| 0..65535
| If any of the production callbacks is enabled, this variable will contain the amount of the first cargo type awaiting to be processed.
|-
| waiting_cargo_2
| 0..65535
| If any of the production callbacks is enabled, this variable will contain the amount of the second cargo type awaiting to be processed.
|-
| waiting_cargo_3
| 0..65535
| If any of the production callbacks is enabled, this variable will contain the amount of the third cargo type awaiting to be processed.
|-
| produced_cargo_waiting_1
| 0..65535
| The amount of produced 'output cargo type 1' that this waiting to be transported.
|-
| produced_cargo_waiting_2
| 0..65535
| The amount of produced 'output cargo type 2' that this waiting to be transported.
|-
| produced_this_month_1
| 0..65535
| The amount of 'output cargo type 1' that was produced this month.
|-
| produced_this_month_2
| 0..65535
| The amount of 'output cargo type 2' that was produced this month.
|-
| produced_last_month_1
| 0..65535
| The amount of 'output cargo type 1' that was produced last month.
|-
| produced_last_month_2
| 0..65535
| The amount of 'output cargo type 2' that was produced last month.
|-
| transported_this_month_1
| 0..65535
| The amount of 'output cargo type 1' that was transported this month.
|-
| transported_this_month_2
| 0..65535
| The amount of 'output cargo type 2' that was transported this month.
|-
| transported_last_month_1
| 0..65535
| The amount of 'output cargo type 1' that was produced last month.
|-
| transported_last_month_2
| 0..65535
| The amount of 'output cargo type 2' that was produced last month.
|-
| transported_last_month_pct_1
| 0..100
| Percentage of produced 'output cargo type 1' that was transported last month.
|-
| transported_last_month_pct_2
| 0..100
| Percentage of produced 'output cargo type 2' that was transported last month.
|-
| production_rate_1
| 0..255
| {{nml|0.3}} Amount of 'output cargo type 1' that is produced every 256 ticks. Initial value from the <code>prod_multiplier</code>-property, but it will change accordingly when the production level changes.
|-
| production_rate_2
| 0..255
| {{nml|0.3}} Amount of 'output cargo type 2' that is produced every 256 ticks. Initial value from the <code>prod_multiplier</code>-property, but it will change accordingly when the production level changes.
|-
| water_distance
| Distance to the tile
| If the industry is built on water, this variable gives the distance of the closest dry land tile, otherwise it gives the distance of the closest water tile.
|-
| layout_num
| 1..255
| Number of the layout being used by the industry.
|-
| founder
| 0..16
| Company number of the industry founder. It will be FOUNDER_GAME (=16) if the industry was generated randomly. TTDPatch only supports up to 8 companies (0..7).
|-
| founder_type
| PLAYERTYPE_XX
| PLAYERTYPE_HUMAN, PLAYERTYPE_AI, PLAYERTYPE_HUMAN_IN_AI (human managing AI company) or PLAYERTYPE_AI_IN_HUMAN (AI managing human company). OpenTTD only uses PLAYERTYPE_HUMAN and PLAYERTYPE_AI. If you cheat yourself to be part of an AI company OpenTTD will still report PLAYERTYPE_AI for the company with yourself and the AI and it'll report PLAYERTYPE_HUMAN for the now uncontrolled company.
|-
| founder_colour1
| COLOUR_XXX
|
Index of founding company's first colour. 0 if not founded by a company. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| founder_colour2
| COLOUR_XXX
|
Index of founding company's second colour. It's the same as company_colour1, if no second company colour is chosen. 0 if not founded by a company. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| colour
| COLOUR_XXX
|
Random colour for this industry. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| build_date
| 0..1826212865
| Date of the industry foundation in days since year 0.
|-
| build_type
| BUILDTYPE_XX
| BUILDTYPE_UNKNOWN (if created in an old version or with newindustries disabled), BUILDTYPE_GAMEPLAY (if founded or created by the in-game random industry generator), BUILDTYPE_GENERATION (if created during random map generation) or BUILDTYPE_EDITOR (if created with the scenario editor).
|-
| counter
| 0..65535
| Decremented every tick, used to time primary industry production in TTD.
|-
| last_accept_date
| date(year, month, day)
| Date when cargo was accepted for the last time. Not valid before 1920 and after 2090.
|-
| random_bits
| 0 ... 65535
| Random data that can be used to randomize certain descisions. (see [[NML:Random_switch|Random switch]]) (NML r1666)
|}

 Variables that require some parameters.

{| class="t"
! name
! arguments
! comment
|-
| industry_count
| industry_type, grfid = -1
|
The value of this variable is the number of industries of a given type that are currently on the map. industry_type is either the ID of an industry. GRFid is the grf in which the industry was defined. The default value is -1, which means current newgrf. A grfid of 0 lets you check the number of default industries of a given type. Use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert a grfid to its numeric representation. ''Warning: using this variable trashes the contents of temporary storage register 0x100''
|-
| industry_distance
| industry_type, grfid = -1
| The value of this variable is the manhattan distance the closest instance of the given industry or 0xFFFF if not applicable. See industry_count for a description of the parameters. ''Warning: using this variable trashes the contents of temporary storage register 0x100.''
|-
| industry_layout_count / industry_layout_distance
| industry_type, layout, grfid = -1.
| See industry_count / industry_distance for description of industry_type, grfid and return value. The results are filtered to industries that have the given layout number. ''Warning: using this variable trashes the contents of temporary storage registers 0x100 and 0x101.''
|-
| industry_town_count
| industry_type, grfid = -1.
| See industry_count / industry_distance for description of industry_type, grfid and return value. The results are filtered to industries that have the same town than the current industry. ''Warning: using this variable trashes the contents of temporary storage registers 0x100 and 0x101.''
|-
| town_manhattan_dist
| x, y
| Parameters indicate a signed offset relative to the northern tile. Returns the Manhattan distance (dx + dy) from the selected tile to the closest town
|-
| town_euclidean_dist
| x, y
| Parameters indicate a signed offset relative to the northern tile. Returns the squared Eucleidean distance (dx^2 + dy^2) from the selected tile to the closest town.
|-
| town_zone
| x, y
|
Parameters indicate a signed offset relative to the northern tile. Returns the [[NML:List of town zones|town zone]] that the selected tile is in.
|-
| nearby_tile_random_bits
| x, y
| Parameters indicate an unsigned offset relative to the northern tile. Returns the random bits of the selected industry tile, or 0 if it is not an industry tile that's part of this industry.
|}

==Industry callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| varies
| Any unhandled callbacks. Generally this doesn't need to be used, except for old-style callbacks.
|-
| produce_cargo_arrival
| Produce-block
| Called to produce cargo when it arrives.
|-
| produce_256_ticks
| Produce-block
| Called to produce cargo every 256 ticks.
|-
| availability
| CB_RESULT_IND_ALLOW or CB_RESULT_IND_DISALLOW
|
{{nml|0.2}} Only available in NML 0.2 or earlier. Called when the game needs to know if the industry type is available. It is limited to the type as a whole, so you can't access industry-specific variables. <code style="color:darkgreen">extra_callback_info2</code> contains the [[#Industry creation types|creation type]].
|-
| construction_probability
| CB_RESULT_IND_NO_CONSTRUCTION, CB_RESULT_IND_PROBABILITY_FROM_PROPERTY or a relative probability 0..255
|
{{nml|0.3}}. Called when the game needs to know if the industry type is available. It is limited to the type as a whole, so you can't access industry-specific variables.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The [[#Industry creation types|creation type]].
If you return CB_RESULT_IND_NO_CONSTRUCTION or 0 the industry won't be build. If you return CB_RESULT_IND_PROBABILITY_FROM_PROPERTY it'll be build according to the relative probability as defined in the <code style="color:darkgreen">prob_random</code> or <code style="color:darkgreen">prob_in_game</code> properties, otherwise it'll use the value as returned as relative probability.
|-
| location_check
|
See the [[#Location check results|table]] below.
|
Called to check if a location is suitable.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The [[#Industry creation types|creation type]].
Since the industry isn't built yet, industry variables aren't available. If this callback is not implemented or fails, constructing the industry will be allowed. Construction might also be prevented via the <code style="color:darkgreen">tile_check</code> industry tile callback, though.
|-
| monthly_prod_change
|
See [[#Production change callback results|below]]
| Called each month to (possibly) change the industry production.
* <code style="color:darkgreen">extra_callback_info2</code>: 32 random bits.
|-
| random_prod_change
|
See [[#Production change callback results|below]]
| Works exactly the same as <code style="color:darkgreen">monthly_prod_change</code>, except that it's only called when TTD selects this industry for a random production change.
|-
| build_prod_change
| Value in range 4-128
| {{ottd|1.3|r24186}} Called when an industry is constructed. Return value is production level (default 16). Can also be used to initialise permanent storage when an industry is constructed.
|-
| cargo_subtype_display
| String or CB_RESULT_NO_TEXT
| This callback allows displaying some text after a cargo name. Returning CB_RESULT_NO_TEXT displays nothing.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: 0 .. 2 to get texts for the first .. third accepted cargo type, and 3 .. 4 for the first ... second produced cargo type.
* <code style="color:darkgreen">getbits(extra_callback_info2, 8, 8)</code>: 0 when getting a string for the buy menu (no industry variables available!), 1 when for the industry window and 2 for the industry directory window.
|-
| extra_text_industry
| String
| Show extra text in the industry window.
|-
| extra_text_fund
| String
| Show extra text in the fund window. Since the industry isn't built, no industry variables are available.
|-
| control_special
| 0 or 1
| Called to control various effects from the <code style="color:darkgreen">spec_flags</code> property. Currently only works for the first two (plant fields / cut trees). Return 1 to execute the action or 0 to not do so.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Queried effect.
The default (if the flag is enabled, of course) is to plant fields with 1/8th chance every 256 ticks, and to cut trees every 512 ticks.
|-
| stop_accept_cargo
| 0 or 1
| With this callback, you can temporarily refuse accepting a certain cargo, for example because the stockpile is full. Return 1 to accept or 0 to refuse. Make sure to synchronize this callback with the <code style="color:darkgreen">cargo_amount_accept</code> callback for industry tiles.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code> The cargo type to accept or not.
|-
| colour
| COLOUR_XXX
| Called after constructing the industry. The <code style="color:darkgreen">colour</code> variable is set to a random value at this point, you can use this callback to change this.
|-
| cargo_input
| Cargo type, or 0xFF
| Decide the input cargo types. Called repeatedly until 0xFF is returned, although currently not more than three times. Do not rely on this limitation, though.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>: Starts at 0 and is incremented for every iteration.
Return a cargo type (from the table) or 0xFF to stop.
|-
| cargo_output
| Cargo type, or 0xFF
| Same as <code style="color:darkgreen">cargo_input</code> above, except that it is applied to the output cargo types and currently not called more than twice.
|}

{{NML:LocationCheckResults}}

===Production change callback results===

{| class="t"
! value
! meaning
|-
| CB_RESULT_IND_PROD_NO_CHANGE
| Do not change industry production
|-
| CB_RESULT_IND_PROD_HALF
| Half industry production. If production goes below a quarter of default, the industry closes.
|-
| CB_RESULT_IND_PROD_DOUBLE
| Double production if it's not 8x default yet.
|-
| CB_RESULT_IND_PROD_CLOSE
| Announce closure and remove the industry next month.
|-
| CB_RESULT_IND_PROD_RANDOM
| Do a random production change, as if the industry is a primary one.
|-
| CB_RESULT_IND_PROD_DIVIDE_BY_4
| Divide production by 4
|-
| CB_RESULT_IND_PROD_DIVIDE_BY_8
| Divide production by 8
|-
| CB_RESULT_IND_PROD_DIVIDE_BY_16
| Divide production by 16
|-
| CB_RESULT_IND_PROD_DIVIDE_BY_32
| Divide production by 32
|-
| CB_RESULT_IND_PROD_MULTIPLY_BY_4
| Multiply production by 4
|-
| CB_RESULT_IND_PROD_MULTIPLY_BY_8
| Multiply production by 8
|-
| CB_RESULT_IND_PROD_MULTIPLY_BY_16
| Multiply production by 16
|-
| CB_RESULT_IND_PROD_MULTIPLY_BY_32
| Multiply production by 32
|-
| CB_RESULT_IND_PROD_DECREMENT_BY_1
| Decrement production by 1
|-
| CB_RESULT_IND_PROD_INCREMENT_BY_1
| Increment production by 1
|-
| CB_RESULT_IND_PROD_SET_BY_0x100
| Set the production level to the value in bits 16 .. 23 of register 0x100.
|}

Setting bit 7 of the result disables the associated news message. Setting bit 8 replaces the news message with a custom message, read from register 0x100 bits 0 .. 15.

===Industry creation types===

{| class="t"
! value
! meaning
|-
| IND_CREATION_GENERATION
| Industry is created during map generation, or when building 'many random industries' in the scenario editor.
|-
| IND_CREATION_RANDOM
| Industry is randomly generated during gameplay
|-
| IND_CREATION_FUND
| Industry is funded by the player (in game or scenario editor)
|-
| IND_CREATION_PROSPECT
| Industry is prospected by the player
|}

NML:Vehicles

2015-02-14T14:15:23Z

Alberth: Escape | in a table

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

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

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

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

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

==Properties common to all vehicle types==

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

To make a vehicle available in all climates except toyland you could use: <code style="color:green">ALL_CLIMATES & ~bitmask(CLIMATE_TOYLAND)</code>.
|-
| <code style="color:green">introduction_date</code>
| <code style="color:green">date</code>(yyyy,mm,dd)
| no
| Valid range for yyyy is 0 ... 5000000. In TTDPatch, dates after 2044 will be limited to 2044. Unless the engine is introduced within two years after game-start (always 1920 in TTDPatch), a random number of days between 0 and 511 will be added to this.
|-
| <code style="color:green">model_life</code>
| 0 ... 254 (years) or <code style="color:green">VEHICLE_NEVER_EXPIRES</code>
| no
|
Number of years a model is "supported" by the manufacturer, see [[#Engine life cycle|below]].
|-
| <code style="color:green">retire_early</code>
| -128 ... 127 (years)
| no
|
Retire the vehicle (make it unavailable in the purchase menu) this many years before reliability starts dropping, see [[#Engine life cycle|below]]. May be negative.
|-
| <code style="color:green">vehicle_life</code>
| 0 ... 255 (years)
| no
| Life length of an individual vehicle, before it is considered too old and in need of replacement.
|-
| <code style="color:green">reliability_decay</code>
| 0 ... 255
| no
| Default vehicles use 20. The higher the value the faster reliability decays, the more frequent service is needed. 0 means reliability never decreases if the vehicle is not too old
|-
| <code style="color:green">refittable_cargo_classes</code>
|
bit set of [[NML:Cargos#Cargo classes|cargo classes]]
| yes
| for example: <code style="color:darkgreen">bitmask(CC_BULK, CC_COVERED)</code>
|-
| <code style="color:green">non_refittable_cargo_classes</code>
|
bit set of [[NML:Cargos#Cargo classes|cargo classes]]
| yes
| for example: <code style="color:darkgreen">bitmask(CC_OVERSIZED, CC_SPECIAL)</code>
|-
| <code style="color:green">refittable_cargo_types</code>
| bit mask of entries into the cargo translation table
| yes
| As of NML 0.3, do not use this. Use cargo_[dis]allow_refit (see below) instead.
|-
| <code style="color:green">cargo_allow_refit</code>
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Yes
| {{ottdp|1.2|no|ottdrev=r23291}} A list of cargo types to allow refitting to, irrespective of cargo classes. Example: <code style="color:darkgreen">[COAL, IORE]</code>
|-
| <code style="color:green">cargo_disallow_refit</code>
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Yes
| {{ottdp|1.2|no|ottdrev=r23291}} A list of cargo types to disallow refitting to, irrespective of cargo classes. Example: <code style="color:darkgreen">[MAIL]</code>
|-
| <code style="color:green">loading_speed</code>
| 0 ... 255 (cargo units)
| yes
| Units of cargo loaded per time unit. Default vehicles use 5 for trains and road vehicles, 10 for ships and 20 for aircraft. This amount of cargo is loaded to or unloaded from the vehicle every 40 ticks for trains, every 20 ticks for road vehicles and aircraft and every 10 ticks for ships.
|-
| <code style="color:green">cost_factor</code>
| 0 ... 255
| Set to 0
| multiplier to the base purchase cost
|-
| <code style="color:green">running_cost_factor</code>
| 0 ... 255
| Set to 0
| multiplier to the base running costs
|-
| <code style="color:green">cargo_age_period</code>
| 0 ... 65535
| yes
|
{{ottd|1.2|r22713}} This property specifies after how many ticks cargo is aged. Default value is 185. 74 ticks is equal to 1 day.
|}

===Refittability===

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

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

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

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

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

===Engine life cycle===

The life cycle of a vehicle model consists of three phases, as outlined in the following table. When starting a new game, a random amount between 31 months and 17 years is added to the model life as well.

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

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

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

==Sorting vehicles in the purchase list==
This is a special property that is not encoded in an item/property-block like most other properties but it has it's own block instead. The syntax is as follows:

sort(<feature>, [<ID>, <ID>, <ID>...]);

The engines will be sorted in the given order on the position where originally the first element was. Say the original engine sorting is this: A B C D E and you use this code <code style="color:darkgreen">sort(FEAT_TRAINS, [D, B, A]);</code> the final sorting will be this: C D B A E

==Train properties==

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

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

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

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

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

==Road vehicle properties==

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

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

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

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

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

==Ship properties==

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

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

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

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

;EFFECT_SPAWN_MODEL_NONE
: Do not spawn any effects.
;EFFECT_SPAWN_MODEL_STEAM
: Gradually less effects when approaching max speed.
;EFFECT_SPAWN_MODEL_DIESEL
: Effect proportional to acceleration, no effect when idling at top speed.
;EFFECT_SPAWN_MODEL_ELECTRIC
: Random effect, gradually less likely when approaching max speed.
|}

==Aircraft properties==

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

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

==Vehicle variables==

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

===Variables without parameter===

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

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

===Variables that require an argument===

{| class="t"
! name
! Argument
! value range
! available in purchase list?
! comment
|-
| count_veh_id
| The vehicle ID to look for.
| 0..255
| No
| The number of vehicles in the current consist that have the given ID.
|-
| other_veh_curv_info
| Offset in the chain from the current vehicle.<ref name="offset">Argument range is -128..127. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.</ref>
| -4..4
| No
| Difference in direction between the other vehicle and this vehicle. Curvature to the right is positive. 1 unit is 45 degrees.
|-
| other_veh_is_hidden
| Offset in the chain from the current vehicle.<ref name="offset"/>
| [0 <nowiki>|</nowiki> 1]
| No
| 1 the other vehicle is hidden in a depot or tunnel, 0 otherwise
|-
| other_veh_x_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in X-position (top-right to bottom-left) between the other vehicle and this vehicle.
|-
| other_veh_y_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in Y-position (top-left to bottom-right) between the other vehicle and this vehicle.
|-
| other_veh_z_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in Z-position (upwards) between the other vehicle and this vehicle.
|}
<references/>

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

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

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

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

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

Additional to the number of effects, the callback result may specify these flags:
;<code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_CENTER</code>
:(Train and road vehicle only) If set, position effect relative to vehicle center instead of relative to vehicle sprite. (behaves the same for vehicles with length 8/8)
;<code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>
*If not set, the parameters to <code style="color:darkgreen">effect_sprite</code> describe longitudinal/transversal positions, which are rotate wrt. vehicle orientation.
*If set, the parameters to <code style="color:darkgreen">effect_sprite</code> describe X and Y positions, which are not automatically rotated.
|}

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

{| class="t"
! Name
! Available for
! In purchase menu?
! comment
|-
| loading_speed
| All
| No
|
|-
| speed
| All
| Yes, unless <code style="color:darkgreen">purchase_speed</code> is set separately
| Units are not (yet) available
|-
| cost_factor
| All
| Yes, only
|
|-
| running_cost_factor
| All
| Yes, unless <code style="color:darkgreen">purchase_running_cost_factor</code> is set separately
|
|-
| cargo_age_period
| All
| No
|
|-
| cargo_capacity
| All except aircraft
| Yes, unless <code style="color:darkgreen">purchase_cargo_capacity</code> is set separately
|
|-
| passenger_capacity
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_passenger_capacity</code> is set separately
|
|-
| mail_capacity
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_mail_capacity</code> is set separately
|
|-
| range
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_range</code> is set separately
|
|-
| visual_effect_and_powered
| Trains
| No
|
|-
| visual_effect
| Road Vehicles, Ships
| No
|
|-
| effect_spawn_model_and_powered
| Trains
| No
|
|-
| effect_spawn_model
| Road Vehicles, Ships
| No
|
|-
| power
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_power</code> is set separately
| Units are not (yet) available
|-
| weight
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_weight</code> is set separately
| Units are not (yet) available
|-
| length
| Trains, Road vehicles
| No
|
|-
| tractive_effort_coefficient
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_tractive_effort_coefficient</code> is set separately
| Value range is 0 .. 255 instead of 0 .. 1.
|-
| bitmask_vehicle_info
| Trains
| No
|
|}

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

===Sound events===

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

NML:Switch

2014-02-19T21:41:00Z

Alberth: let's call the feature a feature instead of an expression

{{NMLNavBlocksyntax}}

switch (<feature>, (SELF|PARENT), <ID>, <expression>) {
(<range>: <return_value>;)*
<return_value>;
}

The four parameters have the following meaning:

* <code style="color:darkgreen"><feature></code>: The feature for which this switch is used (see [[NML:Features|Features]]).
* <code style="color:darkgreen">(SELF|PARENT)</code>Which variables to use. SELF uses the variables of the item itself, while PARENT uses the variables of a related object. This related object differs per feature, refer to the table below.
* <code style="color:darkgreen"><ID></code>Name of this switch block. This (unique) name can be used to refer to the block from other switch- or graphics-blocks.
* <code style="color:darkgreen"><expression></code>The expression that will be evaluated to make a decision. This expression may contain variables. Instead of a single expression this may also be an array of expressions. In that case all of the array elements are evaluated in order and the last one is used to make a decision.

{| class="t"
! Feature
! SELF
! PARENT
! permanent storage
|-
| FEAT_TRAINS
| Engine / wagon / articulated part itself
| Front engine
| no
|-
| FEAT_ROADVEHS
| Road vehicle part
| First road vehicle part
| no
|-
| FEAT_SHIPS
| Ship
| Ship
| no
|-
| FEAT_AIRCRAFT
| Aircraft (a)
| Aircraft
| no
|-
| FEAT_STATIONS
| Station tile
| Town
| no
|-
| FEAT_CANALS
| Canal tile
| N/A
| no
|-
| FEAT_BRIDGES
| Bridge
| Town
| no
|-
| FEAT_HOUSES
| House tile
| Town
| no
|-
| FEAT_GLOBALVARS
| N/A
| N/A
| no
|-
| FEAT_INDUSTRYTILES
| Industry tile
| Industry to which the tile belongs
| no
|-
| FEAT_INDUSTRIES
| Industry
| Town
| yes
|-
| FEAT_CARGOS
| Cargo type
| N/A
| no
|-
| FEAT_SOUNDEFFECTS
| N/A
| N/A
| no
|-
| FEAT_AIRPORTS
| Airport
| N/A
| yes
|-
| FEAT_SIGNALS
| N/A
| N/A
| no
|-
| FEAT_OBJECTS
| Object tile
| Town
| no
|-
| FEAT_RAILTYPES
| Rail tile
| N/A
| no
|-
| FEAT_AIRPORTTILES
| Airport tile
| Airport
| no
|}

(a) Except for mail capacity callbacks, where it refers to the mail compartment. To refer to the aircraft itself, use PARENT scope there.

<code style="color:darkgreen"><range></code> can either be a single number or two numbers separated by two dots. In the first case, the range matches if the result of the computation is equal to the supplied value. If a range (<code style="color:darkgreen">a .. b</code>) is supplied, it matches if the computed result is within that range. If several lines of the switch block match the expression being tested the first applicable result will be returned.

Possible values for <code style="color:darkgreen"><return_value></code> are the following:

* <code style="color:darkgreen"><ID>;</code> chains to the (random-)switch or spritegroup with the given ID.
* <code style="color:darkgreen">return (<expression>|<string>);</code> returns the given expression or string as a result of the callback. A returned expression may contain variables (with the same scope as the switch block itself), parameter accesses and everything else that a normal switch-expression may contain.
* <code style="color:darkgreen">return;</code> returns the computed value directly as a callback result. Note that the maximum value for callback results is 32511 (0x7EFF).
* <code style="color:darkgreen">CB_FAILED;</code> stops processing and returns an explicit failure code.

Some example code is given below. Note that the code does not have an actual meaning, it is merely meant to demonstrate all the various options available.

<pre style="color:blue">
switch (FEAT_TRAINS, PARENT, some_vehicle_switch, (position_in_consist + param[1]) % 4) {
0..2: return string(STRING_FOO_BAR); //return a text message
3: return; //return the computed value
5..300: return 42; //42 is always a good answer
400: other_switch; //chain to some other switch block
401: return num_vehs_in_consist + 1; //return a value with a variable access
CB_FAILED; //return a failure result as default
}
</pre>

You can also use temporary variables and with some features also pemanent variables to store and retrieve some values by means of <code style="color:darkgreen">STORE_TEMP(value, register)</code>, <code style="color:darkgreen">LOAD_TEMP(register)</code> and <code style="color:darkgreen">STORE_PERM(value, register)</code> and <code style="color:darkgreen">LOAD_PERM(register[, grfid])</code> respectively. Using temporary storage is useful when you want to use the result of an expensive calculation in various decisions (switches) within the chain (like for example the number of a certain wagon type within a train). Permanent storage might be useful to control the long-term behaviour of an object. Note that it is only available for industries, airports and towns. For towns, you can optionally specify a grfid to load registers belonging to a different grf. Note that accessing (both reading and writing) permanent town registers thrashes the contents of temporary register 0x100.

{{nml|0.3}} As of NML 0.3 it is possible to specify the default value using <code>default: <value>;</code> as one of the 'ranges'. Specifying multiple default values (either this way or by the classical method) is of course not possible, but omitting a default value is allowed. In that case, if none of the ranges matches, the callback fails.

NML:Item

2014-02-02T10:37:20Z

Alberth: Fixed typo

{{NMLNavBlocksyntax}}

== General ==

item (<expression> [, <ID> [, <expression> [, <expression>]]]) {
(<property-block>|<graphics-block>|<livery_override-block>)+
}

The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. The meaning and relevance of this id differs per-feature, refer to the feature-specific pages for more information. The default value is -1, which lets NML pick an id for you. The fourth (optional) argument is the size, which is relevant for [[NML:Houses|houses]] only and explained there.

Example:

<pre style="color:blue">
item (FEAT_ROADVEHS, hereford_tram) {
property {
name: string(STR_NAME_HEREFORD_TRAM);
climates_available: ALL_CLIMATES;
introduction_date: date(1940,1,1);
speed: 60 km/h;
}
}
</pre>

== Property block ==

property {
(<ID>: (<string>|(<expression> [<unit>]));)+
}

This one looks a lot more complicated than it actually is. A property-block contains one or more assignments. Each assignment starts with the name of the property that is changed followed by a colon. After the colon follows the value and you end the line with a semicolon. The type of the value depends on the property, some properties require a string as value and some an expression. For some properties you can optionally specify a unit that is used to convert the value to the unit that is written to the output file. You can only use a unit if the expression is constant. [[NML:Units|List of valid units]]

== Graphics block ==

A graphics block must be placed in an item-block. It allows to define the graphics for a particular item, as well as various callbacks. Callbacks are used to define various things at run time, based on information (variables) of the item itself. This provides a much greater degree of flexibility than setting properties. An example (using fictional callback names):

<pre style="color:blue">
graphics {
callback_a: switch_a;
callback_b: return 42 + some_var;
default: some_spritegroup;
}
</pre>

The callbacks that are available differ per feature, refer to the feature-specific pages for more information. The 'default'-callback is usually used to resolve the graphics. For each callback a return value may be specified, in the same way as for [[NML:Switch| switch-blocks]]. Note that all callbacks have to be defined in a '''single''' graphics-block.

For vehicles and stations, a cargo type (identifier from the [[NML:Cargotable|cargo table]]) may be used as callback name, to provide cargo-specific graphics.

== Livery override ==

[[Image:NML liveryoverride.png|frame|left|Same cars, different engine, different car sprites]]

A livery override block offers the option to change the look and behaviour of a wagon depending on the engine it is attached to. It is basically the same as a graphics-block and its syntax is the same. The difference is that it only applies to a particular combination of an engine and a wagon. E.g. passenger wagons could adapt their livery to match the engine, to make the consist look like a multiple-unit train. The spritegroup needs to be defined before it can be used in a livery override. A livery override block is always part of the '''engine''' definition and looks like

livery_override (vehicleID) {
callback_name: switch_name;
callback_name2: return value;
default: spritegroup_name;
}

For an example see the [[NML:Spritegroup|spritegroup]]

NML talk:Block Example

2012-12-09T14:38:46Z

Alberth: added a comment about having wrong/duplicate information

This is wrong information, I got here by "Language Structure -> Blocks", so I expected an overview of the available blocks. Instead I get an almost copy of a part of NML:Block_syntax.
[[User:Alberth|Alberth]] 14:38, 9 December 2012 (UTC)

Action2/Sprite Layout

2011-08-05T14:17:36Z

Alberth: the combined sprites also missed a 11

= Action2 Sprite Layout =
{| |-
!Feature !! TTDPatch !! OpenTTD
|-
|Houses || 2.0.1 alpha ? || ?
|-
|Industry Tiles || ? || 0.6
|-
|Objects || 2.6 alpha r2023 || 1.1.0
|-
|Airport Tiles || not supported || 1.1.0
|}

This Action2 defines a spritelayout for a tile. There are two formats available:
* Basic format for a single groundsprite and a single building sprite.
* Extended format for combining multiple sprites.

== Basic format for tiles with a single building sprite ==

<pre> <Sprite-number> * <Length> 02 07/09/0F/11 <set-id> 00 <groundsprite> <buildingsprite> <xoffset> <yoffset> <xextent> <yextent> <zextent></pre>

{|
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<Sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action
|-
|02||B||Defines action 02
|-
|07/09/0F||B||feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 airport tiles
|-
|<set-id>||B||ID for this definition
|-
|00||B||Literal 0 (to distinguish this definition from random/variational lists)
|-
|<groundsprite>||D||Ground sprite for the building (see format below)
|-
|<buildingsprite>||D||The sprite of the building (see format below), can be zero to indicate that no building sprite should be displayed (useful for early building stages)
|-
|<xofs>||B||x-offset from northern tile corner (as a signed byte)
|-
|<yofs>||B||y-offset from northern tile corner (as a signed byte)
|-
|<xextent>||B||size of sprite in x direction
|-
|<yextent>||B||size of sprite in y direction
|-
|<zextent>||B||size of sprite in z direction
|}

In the above, xofs, yofs, xextent, yextent and zextent define the 3D bounding box of the building sprite not including the ground sprite. The z-offset is always zero for buildings (TTD doesn't support floating buildings). Please note that xofs/xextent and yofs/yextent pairs that place the bounding box off the tile are not recommended.

== Extended format using multiple combined sprites ==

Since TTDPatch 2.0.1 alpha 55 vcs 3, houses, industry (and object) tiles support an extended syntax as well, which looks as follows:

<pre><nowiki><Sprite-number> * <Length> 02 07/09/0F/11 <set-id> <num-sprites> <groundsprite> [<buildingsprite> (<xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>) | (<xpixeloffset> <ypixeloffset> 80)] ...</nowiki></pre>

{|
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<Sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action
|-
|02||B||Defines action 02
|-
|07/09/0F||B||feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 = airport tiles
|-
|<set-id>||B||ID for this definition
|-
|<num-sprites>||B||Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers (since OpenTTD r22518; to be documented).
|-
|<groundsprite>||D||Ground sprite for the building (see format below)
|-
|<buildingsprite>||D||The sprite to be drawn. Unlike the basic format, zero isn't allowed here.
|-
!colspan="3"| -- for sprites defining a new bounding box --
|-
|<xofs>||B||x-offset from northern tile corner (as a signed byte)
|-
|<yofs>||B||y-offset from northern tile corner (as a signed byte)
|-
|<zofs>||B||z-offset from the ground
|-
|<xextent>||B||size of sprite in x direction
|-
|<yextent>||B||size of sprite in y direction
|-
|<zextent>||B||size of sprite in z direction
|-
!colspan="3"| -- for sprites sharing their bounding box with the previous sprite --
|-
|<xpixeloffset>||B||x offset from the top left corner of the previous sprite
|-
|<ypixeloffset>||B||y offset from the top left corner of the previous sprite
|-
|80||B||a literal 80h byte to distinguish from new-bounding-box definitions
|}

Note: restrictions for sprites sharing their bounding box are the same as explained for [[Action0Stations#Sprite layout (09)|station tiles.]]

Since OpenTTD r18959 you can draw multiple ground sprites for a tile, which is useful if you want to use the usual grass/water/concrete groundtile, but still need to add features to it without using a new bounding box. To do so use the syntax of sprites sharing the previous bounding box, but use it before the first bounding box definition. xpixeloffset and ypixeloffset refer to the usual spot of groundtiles.

The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2313: TTDPatch ignores the xpixeloffset and ypixeloffset fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xpixeloffset and ypixeloffset zero to get the same effect in both games.

== Sprite definition ==

The ground and building sprite fields have the following format:

{|
!Bits!!Content
|-
|0-13||Sprite number, exact meaning specified by bit 31
|-
|14-15||0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite
|-
|16-29||Color translation special sprite number, see below
|-
|30||If set, sprite is drawn normally even in transparent buildings mode (for building sprites only; supported in TTDPatch 2.0.1 alpha 57 or later)
|-
|31||Sprite type, see below
|}

Since TTDPatch 2.0.1 alpha 57, the groundsprite value can be zero if no ground sprite is needed (this is useful if you need to draw custom foundations, see [[Callbacks#Decide drawing default foundations 30 14E 150|example]]). Ground sprites are always drawn normally, so bit 30 is ignored for them. Bit 30 may get a different meaning for ground sprites in a later version of TTDPatch, so please leave it zero for now. This does not apply to additional groundsprites using the "<xpixeloffset> <ypixeloffset> 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.

=== Colour translation special sprite number ===

This is used only if bits 14 or 15 are nonzero. Bits 16-29 must be the number of a regular TTD sprite containing a colour translation table (see below for available translation tables). For transparent mode, a suitable translation table is needed, e.g. that of TTD´s sprite number 802 (s.b.). See [[RecolorSprites]] for more information on the usage of transparent and recolouring sprites.

For houses, if no recolour sprite is given but recolouring is turned on in bits 14-15, there are two possibilities:
* If you have [[Callbacks#Building colour (1E) |callback 1E]] enabled, it is called to determine the colour mapping.
* If [[Callbacks#Building colour (1E) |callback 1E]] is disabled or fails, one of the colours specified in property 17 will be chosen randomly.

See [[RecolorSprites]] for a list of available colour translations.

For industry tiles, if this field is zero, but recolouring is turned on in bits 14 or 15, the colour of the containing industry will automatically be applied.

The ground sprite should be exactly the same size and shape as TTD's flat tile. In general, it shouldn't contain anything that has a z-dimension because any non-ground sprite will cover it.

Useful values for ground sprites:

{|
!Sprite number (decimal)!!Contents
|-
|3924||bare land
|-
|3981||grass
|-
|4061||water
|-
|4550||snow or desert (depending on climate)
|-
|1420||concrete
|}

Please note that all the ground sprite becomes visible in "transparent buildings" mode, so you should draw parts that seem to be hidden as well.

=== Sprite type ===

If bit 31 is clear, the bottom 14 bits contain a regular TTD sprite number.

If bit 31 is set, the bottom 14 bits contain a number of a sprite set in the most recent action 1, and the used sprite is decided according to the current construction state and the number of sprites in the set:
* if there's only one sprite, it's used always
* if there are two sprites, the first is used during construction (stages 0-2), and the second is used for the finished building (stage 3)
* if there are three sprites, the first will be used in the beginning of the construction (stage 0), the second will be used during the rest of the construction (stages 1 and 2) and the third will be used for the complete building (stage 3)
* if there are four or more sprites, the first four will be used for the four construction stages. Sprites after the first four are always ignored.

Action2/Sprite Layout

2011-08-05T13:02:47Z

Alberth: Missed one 11

= Action2 Sprite Layout =
{| |-
!Feature !! TTDPatch !! OpenTTD
|-
|Houses || 2.0.1 alpha ? || ?
|-
|Industry Tiles || ? || 0.6
|-
|Objects || 2.6 alpha r2023 || 1.1.0
|-
|Airport Tiles || not supported || 1.1.0
|}

This Action2 defines a spritelayout for a tile. There are two formats available:
* Basic format for a single groundsprite and a single building sprite.
* Extended format for combining multiple sprites.

== Basic format for tiles with a single building sprite ==

<pre> <Sprite-number> * <Length> 02 07/09/0F/11 <set-id> 00 <groundsprite> <buildingsprite> <xoffset> <yoffset> <xextent> <yextent> <zextent></pre>

{|
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<Sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action
|-
|02||B||Defines action 02
|-
|07/09/0F||B||feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 airport tiles
|-
|<set-id>||B||ID for this definition
|-
|00||B||Literal 0 (to distinguish this definition from random/variational lists)
|-
|<groundsprite>||D||Ground sprite for the building (see format below)
|-
|<buildingsprite>||D||The sprite of the building (see format below), can be zero to indicate that no building sprite should be displayed (useful for early building stages)
|-
|<xofs>||B||x-offset from northern tile corner (as a signed byte)
|-
|<yofs>||B||y-offset from northern tile corner (as a signed byte)
|-
|<xextent>||B||size of sprite in x direction
|-
|<yextent>||B||size of sprite in y direction
|-
|<zextent>||B||size of sprite in z direction
|}

In the above, xofs, yofs, xextent, yextent and zextent define the 3D bounding box of the building sprite not including the ground sprite. The z-offset is always zero for buildings (TTD doesn't support floating buildings). Please note that xofs/xextent and yofs/yextent pairs that place the bounding box off the tile are not recommended.

== Extended format using multiple combined sprites ==

Since TTDPatch 2.0.1 alpha 55 vcs 3, houses, industry (and object) tiles support an extended syntax as well, which looks as follows:

<pre><nowiki><Sprite-number> * <Length> 02 07/09/0F <set-id> <num-sprites> <groundsprite> [<buildingsprite> (<xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>) | (<xpixeloffset> <ypixeloffset> 80)] ...</nowiki></pre>

{|
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<Sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action
|-
|02||B||Defines action 02
|-
|07/09/0F||B||feature 7=town buildings, 9=industry tiles or 0F = objects
|-
|<set-id>||B||ID for this definition
|-
|<num-sprites>||B||Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers (since OpenTTD r22518; to be documented).
|-
|<groundsprite>||D||Ground sprite for the building (see format below)
|-
|<buildingsprite>||D||The sprite to be drawn. Unlike the basic format, zero isn't allowed here.
|-
!colspan="3"| -- for sprites defining a new bounding box --
|-
|<xofs>||B||x-offset from northern tile corner (as a signed byte)
|-
|<yofs>||B||y-offset from northern tile corner (as a signed byte)
|-
|<zofs>||B||z-offset from the ground
|-
|<xextent>||B||size of sprite in x direction
|-
|<yextent>||B||size of sprite in y direction
|-
|<zextent>||B||size of sprite in z direction
|-
!colspan="3"| -- for sprites sharing their bounding box with the previous sprite --
|-
|<xpixeloffset>||B||x offset from the top left corner of the previous sprite
|-
|<ypixeloffset>||B||y offset from the top left corner of the previous sprite
|-
|80||B||a literal 80h byte to distinguish from new-bounding-box definitions
|}

Note: restrictions for sprites sharing their bounding box are the same as explained for [[Action0Stations#Sprite layout (09)|station tiles.]]

Since OpenTTD r18959 you can draw multiple ground sprites for a tile, which is useful if you want to use the usual grass/water/concrete groundtile, but still need to add features to it without using a new bounding box. To do so use the syntax of sprites sharing the previous bounding box, but use it before the first bounding box definition. xpixeloffset and ypixeloffset refer to the usual spot of groundtiles.

The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2313: TTDPatch ignores the xpixeloffset and ypixeloffset fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xpixeloffset and ypixeloffset zero to get the same effect in both games.

== Sprite definition ==

The ground and building sprite fields have the following format:

{|
!Bits!!Content
|-
|0-13||Sprite number, exact meaning specified by bit 31
|-
|14-15||0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite
|-
|16-29||Color translation special sprite number, see below
|-
|30||If set, sprite is drawn normally even in transparent buildings mode (for building sprites only; supported in TTDPatch 2.0.1 alpha 57 or later)
|-
|31||Sprite type, see below
|}

Since TTDPatch 2.0.1 alpha 57, the groundsprite value can be zero if no ground sprite is needed (this is useful if you need to draw custom foundations, see [[Callbacks#Decide drawing default foundations 30 14E 150|example]]). Ground sprites are always drawn normally, so bit 30 is ignored for them. Bit 30 may get a different meaning for ground sprites in a later version of TTDPatch, so please leave it zero for now. This does not apply to additional groundsprites using the "<xpixeloffset> <ypixeloffset> 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.

=== Colour translation special sprite number ===

This is used only if bits 14 or 15 are nonzero. Bits 16-29 must be the number of a regular TTD sprite containing a colour translation table (see below for available translation tables). For transparent mode, a suitable translation table is needed, e.g. that of TTD´s sprite number 802 (s.b.). See [[RecolorSprites]] for more information on the usage of transparent and recolouring sprites.

For houses, if no recolour sprite is given but recolouring is turned on in bits 14-15, there are two possibilities:
* If you have [[Callbacks#Building colour (1E) |callback 1E]] enabled, it is called to determine the colour mapping.
* If [[Callbacks#Building colour (1E) |callback 1E]] is disabled or fails, one of the colours specified in property 17 will be chosen randomly.

See [[RecolorSprites]] for a list of available colour translations.

For industry tiles, if this field is zero, but recolouring is turned on in bits 14 or 15, the colour of the containing industry will automatically be applied.

The ground sprite should be exactly the same size and shape as TTD's flat tile. In general, it shouldn't contain anything that has a z-dimension because any non-ground sprite will cover it.

Useful values for ground sprites:

{|
!Sprite number (decimal)!!Contents
|-
|3924||bare land
|-
|3981||grass
|-
|4061||water
|-
|4550||snow or desert (depending on climate)
|-
|1420||concrete
|}

Please note that all the ground sprite becomes visible in "transparent buildings" mode, so you should draw parts that seem to be hidden as well.

=== Sprite type ===

If bit 31 is clear, the bottom 14 bits contain a regular TTD sprite number.

If bit 31 is set, the bottom 14 bits contain a number of a sprite set in the most recent action 1, and the used sprite is decided according to the current construction state and the number of sprites in the set:
* if there's only one sprite, it's used always
* if there are two sprites, the first is used during construction (stages 0-2), and the second is used for the finished building (stage 3)
* if there are three sprites, the first will be used in the beginning of the construction (stage 0), the second will be used during the rest of the construction (stages 1 and 2) and the third will be used for the complete building (stage 3)
* if there are four or more sprites, the first four will be used for the four construction stages. Sprites after the first four are always ignored.

Action2/Sprite Layout

2011-08-05T13:01:49Z

Alberth: added 11 airport tiles to the feature description

= Action2 Sprite Layout =
{| |-
!Feature !! TTDPatch !! OpenTTD
|-
|Houses || 2.0.1 alpha ? || ?
|-
|Industry Tiles || ? || 0.6
|-
|Objects || 2.6 alpha r2023 || 1.1.0
|-
|Airport Tiles || not supported || 1.1.0
|}

This Action2 defines a spritelayout for a tile. There are two formats available:
* Basic format for a single groundsprite and a single building sprite.
* Extended format for combining multiple sprites.

== Basic format for tiles with a single building sprite ==

<pre> <Sprite-number> * <Length> 02 07/09/0F <set-id> 00 <groundsprite> <buildingsprite> <xoffset> <yoffset> <xextent> <yextent> <zextent></pre>

{|
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<Sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action
|-
|02||B||Defines action 02
|-
|07/09/0F||B||feature 7=town buildings, 9=industry tiles, 0F = objects, or 11 airport tiles
|-
|<set-id>||B||ID for this definition
|-
|00||B||Literal 0 (to distinguish this definition from random/variational lists)
|-
|<groundsprite>||D||Ground sprite for the building (see format below)
|-
|<buildingsprite>||D||The sprite of the building (see format below), can be zero to indicate that no building sprite should be displayed (useful for early building stages)
|-
|<xofs>||B||x-offset from northern tile corner (as a signed byte)
|-
|<yofs>||B||y-offset from northern tile corner (as a signed byte)
|-
|<xextent>||B||size of sprite in x direction
|-
|<yextent>||B||size of sprite in y direction
|-
|<zextent>||B||size of sprite in z direction
|}

In the above, xofs, yofs, xextent, yextent and zextent define the 3D bounding box of the building sprite not including the ground sprite. The z-offset is always zero for buildings (TTD doesn't support floating buildings). Please note that xofs/xextent and yofs/yextent pairs that place the bounding box off the tile are not recommended.

== Extended format using multiple combined sprites ==

Since TTDPatch 2.0.1 alpha 55 vcs 3, houses, industry (and object) tiles support an extended syntax as well, which looks as follows:

<pre><nowiki><Sprite-number> * <Length> 02 07/09/0F <set-id> <num-sprites> <groundsprite> [<buildingsprite> (<xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>) | (<xpixeloffset> <ypixeloffset> 80)] ...</nowiki></pre>

{|
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<Sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action
|-
|02||B||Defines action 02
|-
|07/09/0F||B||feature 7=town buildings, 9=industry tiles or 0F = objects
|-
|<set-id>||B||ID for this definition
|-
|<num-sprites>||B||Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers (since OpenTTD r22518; to be documented).
|-
|<groundsprite>||D||Ground sprite for the building (see format below)
|-
|<buildingsprite>||D||The sprite to be drawn. Unlike the basic format, zero isn't allowed here.
|-
!colspan="3"| -- for sprites defining a new bounding box --
|-
|<xofs>||B||x-offset from northern tile corner (as a signed byte)
|-
|<yofs>||B||y-offset from northern tile corner (as a signed byte)
|-
|<zofs>||B||z-offset from the ground
|-
|<xextent>||B||size of sprite in x direction
|-
|<yextent>||B||size of sprite in y direction
|-
|<zextent>||B||size of sprite in z direction
|-
!colspan="3"| -- for sprites sharing their bounding box with the previous sprite --
|-
|<xpixeloffset>||B||x offset from the top left corner of the previous sprite
|-
|<ypixeloffset>||B||y offset from the top left corner of the previous sprite
|-
|80||B||a literal 80h byte to distinguish from new-bounding-box definitions
|}

Note: restrictions for sprites sharing their bounding box are the same as explained for [[Action0Stations#Sprite layout (09)|station tiles.]]

Since OpenTTD r18959 you can draw multiple ground sprites for a tile, which is useful if you want to use the usual grass/water/concrete groundtile, but still need to add features to it without using a new bounding box. To do so use the syntax of sprites sharing the previous bounding box, but use it before the first bounding box definition. xpixeloffset and ypixeloffset refer to the usual spot of groundtiles.

The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2313: TTDPatch ignores the xpixeloffset and ypixeloffset fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xpixeloffset and ypixeloffset zero to get the same effect in both games.

== Sprite definition ==

The ground and building sprite fields have the following format:

{|
!Bits!!Content
|-
|0-13||Sprite number, exact meaning specified by bit 31
|-
|14-15||0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite
|-
|16-29||Color translation special sprite number, see below
|-
|30||If set, sprite is drawn normally even in transparent buildings mode (for building sprites only; supported in TTDPatch 2.0.1 alpha 57 or later)
|-
|31||Sprite type, see below
|}

Since TTDPatch 2.0.1 alpha 57, the groundsprite value can be zero if no ground sprite is needed (this is useful if you need to draw custom foundations, see [[Callbacks#Decide drawing default foundations 30 14E 150|example]]). Ground sprites are always drawn normally, so bit 30 is ignored for them. Bit 30 may get a different meaning for ground sprites in a later version of TTDPatch, so please leave it zero for now. This does not apply to additional groundsprites using the "<xpixeloffset> <ypixeloffset> 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.

=== Colour translation special sprite number ===

This is used only if bits 14 or 15 are nonzero. Bits 16-29 must be the number of a regular TTD sprite containing a colour translation table (see below for available translation tables). For transparent mode, a suitable translation table is needed, e.g. that of TTD´s sprite number 802 (s.b.). See [[RecolorSprites]] for more information on the usage of transparent and recolouring sprites.

For houses, if no recolour sprite is given but recolouring is turned on in bits 14-15, there are two possibilities:
* If you have [[Callbacks#Building colour (1E) |callback 1E]] enabled, it is called to determine the colour mapping.
* If [[Callbacks#Building colour (1E) |callback 1E]] is disabled or fails, one of the colours specified in property 17 will be chosen randomly.

See [[RecolorSprites]] for a list of available colour translations.

For industry tiles, if this field is zero, but recolouring is turned on in bits 14 or 15, the colour of the containing industry will automatically be applied.

The ground sprite should be exactly the same size and shape as TTD's flat tile. In general, it shouldn't contain anything that has a z-dimension because any non-ground sprite will cover it.

Useful values for ground sprites:

{|
!Sprite number (decimal)!!Contents
|-
|3924||bare land
|-
|3981||grass
|-
|4061||water
|-
|4550||snow or desert (depending on climate)
|-
|1420||concrete
|}

Please note that all the ground sprite becomes visible in "transparent buildings" mode, so you should draw parts that seem to be hidden as well.

=== Sprite type ===

If bit 31 is clear, the bottom 14 bits contain a regular TTD sprite number.

If bit 31 is set, the bottom 14 bits contain a number of a sprite set in the most recent action 1, and the used sprite is decided according to the current construction state and the number of sprites in the set:
* if there's only one sprite, it's used always
* if there are two sprites, the first is used during construction (stages 0-2), and the second is used for the finished building (stage 3)
* if there are three sprites, the first will be used in the beginning of the construction (stage 0), the second will be used during the rest of the construction (stages 1 and 2) and the third will be used for the complete building (stage 3)
* if there are four or more sprites, the first four will be used for the four construction stages. Sprites after the first four are always ignored.

Talk:GRFActionsDetailed

2011-08-05T12:13:17Z

Alberth: Suggested move of grfcodec escape sequences to a grfcodec page

The list of grfcodec escape sequences are perhaps better moved to a page about the grfcodec program
[[User:Alberth|Alberth]] 12:13, 5 August 2011 (UTC)