VariationalAction2/Towns

2011-06-15T10:32:25Z

Hgnmu128: Added zone radii. Courtesy marcin, TTDPatch.

==Introduction==

==Variables==

{| |-
!Variable!!Size!!Content
|-
|40||B||Larger town effect on this town
|-
|41||B||Town index
|-
|82||W||Population
|-
|94..9C||W*5||5 WORD values of the town zone radii
|-
|B6||W||number of buildings
|}

These are accessed by using a type 82/86/8A action 2 for stations, town buildings, or industries.

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

==Description==
===Larger town effect (40)===

This returns how the "largertowns" switch affects this town:

{| |-
!Value!!Meaning
|-
|0||largertowns is enabled, but it won't allow this town to grow larger than usual
|-
|1||largertowns is enabled, and it allows to grow this town larger
|-
|2||largertowns is disabled, so no towns are allowed to grow larger
|}

===Town index (41)===

This returns the index of the town in the town array. This value is between 0 and 69 (inclusive). You can use this value to treat some towns specially. (For example, the first town on the map can be considered the capital and you can allow a Parliament to be built there, but nowhere else)

===Town zone radii (94..9C)===
Squares of radii of 5 town zones. The first zone is where station activity contributes to growth of the town, other zones determine where roads are paved or have trees or streetlights. Most types of town buildings have restrictions as to which zones they may be built in. Zone radii are based on the total number of buildings in town. These values are frequently updated by TTD, so changing them has little or no effect in the long run.

==Example==

CargoTypes

2011-06-14T01:02:25Z

Hgnmu128: Reformat, visual update: changed FIRS background colors to contrast link color

'''Cargo types in TTD'''

Definitions of cargo types used in TTD and the Patch

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

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

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

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

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

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

{| class="wikitable
|-
! Type A
! Bit Value
! Type B
! Cargo
! style="background: #FFA020; color: black" | [http://www.tt-wiki.net/wiki/ECS ECS]
! style="background: #0000C0; color: white" | Type B
! style="background: #0CDDA0; color: white" | [http://www.tt-wiki.net/wiki/FIRS FIRS]
|-
| 00
| 1
| 00
| Passengers
| +
| 00
| +
|-
| 01
| 2
| 01
| Coal
| +
| 01
| +
|-
| 02
| 4
| 02
| Mail
| +
| 02
| +
|-
| 03
| 8
| 03
| Oil
| +
| 03
| +
|-
| 04
| 10
| 04
| Livestock
| +
| 04
| +
|-
| 05
| 20
| 05
| Goods
| +
| 05
| +
|-
| 06
| 40
| 06
| Grain/Wheat/Maize
| +
| 06
| +
|-
| 07
| 80
| 07
| Wood
| +
| 07
| +
|-
| 08
| 100
| 08
| Iron Ore
| +
| 08
| +
|-
| 09
| 200
| 09
| Steel
| +
| 09
| +
|-
| 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
| colspan="4" | Use first (**) 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
|}

<nowiki>*Only in temperate climate, with the "moreindustriesperclimate" switch, i.e. disabled when "newcargos" is switched on.</nowiki>

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

==Cargo Labels==

The following cargo labels have been defined so far:

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

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

StyleGuide

2011-06-14T00:37:58Z

Hgnmu128: Added links,

Pages in the NewGRF specs wiki should try to follow a common style. Headings are as follows:

Note: section headings are indicated by == otherwise they have the same size as the page title

== Action0 pages ==
<pre>
==Introduction==
One to three sentences for summary.

==Properties==
{|
!Property !!Version !!Size !! Description
|-
|01 || ||B ||Short summary 1
|-
|02 || ||W ||Short summary 2
|-
|03 || ||D ||Short summary 3
|-
|04 || ||B/B* ||Short summary 4
|}

==Description==
===Property 1 name (01)===
Detailed Description

===Property 2 name (02)===
Detailed description

===Property N name (0xN)===
Detailed description

==Example==
General example for the action, not specific to the a single property. Lines are ALL indented by a single space at least
-1 * 0 00 00 \b3 01 \b*2 // \b<number of props to change> \b*<vehicle ID>
09 \w192 // value for speed (192 km/h)
0B \w3800 // value for power (3800 hp)
12 FD // use new graphics
</pre>

== VarAction2 pages ==
<pre>
==Introduction==
One to three sentences for summary.

==Variables==
{|
!Variable !!Version !!Size !! Description
|-
|01 || ||B ||Short summary 1
|-
|02 || ||W ||Short summary 2
|-
|03 || ||D ||Short summary 3
|-
|04 || ||B/B* ||Short summary 4
|}

==Description==
Detailed description.

==Example==
General example for the action, not specific to the a single variable.
</pre>

== Other pages ==
<pre>
==Introduction==
One to three sentences for summary.

==Syntax==
Formal syntax definition, including a table with summaries for the variable parts of it.

==Description==
Detailed description.

==Example==
General example for the action.
</pre>

== See also == 
*[http://www.tt-wiki.net/LocalStyleGuide TTWiki LocalStyleGuide (from TTDPatch Wiki)]
*[http://www.tt-wiki.net/Manual_of_Style TTWiki Manual of Style]

GRFSpecs - User contributions [en-gb]

VariationalAction2/Towns

CargoTypes

StyleGuide