Difference between revisions of "CargoTypes"
From GRFSpecs
Jump to navigationJump to search (rv - by all means remove the ECS and FIRS info if that is out of date, but the table of original cargos is still useful, especially for those of us updating older GRFs.) |
|||
| Line 1: | Line 1: | ||
| − | '''Cargo |
+ | '''Cargo labels in OpenTTD''' |
| + | {{grf|8}} In GRF version 8 the value to be used in all vehicle and industry properties, and in [[Action3|action 3]], is the position of the cargo label in the [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]] included in the GRF. |
||
| − | Definitions of cargo types used in TTD and the Patch |
||
| + | {{grf|7}} GRF version 7 and below used different cargo properties for different properties (called "Type A" or "translated" and "Type B" or "untranslated" cargo slots), for historical reasons. This method is deprecated as it meant relying blindly on cargos always using the same slots. You can see the table of Type A and Type B slots [http://newgrf-specs.tt-wiki.net/index.php?title=CargoTypes&oldid=2861 here] if you really want to. |
||
| − | For setting the various action 0 properties of vehicles, various way of specifying the cargo type are used. Typically, there is one property that sets the default cargo type, and another property that sets the cargo types available for refitting in a bit mask. |
||
| − | |||
| − | The following table lists the values to use for these properties, as well as the values to use for [[Action3|action 3]]. |
||
| − | |||
| − | {| class="wikitable |
||
| − | |- |
||
| − | ! Column |
||
| − | ! Name |
||
| − | ! Usage |
||
| − | |- |
||
| − | | Type A |
||
| − | | Cargo bit |
||
| − | | Use this cargo type in action 3. |
||
| − | |||
| − | {{grf|8}} In GRF version 8 and above this type is also used for the 'default cargo type' of vehicles. |
||
| − | |||
| − | When using a [[Action0/Global Settings#Cargo_translation_table_.2809.29|cargo translation table]], this is the position in the translation table. If there is no cargo translation table, the cargo bit is defined by property 08 for new cargos. |
||
| − | |- |
||
| − | | Bit value |
||
| − | | |
||
| − | | Add these bit values to find the value to give the refit mask property (this is -+1 << cargobit+-) |
||
| − | |- |
||
| − | | Type B |
||
| − | | Cargo slot |
||
| − | | {{grf|7}} For GRF version 7 an below use this cargo type to set the default cargo type of vehicles (note, this is climate dependent!). |
||
| − | |||
| − | {{grf|8}} For GRF version 8 and above this type is used nowhere, except in the cargo definition itself. |
||
| − | |||
| − | For new cargos this is the ID used in Action 0 and Action 3 of the cargo-defining NewGRF. |
||
| − | |} |
||
| − | |||
| − | Note, when New Cargos are being used, you can only rely on Type A values when using a cargo translation table. Type B values depend on the actual NewGRF (and its version) defining the new cargos; so, unless you test for a specific (industry) NewGRF you cannot rely on any value for Type B. |
||
| − | |||
| − | {{grf|7}} For GRF version 7 and below that means, to be compatible to any new cargos, you have to set the default cargo of refittable vehicles to "first refittable". However, you can kind of rely on passengers being slot 0 and mail being slot 2. |
||
| − | |||
| − | |||
| − | {| class="wikitable |
||
| − | |- |
||
| − | ! Type A |
||
| − | ! Bit Value |
||
| − | ! Type B |
||
| − | ! Cargo |
||
| − | ! style="background: #FFA020; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS] |
||
| − | ! style="background: #0000C0; color: white" | Type B |
||
| − | ! style="background: #0CDDA0; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS] |
||
| − | |- |
||
| − | | 00 |
||
| − | | 1 |
||
| − | | 00 |
||
| − | | Passengers |
||
| − | | + |
||
| − | | 00 |
||
| − | | + |
||
| − | |- |
||
| − | | 01 |
||
| − | | 2 |
||
| − | | 01 |
||
| − | | Coal |
||
| − | | + |
||
| − | | 01 |
||
| − | | + |
||
| − | |- |
||
| − | | 02 |
||
| − | | 4 |
||
| − | | 02 |
||
| − | | Mail |
||
| − | | + |
||
| − | | 02 |
||
| − | | + |
||
| − | |- |
||
| − | | 03 |
||
| − | | 8 |
||
| − | | 03 |
||
| − | | Oil |
||
| − | | + |
||
| − | | 03 |
||
| − | | + |
||
| − | |- |
||
| − | | 04 |
||
| − | | 10 |
||
| − | | 04 |
||
| − | | Livestock |
||
| − | | + |
||
| − | | 04 |
||
| − | | + |
||
| − | |- |
||
| − | | 05 |
||
| − | | 20 |
||
| − | | 05 |
||
| − | | Goods |
||
| − | | + |
||
| − | | 05 |
||
| − | | + |
||
| − | |- |
||
| − | | 06 |
||
| − | | 40 |
||
| − | | 06 |
||
| − | | Grain/Wheat/Maize |
||
| − | | + |
||
| − | | 06 |
||
| − | | + |
||
| − | |- |
||
| − | | 07 |
||
| − | | 80 |
||
| − | | 07 |
||
| − | | Wood |
||
| − | | + |
||
| − | | 07 |
||
| − | | + |
||
| − | |- |
||
| − | | 08 |
||
| − | | 100 |
||
| − | | 08 |
||
| − | | Iron Ore |
||
| − | | + |
||
| − | | 08 |
||
| − | | + |
||
| − | |- |
||
| − | | 09 |
||
| − | | 200 |
||
| − | | 09 |
||
| − | | Steel |
||
| − | | + |
||
| − | | 09 |
||
| − | | + (Metal) |
||
| − | |- |
||
| − | | 0A |
||
| − | | 400 |
||
| − | | 0A |
||
| − | | Valuables/Gold/Diamonds |
||
| − | | + |
||
| − | | 0A |
||
| − | | Milk |
||
| − | |- |
||
| − | | 0B |
||
| − | | 800 |
||
| − | | 09 |
||
| − | | Paper |
||
| − | | Food |
||
| − | | 0B |
||
| − | | Food |
||
| − | |- |
||
| − | | 0C |
||
| − | | 1000 |
||
| − | | 0B |
||
| − | | Food |
||
| − | | Paper |
||
| − | | 0C |
||
| − | | Raw Sugar |
||
| − | |- |
||
| − | | 0D |
||
| − | | 2000 |
||
| − | | 04 |
||
| − | | Fruit |
||
| − | | + |
||
| − | | 0D |
||
| − | | Fruit and Vegetables |
||
| − | |- |
||
| − | | 0E |
||
| − | | 4000 |
||
| − | | 08 |
||
| − | | Copper Ore |
||
| − | | Fish |
||
| − | | 0E |
||
| − | | Fish |
||
| − | |- |
||
| − | | 0F |
||
| − | | 8000 |
||
| − | | 09 |
||
| − | | Water |
||
| − | | Wool |
||
| − | | 0F |
||
| − | | Wool |
||
| − | |- |
||
| − | | 10 |
||
| − | | 10000 |
||
| − | | 01 |
||
| − | | Rubber |
||
| − | | Potash |
||
| − | | 10 |
||
| − | | Clay |
||
| − | |- |
||
| − | | 11 |
||
| − | | 20000 |
||
| − | | 01 |
||
| − | | Sugar |
||
| − | | Sand |
||
| − | | 11 |
||
| − | | Sand |
||
| − | |- |
||
| − | | 12 |
||
| − | | 40000 |
||
| − | | 03 |
||
| − | | Toys |
||
| − | | Glass/Ceramics |
||
| − | | 12 |
||
| − | | Manufacturing Supplies |
||
| − | |- |
||
| − | | 13 |
||
| − | | 80000 |
||
| − | | 04 |
||
| − | | Batteries |
||
| − | | Wood products |
||
| − | | 13 |
||
| − | | Lumber |
||
| − | |- |
||
| − | | 14 |
||
| − | | 100000 |
||
| − | | 05 |
||
| − | | Candy (Sweets) |
||
| − | | Dyes |
||
| − | | 14 |
||
| − | | Scrap Metal |
||
| − | |- |
||
| − | | 15 |
||
| − | | 200000 |
||
| − | | 06 |
||
| − | | Toffee |
||
| − | | Fertiliser |
||
| − | | 15 |
||
| − | | Farm Supplies |
||
| − | |- |
||
| − | | 16 |
||
| − | | 400000 |
||
| − | | 07 |
||
| − | | Cola |
||
| − | | Oil seeds |
||
| − | | 16 |
||
| − | | Plant Fibres |
||
| − | |- |
||
| − | | 17 |
||
| − | | 800000 |
||
| − | | 08 |
||
| − | | Cotton Candy (Candyfloss) |
||
| − | | Refined products |
||
| − | | 17 |
||
| − | | Chemicals |
||
| − | |- |
||
| − | | 18 |
||
| − | | 1000000 |
||
| − | | 09 |
||
| − | | Bubbles |
||
| − | | Vehicles |
||
| − | | 18 |
||
| − | | Engineering Supplies |
||
| − | |- |
||
| − | | 19 |
||
| − | | 2000000 |
||
| − | | 0A |
||
| − | | Plastic |
||
| − | | Petrol |
||
| − | | 19 |
||
| − | | Petrol |
||
| − | |- |
||
| − | | 1A |
||
| − | | 4000000 |
||
| − | | 0B |
||
| − | | Fizzy Drinks |
||
| − | | Bricks |
||
| − | | 1A |
||
| − | | Gravel |
||
| − | |- |
||
| − | | 1B |
||
| − | | 8000000 |
||
| − | | 0B |
||
| − | | Paper<ref name="moreindustries">Only in temperate climate, with the "moreindustriesperclimate" switch, i.e. disabled when "newcargos" is switched on.</ref> |
||
| − | | Sulphur |
||
| − | | 1B |
||
| − | | Bauxite |
||
| − | |- |
||
| − | | 1C |
||
| − | | 10000000 |
||
| − | | 08 |
||
| − | | undefined; unused slot in arctic climate |
||
| − | | Cement |
||
| − | | 1C |
||
| − | | Building Materials |
||
| − | |- |
||
| − | | 1D |
||
| − | | 20000000 |
||
| − | | - |
||
| − | | undefined; unused slot |
||
| − | | Fibre crops |
||
| − | | 1D |
||
| − | | Alcohol |
||
| − | |- |
||
| − | | 1E |
||
| − | | 40000000 |
||
| − | | - |
||
| − | | undefined; unused slot |
||
| − | | Lime stone |
||
| − | | 1E |
||
| − | | Reserved1 |
||
| − | |- |
||
| − | | 1F |
||
| − | | 80000000 |
||
| − | | - |
||
| − | | undefined; unused slot |
||
| − | | Tourists |
||
| − | | 1F |
||
| − | | Reserved2 |
||
| − | |- |
||
| − | | FF |
||
| − | | n/a |
||
| − | | FF |
||
| − | | colspan="4" | Use first <ref name="firstrefittable">{{grf|7}} For GRF version 7 and below "first" means first wrt. cargo slot, type B. I.e. this is purely up to the cargo-defining NewGRF and cannot be influenced by the vehicle NewGRF.<br/>{{grf|8}}For GRF version 8 and above "first" means the first wrt. (translated) cargo bit, type A. Thus the cargo translation table of the vehicle GRF defines the order.</ref> refittable cargo type as default cargo. See also [[VehicleRefitting|vehicle refitting]]. |
||
| − | |- |
||
| − | | FE |
||
| − | | n/a |
||
| − | | n/a |
||
| − | | colspan="4" | Used in action 3 for stations to disable default |
||
| − | |- |
||
| − | | FF |
||
| − | | n/a |
||
| − | | n/a |
||
| − | | colspan="4" | Shown in purchase list |
||
| − | |} |
||
| − | |||
| − | <references /> |
||
== Cargo Labels == |
== Cargo Labels == |
||
Revision as of 13:51, 24 February 2012
Cargo labels in OpenTTD
GRFv8 In GRF version 8 the value to be used in all vehicle and industry properties, and in action 3, is the position of the cargo label in the cargo translation table included in the GRF.
GRFv7 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 here if you really want to.
Cargo Labels
The following cargo labels have been defined so far:
| Label | Cargo Description | Cargo classes | Notes | ||
|---|---|---|---|---|---|
| TTD Default Cargos | These cargos are present when no NewGRF is used | ||||
| PASS | Passengers | 0001 Passengers | ECS | FIRS | |
| COAL | Coal | 0010 Bulk | ECS | FIRS | |
| 0002 Mail | ECS | FIRS | |||
| OIL_ | Oil | 0040 Liquid | ECS | FIRS | |
| LVST | Livestock | 0020 Piece goods | ECS | FIRS | |
| GOOD | Goods | 0004 Express | ECS | FIRS | |
| GRAI | Grain | 0010 Bulk | FIRS | Temperate; see also WHEA, MAIZ, CERE | |
| WOOD | Wood | 0020 Piece goods | ECS | FIRS | |
| IORE | Iron Ore | 0010 Bulk | ECS | FIRS | |
| STEL | Steel | 0020 Piece goods | ECS | FIRS | Renamed "Metal" in FIRS. |
| VALU | Valuables | 0008 Armoured | ECS | Temperate; see also GOLD, DIAM | |
| PAPR | Paper | 0020 Piece goods | ECS | ||
| WHEA | Wheat | 0010 Bulk | Arctic; see also GRAI, MAIZ, CERE | ||
| FOOD | Food | 0084 Express, refrigerated | ECS | FIRS | |
| GOLD | Gold | 0008 Armoured | ECS | Arctic; see also VALU, DIAM | |
| RUBR | Rubber | 0040 Liquid | ECS | ||
| FRUT | Fruit | 0090 Bulk, refrigerated | ECS | ||
| MAIZ | Maize | 0010 Bulk | Tropic; see also GRAI, WHEA, CERE | ||
| CORE | Copper Ore | 0010 Bulk | ECS | ||
| WATR | Water | 0040 Liquid | ECS | ||
| DIAM | Diamonds | 0008 Armoured | ECS | Tropic; see also VALU, GOLD | |
| SUGR | Sugar | 0010 Bulk | Toyland | ||
| TOYS | Toys | 0020 Piece goods | Toyland | ||
| BATT | Batteries | 0020 Piece goods | Toyland | ||
| SWET | Sweets (Candy) | 0004 Express | Toyland | ||
| TOFF | Toffee | 0010 Bulk | Toyland | ||
| COLA | Cola | 0040 Liquid | Toyland | ||
| CTCD | Cotton Candy (Candyfloss) | 0010 Bulk | Toyland | ||
| BUBL | Bubbles | 0020 Piece goods | Toyland | ||
| PLST | Plastic | 0040 Liquid | Toyland; see also PLAS | ||
| FZDR | Fizzy Drinks | 0020 Piece goods | Toyland | ||
| New Cargos | these cargos are only present when NewGRF industry sets are used | ||||
| AORE | Bauxite (Aluminium ore) | 0010 Bulk | ECS | FIRS | |
| BEER | Alcohol | 0064 Express, piece goods, liquids | FIRS | ||
| BDMT | Building Materials | 0220 Piece goods, covered/sheltered | ECS | FIRS | |
| BRCK | Bricks | 0020 Piece goods | ECS | ||
| CERA | Ceramics | 0020 Piece goods | ECS | ||
| CERE | Cereals | 0210 Bulk, covered/sheltered | ECS | [1] | |
| CLAY | Clay | 0210 Bulk covered/sheltered | FIRS | ||
| CMNT | Cement | 0210 Bulk covered/sheltered | ECS | ||
| COPR | Copper | 0020 Piece goods | |||
| DYES | Dyes | 0060 Piece goods, liquids | ECS | ||
| ENSP | Engineering Supplies | 0024 Express, piece goods | FIRS | ||
| FERT | Fertiliser | 0030 Bulk, piece goods | ECS | [1] | |
| FICR | Fibre crops | 0030 Bulk, piece goods | ECS | FIRS | |
| FISH | Fish | 0084 Express, refrigerated | ECS | FIRS | |
| FMSP | Farm Supplies | 0024 Express, piece goods | FIRS | ||
| FRVG | Fruit (and optionally Vegetables) | 00A4 Express, piece goods, refrigerated | FIRS | ||
| GLAS | Glass | 0420 Piece goods, oversized | ECS | ||
| GRVL | Gravel / Ballast | 0010 Bulk | FIRS | ||
| LIME | Lime stone | 0010 Bulk | ECS | ||
| MILK | Milk | 00C4 Express, liquid, refrigerated | FIRS | ||
| MNSP | Manufacturing Supplies | 0024 Piece Goods, express | FIRS | ||
| OLSD | Oil seed | 0210 Bulk, covered/sheltered | ECS | [1] | |
| PETR | Petrol / Fuel Oil | 0040 Liquid | ECS | FIRS | |
| PLAS | Plastic | 0060 Piece goods, liquid | ECS | ||
| POTA | Potash | 0210 Bulk, covered/sheltered | ECS | [1] | |
| RCYC | Recyclables | 0220 Piece Goods, covered | FIRS | ||
| RFPR | Refined products | 0040 Liquid | ECS | FIRS | |
| SAND | Sand | 0010 Bulk | ECS | FIRS | |
| SCMT | Scrap Metal | 0010 Bulk | FIRS | ||
| SGBT | Sugar beet | 0010 Bulk | FIRS | not in tropical | |
| SGCN | Sugarcane | 0010 Bulk | FIRS | only tropical | |
| SULP | Sulphur | 0210 Bulk, covered/sheltered | ECS | [1] | |
| TOUR | Tourists | 0005 Passengers, express | ECS | ||
| VEHI | Vehicles | 0420 Piece goods, oversized | ECS | ||
| WDPR | Wood Products | 0030 Bulk, piece goods | ECS | FIRS | |
| WOOL | Wool | 0220 Piece goods, covered/sheltered | ECS | FIRS | [1] |
| Special Cargos | these cargos are for use outside industry sets and do not represent transporting anything | ||||
| GEAR | Locomotive regearing | 8000 Special | Using this cargo may make your vehicle set incompatible with some industry sets
use CB36 instead to set capacity to 0 | ||
| Deprecated Cargos | these cargos are not used by any current industry set, and are listed here for backwards compatibility | ||||
| FUEL | Fuel | 0040 Liquid | Use PETR for refined-oil fuel | ||
| RSGR | Raw Sugar | 0010 Bulk | Deprecated in FIRS. See SGBT and SGCN | ||
| SCRP | Scrap Metal | 0010 Piece Goods | Deprecated in FIRS, use SCMT instead | ||
| TWOD | Tropic Wood | 0020 Piece goods | formerly intended as a default cargo | ||
| WSTE | Waste | 0010 Bulk | Deprecated in FIRS. | ||
If you write or publish a NewGRF which introduces a new cargo label, please also add a comment where the new label is used.
