Difference between revisions of "CargoTypes"

From GRFSpecs
Jump to navigationJump to search
(Updates to tabel syntax)
m (Updates to tablesyntax)
Line 314: Line 314:
 
|}
 
|}
   
<pre>*</pre> Only in temperate climate, with moreindustriesperclimate switch, i.e. disabled when &quot;newcargos&quot; switched on
+
<nowiki>*Only in temperate climate, with moreindustriesperclimate switch, i.e. disabled when &quot;newcargos&quot; switched on.</nowiki>
  +
<pre>**</pre> &quot;first&quot; 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.
+
<nowiki>** &quot;first&quot; 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.</nowiki>
   
   

Revision as of 13:02, 13 June 2011

Cargo types in TTD

Cargo Types in TTD

Definitions of cargo types used in TTD and the patch

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

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

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

Note, when New Cargos are being used, you can only rely on Type A values when using a cargo translation table. Type B values depend on the actual NewGRF (and its version) defining the new cargos; so, unless you test for a specific (industry) NewGRF you cannot rely on any value for Type B. That means, to be compatible to any new cargos, you have to set the default cargo of refittable vehicles to "first refittable". However, you can kind of rely on passengers being slot 0 and mail being slot 2.


Type A Bit Value Type B Cargo ECS Type B 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 +
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 Fibre crops
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* Sulphur 1B Bauxite
1C 10000000 08 undefined; unused slot in arctic climate Cement 1C Building Materials
1D 20000000 - undefined; unused slot Fibre crops 1D Reserved1
1E 40000000 - undefined; unused slot Lime stone 1E Reserved2
1F 80000000 - undefined; unused slot Tourists 1F Reserved3
n/a n/a FF Use first (**) refittable cargo type as default cargo. See also vehicle refitting.
FE n/a n/a Used in action 3 for stations to disable default
FF n/a n/a Shown in purchase list

*Only in temperate climate, with moreindustriesperclimate switch, i.e. disabled when "newcargos" switched on.

** "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.


Cargo Labels

The following cargo labels have been defined so far:

||Label|Cargo description|Cargo classes|Notes

TTD Default Cargos

PASS|Passengers|0001 Passengers |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | COAL|Coal|0010 Bulk |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | MAIL|Mail|0002 Mail |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | OIL_|Oil|0040 Liquid |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | LVST|Livestock|0020 Piece goods |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | GOOD|Goods|0004 Express|{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | GRAI|Grain|0010 Bulk | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} |Temperate; see also WHEA, MAIZ, CERE WOOD|Wood|0020 Piece goods |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | IORE|Iron Ore|0010 Bulk |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | STEL|Steel|0020 Piece goods |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | VALU|Valuables|0008 Armoured |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |Temperate; see also GOLD, DIAM PAPR|Paper|0020 Piece goods |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |

WHEA|Wheat|0010 Bulk | | |Arctic; see also GRAI, MAIZ, CERE

FOOD|Food|0084 Express, refrigerated |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | | GOLD|Gold|0008 Armoured |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |Arctic; see also VALU, DIAM RUBR|Rubber|0040 Liquid |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | | FRUT|Fruit|0090 Bulk, refrigerated |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |

MAIZ|Maize|0010 Bulk | | |Tropic; see also GRAI, WHEA, CERE

CORE|Copper Ore|0010 Bulk |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | | WATR|Water|0040 Liquid |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | | DIAM|Diamonds|0008 Armoured |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |Tropic; see also VALU, GOLD

SUGR|Sugar|0010 Bulk | | |

TOYS|Toys|0020 Piece goods | | |

BATT|Batteries|0020 Piece goods | | |

SWET|Sweets (Candy)|0004 Express | | |

TOFF|Toffee|0010 Bulk | | |

COLA|Cola|0040 Liquid | | |

CTCD|Cotton Candy (Candyfloss)|0010 Bulk | | |

BUBL|Bubbles|0020 Piece goods | | |

PLST|Plastic|0040 Liquid | | |Toyland; see also PLAS

FZDR|Fizzy Drinks|0020 Piece goods | | |

NewCargos

AORE|Bauxite (Aluminium ore)|0010 Bulk | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | BEER|Alcohol|0064 Express, piece goods, liquids | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | BDMT|Building Materials|0220 Piece goods, covered/sheltered | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | BRCK|Bricks| 0020 Piece goods |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | | CERA|Ceramics| 0020 Piece goods |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | | CERE|Cereals| 0210 Bulk, covered/sheltered |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |(*)

CARB|Carbon Brick|0010 Bulk | | |

CLAY|Clay|0210 Bulk covered/sheltered | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | CMNT|Cement| 0210 Bulk covered/sheltered |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |

COPR|Copper|0020 Piece goods | | |

DURA|Depleted Uranium|0100 Hazardous | | |

DYES|Dyes| 0060 Piece goods, liquids |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | | ENSP|Engineering Supplies|0024 Express, piece goods | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | FERT|Fertiliser| 0030 Bulk, piece goods |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |(*) FICR|Fibre crops| 0030 Bulk, piece goods|{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | FISH|Fish| 0084 Express, refrigerated |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | FMSP|Farm Supplies|0024 Express, piece goods | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | FRVG|Fruit (and optionally Vegetables)|00A4 Express, piece goods, refrigerated  | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} |

FUEL|Fuel|0040 Liquid | | |Use PETR for refined-oil fuel

GEAR|Locomotive regearing|8000 Special | | |

GLAS|Glass| 0420 Piece goods, oversized |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | | GRVL|Gravel / Ballast|0010 Bulk | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | LIME|Lime stone| 0010 Bulk |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |

MATE|Materials|0020 Piece goods | | |

MILK|Milk|00C4 Express, liquid, refrigerated | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | MNSP|Manufacturing Supplies|0020 Piece Goods, express | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | OLSD|Oil seed| 0210 Bulk, covered/sheltered |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |(*)

OXYG|Oxygen|0040 Liquid | | |

PETR|Petrol / Fuel Oil| 0040 Liquid |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV}  | PLAS|Plastic| 0060 Piece goods, liquid|{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | | POTA|Potash| 0210 Bulk, covered/sheltered |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |(*) RCYC|Recyclables|0220 Piece Goods, covered  | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} |

RCKT|Rockets|0000 None| | |

RFPR|Refined products| 0040 Liquid |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | RSGR|Raw Sugar|0010 Bulk | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | Sugar cane in tropic, sugar beet in other climates SAND|Sand| 0010 Bulk |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | SCRP|Scrap Metal|0010 Bulk | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV}  |

SILI|Silicate|0010 Bulk | | |

SULP|Sulphur| 0210 Bulk, covered/sheltered |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |(*) TOUR|Tourists| 0005 Passengers, express |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |

TWOD|Tropic Wood|0020 Piece goods | | |

UORE|Uranium Ore|0110 Hazardous, Bulk | | |

URAN|Uranium|0100 Hazardous | | |

VEHI|Vehicles| 0420 Piece goods, oversized |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} | |

WATT|Electricity|0000 None | | |

WDPR|Wood Products| 0030 Bulk, piece goods |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} | WOOL|Wool| 0220 Piece goods, covered/sheltered  |{DIV(bg=>#eebb00)}

~hs~ECS~hs~

{DIV} |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} |(*) WSTE|Waste|0010 Bulk | |{DIV(bg=>#1a3cb7)}

~hs~FIRS~hs~

{DIV} |

||

(*) ECS cargo classes changed as of dec 31, 2010