GRFSpecs - User contributions [en-gb]

GRFSpecs:Privacy policy

2015-08-04T20:22:33Z

Orudge: Add privacy policy

Cookies are used to keep you logged in, to personalise ads, and to analyse the site's traffic. This information may also be shared with our advertising and analytics partners.

For more information, please see [http://www.tt-forums.net/viewtopic.php?f=14&t=12960 this page] on the Transport Tycoon Forums ("Cookies Policy" section).

Action0/Vehicles

2011-06-17T18:24:51Z

Orudge: Fix link to ResetVehicleData

== Introduction ==
Action 0 properties common to all vehicle types:
The four vehicle types (trains, road vehicles, ships and planes) all have some common properties, which are described here.

== Properties ==

{| class="wikitable"
|-
!Number !!Version !![[GRFActionsDetailed|Size]]!!Description !!Available for articulated parts
|-
|00 || ||W||date of introduction||no
|-
| 02|| ||B||reliability decay speed||no
|-
| 03|| ||B||vehicle life in years||no
|-
| 04|| ||B||model life in years||no
|-
| 06|| ||B||climate availability||should be zero
|-
| 07||2||B||load amount||yes
|}

TTDPatch only: Properties 00 to 06 only apply to new games, or when using {{ttwiki|ResetVehicleData|Cht: ResetVehicles}}.

== Description ==

=== Date of introduction ===

The date is specified as number of days since 1920 where TTD counts 365,25 days in a year. It will have a random number from 0 to 511 days added to it at the start of every new game, or after using "Cht: ResetVehicles" (TTDPatch).  Note that TTD stops updating vehicle type data after the game ends in 2050, so all dates of introduction should be no later than in 2044, to ensure that all vehicle types can be introduced and reach their maximum reliability.

In TTDPatch: If the property value is 729 (2D9h) or less, i.e. before 1922, the random number is not added and the vehicle is introduced at exactly the given date.

In OpenTTD: Since r16929 the start date is not randomised in the first two years after game-start (no matter whether before or after 1922).

The \w<date> escape sequence is especially useful here. See [[GRFActionsDetailed#Byte order|the discussion of escape sequences]] for further information.

=== Reliability decay speed ===

The reliability decay speed is set when a new vehicle is bought, and specifies how quickly the reliability decays after servicing.  The initial TTD default for all vehicles is 20.  If a vehicle goes without servicing for a long time, or if it gets very, very old, this number increases, meaning faster decay and more breakdowns.  Larger numbers mean faster decay, smaller number slower decay. If set to 0, reliability never decreases in normal operation.

=== Vehicle life ===

The number of years before a particular vehicle is considered too old and needs replacing,

=== Model life ===

The number of years that this model can be bought in the game (if PersistentEngines is off).  Usually this should be at least twice or three times as  long as the vehicle life.  When starting a new game, a random amount between 31 months and 17 years is added to this as well.

If the early retirement property (26/1B/16/16) is not set, the model life works like this:

{|
|-
!Phase !!Duration !!Reliability
|-
|1||7 to 38 months||increases from 48-73% to 75-100%
|-
|2||prop. 04 less 8 years||stays constant at peak, 75-100%
|-
|3||10 to 20.5 years||decreases from peak to 25-50%
|}

(the ranges in time and reliability are randomized at the start of each game)

At the end of phase 3, the model is retired and removed from the purchase list.  Note that when the model reliability starts dropping in phase 3, so does the reliability of every single vehicle of this make in the game.

Setting this property to 0xFF means the model will never expire.

If persistentengines is on, the model never gets to within two years of the end of phase 2, it is kept in phase 2 as long as at least one vehicle of this make is in the game.

If the early retirement property is set, the vehicle is retired this many years before the end of phase 2 (can be negative if desired), but not if persistentengines would keep the model alive.

Note: This property also works for wagons since TTDPatch 2.5 beta 7 resp. OpenTTD r14680.

=== Climate availability ===

This is a bit mask of the climates in which this model is available.  Simply add the values for the climates:

{|
|-
!Bit!!Value!!Climate
|-
|0||1||Temperate
|-
|1||2||Arctic
|-
|2||4||Tropical
|-
|3||8||Toyland
|}

For example, 1+2+4 = 07 would make a vehicle available in all climates except Toyland.

If you need a vehicle not to be available through the purchase menu, e.g. a locomotive tender being part of an articulated vehicle (locomotive and tender), you may use a value of zero for the bit mask. Same procedure works for vehicles to be used exlusively by TTDPatch's AI, but not by a human player.

=== Load amount ===
This is the amount of cargo transferred per unit of time if using gradualloading.  The default is 5 for trains and road vehicles, 10 for ships and 20 for aircraft.

Note: For aircraft carrying both passengers and mail this property is broken (wrt. mail) in TTDPatch and OpenTTD before r14672.

Since OpenTTD r14672 this property is used for passengers, while mail uses 1/4 (rounded up). You can use [[Callbacks#Load amount callback 12|callback 12]] to control load amounts for passengers and mail independently.

MediaWiki:Common.css

2011-06-15T15:32:00Z

Orudge: Add AdSense code

/* CSS placed here will be applied to all skins */

table.wikitable td, th {
border: 1px solid #CCCCCC;
padding: 0;
}
table {
border-collapse: collapse;
empty-cells: show;
}

td, th {
border: 1px solid #CCCCCC;
padding: 0px 5px;
}

/* Pad Google AdSense box in portlet in sidebar */
#p-googleadsense .pBody {
padding-top: 5px;
text-align: center;
}

MediaWiki:Googleadsense

2011-06-15T15:31:17Z

Orudge: Add AdSense title

Action13

2011-06-13T16:32:56Z

Orudge: Remove redundant information

==Description==

Translating regular strings is easy by just overwriting them with an [[Action4|action 4]], however this is not possible for translating GRF-specific strings in the D000 or DC00 range of IDs. Instead, these must be translated with this action 13.

Available since 2.6 alpha 1 (r857).

==Format==

The data looks as follows:

<pre>-+<sprite-number> * <length> 13 <feature> <grfid> <num-ent> <offset> <text...>+-</pre>

{| class="wikitable"
|-
!'''Element'''
![[GRFActionsDetailed|'''Size''']]
!'''Description'''
|-
|<sprite-number>
|dec
|A sequential sprite number
|-
|<length>
|dec
|The total number of bytes in the action
|-
|13
|B
|Action 13
|-
|<grfid>
|4*B
|The GRFID of the file whose texts are to be translated
|-
|<num-ent>
|B
|Number of strings
|-
|<offset>
|W
|First text ID
|-
|<text...>
|S
|Zero-terminated strings
|}

For action 13, <num-ent>, <offset> and <text...> work exactly as for [[Action4|action 4]], but the offset may only refer to a text ID in the D000 or DC00 range of IDs.

Action 13 is skipped if the given GRFID cannot be found or if the file is inactive; action 13 generates an error message and disables the current file if it appears before the GRF that it is translating.

TracktypeLabels

2011-06-12T21:18:31Z

Orudge: 6 revisions

=Railtype Labels=

The following railtype labels have been defined so far:

||Label|rail type|notes

<center>OpenTTD Default Railtypes</center>

RAIL|Normal rail|

ELRL|electrified rail|

MONO|mono rail|

MGLV|maglev rail|

<center>New Railtypes</center>

_040|speed limit 40 km/h|Slowrails, ))SwedishRails[[]]SwedishRails[[

_080|speed limit 80 km/h|Slowrails, ))SwedishRails[[]]SwedishRails[[

E040|speed limit 40 km/h, electrified|Slowrails, ))SwedishRails[[]]SwedishRails[[

E080|speed limit 80 km/h, electrified|Slowrails, ))SwedishRails[[]]SwedishRails[[

3RDR|third rail|))MetroTracks[[]]MetroTracks[[, ))NuTracks[[]]NuTracks[[

3RDC|third rail and catenary|))MetroTracks[[]]MetroTracks[[, ))NuTracks[[]]NuTracks[[

RLOW|Low speed rails|NuTracks,))SwedishRails[[]]SwedishRails[[

ELOW|Low speed rails, Catenary|NuTracks,))SwedishRails[[]]SwedishRails[[

3LOW|Low speed 3rd rails|NuTracks,

CLOW|Low speed 3rd rails, Catenary|NuTracks

RMED|Medium speed rails|NuTracks,))SwedishRails[[]]SwedishRails[[

EMED|Medium speed rails, Catenary|NuTracks,))SwedishRails[[]]SwedishRails[[

3MED|Medium speed 3rd rails|NuTracks

CMED|Medium speed 3rd rails, Catenary|NuTracks

RHIG|High speed rails|NuTracks,))SwedishRails[[]]SwedishRails[[

EHIG|High speed rails, Catenary|NuTracks,))SwedishRails[[]]SwedishRails[[

HSTR|Very high speed track, Catenary|NuTracks,))SwedishRails[[]]SwedishRails[[

PLAN|Planning tracks (blue dotted lines)|NuTracks

MTRO|Metro tracks|NuTracks

MTRC|Metro tracks with concrete edges|NuTracks

MTRS|Metro tracks with suburban buildings on top|NuTracks

MTRU|Metro tracks with 'downtown' buildings on top|NuTracks

MTRT|Metro tracks with terrain on top|NuTracks

DBNN|branch line|DBRails

DBNE|branch line, electrified|DBRails

DBHN|main line|DBRails

DBHE|main line, electrified|DBRails

DBHS|high speed line electrified (NBS)|DBRails

TRPD|transrapid track|Transrapid track type||

PalettesAndCoordinates

2011-06-12T21:18:31Z

Orudge: 10 revisions

'''''How to work with palettes, and the 2D and 3D coordinates'''''

=Palettes=

Since TTD is a palette-based game, you have to be careful that the graphics program you use can deal with that properly. Also, TTD uses some palette entries for palette cycling to do some colour-animation, don't use these as regular colours. These entries are often called "action colours".

Below is an explanation by Oskar Eisemuth of the various colour ranges in the DOS and Windows palettes.  Both palettes work similarly, but some of the colours are in different places.

{picture file=img/wiki_up//windowspal.png}

Info on the image: The colors you '''can use normally''' are marked in '''green'''. The colors which '''have special purposes/are color cycles''' are marked '''yellow'''. '''Don't use''' the '''red''' marked colors.

The colours in the "company" range are often (but not always) changed to the current player colours. In some instances, they may be changed to colours specified by the .grf file, or random colours, or not changed at all.

Here is a list, provided by George, of the shades of player colours that will be used:

{picture file=img/wiki_up//playercolours.png}

The "Patch Company 2" range is normally not a special colour range, but since 2.0.1 alpha 67 it is possible to activate it as a second company colour for vehicles and town houses.

The palette cycling ranges listed are the water cycle (used for the blinking dots in the water), the block cycle, fire cycle, exchange red (better called crossing red; used for the flashing crossing lights), and the yellow cycle (used for lights in the runway of the large airport).

The following table presents more detailed info on differences between DOS and Windows colours and colour indices:

=Coordinates=

TTD internally uses a 3D engine, which then uses an isometric projection to display graphics on a 2D screen.  The 3D engine uses so-called "bounding boxes" for each sprite, which are then sorted by the sprite sorter to get drawn in (what it thinks is) the right order.

To get a certain sprite drawn at the right place, it needs to have a proper bounding box (which is provided by the game for the most part), and the correct 2D offsets, here called "xofs" and "yofs" (see [[RealSprites]] for more information). The following picture by Oskar Eisemuth should help in figuring out how the 3D and 2D coordinates relate to each other:

{picture file=img/wiki_up//coordinates3d.png}

For 3D coordinates, X goes from top right to bottom left, Y goes from top left to bottom right, and Z (height) from down to up.  For 2D coordinates, X goes from left to right, and Y from top to bottom.  Usually, the top side of the screen is referred to as "north", and thus "east", "south" and "west" are the right, bottom and left side of the screen.

For vehicles, the center of the bounding box (shown with a red dot in the yellow boxframe) is the reference point from which the xofs and yofs are counted.  This means that in most cases, xofs and yofs need to be negative to get the sprite to fit on the box.  Normally, as indicated above, this means xofs is approximately the negative value of half the sprite width, and yofs is approximately the negative value of half the sprite height.

For all other sprites, the reference point is the furthest corner of the box, at its lowest X, Y and Z coordinates, i.e. the lower northernmost corner.  In the image above, it is indicated by the crossing point of the blue lines.  The xofs and yofs work from this point, instead of the center of the box as for vehicles.

ObjectLabels

2011-06-12T21:18:31Z

Orudge: 4 revisions

=Object labels=

Defining Object Class Label Recommendations

{maketoc}

==Recommendations - Predefined==

1. Predefined labels are best used for single objects that are not part of a comprehensive set

2. It is possible to have a label for each object. This would make for a very ungainly menu.

3. A labeling system allows a coder/author to make their works much more user friendly.

4. To keep the numbers more manageable, the classes are as generic as possible.

5. While being generic, assigning objects to a label should be intuitive.

6. Assuming that there will be special circumstances where a coder/author needs to deviate from the norm, '''the Recommendation is not mandatory'''.

||<center>PREDEFINED RECOMMENDATIONS</center>

Label|<center>Action4 Text</center>|<center>Description</center>

TTDX|<center>Default*TTDX</center>|Transport Tycoon's copy-written objects - lighthouse, communication tower, rocks, etc.

OTTD|<center>Default*OpenTTD</center>|OpenGFX objects - lighthouse, communication tower, rocks, etc.

STRU|<center>Structures</center>|Multitile engineered objects that don't quite fit in as industries, houses or stations - dams etc.

INFR|<center>Infrastructure</center>| - light poles, communication towers, transmission towers, road signs, etc.

BLDG|<center>Buildings</center>|Normally accommodated by industries, houses or stations but the author feels there are limiting circumstances.

NATR|<center>Natural objects</center>| - caves, coral reefs, swamps, etc.

PARK|<center>Public areas</center>|Normally accommodated by towns or industries (tourist stuff ...) but the author feels there are limiting circumstances - Parks, statues, etc.

ARTF|<center>Artifacts</center>|They really don't fit under any of the above - shipwrecks, etc.

MISC|<center>Miscellaneous</center>|For the author who is unable to accommodate his/her object under any of the previous labels.||

==Recommendations - Author defined==

1. Author defined labels are best used for comprehensive object sets that consist of several obviously related objects.

2. Each label must consist of four (4) alphanumeric characters.

3. To prevent menu confusion, new labels should be unique and should not duplicate predefined labels (see chart above) nor previously selected author defined labels (see chart below).

4. The author should add their label(s) to the following chart in alphanumeric order.

5. If an author is uncomfortable with adding a label to the chart, they can PM their request to [http://www.tt-forums.net/ucp.php?i=pm&mode;=compose&action;|wallyweb].

6. The chart will be regularly reviewed for duplications.

7. The chart will be regularly edited for alphanumeric sequence.

||<center>AUTHOR DEFINED RECOMMENDATIONS</center>

Label|<center>Action4 Text</center>|<center>Description</center>|<center>Author</center>|<center>tt-forums link</center>

EXM1|<center>Example 1</center>|An example label listing|your name here|Forum link goes here

EXM2|<center>Example 2</center>|Another example label listing|your name here|Forum link goes here||

VehicleRefitting

2011-06-12T21:18:31Z

Orudge: 2 revisions

'''''Interaction of vehicle properties and callbacks during refitting'''''

Vehicles have multiple properties and callbacks which define the default cargotype and capacity, the refitoptions and the capacities after refitting.
* Default cargo slot (trains, road vehicles, ships)
* Default capacity (trains, road vehicles, ships)
* Passenger capacity (aircraft)
* Mail capacity (aircraft)
* Refit mask (all vehicle types)
* Refittable cargo classes (all vehicle types)
* Non-refittable cargo classes (all vehicle types)
* 'Refittable'-flag (ships)
* Callback 36 'capacity' (all vehicle types)
* Callbck 15 'refitted capacity'

The following image visualises the interactions of these wrt. OpenTTD. If you know the behaviour of TTDPatch at that detail level, please elaborate.

IndustryTileDefaultProps

2011-06-12T21:18:31Z

Orudge: 12 revisions

'''''Default property values for TTD's industry tiles'''''

=Default Industry Tile Properties=

Default property values for TTD's industry tiles

This page is based on a table compiled by [[CsabaVarga|Csaba Varga]] in connection with his work on the Patch´s ''newindustries'' feature.

The properties listed below are automatically copied to your newly defined industry tile when setting property 8, therefore you can save some bytes by leaving alone those that fit your needs. This data is also useful for reference so you know how you should set these properties for new industries.

Note that the values listed here are big-endian. In order to use the values listed for props 0A..0C in an NFO file, you'll have to reverse the bytes first.

In case of more than one ground or building sprite listed, these are sprites for successive construction building states, unless marked as sprites for animation sequences. Some sprites are taken from climate-specific .grfs like trgh.grf (sub-tropical) or trgc.grf (sub-arctic) and thus marked. All sprite numbers are given as decimal numbers.

||ID|Land shape flags (0D)|Acceptance 1 (0A)|Acceptance 2 (0B)|Acceptance 3 (0C)|ground sprites|building sprites

Coal mine

00h|10h|00 00|00 00|00 00|2022|2011 - 2013

01h|10h|00 00|00 00|00 00|2022|2013 - 2015 (animation)

02h|10h|00 00|00 00|00 00|2022|2016 - 2018

03h|10h|01 00|00 00|00 00|2022|2019 - 2021

04h|10h|00 00|00 00|00 00|2023|n/a

05h|10h|00 00|00 00|00 00|2024|n/a

06h|10h|00 00|00 00|00 00|2025|n/a

Power station

07h|10h|00 00|00 00|00 00|3924|2045 - 2047

08h|10h|01 00|08 01|00 00|3924|2048 - 2050

09h|10h|00 00|00 00|00 00|3924|2051 - 2053

0Ah|10h|00 00|00 00|00 00|3924|2054, 2055 - 2060 (animation)

Sawmill

0Bh|10h|01 00|00 00|00 00|3924|2061 - 2063

0Ch|10h|01 00|00 00|00 00|3924|2064 - 2066

0Dh|10h|01 00|08 07|00 00|3924|2067 - 2069

0Eh|10h|00 00|00 00|00 00|3924|2070

0Fh|10h|00 00|00 00|00 00|3924|2071

Forest (temperate)

10h|10h|00 00|00 00|00 00|2077|2072 - 2075 (animation)

11h|10h|00 00|00 00|00 00|2077|2076

Forest (arctic, sprites in trgc.grf)

10h|10h|00 00|00 00|00 00|327|322 - 325 (animation)

11h|10h|00 00|00 00|00 00|327|326

Oil refinery

12h|10h|00 00|00 00|00 00|1420|2078 - 2080

13h|10h|00 00|00 00|00 00|1420|2081 - 2083

14h|10h|00 00|08 03|00 00|1420|2084 - 2086

15h|10h|00 00|00 00|00 00|1420|2087 - 2089

16h|10h|00 00|00 00|00 00|1420|2090 - 2092

17h|10h|01 00|00 00|00 00|1420|2093 - 2095

Oil rig

18h|10h|00 00|08 00|00 00

19h|10h|00 00|08 02|00 00

1Ah|10h|00 00|00 00|00 00

1Bh|10h|00 00|00 00|00 00

1Ch|10h|00 00|00 00|00 00

Oil wells (temperate)

1Dh|10h|00 00|00 00|00 00|2173|2174

1Eh|10h|00 00|00 00|00 00|2173|2174-2179 (animation)

1Fh|10h|00 00|00 00|00 00|2173|2174-2179 (animation)

20h|10h|00 00|00 00|00 00|2173|2174-2179 (animation)

Oil wells (arctic, sprites in trgc.grf)

1Dh|10h|00 00|00 00|00 00|262|263

1Eh|10h|00 00|00 00|00 00|262|263 - 268 (animation)

1Fh|10h|00 00|00 00|00 00|262|263 - 268 (animation)

20h|10h|00 00|00 00|00 00|262|263 - 268 (animation)

Oil wells (sub-tropical, sprites in trgh.grf)

1Dh|10h|00 00|00 00|00 00|250|251

1Eh|10h|00 00|00 00|00 00|250|251 - 256 (animation)

1Fh|10h|00 00|00 00|00 00|250|251 - 256 (animation)

20h|10h|00 00|00 00|00 00|250|251 - 256 (animation)

Farm (temperate)

21h|10h|01 00|00 00|00 00|2106|2108

22h|10h|01 00|00 00|00 00|2107|2109

23h|10h|00 00|00 00|00 00|2110|2111

24h|10h|00 00|00 00|00 00|2112|2113

25h|10h|00 00|00 00|00 00|2114|2115

26h|10h|00 00|00 00|00 00|2116|2117

Farm (arctic, sprites in trgc.grf)

21h|10h|01 00|00 00|00 00|61|64

22h|10h|01 00|00 00|00 00|62|65

23h|10h|00 00|00 00|00 00|66|67

24h|10h|00 00|00 00|00 00|68|69

25h|10h|00 00|00 00|00 00|70|71

26h|10h|00 00|00 00|00 00|72|73

Farm (tropic, sprites in trgh.grf)

21h|10h|01 00|00 00|00 00|543|545

22h|10h|01 00|00 00|00 00|544|546

23h|10h|00 00|00 00|00 00|547|548

24h|10h|00 00|00 00|00 00|549|550

25h|10h|00 00|00 00|00 00|551|552

26h|10h|00 00|00 00|00 00|553|554

Factory (temperate)

27h|10h|08 06|08 04|08 09|2022, 2022, 2146|2153, 2157, 2150

28h|10h|08 06|08 04|08 09|2022, 2022, 2147|2154, 2158, 2151

29h|10h|08 06|08 04|08 09|2022, 2022, 2148|2155, 2159, 2152

2Ah|10h|08 06|08 04|08 09|2022, 2022, 2149|2156, 2160, n/a

Printing works

2Bh|10h|00 00|08 09|00 00|3924|2161, 2165, 2169

2Ch|10h|00 00|08 09|00 00|3924|2162, 2166, 2170

2Dh|10h|00 00|08 09|00 00|3924|2163, 2167, 2171

2Eh|10h|00 00|08 09|00 00|3924|2164, 2168, 2172

Copper ore mine

2Fh|10h|00 00|00 00|00 00|2022|2026-2028

30h|10h|00 00|00 00|00 00|2022|2028-2030 (animation)

31h|10h|00 00|00 00|00 00|2022|2131-2033

32h|10h|01 00|00 00|00 00|2022|2034-2036

33h|10h|01 00|00 00|00 00|2022|2037-2039

Steel mill

34h|10h|01 00|08 08|00 00|2129, 2118|2130, 2119

35h|10h|01 00|08 08|00 00|2131, 2120|2132, 2121

36h|10h|01 00|08 08|00 00|2133, 2122|2134, 2123

37h|10h|01 00|08 08|00 00|2135, 2124|n/a

38h|10h|01 00|08 08|00 00|2136, 2125|2137, 2126

39h|10h|01 00|08 08|00 00|2138, 2127|2139, 2128

Bank (temperate)

3Ah|04h|01 00|08 0A|00 00|2182|2180

3Bh|02h|01 00|08 0A|00 00|2183|2181

Food processing plant

3Ch|10h|08 06|08 04|00 00|2022|2188-2190

3Dh|10h|08 06|08 04|00 00|2022|2191-2193

3Eh|10h|08 06|08 04|00 00|2022|2194-2196

3Fh|10h|08 06|08 04|00 00|2022|2197-2199

Paper mill

40h|10h|00 00|08 07|00 00|2022|2200, 2201, 2201, 2202

41h|10h|00 00|08 07|00 00|2022|n/a, n/a, n/a, 2214

42h|10h|00 00|08 07|00 00|2022|2203, 2204, 2204, 2205

43h|10h|00 00|08 07|00 00|2022|n/a, n/a, n/a, 2206

44h|10h|00 00|08 07|00 00|2022|n/a, 2207, 2208, 2208

45h|10h|00 00|08 07|00 00|2022|n/a, 2207, 2208, 2209

46h|10h|00 00|08 07|00 00|2022|n/a, 2210, 2211, 2212

47h|10h|00 00|08 07|00 00|2022|n/a, 2210, 2211, 2213

Gold mine

48h|10h|00 00|00 00|00 00|2215, 2022, 2022|n/a, 2231, 2247

49h|10h|00 00|00 00|00 00|2216, 2232, 2248|n/a

4Ah|10h|00 00|00 00|00 00|2217, 2022, 2022|n/a, 2233, 2249

4Bh|10h|00 00|00 00|00 00|2218, 2022, 2022|n/a, 2234, 2250

4Ch|10h|00 00|00 00|00 00|2219, 2235, 2251|n/a

4Dh|10h|00 00|00 00|00 00|2220, 2236, 2252|n/a

4Eh|10h|00 00|00 00|00 00|2221, 2237, 2253|n/a

4Fh|10h|00 00|00 00|00 00|2222, 2238, 2254|n/a, n/a, 2263

50h|10h|00 00|00 00|00 00|2223, 2239, 2255|n/a

51h|10h|00 00|00 00|00 00|2224, 2240, 2256|n/a

52h|10h|00 00|00 00|00 00|2225, 2241, 2257|n/a

53h|10h|00 00|00 00|00 00|2226, 2242, 2258|n/a

54h|10h|00 00|00 00|00 00|2227, 2243, 2259|n/a

55h|10h|00 00|00 00|00 00|2228, 2244, 2260|n/a

56h|10h|00 00|00 00|00 00|2229, 2245, 2261|n/a

57h|10h|00 00|00 00|00 00|2230, 2246, 2262|n/a

58h|10h|00 00|00 00|00 00|2254|2263-2265 (animation)

Bank (sub-arctic or sub-tropical)

59h|04h|00 00|08 0A|00 00|2184|2186

5Ah|02h|00 00|08 0A|00 00|2485|2187

Diamond mine

5Bh|10h|00 00|00 00|00 00|2266, 2022, 2022|n/a, 2275, 2284

5Ch|10h|00 00|00 00|00 00|2267, 2022, 2022|n/a, 2276, 2285

5Dh|10h|00 00|00 00|00 00|2268, 2022, 2022|n/a, 2077, 2286

5Eh|10h|00 00|00 00|00 00|2269, 2022, 2022|n/a, 2078, 2287

5Fh|10h|00 00|00 00|00 00|2270, 2279, 2288|n/a

60h|10h|00 00|00 00|00 00|2271, 2280, 2289|n/a

61h|10h|00 00|00 00|00 00|2272, 2022, 2022|n/a, 2281, 2290

62h|10h|00 00|00 00|00 00|2273, 2282, 2291|n/a

63h|10h|00 00|00 00|00 00|2274, 2283, 2292|n/a

Iron ore mine

64h|10h|00 00|00 00|00 00|2293, 2309, 2325|n/a

65h|10h|00 00|00 00|00 00|2294, 2310, 2326|n/a

66h|10h|00 00|00 00|00 00|2295, 2311, 2327|n/a

67h|10h|00 00|00 00|00 00|2296, 2312, 2328|n/a

68h|10h|00 00|00 00|00 00|2297, 2313, 2329|n/a

69h|10h|00 00|00 00|00 00|2298, 2314, 2330|n/a

6Ah|10h|00 00|00 00|00 00|2299, 2315, 2331|n/a

6Bh|10h|00 00|00 00|00 00|2300, 2316, 2332|n/a

6Ch|10h|00 00|00 00|00 00|2301, 2317, 2333|n/a

6Dh|10h|00 00|00 00|00 00|2302, 2318, 2334|n/a

6Eh|10h|00 00|00 00|00 00|2303, 2319, 2335|n/a

6Fh|10h|00 00|00 00|00 00|2304, 2320, 2336|n/a

70h|10h|00 00|00 00|00 00|2305, 2321, 2337|n/a

71h|10h|00 00|00 00|00 00|2306, 2322, 2338|n/a

72h|10h|00 00|00 00|00 00|2307, 2323, 2339|n/a

73h|10h|00 00|00 00|00 00|2308, 2324, 2340|n/a

Fruit plantation

74h|10h|00 00|00 00|00 00|2341|2342

Rubber plantation

75h|10h|00 00|00 00|00 00|2341|2343

Water supply

76h|10h|00 00|00 00|00 00|350 (trgh)|2347-2349

77h|10h|00 00|00 00|00 00|350 (trgh)|2350-2352

Water tower

78h|10h|00 00|08 09|00 00|350 (trgh)|2344-2346

Factory (sub-tropical)

79h|10h|08 08|08 01|08 07|2022,2022,2146| 2153, 2157, 2150

7Ah|10h|08 08|08 01|08 07|2022,2022,2147| 2154, 2158, 2151

7Bh|10h|08 08|08 01|08 07|2022,2022,2148| 2155, 2159, 2152

7Ch|10h|08 08|08 01|08 07|2022,2022,2149| 2156, 2160, n/a

Lumber mill

7Dh|10h|00 00|00 00|00 00|2022|2353, 2357, 2361

7Eh|10h|00 00|00 00|00 00|2022|2354, 2358, 2362

7Fh|10h|00 00|00 00|00 00|2022|2355, 2359, 2363

80h|10h|00 00|00 00|00 00|2022|2356, 2360, 2364

Candyfloss forest

81h|10h|00 00|00 00|00 00

82h|10h|00 00|00 00|00 00

Sweet factory

83h|10h|08 08|08 01|08 06

84h|10h|08 08|08 01|08 06

85h|10h|08 08|08 01|08 06

86h|10h|08 08|08 01|08 06

Battery farm

87h|10h|00 00|00 00|00 00

88h|10h|00 00|00 00|00 00

Cola wells

89h|10h|00 00|00 00|00 00

Toy shop

8Ah|10h|00 00|08 03|00 00

8Bh|10h|00 00|08 03|00 00

8Ch|10h|00 00|08 03|00 00

8Dh|10h|00 00|08 03|00 00

Toy factory

8Eh|10h|08 04|08 0A|00 00

8Fh|10h|08 04|08 0A|00 00

90h|10h|08 04|08 0A|00 00

91h|10h|08 04|08 0A|00 00

92h|10h|08 04|08 0A|00 00

93h|10h|08 04|08 0A|00 00

Plastic fountains

94h|10h|00 00|00 00|00 00

95h|10h|00 00|00 00|00 00

96h|10h|00 00|00 00|00 00

97h|10h|00 00|00 00|00 00

98h|10h|00 00|00 00|00 00

99h|10h|00 00|00 00|00 00

9Ah|10h|00 00|00 00|00 00

9Bh|10h|00 00|00 00|00 00

Fizzy drink factory

9Ch|10h|08 09|08 07|00 00

9Dh|10h|08 09|08 07|00 00

9Eh|10h|08 09|08 07|00 00

9Fh|10h|08 09|08 07|00 00

Bubble generator

A0h|10h|00 00|00 00|00 00

A1h|10h|00 00|00 00|00 00

A2h|10h|00 00|00 00|00 00

A3h|10h|00 00|00 00|00 00

Toffee quarry

A4h|10h|00 00|00 00|00 00

A5h|10h|00 00|00 00|00 00

A6h|10h|00 00|00 00|00 00

Sugar mine

A7h|10h|00 00|00 00|00 00

A8h|10h|00 00|00 00|00 00

A9h|10h|00 00|00 00|00 00

AAh|10h|00 00|00 00|00 00

ABh|10h|00 00|00 00|00 00

ACh|10h|00 00|00 00|00 00

ADh|10h|00 00|00 00|00 00

AEh|10h|00 00|00 00|00 00||''text''

IndustryDefaultProps

2011-06-12T21:18:31Z

Orudge: 4 revisions

'''''Default properties values for TTD's industries'''''

=Default Industry Properties=

Default property values for TTD's industries

))This page was blatantly stolen from Csaba to aid GRF coders in their work[[MiscellaneousModifications|miscmods]].dontfixtropicbanks bit is set. This table contains the fixed values. If the player has set that bit, the two marked values will be swapped.

==Industry Layouts==

Each layout consists of industry tile IDs to build. Keep in mind that the X axis of the TTD coordinate system goes SW and the Y axis goes SE. This means that to get the real alignment from this chart, you need to mirror things around the vertical axis, then rotate them 45 degrees counter-clockwise.

||ID|Name|Layouts

00h|Coal mine|~pp~05 06 03

  00

  02 03~/pp~|~pp~03 03 00

04 00 02

04 02 04~/pp~|~pp~00 03

02 03

05 06~/pp~|~pp~   05 06

00 00 04

02 02 03

04 03~/pp~

01h|Power station|~pp~07 07 07 0A

09 08 08 0A~/pp~|~pp~   08 09

07 08 0A

07 07 09~/pp~|~pp~07 09 0A

07 08 09~/pp~

02h|Sawmill|~pp~0F 0E 0E

0F 0C 0D

0C 0B~/pp~|~pp~0F 0F 0B

0B 0D 0D

0E 0C~/pp~

03h|Forest|~pp~10 10 10 10

10 10 10 10

10 10 10 10

10 10 10 10

  10 10~/pp~|~pp~10 10 10 10 10

10 10 10 10 10

10 10 10 10 10

10 10 10 10 10

  10 10 10~/pp~

04h|Oil refinery|~pp~14 14 17

15 13 12 17

16 16 12 12

15 14 12 12~/pp~|~pp~12 12 12

12 12 12

15 13 13

16 14 16

14 17 17~/pp~

05h|Oil rig|~pp~

xx xx xx xx xx xx xx xx xx xx

xx                         xx

xx                         xx

xx                         xx

xx         [18]1A xx       xx

xx          18 1B          xx

xx          19 1C          xx

xx                         xx

xx                         xx

xx                         xx

xx xx xx xx xx xx xx xx xx xx~/pp~ (*)

06h|Factory (temperate climate)|~pp~27 29

28 2A 27 29

27 29 28 2A

28 2A~/pp~|~pp~27 29 27 29

28 2A 28 2A

  27 29

  28 2A~/pp~

07h|Printing works|~pp~2B 2D

2C 2E 2B 2D

2B 2D 2C 2E

2C 2E~/pp~|~pp~2B 2D 2B 2D

2C 2E 2C 2E

  2B 2D

  2C 2E~/pp~

08h|Steel mill|~pp~38 39 38 39

38 39 34 36

38 39 35 37~/pp~|~pp~34 36 34 36

35 37 35 37

38 39 38 39

  38 39~/pp~

09h|Farm (temperate or sub-arctic)|~pp~25 21 23

25 22 26

24 24 26~/pp~|~pp~23 25 25

24 21 25

24 22 26

23 26 26~/pp~|~pp~24 23 21

24 26 22

25 26 25

25 25 23~/pp~

0Ah|Copper ore mine|~pp~2F 2F 33

31 31 33

33 32~/pp~|~pp~32 2F 33

2F 31 2F

31 33 31~/pp~

0Bh|Oil wells|~pp~1D 1D 1D

1D

1D~/pp~|~pp~1D 1D

  1D

     1D

     1D~/pp~

0Ch|Bank (temperate)|~pp~3A 3B~/pp~

0Dh|Food processing plant|~pp~3C 3C 3C

3C 3C 3C

3D 3D 3F

3E 3E 3F~/pp~|~pp~3D 3C 3D 3D

3E 3F 3F 3F

3C 3C 3C 3C

3E 3E~/pp~

0Eh|Paper mill|~pp~40 41 42 43

44 45 43 43

42 47 47 46~/pp~

0Fh|Gold mine|~pp~48 4C 50 54

49 4D 51 55

4A 4E 52 56

4B 4F 53 57~/pp~

10h|Bank (sub-tropical or sub-arctic)|~pp~59 5A~/pp~

11h|Diamond mine|~pp~5B 5E 61

5C 5F 62

5D 60 63~/pp~

12h|Iron ore mine|~pp~64 68 6C 70

65 69 6D 71

66 6A 6E 72

67 6B 6F 73~/pp~

13h|Fruit plantation|~pp~74 74 74 74 74

74 74 74 74 74

74 74 74 74 74

74 74 74 74 74~/pp~

14h|Rubber plantation|~pp~75 75 75 75 75

75 75 75 75 75

75 75 75 75 75

75 75 75 75 75~/pp~

15h|Water supply|~pp~76 76

77 77~/pp~

16h|Water tower|~pp~78~/pp~

17h|Factory (sub-tropical)|~pp~79 7B

7A 7C

79 7B

7A 7C~/pp~|~pp~79 7B 79 7B

7A 7C 7A 7C~/pp~

18h|Farm (sub-tropical)|~pp~25 21 23

25 22 26

24 24 26~/pp~|~pp~23 25 25

24 21 25

24 22 26

23 26 26~/pp~|~pp~24 23 21

24 26 22

25 26 25

25 25 23~/pp~

19h|Lumber mill|~pp~7D 7F

7E 80~/pp~

1Ah|Candyfloss forest|~pp~81 81 81 81

81 81 81 81

81 81 81 81

81 81 81 81

  81 81~/pp~|~pp~81 81 81 81 81

81 81 81 81 81

81 81 81 81 81

81 81 81 81 81

  81 81 81~/pp~

1Bh|Sweet factory|~pp~83 85

84 86 83 85

83 85 84 86

84 86~/pp~|~pp~83 85 83 85

84 86 84 86

  83 85

  84 86~/pp~

1Ch|Battery farm|~pp~87 87 87 87 87

87 87 87 87 87

87 87 87 87 87

87 87 87 87 87~/pp~

1Dh|Cola wells|~pp~89 89

89 89 89

89 89 89~/pp~|~pp~   89

89 89 89

89 89

89~/pp~

1Eh|Toy shop|~pp~8A 8C

8B 8D~/pp~

1Fh|Toy factory|~pp~93 93 93 92

8E 8F 90 91~/pp~

20h|Plastic fountains|~pp~94

97

9A~/pp~|~pp~94 97 9A~/pp~

21h|Fizzy drink factory|~pp~9C 9E

9D 9F~/pp~

22h|Bubble generator|~pp~A3 A3 A3

A0 A1 A2

A3 A3 A3

A0 A1 A2~/pp~

23h|Toffee quarry|~pp~A4 A5 A6~/pp~

24h|Sugar mine|~pp~A7 A9 AB AD

A8 AA AC AE~/pp~||

(*) Oil rigs are slightly special industries, since they have industry "tile" FFh, which doesn't create anything on the landscape, but the tile is still checked, and construction fails if it isn't a clear water tile. These special tiles are marked with "xx". The north corner of the industry is marked with <nowiki><nowiki>[ ]</nowiki></nowiki>.

DefaultHouseProps

2011-06-12T21:18:31Z

Orudge: 2 revisions

'''''Default property values for TTD's houses'''''

=Default House Properties=

Default property values for TTD's houses

This page is largely a copy of housedata.html, from <nowiki>http://users.tt-forums.net/csaboka/ttdpatch/housetut.zip

</nowiki>

This list contains all properties of default TTD house types, allowing you to know what will be copied to your new house ID when you set its property 8, and can also be used for reference when deciding what properties your new house should have. House names are taken from Marcin Grzegorczyk's "Transport Tycoon Deluxe savegame internals" file, which has more descriptive names than the original TTD ones. Unfortunately, even these names aren't unique, either. The "Flags" column lists what will be set to your new building's property 9 (that's why their church and stadium flags aren't set). Negative goods acceptance means that the building accepts food/candy instead of goods/fizzy drinks. "None" in the max. year column means that the building type never becomes obsolete. The rest of the columns is pretty self-explanatory.

|| ID| Name| Climates | Town zones| Flags| Min. build year| Max. build year| Population| Mail generation| Passenger acceptance (in 1/8 units)| Mail acceptance (in 1/8 units)| Goods/food acceptance (in 1/8 units)| Remove ratings decrease| Remove cost multiplier

00h| tall office block| temperate| 4| 01h| 1963 | none| 187| 70| 8| 3| 4| 140| 150

01h| office block| temperate| 3, 4| 01h| 1957| none| 85| 55 | 8| 3| 4| 130| 140

02h| small block of flats| temperate | 1, 2, 3| 01h| 1968| none| 40| 20| 8| 3| 1 | 90| 100

03h| church| temperate| 0, 1, 2, 3| 01h| 1930 | none| 5| 2| 2| 0| 0| 230| 90

04h| large office block| temperate, sub-arctic, subtropical| 4| 21h| 1975| none| 220| 85| 10| 4| 6| 160| 160

05h| large office block| snow | 4| 21h| 1975| none| 220| 85| 10| 4| 6 | 160| 160

06h| town houses| temperate| 0, 1, 2, 3| 01h| 1930| none| 30| 12| 4| 1| 0| 80| 80

07h| hotel (N part)| temperate| 2, 4| 08h| 1959| none| 140| 22 | 6| 1| 2| 150| 180

08h| hotel (E part)| | | 00h| 1959| none| 0| 22| 6| 1| 2| 150 | 180

09h| statue| temperate, sub-arctic, subtropical| 3, 4| 01h| 1945| none | 0| 0| 2| 0| 0| 40| 65

0Ah | fountain | temperate, sub-arctic, subtropical| 4| 01h| 1945| none| 0| 0| 2 | 0| 0| 40| 65

0Bh| park (with a pond)| temperate| 2 | 01h| 1930| none| 0| 0| 2| 0| 0| 75 | 60

0Ch| park (with an alley)| temperate| 3| 01h| 1935| none| 0| 0| 2| 0| 0| 75| 60

0Dh | office block | temperate| 3, 4| 01h| 1951| none| 150| 65| 8 | 2| 4| 110| 130

0Eh| shops and offices 1| temperate| 2, 3, 4 | 01h| 1930| 1960| 95| 48| 6| 2| 3| 100 | 110

0Fh| shops and offices 2| temperate| 2, 3, 4| 01h| 1930| 1960 | 95| 48| 6| 2| 3| 100| 105

10h | shops and offices 3 | temperate| 2, 3, 4| 01h| 1930| 1960| 95| 48| 6 | 2| 3| 100| 107

11h| modern office building| temperate, sub-arctic, subtropical| 4 | 01h| 1977| none| 130| 50| 10| 3| 6| 150 | 200

12h| warehouse| temperate| 4| 01h| 1983| none | 6| 10| 6| 3| 8| 110| 145

13h | office block (with spiral stairway) | temperate| 4| 01h| 1985| none| 110| 55| 6| 2| 6| 110| 155

14h| stadium (N part)| temperate| 0, 1, 2, 3| 10h| 1930| none| 65| 5| 4| 0| 0| 300 | 250

15h| stadium (E part)| | | 00h| 1930| none| 0 | 5| 4| 0| 0| 300| 250

16h| stadium (W part) | | | 00h| 1930| none| 0| 5| 4| 0| 0 | 300| 250

17h| stadium (S part)| | | 00h| 1930| none | 0| 5| 4| 0| 0| 300| 250

18h | old houses | temperate| 0, 1| 01h| 1930| 1951| 15| 6| 3 | 1| 0| 75| 70

19h| cottages| temperate| 0| 01h| 1930| 1952| 12| 7| 3| 1| 0| 75   | 75

1Ah| houses| temperate| 0, 1, 2, 3| 01h| 1931| none | 13| 8| 3| 1| 0| 75| 71

1Bh  | flats | temperate| 2, 3, 4| 01h| 1935| none| 100| 35| 7  | 2| 2| 100| 135

1Ch| tall office block| temperate| 2, 3, 4 | 01h| 1963| none| 170| 50| 8| 3| 3| 170 | 145

1Dh| shops and offices| temperate| 2, 3, 4| 01h| 1930| 1955 | 100| 40| 6| 2| 3| 135| 132

1Eh | shops and offices | temperate, subtropical| 2, 4| 01h| 1973| none| 180| 64| 8  | 3| 3| 180| 155

1Fh| theatre| temperate| 3, 4 | 01h| 1930| none| 35| 23| 8| 2| 2| 230 | 220

20h| stadium (modern style, N part)| temperate, sub-arctic, subtropical| 0, 1, 2, 3| 10h| 1958| none | 65| 5| 4| 0| 0| 300| 250

21h | stadium (modern style, E part) | | | 00h| 1958| none| 0| 5| 4| 0 | 0| 300| 250

22h| stadium (modern style, W part)| | | 00h| 1958 | none| 0| 5| 4| 0| 0| 300| 250

23h| stadium (modern style, S part)| | | 00h| 1958| none| 0| 5| 4 | 0| 0| 300| 250

24h| offices ('vertical tube' style)| temperate, sub-arctic, subtropical| 3, 4 | 01h| 2000| none| 140| 65| 8| 3| 2| 250 | 170

25h| houses| sub-arctic| 0, 1| 01h| 1930| 1960 | 15| 6| 3| 1| -1| 75| 70

26h | houses | snow| 0, 1| 01h| 1930| 1960| 15| 6| 3 | 1| -1| 75| 70

27h| cinema| temperate| 2, 3, 4 | 01h| 1945| none| 35| 23| 8| 2| 2| 230 | 210

28h| shopping mall (N part)| temperate| 1, 2, 3, 4| 10h| 1983| none | 180| 5| 8| 2| 3| 300| 250

29h  | shopping mall (E part) | | | 00h| 1983| none| 0| 5| 8| 2 | 3| 300| 250

2Ah| shopping mall (W part)| | | 00h| 1983| none| 0| 5| 8| 2| 3| 300| 250

2Bh| shopping mall (S part)| | | 00h| 1983| none| 0| 5| 8 | 2| 3| 300| 250

2Ch| flats| sub-arctic| 2, 3, 4| 01h| 1930| none| 80| 20| 5| 2| -2| 90| 100

2Dh| flats| snow| 2, 3, 4| 01h| 1930| none | 80| 20| 5| 2| -2| 90| 100

2Eh | houses | sub-arctic| 0, 1, 2, 3| 01h| 1930| none| 16| 6| 3| 1| -2| 70| 70

2Fh| houses| snow| 0, 1, 2, 3 | 01h| 1930| none| 16| 6| 3| 1| -2| 70 | 70

30h| houses| sub-arctic| 0, 1, 2| 01h| 1930| 1963 | 14| 6| 3| 1| -2| 70| 80

31h | houses | snow| 0, 1, 2| 01h| 1930| 1963| 14| 6| 3 | 1| -2| 70| 80

32h| tall office block| sub-arctic, subtropical| 3, 4 | 01h| 1966| none| 135| 60| 8| 3| 4| 120| 150

33h| tall office block| snow| 3, 4| 01h| 1966| none | 135| 60| 8| 3| 4| 120| 150

34h | tall office block | sub-arctic| 3, 4| 01h| 1970| none| 170| 70| 9 | 3| 4| 130| 170

35h| tall office block| snow| 3, 4 | 01h| 1970| none| 170| 70| 9| 3| 4| 130 | 170

36h| tall office block| sub-arctic, subtropical| 3, 4| 01h| 1974| none | 210| 80| 10| 3| 5| 140| 200

37h | tall office block | snow| 3, 4| 01h| 1974| none| 210| 80| 10 | 3| 5| 140| 200

38h| houses| sub-arctic| 0 | 01h| 1930| none| 10| 5| 2| 1| -1| 60| 60

39h| houses| snow| 0| 01h| 1930| none | 10| 5| 2| 1| -1| 60| 60

3Ah | shops and offices | sub-arctic| 1, 2, 3, 4| 01h| 1930| none| 25| 20| 3 | 1| -1| 80| 100

3Bh| shops and offices| snow| 1, 2, 3, 4 | 01h| 1930| none| 25| 20| 3| 1| -1| 80 | 100

3Ch| church| sub-arctic| 0, 1, 2, 3| 01h| 1930| none | 6| 2| 2| 0| 0| 230| 85

3Dh  | church | snow| 0, 1, 2, 3| 01h| 1930| none| 6| 2| 2| 0| 0| 230| 85

3Eh| houses| sub-arctic| 0, 1, 2 | 01h| 1930| none| 17| 7| 3| 1| -1| 80| 80

3Fh| houses| snow| 0, 1, 2| 01h| 1930| none | 17| 7| 3| 1| -1| 80| 80

40h | shops and offices | sub-arctic| 2, 3, 4| 01h| 1930| 1960| 90| 45| 6 | 2| 3| 110| 140

41h| shops and offices| snow| 2, 3, 4 | 01h| 1930| 1960| 90| 45| 6| 2| 3| 110 | 140

42h| hotel (N part)| sub-arctic| 2, 3, 4| 08h| 1972| none | 140| 25| 6| 1| -3| 160| 160

43h | hotel (E part) | | | 00h| 1972| none| 0| 25| 6| 1 | 2| 160| 160

44h| hotel (N part)| snow| 2, 3, 4| 08h | 1972| none| 140| 25| 6| 1| -3| 160| 160

45h| hotel (E part)| | | 00h| 1972| none| 0| 25| 6| 1| 2| 160| 160

46h| shops and offices| sub-arctic, subtropical | 2, 3, 4| 01h| 1963| none| 105| 50| 7| 2| 3 | 105| 130

47h| shops and offices| snow| 2, 3, 4| 01h| 1963 | none| 105| 50| 7| 2| 3| 105| 130

48h| tall office block| sub-arctic| 3, 4| 01h| 1978| none| 190| 75 | 9| 3| 4| 135| 190

49h| tall office block| snow| 3, 4| 01h| 1978| none| 190| 75| 9| 3| 4| 135| 190

4Ah| tall office block (N part)| sub-arctic| 2, 3, 4| 04h| 1967| none| 250| 60| 7| 2| 2| 200| 140

4Bh| tall office block (W part)| | | 00h| 1967| none| 0| 60| 7 | 2| 2| 200| 140

4Ch| tall office block (N part)| snow| 2, 3, 4| 04h| 1967| none| 250| 60| 7| 2| 2| 200 | 140

4Dh| tall office block (W part)| | | 00h| 1967| none| 0 | 60| 7| 2| 2| 200| 140

4Eh| houses (with a tree in a corner)| subtropical| 1, 2, 3, 4| 01h| 1930| none| 16| 6| 3| 1| -2| 80| 80

4Fh| houses| subtropical| 1, 2, 3, 4| 01h | 1930| none| 16| 6| 3| 1| -2| 80| 80

50h| houses| subtropical| 1, 2, 3, 4| 01h| 1930| none| 16| 5| 3| 1| -2| 80| 80

51h| houses (suburb-type) | subtropical| 0| 01h| 1930| none| 7| 4| 3| 1| -1| 30| 30

52h| flats| subtropical| 2, 3, 4| 01h| 1930| none| 45| 15| 6| 2| 1| 95| 130

53h| church| subtropical| 1, 2, 3| 01h| 1930| none| 8 | 3| 2| 0| 0| 200| 90

54h| houses (with two trees in front)| subtropical| 1, 2, 3, 4| 01h| 1930| none| 18| 7| 3| 1 | -2| 80| 80

55h| flats| subtropical| 2, 3, 4| 01h | 1973| none| 90| 24| 6| 2| 1| 95| 110

56h| flats| subtropical| 2, 3, 4| 01h| 1962| none| 120| 25| 6| 2| 1| 95| 120

57h| tall office block (N part) | subtropical| 3, 4| 04h| 1984| none| 250| 80| 8| 3| 4| 140| 190

58h| tall office block (W part)| subtropical| | 00h| 1984 | none| 0| 80| 8| 3| 4| 140| 190

59h| flats| subtropical| 2, 3, 4| 01h| 1930| none| 80| 23| 6| 2| 1| 95| 110

5Ah| tall office block| subtropical| 3, 4| 01h| 1993| none| 180| 90| 8| 3| 4| 150| 180

5Bh| church| toyland| 0, 1, 2, 3, 4| 01h| 1930| none| 8| 3| 2| 0| 0| 200| 90

5Ch| toyland houses| toyland| 0, 1, 2, 3, 4| 01h| 1930| none| 18| 5 | 6| 2| 2| 90| 90

5Dh| toyland houses| toyland | 0, 1| 01h| 1930| none| 7| 3| 3| 1| 1| 50| 70

5Eh| toyland houses| toyland| 0, 1, 2, 3| 01h| 1930| none| 15| 6| 3| 1| 2| 75| 80

5Fh| toyland houses| toyland| 0, 1, 2, 3| 01h| 1930| none| 17| 6 | 3| 1| 2| 75| 80

60h| toyland houses| toyland | 0, 1, 2, 3| 01h| 1930| none| 19| 6| 3| 1| 2 | 75| 80

61h| toyland houses| toyland| 0, 1, 2, 3| 01h| 1930| none| 21| 6| 3| 1| 2| 75| 80

62h| tall office block| toyland| 2, 3, 4| 01h| 1930| none| 75| 20 | 8| 4| 2| 130| 160

63h| shoe house (N part)| toyland | 0, 1, 2, 3, 4| 08h| 1930| none| 35| 9| 4| 1| 2 | 80| 90

64h| shoe house (E part)| | | 00h| 1930| none | 0| 0| 4| 1| 2| 80| 90

65h | tall office block | toyland| 2, 3, 4| 01h| 1930| none| 85| 18| 8 | 4| 2| 130| 150

66h| igloo| toyland| 0 | 01h| 1930| none| 11| 3| 3| 1| 1| 45  | 60

67h| tepees| toyland| 0| 01h| 1930| none | 10| 3| 3| 1| 1| 45| 60

68h| shops and offices | toyland| 2, 3, 4| 01h| 1930| none| 67| 22| 8 | 4| -4| 130| 140

69h| shops and offices| toyland| 2, 3, 4 | 01h| 1930| none| 86| 23| 8| 4| -4| 130 | 145

6Ah| tall office block| toyland| 2, 3, 4| 01h| 1930| none| 95| 28| 8| 4| 2| 130| 165

6Bh | statue | toyland| 2, 3, 4| 01h| 1930| none| 30| 10| 4 | 1| 2| 70| 90

6Ch| teapot-house| toyland| 0, 1, 2, 3, 4| 01h| 1930| none| 25| 8| 3| 1| 2| 65| 75

6Dh| piggy-bank| toyland| 0, 1, 2, 3, 4| 01h| 1930| none| 18| 7| 3| 2| -4| 95| 85

||

CargoDefaultProps

2011-06-12T21:18:31Z

Orudge: 4 revisions

'''''Default property values for TTD's cargo types'''''

=Default cargo properties for TTD=

Default property values for TTD's cargo types

This is the data TTD fills the 12 first cargo type slots with when starting a new game. The slots marked "--unused--" will still be initialized to these values, they just won't be used anywhere.

==Temperate==

||Name|Slot# (ID)|Bit# (08)|Icon (0E)|Weight (0F)|Penalty1 (10)|Penalty2 (11)|Price (12)|Color (13)|Color on graph (14)

Passengers|00|00|4297|1|0|24|3185|98h|98h

Coal|01|01|4298|16|7|255|5916|06h|06h

Mail|02|02|4299|4|20|90|4550|0Fh|0Fh

Oil|03|03|4300|16|25|255|4437|AEh|AEh

Livestock|04|04|4301|3|4|18|4322|D0h|D0h

Goods|05|05|4302|8|5|28|6144|C2h|C2h

Grain|06|06|4303|16|4|40|4778|BFh|BFh

Wood|07|07|4304|16|15|255|5005|37h|54h

Iron Ore|08|08|4305|16|9|255|5120|B8h|B8h

Steel|09|09|4306|16|7|255|5688|0Ah|0Ah

Valuables|0A|0A|4307|2|1|32|7509|BFh|CAh

--unused--|0B|1B|2|0|0|30|5688|30h|01h

Paper (*)|0B|1B|4313|16|7|60|5461|30h|01h||

(*) Stats if moreindustriesperclimate on. These are for reference only; moreindustriesperclimate is automatically disabled if newcargos is on.

==Arctic==

||Name|Slot# (ID)|Bit# (08)|Icon (0E)|Weight (0F)|Penalty1 (10)|Penalty2 (11)|Price (12)|Color (13)|Color on graph (14)

Passengers|00|00|4297|1|0|24|3185|98h|98h

Coal|01|01|4298|16|7|255|5916|06h|06h

Mail|02|02|4299|4|20|90|4550|0Fh|0Fh

Oil|03|03|4300|16|25|255|4437|AEh|AEh

Livestock|04|04|4301|3|4|18|4322|D0h|D0h

Goods|05|05|4302|8|5|28|6144|C2h|C2h

Wheat|06|06|4303|16|4|40|4778|BFh|BFh

Wood|07|07|4304|16|15|255|5005|37h|54h

--unused--|08|1C|2|0|9|255|5120|B8h|B8h

Paper|09|0B|4313|16|7|60|5461|0Ah|0Ah

Gold|0A|0A|4307|8|10|40|5802|BFh|CAh

Food|0B|0C|4312|16|0|30|5688|30h|01h||

==Tropic==

||Name|Slot# (ID)|Bit# (08)|Icon (0E)|Weight (0F)|Penalty1 (10)|Penalty2 (11)|Price (12)|Color (13)|Color on graph (14)

Passengers|00|00|4297|1|0|24|3185|98h|98h

Rubber|01|10|4314|16|2|20|4437|06h|06h

Mail|02|02|4299|4|20|90|4550|0Fh|0Fh

Oil|03|03|4300|16|25|255|4892|AEh|AEh

Fruit|04|0D|4308|16|0|15|4209|D0h|D0h

Goods|05|05|4302|8|5|28|6144|C2h|C2h

Maize|06|06|4303|16|4|40|4322|BFh|BFh

Wood|07|07|4304|16|15|255|7964|37h|54h

Copper Ore|08|0E|4309|16|12|255|4892|B8h|B8h

Water|09|0F|4310|16|20|80|4664|0Ah|0Ah

Diamonds|0A|0A|4311|2|10|255|5802|BFh|CAh

Food|0B|0C|4312|16|0|30|5688|30h|01h||

==Toyland==

||Name|Slot# (ID)|Bit# (08)|Icon (0E)|Weight (0F)|Penalty1 (10)|Penalty2 (11)|Price (12)|Color (13)|Color on graph (14)

Passengers|00|00|4297|1|0|24|3185|98h|98h

Sugar|01|11|4316|16|20|255|4437|06h|06h

Mail|02|02|4299|4|20|90|4550|0Fh|0Fh

Toys|03|12|4317|2|25|255|5574|AEh|AEh

Batteries|04|13|4323|4|2|30|4322|D0h|D0h

Candy|05|14|4315|5|8|40|6144|C2h|C2h

Toffee|06|15|4320|16|14|60|4778|BFh|BFh

Cola|07|16|4310|16|5|75|4892|37h|54h

Cotton Candy|08|17|4318|16|10|25|5005|B8h|B8h

Bubbles|09|18|4321|1|20|80|5077|0Ah|0Ah

Plastic|0A|19|4322|16|30|255|4664|BFh|CAh

Fizzy Drinks|0B|1A|4319|2|30|5|6250|30h|01h||

DebuggingGRFCode

2011-06-12T19:23:34Z

Orudge: 6 revisions

'''''Tools for debugging problems in GRF code'''''

=DebuggingGRFCode=

For the most part, writing NFO code, especially var.action 2 chains, is done by trial-and-error until it works. To help with this process, TTDPatch and OpenTTD provide various debugging tools.

OpenTTD nightly versions from r19723 and up include multiple newgrf debugging tools, including 'inspect' and a sprite aligner.  OpenTTD newgrf debugging tools are described in the OpenTTD manual: <nowiki>http://wiki.openttd.org/NewGRF_Debugging

</nowiki>

TTDPatch nightly versions from r663 and up include a sort of GRF debugger that displays what is going on.

To activate the debugger, use the sign cheat "Cht: grfdebug 1 <nowiki><nowiki>[</nowiki></nowiki><feature> <nowiki><nowiki>[</nowiki></nowiki><id> <nowiki><nowiki>[</nowiki></nowiki><callback>]]]".

The "1" is there to activate the debugger. This creates a file "grfdebug.log" (deleting any existing version first) to which all following debug information is written. The optional feature, id and callback values specify what to log. If specified, only the given feature, id and callback are logged. Note that the values have to be entered in ''decimal'', despite being hex everywhere else. When a value is missing or is equal to 255, it is not checked for a match. If the cheat fails due to "invalid parameter", it means the file "grfdebug.log" could not be created, possibly because a file of the same name exists but is not writable. If it fails with "unknown cheat", the given version does not have the GRF debugger built in (only nightly versions have it, not releases because it slows down graphics processing a little even when not used).

For instance, "Cht: grfdebug 1 1 255 18" logs callback 12 (load amount, decimal 18) for all road vehicles.

Due to the logging the game will become very slow when the debugger is active, so it is best to enable it in paused mode only, and to only briefly unpause if necessary. To trigger redrawing the graphics that are currently on the screen, press "t" (transparent mode) once. Otherwise, if the graphics in question are shown in a window, moving that window a small amount will also trigger redrawing them and call any callbacks necessary to display it.

When the problematic graphics have been displayed, turn off the debugger again with "Cht: grfdebug". This closes the "grfdebug.log" file, which may then be examined for the following entries. For help in interpreting the debug lines, ))DaleStan[[]]DaleStan[[ has written a [http://www.tt-forums.net/viewtopic.php?p=573250#573250|tool] to parse the "grfdebug.log" file into a more descriptive text file.

<pre>-+GET  cccciiff <grfid>+-</pre>

Written at the start when determining the sprite/callback result for feature ff, ID ii in callback cccc (callback is 0 if none, or 1 when determining random triggers). The given GRFID is the one owning the action 3 in question.

<pre>-+ACT2 <sprite> 00000000+-</pre>

When processing a regular, random or variational action 2. The sprite number is the sprite number in the .NFO file minus one, given in hex.

<pre>-+RND  <value> <rndbits>+-</pre>

In a random action 2, the random value is <value> with <rndbits> being the bits used to choose the next action 2.

<pre>-+VAR  <value> <adjusted>+-</pre>

In a variational action 2, the variable value has been computed as <value>, and <adjusted> will be used after shift/and/add/mod/div adjustments were applied. Note that this is a DWORD value, but only the BYTE/WORD part will be used depending on the var.action 2 type.

<pre>-+RSLT <result> 00000000+-</pre>

A callback result has been computed. When not in a callback, this causes the sprite determination to fail and default sprites to be used.

<pre>-+SPRT <sprite> 00000000+-</pre>

A sprite number has been computed. When in a callback, this causes the callback to fail if it isn't following a RSLT line indicating a valid callback result.

Since the value is mapped into TTD's sprite number space, it is not directly related to sprite numbers in the NFO file. To translate the returned sprite number to an action 1 block sprite, it is necessary to have this grf file be loaded first in newgrf(w).cfg. Then the sprite numbers of action 1 blocks will be allocated consecutively starting from the base number (see below) for each feature.

||Feature|Base number

other|1324 (4900) Note: this includes all features not listed below as well as GRM sprite allocations

Trains|4000 (16384)

Road vehicles|6CDC (27868)

Aircraft|99B8 (39352)

Ships|BBCD (48077)

Houses|DDE2 (56802)||

The feature-specific base numbers are only valid if the extended sprite limit is active, otherwise all features use the "other" base number.

For instance, the first sprite block of 32 (20 hex) sprites for a road vehicle would start at sprite 6CDC, then the following sprite block would start at 6CDC+20=6CFC.

GrfLoadingStages

2011-06-12T19:23:34Z

Orudge: 7 revisions

'''''Stages of loading a GRF file'''''

=The stages of loading a grf file=

Processing of .grf files is done in several passes, most of which happen repeatedly, once per activations, which is whenever a game is started/loaded or the "Apply" button in the GRF Status Window is pressed. Each pass processes all files in the order they appear in the GRF Status Window.

Essentially, initialization is a two-pass system (first resolve jump targets, then initialize everything) that happens only once, activation is a two-pass system (first define cargos and reserve GRM IDs, then activate) that happens multiple times, and testing is a one-pass system run per click on a red/green flag in the GRF Status Window.

||Pass|Description

Post-Load|Run once after loading all files. Initializes the targets of action 7&9 (to resolve goto jumps), ignores all other actions.

Initialization|Run once after the post-load pass. Checks action 0 for validity, records action 1 sprite numbers, resolves action 2 references (to the sprite numbers within the grf file of action 1 sprites and references to variational/random action 2), executes actions 6, 9, B, D and F, initializes action 3, 4, 8 and 11, and ignores the rest of the actions (including in particular action 7).

Reserve|Called just before activation, to reserve GRM IDs. Also applies action 0 for cargos to make cargo labels valid to check in action 7/9 independent of order of .grf files. Ignores all actions except action 0 (for cargos), 6, 7, 8, 9, B, D and E.

Activate|Called during activation. Applies all actions except F and 10.

Test|Called when user clicks to enable/disable file in the GRF Status Window to check which other files react to the change. Ignores all actions except 6, 7, 8, 9, B, D and E.||

A .grf file is activated only if it was active when the game was started. If a game is loaded, only its active .grfs will be reactivated. A .grf file is considered active if its action 8 has been processed, i.e. its action 8 hasn't been skipped using an action 7.

The following table shows exactly which actions are excuted in which passes (X=action executed, I=action initialized, empty=action ignored).

||Action|Load|Init|Res|Act|Test|Notes

0| |<center>X</center>|<center>X*</center>|<center>X</center>| |During reservation stage especially cargo- and railtypes are reserved, so their existence can be tested by all GRFs in activation stage independent of loading order.

1| |<center>I</center>| |<center>X</center>| |

2| |<center>I</center>| |<center>X</center>| |

3| |<center>I</center>| |<center>X</center>| |

4| |<center>I</center>| |<center>X</center>| |

5| | | |<center>X</center>| |

6| |<center>X</center>|<center>X</center>|<center>X*</center>|<center>X</center>|Processed during activation in a51 and later.

7|<center>I</center>| |<center>X</center>|<center>X</center>|<center>X</center>|

8| |<center>I</center>|<center>X</center>|<center>X</center>|<center>X</center>|When executed for an inactive file, skips remainder of file.

9|<center>I</center>|<center>X</center>|<center>X</center>|<center>X</center>|<center>X</center>|

A| | | |<center>X</center>| |

B| |<center>X*</center>|<center>X</center>|<center>X</center>|<center>X</center>|Processed during initialization only if bit 7 of severity is set.

C| | | | | |

D| |<center>X</center>|<center>X</center>|<center>X</center>|<center>X</center>|

E| | |<center>X</center>|<center>X</center>|<center>X</center>|

F| |<center>X</center>| | | |

10|<center>X</center>| | | | |

11| |<center>I</center>| |<center>X</center>| |

12| | | |<center>X</center>| | If TTDPatch encounters any Action12 during any stage (including "Load"), Unicode handling is enabled.

13| | | |<center>X</center>| |

14| | | | | | Processed by OpenTTD only when scanning for files. Not processed during the normal loading/activation. ||

StringCodes

2011-06-12T19:23:34Z

Orudge: 13 revisions

'''''Description of characters in TTD's character set'''''

=String Codes=

Texts in TTD are mostly in the Latin-1 (ISO-8859-1) character set (except when using UTF-8 encoding; see below), however a few characters are different.  Also, some characters have special meaning. These are explained in the following table.

||Range, hex|Meaning

00..1F|Control characters, unused except for the following:

|01 X offset in next byte of string (variable space)

|0D New line

|0E Set small font size

|0F Set large font size

|1F X and Y offsets in next two bytes of string

20..7A| Latin-1 characters, from space " " up to lower case "z"

7B..87| Formatting instructions, all take their argument from the stack if not otherwise specified

|7B Print dword

|7C Print signed word

|7D Print signed byte

|7E Print unsigned word

|7F Print dword in currency units

|80 Print substring (text ID from stack)

|81 Print substring (text ID in next 2 bytes of string)

|82 Print date (day, month, year)

|83 Print month and year

|84 Print signed word in speed units

|85 Discard next word from stack

|86 Rotate down top 4 words on stack

|87 Print signed word in litres

88..98|Colour codes

|88 Blue

|89 Light Gray

|8A Light Orange ("Gold")

|8B Red

|8C Purple

|8D ))Gray-Green[[]]Gray-Green[[

|8E Orange

|8F Green

|90 Yellow

|91 Light Green

|92 ))Red-Brown[[]]Red-Brown[[

|93 Brown

|94 White

|95 Light Blue

|96 Dark Gray

|97 Mauve (grayish purple)

|98 Black

99|Switch to company colour that follows in next byte (enabled by enhancegui)

9A|Extended format code in next byte:

|00 -or- 01 Display 64-bit value from stack in currency units

|02 Ignore next colour byte. Multiple instances will skip multiple colour bytes.

|03 WORD Push WORD onto the textref stack

|04 BYTE Un-print the previous BYTE characters.

|05 For internal use only. Not valid in GRF files.

|06 Print byte in hex (since TTDPatch r2007)

|07 Print word in hex (since TTDPatch r2007)

|08 Print dword in hex (since TTDPatch r2007)

|09 For internal use only. Usage in NewGRFs will most likely crash TTDPatch. (since TTDPatch r2128)

|0A For internal use only. Usage in NewGRFs will most likely crash TTDPatch. (since TTDPatch r2128)

|0B Print 64-bit value in hex (since TTDPatch r2178)

|0C Print name of station with id in next textrefstack word (since TTDPatch r2178)

|0D Print signed word in tonnes (since OpenTTD r21086)

|0E Set gender of string, NewGRF internal ID in next byte. Must be first in a string (since OpenTTD r21209) (*)

|0F Select case for next substring, NewGRF internal ID in next byte (since OpenTTD r21209) (*)

|10 Begin choice list value, NewGRF internal ID in next byte (since OpenTTD r21211) (**)

|11 Begin choice list default (since OpenTTD r21211) (**)

|12 End choice list (since OpenTTD r21211) (**)

|13 Begin gender choice list, stack offset of substring to get gender from in next byte (since OpenTTD r21211) (**)

|14 Begin case choice list (since OpenTTD r21211) (**)

|15 Begin plural choice list, stack offset of value to get plural for in next byte (since OpenTTD r21216) (***)

9B..9D|Reserved

9E..FF|Latin-1 characters, except for the following:

|9E Euro character "€"

|9F Capital Y umlaut "&Yuml;"

|A0 Scroll button up

|AA Scroll button down

|AC Tick mark

|AD X mark

|AF Scroll button right

|B4 Train symbol

|B5 Truck symbol

|B6 Bus symbol

|B7 Plane symbol

|B8 Ship symbol

|B9 Superscript -1

|BC Small scroll button up

|BD Small scroll button down||

The formatting instructions must not be used except in strings that expect them, and then they may not be out of order (with the possible exception of code 86 shuffling the internal stack). When used improperly, they will most likely crash TTD. Code 81 is always safe to use (provided that the referenced text ID uses no unsafe formatting instructions either), and will insert the given text ID (e.g. "\81\3D\A0" will insert text ID A03D, "\98Refit Aircraft"). Note however that if you want to include e.g. ID D000/D400, the 00 byte will be considered the end of string, and this will therefore break if additional texts are supposed to follow in the action 4. DCxx IDs must not be included; neither codes 80 nor 81 correctly access DCxx IDs.

Each formatting instructions removes its argument from the stack, so that the next one will receive the following bytes as arguments. Code 86 takes the top four words from the stack, let's call them W1 through W4, and reorders them as W4 W1 W2 W3. This is used for languages in which industries or stations should be named not "Flinfingbury Power Plant" but "Power Plant Flinfingbury".

(*) Maps a NewGRF internal gender or case ID to an OpenTTD gender or case. The internal ID is resolved to the appropriate OpenTTD gender or case at load time by means of the mapping. The first internal ID in the mapping that matches the ID from the string and has an existing OpenTTD gender or case is taken, i.e. the list of mappings is filtered by internal ID and existance of the OpenTTD gender/case and then the top element is used. When the gender or case ID is not known, or there is no existing OpenTTD gender or case with the mapped names the whole mapping is ignored and the default gender or case is taken.

-=Example=-

<pre>~pp~// Gender translation table

// Current OpenTTD German translation uses m, w, n and p but

// support a (fictitious) previous version that used masculine,

// feminine, neuter and plural as gender names.

 0 * 56     00 08 01 01 02

    13

       01 "m" 00

       01 "masculine" 00

       02 "w" 00

       02 "feminine" 00

       03 "n" 00

       03 "neuter" 00

       04 "p" 00

       04 "plural" 00

       00

// Brauerei is a female word in German; this sets it as female.

 1 * 40     04 0A 82 01 73 DC C3 9E 9A 0E 02 "Brauerei" 00

~/pp~</pre>

In this case OpenTTD would look for NewGRF internal ID 2 in the gender table. This would yield "w" and "feminine" as OpenTTD gender names. In current OpenTTD this would match "w", in the fictitious older version of OpenTTD it will match "feminine".

(**) Maps an OpenTTD gender or case to the NewGRF internal gender or case ID. The mapping is resolved at load time by going through all cases or genders OpenTTD's translation knows an mapping these to NewGRF internal IDs. If mapping is found the default choice list item is chosen. This happens by filtering the mapping on the gender or case name and then the NewGRF internal ID of the top element is used.

The choice list string codes are related and must be used in a specific manner:

Genders: 9A 13 <offset> (9A 10 <index> <string>)+ 9A 11 <default> 9A 12

Cases: 9A 14 (9A 10 <ndex> <string>)+ 9A 11 <default> 9A 12

Plurals: 9A 13 <offset> (9A 10 <index> <string>)+ 9A 11 <default> 9A 12

The offset is the stack location of the substring/value you want to get the gender/plural for. This is the real offset plus 80, i.e. an offset of 0 becomes 80 and an offset of 1 becomes 81 in the NFO.

-=Example=-

<pre>~pp~// Assuming the translation table of the previous example

// A string with a gender choice list and a stack item that gets resolved

 2 * 29     04 0A FF 01 1A DC "D" 9A 13 80 9A 10 1 "er" 9A 10 3 "as" 9A 11 "ie" 9A 12 " " 80 00

~/pp~</pre>

Imagine the "Brauerei" from the previous example being, as substring, on the stack. Then this string would resolve to "Die Brauerei".

What happens in OpenTTD is that whenever the "begin gender choice list" string code is found it will resolve the string at the given stack location. Of that resolved string the first character is compared to the "set gender" string code and if that is the case the (mapped) OpenTTD gender is retrieved. When there is "set gender" string code the first OpenTTD gender is used. After resolving the OpenTTD gender that gender is reverse mapped to a NewGRF internal ID. If that NewGRF internal ID exists in one of the "choice list values" that (sub)string is taken (up till the next choice list value/default). If there is no reverse mapping the string at the "choice list default" string code is used up till the "end choice list" string code. Further processing of the string happens after the choice list, i.e. the (sub)strings in the choice list may not contain any special string codes except colour codes.

Case choice lists work in a similar matter, except that instead of resolving a case from a (sub)string we "are" the substring; the string that includes this substring has set a case using the "select case" string code. As such no offset has to be given to the choice list, but the rest works in the same way as gender choice lists.

(***) The plural list works like a gender list, however you have to choose one "mapping" from value to plural index by setting the plural form using [[Action0GeneralVariables]] property 15.

If, for example, plural form 0 is chosen using the [[Action0GeneralVariables]] property 15, then there are 2 plural indices. If the value at the stack with the given offset equals 1 you get plural index 1, otherwise plural index 2. These plural indices are the indices that are used in the choice lists.

||Plural form|Plural index|Description

0|Two forms:

|1|1

|2|rest

1|Only one form:

|1|every form

2|Two forms:

|1|0 or 1

|2|rest

3|Three forms:

|1|ending in 1, but not ending in 11

|2|0

|3|rest

4|Five forms:

|1|1

|2|2

|3|3-6

|4|7-10

|5|rest

5|Three forms:

|1|ending in 1, but not ending in 11

|2|ending in 2-9, but not ending in 1~91~2-9~93~

|3|rest

6|Three forms:

|1|ending in 1, but not ending in 11

|2|ending in 2-4, but not ending in 1~91~2-4~93~

|3|rest

7|Three forms:

|1|0

|2|ending in 2-4, but not ending in 1~91~2-4~93~

|3|rest

8|Four forms:

|1|ending in 01

|2|ending in 02

|3|ending in 03 or ending in 04

|4|rest

9|Two forms:

|1|ending in 1, but not ending in 11

|2|ret

10|Three forms:

|1|1

|2|2-4

|3|rest

11|Two forms:

|1|ending in 0, 1, 3, 6, 7 and 8

|2|ending in 2, 4, 5 and 9

12|Four forms:

|1|1

|2|0 or ending in 02-10

|3|ending in 11-19

|4|rest||

-=Example=-

<pre>~pp~// Gender translation table

// Set the plural type to type 0

 0 * 7     00 08 01 01 02 15 00

// In case of the first stack item being 1 use "Tonne", otherwise use "Tonnen"

 1 * 34     04 0B 82 01 1A DC C3 9E "\UE07C Tonne" 9A 15 80 9A 10 01 "" 9A 11 "n" 9A 12 " Sand" 00

~/pp~</pre>

=UTF-8 support=

Since 2.0.1 alpha 68, TTDPatch supports UTF-8 encoded input strings. Use [[Action12|action 12]] to define glyphs for the characters which do not exist in TTD's .grf files (possible since 2.0.1 alpha 73).

To indicate that a given string is in UTF-8 encoding, start it with a capital thorn (U+00DE, "Þ"), encoded in UTF-8 as usual with the bytes C3 9E.  Everything in that string is then assumed to be in UTF-8 encoding, with the following exception: if characters appear that are not valid UTF-8 sequences, they are assumed to be one of the above control codes. This way, it is still possible to write, e.g. "ÞCapacity: " 87 "litres", without encoding the 87 in UTF-8 (which would instead refer to a character installed at codepoint U+0087).

In addition, this allows using the non-Unicode characters 9E, 9F, A0, AA, AC, AD, AF, B4..B9, BC and BD from the above list, which when encoded with UTF-8 would refer to their respective Unicode characters instead. To use the TTD characters, simply do not encode them using UTF-8 but enter them directly as bytes. This causes them to be an invalid UTF-8 sequence and allows TTDPatch to use the correct symbol from TTD's fonts.

Alternatively, these symbols (in fact, the TTD character set from 20 to FF) are also mapped into the Unicode Private Use Area at U+E0xx, so to encode the truck symbol, you may use character U+E0B5 as well, although this will probably be an unprintable character in most text editors.

Finally, characters 7B..7F no longer function as the above formatting instructions, but will display regular glyphs instead (provided they are installed; by default TTD has none at these codepoints). Instead, to use these formatting instructions in UTF-8 mode, you need to use their Private Use Area codepoint at U+E0xx.

Basically there are three possibilities:
# Characters U+E020..U+E0FF  in the E0xx Private Use Area do what their respective character xx would do in TTD, as do the control characters below U+0020
# All other valid UTF-8 sequences display actual glyphs, if they are available
# All invalid UTF-8 sequences do what their individual bytes would do in TTD

To summarize, here's a handy table:

||Character|Encoding in UTF-8 mode|Meaning

7E|7E|Unicode Character 'TILDE' (~)

82|82 (invalid UTF-8)|Print date (day, month, year)

82|C2 82|Display glyph for U+0082

AC|AC (invalid UTF-8)|Tick mark

AC|C2 AC|Unicode Character 'NOT SIGN' (¬)

E07E|EE 81 BE|Print unsigned word

E082|EE 82 82|Print date (day, month, year)

E0AC|EE 82 AC|Tick mark||

SpriteErrors

2011-06-12T19:23:33Z

Orudge: 13 revisions

'''''Explanation of all possible sprite error messages'''''

=Sprite Errors=

This page explains the error messages that may be generated due to incorrect pseudo-sprite data.  It does not include the messages that are only generated by an action B.

==List of sprite error messages==

||Message|Meaning

More sprites than specified|The file contains more sprites than the first pseudo-sprite specifies

Out of memory|TTDPatch could not read the sprite data because it ran out of memory

Wrong .grf version|Either the action 8 requires a different grf version, the file had no action 8, or the sprite uses an action that is not valid before action 8

Cannot load more sprites|The limit of active sprites has been exceeded

File ''file'' not found|The file was listed in newgrf(w).cfg but could not be opened

File ''file'' has invalid sprite #''nr'' (code ''code''/''pos'')|The pseudo-sprite data of the given sprite is invalid; see below for explanation of ''code'' and ''pos''

File ''file'' is not a TTDPatch graphics file|The first sprite is not a pseudo-sprite, or it does not specify a valid number of sprites||

==Invalid sprites==

A pseudo-sprite has invalid data, if it does not follow the specifications of each action correctly.  In this error message (starting with TTDPatch 2.0.1 alpha 46), the ''code'' defines what kind of error occured, and the position ''pos'' in most cases (i.e. whenever possible) points to the byte in the sprite that follows the one which triggered the error.

||Code|Meaning

1|A real graphics sprite was encountered where a pseudo sprite was expected

2|The sprite uses an unknown action type, or this action is not valid before an action 8

3|The sprite uses an unknown feature

4|The sprite refers to an invalid vehicle/text/town part ID

5|The sprite has fewer bytes than expected

6|The given property number in action 0 is invalid

7|The sprite block following action 1/5/A/11/12 would go beyond the end of the file

8|The feature types of action 1, 2 and 3 don't agree

9|Action 2 refers to an action 1 sprite block that is beyond the size of the most recent action 1 sprite block

10|Action 2 (var./random) or action 3 refers to an action 2 cargo-id that hasn't been defined yet

11|Action 7, 9 or D refers to an invalid variable number

12|The grf file has multiple action 8 entries

13|Action A refers to an invalid TTD sprite

14|The message severity in action B is invalid

15|The message type in action B is invalid

16|The operation type in action D is invalid

17|Action E is trying to deactivate an already-active file

18|The number of parts in action F is zero when it must not be zero

19|The bit number or count in action F is invalid

20|Invalid label number in action 10

21|Resource not valid for action D (ID out of range, or invalid for this resource type)

22|Multiple action 11 present in GRF file, there may only be one

23|A sprite that is part of action 11 is not a binary include file

24|Attempt to modify ID not reserved with GRM (only with experimentalfeatures.mandatorygrm on)

25|Invalid font number in action 12

26|Range crosses 128-character block, must be split

27|Invalid property value in action 0

28|Invalid condition type in action 7/9

29|Invalid industry tile ID in industry layout

30|Inconsistent industry layout size|

31|Invalid subid in action3||

Note, if you do not see the code or the position, you need to edit your ttdpttxt.txt file, and change the "invalidsprite" line into the following format (and then rerun mkpttxt.exe):

<pre>-+invalidsprite="\94File \"\80\" has invalid sprite #\7c (code \7c/\7c).\00"+-</pre>

==Resource conflicts==

If a GRF file attempts to allocate a resource that is not available, it will be deactivated and the following message will be shown: "GRF conflict with <other-grf> (resource <r-id> at sprite <num>)".

The following resources can cause conflicts. Numbers 0 and above are allocated by a GRM action D, negative numbers are automatically allocated by an action 0 (IDs), action 4 (persistent GRF texts) or actions 1/5/D/12 (sprites).

||r-id(s)|Resource

-12|Duplicate GRFID

-11|Persistent GRF texts

-10|New industries

-9|New industry tiles

-8|New houses

-7|New stations

-6|House sprites

-5|Plane sprites

-4|Ship sprites

-3|Road vehicle sprites

-2|Train sprites

-1|"Other" sprites

0..255|Vehicle IDs

256..287|Cargo IDs

288..319|Cargo bits||

TextIDs

2011-06-12T19:23:33Z

Orudge: 14 revisions

'''''TextIDs to use for Action 4'''''

This is a list of the text IDs in TTD (for action 4), originally compiled by A. Skrobov.

You can use these Text IDs
* to change/translate TTD strings using action4 feature 48. (This is not supported by OpenTTD, nor will it ever.)
* to reference them in various action 0 properties, e.g. for house/industry/cargo names. (This is partly supported by OpenTTD.)

Note: OpenTTD's string system is very different to the system of TTD and TTDPatch. It supports/requires plural forms, genders, cases and different number formattings, so complex strings which are combined from multiple parts are not interchangeable. Various strings also have changed their parameter order over time or got additional arguments.

As such action 4 is not allowed to change any original strings in OpenTTD; translations are not done via NewGRF, but only via the [http://translator.openttd.org/|WebTranslator].

In action 0 only a subset of the original strings can be accessed. These are more or less the string which have no additional parameters, e.g. plain cargo/house/industry names.

{maketoc}

=0000 General strings=

0000 \94Cannot remove obstacles on land

0001 \94Off edge of map

0002 \94Too close to edge of map

0003 \94Not enough cash - requires \7f

0004 \94\7f

0005 \8b\7f

0006

0007 \94Flat land required

0008 \98Waiting: \94\80

0009 \94\80

000A \94\80\90 (en-route from

000B \90\80)

000C \98Accepts: \94

000D \98Accepts: \8a

000E

000F Passengers

0010 Coal

0011 Mail

0012 Oil

0013 Livestock

0014 Goods

0015 Grain

0016 Wood

0017 Iron Ore

0018 Steel

0019 Valuables

001A Copper Ore

001B Maize

001C Fruit

001D Diamonds

001E Food

001F Paper

0020 Gold

0021 Water

0022 Wheat

0023 Rubber

0024 Sugar

0025 Toys

0026 Sweets

0027 Cola

0028 Candyfloss

0029 Bubbles

002A Toffee

002B Batteries

002C Plastic

002D Fizzy Drinks

002E

002F Passenger

0030 Coal

0031 Mail

0032 Oil

0033 Livestock

0034 Goods

0035 Grain

0036 Wood

0037 Iron Ore

0038 Steel

0039 Valuables

003A Copper Ore

003B Maize

003C Fruit

003D Diamond

003E Food

003F Paper

0040 Gold

0041 Water

0042 Wheat

0043 Rubber

0044 Sugar

0045 Toy

0046 Sweet

0047 Cola

0048 Candyfloss

0049 Bubble

004A Toffee

004B Battery

004C Plastic

004D Fizzy Drink

004E

004F | passenger

0050 | tonne of coal

0051 | bag of mail

0052 \87 of oil

0053 | item of livestock

0054 | crate of goods

0055 | tonne of grain

0056 | tonne of wood

0057 | tonne of iron ore

0058 | tonne of steel

0059 | bag of valuables

005A | tonne of copper ore

005B | tonne of maize

005C | tonne of fruit

005D | bag of diamonds

005E | tonne of food

005F | tonne of paper

0060 | bag of gold

0061 \87 of water

0062 | tonne of wheat

0063 \87 of rubber

0064 | tonne of sugar

0065 | toy

0066 | bag of sweets

0067 \87 of cola

0068 | tonne of candyfloss

0069 | bubble

006A | tonne of toffee

006B | battery

006C \87 of plastic

006D | fizzy drink

006E

006F | passengers

0070 | tonnes of coal

0071 | bags of mail

0072 \87 of oil

0073 | items of livestock

0074 | crates of goods

0075 | tonnes of grain

0076 | tonnes of wood

0077 | tonnes of iron ore

0078 | tonnes of steel

0079 | bags of valuables

007A | tonnes of copper ore

007B | tonnes of maize

007C | tonnes of fruit

007D | bags of diamonds

007E | tonnes of food

007F | tonnes of paper

0080 | bags of gold

0081 \87 of water

0082 | tonnes of wheat

0083 \87 of rubber

0084 | tonnes of sugar

0085 | toys

0086 | bags of sweets

0087 \87 of cola

0088 | tonnes of candyfloss

0089 | bubbles

008A | tonnes of toffee

008B | batteries

008C \87 of plastic

008D | fizzy drinks

008E

008F \0ePS

0090 \0eCL

0091 \0eML

0092 \0eOL

0093 \0eLV

0094 \0eGD

0095 \0eGR

0096 \0eWD

0097 \0eOR

0098 \0eST

0099 \0eVL

009A \0eCO

009B \0eMZ

009C \0eFT

009D \0eDM

009E \0eFD

009F \0ePR

00A0 \0eGD

00A1 \0eWR

00A2 \0eWH

00A3 \0eRB

00A4 \0eSG

00A5 \0eTY

00A6 \0eSW

00A7 \0eCL

00A8 \0eCF

00A9 \0eBU

00AA \0eTF

00AB \0eBA

00AC \0ePL

00AD \0eFZ

00AE \94\83

00AF \94\82

00B0 \94Map - \80

00B1 \94Game Options

00B2 \90Message

00B3 \90Message from \80

00B4 \94Can't do this....

00B5 \94Can't clear this area....

00B6 \98Copyright \a9 1995 Chris Sawyer,All rights reserved

00B7 \98Version 2.01.119 6th October 1995 17:19:21

00B8 \98Designed & Programmed by Chris Sawyer

00B9 \98Graphics by Simon Foster

00BA \98Music by John Broomhall\0dSound Programming by Andrew Parton\0d\0dQuality Assurance:\0dAndrew Luckett,Don Witcombe,Craig Lear, Daniel Luton,Justin Manning,\0dJason Sampson,Darren Kirby,Phil ))McDonnell[[]]McDonnell[[,Patrice Stauder\0dInstallation by Tim Cannell\0dProducer: Mike Rudderham\0d\0dThanks to: Jacqui Lyons at Marjacq Micro\0d

00BB \98Memory: {K ({K unused)

00BC \98Memory Manager:\80\80\80\80\80

00BD \98Processor: 80}86

00BE \98Graphics:

00BF VESA (

00C0 ATI

00C1 Trident

00C2 Oak Technologies

00C3 Tseng Labs

00C4 Paradise

00C5 \98\ad

00C6 \89\ad

00C7 \94Quit to DOS

00C8 \98Yes

00C9 \98No

00CA \90Are you sure you want to abandon this game and quit to DOS ?

00CB \981

00CC \982

00CD \983

00CE \984

00CF \985

00D0 Nothing

00D1 Dark Blue

00D2 Pale Green

00D3 Pink

00D4 Yellow

00D5 Red

00D6 Light Blue

00D7 Green

00D8 Dark Green

00D9 Blue

00DA Cream

00DB Mauve

00DC Purple

00DD Orange

00DE Brown

00DF Grey

00E0 White

00E1 \94Too many vehicles in game

00E2 \98|

00E3 \8b|

00E4 \98Location

00E5 Contours

00E6 Vehicles

00E7 Industries

00E8 Routes

00E9 Vegetation

00EA Owners

00EB \98\0eRoads

00EC \98\0eRailways

00ED \98\0eStations/Airports/Docks

00EE \98\0eBuildings/Industries

00EF \98\0eVehicles

00F0 \98\0e100m

00F1 \98\0e200m

00F2 \98\0e300m

00F3 \98\0e400m

00F4 \98\0e500m

00F5 \98\0eTrains

00F6 \98\0eRoad Vehicles

00F7 \98\0eShips

00F8 \98\0eAircraft

00F9 \98\0eTransport Routes

00FA \98\0eCoal Mine

00FB \98\0ePower Station

00FC \98\0eForest

00FD \98\0eSawmill

00FE \98\0eOil Refinery

00FF \98\0eFarm

0100 \98\0eFactory

0101 \98\0ePrinting Works

0102 \98\0eOil Wells

0103 \98\0eIron Ore Mine

0104 \98\0eSteel Mill

0105 \98\0eBank

0106 \98\0ePaper Mill

0107 \98\0eGold Mine

0108 \98\0eFood Processing Plant

0109 \98\0eDiamond Mine

010A \98\0eCopper Ore Mine

010B \98\0eFruit Plantation

010C \98\0eRubber Plantation

010D \98\0eWater Supply

010E \98\0eWater Tower

010F \98\0eLumber Mill

0110 \98\0eCandyfloss Forest

0111 \98\0eSweet Factory

0112 \98\0eBattery Farm

0113 \98\0eCola Wells

0114 \98\0eToy Shop

0115 \98\0eToy Factory

0116 \98\0ePlastic Fountains

0117 \98\0eFizzy Drink Factory

0118 \98\0eBubble Generator

0119 \98\0eToffee Quarry

011A \98\0eSugar Mine

011B \98\0eRailway Station

011C \98\0eLorry Loading Bay

011D \98\0eBus Station

011E \98\0eAirport/Heliport

011F \98\0eDock

0120 \98\0eRough Land

0121 \98\0eGrass Land

0122 \98\0eBare Land

0123 \98\0eFields

0124 \98\0eTrees

0125 \98\0eRocks

0126 \98\0eWater

0127 \98\0eNo Owner

0128 \98\0eTowns

0129 \98\0eIndustries

012A \98\0eDesert

012B \98\0eSnow

012C \94Message

012D \94\80

012E \98Cancel

012F \98OK

0130 \98Rename

0131 \94Too many names defined

0132 \94Chosen name in use already

0133 Pounds (\a3)

0134 Dollars ($)

0135 Franc (FF)

0136 Deutschmark (DM)

0137 Yen (\a5)

0138 Peseta (Pt)

0139 Imperial (miles)

013A Metric (kilometres)

013B \94...owned by \80

013C \98Cargo

013D \98Information

013E \98Capacities

013F \98Capacity: \95\80

0140 \98New Game

0141 \98Load Game

0142 \98Tutorial / Demonstration

0143 \981 Player

0144 \982 Players

0145 \942 Player Link Setup

0146 \98Attempt Connection

0147 \94Unable to make connection to remote computer

0148 \98Game Options

014A

014B  XMS

014C  VCPI

014D  DPMI

014E  Windows

014F  OS/2

0150 someone\85\85

0151 Map of world

0152 Town directory

0153 Subsidies

0154 Operating profit graph

0155 Income graph

0156 Delivered cargo graph

0157 Performance history graph

0158 Company value graph

0159 Cargo payment rates

015A Company league table

015B \94Transport Tycoon (Deluxe)

015C Save game

015D Abandon game

015E

015F Quit to DOS

0160 \90Are you sure you want to abandon this game ?

0161 \94Abandon Game

0162 Jan

0163 Feb

0164 Mar

0165 Apr

0166 May

0167 Jun

0168 Jul

0169 Aug

016A Sep

016B Oct

016C Nov

016D Dec

016E \0e\80\0d \80

016F \0e\80\0d \80\0d~

0170 \0e\80-

0171 \98Pause game

0172 \98Save game,abandon game,quit to DOS

0173 \98Display list of company's stations

0174 \98Display map

0175 \98Display map,town directory

0176 \98Display town directory

0177 \98Display company finances information

0178 \98Display company general information

0179 \98Display graphs

017A \98Display company league table

017B \98Display list of company's trains

017C \98Display list of company's road vehicles

017D \98Display list of company's ships

017E \98Display list of company's aircraft

017F \98Zoom the view in

0180 \98Zoom the view out

0181 \98Build railway track

0182 \98Build roads

0183 \98Build ship docks

0184 \98Build airports

0185 \98Plant trees,place signs etc.

0186 \98Query land block

0187 \98Options

0188 \98\bc

0189 \98\bd

018A \94Can't change servicing interval...

018B \98Close window

018C \98Window title - drag this to move window

018D \98Demolish buildings etc. on a square of land

018E \98Lower a corner of land

018F \98Raise a corner of land

0190 \98Scroll bar - scrolls list up/down

0191 \98Show land contours on map

0192 \98Show vehicles on map

0193 \98Show industries on map

0194 \98Show transport routes on map

0195 \98Show vegetation on map

0196 \98Show land owners on map

0197 \98Toggle town names on/off on map

0198 \0e\98Profit this year: \7f (last year: \7f)

0199 | year (|)

019A | years (|)

019B \8b| years (|)

019C Road vehicle

019D Aircraft

019E Ship

019F Train

01A0 \94\80 | is getting old

01A1 \94\80 | is getting very old

01A2 \94\80 | is getting very old and urgently needs replacing

01A3 \94Land Area Information

01A4 \98Cost to clear: \95N/A

01A5 \98Cost to clear: \95\7f

01A6 N/A

01A7 \98Owner: \95\80

01A8 \98Local authority: \95\80

01A9 None

01AA \98Name

01AB \98\0e\80

01AC 1st

01AD 2nd

01AE 3rd

01AF 4th

01B0 5th

01B1 6th

01B2 7th

01B3 8th

01B4 9th

01B5 10th

01B6 11th

01B7 12th

01B8 13th

01B9 14th

01BA 15th

01BB 16th

01BC 17th

01BD 18th

01BE 19th

01BF 20th

01C0 21st

01C1 22nd

01C2 23rd

01C3 24th

01C4 25th

01C5 26th

01C6 27th

01C7 28th

01C8 29th

01C9 30th

01CA 31st

01CB \0e|

01CC \98Toggle large/small map size

01CD \94Select Tutorial/Demonstration

01CE \98Cargo accepted: \95\80

01CF \98Cargo accepted: \95\80,\80

01D0 \98Cargo accepted: \95\80,\80,\80

01D1 (}/8 \80)

01D2 \94Jazz Jukebox

01D3 Sound/music

01D4 \98Show sound/music window

01D5 \0eAll

01D6 \0eOld Style

01D7 \0eNew Style

01D8 \0eEzy Street

01D9 \0eCustom 1

01DA \0eCustom 2

01DB \98\0eMusic Volume

01DC \98\0eEffects Volume

01DD \98\0eMIN ' ' ' ' ' ' MAX

01DE \98Skip to previous track in selection

01DF \98Skip to next track in selection

01E0 \98Stop playing music

01E1 \98Start playing music

01E2 \98Drag sliders to set music and sound effect volumes

01E3 \91\0e--

01E4 \91\0e0}

01E5 \91\0e}

01E6 \91\0e------

01E7 \91\0e"\80"

01E8 \98\0eTrack\01XTitle

01E9 \0eShuffle

01EA \0e\98Program

01EB \94Music Program Selection

01EC \0e\950|   "\80"

01ED \0e\95|   "\80"

01EE \0e\98Track Index

01EF \0e\98Program - '\80'

01F0 \0e\98Clear

01F1 \0e\98Save

01F2 \98Current program of music tracks

01F3 \98Select 'all tracks' program

01F4 \98Select 'old style music' program

01F5 \98Select 'new style music' program

01F6 \98Select 'Custom 1' (user-defined) program

01F7 \98Select 'Custom 2' (user-defined) program

01F8 \98Clear current program (Custom1 or Custom2 only)

01F9 \98Save music settings to disk

01FA \98Click on music track to add to current program (Custom1 or Custom2 only)

01FB \98Toggle program shuffle on/off

01FC \98Show music track selection window

01FD \98Click on service to centre view on industry/town

01FE \98Difficulty (\80)

01FF \0e\98\82

0200 Last message/news report

0201 Message settings

0202 Send message

0203 \98Show last message/news report,show message options

0204 \94Message Options

0205 \98Message types:-

0206 \90Arrival of first vehicle at player's station

0207 \90Arrival of first vehicle at competitor's station

0208 \90Accidents / disasters

0209 \90Company information

020A \90Economy changes

020B \90Advice / information on player's vehicles

020C \90New vehicles

020D \90Changes of cargo acceptance

020E \90Subsidies

020F \90General information

0210 \94...too far from previous destination

0211 \0f\98Top companies who reached 2050\0d(\80 Level)

0212 \0f|.

0213 Businessman

0214 Entrepreneur

0215 Industrialist

0216 Capitalist

0217 Magnate

0218 Mogul

0219 Tycoon of the Century

021A \0f'\80' (|)

021B \0f\80\80 achieves '\80' status!

021C \0f\80\80 of \80 achieves '\80' status!

021D \98

021E \94

021F \88|

0220 \98Create Scenario

0221 \90Transport Tycoon

0222 \90Scenario Editor

0223 \94Land Generation

0224 \98\a0

0225 \98\aa

0226 \98Random Land

0227 \98Reset Land

0228 \98Increase size of land area to lower/raise

0229 \98Decrease size of land area to lower/raise

022A \98Generate random land

022B \98Reset landscape

022C \94Reset Landscape

022D \98Are you sure you want to reset the landscape?

022E \98Landscape generation

022F \98Town generation

0230 \98Industry generation

0231 \98Road construction

0232 \98Vegetation and other objects

0233 \94Town Generation

0234 \98New Town

0235 \98Construct new town

0236 \94Can't build town here...

0237 \94...too close to edge of map

0238 \94...too close to another town

0239 \94...site unsuitable

023A \94...too many towns

023B \98Increase size of town

023C \98Expand

023D \98Random Town

023E \98Build town in random location

023F \94Industry Generation

0240 \98Coal Mine

0241 \98Power Station

0242 \98Sawmill

0243 \98Forest

0244 \98Oil Refinery

0245 \98Oil Rig

0246 \98Factory

0247 \98Steel Mill

0248 \98Farm

0249 \98Iron Ore Mine

024A \98Oil Wells

024B \98Bank

024C \98Paper Mill

024D \98Food Processing Plant

024E \98Printing Works

024F \98Gold Mine

0250 \98Lumber Mill

0251 \98Fruit Plantation

0252 \98Rubber Plantation

0253 \98Water Supply

0254 \98Water Tower

0255 \98Diamond Mine

0256 \98Copper Ore Mine

0257 \98Candyfloss Forest

0258 \98Sweet Factory

0259 \98Battery Farm

025A \98Cola Wells

025B \98Toy Shop

025C \98Toy Factory

025D \98Plastic Fountains

025E \98Fizzy Drink Factory

025F \98Bubble Generator

0260 \98Toffee Quarry

0261 \98Sugar Mine

0262 \98Construct Coal Mine

0263 \98Construct Power Station

0264 \98Construct Sawmill

0265 \98Plant Forest

0266 \98Construct Oil Refinery

0267 \98Construct Oil Rig (Can only be built near the edges of the map)

0268 \98Construct Factory

0269 \98Construct Steel Mill

026A \98Construct Farm

026B \98Construct Iron Ore Mine

026C \98Construct Oil Wells

026D \98Construct Bank (Can only be built in towns with a population greater than 1200)

026E \98Construct Paper Mill

026F \98Construct Food Processing Plant

0270 \98Construct Printing Works

0271 \98Construct Gold Mine

0272 \98Construct Bank (Can only be built in towns)

0273 \98Construct Lumber Mill (to clear rainforest and produce Wood)

0274 \98Plant Fruit Plantation

0275 \98Plant Rubber Plantation

0276 \98Construct Water Supply

0277 \98Construct Water Tower (Can only be built in towns)

0278 \98Construct Diamond Mine

0279 \98Construct Copper Ore Mine

027A \98Plant Candyfloss Forest

027B \98Construct Sweet Factory

027C \98Construct Battery Farm

027D \98Construct Cola Wells

027E \98Construct Toy Shop

027F \98Construct Toy Factory

0280 \98Construct Plastic Fountains

0281 \98Construct Fizzy Drink Factory

0282 \98Construct Bubble Generator

0283 \98Construct Toffee Quarry

0284 \98Construct Sugar Mine

0285 \94Can't build \80 here...

0286 \94...must build town first

0287 \94...only one allowed per town

0288 \98Plant trees

0289 \98Place sign

028A \98Random Trees

028B \98Plant trees randomly over landscape

028C \98Place rocky areas on landscape

028D \98Place lighthouse

028E \98Place transmitter

028F \98Define desert area

0290 \98Delete

0291 \98Delete this town completely

0292 Save scenario

0293 Load scenario

0294 Abandon editor

0295

0296 Quit to DOS

0297 \98Save scenario,load scenario,abandon scenario editor,quit to DOS

0298 \94Load Scenario

0299 \94Save Scenario

029A \98Play Scenario

029B \90Are you sure you want to abandon this scenario ?

029C \94Abandon Editor

029D \94...can only be built in towns with a population of at least 1200

029E \98Move the starting date backward 1 year

029F \98Move the starting date forward 1 year

02A0 \94...ends of bridge must both be on land

02A1 \98Small

02A2 \98Medium

02A3 \98Large

02A4 \98Select town size

02A5 \90Town size:

02A6 \94Message to Player 2

02A7 \98Change Modem Initialisation String:

02A8 \98Change Dial Number:

02A9 \94Modem init. string:

02AA \94Dial number:

02AB \98Serial Port

02AC COM1

02AD COM2

02AE COM3

02AF COM4

02B0 \98\80

02B1 \98Baud Rate

02B2 \98\85\80 baud

02B3 9600

02B4 14400

02B5 19200

02B6 \80 - \80

02B7 \98Show last message or news report

02B8 \98Summary

02B9 \98Full

02BA \89- - \80 - -

02BB Town directory

02BC \98Vehicle design names

02BD \98\80

02BE Default

02BF Custom

02C0 \98Save custom names to disk

02C1 \98Vehicle design names selection

02C2 \98Save customized vehicle design names to disk

02C4 Game options

02C6 Difficulty settings

02C8

02C9 \ac

02CA \01\0cTown names displayed

02CB \ac

02CC \01\0cStation names displayed

02CD \ac

02CE \01\0cSigns displayed

02CF \ac

02D0 \01\0cFull animation

02D1 \ac

02D2 \01\0cFull detail

02D3 \ac

02D4 \01\0cTransparent buildings

02D5 Query land block

02D6

02D7 ))ScreenShot[[]]ScreenShot[[ (Ctrl-S)

02D8 Giant ))ScreenShot[[]]ScreenShot[[ (Ctrl-G)

02D9 About 'Transport Tycoon'

02DA \98On

02DB \98Off

02DC \98Display subsidies

02DD Subsidies

02DE Map of world

02DF Town directory

02E0 \98Currency units

02E1 \98\85\80

02E2 \98Currency units selection

02E3 \98Distance units

02E4 \98\85\85\80

02E5 \98Distance units selection

02E6 \98Road vehicles

02E7 \98\85\85\85\80

02E8 \98Select side of road for vehicles to drive on

02E9 Drive on left

02EA Drive on right

02EB \98Town names

02EC \98\85\85\85\85\80

02ED \98Select style of town names

02EE English

02EF French

02F0 German

02F1 American

02F2 ))Latin-American[[]]Latin-American[[

02F3 Silly

02F4 \98Autosave

02F5 \98\85\85\85\85\85\80

02F6 \98Select interval between automatic game saves

02F7 Off

02F8 Every 3 months

02F9 Every 6 months

02FA Every 12 months

02FB \98Start a new game

02FC \98Load a saved game from disk

02FD \98View demonstrations/tutorials

02FE \98Create a customized game world/scenario

02FF \98Select single-player game

0300 \98Select two-player game

0301 \98Display game options

0302 \98Display difficulty options

0303 \98Start a new game,using a customized scenario

0304 \98Quit to DOS

0305 \98Leave 'Transport Tycoon',and quit to DOS

0306 \98View demonstration/tutorial

0307 \94Transport Tycoon (Deluxe)

0308 \98Select serial port to be used for direct or modem connection

0309 \98Select serial port speed for direct or modem connection

030A \98Attempt to connect to second computer for 2 player game

030B \98Change the modem initialisation string

030C \98Set the number to be dialled by the modem

030D \94...can only be built in towns

030E \98Select 'temperate' landscape style

030F \98Select 'sub-arctic' landscape style

0310 \98Select 'sub-tropical' landscape style

0311 \98Select 'toyland' landscape style

0312 \98Fund construction of new industry

0313 Fund new industry

0314 \94Fund new industry

0315 \80

0316 \94...can only be built in towns

0317 \94...can only be built in rainforest areas

0318 \94...can only be built in desert areas

0319 \90* * PAUSED * *

031A SCR|.PCX

031B \94Screenshot successfully saved to disk as '\80'

031C \94Screenshot failed!

031D \98Link method

031E \98\85\85\80

031F \98Select communications link method for 2-player game

0320 Serial cable (sender)

0321 Serial cable (receiver)

0322 Modem (send/dial)

0323 Modem (receive)

0324 Network - IPX protocol (sender)

0325 Network - IPX protocol (receiver)

0329 \98Purchase land for future use

032A \981: Road vehicle service

032B \982: Railway service

032C \983: Air service

032D \984: Ship service

032E \985: Railway service (advanced)

032F \8bAUTOSAVE

0330 \98Select 'Ezy Street style music' program

0331 \94...IPX driver not found

0332 \94...not enough free base memory for network buffers

0333 \94...unable to open an IPX socket

0334 \94Connection successful!\0d\0dGames now linked!

=0800 Basic land strings=

0800 \0e

0801 \8bCost: \7f

0802 \0e

0803 \8fIncome: \7f

0804 \0e

0805 \94Estimated Cost: \7f

0806 \0e

0807 \94Estimated Income: \7f

0808 \94Can't raise land here...

0809 \94Can't lower land here...

080A Rocks

080B Rough land

080C Bare land

080D Grass

080E Fields

080F Snow-covered land

0810 Desert

=1000 Railroad strings=

1000 \94Land sloped in wrong direction

1001 \94Impossible track combination

1002 \94Excavation would damage tunnel

1003 \94Already at sea-level

1004 \94Too high

1005 \94No suitable railway track

1006 \94Train inside depot

1007 \94...already built

1008 \94Must remove railway track first

1009 \94Too many depots

100A \94Railway Construction

100B \94Monorail Construction

100C \94MagLev Construction

100D \94Select Rail Bridge

100E \94Can't build train depot here...

100F \94Can't build railway station here...

1010 \94Can't build signals here...

1011 \94Can't build railway track here...

1012 \94Can't remove railway track from here...

1013 \94Can't remove signals from here...

1014 \94Train Depot Orientation

1015 Railway construction

1016 Monorail construction

1017 ))MagLev[[]]MagLev[[ construction

1018 \98Build railway track

1019 \98Build train depot (for building and servicing trains)

101A \98Build railway station

101B \98Build railway signals

101C \98Build railway bridge

101D \98Build railway tunnel

101E \98Toggle build/remove for railway track and signals

101F \98Bridge selection - click on selected bridge to build it

1020 \98Select rail depot orientation

1021 Railway track

1022 Railway track with signals

1023 Railway train depot

1024 \94...area is owned by another company

=1800 Road strings=

1800 \94Land sloped in wrong direction for road

1801 \94Must remove road first

1802 \94Road Construction

1803 \94Select Road Bridge

1804 \94Can't build road here...

1805 \94Can't remove road from here...

1806 \94Road Depot Orientation

1807 \94Can't build road vehicle depot here...

1808 \94Can't build bus station...

1809 \94Can't build lorry station...

180A Road construction

180B \98Build road section

180C \98Build road vehicle depot (for building and servicing vehicles)

180D \98Build bus station

180E \98Build lorry loading bay

180F \98Build road bridge

1810 \98Build road tunnel

1811 \98Toggle build/remove for road construction

1812 \98Bridge selection - click on selected bridge to build it

1813 \98Select road vehicle depot orientation

1814 Road

1815 Road with streetlights

1816 Tree-lined road

1817 Road vehicle depot

1818 Road/rail level crossing

=2000 Town strings=

2000 \94Towns

2001 \94\80

2002 \0e\98\80

2003 \0e\94\80

2004 \94Building must be demolished first

2005 \94\80

2006 \98Population: \8e{

2007 Rename Town

2008 \94Can't rename town...

2009 \94\80 local authority refuses to allow this

200A \98Town names - click on name to centre main view on town

200B \98Centre the main view on town location

200C \98Change town name

200D \98Passengers last month: \8e|\98 max: \8e|

200E \98Mail last month: \8e|\98 max: \8e|

200F Tall office block

2010 Office block

2011 Small block of flats

2012 Church

2013 Large office block

2014 Town houses

2015 Hotel

2016 Statue

2017 Fountain

2018 Park

2019 Office block

201A Shops and offices

201B Modern office building

201C Warehouse

201D Office block

201E Stadium

201F Old houses

2020 \98Local authority

2021 \98Show information on local authority

2022 \94\80 local authority

2023 \98Transport company ratings:

2024 \90\80\80: \8e\80

2025 \94Subsidies

2026 \98Subsidies on offer for services taking:-

2027 \8e\80 from \80 to \80

2028 \90 (by \83)

2029 \80 \80

202A \8eNone

202B \98Services already subsidised:-

202C \8e\80 from \80 to \80\90 (\80

202D \90,until \83)

202E \98\0fOffer of subsidy expired:\0d\0d\80 from \80 to \80 will now not attract a subsidy.

202F \98\0fSubsidy withdrawn:\0d\0d\80 service from \80 to \80 is no longer subsidised.

2030 \98\0fService subsidy offered:\0d\0dFirst \80 service from \80 to \80 will attract a year's subsidy from the local authority!

2031 \98\0fService subsidy awarded to \80!\0d\0d\80 service from \80 to \80 will pay 50% extra for the next year!

2032 \98\0fService subsidy awarded to \80!\0d\0d\80 service from \80 to \80 will pay double rates for the next year!

2033 \98\0fService subsidy awarded to \80!\0d\0d\80 service from \80 to \80 will pay triple rates for the next year!

2034 \98\0fService subsidy awarded to \80!\0d\0d\80 service from \80 to \80 will pay quadruple rates for the next year!

2035 \94\80 local authority refuses to allow another airport to be built in this town

2036 Cottages

2037 Houses

2038 Flats

2039 Tall office block

203A Shops and offices

203B Shops and offices

203C Theatre

203D Stadium

203E Offices

203F Houses

2040 Cinema

2041 Shopping mall

2042 \98Do it

2043 \98List of things to do at this town - click on item for more details

2044 \98Carry out the highlighted action in the list above

2045 \98Actions available:

2046 Small advertising campaign

2047 Medium advertising campaign

2048 Large advertising campaign

2049 Fund local road reconstruction

204A Build statue of company owner

204B Fund new buildings

204C Buy exclusive transport rights

204D \94\80\0d\90 Initiate a small local advertising campaign,to attract more passengers and cargo to your transport services.\0d Cost: \7f

204E \94\80\0d\90 Initiate a medium local advertising campaign,to attract more passengers and cargo to your transport services.\0d Cost: \7f

204F \94\80\0d\90 Initiate a large local advertising campaign,to attract more passengers and cargo to your transport services.\0d Cost: \7f

2050 \94\80\0d\90 Fund the reconstruction of the urban road network. Causes considerable disruption to road traffic for up to 6 months.\0d Cost: \7f

2051 \94\80\0d\90 Build a statue in honour of your company.\0d Cost: \7f

2052 \94\80\0d\90 Fund the construction of new commercial buildings in the town.\0d Cost: \7f

2053 \94\80\0d\90 Buy 1 year's exclusive transport rights in town. Town authority will only allow passengers and cargo to use your company's stations.\0d Cost: \7f

2054 \94Can't do this...

2055 \0f\98Traffic chaos in \80!\0d\0dRoad rebuilding programme funded by \80 brings 6 months of misery to motorists!

2056 \0e\94\80

2057 \8e\80\98  ({)

2058 \80 (under construction)

2059 Igloo

205A Tepees

205B ))Teapot-House[[]]Teapot-House[[

205C ))Piggy-Bank[[]]Piggy-Bank[[

=2800 Tree strings=

2800 Plant trees

2801 Place sign

2802 \94Trees

2803 \94...tree already here

2804 \94...site unsuitable

2805 \94Can't plant tree here...

2806 \94\80

2807 \0e\94\80

2808 \94...too many signs

2809 \94Can't place sign here...

280A Sign

280B \94Edit sign text

280C \94Can't change sign name...

280D \98Select tree type to plant

280E Trees

280F Rainforest

2810 Cactus Plants

=3000 Station strings=

3000 \94Rail Station Selection

3001 \94Airport Selection

3002 \98Orientation

3003 \98Number of tracks

3004 \98Platform length

3005 \94Too close to another railway station

3006 \94Adjoins more than one existing station/loading area

3007 \94Too many stations/loading areas in this town

3008 \94Too many stations/loading areas

3009 \94Too close to another station/loading area

300A \94\80 \81\d10

300B \94Must demolish railway station first

300C

300D \94Too close to another airport

300E \94Must demolish airport first

300F \80

3010 \80 North

3011 \80 South

3012 \80 East

3013 \80 West

3014 \80 Central

3015 \80 Transfer

3016 \80 Halt

3017 \80 Valley

3018 \80 Heights

3019 \80 Woods

301A \80 Lakeside

301B \80 Exchange

301C \80 Airport

301D \80 Oilfield

301E \80 Mines

301F \80 Docks

3020 \80 Buoy 1

3021 \80 Buoy 2

3022 \80 Buoy 3

3023 \80 Buoy 4

3024 \80 Buoy 5

3025 \80 Buoy 6

3026 \80 Buoy 7

3027 \80 Buoy 8

3028 \80 Buoy 9

3029 \80 Annexe

302A \80 Sidings

302B \80 Branch

302C Upper \80

302D Lower \80

302E \80 Heliport

302F \80 Forest

3030 Rename station/loading area

3031 \94Can't rename station...

3032 \98Ratings

3033 \98Accepts

3034 \98Local rating of transport service:

3035 Appalling

3036 Very Poor

3037 Poor

3038 Mediocre

3039 Good

303A Very Good

303B Excellent

303C Outstanding

303D \94\80: \90\80 (}%)

303E \94\80 no longer accepts \80

303F \94\80 no longer accepts \80 or \80

3040 \94\80 now accepts \80

3041 \94\80 now accepts \80 and \80

3042 \94Bus Station Orientation

3043 \94Lorry Station Orient.

3044 \94Too close to another bus station

3045 \94Too close to another lorry station

3046 \94Must demolish bus station first

3047 \94Must demolish lorry station first

3048 \94\80 - Stations

3049 \90\80 \81\d10

304A \90- None -

304B \94...site unsuitable

304C \94Too close to another dock

304D \94Must demolish dock first

304E \98Select railway station orientation

304F \98Select number of platforms for railway station

3050 \98Select length of railway station

3051 \98Select bus station orientation

3052 \98Select lorry loading bay orientation

3053 \98Centre main view on station location

3054 \98Show station ratings

3055 \98Change name of station

3056 \98Show list of accepted cargo

3057 \98Station names - click on name to centre main view on station

3058 \98Select size/type of airport

3059 \98Small

305A \98Large

305B \98Size

305C \98\80 \81\d10

305D \0e\98\80 \81\d10

305E Railway station

305F Aircraft hangar

3060 Airport

3061 Lorry loading area

3062 Bus station

3063 Ship dock

3064 \98Highlight catchment area of proposed site

3065 \98Don't highlight catchment area of proposed site

3066 \98Catchment area highlight

3067 \94Monorail Station Select.

3068 \94Dock

3069 Buoy

306A \94...buoy in the way

306B \98Heliport

306C \94...station too spread out

=3800 Water strings=

3800 \94Ship Depot Orientation

3801 \94...must be built on water

3802 \94Can't build ship depot here...

3803 \98Select ship depot orientation

3804 Water

3805 Coast or riverbank

3806 Ship depot

3807 \94...Can't build on water

=4000 Load/save strings=

4000 \94Save Game

4001 \94Load Game

4002 \98Save

4003 \98Delete

4004 \80, \82

4005 \98{ bytes free

4006 \98Unable to read drive

4007 \94Game Save Failed

4008 \94Unable to delete file

4009 \94Game Load Failed

400A \98List of drives,directories and saved-game files

400B \98Currently selected name for saved-game

400C \98Delete the currently selected saved-game

400D \98Save the current game,using the selected name

400E \94Select New Game Type

400F \98Select scenario (green),pre-set game (blue),or random new game

4010 Generate random new game

=4800 Industry strings=

4800 \94\80 in the way

4801 \94\80 \80

4802 Coal Mine

4803 Power Station

4804 Sawmill

4805 Forest

4806 Oil Refinery

4807 Oil Rig

4808 Factory

4809 Printing Works

480A Steel Mill

480B Farm

480C Copper Ore Mine

480D Oil Wells

480E Bank

480F Food Processing Plant

4810 Paper Mill

4811 Gold Mine

4812 Bank

4813 Diamond Mine

4814 Iron Ore Mine

4815 Fruit Plantation

4816 Rubber Plantation

4817 Water Supply

4818 Water Tower

4819 Factory

481A Farm

481B Lumber Mill

481C Candyfloss Forest

481D Sweet Factory

481E Battery Farm

481F Cola Wells

4820 Toy Shop

4821 Toy Factory

4822 Plastic Fountains

4823 Fizzy Drink Factory

4824 Bubble Generator

4825 Toffee Quarry

4826 Sugar Mine

4827 \98Requires: \90\80

4828 \98Requires: \90\80,\80

4829 \98Requires: \90\80,\80,\80

482A \98Production last month:

482B \90\80\98 (|% transported)

482C \98Centre the main view on industry location

482D \98\0fNew \80 under construction near \80!

482E \98\0fNew \80 being planted near \80!

482F \98Cost: \90\7f

4830 \94Can't construct this industry type here...

4831 \94...forest can only be planted above snow-line

4832 \98\0f\80 \80 announces imminent closure!

4833 \98\0fSupply problems cause \80 \80 to announce imminent closure!

4834 \98\0fLack of nearby trees causes \80 \80 to announce imminent closure!

4835 \98\0f\80 \80 increases production!

4836 \98\0fNew coal seam found at \80 \80!\0dProduction is expected to double!

4837 \98\0fNew oil reserves found at \80 \80!\0dProduction is expected to double!

4838 \98\0fImproved farming methods at \80 \80 are expected to double production!

4839 \98\0f\80 \80 production down by 50%

483A \98\0fInsect infestation causes havoc at \80 \80!\0dProduction down by 50%

483B \94...can only be positioned near edges of map

=5000 Tunnel and bridge strings=

5000 \94Train in tunnel

5001 \94Road vehicle in tunnel

5002

5003 \94Another tunnel in the way

5004

5005 \94Unable to excavate land for other end of tunnel

5006 \94Must demolish tunnel first

5007 \94Must demolish bridge first

5008 \94Cannot start and end on same position

5009 \94Level land or water required under bridge

500A \94Start and end must be in line

500B \94Site unsuitable for tunnel entrance

500C

500D \8a\80,\0d \84   \94\7f

500E Suspension,Steel

500F Girder,Steel

5010 Cantilever,Steel

5011 Suspension,Concrete

5012 Wooden

5013 Concrete

5014 Tubular,Steel

5015 \94Can't build bridge here...

5016 \94Can't build tunnel here...

5017 Railway tunnel

5018 Road tunnel

5019

501A

501B Steel suspension rail bridge

501C Steel girder rail bridge

501D Steel cantilever rail bridge

501E Reinforced concrete suspension rail bridge

501F Wooden rail bridge

5020 Concrete rail bridge

5021 Steel suspension road bridge

5022 Steel girder road bridge

5023 Steel cantilever road bridge

5024 Reinforced concrete suspension road bridge

5025 Wooden road bridge

5026 Concrete road bridge

5027 Tubular rail bridge

5028 Tubular road bridge

5029 Steel

=5800 Object strings=

5800 \94Object in the way

5801 Transmitter

5802 Lighthouse

5803 Company Headquarters

5804 \94...company headquarters in the way

5805 Company-owned land

5806 \94Can't purchase this land area...

5807 \94...you already own it!

=6000 Debugger strings=

6000 \94Debugger

6001 \8bAnimation blocks: |/|

6002 \98+Cash

6003 \98+Towns

6004 \98{

6005 \98+

6006 \98-

6007 \8bNon-Effect Objects: |/|

6008 \8bEffect Objects: |/|

6009 \8bText Effects: |/|

600A \98Land Code: |

600B \8bOrders: |/|

600C \8bNames: |/|

600D \98AllVeh

600E \98+Cmpny

600F \98Interrupts: |

6010 \98ID: |

6011 \98Serial resends: |

6012 \8eRand.Seed: \90|

6013 \8bGr.Cache Used: {/{

6014 \98Fingerprint: --------

6015 \8bStations: |/|

6016 \98Random seed: \8e{

6017 \98NPC PZ

6018 \94GAMES OUT OF SYNC!

=6800 Difficulty strings=

6800 \94Difficulty Level

6801 \98Easy

6802 \98Medium

6803 \98Hard

6804 \98Custom

6805 \95Maximum no. competitors: \8e|

6806 \95Competitor start time: \8e\80

6807 \95No. of towns: \8e\80

6808 \95No. of industries: \8e\80

6809 \95Maximum initial loan: \8e\7f

680A \95Initial interest rate: \8e|%

680B \95Vehicle running costs: \8e\80

680C \95Construction speed of competitors: \8e\80

680D \95Intelligence of competitors: \8e\80

680E \95Vehicle breakdowns: \8e\80

680F \95Subsidy multiplier: \8e\80

6810 \95Cost of construction: \8e\80

6811 \95Terrain type: \8e\80

6812 \95Quantity of sea/lakes: \8e\80

6813 \95Economy: \8e\80

6814 \95Train reversing: \8e\80

6815 \95Disasters: \8e\80

6816 Low

6817 Normal

6818 High

6819 \98&lt;

681A \98&gt;

681B Very Slow

681C Slow

681D Medium

681E Fast

681F Very Fast

6820 Low

6821 Medium

6822 High

6823 None

6824 Reduced

6825 Normal

6826 x1.5

6827 x2

6828 x3

6829 x4

682A Very Flat

682B Flat

682C Hilly

682D Mountainous

682E Steady

682F Fluctuating

6830 Immediate

6831 3 months after player

6832 6 months after player

6833 9 months after player

6834 At end of line,and at stations

6835 At end of line only

6836 Off

6837 On

6838 \98Show hi-score chart

=7000 Company strings=

7000 Unnamed\85\85

7001 \94\80\98\80

7002  (Player 1)

7003  (Player 2)

7004 \98New Face

7005 \98Colour Scheme

7006 \8aColour Scheme:

7007 \94New Colour Scheme

7008 \98Company Name

7009 \98Manager Name

700A Company Name

700B Manager's Name

700C \94Can't change company name...

700D \94Can't change manager's name...

700E \94\80 Finances\98\80

700F \94Expenditure/Income

7010 \94~

7011 \8aConstruction

7012 \8aNew Vehicles

7013 \8aTrain Running Costs

7014 \8aRoad Veh. Running Costs

7015 \8aAircraft Running Costs

7016 \8aShip Running Costs

7017 \8aProperty Maintenance

7018 \8aTrain Income

7019 \8aRoad Vehicles Income

701A \8aAircraft Income

701B \8aShip Income

701C \8aLoan Interest

701D \8aOther

701E \98-\7f

701F \98+\7f

7020 \94Total:

7021 \80\80

7022 \94Income Graph

7023 \7f

7024 {

7025 \94Operating Profit Graph

7026 \94Bank Balance

7027 \94Loan

7028 \98\7f

7029 \98Borrow \85\85\85\85\7f

702A \98Repay \85\85\85\85\7f

702B \94...maximum permitted loan size is \7f

702C \94Can't borrow any more money...

702D \94...loan already repayed

702E \94...\7f required

702F \94Can't repay loan...

7030 \98Select new face for manager

7031 \98Change the company vehicle livery

7032 \98Change the manager's name

7033 \98Change the company name

7034 \98Click on selected new colour scheme

7035 \98Increase size of loan

7036 \98Repay part of loan

7037 \94\80\0d\8a(Manager)

7038 \8aInaugurated: \94~

7039 \8aVehicles:

703A \94| train

703B \94| trains

703C \94| road vehicle

703D \94| road vehicles

703E \94| aircraft

703F \94| aircraft

7040 \94| ship

7041 \94| ships

7042 \94None

7043 \94Face Selection

7044 \98Male

7045 \98Female

7046 \98New Face

7047 \98Cancel new face selection

7048 \98Accept new face selection

7049 \98Select male faces

704A \98Select female faces

704B \98Generate random new face

704C \98Key

704D \98Show key to graphs

704E \94Key to company graphs

704F \98Click here to toggle company's entry on graph on/off

7050 \94Units of cargo delivered

7051 \94Company performance ratings (maximum rating=1000)

7052 \94Company values

7053 \94Company League Table

7054 \94\80\01-\8e\80 \98\80   '\80'

7055 \90\80\01-\8e\80 \98\80   '\80'

7056 \98\0fTransport company in trouble!

7057 \98\0f\80 will be sold off or declared bankrupt unless performance increases soon!

7058 \98\80\0d(Manager)

7059 \98\0fTransport company merger!

705A \98\0f\80 has been sold to \80 for \7f!

705B \94We are looking for a transport company to take-over our company\0d\0dDo you want to purchase \80 for \7f?

705C \98\0fBankrupt!

705D \98\0f\80 has been closed down by creditors and all assets sold off!

705E \98\0fNew transport company launched!

705F \98\0f\80 starts construction near \80!

7060 \94Can't buy company...

7061 \94Cargo Payment Rates

7062 \98\0eDays in transit

7063 \98\0ePayment for delivering 10 units (or 1,000 litres) of cargo a distance of 20 squares

7064 \98Toggle graph for cargo type on/off

7065 \98\0e\80

7066 Engineer

7067 Traffic Manager

7068 Transport Coordinator

7069 Route Supervisor

706A Director

706B Chief Executive

706C Chairman

706D President

706E Tycoon

706F \98Build HQ

7070 \98Build company headquarters / view company headquarters

7071 \94Can't build company headquarters...

7072 \98View HQ

7073 \0f\98World Recession!\0d\0dFinancial experts fear worst as economy slumps!

7074 \0f\98Recession Over!\0d\0dUpturn in trade gives confidence to industries as economy strengthens!

7075 \98Toggle large/small window size

7076 \8aCompany value: \94\7f

7077 \98Buy 25% share in company

7078 \98Sell 25% share in company

7079 \98Buy 25% share in this company

707A \98Sell 25% share in this company

707B \94Can't buy 25% share in this company...

707C \94Can't sell 25% share in this company...

707D \94(|% owned by \80)

707E \94(|% owned by \80\0d |% owned by \80)

707F \98\0f\80 has been taken over by \80!

=7800 Custom strings=

These cannot be set directly; an entry is generated every time the player enters a custom name for example for signs, stations or vehicles.

=8000 Vehicle type names=

Note, IDs 8000..80FF will be changed by using a regular action 4 to name new vehicles, but not by using "custom vehicle names" from vehicle.dat which use custom strings instead.

8000 Kirby Paul Tank (Steam)

8001 MJS 250 (Diesel)

8002 Ploddyphut ))Choo-Choo[[]]Choo-Choo[[

8003 Powernaut ))Choo-Choo[[]]Choo-Choo[[

8004 Mightymover ))Choo-Choo[[]]Choo-Choo[[

8005 Ploddyphut Diesel

8006 Powernaut Diesel

8007 Wills 2-8-0 (Steam)

8008 Chaney 'Jubilee' (Steam)

8009 Ginzu 'A4' (Steam)

800A SH '8P' (Steam)

800B ))Manley-Morel[[]]Manley-Morel[[ DMU (Diesel)

800C 'Dash' (Diesel)

800D SH/Hendry '25' (Diesel)

800E UU '37' (Diesel)

800F Floss '47' (Diesel)

8010 CS 4000 (Diesel)

8011 CS 2400 (Diesel)

8012 Centennial (Diesel)

8013 Kelling 3100 (Diesel)

8014 Turner Turbo (Diesel)

8015 MJS 1000 (Diesel)

8016 SH '125' (Diesel)

8017 SH '30' (Electric)

8018 SH '40' (Electric)

8019 'T.I.M.' (Electric)

801A 'AsiaStar' (Electric)

801B Passenger Carriage

801C Mail Van

801D Coal Truck

801E Oil Tanker

801F Livestock Van

8020 Goods Van

8021 Grain Hopper

8022 Wood Truck

8023 Iron Ore Hopper

8024 Steel Truck

8025 Armoured Van

8026 Food Van

8027 Paper Truck

8028 Copper Ore Hopper

8029 Water Tanker

802A Fruit Truck

802B Rubber Truck

802C Sugar Truck

802D Candyfloss Hopper

802E Toffee Hopper

802F Bubble Van

8030 Cola Tanker

8031 Sweet Van

8032 Toy Van

8033 Battery Truck

8034 Fizzy Drink Truck

8035 Plastic Truck

8036 'X2001' (Electric)

8037 'Millennium Z1' (Electric)

8038 Wizzowow Z99

8039 Passenger Carriage

803A Mail Van

803B Coal Truck

803C Oil Tanker

803D Livestock Van

803E Goods Van

803F Grain Hopper

8040 Wood Truck

8041 Iron Ore Hopper

8042 Steel Truck

8043 Armoured Van

8044 Food Van

8045 Paper Truck

8046 Copper Ore Hopper

8047 Water Tanker

8048 Fruit Truck

8049 Rubber Truck

804A Sugar Truck

804B Candyfloss Hopper

804C Toffee Hopper

804D Bubble Van

804E Cola Tanker

804F Sweet Van

8050 Toy Van

8051 Battery Truck

8052 Fizzy Drink Truck

8053 Plastic Truck

8054 Lev1 'Leviathan' (Electric)

8055 Lev2 'Cyclops' (Electric)

8056 Lev3 'Pegasus' (Electric)

8057 Lev4 'Chimaera' (Electric)

8058 Wizzowow Rocketeer

8059 Passenger Carriage

805A Mail Van

805B Coal Truck

805C Oil Tanker

805D Livestock Van

805E Goods Van

805F Grain Hopper

8060 Wood Truck

8061 Iron Ore Hopper

8062 Steel Truck

8063 Armoured Van

8064 Food Van

8065 Paper Truck

8066 Copper Ore Hopper

8067 Water Tanker

8068 Fruit Truck

8069 Rubber Truck

806A Sugar Truck

806B Candyfloss Hopper

806C Toffee Hopper

806D Bubble Van

806E Cola Tanker

806F Sweet Van

8070 Toy Van

8071 Battery Truck

8072 Fizzy Drink Truck

8073 Plastic Truck

8074 MPS Regal Bus

8075 Hereford Leopard Bus

8076 Foster Bus

8077 Foster MkII Superbus

8078 Ploddyphut MkI Bus

8079 Ploddyphut MkII Bus

807A Ploddyphut MkIII Bus

807B Balogh Coal Truck

807C Uhl Coal Truck

807D DW Coal Truck

807E MPS Mail Truck

807F Reynard Mail Truck

8080 Perry Mail Truck

8081 ))MightyMover[[]]MightyMover[[ Mail Truck

8082 Powernaught Mail Truck

8083 Wizzowow Mail Truck

8084 Witcombe Oil Tanker

8085 Foster Oil Tanker

8086 Perry Oil Tanker

8087 Talbott Livestock Van

8088 Uhl Livestock Van

8089 Foster Livestock Van

808A Balogh Goods Truck

808B Craighead Goods Truck

808C Goss Goods Truck

808D Hereford Grain Truck

808E Thomas Grain Truck

808F Goss Grain Truck

8090 Witcombe Wood Truck

8091 Foster Wood Truck

8092 Moreland Wood Truck

8093 MPS Iron Ore Truck

8094 Uhl Iron Ore Truck

8095 Chippy Iron Ore Truck

8096 Balogh Steel Truck

8097 Uhl Steel Truck

8098 Kelling Steel Truck

8099 Balogh Armoured Truck

809A Uhl Armoured Truck

809B Foster Armoured Truck

809C Foster Food Van

809D Perry Food Van

809E Chippy Food Van

809F Uhl Paper Truck

80A0 Balogh Paper Truck

80A1 MPS Paper Truck

80A2 MPS Copper Ore Truck

80A3 Uhl Copper Ore Truck

80A4 Goss Copper Ore Truck

80A5 Uhl Water Tanker

80A6 Balogh Water Tanker

80A7 MPS Water Tanker

80A8 Balogh Fruit Truck

80A9 Uhl Fruit Truck

80AA Kelling Fruit Truck

80AB Balogh Rubber Truck

80AC Uhl Rubber Truck

80AD RMT Rubber Truck

80AE ))MightyMover[[]]MightyMover[[ Sugar Truck

80AF Powernaught Sugar Truck

80B0 Wizzowow Sugar Truck

80B1 ))MightyMover[[]]MightyMover[[ Cola Truck

80B2 Powernaught Cola Truck

80B3 Wizzowow Cola Truck

80B4 ))MightyMover[[]]MightyMover[[ Candyfloss Truck

80B5 Powernaught Candyfloss Truck

80B6 Wizzowow Candyfloss Truck

80B7 ))MightyMover[[]]MightyMover[[ Toffee Truck

80B8 Powernaught Toffee Truck

80B9 Wizzowow Toffee Truck

80BA ))MightyMover[[]]MightyMover[[ Toy Van

80BB Powernaught Toy Van

80BC Wizzowow Toy Van

80BD ))MightyMover[[]]MightyMover[[ Sweet Lorry

80BE Powernaught Sweet Lorry

80BF Wizzowow Sweet Lorry

80C0 ))MightyMover[[]]MightyMover[[ Battery Truck

80C1 Powernaught Battery Truck

80C2 Wizzowow Battery Truck

80C3 ))MightyMover[[]]MightyMover[[ Fizzy Drink Truck

80C4 Powernaught Fizzy Drink Truck

80C5 Wizzowow Fizzy Drink Truck

80C6 ))MightyMover[[]]MightyMover[[ Plastic Truck

80C7 Powernaught Plastic Truck

80C8 Wizzowow Plastic Truck

80C9 ))MightyMover[[]]MightyMover[[ Bubble Truck

80CA Powernaught Bubble Truck

80CB Wizzowow Bubble Truck

80CC MPS Oil Tanker

80CD CS-Inc. Oil Tanker

80CE MPS Passenger Ferry

80CF FFP Passenger Ferry

80D0 Bakewell 300 Hovercraft

80D1 ))Chugger-Chug[[]]Chugger-Chug[[ Passenger Ferry

80D2 Shivershake Passenger Ferry

80D3 Yate Cargo ship

80D4 Bakewell Cargo ship

80D5 Mightymover Cargo ship

80D6 Powernaut Cargo ship

80D7 Sampson U52

80D8 Coleman Count

80D9 FFP Dart

80DA Yate Haugan

80DB Bakewell Cotswald LB-3

80DC Bakewell Luckett LB-8

80DD Bakewell Luckett LB-9

80DE Bakewell Luckett LB80

80DF Bakewell Luckett LB-10

80E0 Bakewell Luckett LB-11

80E1 Yate Aerospace YAC 1-11

80E2 Darwin 100

80E3 Darwin 200

80E4 Darwin 300

80E5 Darwin 400

80E6 Darwin 500

80E7 Darwin 600

80E8 Guru Galaxy

80E9 Airtaxi A21

80EA Airtaxi A31

80EB Airtaxi A32

80EC Airtaxi A33

80ED Yate Aerospace YAe46

80EE Dinger 100

80EF ))AirTaxi[[]]AirTaxi[[ A34-1000

80F0 Yate ))Z-Shuttle[[]]Z-Shuttle[[

80F1 Kelling K1

80F2 Kelling K6

80F3 Kelling K7

80F4 Darwin 700

80F5 FFP Hyperdart 2

80F6 Dinger 200

80F7 Dinger 1000

80F8 Ploddyphut 100

80F9 Ploddyphut 500

80FA Flashbang X1

80FB Juggerplane M1

80FC Flashbang Wizzer

80FD Tricario Helicopter

80FE Guru X2 Helicopter

80FF Powernaut Helicopter

8100 \94Message from vehicle manufacturer

8101 \8aWe have just designed a new \80 - would you be interested in a year's exclusive use of this vehicle,so we can see how it performs before making it universally available ?

8102 railway locomotive

8103 road vehicle

8104 aircraft

8105 ship

8106 monorail locomotive

8107 maglev locomotive

=8800 Train strings=

8800 \94\80 Train Depot

8801 \98\0fCitizens celebrate . . .\0dFirst train arrives at \80!

8802 \94\80 (Details)

8803 \94Train in the way

8804 \01\0A\7D: \80

8805 \AF\01\0A\7D: \80

8806 Go to \80

8807 Go to \80 (Unload)

8808 Go to \80 (Load)

8809

880A Go non-stop to \80

880B Go non-stop to \80 (Unload)

880C Go non-stop to \80 (Load)

880D

880E Go to \80 Train Depot

880F Go non-stop to \80 Train Depot

8810 \95Heading for \80

8811 \95Heading for \80 Train Depot

8812 \95Empty

8813 \95\80 from \80

8814 \94Train | is waiting in depot

8815 \98New Vehicles

8816 \98-

8817 \98Cost: \8a\7f\98 Weight: \8a|t\0d\98Speed: \8a\84\98 Power: \8a|hp\0d\98Running Cost: \8a\7f/yr\0d\98Capacity: \8a\80\0d\98Designed: \8a~\98 Life: \8a| years\0d\98Max. Reliability: \8a}%

8818 \98Information

8819 \94Train too long

881A \94Trains can only be altered when stopped inside a depot

881B \94\80 - Trains

881C \94New Rail Vehicles

881D \94New Monorail Vehicles

881E \94New Maglev Vehicles

881F \98Build Vehicle

8820 \98Rename

8821 \98Cost: \8a\7f\0d\98Weight: \8a|t (|t)\0d\98Capacity: \8a\80

8822 \95No orders

8823 \98Skip

8824 \98Delete

8825 \98Non-Stop

8826 \98Go To

8827 \98Full Load

8828 \98Unload

8829 \94\80 (Orders)

882A \01\0a- - End of Orders - -

882B \94Can't build rail vehicle...

882C \95\80\98 Built: \95~\98 Value: \95\7f

882D \95\80\98 Value: \95\7f

882E \94\80

882F \95Loading / Unloading

8830 \94Can't send train to depot...

8831 \94No more space for orders

8832 \94Too many orders

8833 \94Can't insert new order...

8834 \94Can't delete this order...

8835 \94Can't modify this order...

8836 \94Must build train depot first

8837 \94Can't move vehicle...

8838 N/A\85

8839 \94Can't sell rail vehicle...

883A \94Unable to find route to local depot

883B \94Can't stop/start train...

883C \98Servicing interval: \95|days\98 Last service: \95\82

883D \98Trains - click on train for information

883E \98Build new trains (requires train depot)

883F \98Trains - click on train for info.,drag vehicle to add/remove from train

8840 \98Build new train vehicle

8841 \98Drag train vehicle to here to sell it

8842 \98Centre main view on train depot location

8843 \98Train vehicle selection list - click on vehicle for information

8844 \98Build the highlighted train vehicle

8845 \98Rename train vehicle type

8846 \98Current train action - click here to stop/start train

8847 \98Show train's orders

8848 \98Centre main view on train's location

8849 \98Send train to depot

884A \98Force train to proceed without waiting for signal to clear

884B \98Reverse direction of train

884C \98Show train details

884D \98Increase servicing interval

884E \98Decrease servicing interval

884F \98Show details of cargo carried

8850 \98Show details of train vehicles

8851 \98Show capacities of each vehicle

8852 \98Orders list - click on order to highlight it

8853 \98Skip the current order,and start the next

8854 \98Delete the highlighted order

8855 \98Make the highlighted order non-stop

8856 \98Insert a new order before the highlighted order,or add to end of list

8857 \98Make the highlighted order force the vehicle to wait for a full load

8858 \98Make the highlighted order force the vehicle to unload

8859 \98\0fNew \80 now available!

885A \98\0f\80

885B \98Cost: \7f Weight: |t\0dSpeed: \84 Power: |hp\0dRunning Cost: \7f/yr\0dCapacity: \80

885C \8bBroken down

885D \98Age: \95\80\98 Running Cost: \95\7f/yr

885E \98Weight: \95|t \98Power: \95|hp\98 Max. speed: \95\84

885F \98Profit this year: \95\7f (last year: \7f)

8860 \98Reliability: \95}% \98Breakdowns since last service: \95|

8861 \8bStopped

8862 \94Can't make train pass signal at danger...

8863 \8bCrashed!

8864 Train |

8865 \94Name train

8866 \94Can't name train...

8867 \98Name train

8868 \98\0fTrain Crash!\0d| die in fireball after collision

8869 \94Can't reverse direction of train...

886A \94Rename train vehicle type

886B \94Can't rename train vehicle type...

=9000 Road vehicle strings=

9000 \94Road vehicle in the way

9001 \94\80 - Road Vehicles

9002 \94\80

9003 \94\80 Road Vehicle Depot

9004 \98New Vehicles

9005 \98Information

9006 \94New Road Vehicles

9007 \98Build Vehicle

9008 \98Cost: \8a\7f\98 Speed: \8a\84\0d\98Running Cost: \8a\7f/yr\0d\98Capacity: \8a\80\0d\98Designed: \8a~\98 Life: \8a| years\0d\98Max. Reliability: \8a}%

9009 \94Can't build road vehicle...

900A \94Must build road vehicle depot first

900B \94\80 (Orders)

900C \94\80 (Details)

900D \98Age: \95\80\98 Running Cost: \95\7f/yr

900E \98Max. speed: \95\84

900F \98Profit this year: \95\7f (last year: \7f)

9010 \98Reliability: \95}% \98Breakdowns since last service: \95|

9011 \95\80\98 Built: \95~\98 Value: \95\7f

9012 \98Capacity: \95\80

9013 \94...must be stopped inside a road vehicle depot

9014 \94Can't sell road vehicle...

9015 \94Can't stop/start road vehicle...

9016 \94Road Vehicle | is waiting in depot

9017 \95Heading for \80 Road Depot

9018 \94Can't send vehicle to depot...

9019 \94Unable to find local depot

901A \98Road vehicles - click on vehicle for information

901B \98Build new road vehicles (requires road vehicle depot)

901C \98Current vehicle action - click here to stop/start vehicle

901D \98Show vehicle's orders

901E \98Centre main view on vehicle's location

901F \98Send vehicle to depot

9020 \98Force vehicle to turn around

9021 \98Show road vehicle details

9022 \98Vehicles - click on vehicle for information

9023 \98Build new road vehicle

9024 \98Drag road vehicle to here to sell it

9025 \98Centre main view on road vehicle depot location

9026 \98Road vehicle selection list - click on vehicle for information

9027 \98Build the highlighted road vehicle

9028 \98\0fNew road vehicle now available!

9029 \98\0f\80

902A \98Cost: \7f\0dSpeed: \84\0dRunning Cost: \7f/yr\0dCapacity: \80

902B Road Vehicle |

902C \94Name road vehicle

902D \94Can't name road vehicle...

902E \98Name road vehicle

902F \98\0fCitizens celebrate . . .\0dFirst bus arrives at \80!

9030 \98\0fCitizens celebrate . . .\0dFirst lorry arrives at \80!

9031 \98\0fRoad Vehicle Crash!\0dDriver dies in fireball after collision with train

9032 \98\0fRoad Vehicle Crash!\0d| die in fireball after collision with train

9033 \94Can't make vehicle turn around...

9034 \98Rename

9035 \98Rename road vehicle type

9036 \94Rename road vehicle type

9037 \94Can't rename road vehicle type...

=9800 Ship strings=

9800 Dock construction

9801 \94Dock construction

9802 \94Can't build dock here...

9803 \94\80 Ship Depot

9804 \98New Ships

9805 \94\80 - Ships

9806 \94Can't build ships...

9807 \94Must build ship depot first

9808 \94New Ships

9809 \98Build Ship

980A \98Cost: \8a\7f\98 Speed: \8a\84\0d\98Capacity: \8a\80 \80\0d\98Running Cost: \8a\7f/yr\0d\98Designed: \8a~\98 Life: \8a| years\0d\98Max. Reliability: \8a}%

980B \94Ship must be stopped in depot

980C \94Can't sell ship...

980D \94Can't build ship...

980E \94Ship in the way

980F \94\80

9810 \94\80 (Orders)

9811 \94\80 (Details)

9812 \98Age: \95\80\98 Running Cost: \95\7f/yr

9813 \98Max. speed: \95\84

9814 \98Profit this year: \95\7f (last year: \7f)

9815 \98Reliability: \95}% \98Breakdowns since last service: \95|

9816 \95\80\98 Built: \95~\98 Value: \95\7f

9817 \98Capacity: \95\80

9818 \94Can't stop/start ship...

9819 \94Can't send ship to depot...

981A \94Unable to find local depot

981B \95Heading for \80 Ship Depot

981C \94Ship | is waiting in depot

981D \98Build ship dock

981E \98Build ship depot (for building and servicing ships)

981F \98Ships - click on ship for information

9820 \98Build new ship

9821 \98Drag ship to here to sell it

9822 \98Centre main view on ship depot location

9823 \98Ships - click on ship for information

9824 \98Build new ships (requires ship depot)

9825 \98Ship selection list - click on ship for information

9826 \98Build the highlighted ship

9827 \98Current ship action - click here to stop/start ship

9828 \98Show ship's orders

9829 \98Centre main view on ship's location

982A \98Send ship to depot

982B \98Show ship details

982C \98\0fNew ship now available!

982D \98\0f\80

982E \98Cost: \7f Max. Speed: \84\0dCapacity: \80\0dRunning Cost: \7f/yr

982F \98Name ship

9830 Ship |

9831 \94Name ship

9832 \94Can't name ship...

9833 \98\0fCitizens celebrate . . .\0dFirst ship arrives at \80!

9834 \98Position buoy,which can be used for additional way points

9835 \94Can't position buoy here...

9836 \98Rename

9837 \98Rename ship type

9838 \94Rename ship type

9839 \94Can't rename ship type...

983A \98Refit cargo ship to carry a different cargo type

983B \94\80 (Refit)

983C \98Refit ship

983D \98Select type of cargo for ship to carry

983E \98Refit ship to carry highlighted cargo type

983F \8aSelect cargo type to carry:-

9840 \98New capacity: \8a\80\0d\98Cost of refit: \8a\7f

9841 \94Can't refit ship...

9842 (refittable)

=A000 Aircraft strings=

A000 \94Airport Construct.

A001 \94Can't build airport here...

A002 \94\80 Aircraft Hangar

A003 \98New Aircraft

A004 \98Information

A005 \94New Aircraft

A006 \98Build Aircraft

A007 \98Cost: \8a\7f\98 Speed: \8a\84\0d\98Capacity: \8a| passengers,| bags of mail\0d\98Running Cost: \8a\7f/yr\0d\98Designed: \8a~\98 Life: \8a| years\0d\98Max. Reliability: \8a}%

A008 \94Can't build aircraft...

A009 \94\80 - Aircraft

A00A \94\80

A00B \94\80 (Orders)

A00C \94\80 (Details)

A00D \98Age: \95\80\98 Running Cost: \95\7f/yr

A00E \98Max. speed: \95\84

A00F \98Profit this year: \95\7f (last year: \7f)

A010 \98Reliability: \95}% \98Breakdowns since last service: \95|

A011 \95\80\98 Built: \95~\98 Value: \95\7f

A012 \94Can't send aircraft to hangar...

A013 \95Heading for \80 Hangar

A014 \94Aircraft | is waiting in the aircraft hangar

A015 \94Aircraft in the way

A016 \94Can't stop/start aircraft...

A017 \94Aircraft is in flight

A018 \94Must build airport first

A019 \98Capacity: \95\80,\80

A01A \98Capacity: \95\80

A01B \94Aircraft must be stopped in hangar

A01C \94Can't sell aircraft...

A01D Airport construction

A01E \98Build airport

A01F \98Aircraft - click on aircraft for information

A020 \98Build new aircraft (requires airport with hangar)

A021 \98Aircraft - click on aircraft for information

A022 \98Build new aircraft

A023 \98Drag aircraft to here to sell it

A024 \98Centre main view on hangar location

A025 \98Aircraft selection list - click on aircraft for information

A026 \98Build the highlighted aircraft

A027 \98Current aircraft action - click here to stop/start aircraft

A028 \98Show aircraft's orders

A029 \98Centre main view on aircraft's location

A02A \98Send aircraft to hangar

A02B \98Show aircraft details

A02C \98\0fNew aircraft now available!

A02D \98\0f\80

A02E \98Cost: \7f Max. Speed: \84\0dCapacity: | passengers,| bags of mail\0dRunning Cost: \7f/yr

A02F Aircraft |

A030 \94Name aircraft

A031 \94Can't name aircraft...

A032 \98Name aircraft

A033 \98\0fCitizens celebrate . . .\0dFirst aircraft arrives at \80!

A034 \98\0fPlane Crash!\0d| die in fireball at \80

A035 \0e\98Destinations:

A036 \0e\98\80

A037 \98Rename

A038 \98Rename aircraft type

A039 \94Rename aircraft type

A03A \94Can't rename aircraft type...

A03B \98Refit aircraft to carry a different cargo type

A03C \94\80 (Refit)

A03D \98Refit aircraft

A03E \98Select type of cargo for aircraft to carry

A03F \98Refit aircraft to carry highlighted cargo type

A040 \8aSelect cargo type to carry:-

A041 \98New capacity: \8a\80\0d\98Cost of refit: \8a\7f

A042 \94Can't refit aircraft...

A043 (refittable)

=A800 Pseudo-vehicle strings=

(None defined)

=B000 Disaster strings=

B000 \98\0fZeppelin disaster at \80!

B001 \98\0fRoad vehicle destroyed in 'UFO' collision!

B002 \98\0fOil refinery explosion near \80!

B003 \98\0fFactory destroyed in suspicious circumstances near \80!

B004 \98\0f'UFO' lands near \80!

B005 \98\0fCoal mine subsidence leaves trail of destruction near \80!

=B800 unused=

=C000 New station names=

This is used for TTDPatch newgrf station and class names. See action 4 for more details.

=C800 New house names=

This is used for TTDPatch newgrf town building names. See action 4 for more details.

=D000 Miscellaneous GRF texts=

This is used for TTDPatch newgrf miscellaneous texts, mostly for callbacks. See action 4 for more details.

The table has up to 1024 entries. To use entry X in an include text (codes 80/81), use ID D400+X. Note that if you want to include ID D000/D400, the 00 byte will be considered the end of string in action 4, this will therefore break if additional texts are supposed to follow in the action 4.

=D800 Persistent GRF texts=

This is used for TTDPatch newgrf persistent texts (the ID mappings are preserved through saving and loading even if the GRF file is unavailable). See action 4 for more details.

D800 class IDs (DCxx IDs) must not be used except in action 0 and where the spec explicitly says that they work.

=E000 Hard-coded game texts=

This text class exists only in TTDPatch 2.0.1 alpha 59 and later. It contains language-dependent texts that didn't have textIDs originally. This class allows translating TTD entirely by using action 4s, since now every language-dependent text can be accessed.

This list contains interspersed comments in parentheses.

(The first 12 elements are the full month names used for dates)

E000 January

E001 February

E002 March

E003 April

E004 May

E005 June

E006 July

E007 August

E008 September

E009 October

E00A November

E00B December

(The following 13 names are used for companies that aren't manually named and can't use "xxx Transport" for some reason)

E00C Bloggs Brothers

E00D Tiny Transport Ltd.

E00E Express Travel

E00F ))Comfy-Coach[[]]Comfy-Coach[[ & Co.

E010 Crush & Bump Ltd.

E011 Broken & Late Ltd.

E012 Sam Speedy & Son

E013 Supersonic Travel

E014 Mike's Motors

E015 Lightning International

E016 Pannik & Loozit Ltd.

E017 ))Inter-City[[]]Inter-City[[ Transport

E018 Getout & Pushit Ltd.

(The following 41 texts are last names to be used for managers of AI companies)

E019 Adams

E01A Allan

E01B Baker

E01C Bigwig

E01D Black

E01E Bloggs

E01F Brown

E020 Campbell

E021 Gordon

E022 Hamilton

E023 Hawthorn

E024 Higgins

E025 Green

E026 Gribble

E027 Jones

E028 ))McAlpine[[]]McAlpine[[

E029 ))MacDonald[[]]MacDonald[[

E02A ))McIntosh[[]]McIntosh[[

E02B Muir

E02C Murphy

E02D Nelson

E02E O'Donnell

E02F Parker

E030 Phillips

E031 Pilkington

E032 Quigley

E033 Sharkey

E034 Thomson

E035 Watkins

(Names above this are used for the first three climates, the following ones are used in toyland only)

E036 Grumpy

E037 Dozy

E038 Speedy

E039 Nosey

E03A Dribble

E03B Mushroom

E03C Cabbage

E03D Sniffle

E03E Fishy

E03F Swindle

E040 Sneaky

E041 Nutkins

(The following two texts must be exactly 19 characters long, and must contain letters that are available as shortened first names of AI company managers like "C. F. Watkins".

The first ID is used for first names, the second is for middle names, but having a middle name has a small chance.)

E042 ABCDEFGHIJKLMNPRSTW

E043 ABCDEFGHIJKLMNPRSTW

(The following two are suffixes shown in the load/save dialog)

E044 .. (Parent Directory)

E045  (Directory)

(Suffix to be used after the manager name to create a company name)

E046  Transport

(Suffix to be used after an English or German town name to create a company name)

E047  Transport

(Suffix to be used after a French, Spanish or silly town name to create a company name)

E048  Transport

(The following three are used for printing liquid amounts and speeds)

E049  litres

E04A kmh-1

E04B mph

(The following suffix is used to make a company name from an AI last name. (e.g. Watkins & Co.))

E04C  & Co.

=E800 News texts=

This is used internally by TTDPatch for its additional news messages.

=F000 unused=

(Unused, but TTD's critical error messages internally have a number in this region, even though they aren't text IDs as such.)

=F800 Internal TTDPatch texts=

This is used internally by TTDPatch for its additional regular strings, i.e. those from ttdpttxt.txt. Since 2.0.1 alpha 59 you may use the following text IDs to change the respective patch strings (before alpha 59, the text IDs changed regularly). For default values, please see ttdpttxt.txt produced by mkpttxt.exe.

In case this list is outdated, you can also see their definitions (including the default strings in all 5 standard languages) by running -+mkpttxt -l <nowiki><nowiki>[langnum]</nowiki></nowiki>+-.

F800 bribetext

F801 bribedesc

F802 bribefailed

F803 headingfor

F804 headingfordepot1

F805 headingfordepot2

F806 headingfordepot3

F807 headingfordepot4

F808 withsignals

F809 wplainsignals

F80A wpresignals

F80B wpresigexits

F80C wprecombined

F80D presigautomatic

F80E presigmanual

F80F pathbasedauto

F810 pathbasedmanual

F811 vehmulttoolow

F812 rchunknotloaded

F813 loadgame

F814 gotodepot

F815 gotodepotonly

F816 gototraindepot

F817 gotoroaddepot

F818 gotoshipdepot

F819 gotoairdepot

F81A routethrough

F81B routenonstopthrough

F81C vehobsolete

F81D cannotcheat

F81E cheatinvalidparm

F81F cheatunknown

F820 cheatobsolete1

F821 cheatobsolete2

F822 nostationhere

F823 managedby1

F824 managedby2

F825 manage

F826 engineinfo1

F827 wagonpower

F828 engineinfo2

F829 wagoninfo

F82A newwagoninfo

F82B wagonspeedlimit

F82C refittableto

F82D refittabletoallbut

F82E refittabletoall

F82F railwaywagon

F830 monorailwagon

F831 maglevwagon

F832 ufodestroyed

F833 rvweightinfo

F834 rvweightpurchasewindow

F835 grfloaderror

F836 toomanysprites

F837 outofmemory

F838 wronggrfversion

F839 toomanyspritestotal

F83A filenotfound

F83B invalidsprite

F83C notttdpatchgrf

F83D grferror

F83E grfwarning

F83F grfneedspatchversion

F840 grfneedsdoswin

F841 grfwantsswitch

F842 grfinvalidparam

F843 grfconflict

F844 grfstatcaption

F845 grfstatapply

F846 grfstatreset

F847 grfinfotext

F848 grflisthint

F849 grfapplyhint

F84A grfresethint

F84B grfstatusmenu

F84C initialgrfsettings

F84D initialgrfsettingshint

F84E grfstatgeninfo1

F84F grfstatgeninfo2

F850 grfstatgeninfo3

F851 grfstatgeninfo4

F852 grfstatmax

F853 elecrailconstitle

F854 elecrailconsmenu

F855 lmilloutoftrees

F856 eurointroduced

These next thirteen text IDs, and the six at F8DD..F8E2 are difficult, if not impossible, to set correctly using action 4. Use [[Action0GeneralVariables|action 0]] instead.

F857 curr_HUF

F858 curr_PLN

F859 curr_ATS

F85A curr_BEF

F85B curr_DKK

F85C curr_FIM

F85D curr_GRD

F85E curr_CHF

F85F curr_NLG

F860 curr_ITL

F861 curr_SEK

F862 curr_RUB

F863 curr_EUR

F864 townlastmonthaccepted

F865 aircraftcleared

F866 zeppelincleared

F867 traincleared

F868 endofsharedorders

F869 resetorders

F86A toggleservice

F86B resethint

F86C servicehint

F86D nosort

F86E sortconsistnum

F86F sortprofit

F870 sortlastprofit

F871 sortage

F872 sortmaxspeed

F873 sortreliability

F874 sortcargo

F875 sortdestination

F876 sorthint

F877 performance

F878 vehiclelost

F879 wrongrailtype

F87A neterror1

F87B neterror2

F87C desynch1

F87D desynch2

F87E refitvehicle

F87F refitcargohint

F880 refitbuttonhint

F881 cantbuildcanalhere

F882 fundprospecting

F883 buildindustry

F884 fundingfailed

F885 cannotfundprospecting

The following 9 TextIDs are used if vehicle message are set to use the vehicle name, not the vehicle number (i.e. if miscmods.usevehnumbernotname is off). They behave in the following manner: If set to an empty string (a single 00 - the default value), the Patch tries to automatically generate each them from one or two original TTD TextIDs. If it is unable to match and replace the string (which is likely to happen with translated strings), it simply displays a string with format "name??".

F886 newtrainindepot - Looks for TextID 8864 in TextID 8814. Equivalent string is "\94\80 is waiting in depot".

F887 newrvindepot - Looks for TextID 902B in TextID 9016. Equivalent string is "\94\80 is waiting in depot".

F888 newshipindepot - Looks for TextID 9830 in TextID 981C. Equivalent string is "\94\80 is waiting in depot".

F889 newaircraftinhangar - Looks for TextID A02F in TextID A014. Equivalent string is "\94\80 is waiting in the aircraft hangar".

F88A newvehold - Generated from TextID 01A0. Equivalent string is "\94\80 is getting old".

F88B newvehveryold - Generated from TextID 01A1. Equivalent string is "\94\80 is getting very old".

F88C newvehveryveryold - Generated from TextID 01A2. Equivalent string is "\94\80 is getting very old and urgently needs replacing".

F88D newvehiclelost - Generated from TextID F878 (vehiclelost). Equivalent string is "\94\80 seems to be lost".

F88E newcantreverse - Generated from TextID F8AE (cantreverse). Equivalent string is "\94\80 needs to reverse but cannot do so safely.".

F88F txtetoolboxmenu

F890 txtetoolbox

F891 txtetoolbox_tsigns

F892 txtetoolbox_tsignstrans

F893 txtetoolbox_tsignsold

F894 txtetoolbox_dsize

F895 txtetoolbox_d8

F896 txtetoolbox_d10

F897 txtetoolbox_d12

F898 txtetoolbox_d14

F899 txtetoolbox_d16

F89A txtetoolbox_d18

F89B txtetoolbox_d20

F89C txtetoolbox_depotalltrash

F89D txtetoolbox_on

F89E txtetoolbox_off

F89F txtetoolbox_saveinsavegame

))F8A0[[]]F8A0[[ txtetoolbox_usedefaultinsave

))F8A1[[]]F8A1[[ txtetoolbox_saveasdefault

))F8A2[[]]F8A2[[ txtetoolbox_resetdefaultsizes

))F8A3[[]]F8A3[[ none

))F8A4[[]]F8A4[[ low

))F8A5[[]]F8A5[[ normal

))F8A6[[]]F8A6[[ high

))F8A7[[]]F8A7[[ defaultstation

))F8A8[[]]F8A8[[ stationnumdefault

))F8A9[[]]F8A9[[ stationclassdefault

F8AA unnamedtownnamestyle

F8AB newshistory

F8AC messagesettings

F8AD messages

F8AE cantreverse

F8AF grflanguage

))F8B0[[]]F8B0[[ sizertooltip

))F8B1[[]]F8B1[[ stickytooltip

))F8B2[[]]F8B2[[ rcw_railway

))F8B3[[]]F8B3[[ rcw_signaltype

))F8B4[[]]F8B4[[ rcw_semaphores

))F8B5[[]]F8B5[[ rcw_lights

))F8B6[[]]F8B6[[ rcw_automatic

))F8B7[[]]F8B7[[ rcw_normal

))F8B8[[]]F8B8[[ rcw_entry

))F8B9[[]]F8B9[[ rcw_exit

F8BA rcw_combo

F8BB rcw_nopbs

F8BC rcw_pbs

F8BD rcw_tracks

F8BE rcw_length

F8BF rcw_drag

))F8C0[[]]F8C0[[ rcw_class

))F8C1[[]]F8C1[[ rcw_type

))F8C2[[]]F8C2[[ rcw_accepts

))F8C3[[]]F8C3[[ outofdynmem

))F8C4[[]]F8C4[[ cantresize

))F8C5[[]]F8C5[[ grftextnotfound

))F8C6[[]]F8C6[[ newindubuildindustry

))F8C7[[]]F8C7[[ newindufundprospecting

))F8C8[[]]F8C8[[ newinduproduces

))F8C9[[]]F8C9[[ toomanyindustries

F8CA newindulist_tooltip

F8CB newinduinfo_tooltip

F8CC newindubuild_tooltip

F8CD newinduprospect_tooltip

F8CE newindu_cargowaiting

F8CF warning_notowns

))F8D0[[]]F8D0[[ localplayer

))F8D1[[]]F8D1[[ remoteplayer

))F8D2[[]]F8D2[[ multiplayer

))F8D3[[]]F8D3[[ multiplayer_tooltip

))F8D4[[]]F8D4[[ patchsnd_dll_notfound

))F8D5[[]]F8D5[[ statistics

))F8D6[[]]F8D6[[ statistics_white

))F8D7[[]]F8D7[[ totalcargo

))F8D8[[]]F8D8[[ landareainfoheight

))F8D9[[]]F8D9[[ txteroadmenu

F8DA txtetramwindowheader

F8DB hotkeylistdos

F8DC hotkeylistwin

These next six text IDs, and the thirteen at F857..F863 are difficult, if not impossible, to set correctly using action 4. Use [[Action0GeneralVariables|action 0]] instead.

F8DD curr_pound

F8DE curr_dollar

F8DF curr_franc

))F8E0[[]]F8E0[[ curr_deutschmark

))F8E1[[]]F8E1[[ curr_yen

))F8E2[[]]F8E2[[ curr_peseta

))F8E3[[]]F8E3[[ shortdateformat

))F8E4[[]]F8E4[[ longdateformat

))F8E5[[]]F8E5[[ txtltwocc

))F8E6[[]]F8E6[[ txtltwoccglb

))F8E7[[]]F8E7[[ txtltwoccstm

))F8E8[[]]F8E8[[ txtltwoccdsl

))F8E9[[]]F8E9[[ txtltwoccelc

F8EA txtltwoccmor

F8EB txtltwoccmgv

F8EC txtltwoccdmu

F8ED txtltwoccemu

F8EE txtltwoccpaw

F8EF txtltwoccfrw

))F8F0[[]]F8F0[[ txtltwoccbus

))F8F1[[]]F8F1[[ txtltwocctrm

))F8F2[[]]F8F2[[ txtltwocctrk

))F8F3[[]]F8F3[[ txtltwoccpsh

))F8F4[[]]F8F4[[ txtltwoccfsh

))F8F5[[]]F8F5[[ txtltwoccsap

))F8F6[[]]F8F6[[ txtltwocclap

))F8F7[[]]F8F7[[ txtltwoccfrp

))F8F8[[]]F8F8[[ txtltwocchel

))F8F9[[]]F8F9[[ txtltwocclr1

F8FA txtltwocclr2

F8FB steepslopes

F8FC landhigherbridgehead

F8FD grfhelpercaption

F8FE grfhelper_displxrelyrel

F8FF textsprite

F900 txtetramstationheader

F901 txtetramdepotheader

F902 statistics_tooltip

F903 conflict_itself

F904 conflict_preexist

F905 grfstatdebug

F906 grfdebughint

F907 grfdebugmsg

F908 firstpasstramarrives

F909 firstfreighttramarrives

The following strings/textIDs are for TTDPatch 2.5 and are different in 2.6:

F90A newgame "New game\00"

F90B newgamewindow "\90Are you sure you want to abandon this game and start a new game?\00"

The following strings/textIDs are '''only''' in TTDPatch 2.6:

F90A airporttype "\98Airport Type\00"

F90B unnamedairporttype "(Unnamed type)\00"

F90C txtclonedepotbutton "\98Clone Train\00"

F90D txtclonetooltip "\98Allows you to clone a train\00"

F90E txtcloneerrortop "\94Cannot clone train consist\00"

F90F txtclonebadcash "\00"

F910 txtcloneerror_company "\94Not a company train\00"

F911 txtcloneerror_unavail "\94Vehicle in consist is not available anymore\00"

F912 txtcloneerror_nothead "\94No engine head at the start of the consist\00"

F913 txtcloneerror_notrail "\94Not a rail vehicle\00"

F914 txtcloneerror_unknown "\94Unknown reason\00"

F915 grfbefore "\94File \"\80\" must be loaded before \80.\00"

F916 grfafter "\94File \"\80\" must be loaded after \80.\00"

F917 tr_trainlen "Number of Train Carriages\00"

F918 tr_maxspeed_kph "Maximum Speed in km/h\00"

F919 tr_curorder "Station of Current Order\00"

F91A tr_curdeporder "Depot of Current Order\00"

F91B tr_totalpower "Total Train Horsepower\00"

F91C tr_totalweight "Total Train Weight\00"

F91D tr_restricttitle "\98Routefinding Restriction\00"

F91E tr_valuebtn "Value\00"

F91F tr_andbtn "And\00"

F920 tr_orbtn "Or\00"

F921 tr_xorbtn "Xor\00"

F922 tr_error1 "\94Error: Too Many Restriction Objects.\00"

F923 tr_siggui_text "\98Routefinding\00"

F924 tr_enternumber "\94Enter Number\00"

F925 tr_copy "\98Copy\00"

F926 tr_share "\98Share\00"

F927 tr_end "-- End of routefinding restriction criteria\80 --\00"

F928 tr_endshare ", shared by \7e signals\00"

F929 tr_landinfotext "restricted\00"

F92A tr_sigval_sw "Signal Status SW\00"

F92B tr_sigval_se "Signal Status SE\00"

F92C tr_sigval_nw "Signal Status NW\00"

F92D tr_sigval_ne "Signal Status NE\00"

F92E tr_sigval_is_green "is green\00"

F92F tr_sigval_is_red "is red\00"

F930 tr_sigval_is_g "G\00"

F931 tr_sigval_is_r "R\00"

F932 tr_maxspeed_mph "Maximum Speed in mph\00"

F933 tr_nextorder "Station of Next Order\00"

F934 tr_lastvisitstation "Last Visited Station\00"

F935 tr_carriescargo "Train Cargo\00"

F936 tr_distancefromsig "Number of tiles from signals\00"

F937 tr_vartxt "Variable\00"

F938 tr_optxt "Op\00"

F939 directoryoverflow "\94Too many folders in listing\00"

F93A trdlg_eq "is\00"

F93B trdlg_neq "is not\00"

F93C tr_nextdeporder "Depot of Next Order\00"

F93D adjsttitle "\94\80 - Adjacent stations\00"

F93E adjstnumstsinrange "\98Number of stations in range found: \85\85\85\7e\00"

F93F adjstnormstmergealgtxt "\98Standard merge to connecting station\00"

F940 adjstnewsttxt "\98Create new station\00"

F941 adjstnewstbuoy "\98Create new standard buoy\00"

F942 adjstnewenhbuoy "\98Create new station buoy\00"

F943 newgame "New game\00"

F944 newgamewindow "\90Are you sure you want to abandon this game and start a new game?\00"

F945 aquaducttext "Aquaduct\00"

F946 headingfordepot1v2 "\95\80 Train Depot\80, \84\00"

F947 headingfordepot2v2 "\95\80 Road Depot\80, \84\00"

F948 headingfordepot3v2 "\95\80 Ship Depot\80, \84\00"

F949 canaltexttip "\98Build Canals and Locks\00"

F94A rivertexttip "\98Build River\00"

F94B aquaducttexttip "\98Build an Aqueduct to overpass a valley\00"

F94C waterconstrwin "\94Water construction\00"

F94D waterconstrtbtip "\98Canal, River and Aqueduct construction\00"

F94E sortname "Name\00"

F94F tr_days_since_last_service "Number of Days Since Last Service\00"

F950 tr_searching_for_depot "Train \80 Currently Searching For Depot\00"

F951 tr_ps_wintitle "\98Signal Programming\00"

F952 tr_ps_gui_text "\98Signal\00"

F953 tr_ps_sigcount_g "No. of green exit & combo signals\00"

F954 tr_ps_sigcount_go "No. of green one-way exit & combo signals\00"

F955 tr_ps_sigcount_gt "No. of green two-way exit & combo signals\00"

F956 tr_ps_sigcount_r "No. of red exit & combo signals\00"

F957 tr_ps_sigcount_ro "No. of red one-way exit & combo signals\00"

F958 tr_ps_sigcount_rt "No. of red two-way exit & combo signals\00"

F959 tr_ps_end "-- End of criteria to set signal to red\80 --\00"

F95A tr_ps_landinfotext "programmed\00"

F95B ne "NE\00"

F95C se "SE\00"

F95D sw "SW\00"

F95E nw "NW\00"

F95F tr_entertileside "Entered side of tile\00"

F960 tr_pbssigblentertl "Entered tile of PBS signal block\00"

F961 newstartyear "\98New game start year\00"

F962 newstartyearprint "\98\7e\00"

F963 newstartyearhintyear "\98This is the current new game start year\00"

F964 newstartyearhintinc "\98Increases the new game start year\00"

F965 newstartyearhintdec "\98Decreases the new game start year\00"

F966 nohouseremove "\94Local authority refuses to demolish building in the way\00"

F967 tsignal_linfotxt "through\00"

F968 isignal_linfotxt "inverted\00"

F969 advorder_findnearestdepottxt "nearest\00"

F96A advorder_gotonearestdepotddltxt "Go to nearest depot\00"

F96B advorder_servicenearestdepotddltxt "Service at nearest depot\00"

F96C advorder_loadcondskipddltxt "Load-based conditional order skip\00"

F96D advorder_loadcondskiporderwintxt "Skip next \7e orders if load \80 \7e%\00"

F96E advorder_orderskipcountguibtntxt "Count\00"

F96F advorder_orderloadpercentguibtntxt "Load%\00"

F970 advorder_ordercondskiploadparamddltxt "\98Params Ş\00"

F971 advorder_orderparamtooltip "\98Configure the advanced settings for this order\00"

F972 advorder_selrefitveh "Refit consist\00"

F973 advorder_orderrefitveh "Refit to: \80\00"

F974 advorder_ordergotoloadonlytxt "Go to \80 (Load Only)\00"

F975 advorder_ordergotounloadonlytxt "Go to \80 (Unload Only)\00"

F976 advorder_ordergotoloadonlyddltxt "Go to station (Load Only)\00"

F977 advorder_ordergotounloadonlyddltxt "Go to station (Unload Only)\00"

F978 transopts_option "\01\0cTransparency options\00"

F979 transopts_caption "\94Transparency Options\00"

F97A transopts_tttrees "\00"

F97B transopts_ttbuildings "\00"

F97C transopts_ttindustries "\00"

F97D transopts_ttstations "\00"

F97E transopts_ttraildepots "\00"

F97F transopts_ttroaddepots "\00"

F980 transopts_ttshipdepots "\00"

F981 transopts_ttbridges "\00"

F982 transopts_ttobjects "\00"

F983 transopts_ttcompany "\00"

F984 transopts_ttinvistrees "\00"

F985 tr_findbtn "Find\00"

F986 transopts_cttrees "\98Cycle transparency for trees (Ctrl-click to lock)\00"

F987 transopts_ctbuildings "\98Cycle transparency for town buildings (Ctrl-click to lock)\00"

F988 transopts_ctindustries "\98Cycle transparency for industries (Ctrl-click to lock)\00

F989 transopts_ctstations "\98Cycle transparency for stations (Ctrl-click to lock)\00"

F98A transopts_ctraildepots "\98Cycle transparency for rail depots (Ctrl-click to lock)\00

F98B transopts_ctroaddepots "\98Cycle transparency for road depots (Ctrl-click to lock)\00"

F98C transopts_ctshipdepots "\98Cycle transparency for ship depots (Ctrl-click to lock)\00"

F98D transopts_ctbridges "\98Cycle transparency for bridges (Ctrl-click to lock)\00"

F98E transopts_ctobjects "\98Cycle transparency for objects (Ctrl-click to lock)\00"

F98F transopts_ctcompany "\98Cycle transparency for company property (Ctrl-click to lock)\00"

F990 transopts_ttoneway "\98Toggle invisiblility for one-way road markers when road-building toolbar is closed (Ctrl-click to lock)\00"

F991 industrydirmenu "Industry directory\00"

F992 industrydir "\94Industries\00"

F993 industrydiritem0 "\8e\80 \80\00"

F994 industrydiritem1 "\8e\80 \80\98 (\80\80)\90 (\7d% transported)\00"

F995 industrydiritem2 "\8e\80 \80\98 (\80\80/\80\80)\90 (\7d%/\7d% transported)\00"

F996 sortorder_tooltip "\98Select sorting order (descending/ascending)\00"

F997 sortorder_production "\98Production\00"

F998 sortorder_type "\98Type\00"

F999 sortorder_transported "\98Transported\00"

F99A sortorder_name "\98Name\00"

VehicleIDs

2011-06-12T19:23:31Z

Orudge: 8 revisions

'''''List of vehicle IDs'''''

This is a list of vehicle IDs, for example for choosing the ID to change in [[Action0|action 0]] or [[Action3|Action 3]].

The first column of each table shows the ID of the vehicle within the game (in decimal), the second columns shows the ID to use for .NFO files (in hex), and the third column shows the standard name of the vehicle.

Please see the RoadVehicleIDRecommendation for information on how to make your road vehicle set compatible with other road vehicle sets.

The IDs listed are the only IDs that can be used in TTDPatch and OpenTTD prior to r12924. Since OpenTTD r13482, IDs greater than 255 are allowed, up to a theoretical limit of 65535. Any engine defined which is not in the original range listed below will have no default properties, including name.

==Train Engines==

||ID|NFO ID|Name

0|<center>00</center>|<nowiki><nowiki>Kirby Paul Tank (Steam)</nowiki></nowiki>

1|<center>01</center>|<nowiki><nowiki>MJS 250 (Diesel)</nowiki></nowiki>

2|<center>02</center>|<nowiki><nowiki>Ploddyphut Choo-Choo</nowiki></nowiki>

3|<center>03</center>|<nowiki><nowiki>Powernaut Choo-Choo</nowiki></nowiki>

4|<center>04</center>|<nowiki><nowiki>Mightymover Choo-Choo</nowiki></nowiki>

5|<center>05</center>|<nowiki><nowiki>Ploddyphut Diesel</nowiki></nowiki>

6|<center>06</center>|<nowiki><nowiki>Powernaut Diesel</nowiki></nowiki>

7|<center>07</center>|<nowiki><nowiki>Wills 2-8-0 (Steam)</nowiki></nowiki>

8|<center>08</center>|<nowiki><nowiki>Chaney 'Jubilee' (Steam)</nowiki></nowiki>

9|<center>09</center>|<nowiki><nowiki>Ginzu 'A4' (Steam)</nowiki></nowiki>

10|<center>0A</center>|<nowiki><nowiki>SH '8P' (Steam)</nowiki></nowiki>

11|<center>0B</center>|<nowiki><nowiki>Manley-Morel DMU (Diesel)</nowiki></nowiki>

12|<center>0C</center>|<nowiki><nowiki>'Dash' (Diesel)</nowiki></nowiki>

13|<center>0D</center>|<nowiki><nowiki>SH/Hendry '25' (Diesel)</nowiki></nowiki>

14|<center>0E</center>|<nowiki><nowiki>UU '37' (Diesel)</nowiki></nowiki>

15|<center>0F</center>|<nowiki><nowiki>Floss '47' (Diesel)</nowiki></nowiki>

16|<center>10</center>|<nowiki><nowiki>CS 4000 (Diesel)</nowiki></nowiki>

17|<center>11</center>|<nowiki><nowiki>CS 2400 (Diesel)</nowiki></nowiki>

18|<center>12</center>|<nowiki><nowiki>Centennial (Diesel)</nowiki></nowiki>

19|<center>13</center>|<nowiki><nowiki>Kelling 3100 (Diesel)</nowiki></nowiki>

20|<center>14</center>|<nowiki><nowiki>Turner Turbo (Diesel)</nowiki></nowiki>

21|<center>15</center>|<nowiki><nowiki>MJS 1000 (Diesel)</nowiki></nowiki>

22|<center>16</center>|<nowiki><nowiki>SH '125' (Diesel)</nowiki></nowiki>

23|<center>17</center>|<nowiki><nowiki>SH '30' (Electric)</nowiki></nowiki>

24|<center>18</center>|<nowiki><nowiki>SH '40' (Electric)</nowiki></nowiki>

25|<center>19</center>|<nowiki><nowiki>'T.I.M.' (Electric)</nowiki></nowiki>

26|<center>1A</center>|<nowiki><nowiki>'AsiaStar' (Electric)</nowiki></nowiki>||

==Train Wagons==

||ID|NFO ID|Name

27|<center>1B</center>|<nowiki><nowiki>Passenger Carriage</nowiki></nowiki>

28|<center>1C</center>|<nowiki><nowiki>Mail Van</nowiki></nowiki>

29|<center>1D</center>|<nowiki><nowiki>Coal Truck</nowiki></nowiki>

30|<center>1E</center>|<nowiki><nowiki>Oil Tanker</nowiki></nowiki>

31|<center>1F</center>|<nowiki><nowiki>Livestock Van</nowiki></nowiki>

32|<center>20</center>|<nowiki><nowiki>Goods Van</nowiki></nowiki>

33|<center>21</center>|<nowiki><nowiki>Grain Hopper</nowiki></nowiki>

34|<center>22</center>|<nowiki><nowiki>Wood Truck</nowiki></nowiki>

35|<center>23</center>|<nowiki><nowiki>Iron Ore Hopper</nowiki></nowiki>

36|<center>24</center>|<nowiki><nowiki>Steel Truck</nowiki></nowiki>

37|<center>25</center>|<nowiki><nowiki>Armoured Van</nowiki></nowiki>

38|<center>26</center>|<nowiki><nowiki>Food Van</nowiki></nowiki>

39|<center>27</center>|<nowiki><nowiki>Paper Truck</nowiki></nowiki>

40|<center>28</center>|<nowiki><nowiki>Copper Ore Hopper</nowiki></nowiki>

41|<center>29</center>|<nowiki><nowiki>Water Tanker</nowiki></nowiki>

42|<center>2A</center>|<nowiki><nowiki>Fruit Truck</nowiki></nowiki>

43|<center>2B</center>|<nowiki><nowiki>Rubber Truck</nowiki></nowiki>

44|<center>2C</center>|<nowiki><nowiki>Sugar Truck</nowiki></nowiki>

45|<center>2D</center>|<nowiki><nowiki>Candyfloss Hopper</nowiki></nowiki>

46|<center>2E</center>|<nowiki><nowiki>Toffee Hopper</nowiki></nowiki>

47|<center>2F</center>|<nowiki><nowiki>Bubble Van</nowiki></nowiki>

48|<center>30</center>|<nowiki><nowiki>Cola Tanker</nowiki></nowiki>

49|<center>31</center>|<nowiki><nowiki>Sweet Van</nowiki></nowiki>

50|<center>32</center>|<nowiki><nowiki>Toy Van</nowiki></nowiki>

51|<center>33</center>|<nowiki><nowiki>Battery Truck</nowiki></nowiki>

52|<center>34</center>|<nowiki><nowiki>Fizzy Drink Truck</nowiki></nowiki>

53|<center>35</center>|<nowiki><nowiki>Plastic Truck</nowiki></nowiki>||

==Monorail Engines==

||ID|NFO ID|Name

54|<center>36</center>|<nowiki><nowiki>'X2001' (Electric)</nowiki></nowiki>

55|<center>37</center>|<nowiki><nowiki>'Millennium Z1' (Electric)</nowiki></nowiki>

56|<center>38</center>|<nowiki><nowiki>Wizzowow Z99</nowiki></nowiki>||

==Monorail Wagons==

||ID|NFO ID|Name

57|<center>39</center>|<nowiki><nowiki>Passenger Carriage</nowiki></nowiki>

58|<center>3A</center>|<nowiki><nowiki>Mail Van</nowiki></nowiki>

59|<center>3B</center>|<nowiki><nowiki>Coal Truck</nowiki></nowiki>

60|<center>3C</center>|<nowiki><nowiki>Oil Tanker</nowiki></nowiki>

61|<center>3D</center>|<nowiki><nowiki>Livestock Van</nowiki></nowiki>

62|<center>3E</center>|<nowiki><nowiki>Goods Van</nowiki></nowiki>

63|<center>3F</center>|<nowiki><nowiki>Grain Hopper</nowiki></nowiki>

64|<center>40</center>|<nowiki><nowiki>Wood Truck</nowiki></nowiki>

65|<center>41</center>|<nowiki><nowiki>Iron Ore Hopper</nowiki></nowiki>

66|<center>42</center>|<nowiki><nowiki>Steel Truck</nowiki></nowiki>

67|<center>43</center>|<nowiki><nowiki>Armoured Van</nowiki></nowiki>

68|<center>44</center>|<nowiki><nowiki>Food Van</nowiki></nowiki>

69|<center>45</center>|<nowiki><nowiki>Paper Truck</nowiki></nowiki>

70|<center>46</center>|<nowiki><nowiki>Copper Ore Hopper</nowiki></nowiki>

71|<center>47</center>|<nowiki><nowiki>Water Tanker</nowiki></nowiki>

72|<center>48</center>|<nowiki><nowiki>Fruit Truck</nowiki></nowiki>

73|<center>49</center>|<nowiki><nowiki>Rubber Truck</nowiki></nowiki>

74|<center>4A</center>|<nowiki><nowiki>Sugar Truck</nowiki></nowiki>

75|<center>4B</center>|<nowiki><nowiki>Candyfloss Hopper</nowiki></nowiki>

76|<center>4C</center>|<nowiki><nowiki>Toffee Hopper</nowiki></nowiki>

77|<center>4D</center>|<nowiki><nowiki>Bubble Van</nowiki></nowiki>

78|<center>4E</center>|<nowiki><nowiki>Cola Tanker</nowiki></nowiki>

79|<center>4F</center>|<nowiki><nowiki>Sweet Van</nowiki></nowiki>

80|<center>50</center>|<nowiki><nowiki>Toy Van</nowiki></nowiki>

81|<center>51</center>|<nowiki><nowiki>Battery Truck</nowiki></nowiki>

82|<center>52</center>|<nowiki><nowiki>Fizzy Drink Truck</nowiki></nowiki>

83|<center>53</center>|<nowiki><nowiki>Plastic Truck</nowiki></nowiki>||

==Maglev Engines==

||ID|NFO ID|Name

84|<center>54</center>|<nowiki><nowiki>Lev1 'Leviathan' (Electric)</nowiki></nowiki>

85|<center>55</center>|<nowiki><nowiki>Lev2 'Cyclops' (Electric)</nowiki></nowiki>

86|<center>56</center>|<nowiki><nowiki>Lev3 'Pegasus' (Electric)</nowiki></nowiki>

87|<center>57</center>|<nowiki><nowiki>Lev4 'Chimaera' (Electric)</nowiki></nowiki>

88|<center>58</center>|<nowiki><nowiki>Wizzowow Rocketeer</nowiki></nowiki>||

==Maglev Wagons==

||ID|NFO ID|Name

89|<center>59</center>|<nowiki><nowiki>Passenger Carriage</nowiki></nowiki>

90|<center>5A</center>|<nowiki><nowiki>Mail Van</nowiki></nowiki>

91|<center>5B</center>|<nowiki><nowiki>Coal Truck</nowiki></nowiki>

92|<center>5C</center>|<nowiki><nowiki>Oil Tanker</nowiki></nowiki>

93|<center>5D</center>|<nowiki><nowiki>Livestock Van</nowiki></nowiki>

94|<center>5E</center>|<nowiki><nowiki>Goods Van</nowiki></nowiki>

95|<center>5F</center>|<nowiki><nowiki>Grain Hopper</nowiki></nowiki>

96|<center>60</center>|<nowiki><nowiki>Wood Truck</nowiki></nowiki>

97|<center>61</center>|<nowiki><nowiki>Iron Ore Hopper</nowiki></nowiki>

98|<center>62</center>|<nowiki><nowiki>Steel Truck</nowiki></nowiki>

99|<center>63</center>|<nowiki><nowiki>Armoured Van</nowiki></nowiki>

100|<center>64</center>|<nowiki><nowiki>Food Van</nowiki></nowiki>

101|<center>65</center>|<nowiki><nowiki>Paper Truck</nowiki></nowiki>

102|<center>66</center>|<nowiki><nowiki>Copper Ore Hopper</nowiki></nowiki>

103|<center>67</center>|<nowiki><nowiki>Water Tanker</nowiki></nowiki>

104|<center>68</center>|<nowiki><nowiki>Fruit Truck</nowiki></nowiki>

105|<center>69</center>|<nowiki><nowiki>Rubber Truck</nowiki></nowiki>

106|<center>6A</center>|<nowiki><nowiki>Sugar Truck</nowiki></nowiki>

107|<center>6B</center>|<nowiki><nowiki>Candyfloss Hopper</nowiki></nowiki>

108|<center>6C</center>|<nowiki><nowiki>Toffee Hopper</nowiki></nowiki>

109|<center>6D</center>|<nowiki><nowiki>Bubble Van</nowiki></nowiki>

110|<center>6E</center>|<nowiki><nowiki>Cola Tanker</nowiki></nowiki>

111|<center>6F</center>|<nowiki><nowiki>Sweet Van</nowiki></nowiki>

112|<center>70</center>|<nowiki><nowiki>Toy Van</nowiki></nowiki>

113|<center>71</center>|<nowiki><nowiki>Battery Truck</nowiki></nowiki>

114|<center>72</center>|<nowiki><nowiki>Fizzy Drink Truck</nowiki></nowiki>

115|<center>73</center>|<nowiki><nowiki>Plastic Truck</nowiki></nowiki>||

==Buses==

||ID|NFO ID|Name

116|<center>00</center>|<nowiki><nowiki>MPS Regal Bus</nowiki></nowiki>

117|<center>01</center>|<nowiki><nowiki>Hereford Leopard Bus</nowiki></nowiki>

118|<center>02</center>|<nowiki><nowiki>Foster Bus</nowiki></nowiki>

119|<center>03</center>|<nowiki><nowiki>Foster MkII Superbus</nowiki></nowiki>

120|<center>04</center>|<nowiki><nowiki>Ploddyphut MkI Bus</nowiki></nowiki>

121|<center>05</center>|<nowiki><nowiki>Ploddyphut MkII Bus</nowiki></nowiki>

122|<center>06</center>|<nowiki><nowiki>Ploddyphut MkIII Bus</nowiki></nowiki>||

==Trucks - Regular climates (mostly)==

||ID|NFO ID|Name

123|<center>07</center>|<nowiki><nowiki>Balogh Coal Truck</nowiki></nowiki>

124|<center>08</center>|<nowiki><nowiki>Uhl Coal Truck</nowiki></nowiki>

125|<center>09</center>|<nowiki><nowiki>DW Coal Truck</nowiki></nowiki>

126|<center>0A</center>|<nowiki><nowiki>MPS Mail Truck</nowiki></nowiki>

127|<center>0B</center>|<nowiki><nowiki>Reynard Mail Truck</nowiki></nowiki>

128|<center>0C</center>|<nowiki><nowiki>Perry Mail Truck</nowiki></nowiki>

129|<center>0D</center>|<nowiki><nowiki>MightyMover Mail Truck</nowiki></nowiki>

130|<center>0E</center>|<nowiki><nowiki>Powernaught Mail Truck</nowiki></nowiki>

131|<center>0F</center>|<nowiki><nowiki>Wizzowow Mail Truck</nowiki></nowiki>

132|<center>10</center>|<nowiki><nowiki>Witcombe Oil Tanker</nowiki></nowiki>

133|<center>11</center>|<nowiki><nowiki>Foster Oil Tanker</nowiki></nowiki>

134|<center>12</center>|<nowiki><nowiki>Perry Oil Tanker</nowiki></nowiki>

135|<center>13</center>|<nowiki><nowiki>Talbott Livestock Van</nowiki></nowiki>

136|<center>14</center>|<nowiki><nowiki>Uhl Livestock Van</nowiki></nowiki>

137|<center>15</center>|<nowiki><nowiki>Foster Livestock Van</nowiki></nowiki>

138|<center>16</center>|<nowiki><nowiki>Balogh Goods Truck</nowiki></nowiki>

139|<center>17</center>|<nowiki><nowiki>Craighead Goods Truck</nowiki></nowiki>

140|<center>18</center>|<nowiki><nowiki>Goss Goods Truck</nowiki></nowiki>

141|<center>19</center>|<nowiki><nowiki>Hereford Grain Truck</nowiki></nowiki>

142|<center>1A</center>|<nowiki><nowiki>Thomas Grain Truck</nowiki></nowiki>

143|<center>1B</center>|<nowiki><nowiki>Goss Grain Truck</nowiki></nowiki>

144|<center>1C</center>|<nowiki><nowiki>Witcombe Wood Truck</nowiki></nowiki>

145|<center>1D</center>|<nowiki><nowiki>Foster Wood Truck</nowiki></nowiki>

146|<center>1E</center>|<nowiki><nowiki>Moreland Wood Truck</nowiki></nowiki>

147|<center>1F</center>|<nowiki><nowiki>MPS Iron Ore Truck</nowiki></nowiki>

148|<center>20</center>|<nowiki><nowiki>Uhl Iron Ore Truck</nowiki></nowiki>

149|<center>21</center>|<nowiki><nowiki>Chippy Iron Ore Truck</nowiki></nowiki>

150|<center>22</center>|<nowiki><nowiki>Balogh Steel Truck</nowiki></nowiki>

151|<center>23</center>|<nowiki><nowiki>Uhl Steel Truck</nowiki></nowiki>

152|<center>24</center>|<nowiki><nowiki>Kelling Steel Truck</nowiki></nowiki>

153|<center>25</center>|<nowiki><nowiki>Balogh Armoured Truck</nowiki></nowiki>

154|<center>26</center>|<nowiki><nowiki>Uhl Armoured Truck</nowiki></nowiki>

155|<center>27</center>|<nowiki><nowiki>Foster Armoured Truck</nowiki></nowiki>

156|<center>28</center>|<nowiki><nowiki>Foster Food Van</nowiki></nowiki>

157|<center>29</center>|<nowiki><nowiki>Perry Food Van</nowiki></nowiki>

158|<center>2A</center>|<nowiki><nowiki>Chippy Food Van</nowiki></nowiki>

159|<center>2B</center>|<nowiki><nowiki>Uhl Paper Truck</nowiki></nowiki>

160|<center>2C</center>|<nowiki><nowiki>Balogh Paper Truck</nowiki></nowiki>

161|<center>2D</center>|<nowiki><nowiki>MPS Paper Truck</nowiki></nowiki>

162|<center>2E</center>|<nowiki><nowiki>MPS Copper Ore Truck</nowiki></nowiki>

163|<center>2F</center>|<nowiki><nowiki>Uhl Copper Ore Truck</nowiki></nowiki>

164|<center>30</center>|<nowiki><nowiki>Goss Copper Ore Truck</nowiki></nowiki>

165|<center>31</center>|<nowiki><nowiki>Uhl Water Tanker</nowiki></nowiki>

166|<center>32</center>|<nowiki><nowiki>Balogh Water Tanker</nowiki></nowiki>

167|<center>33</center>|<nowiki><nowiki>MPS Water Tanker</nowiki></nowiki>

168|<center>34</center>|<nowiki><nowiki>Balogh Fruit Truck</nowiki></nowiki>

169|<center>35</center>|<nowiki><nowiki>Uhl Fruit Truck</nowiki></nowiki>

170|<center>36</center>|<nowiki><nowiki>Kelling Fruit Truck</nowiki></nowiki>

171|<center>37</center>|<nowiki><nowiki>Balogh Rubber Truck</nowiki></nowiki>

172|<center>38</center>|<nowiki><nowiki>Uhl Rubber Truck</nowiki></nowiki>

173|<center>39</center>|<nowiki><nowiki>RMT Rubber Truck</nowiki></nowiki>||

==Trucks - Toyland==

||ID|NFO ID|Name

174|<center>3A</center>|<nowiki><nowiki>MightyMover Sugar Truck</nowiki></nowiki>

175|<center>3B</center>|<nowiki><nowiki>Powernaught Sugar Truck</nowiki></nowiki>

176|<center>3C</center>|<nowiki><nowiki>Wizzowow Sugar Truck</nowiki></nowiki>

177|<center>3D</center>|<nowiki><nowiki>MightyMover Cola Truck</nowiki></nowiki>

178|<center>3E</center>|<nowiki><nowiki>Powernaught Cola Truck</nowiki></nowiki>

179|<center>3F</center>|<nowiki><nowiki>Wizzowow Cola Truck</nowiki></nowiki>

180|<center>40</center>|<nowiki><nowiki>MightyMover Candyfloss Truck</nowiki></nowiki>

181|<center>41</center>|<nowiki><nowiki>Powernaught Candyfloss Truck</nowiki></nowiki>

182|<center>42</center>|<nowiki><nowiki>Wizzowow Candyfloss Truck</nowiki></nowiki>

183|<center>43</center>|<nowiki><nowiki>MightyMover Toffee Truck</nowiki></nowiki>

184|<center>44</center>|<nowiki><nowiki>Powernaught Toffee Truck</nowiki></nowiki>

185|<center>45</center>|<nowiki><nowiki>Wizzowow Toffee Truck</nowiki></nowiki>

186|<center>46</center>|<nowiki><nowiki>MightyMover Toy Van</nowiki></nowiki>

187|<center>47</center>|<nowiki><nowiki>Powernaught Toy Van</nowiki></nowiki>

188|<center>48</center>|<nowiki><nowiki>Wizzowow Toy Van</nowiki></nowiki>

189|<center>49</center>|<nowiki><nowiki>MightyMover Sweet Lorry</nowiki></nowiki>

190|<center>4A</center>|<nowiki><nowiki>Powernaught Sweet Lorry</nowiki></nowiki>

191|<center>4B</center>|<nowiki><nowiki>Wizzowow Sweet Lorry</nowiki></nowiki>

192|<center>4C</center>|<nowiki><nowiki>MightyMover Battery Truck</nowiki></nowiki>

193|<center>4D</center>|<nowiki><nowiki>Powernaught Battery Truck</nowiki></nowiki>

194|<center>4E</center>|<nowiki><nowiki>Wizzowow Battery Truck</nowiki></nowiki>

195|<center>4F</center>|<nowiki><nowiki>MightyMover Fizzy Drink Truck</nowiki></nowiki>

196|<center>50</center>|<nowiki><nowiki>Powernaught Fizzy Drink Truck</nowiki></nowiki>

197|<center>51</center>|<nowiki><nowiki>Wizzowow Fizzy Drink Truck</nowiki></nowiki>

198|<center>52</center>|<nowiki><nowiki>MightyMover Plastic Truck</nowiki></nowiki>

199|<center>53</center>|<nowiki><nowiki>Powernaught Plastic Truck</nowiki></nowiki>

200|<center>54</center>|<nowiki><nowiki>Wizzowow Plastic Truck</nowiki></nowiki>

201|<center>55</center>|<nowiki><nowiki>MightyMover Bubble Truck</nowiki></nowiki>

202|<center>56</center>|<nowiki><nowiki>Powernaught Bubble Truck</nowiki></nowiki>

203|<center>57</center>|<nowiki><nowiki>Wizzowow Bubble Truck</nowiki></nowiki>||

==Ships==

||ID|NFO ID|Name

204|<center>00</center>|<nowiki><nowiki>MPS Oil Tanker</nowiki></nowiki>

205|<center>01</center>|<nowiki><nowiki>CS-Inc. Oil Tanker</nowiki></nowiki>

206|<center>02</center>|<nowiki><nowiki>MPS Passenger Ferry</nowiki></nowiki>

207|<center>03</center>|<nowiki><nowiki>FFP Passenger Ferry</nowiki></nowiki>

208|<center>04</center>|<nowiki><nowiki>Bakewell 300 Hovercraft</nowiki></nowiki>

209|<center>05</center>|<nowiki><nowiki>Chugger-Chug Passenger Ferry</nowiki></nowiki>

210|<center>06</center>|<nowiki><nowiki>Shivershake Passenger Ferry</nowiki></nowiki>

211|<center>07</center>|<nowiki><nowiki>Yate Cargo ship</nowiki></nowiki>

212|<center>08</center>|<nowiki><nowiki>Bakewell Cargo ship</nowiki></nowiki>

213|<center>09</center>|<nowiki><nowiki>Mightymover Cargo ship</nowiki></nowiki>

214|<center>0A</center>|<nowiki><nowiki>Powernaut Cargo ship</nowiki></nowiki>||

==Planes==

||ID|NFO ID|Name

215|<center>00</center>|<nowiki><nowiki>Sampson U52</nowiki></nowiki>

216|<center>01</center>|<nowiki><nowiki>Coleman Count</nowiki></nowiki>

217|<center>02</center>|<nowiki><nowiki>FFP Dart</nowiki></nowiki>

218|<center>03</center>|<nowiki><nowiki>Yate Haugan</nowiki></nowiki>

219|<center>04</center>|<nowiki><nowiki>Bakewell Cotswald LB-3</nowiki></nowiki>

220|<center>05</center>|<nowiki><nowiki>Bakewell Luckett LB-8</nowiki></nowiki>

221|<center>06</center>|<nowiki><nowiki>Bakewell Luckett LB-9</nowiki></nowiki>

222|<center>07</center>|<nowiki><nowiki>Bakewell Luckett LB80</nowiki></nowiki>

223|<center>08</center>|<nowiki><nowiki>Bakewell Luckett LB-10</nowiki></nowiki>

224|<center>09</center>|<nowiki><nowiki>Bakewell Luckett LB-11</nowiki></nowiki>

225|<center>0A</center>|<nowiki><nowiki>Yate Aerospace YAC 1-11</nowiki></nowiki>

226|<center>0B</center>|<nowiki><nowiki>Darwin 100</nowiki></nowiki>

227|<center>0C</center>|<nowiki><nowiki>Darwin 200</nowiki></nowiki>

228|<center>0D</center>|<nowiki><nowiki>Darwin 300</nowiki></nowiki>

229|<center>0E</center>|<nowiki><nowiki>Darwin 400</nowiki></nowiki>

230|<center>0F</center>|<nowiki><nowiki>Darwin 500</nowiki></nowiki>

231|<center>10</center>|<nowiki><nowiki>Darwin 600</nowiki></nowiki>

232|<center>11</center>|<nowiki><nowiki>Guru Galaxy</nowiki></nowiki>

233|<center>12</center>|<nowiki><nowiki>Airtaxi A21</nowiki></nowiki>

234|<center>13</center>|<nowiki><nowiki>Airtaxi A31</nowiki></nowiki>

235|<center>14</center>|<nowiki><nowiki>Airtaxi A32</nowiki></nowiki>

236|<center>15</center>|<nowiki><nowiki>Airtaxi A33</nowiki></nowiki>

237|<center>16</center>|<nowiki><nowiki>Yate Aerospace YAe46</nowiki></nowiki>

238|<center>17</center>|<nowiki><nowiki>Dinger 100</nowiki></nowiki>

239|<center>18</center>|<nowiki><nowiki>AirTaxi A34-1000</nowiki></nowiki>

240|<center>19</center>|<nowiki><nowiki>Yate Z-Shuttle</nowiki></nowiki>

241|<center>1A</center>|<nowiki><nowiki>Kelling K1</nowiki></nowiki>

242|<center>1B</center>|<nowiki><nowiki>Kelling K6</nowiki></nowiki>

243|<center>1C</center>|<nowiki><nowiki>Kelling K7</nowiki></nowiki>

244|<center>1D</center>|<nowiki><nowiki>Darwin 700</nowiki></nowiki>

245|<center>1E</center>|<nowiki><nowiki>FFP Hyperdart 2</nowiki></nowiki>

246|<center>1F</center>|<nowiki><nowiki>Dinger 200</nowiki></nowiki>

247|<center>20</center>|<nowiki><nowiki>Dinger 1000</nowiki></nowiki>

248|<center>21</center>|<nowiki><nowiki>Ploddyphut 100</nowiki></nowiki>

249|<center>22</center>|<nowiki><nowiki>Ploddyphut 500</nowiki></nowiki>

250|<center>23</center>|<nowiki><nowiki>Flashbang X1</nowiki></nowiki>

251|<center>24</center>|<nowiki><nowiki>Juggerplane M1</nowiki></nowiki>

252|<center>25</center>|<nowiki><nowiki>Flashbang Wizzer</nowiki></nowiki>||

==Helicopters==

||ID|NFO ID|Name

253|<center>26</center>|<nowiki><nowiki>Tricario Helicopter</nowiki></nowiki>

254|<center>27</center>|<nowiki><nowiki>Guru X2 Helicopter</nowiki></nowiki>

255|<center>28</center>|<nowiki><nowiki>Powernaut Helicopter</nowiki></nowiki>||

BaseCosts

2011-06-12T19:23:31Z

Orudge: 12 revisions

'''''List of all base costs'''''

=Base Costs=

This is a list of all base costs used by TTD.

NFO ID is the ID to use for action 0 feature 8 property 08.

Location is the address in the savegame structure.

Default value is the initial value used at the game start.

||ID|NFO ID|Location|Default|Used for

0|<center>0</center>|4B34|100|miscellaneous

1|<center>1</center>|4B3A|100|build track

2|<center>2</center>|4B40|95|build road

3|<center>3</center>|4B46|65|place signal

4|<center>4</center>|4B4C|275|build bridge tile

5|<center>5</center>|4B52|600|build rail depot, also affects "build rail-waypoint" (*)

6|<center>6</center>|4B58|500|build road depot

7|<center>7</center>|4B5E|700|build ship depot

8|<center>8</center>|4B64|450|build tunnel unit

9|<center>9</center>|4B6A|200|build platform unit (per tile)

10|<center>A</center>|4B70|180|build platform fixed (per platform)

11|<center>B</center>|4B76|600|build airport tile

12|<center>C</center>|4B7C|200|build bus station

13|<center>D</center>|4B82|200|build lorry area

14|<center>E</center>|4B88|350|build dock, also affects "build buoy" (*)

15|<center>F</center>|4B8E|400,000|locomotive purchase

16|<center>10</center>|4B94|2000|waggon purchase

17|<center>11</center>|4B9A|700,000|aircraft purchase

18|<center>12</center>|4BA0|14,000|road vehicle purchase

19|<center>13</center>|4BA6|65,000|ship purchase

20|<center>14</center>|4BAC|20|plant tree

21|<center>15</center>|4BB2|250|raise/lower land, also affects "build foundation" (*)

22|<center>16</center>|4BB8|20|clear grass

23|<center>17</center>|4BBE|40|clear rough land, also affects "build/remove object" (*)

24|<center>18</center>|4BC4|200|clear rocks

25|<center>19</center>|4BCA|500|clear fields

26|<center>1A</center>|4BD0|20|remove tree

27|<center>1B</center>|4BD6|-70|remove track

28|<center>1C</center>|4BDC|10|remove signal

29|<center>1D</center>|4BE2|50|remove bridge tile, also affects "remove aqueduct" (*)

30|<center>1E</center>|4BE8|80|remove rail depot, also affects "remove rail-waypoint" (*)

31|<center>1F</center>|4BEE|80|remove road depot

32|<center>20</center>|4BF4|90|remove ship depot

33|<center>21</center>|4BFA|30|remove tunnel tile

34|<center>22</center>|4C00|10,000|clear water, also affects "build/remove canal/lock" and "build aqueduct" (*)

35|<center>23</center>|4C06|50|remove platform tile

36|<center>24</center>|4C0C|30|remove airport tile

37|<center>25</center>|4C12|50|remove bus station

38|<center>26</center>|4C18|50|remove lorry area, also affects "remove buoy" (*) (**)

39|<center>27</center>|4C1E|55|remove dock

40|<center>28</center>|4C24|1600|remove house, also affects "remove industry" (*)

41|<center>29</center>|4C2A|40|remove road

42|<center>2A</center>|4C30|5600|steam engine running costs

43|<center>2B</center>|4C36|5200|diesel engine running costs

44|<center>2C</center>|4C3C|4800|electricengine running costs

45|<center>2D</center>|4C42|9600|aircraft running costs

46|<center>2E</center>|4C48|1600|road vehicle running costs

47|<center>2F</center>|4C4E|5600|ship running costs

48|<center>30</center>|4C54|1,000,000|funding industries, also affects "stuff with local authority", "build raw industry" and "fund town" (*)

49|<center>31</center>|-|1600|remove industry|OTTD r18283

50|<center>32</center>|-|40|build object|OTTD r18283

51|<center>33</center>|-|40|remove object|OTTD r18283

52|<center>34</center>|-|600|build rail-waypoint|OTTD r18283

53|<center>35</center>|-|80|remove rail-waypoint|OTTD r18283

54|<center>36</center>|-|350|build buoy|OTTD r18283

55|<center>37</center>|-|50|remove buoy|OTTD r18283

56|<center>38</center>|-|1,000,000|stuff with town authority|OTTD r18283

57|<center>39</center>|-|250|build foundation|OTTD r18283

58|<center>3A</center>|-|8,000,000|build raw industry (in case prospecting is disabled)|OTTD r18283

59|<center>3B</center>|-|1,000,000|fund town|OTTD r18283

60|<center>3C</center>|-|5,000|build canal|OTTD r19720

61|<center>3D</center>|-|5,000|remove canal|OTTD r19720

62|<center>3E</center>|-|10,000|build aqueduct|OTTD r19720

63|<center>3F</center>|-|2,000|remove aqueduct|OTTD r19720

64|<center>40</center>|-|7,500|build lock|OTTD r19720

65|<center>41</center>|-|2,000|remove lock|OTTD r19720||

<nowiki><nowiki>*</nowiki></nowiki> if not set separately

<nowiki><nowiki>**</nowiki></nowiki> yes, "remove buoy" is mentioned in this line, not in the line below

Note: The newly added base costs of OTTD only apply if a base cost modifier is set for them. E.g. if NewGRF only set a base cost modifier for terraforming, but none for building foundations, the modifier for terraforming will also apply to building foundations, as that was the base cost used before the new one was added.

Note that some values may be adjusted by certain constant factors before being used by the game, but that is a property of the place where it's used, not the base cost as such.

Also, all constructions costs and all running costs are subject to modification by the game difficulty settings.

CargoTypes

2011-06-12T19:23:31Z

Orudge: 17 revisions

'''''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 [[Action3|action 3]].

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

||Type A|Bit Value|Type B|Cargo|{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV}|{DIV(bg=>#eebb00)}Type B{DIV}|{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV}

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 [[VehicleRefitting|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|[[Action0Cargos#Cargo_classes_16_|Cargo classes]]|Notes

<center>TTD Default Cargos</center>

PASS|Passengers|0001 Passengers |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

COAL|Coal|0010 Bulk |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

MAIL|Mail|0002 Mail |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

OIL_|Oil|0040 Liquid |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

LVST|Livestock|0020 Piece goods |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

GOOD|Goods|0004 Express|{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

GRAI|Grain|0010 Bulk | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |Temperate; see also WHEA, MAIZ, CERE

WOOD|Wood|0020 Piece goods |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

IORE|Iron Ore|0010 Bulk |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

STEL|Steel|0020 Piece goods |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

VALU|Valuables|0008 Armoured |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |Temperate; see also GOLD, DIAM

PAPR|Paper|0020 Piece goods |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

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

FOOD|Food|0084 Express, refrigerated |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

GOLD|Gold|0008 Armoured |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |Arctic; see also VALU, DIAM

RUBR|Rubber|0040 Liquid |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

FRUT|Fruit|0090 Bulk, refrigerated |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

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

CORE|Copper Ore|0010 Bulk |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

WATR|Water|0040 Liquid |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

DIAM|Diamonds|0008 Armoured |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{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 | | |

<center>NewCargos</center>

AORE|Bauxite (Aluminium ore)|0010 Bulk | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

BEER|Alcohol|0064 Express, piece goods, liquids | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

BDMT|Building Materials|0220 Piece goods, covered/sheltered | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

BRCK|Bricks| 0020 Piece goods |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

CERA|Ceramics| 0020 Piece goods |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

CERE|Cereals| 0210 Bulk, covered/sheltered |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |(*)

CARB|Carbon Brick|0010 Bulk | | |

CLAY|Clay|0210 Bulk covered/sheltered | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

CMNT|Cement| 0210 Bulk covered/sheltered |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

COPR|Copper|0020 Piece goods | | |

DURA|Depleted Uranium|0100 Hazardous | | |

DYES|Dyes| 0060 Piece goods, liquids |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

ENSP|Engineering Supplies|0024 Express, piece goods | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

FERT|Fertiliser| 0030 Bulk, piece goods |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |(*)

FICR|Fibre crops| 0030 Bulk, piece goods|{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

FISH|Fish| 0084 Express, refrigerated |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

FMSP|Farm Supplies|0024 Express, piece goods | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

FRVG|Fruit (and optionally Vegetables)|00A4 Express, piece goods, refrigerated  | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{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)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

GRVL|Gravel / Ballast|0010 Bulk | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

LIME|Lime stone| 0010 Bulk |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

MATE|Materials|0020 Piece goods | | |

MILK|Milk|00C4 Express, liquid, refrigerated | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

MNSP|Manufacturing Supplies|0020 Piece Goods, express | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

OLSD|Oil seed| 0210 Bulk, covered/sheltered |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |(*)

OXYG|Oxygen|0040 Liquid | | |

PETR|Petrol / Fuel Oil| 0040 Liquid |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV}  |

PLAS|Plastic| 0060 Piece goods, liquid|{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

POTA|Potash| 0210 Bulk, covered/sheltered |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |(*)

RCYC|Recyclables|0220 Piece Goods, covered  | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

RCKT|Rockets|0000 None| | |

RFPR|Refined products| 0040 Liquid |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

RSGR|Raw Sugar|0010 Bulk | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} | Sugar cane in tropic, sugar beet in other climates

SAND|Sand| 0010 Bulk |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

SCRP|Scrap Metal|0010 Bulk | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV}  |

SILI|Silicate|0010 Bulk | | |

SULP|Sulphur| 0210 Bulk, covered/sheltered |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |(*)

TOUR|Tourists| 0005 Passengers, express |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{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)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} | |

WATT|Electricity|0000 None | | |

WDPR|Wood Products| 0030 Bulk, piece goods |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

WOOL|Wool| 0220 Piece goods, covered/sheltered  |{DIV(bg=>#eebb00)}<center>~hs~[[ECS|ECS]]~hs~</center>{DIV} |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |(*)

WSTE|Waste|0010 Bulk | |{DIV(bg=>#1a3cb7)}<center>~hs~[[FIRS|FIRS]]~hs~</center>{DIV} |

||

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

RecolorSprites

2011-06-12T19:23:30Z

Orudge: 11 revisions

'''''Changing how other sprites are drawn'''''

=Recolor Sprites=

Changing how other sprites are drawn

-=Introduction=-

Recolor sprites are pseudosprites used to recolor other sprites, most often to apply company colors. A recolour sprite is simply a re-mapping of TTDs original colour table.

-=Format=-

A recolor sprite has the following format:

<pre> -+<Sprite-number> * 257 00 <recolor-table>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

<Sprite-number>|dec|A sequential sprite number

257|dec|The total number of bytes used in this action, always 257

00|B|literal 00

<recolor-table>|256*B|See below||

-=Filling in the Terms=-

===00===

At first glance, it is easy to confuse a recolor sprite with an action 0, most often for trains. Attempting to read the recolor sprite as an action 0 will usually reveal that there are far too many bytes. Another clue is that recolor sprites are always 257 bytes long.

The correct method to distinguish recolor sprites and action 0s is to note that recolor sprites can only appear in an [[Action5]] or [[ActionA]] block, and action 0s can only appear outside such a block.

===recolor-table===

A 256-byte recolor table. A byte at the offset equal to the index of the source color specifies the color to be drawn.

Note that the offsets and bytes are different depending on whether the GRF is being loaded in TTD DOS or TTD Win. If you create a grf that contains recolor sprites, you may find it necessary to maintain two separate versions, or use an Action7 that checks variable 83 to guard the introducing action 5/A and the recolor sprite(s).

-=Usage=-

Recolor sprites are applied in one of two ways.

;Non-transparently: Each pixel in the sprite is looked up in the recolor table, and then the color specified at that offset is drawn on the screen. If the resultant color is 00 ("transparent blue"), then if the [[RealSprites#compression|sprite's compression]] bit 3 is ''not'' set, nothing is drawn; otherwise (i.e. if the sprite is in chunked data format) the actual color 00 (which is ''black'') is drawn.

;Transparently: For each sprite pixel that is not transparent, the current (on-screen) color of the pixel at the location where the sprite pixel would be drawn is looked up in the recolor table, and then redrawn in the new color. If the recolor lookup returns 00 ("transparent blue"), the resultant color is actually black. Other than is-transparent-blue/not-transparent-blue, the actual colors of the pixels in a sprite that is drawn transparently are meaningless.

-=Default recolour sprites=-

TTD already defines a number of recolour sprites for various uses, e.g. for the semi-transparency of glass or the re-colouring of the tubular bridges, company colours or some houses.

||'''Sprite number (dec)'''|'''Sprite number (hex)'''|'''Description'''

771|0x303| A pulsating red tile is drawn if you try to build a wrong tunnel or raise/lower land where it is not possible

772|0x304| Makes a square red. is used when removing rails or other stuff

773|0x305 | This draws a blueish square (catchment areas for example)

'''translations for the company colour (blue-ish colours are replaced)'''

775|0x307 | company colour to dark blue

776|0x308 | company colour to pale green

777|0x309 | company colour to pink

778|0x30A | company colour to yellow

779|0x30B | company colour to red

780|0x30C | company colour to light blue

781|0x30D | company colour to green

782|0x30E | company colour to dark green

783|0x30F | company colour to blue

784|0x310 | company colour to cream

785|0x311 | company colour to mauve

786|0x312 | company colour to purple

787|0x313 | company colour to orange

788|0x314 | company colour to brown

789|0x315 | company colour to grey

790|0x316 | company colour to white (darker parts are blue-ish)

'''translations for "brownish red" colour used by some town buildings and bridges'''

791|0x317 | bare land, for rail and road (crossings)

795|0x31B | structure to blue

796|0x31C | structure to brownish (e.g. cantilever bridges)

797|0x31D | structure to white

798|0x31E | structure to red (e.g. bridges)

799|0x31F | structure to green (e.g. bridges)

800|0x320 | structure to concrete (e.g. suspension bridge)

801|0x321 | structure to yellow (e.g. suspension bridge + tubular)

'''special colour translations'''

802|0x322 | glass effect

803|0x323 | maps to grey (e.g. tubular bridge or newspaper)

804|0x324 | crashed vehicle (grey-ish)

1438|0x59E | church red

1439|0x59F | church cream||

For the company colour translation a translation to dark blue (0x307) is the identity translation which replaces every colour with itself. You can use it in cases where a remapping is needed, but you don't want to recolor anything.

-= Dual company colours =-

You can also use the dual-company-colour recolour sprites. However, they are no default TTD sprites and thus they do not have fixed sprite numbers. You can determine the spritenumber of the first 2CC recolour sprite via [[ReadingPatchVariables|Patch Variable 11]]. You then need [[Action6|Action 6]] to put the needed recolourings into actions where needed.

Starting from the spritenumber from patch variable 11 there are 256 recolour sprites. Their order follows the default company recolourings above. The second company colour changes every 16 sprites, so every combination of first and second colour is available:

||'''Offset from first sprite (dec)''' |'''Offset from first sprite (hex)''' | '''First colour (colours 0xC6 to 0xCD)''' | '''Second colour (colours 0x50 to 0x57)'''

0 | 0x00 | dark blue | dark blue

1 | 0x01 | pale green | dark blue

<nowiki>:</nowiki> | : | : | :

15 |  0x0F | white | dark blue

16 |  0x10 | dark blue |pale green

<nowiki>:</nowiki> | : | : | :

31 | 0x1F | white |pale green

32 | 0x20 | dark blue | pink

<nowiki>:</nowiki> | : | : | :

255 | 0xFF | white | white ||

You'll notice in hex that the low nibble of the offset represents the first company colour from 0 (dark blue) to F (white), and the high nibble represents the second company colour.

RealSprites

2011-06-12T19:23:30Z

Orudge: 10 revisions

'''''Sprites that actually get drawn on the screen'''''

=Real Sprites=

The sprites that the user actually sees.

{maketoc}

-=Introduction=-

Real sprites are the graphical part of .grf files; they are what the user actually sees in-game.

-=Format=-

A real sprite has the following format:

<pre>-+<Sprite-number> <filename> <xpos> <ypos> <compression> <ysize> <xsize> <xrel> <yrel>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

<Sprite-number>|dec|A sequential sprite number

<filename>|string*|The name of the .pcx file in which the sprite will be found

<xpos>|dec|The x position of the upper-left corner of the sprite in the file

<ypos>|dec|The y position of the upper-left corner of the sprite in the file

<compression>|B|The "compression"; see below

<ysize>|dec|The y size of the sprite

<xsize>|dec|The x size of the sprite

<xrel>|dec|The x position of the upper-left corner of the sprite, relative to the "center" (usually negative)

<yrel>|dec|The y position of the upper-left corner of the sprite, relative to the "center" (usually negative)||

<nowiki><nowiki>*</nowiki></nowiki> Unlike strings in pseudo-sprites, this string should not have a terminating "00" and should not be placed in quotes.

-=Filling in the Terms=-

===filename===

This specifies the name and path of the .pcx file. The path may be specified one of two ways:
# An absolute path. (eg C:\GRF\sprites\filename.pcx)
# A relative path; these are specified relative to the location of the .grf file. (eg sprites\filename.pcx)

For most purposes, relative paths are preferred, since .nfo files with relative paths are more portable than .nfo files with absolute paths.

===xpos, ypos, ysize, and xsize===

These are pretty easy to set, as long as you remember that the order is  X, Y, Y, X, and not X, Y, X, Y.

Also, no sprite may contain zero pixels; ysize and xsize must both be at least 1.

There is a bug in grfcodec 0.9.7 and earlier that prevents them from properly encoding a sprite with a smaller ypos value than any earlier sprite. The best way to circumvent this bug is to upgrade to the newest version.

Andrex's [http://www.divxland.org/ttd/files/nfoeditor.zip|NFOEditor] can often be helpful for setting these four values.

'''WARNING:''' NFOEditor is replete with bugs, limitations, &c.;: You MUST specify absolute paths, and paths must be delimited by backslashes (decode with grfcodec 0.9.5); comments MUST NOT contain "*"; and sprite numbers MUST be correct. Also, moving too far outside the size of the .pcx file will cause NFOEditor to crash, so save early and often.

===compression===

Unlike the other numbers, the compression is a hexadecimal bit-field. Currently, the following bits are supported:

||bit|value|meaning

0|1|Color index 0 is transparent (should be '''always''' set; ignored if bit 3 is set)

1|2|Store compressed sprite in memory

3|8|Sprite is in chunked data format (aka "tile compression")

6|40|Sprite should not be cropped. (obeyed by GRFCodec r1604 and later)||

The chunked data format is designed to compress tiles and diagonal views of vehicles; things with lots of transparency around the edges, and a contiguous block of non-transparent pixels in the middle. Using the chunked data format may provide advantages in drawing speed.

The most common values for the compression are 01 and 09. 03 is useful for large sprites that are infrequently used, as it reduces memory usage at the cost of slower drawing speed. It is generally a bad idea to use any other value, as that may cause problems. FF is an especially bad idea.

===xrel and yrel===

These two numbers will probably become the bane of your existence.

TTD stores a single point for every sprite. xrel and yrel specify how far right and down (respectively) to go from the TTD point to the upper-left hand corner of the sprite.

Halving xsize and ysize and negating the results produces a decent starting point for these values, and further adjustments may be done manually, with NFOEditor, or (in TTDPatch 2.0.1 alpha 69 and later) with the [[GRFAuthorHelperWindow]].

===Ranges===

The ranges for the four numbers after the compression are as follows:

ysize: 1..255

xsize: 1..65535

xrel: -32768..32767

yrel: -32768..32767

ysize*xsize may not exceed 65535.

===Other notes===

It is a common practice, in action 1 blocks, to use the pseudosprite "-1 * 1 00" to take the place of a real sprite that will never be used. The most common use is for vehicle sets that will only be used in the purchase window. This reduces the size of the .grf file when compared to replacing them with one-pixel sprites (but not when compared to splitting the action 1 and making the second one define only one sprite), but does not save real-sprite slots. If TTD ever attempts to draw one of these sprites, it will, at best, crash.

===Transparency and glass effect===

Transparency and glass effects can be achieved by means of [[RecolorSprites]]

-=Example=-

The best way to see real sprites is to decode one of TTD's standard .grf files. With very few exceptions, all sprites in those files are real sprites; the few that are not are RecolorSprites.

Example real sprites can also be found at the bottom of [[Action1]] or [[ActionA]].

Those sprites use absolute paths. Removing the C:\TTD\ part of each filename would work just as well, assuming you want the .grf file to appear in C:\TTD.

GRFResourceManagement

2011-06-12T19:23:30Z

Orudge: 2 revisions

'''''Preventing conflicts with limited resources'''''

=GRF Resource Management=

Preventing conflicts with limited resources

{maketoc}

-=Introduction=-

Since 2.0.1 alpha 51, it has been possible to use action D to participate in cooperative resource management.

This feature is useful for avoiding resource conflicts between grf files. A file may query the available resources, check whether certain IDs are available, and/or mark them as reserved. Then, an action 6 will enter the actual values in the appropriate action entries, for example action 0 or 3 for vehicles, and action A for sprites. Alternatively, one can use another action D to set variable 99 and have it adjust the IDs of the relevant actions appropriately.

If the requested resources are not available, the grf file will be deactivated and be shown with an orange colour in the GRF Status Window, as well as a message indicating the type of resource that was not available. Note that previously allocated resources will not be freed if this happens, therefore you must first ''check'' that ''all'' of the resources are available before reserving ''any'' of them. This means if you have more than one type of resource that is required, you need two action D entries for each type, first one action D for each type using the "check" or "find" operation, after all of which follow the action D entries for each type using the "reserve" or "mark" operation.

This type of action D is ignored during initialisation (because the resources are not initialised yet either), and the target parameter will be set to 0 in that case.

'''Please note:''' This resource management is cooperative. That means that grf files that do not use it can still access all IDs, and the patch will never know about it. Only those grf files that use this resource management will "know" of each other and can be sure not to use conflicting resources. If another grf file then uses a "reserved" ID without telling the patch via an action D, there is nothing that will prevent it from doing so.

-=Format=-

<pre> -+<Sprite-number> * <Length> 0D <target> 00 <GRM-op> FE FF <feature> <count>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

0D|B|Defines action 0D

<target>|B|Target parameter. See also below.

00|B|Assignment

<GRM-op>|B|Resource operation to perform. See below.

FE|B|Defines a special variable access

FF|B|Prevent conflicts with ReadingOtherGRFParameters

<feature>|B|Feature to operate on. See below.

<count>|W|Number of IDs to operate on.||

For the check, mark, no-fail check, and get-owner operations, <target> must contain the first ID to be operated on.

==GRM-op==

The following operations are available:

Each operation also has a corresponding escape sequence, as listed. See [[GRFActionsDetailed#Byte_order|the discussion of escape sequences]] for further information on escape sequences in general.

||Number|Escape|Operation|Result|Meaning

00|\DR|Reserve|First found ID|find available resource ID and mark as in use

01|\DF|Find|First found ID|find available resource ID but do not mark

02|\DC|Check|(none)|check whether given resources (ID stored in the <target> variable) are available

03|\DM|Mark|(none)|check that the given resources are available, and if so mark as in use

04|\DnF|No-fail Find|(see below)|like "Find", but does not deactive the grf if no IDs found

05|\DnC|No-fail Check|(see below)|like "Check", but does not deactive the grf if there is a conflict

06|\DO|Get Owner|GRF-ID of owner|Retrieve GRFID that has reserved the given ID (or 0 if not reserved)||

Action D returns its result (if any) in the given <target> parameter. If the result is marked as "(none)" in the above table, the <target> parameter is not modified.

The "reserve" and "find" operations will try to find a contiguous block of <count> entries, and store the first number in the target parameter of the action D. If not enough entries can be found, the grf file is deactivated.

The "check" and "mark" operations use the value stored in the ''target'' parameter of the action D, and check/mark the block of <count> entries starting from that number. If not all entries are available, the grf file is deactivated.

The no-fail versions work exactly like their regular counterparts, but they set the <target> parameter to -1 (FFFFFFFF) if the resources are unavailable, which can be checked with action 7 afterwards. They do not deactivate the grf file. If successful, they do nothing. They are useful if the file wants to voluntarily skip certain modifications in case other files have changed them already.

Typically, the "reserve" or "find" operations will be used for files that modify only a few vehicles. For (mostly) complete sets, the "check" and "mark" operations are more useful, because it is often not feasible to remap the IDs of an entire set, so these operations will simply make sure that all needed IDs are available.

For each feature, multiple "find" operations will check for different size blocks, but will always return the same base entry number, so "find" should only be called once for each feature.

==Feature==

The following features and feature/GRM-op combinations are supported:

||Feature|Reserve|Find|Check|Mark|Get|Notes

00 (trains)|<center>0</center>|<center>0</center>|<center>X</center>|<center>X</center>|<center>X</center>|

01 (road vehicles)|<center>0</center>|<center>0</center>|<center>X</center>|<center>X</center>|<center>X</center>|

02 (ships)|<center>0</center>|<center>0</center>|<center>X</center>|<center>X</center>|<center>X</center>|

03 (aircraft)|<center>0</center>|<center>0</center>|<center>X</center>|<center>X</center>|<center>X</center>|

08 (general sprites)|<center>X</center>|<center>X</center>|<center>*</center>|<center>*</center>|<center>-</center>|

0B (cargos)|<center>-</center>|<center>-</center>|<center>X</center>|<center>X</center>|<center>X</center>|see below||

0 = unsafe, the IDs may change when loading game

X = safe to use

<nowiki><nowiki>*</nowiki></nowiki> = safe but useless

- = do not use

For newcargos, IDs 00..1F refer to the cargo IDs themselves (e.g. ID 0B is available in the temperate climate, and 0C..1F in all climates), whereas IDs 20..3F refer to the bit number from prop. 08 plus 20 (e.g. ID 2D, being bit number 0D=fruit, is available in all climates except tropical). You need to check and mark both ID types for correct operation.

ReadingPatchVariables

2011-06-12T19:23:30Z

Orudge: 7 revisions

=Reading Patch variables=

-=Introduction=-

Since 2.0.1 alpha 48, it has been possible to use action D to read various special Patch variables. These are usually switch values, but there are also a few other useful values.

-=Format=-

<pre> -+<Sprite-number> * <Length> 0D <target> <operation> <variable> FE FF FF 00 00+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

0D|B|Defines action 0D

<target>|B|Target parameter

<operation>|B|As for ActionD, but only assignment is valid.

<variable>|B|Patch variable number to read. See below.

FE|B|Defines a special variable access

FF FF 00 00|D|Indicates that a patch variable is being read||

==variable==

The following patch variables are defined:

||variable|Switch|Value

00|miscmods/-Yo|Bit switch

01|experimentalfeatures/-XF|Bit switch

02|morevehicles/-x|Vehicle array multiplier

03|mountains&curves;/-mc|Two bytes with four sets of two bits

04|planecrashcontrol/-Xc|Bit switch

05|autorenew/-Xa|Signed value

06|multihead/-M|Speed increase, in percent

07|disasters/-XD|Bit switch

08|unifiedmaglev/-XM|Unified maglev mode

09|bridgespeedlimits/-XX|Speed fraction, in percent

0A|---|TTD Language, see the "new scheme" for [[Action4#language_id|action 4]]

0B|startyear/-XY|Year-1920

0C|morebuildoptions/-YB|Bit switch

0D|moresteam/-YM|value=LF (two hex digits), L=length, F=frequency

0E|freighttrains/-Yf|weight factor

0F|wagonspeedlimits/-YL|Speed increase for empty wagons

10|planespeed/-YP|speed factor

11|dual company colors|2CC colormap base sprite (since r1404)

12|miscmods2/-Zm|Bit switch (since r1738)

13|map size information|Format = -MABXYSS (since r11961 and r1817)

| | M  : the type of map

| |bit 0 set : squared map. Clear : rectangular map

| |bit 1 set   : Y is the bigger edge(bit 0 is clear).Clear : X is the bigger edge.

| |A  : minimum edge(log2) of the map

| |B  : maximum edge(log2) of the map

| |XY : edges(log2) of each side of the map.

| |SS : combination of both X and Y, thus giving the size(log2) of the map

| |All map sizes will be substracted by 6, as to keep the size 64 the smallest one, thus zero based||

If experimentalfeatures, miscmods, or miscmods2 are off, the corresponding value will be zero. For all other switches, the value is unspecified if the switch is off, so [[TTDPatchFlags|action 7 variable 85]] should be checked first.

ReadingOtherGRFParameters

2011-06-12T19:23:29Z

Orudge: 3 revisions

'''''Reading another GRF file's parameters'''''

==Reading another GRF file's parameters==

-=Introduction=-

Since 2.0.1 alpha 16, it has been possible to use action D to read the parameters of other GRF files. With this, you can try to use the settings for another related GRF before falling back to a hard coded default.

-=Format=-

<pre> -+<Sprite-number> * <Length> 0D <target> <operation> <param> FE <grfid>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

0D|B|Defines action 0D

<target>|B|Target parameter

<operation>|B|As for [[ActionD#operation|action D]], but only assignment is valid.

<param>|B|Parameter number of the other GRF file that you want to read

FE|B|Defines a special variable access

<grfid>|D|The GRFID whose parameter you want to read||

This will store parameter <param> of the GRF file with grfid <grfid> into the <target>

With parameter FE you can read the action 14 NewGRF version of another NewGRF in OpenTTD. It returns 0 if no NewGRF version has been set by an action 14.

If the GRF ID cannot be found, or if the parameter is not defined, a value of 0 is used instead (no matter whether bit 7 of the operation is set or not).

TTDPatchFlags

2011-06-12T19:23:29Z

Orudge: 15 revisions

'''''TTDPatch Flags for Action 7/9 Variable 85'''''

=TTDPatch Flags for Action 7/9 Variable 85=

Additional Information

In the table below you find all the TTDPatch flags that belong to <-+Param-num+-> = 85 in Action 7 & Action 9.

||'''Bit'''|'''Switch (bit set = switch on)'''|'''Correspondence in OpenTTD'''

0C|keepsmallairport|station.never_expire_airports

0D|newairports|1

0E|largestations|1

0F|longbridges|construction.longbridges

10|loadtime|0

12|presignals|1

13|extpresignals|1

16|enginespersist|vehicles.never_expire_vehicles

1B|multihead|1

1D|lowmemory|1

1E|generalfixes|1

27|moreairports|economy.station_noise_level

28|mammothtrains|1

29|trainrefit|1

2B|subsidiaries|0

2C|gradualloading|order.gradual_loading

32|(Set to bit 0 of unifiedmaglev mode)|1 (n/a)

33|(Set to bit 1 of unifiedmaglev mode)|1 (n/a)

34|bridgespeedlimits|1

36|eternalgame|1

37|newtrains|1

38|newrvs|1

39|newships|1

3A|newplanes|1

3B|signalsontrafficside|construction.signal_side

3C|electrifiedrailway|vehicle.disable_elrails

41 *|loadallgraphics|1

43|semaphores|1

4A|newobjects (since r2364)|1

4B|enhancegui|0

4C|newagerating|0

4D|buildonslopes|construction.build_on_slopes

4E|fullloadany|1

4F|planespeed|1

50 *|moreindustriesperclimate|0

51|moretoylandfeatures|0

52|newstations|1

53|tracktypecostdiff|1

54|manualconvert|1

55|buildoncoasts|construction.build_on_slopes

56|canals|1

57|newstartyear|1

58|freighttrains|vehicle.freight_trains > 1

59|newhouses|1

5A|newbridges|1

5B|newtownnames|1

5C|moreanimation|1

5D|wagonspeedlimits|vehicle.wagon_speed_limits

5E|newshistory|1

5F|custombridgeheads|0

60|newcargodistribution|0

61|windowsnap|1

62|townbuildnoroads|not (economy.allow_town_roads or _generating_world)

63|pathbasedsignalling|1

64|aichoosechances|0

65|resolutionwidth|1

66|resolutionheight|1

67|newindustries|1

68|fifoloading|order.improved_load

69|townroadbranchprob|0

6A|tempsnowline|0

6B|newcargos|1

6C|enhancemultiplayer|1

6D|onewayroads|1

6E|irregularstations|1

6F|morestatistics|1

70|newsounds|1

71|autoreplace|1

72|autoslope|1

73|followvehicle|0

74|trams|1

75|enhancetunnels|0

76|shortrvs|1

77|articulatedrvs|1

78|dynamicengines|vehicle.dynamic_engines, since r12924

7E|variablerunningcosts (since r1421)|1

7F|set if any switches are on|1||

<nowiki><nowiki>* loadallgraphics is obsolete (and its bit unused) since revision 401. The next official versions were the 5/Jun/2006 nightly (402) and 2.5 beta 6 (472)</nowiki></nowiki>

<nowiki><nowiki><nowiki>*</nowiki> moreindustriesperclimate is obsolete (and its bit unused) since 2.5 beta 2.</nowiki></nowiki>

Callbacks

2011-06-12T19:23:29Z

Orudge: 16 revisions

'''''List of available callbacks'''''

=Callbacks=

{maketoc}

A callback is a special action 2 that the patch "calls" in order to modify various features, an example being the visual effect of train vehicles.  See the [[CallbacksTut|callback tutorial]] on how to use them.

In the final action 2 of a chain of variational action 2s, the second byte of the matching entry has to have bit 7 set to identify it as a callback result. (Previously, it was required that the second byte be FF, but now only bit 7 needs to be set.)

For example, 04 00 is not a callback result (but it may be the ID of another chained action 2), whereas 04 80 is a callback result with a value of 4.  For some callbacks, 15 bit results are possible, in which case the upper 7 bits are stored in the second byte.  For example, 54 C2 is a callback result with a value of 4254=16980, where again the second byte has bit 7 set, changing the 42 into C2.

For compatibility with earlier patch versions, FF in the high byte is taken to mean the same thing as 80, so 04 FF also has a callback result of 4.  Note that if your grf file needs to be compatible with versions before 2.0.1 alpha 40, you must set the high byte to FF, and so can use only 8 bit results.

== List of callbacks==

The following callbacks are defined by the patch.  The number of the callback is what will be stored in variable 0C so that you can return the right results if you have several callbacks.  All callbacks are explained in more detail below.

'''PLEASE NOTE:''' Since TTDPatch 2.5 beta 5, the size of variable 0C has changed, and now there are word-sized callback numbers as well. To maintain backwards compatibility, only callbacks 10..3F can be checked using a byte-sized check. Callbacks 140 and above, on the other hand, must be checked using a word or dword sized check, to make sure they are identified uniquely.

||Number|Feature(s)|Meaning

10|Vehicles|Visual effect and wagon power

11|Vehicles|Wagon length

12|Vehicles|Load amount

13|Stations|Station availability

14|Stations|Use callback to select sprite layout

15|Vehicles|Set refitted capacity

16|Trains|Build articulated engines

17|Houses|House construction check

18|Several (G*)|AI construction/purchase selection

19|Vehicles|Cargo sub-type display

1A|Houses|Next animation frame

1B|Houses|Animation control

1C|Houses|Construction stage changes

1D|Trains|Can wagon be attached

1E|Houses|Decide colour of building

1F|Houses|Cargo acceptance

20|Houses|Length of animation frame

21|Houses|Trigger building destruction

22|Industries|Availability

23|Vehicles|Additional text in purchase screen

24|Stations|Custom station layout

25|Industry tiles|Animation control

26|Industry tiles|Next animation frame

27|Industry tiles|Length of animation frame

28|Industries|Industry location permissibility

29|Industries|Random production change

2A|Houses|Get accepted cargo types

2B|Industry tiles|Decide cargo acceptance

2C|Industry tiles|Get accepted cargo types

2D|Vehicles|Select colour mapping for vehicle

2E|Houses|Custom cargo production

2F|Industry tiles|Custom shape check

30|Industry tiles|Decide drawing default foundations

31|Vehicles|Start/stop check

32|Vehicles|32-day callback

33|Several|Sound effect callback

34|Vehicles (G*)|Autoreplace vehicle selection

35|Industries|Monthly random production change

36|Vehicles|Change vehicle Properties

37|Industries|Cargo sub-type display

38|Industries|Show additional text in fund window

39|Cargoes|Custom profit calculation

3A|Industries|Show additional text in industry window

3B|Industries|Control special effects

3C|Industry tiles|Disable autosloping

3D|Industries|Opt out of accepting cargo

40..13F| |--Reserved--

140|Stations|Animation control

141|Stations|Next animation frame

142|Stations|Length of animation frame

143|Houses|Protect building conditionally

144|Sounds (G*)|Ambient sound effects

145|Cargoes|Custom station rating calculation

146|New Signals (G*)|New signals sprite drawing|

147|Canals|Add sprite offset

148|Houses|Watched cargo accepted

149|Stations|Land slope check

14A|Industries|Decide industry color

14B|Industries|Decide input cargo types

14C|Industries|Decide output cargo types

14D|Houses|Customized building name

14E|Houses|Decide drawing default foundations

14F|Houses|Disable autosloping

150|Airport tiles|Decide drawing default foundations

152|Airport tiles|Animation control (OpenTTD > r19197)

153|Airport tiles|Next Animation frame (OpenTTD > r19197)

154|Airport tiles|Length of animation frame (OpenTTD > r19197)

155|Airports|Extra information about airport layout in the build gui (OpenTTD > r20372)

156|Airports|Airport layout name (OpenTTD > r20373)

157|Objects|Land slope check

158|Objects|Next animation frame

159|Objects|Animation control

15A|Objects|Length of animation frame

15B|Objects|Decide colour of building

15C|Objects|Show additional text in building window

15D|Objects|Disable autosloping||

<nowiki><nowiki>*</nowiki></nowiki> Generic callbacks are called for the feature, not any specific vehicle ID. Read the [[Action3#n%2Did|Action 3]] entry on how to define these.

==Visual effect and wagon power (10)==

This callback is used to determine the visual effect to use for a vehicle and whether a train wagon is powered (adding power and weight to the train).

The 'powered wagon'-flag only applies for train wagons that would by default be powered (i.e. property 1B is set).

The visual effect applies to all train vehicles (since OpenTTD r21238 for road vehicles and ships as well).

The callback is only called when loading a game, when the train reverses, or when rearranging the train in a depot.

In OpenTTD the 'visual effect' is also updated when the vehicle enters track of a different railtype. The 'powered wagon'-flag may not change in that case.

If the callback fails for any reason (e.g. not defined, action 2 does not return callback result etc.), the value of the corresponding action 0 property ( [[Action0Trains#Visual_effects_and_wagon_power_22_|train property 22]], [[Action0RoadVehicles#Visual_effect_21_|road vehicle property 21]], [[Action0Ships#Visual_effect_1C_|ship property 1C]] ) is used instead.  For possible return values, refer to these properties as well.

==Wagon length callback (11)==

This callback is used instead of [[Action0Trains#Shorter_train_vehicles_21_|property 21]] whenever the train leaves a depot or is displayed inside a depot. If the callback fails, the value of property 21 is used instead.

Road vehicles do not have a property for this purpose. If the callback fails, a length of 8/8 is used.

The callback result may change only when whole vehicle chain is inside a depot.

==Load amount callback (12)==

This callback is used instead of [[Action0General#Load_amount|property 07]] when loading a game or rearranging a train in a depot (or when buying other vehicles). If the callback fails, the value of property 07 is used instead.

Note: For aircraft carrying both passengers and mail this callback is broken (wrt. mail) in TTDP and OTTD before r14672.

Since OTTD r14672 the callback is called for passengers and for mail. The mail compartment behaves like a wagon attached to a train engine. I.e. to read general variables of the aircraft you have to use varaction2 type 82/86/8A (related object), as most variables are not valid for the mail compartment.

Finally to distinguish the passenger and the mail part you can use variable 47 or even 40.

==Station availability callback (13)==

This sets whether a station can be constructed or not, i.e. whether it can be selected in the station construction window.  A non-zero callback return indicates the station can be built, and a return code of zero removes the station from the selection.

==Station sprite layout (14)==

Callback 14 selects an entry from the sprite layout (set by [[Action0Stations#Sprite_layout_09_|prop. 09]] or the default if unset), and if its return value is invalid then the sprite layout given from the tile type will be used.  You can use this to have more than 4 different sprite sets to choose from.

Bit 0 (station orientation) of the return value is ignored, and instead set to bit 0 of the actual tile, so that you do not have to check the orientation explicitly and return the two corresponding values, instead just organize the layouts such that even numbers correspond to X orientation (NE-SW) and odd numbers corresponding to Y orientation (NW-SE).

The effect is like having additional tile types that are however not actually built, but only show different graphics depending on this callback.

==Refitted capacity callback (15)==

This callback is used when a vehicle is refitted, to find the new capacity. It is a 15 bit callback since 2.0.1 alpha 40, and allows return values up to 7EFF=32511 units of cargo.

Vehicle variable B9 (for a variational action 2) will be set to the new, climate-specific cargo type (column 3, type B in the [[CargoTypes|cargo type list]]), or to FF when only checking whether the vehicle is refittable.

Unlike regular refitted capacities (including those from callback 36), the return value is not subject to the usual division of capacities for cargoes other than passengers on trains and planes, instead the capacity is used exactly as returned by the callback. See also the summary page about  [[VehicleRefitting|vehicle refitting]].

==Articulated engine callback (16)==

This allows building articulated engines or wagons, i.e. vehicles made from several individual vehicles.  If this callback is in use, additional vehicles will be added until the callback returns FF.

The callback return is interpreted as the ID of the vehicle to add.  If 80 is added to the ID, the vehicle will be reversed (as if Ctrl was held while bought).

Note that since the train is not yet built, you cannot use train variables in action 2. Instead, use variable 10 (extra callback info 1), which is set to 01 for the first articulated part, 02 for the second and so on.

If more than the first vehicle contains cargo, the callback must work in the buy menu as well. (This is only supported since 2.5 beta 8.)  This means that it will be called with cargo type FF in the action 3. Otherwise, the cargo amount shown in the buy menu will only be for the first part of the articulated vehicle.

In OpenTTD the cargo class of the first road vehicles is used to determine whether the vehicle can stop at bus or truck stops regardless of the capacity of the first vehicle. If the cargo class bit for passengers is set it can go to bus stops when the is not set it can go to truck stops. See also the page about  [[VehicleRefitting|vehicle refitting]].

==House construction check (17)==

This callback is used to determine if the given building type can be built on a position. It should return a nonzero value to allow building and zero to cancel it.

Since the building is not created yet, you can't use variables 40 and 41 (they return zero). You can use variable 42, 43, 44, 45 and all town variables, though. Since OpenTTD r19744 you can also access the random bits via RandomAction2 or variable 5F.

Property 0A and 13 are checked even if the callback returns a nonzero value; they can cancel building as well.

For multi-tile buildings, this callback is always called for the north tile type, but the position you can access through variables 40, 42 and 43 is not guaranteed to be the final position of the north tile. It is guaranteed, though, that if the building really gets built, one of its tiles will occupy that tile. So, for example, if you return zero for desert tiles, this neither means that your building won't occupy any desert tiles, nor that its north tile will be on a non-desert tile; it only means that at least one tile of the building will be on a non-desert tile. (e.g. it can still be built on the very edge of a desert) This restriction was removed in OTTD r13489, the callback is now called for the final position of the north tile.

==AI construction/purchase selection (18)==

This generic feature callback is called for various decisions when the AI is constructing a new route. For example, normally the AI has a hardcoded list of wagons for each cargo type, but with this callback you can make the selection depend on source and destination industries as well as service distance among other things.

Since the vehicle hasn't been bought yet, you cannot use the usual 40+x or 80+x vehicle variables, instead you have the following:

||Variable|Size|Content

80|B|cargo type (climate specific, column 3, type B in the [[CargoTypes|cargo type list]])

81|B|cargo type (climate independent, column 1, type A in the [[CargoTypes|cargo type list]])

82|B|default selection

83|B|source [[IndustryTypes|industry type]]. For new industries the substitute type is returned starting with OpenTTD r20108.

84|B|destination [[IndustryTypes|industry type]]. For new industries the substitute type is returned starting with OpenTTD r20108.

85|B|distance between source and destination, in (dx+dy)/2

86|B|AI construction event

87|B|Construction number; for wagons: number of wagon; for stations 0=source station, 1=destination station

88|B|Station size in form NL; N=number of platforms, L=length

40|D|xxxxxxTT, TT=cargo slot from cargo translation table or same as var.81 if no table, available since r1167/2.5b9||

The callback will be called for following construction events, stored in variable 86:

||Group|Feature|Var.86|Type|Description

Trains|00|00|Check|Regular rail engine

| |01|Check|Electric rail engine

| |02|Check|Monorail engine

| |03|Check|Maglev engine

| |08|Get|Regular rail wagon

| |09|Get|Electric rail wagon

| |0A|Get|Monorail wagon

| |0B|Get|Maglev wagon

| |0F|Get|Track type to build

Road Vehicles|01|00|Check|Road vehicle

| |01|Get|First road vehicle ID to try

| |02|Get|Number of road vehicles to try

Ships|02|00|Check|Ship

| |01|Get|First ship ID to try

| |02|Get|Number of ships to try

Aircraft|03|00|Check|Aircraft

Stations|04|00|Get|Station ID||

Notes:
*"Check" means to check if it should try to buy this vehicle (with ID in var.82). Return 00 to disallow purchase, or a non-zero value to allow it. If allowed, the computer will buy the highest-cost (or AI rank for train engines) vehicle it can find that is available and has high enough reliability.
*"Get" means to find out which ID (etc.) to use. The default in var.82 is what it will use if the callback fails.
*For train engines and aircraft, the AI always checks all available engines.
*For road vehicles and ships, the AI has a built-in list of vehicles to try, you can use callback event 01 and 02 to change that list.
*For trains, the track types (0=regular, 1=electric, 2=monorail, 3=maglev) are automatically mapped as appropriate depending on the electrifiedrailways/unifiedmaglev switches. For best results, assume that all four are available. The game will then use the correct one if it is not available.

This callback is "chained", i.e. if a result is not a callback result (high bit is not set), then the request is passed on to the previous generic callback handler, i.e. they are checked in reverse order. This makes it possible to leave certain decisions to the previous handler and allows some cooperation between several .grf files.

==Cargo Subtype Display (19)==

This callback allows you to display some text after the cargo name when refitting, and in the vehicle capacity display. This is useful to distinguish several subtypes of a certain cargo, e.g. goods could be cars, petroleum, sheet metal etc.

The return value must be the number of a D0xx string set by an action 4 in the same .grf file.  For example, if you set text ID D006 to some text, return 06 in this callback will make it displayed after the cargo name.

Normally, you would use the vehicle refit cycle/sub type variable F2 to distinguish the various subtypes.  During refitting, the callback is called with successively increased values of variable F2, until the callback returns FF.  All the returned variations are then displayed as refitting options, with all options that have the same cargo type and callback result (irrespective of refit cycle) grouped together in the same line.

==Next animation frame (1A/26/141/153/158)==

Called in every animation frame, this callback returns the number of the next frame to display. Additionally, it can return these special values:

||Value|Meaning

FF|stop animation. The current frame stays on screen until the animation is restarted.

FE|continue with next frame as usual. You can return this for stages where you don't want to do anything special.||

From TTDPatch 2.5 beta 2, you can ask for random bits in variable 10. To enable this, set bit 3 of property 19 for houses, bit 0 of property 12 for industry tiles, or bit 2 of property 13 for stations.

Additionally all animation callbacks also allow to trigger sound effects as described in [[Callbacks#Watched_cargo_accepted_148_|Callback 148]].

==Animation control (1B/25/140/152/159)==

Called periodically, in a time interval specified in property 16 (houses) or when an animation trigger happens (industry tiles and stations). Returns the number of the frame the animation should jump to, or one of the following special values:

||Value|Meaning

FF|stop animation in its current frame

FE|start animation with its current frame

FD|leave the animation in its current state (do nothing)||

For multi-tile town buildings, [[Action0Houses#Extra_Flags_19_|property 19/bit 2]] modifies this callback slightly, see details there.

For industry tiles and stations, the low byte of variable 18 contains the reason for the call, i.e. the bit number of the event from [[Action0IndustryTiles#Triggers_for_callback_25_11_|property 11]] or [[Action0Stations#Animation_triggers_18_|property 18]], accordingly.

Unlike callback 1B, callbacks 25, 140 and 159 are always used when defined, no bit in the action 0 property needs to be set to activate them.

Since TTDPatch 2.5 beta 2, this callback gets random bits in variable 10, to allow randomizing changes.

For callback 1B, the exact randomness depends on bit 2 of property 19 (synchronized callback 1B). If the callback is synchronized, the high 16 bits will be the same for all tiles and the low 16 bits will be different for each tile. Otherwise, all 32 bits will be independent for each tile.

For callback 25, the randomness depends on the type of the event. For triggers that happen for the whole industry (triggers 2, 3 and 4), the high 16 bits will be the same for all tiles, while the low 16 bits will be different. For other triggers, all 32 bits are independent.

For callback 140, the high 16 bits are the same for all tiles triggered, while the low 16 bits are different for each tile.

Additionally all animation callbacks also allow to trigger sound effects as described in [[Callbacks#Watched_cargo_accepted_148_|Callback 148]].

==Construction stage changes (1C)==

Called when the building changes its construction stage (during normal gameplay, that means exactly four times). Can return the same values as callback 1B. Variable 40 contains the new stage. You can return FF for stages that don't have animated graphics to save resources.

==Watched cargo accepted (148)==

Called when a cargo type specified in property 20 is accepted by a house tile, or to be more specific, in a station that has the house tile in its acceptance area. It will be called for each tile of a multi-tile building whenever a tile with property 20 accepts cargo. This means if more than one tile has cargoes specified in property 20, the callback can be called multiple times on the same tile in the same tick. The low word of variable 18 contains the offset of the trigger tile relative to the current tile; the low byte contains the X offset, the high byte the Y offset. (0 means it's the same tile, negative coordinates mean it's northward, positive southward.) With this, you can tell apart the callings within the same tick. The high word of variable 18 contains random bits, the bits are the same for each tile of multi-tile buildings. The return values can be the same as for callback 1B.

Due to implementation details, up to 250 game ticks can pass between the actual acceptance and triggering this callback.

This callback isn't available if the station2 structure isn't present - see the property 20 entry for more information.

If any of the above animation callbacks return a nonzero value in the high byte, it will be interpreted as a sound effect number, and the corresponding sound effect will be played on the house tile.

==Can wagon be attached (1D)==

This callback is called for the train engine (i.e. from the engine's action 3) when attaching a new vehicle to the current train and determines whether it may in fact be attached to the train. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it.

You may use variational action 2s to check variables 40+x and 80+x. For var. action 2 type 81 (vehicle), they refer to variables of the wagon that is to be attached, not the engine it is being attached to, so you can check the wagon's properties like the cargo type to see whether it is appropriate for the given train engine.

Var. action 2 type 82 (engine) refers to the engine the wagon is being attached to, starting from version 2.0.1 alpha 46. This allows you to for example find out the length of the train it is being attached to. In earlier patch versions, it refers to the engine of the source consist (or the wagon if the wagon is not attached to anything else), which was not really helpful.

Return values:

||Return|Meaning

xx|Disallow attaching and use the D0xx text ID as second line of an error message,

FD|Disallow attaching with the standard message (incompatible rail types)

FE|Allow attaching

FF|Allow attaching if the rail types match (default)||

It you return FE, you would allow attaching for example a monorail wagon to a regular rail vehicle, so if that's not what you intend, return FF.

==Building colour (1E)==

Called to decide what colour mapping the building should use. Should return the number of the colour mapping to be used, for example, 775 for blue->dark blue mapping.

This can be useful if you want something more complex than four random colours.

From 2.0.1 alpha 67, you can return a value of col2*16+col1 plus bit 14 set, where col1 and col2 are two company colours. For example, a return value of 73 C0 uses col1=3=yellow and col2=7=dark green. If no two-company-colour maps have been installed, the colours from prop. 17 are used instead.

Uses 15 return bits.

==Cargo acceptance (1F)==

Called to decide what the building tile can accept. Uses 15 return bits. The returned word should have the layout of Sgmp, where the letters mean the following:

||Symbol|Meaning

S|1 if the building should accept food/fizzy drinks instead of goods

g|If S is 1, the food acceptance in 1/8 units

|If S is 0, the goods acceptance in 1/8 units

m|mail acceptance in 1/8 units

p|passenger acceptance in 1/8 units||

So, for example, giving the ID 8426h means "4/8 goods, 2/8 mail, 6/8 passenger", while giving the ID 9205 means "2/8 food, 5/8 passenger".

If property 1E and/or callback 2A is used, the meaning changes slightly. In this case, p means the acceptance of the first cargo type given, m means the same for the second cargo type, and g is the same for the third cargo type, while S must be zero.

==Length of animation frame (20/27/142/154/15A)==

Called to decide how long the current animation frame should last. The value of the delay should be given in the same way as for property 1B/10/17. Decreasing the return value speeds the animation up instantly. Increasing, on the other hand, doesn't slow it down instantly: the actual duration of the current frame will be somewhere between the old and the new delays. The new delay is applied correctly for later frames.

Note: This is one of the most time consuming callbacks as it is called for every animated tile every ≈30 milliseconds. For better performance try to avoid using it where reasonable, e.g. try to use only the properties and put multiple identical looking animation frames after each other.

==Trigger building destruction (21)==

Called periodically, in a time interval specified by property 16. If it returns a nonzero value, the building gets removed from the map as if the town decided to destroy it. You can use this for example to remove a historical building, since those cannot be normally removed by towns.

==Industry availability (22)==

Called when TTDPatch needs to know if a given industry type is available.

Return zero to make your type available, or any nonzero value to disable it. This callback is intended for limiting your type as a whole, so you can't access any industry-specific variables, just the global ones. A good example for the use of this callback is a nuclear power plant that isn't allowed to appear before 1970.

During this callback, variable 18 (extra callback info 2) can contain the following values:

||Variable 18|Meaning

0|TTD is generating a map and needs to know if your type can appear.

1|TTD decided to build a new random industry during regular gameplay and needs to know if it can choose your type.

2|The user tries to build/prospect for your industry via the new industry window. TTD needs to know if the player is allowed to do this.||

==Additional text in purchase screen (23)==

This callback is called when TTDPatch displays the vehicle stats of any vehicle in its purchase screen. The return value is the "xx" of a D0xx text ID to be shown below all other stats. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it. As of r1908, text IDs D100..D3FF may also be returned.

How many lines are available depends on the type of vehicle and its other properties, for instance the presence or absence of a "refittable to" line or powered wagons etc. Lines are wrapped automatically, or may be broken explicitly using the newline character 0D.

If cargo FF (buy menu sprite) is handled explicitly for a vehicle, then the varaction 2 handling callback 23 must be in the buy menu varaction 2 chain.

==Custom station layout (24)==

After applying the values from station prop. 0E, this callback is used to further customize the tile layout.

It is called once for every tile that is being built, and returns the new tile type to build in its place or to leave the tile as defined by prop. 0E or TTD's default if the callback fails. The only possible return values are 00, 02, 04 and 06. Their meaning is the same as in prop. 0E.

Since the station hasn't yet been built, variables 40+x and 80+x are not available, instead variable 10 (extra callback info 1) contains the same information as variable 41 would contain. For the same reason, it uses the same cargo type in action 3 as the construction menu does (i.e., type FF if defined or else the default).

This callback is used always and does not need setting a bit in the action 0 property to activate it.

==Industry location permissibility (28)==

Called to decide if the industry can be built on a given spot. Since the industry isn't built yet, you can only use a small subset of the data: you can access the data of the nearest town via action 2/type 82 without any problems, but action 2/type 81 will access different variables than it would normally access:

||Variable|[[GRFActionsDetailed|'''Size''']]|Meaning

40+x| |Not accessible

5F| |Since OpenTTD r19744: Random bits the industry starts with after construction. Accessible via RandomAction2 as well.

60+x| |Only var. 62 and vars 64..68 can be used

80|W|Coordinates of the selected position

86|B|Number of the selected layout, according to property 0A

87|B|Ground type of the selected spot (see [[VarAction2Canals|canal variable 81]] for details)

88|B|Town zone of the selected spot (see [[VarAction2Houses#Town_zone_42_|house variable 42]] for details)

89|B|Distance between the closest town and the selected position.

8A|B|Height of the lowest corner of the tile (between 00h and 80h, one land height unit equals 8 units)

8B|W|Distance to the closest water tile if property 1A bit 2 is clear (built on land); distance to the closest empty dry land tile if property 1A bit 2 is clear (built on water)

8D|W|Square of the Euclidean distance between the closest town and the selected position

8F|D|32 random bits (since r1816 and r11985)||

Unless explicitly noted, distances are Manhattan distance, not Euclidean distance, ie. -+|x-x0|+|y-y0|+- instead of -+<nowiki><nowiki>sqrt[[Action11|Action 11]]. If the callback returns a failure code (not a callback result), the default TTD sound effect will be played. If the callback returns a sound number that is neither a TTD sound, nor a sound from action 11, nothing will be played.

||Var. 10|Event

1|Start sound, called when leaving a station or depot, take-off sound for planes

2|Tunnel sound, called when vehicle enters tunnel

3|Breakdown sound, called when vehicle breaks down (not for planes)

4|Running sound, called once per engine tick, but no more than once per vehicle motion

5|Touchdown sound, for planes only (obviously)

6|Train visual effect generation (steam plume, diesel smoke, electric spark)

7|Running sound, called every 16 engine ticks if in motion

8|Stopped sound, called every 16 engine ticks if stopped (e.g. at signal/in station)

9|Load/unload sound, called when consist loads or unloads cargo

10|Bridge sound, called as generic feature 06 callback every time a consist moves on a bridge. Variables 40+x, 60+x and 80+x refer to the vehicle and bits 0..7 of variable 18 hold the bridge type||

For the running sounds, it is advisable to check the [[VarAction2Vehicles#Motion_counter_46_|motion counter]] and to only return a successful sound effect number every so many vehicle motion ticks. This way, the sounds will be played more frequently the faster the train is. Alternatively, you can check the tick counter variable and play the sound effect every so many engine ticks, so that it is played at a constant rate, or, of course, switch between both modes depending on vehicle speed.

Note that if the planespeed switch is active, planes move the given number of times per engine tick. This means that their motion counter increases faster than for other vehicles, and thus to get reliable sound effects you need to divide the motion counter by the planespeed setting (readable via [[ActionDSpecialVariables#Reading_patch_variables|action D]]) before checking the value.

==Autoreplace vehicle selection (34)==

This callback is called whenever an old vehicle needs replacing. It returns the vehicle IDs to upgrade the current vehicle to. The vehicle variables are available as usual to decide which IDs would be appropriate to upgrade to.

The callback is repeatedly called, with the iteration number stored in variable 10.  The .grf file should return all possible IDs one by one, with the best ones listed first.  The patch will use the first vehicle from the list that is available to the player and has the required minimum reliability as set by the autoreplace switch, and abort the callback sequence at this point.

The callback sequence is also aborted when the returned ID is equal to the current vehicle ID. This is to prevent downgrading, and so you must take care to always return the ID of the vehicle for which the callback is called at the appropriate place in the sequence.

If the callback fails, i.e. if no suitable ID could be found by any of the callbacks in the generic chain, the vehicle is not upgraded, and is simply renewed instead.  If an ID is available but the player lacks the cash to upgrade, the patch waits for the cash to become available instead of either picking a worse engine or renewing the vehicle.

For trains, each engine head will be replaced by one vehicle of the new type.  As such, it is advisable for only return "compatible" IDs for trains that require a particular construction or arrangement of engine heads.

The callback is always used when defined, no bit in the action 0 property needs to be set to activate it.

==Monthly random production change (35)==

Works exactly the same way as callback 29, except that it's called every month, allowing more frequent production changes.

==Change vehicle properties (36)==

This common callback allows modification of certain properties of a vehicle for which there exists no specific callback (like CBs 10, 11, 12). The low byte of variable 10 holds the [[Action0|property]] number from Action 0.

The following properties are supported:

||Feature|Property|Minimum version|OpenTTD rev|

Trains (00)|''07 (Load amount)''| - | - |''Changeable via [[Callbacks#Load_amount_callback_12_|callback 12]]''

|09 (Speed)|2.5 beta 6|r9671|

|0B (Power)|2.5 beta 6|r9671|

|0D (Running cost factor)|2.6 rev 1420|r9671|

|14 (Cargo capacity)|2.6 rev 1966|r9828|See also [[Callbacks#Refitted_capacity_callback_15_|callback 15]]

|16 (Weight)|2.6 rev 1887|r9780|

|17 (Cost factor)| |r9806|

|1F (Tractive effort)|2.5 beta 6|r9671|

|''21 (Short wagons)''| - | - |''Changeable via [[Callbacks#Wagon_length_callback_11_|callback 11]]''

|''22 (Visual effect & powered wagons)''| - | - |''Changeable via [[Callbacks#Visual_effect_and_wagon_power_10_|callback 10]]''

|25 (User data)|2.5 beta 6|r11431|

Road Vehicles (01)|''07 (Load amount)''| - | - |''Changeable via [[Callbacks#Load_amount_callback_12_|callback 12]]''

|09 (Running cost factor)| |r18011|

|0F (Cargo capacity)| |r9828|See also [[Callbacks#Refitted_capacity_callback_15_|callback 15]]

|11 (Cost factor)| |r9806|

|13 (Power)| |r21058|

|14 (Weight)| |r21058|

|15 (Speed)| |r21100|

|18 (Tractive effort)| |r21058|

Ships (02)|''07 (Load amount)''| - | - |''Changeable via [[Callbacks#Load_amount_callback_12_|callback 12]]''

|0A (Cost factor)| 2.6 rev 1990 |r9806|

|0B (Speed)|2.5 beta 6|r9671|

|0D (Cargo capacity)| 2.6 rev 1990 |r9828|See also [[Callbacks#Refitted_capacity_callback_15_|callback 15]]

|0F (Running cost factor)| 2.6 rev 1510 |r9808|

Planes (03)|''07 (Load amount)''| - | - |''Changeable via [[Callbacks#Load_amount_callback_12_|callback 12]]''

|0B (Cost factor)| |r9806|

|0C (Speed)|2.5 beta 6|r9671|

|0E (Running cost factor)|2.6 r1507|r9678|

|0F (Passenger capacity)| |r19218|See also [[Callbacks#Refitted_capacity_callback_15_|callback 15]]

|11 (Mail capacity)| |r19218| ||

Most properties will only change when the vehicle is bought, serviced (enters a depot), visits a station or on loading of a saved game. Other ones such as TE are called every time a TE calculation is run.

If the callback fails, the corresponding value from the action 0 property will be used. The callback is always used when defined, no bit in the action 0 property needs to be set to activate it.

Before r1758 (both 2.5 and 2.6), callback 36 was sometimes called with the 40+x and 80+x variables unavailable when they should have been available, or with not all 80+x variables properly initialized, causing some 40+x variables to be unsafe.

About the capacity properties see also the summary page about  [[VehicleRefitting|vehicle refitting]].

==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. Just like callback 19, the return value must be the number of a D0xx string set by an action 4 in the same .grf file. Returning FFh causes no text to be displayed.

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.

Since OpenTTD r17802, the contents of registers 100h..105h are copied onto the text reference stack.

==Show additional text in fund/building window (38/15C)==

This callback allows you to display extra information in the industry fund and object building windows. The return value should be the number of a D0xx text to be displayed. The text must begin with a colouring special character and should not be longer than three lines (automatic line breaks are provided, but you can use char 0D for a manual line break). Since the industry isn't built yet, you can't access any industry variables during this callback. Same holds for objects.

Since OpenTTD r20086 and TTDPatch r2354, the contents of registers 100h..105h are copied onto the text reference stack.

{cookie}

==Custom profit calculation for cargoes (39)==

This callback is called every time cargo is delivered to a station, to get how much income the player should get. The low word of var. 18 contains the distance of the transfer, byte 3 contains the amount of cargo moved and the highest byte contains the time spent en-route (a unit of time is +185 ticks, or ca. 2.5 days). The result should be a signed multiplier that gets multiplied by the amount of cargo moved and the price factor, then gets divided by 8192. Since the highest bit must always be set for a callback result, TTDPatch checks for the second highest bit (bit 14) for the sign. Returning a negative value means that the player has to pay for the transfer instead of getting money from it. For example, the maximum returnable value of 16383 means that the player gets twice the price factor for every unit.

==Show additional text in industry window (3A)==

This callback allows you to display extra information in the industry window about the state of your industry. The return value should be the number of a D0xx text to be displayed. The text must begin with a colouring special character and should not be longer than one line. For example, you can use this callback to display the current production limit of a secondary industry.

Note that since r11987, OpenTTD allows resizing the window when this callback is enabled.  It allows to specify a text containing more than one line.

Since TTDPatch 2.6 r1370, the contents of registers 100h..105h are copied onto the text reference stack. This allows you to display dynamically calculated values in the text by using the according StringCodes. Please note, though, that the text handler will see it as an array of bytes, not as an array of DWORDs, so you will have to pack two words into a register when you use codes that read words from the stack. In the case of \7D (which gets a byte), you may have to pack more into a register, but it's probably easier to use \7C instead. Please also note that you can use \80 to display textIDs calculated on the fly, but DCxx textIDs won't work correctly. When you need to choose from your own texts dynamically, you must use D0xx IDs, and add 400h to them. (That is, use D400 to refer to D000, D401 for D001 etc.)

==Control special industry effects (3B)==

This callback allows you to control some aspects of the special effects enabled in property 1A. The lowest byte of variable 18 always contains the number of the special effect, which equals to the bit number being set in property 1A. Currently only effect 0 (plant fields periodically) and effect 1 (cut nearby trees periodically) are supported.
* For effect 0 you should return zero to avoid planting fields and any other value to plant a field. The callback is called every 256 ticks for a given industry. Variable 10 contains 32 random bits that can be used to randomize the behaviour. Industry variable AAh (word) can be used to make the plantings rarer, but please note that the low byte is always zero at this point. The default behaviour is giving 1/8 chance to plant a new field every 256 ticks.
* For effect 1 you should return zero to avoid cutting a tree and any other value to try cutting one. The callback is called every 256 ticks for a given industry. You don't get random values this case, but you can still use variable AAh; the low byte is always zero here as well. The default behaviour is trying to cut a tree every 512 ticks.

==Disable autosloping (3C/14F/15D)==

With this callback, you can prevent the autoslope feature from altering the ground below a house/industry/object tile. To allow altering the ground, return zero. Returning anything other than zero will disallow land modifications.

==Opt out of accepting cargo (3D)==

With this callback, the industry can refuse accepting a cargo even if it's one of the input cargo types. If there's another industry nearby that accepts this cargo, that one will get it.

The lowest byte of var. 18 contains the ID of the cargo delivered. If your GRF has a cargo translation table installed, you will get the index from that table; otherwise, you will get the cargo bit associated with the cargo type. You must return zero if you don't want to accept the cargo, or 1 to accept it. Other return values are reserved for future use.

This callback should be used in conjunction with callback 2B, since the acceptance of the tiles and the acceptance of the industry itself should always agree. If you disable accepting a cargo via callback 3D, but forget to remove the acceptance from the tiles, the station will keep accepting the cargo and the player will keep getting the money, but the industry won't receive the cargo. On the other hand, if you remove acceptance from the tiles, but forget using callback 3D, your industry may still get the cargo. (For example, there may be another industry nearby whose tiles accept the cargo. This makes the station accept the cargo, and send it to the nearest industry, which happens to be yours, even though its tiles don't accept the cargo.)

==Protect building conditionally (143)==

This callback is called when someone tries to remove the building from the map. You can use this callback to prevent the town or AI players from removing the building if certain conditions are met. You can return 0 to allow the destruction, or 1 to disallow it, except for human players, who can always remove any building.

If you always return 1 from this callback, you achieve the same effect as turning on bit 1 of property 19. When this callback is enabled, bit 1 of property 19 is ignored. If the callback fails, the destruction is allowed.

For multi-tile buildings, the callback will be called for the type of the tile the player wants to destroy. Therefore, to get consistent behaviour, you must enable this callback for every tile and respond it the same way no matter which tile it is called for.

Since TTDPatch 2.6 r1705, you can use this callback to prevent building "town" industries (banks, water towers, etc.) over your house. The lowest byte of variable 10 is zero for "normal" demolition and one when TTD wants to remove the house for the sake of a new industry. Other values of variable 10 are reserved for future use.

==Ambient sound effects (144)==

This callback is a generic callback for feature 0C (new sounds) used for playing ambient sound effects.

The 15-bit return value is the sound effect number. Values from 0 to 72 (dec) are TTD's built-in sound effects, values beyond that refer to the sounds from [[Action11|Action 11]].

To decide whether to play a sound, and what sound to play, Var.Action 2 variable 10 holds the following information: THRRxxxt

||Field|Meaning

T|Tile class, 0=bare land, 4=trees, 6=water

H|Height of north corner of tile

RR|8 random bits

xxx|Reserved

t|Terrain type;  0 normal (grass), 1 desert, 2 rainforest, 4 on or above snowline||

This callback must be enabled by bit 4 in [[ActionD#Misc_GRF_Features_9E_|action D var 9E]].

==Custom station rating calculation (145)==

This callback allows you to modify part of the station cargo rating calculation for your cargo. To understand how to use it, you must first understand how the default rating calculation works:

Internally, the station rating is stored in a byte, 0 meaning 0% and 255 meaning 100%. The rating is calculated as the sum of the following components:
* Time since the cargo was last picked up:

||Time units (days)|Score (%, rounded)

>21 (>52.5 days)|0 (0%)

13..21 (32.5 days..52.5 days)|25 (10%)

7..12 (17.5 days..32.5 days)|50 (20%)

4..6 (10 days..17.5 days)|95 (37%)

0..3 (0 days..10 days)|130 (51%)||

The time unit used equals 185 engine ticks, or 2.5 TTD days. For ships, the time units are divided by 4 before calculating this component, so ships have four times more time before the ratings start dropping.
* Amount of cargo waiting:

||Amount of cargo|Score (%, rounded)

>1500|-90 (-35%)

1001..1500|-35 (-14%)

601..1000|0 (0%)

301..600|10 (4%)

101..300|30 (12%)

0..100|40 (16%)||
* Max. speed of the last vehicle picking up the cargo:

This calculation is somewhat complicated. The maximum speed of the vehicle is expressed in "speed units". For trains and road vehicles, the speed unit is 1 km/h; for ships, it's 0.5 km/h; for aircraft, it's 8 mph. If the max. speed is above 255 speed units, 255 is used instead. If the vehicle is slower than 85 units, no points are awarded; otherwise, you get (speed_units-85)/4 points. Therefore, the maximum you can get is 42 points, or 16%.
* Age of the last carrier picking up the cargo:

The original calculation goes like this:

||Age of vehicle (years)|Score (%, rounded)

2|10 (4%)

1|20 (8%)

0|33 (13%)||

If the newagerating switch is turned on, the calculation changes. You get 33 points for vehicles younger than 5 years, and get 0 points for vehicles older than 21 years. Between these two ages, score drops slowly, by 2 points per year.
* Bonus for AI companies

||AI intelligence setting|Score (%, rounded)

Low|0 (0%)

Medium|31 (12%)

High|63 (25%)||

That is, AI players cheat to get good ratings for their brain-dead routes.
* Bonus for statue in nearest town

If your company has erected a statue in the nearest town, you get 26 points (10%) bonus to all cargo ratings.

If a human player does everything perfectly, the maximum rating she can get is 271 points, while the worst possible transport service gets -90 points; for "highly intelligent" AI players, the corresponding values are 334 and -27, respectively. The resulting value gets clamped to the 0..255 range. TTD makes sure the ratings change slowly, but steadily: every 2.5 days, the actual rating moves towards the value calculated above, by no more than 2 points. For example, you 'd need at least 320 days to go from 0% to 100%, even if your service is perfect. When a cargo type first appears at a station, its rating is set to 175 points (69%), so it takes some time until it gets adjusted to the actual parameters of the service.

The callback allows you to replace the first three components (days since last pickup, amount waiting and max. speed of last vehicle) in the calculation above. If your callback succeeds, the first three components are skipped and the returned value is used instead their results. Bit 14 is considered the sign bit, so you can return negative numbers (and need not to worry about calculated callback results yielding a negative result, as long as you stay in the range -16384..16383). During the callback, variable 18 has the value ssaaaatt, where
* tt is the time since the cargo was last picked up, in the time units described above (1 unit = 2.5 days independent of vehicle type)
* aaaa is the amount of cargo waiting
* ss is the speed of the last vehicle picking the cargo up, in the speed units described above (if no vehicle entered the station yet, the value is FFh)

The lowest byte of variable 10 contains one of the following values:

||value|meaning

10h|the last vehicle entering the station was a train

11h|the last vehicle entering the station was a road vehicle

12h|the last vehicle entering the station was a ship

13h|the last vehicle entering the station was an aircraft

00h|no vehicle entered the station yet, or the last one entering was sold||

Please note that there's only one "last vehicle" field per station, so the vehicle this refers to may not have picked up any of your cargo. The original TTD calculation doesn't care about this and just uses the field to get the vehicle type used in the first component.

Currently, you can only use variables 10 and 18 for your decision, since neither vehicle nor station variables are available for a cargo callback. As soon as the architecture of TTDPatch allows this, the callback will be given access to the station and the last vehicle that entered.

==New signals sprite drawing callback (146)==

This is a generic callback, and thus a generic action 3 must be used. It must be processed by a variational action 2 feature 0E, as indicated in the following link: [[VarAction2NewSignals]].

==Add sprite offset callback (147)==

Add an offset to the default sprite number to be drawn.

||Feature|Accessible Variables

Canals|80+x variables are accessible by Canals. See [[VarAction2Canals]]||

The default number is accessible in variable 10 (extra callback info 1) to decide if the sprite number needs an offset.

==Land slope check (149/157)==

This callback is called for each tile where the new station part will be built. It can return zero to accept the current tile or one to make the station building fail with the "Land sloped in wrong direction" error message. Other return values are reserved for future use, don't use them for now.

Since the station isn't built yet, no 8x variables can be accessed. Only variables 43 and 67 will work from the 4x and 6x variables. You get the following information, though:
* variable 18:

||bit numbers|Meaning

0..7|offset of current tile on the platform, 0 is the northmost tile

8..15|bits 8..15: current platform number, 0 is the northmost platform

16..23|total length of station being built

24..31|total number of platforms being built||
* variable 10:

||bit numbers|Meaning

4..7|Slope info of the current tile:~pp~

bit 7 - N corner is elevated

bit 6 - E corner is elevated

bit 5 - S corner is elevated

bit 4 - W corner is elevated~/pp~

0..3|the same information, but "mirrored" (bit 0 and 2 swapped) if the station is built in the NW-SE orientation. This allows you to check slopes without checking the orientation explicitly.

other bits|reserved for future use||

The callback is called only after the normal checks TTD does for slopes, so it's not possible

to allow a slope that isn't allowed by default; you can only narrow the set of allowed slopes. If the callback fails, the tile will be accepted. It is, however, called for flat tiles, so you can force your station to sloped land. You can't access the station info even if the platform is added to an existing rail station or is overbuilding station tiles. That's because TTD will decide this later in the code, after the slope is already accepted.

This is called if available just before object construction, it does not require that any flags be set in the action0.

Please note that for Objects only the low byte of variable 18 is valid (Offset from north tile (origin), stored as YX) and that variable 10 does not have the reversed version, and bits 0 - 3 contain the actual raised corners (same order as bits 4 - 7).

==Decide industry colour (14A)==

This callback is called when the industry is being constructed, to override the selected colour of the industry (variable A8). This colour will be used for tile sprites that request recolouring, but don't supply a recolour sprite number. The following industry variables aren't yet filled and contain random junk: 86..87, 93, 9E..A1, A9. (You probably wouldn't need to read anything but 86..87 anyway, since these fields contain information about the past, and the industry doesn't yet have a past.) Industry tiles aren't placed yet, either.

Variables A7 and A8 are filled, however, and provide useful information. Variable A7 contains the number of the funder company, or 10h if the industry wasn't funded. Variable A8 contains the number of the colour scheme randomly picked by TTD, it's between 0 and 15. If you don't want to change the colour picked by default, you can either make the callback fail or just return variable A8 unchanged.

Only the lowest four bits of the returned value are used, the other bits are reserved for future use. Those four bits are copied into variable A8 after the callback returns. You can either use industry variable 45 to get the company colour of the funder (if there's any), use a random action2 to select a random colour scheme from a given list, or of course decide on global variables like position or game year.

==Decide input and output cargo types (14B,14C)==

These callbacks are called when the industry is built, and allow customizing the input and output cargo types dynamically. Both callbacks are called repeatedly, with the lowest byte of variable 10 starting from zero and increasing after every call; you should return a cargo type each time, or FFh to terminate the list. (A failed callback terminates the list, too.) The same limitations apply as for callback 14A: industry tiles aren't yet placed, and some industry variables contain junk. You can use random action2s, however. The interpretation of the returned value depends on two factors: the current GRF version number and the presence of a cargo translation table:

||GRF version|Has cargo translation table|Interpretation

6 or below| |Climate-dependent cargo slot number

7 or above|No|Cargo bit

7 or above|Yes|Index in the translation table||

Although currently callback 14B is called no more than three times, and callback 14C no more than twice, this may change between versions/implementations, to allow more input/output types. To be safe, you should return FFh as the last element even when you use all three input types or both output types.

==House customized building name (14D)==

This callback is activated from the Tile Description Query tool, when enquiring a house.  Variable 10 will be set to 1 if the house is complete, otherwise it will be 0.  The return value is the "xx" of a D0xx text ID.  If the callback fails, the Query tool will use the house name set in property 12 (Building name ID).

Since this callback is not performed frequently, you do not need to specify a mask.  It will always be performed, and the name will only change when successful.

Available for OpenTTD since r15172, and for TTDPatch since 2.6r2249

==Extra information about airport layout in the build gui (155)==

This callback allows you to display some extra text in the build airport gui. It should return a D0xx StringID. This callback is always called when available, you do not need to set a bit in any action0 property to enable it. Available for OpenTTD since r20272

==Airport layout name (156)==

This callback allows you to show a name for an airport layout. It should return a D0xx StringID. This callback is always called when available, you do not need to set a bit in any action0 property to enable it. Available for OpenTTD since r20273.

==Decide object colour (15B)==

This callback allows you to set/modify the colour of an object upon construction. Variable 10 contains the current company colour or a random colour for when there is no company, i.e. in the scenario editor. If the object wants a 2CC colour mapping two nibbles, i.e. two colours, are passed in variable 10, otherwise one nibble (colour).

RandomAction2

2011-06-12T19:23:28Z

Orudge: 13 revisions

'''''Randomized Action 2'''''

=Randomized Action 2=

Defining a randomized choice between several action 2 entries

-=Introduction=-

Unlike variational action 2, whose results are always determined by a predictable decision, one can also use randomized results to pick one of several graphics sets.

-=Format=-

The data looks as follows:

<pre> -+<Sprite-number> * <Length> 02 <feature> <set-id> <nowiki><nowiki>[80|83]</nowiki></nowiki> <random-triggers> <randbit> <nrand> <set-ids>+-</pre>

From 2.6 r1850 and OpenTTD r12452, and '''for vehicles only''':

<pre> -+<Sprite-number> * <Length> 02 <feature> <set-id> 84 <count> <random-triggers> <randbit> <nrand> <set-ids>+-</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

<feature>|B|For what type of vehicle/station/... should this definition be used?

<set-id>|B|The ID of this action 2 (used like a cargo ID)

80<nowiki><nowiki>|</nowiki></nowiki>83<nowiki><nowiki>|</nowiki></nowiki>84|B|Type of random action, see below.

<count>|B|(when present) Location of controlling vehicle.

<random-triggers>|B|When to re-randomize

<randbit>|B|What random bit to use for this action 2

<nrand>|B|Number of set-ids to choose from, must be a power of 2

<set-ids>|W|Action 2 set-ids to choose from.||

-=Filling in the terms=-

===Sprite-number===

This is just the number you are at.

===Length===

Count the number of bytes in this action.

===feature===

This sets the type of feature that you wish to change. Set it to:

00 for trains

01 for road vehicles

02 for ships

03 for planes

04 for stations

05 for canals

07 for houses

09 for industry tiles

0A for industries

0F for objects

10 for rail types (available in OpenTTD > r18969)

===set-ID===

This defines the number of this action 2.  The ID can then be used as target in an action 3 or another variational/random action 2.

===80/83/84===

Use 80 to randomize the object (vehicle, station, building, industry, object) based on its own triggers and bits.

Use 83 to randomize the object based on its "related" object (s.b.).

Use 84 to randomize the vehicle based on any vehicle in the consist.

||Feature|Related object

Vehicles (00-03)|First vehicle of consist

Stations (04)|N/A

Houses (07)|N/A

Industry tiles (09)|Industry containing tile

Industries (0A)|N/A

Objects (0F)|N/A||

===count===

For type 84, this specifies which vehicle's random bits this vehicle will be using and/or modifying.

The low nibble (bits 0-3) specifies how far to count from the starting vehicle. If it is zero, the count will be read from GRF register 100h instead.

The high nibble (bits 6-7, actually) specifies which vehicle is the starting vehicle, and which direction to count:

||0|count back (away from the engine), starting at this vehicle

4|count forward (toward the engine), starting at this vehicle.

8|count back, starting at the engine

C|count back, starting at the first vehicle in this chain of vehicles with the same ID, as for vehicle variable 41||

Bits 4-5 are reserved and must be zero, so other values of the high nibble are not allowed.

===random-triggers===

This is a bit mask of triggers which cause re-randomizing. Normally, any matching trigger causes the graphics to be randomized again, but if you add 80 to the bitmask, the re-randomizing only happens if '''all''' triggers have occurred.

Trigger bits are feature-specific, see below.

===randbit===

For versions before 2.0.1 alpha 30, leave this at 00. It doesn't quite work the way intended (it was supposed to allow independent random chains, but currently everything is re-randomized at the same time, thereby defeating this mechanism).

Since 2.0.1 alpha 30, only those bits that actually get triggered will be re-randomized.  Prior versions always re-randomized all bits.  This will make it possible to have independent sets of bits for independent triggers (or untriggered bits, set only at the time of purchase). Setting randbit determines the first bit to be re-randomized, as well as basing the random graphics on. The total number of bits used is the 2-logarithm of nrand below (e.g., for nrand=16, 4 bits are used).

===nrand===

Number of different sets to choose from.  This must be a power of 2, i.e. 2, 4, 8, 16 etc.

===set-ids===

Action 2 IDs to randomly choose from

-=Triggers=-

==Vehicles==

Vehicles have 8 random bits, and the following triggers:

||Bit|Value|Trigger

0|01|Vehicle gets new load of cargo (only after it was empty)

1|02|Vehicle enters a depot and is serviced

2|04|The consist has unloaded all cargo

3|08|Any vehicle of the consist receives cargo

4|10|Callback 32 returned 1||

The consist trigger bits 2 and 3 allow re-randomizing whenever the consist receives cargo after fully unloading. They should be used with action 2 type 80, not 83, and the random-triggers variable should have 80 added to it, to make the re-randomizing happen only if the consist was empty and '''then''' received new cargo.

==Stations==

Stations have 16+4 random bits. Bits 0 to 15 are a property of the station as a whole, and bits 16 to 19 are different for each tile.  To get tile-based randomness, therefore use randbit=10 and nrand of no more than 16 (since only 4 random bits are available per tile).

||Bit|Value|Trigger

0|01|new cargo waiting

1|02|no more cargo

2|04|train arrives (starts unloading/loading)

3|08|train leaves (done unloading & loading)

4|10|train loads or unloads cargo

5|20|train reserves platform (using PBS)||

Also note that none of the above triggers will actually trigger unless prop. 12 has at least one bit set.  Triggers 01 will be triggered for any of the cargo types set in prop. 12, but trigger 02 will only be triggered if all of those cargo types have no more cargo waiting. Triggers 04, 08 and 20 are triggered no matter what cargo types the train transports, as long as prop. 12 is not zero.

Triggers 04, 08, 10 and 20 only affect the platform on which they occur, as well as the random bits of the station, but not other platforms.

==Town building triggers==

Town buildings have 8 random bits.

||Bit|Value|Trigger

0|01|the building tile is processed in the periodic tile processing loop

1|02|the top tile of the building is processed in the periodic tile processing loop||

The periodic tile processing loop constantly processes the tiles of the map, processing any given tile in every 256 ticks (approx. 3.5 TTD days). Since no "real" event happens to town buildings, you have only this opportunity to re-randomize the look of your building.

If every 3.5 days is too fast for you, you can multiply the time-out by setting property 16 for the given tile. The time-out is 256 ticks*(prop. 16+1), so 0 means every 3.5 days, 1 means every 7 days, 2 means every 10.5 days and so on.

If trigger 02 is activated, all parts of the building that has this trigger set will get the same random bits, allowing you to randomize a multi-tile building as one unit. On the other hand, if the tiles of a multi-tile building have trigger 1 set, all tiles will be randomized individually. Note that all tiles of a multi-tile building get the same value when building the building.

==Industry tile triggers==

Industry tiles have 8+16 random bits.  Accessed through random action 2 type 80, you get 8 tile-specific bits, and accessed through random action 2 type 83, you get 16 industry-specific bits.  The triggers are the same for both:

||Bit|Value|Trigger

0|01|the building tile is processed in the periodic tile processing loop

1|02|triggers simultaneously for all tiles of the industry every 256 ticks. If the industry is a primary one, output cargo is generated at the same time.

2|04|cargo is delivered to the industry. If the industry is a processing one, output cargo is generated at the same time.||

Trigger 1 works similarly to trigger 1 for houses except that you cannot multiply the timeout: it's always 256 ticks.

==Canals==

Canals / Rivers have 8 random bits.

There is currently no way to influence the random byte creation via triggers, internally the bits are feed from VarAction2Canals var 83 that is set when building a canal. Feature ids not supported by VarAction2Canals are undefined and should never be used.

==Objects==

Objects have around 8 random bits per tile of the object.

There are no triggers for objects however.

Also note that the random bits are unique to each tile in the object, and are not shared across the whole object.

==Rail types==

Rail tiles have 2 pseudo random bits, based on tile location.

There are no triggers.

==Other features==

All features not mentioned in the list above have neither random bits nor triggers, including cities (which would be accessed using random action 2 type 83 for stations and industries).

-=Example=-

Something to go here

VariationalAction2

2011-06-12T19:23:28Z

Orudge: 14 revisions

'''''Variational Action 2'''''

=Variational Action 2=

Defining a choice between several action 2 entries

-=Introduction=-

To support changes in graphics based on other factors than just the load states, you use a variational action 2. This provides a sophisticated way of deciding what graphics to use.

A variational action 2 can be used like any other action 2, but it provides an additional step in-between: instead of defining the action 1 sets right away, it instead specifies a list of additional action 2 entry, one of which is used depending on the kind of variation that is defined. These action 2 entries that are referred can in turn be variational or random (to provide chains of decisions), or they can be the final element, that is a regular action 2 which contains definitions of action 1 sets, or a callback result.

-=Format=-

The data looks as follows:

<pre> -+<Sprite-number> * <Length> 02 <feature> <set-id> <type> <variable> <varadjust> <nvar> (<set-id> <low-range> <high-range>){n} <default>+-</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

<feature>|B|For what type of vehicle/station should this definition be used?

<set-id>|B|The ID of this action 2 (used like a cargo ID)

<type>|B|Type of variational action 2, see below

<variable>|B|Which variable we base the decision on

<varadjust>|V|How to manipulate the value before deciding.

<nvar>|B|Number of different ranges of the value (not counting the default)

<set-id>|W|Action 2 set-id to use for the following range.

<low-range>|B/W/D|Minimum (inclusive) of the range for which to use the above set-id

<high-range>|B/W/D|Maximum (inclusive) of the range

<default>|W|Action 2 set-id to use if no range matches||

You repeat the sequence of <set-id> <low-range> <high-range> as often as <nvar> specifies.

<low-range> and <high-range> have a size of B, W, or D, depending on <type>. See that entry for more information.

-=Filling in the terms=-

===Sprite-number===

This is just the number you are at.

===Length===

Count the number of bytes in this action.

===feature===

This sets the type of feature that you wish to change. Set it to:

00 for trains

01 for road vehicles

02 for ships

03 for planes

04 for stations

05 for canals

06 for bridges

07 for houses

09 for industry tiles

0A for industries

0B for cargos

0E for signals

0F for objects

10 for railtypes

===Set-ID===

This defines the number of this action 2.  The ID can then be used as target in an action 3 or another variational/random action 2.

===type===

The access type specifies both the size of the variable access, and selects between general variables and the object's innate variables, or variables of a specific "related" object.

Use 81/85/89 to decide upon a general variable, or a variable of the object in question.

Use 82/86/8A to refer to the "related" object:

||Feature|Related object

Vehicles (00-03)|First vehicle of consist

Stations (04)|Town to which station belongs

Canals (05)|N/A

Bridges (06)|Town of bridge

Houses (07)|Town of building

Generic (08)|(no action 2 support)

Industry tiles (09)|Industry containing tile

Industries (0A)|Town to which industry belongs

Cargos (0B)|N/A

Sounds (0C)|(no action 2 support)

Airports (0D)|Town of airport

Signals (0E)|N/A

Objects (0F)|Town of object

Railtypes (10)|N/A||

This number also tells what size the checked variable is:

For 81/82, the lowest byte of the value is accessed

For 85/86, the lowest word is accessed

For 89/8A, the lowest doubleword is accessed.

If the accessed variable is smaller than the size given here, the extra bits may contain junk, and should probably be <and-masked> out.

On this page, the size B/W/D means the field is byte-sized for types 81 and 82, word-sized for types 85 and 86, and doubleword-sized for types 89 and 8A.

===Variable===

Which variable to use for this decision. The following variables are always available:

||'''Number'''|[[GRFActionsDetailed|'''Size''']]|'''Meaning'''

00|W|current date (counted as days from 1920)

01|B|current year (count from 1920, max. 2175 even with eternalgame)

02|B/D|current month (0-11) in bits 0-7; the higher bytes contain unusable junk. Since OTTD r13594 'day of month' (0-30) is stored in bits 8-12, bit 15 is set in leapyears and 'day of year'(0-364 resp. 365) is stored in bits 16-24. All other bits are reserved and should be masked.

03|B|current climate, 0=temp, 1=arctic, 2=trop, 3=toyland

09|W|date fraction, incremented by 0x375 every engine tick

0A|W|animation counter, incremented every tick

0C|W|current [[Callbacks|callback]] ID (feature-specific), set to 00 when not in a callback

10|D|extra callback info 1, as described in the callback specs

11|B|current rail tool type (for station callbacks)

12|B|Game mode, 0 in title screen, 1 in game and 2 in editor

18|D|extra callback info 2, as described in the callback specs

1A|D|always -1 (that is, all bits are set). Useful to create constants (see [[VarAction2Advanced]])

1B|B|display options; bit 0=town names, 1=station names, 2=signs, 3=animation, 4=transparency, 5=full detail

1C|D|result from most recent variational action 2

20|B|snow line height, FFh if snow isn't present at all

23|D|current date; long format, since OpenTTD r13376, 2.6 r2049

24|D|current year; long format, year zero based since OpenTTD r13376, 2.6 r2049

25|D|GrfID of the grf that contains the corresponding Action3. Useful when accessing the "related" object. Currently only supported for vehicles (OpenTTD r15739)

40+x|D|specially calculated feature-specific variable, see following feature-specific pages

5F|D|Feature-specific random data: triggers in low byte, bits in other three bytes. Bits of the variable not associated with random or trigger bits are reserved. (2.5 r1927, 2.6 r1928)

60+x|D|similar to 40+x variables, but the variable number must be followed by a byte, which will be given to the variable handler as parameter.

7B|-|A special 60+x variable to be used in Advanced Variational Action 2. It allows to evaluate any other 60+x variable using a non-constant parameter from a register. The parameter of variable 7B specifies another 60+x variable which is evaluated. The parameter for that variable is read from the accumulator ('val1'), i.e. the result from the preceding operations of the same Advanced Variational Action 2. Hence variable 7B may not be the first variable used in the calculation. Variable 7B itself and 7E (procedure call) are not allowed to be used as parameter for variable 7B. Also note that you can pass non-byte parameters to 60+x variable here. While current 60+x variables only use byte parameters, the higher bits of the parameter are considered reserved. So, make sure to mask the higher bits in the preceding calculations. Available since TTDPatch r2359 and OpenTTD r21604.

7C|D|A special 60+x variable that contains persistent data written by [[VarAction2Advanced#operator|operator 10]], for the features that support it. (The list of supported features can be found on that page.) Available since 2.6 r1315. Should not be read if the current feature doesn't support it. If the given slot hasn't been written yet, it contains zero.

7D|D|A special 60+x variable that contains up to 256 values stored by [[VarAction2Advanced#operator|operator 0E]]. Available since 2.6 r1246. Available in the purchase list. These values are undefined unless written by a var2 earlier in the same chain.

7E|D|A special 60+x variable indicating a [[VarAction2Advanced#Using_procedures|procedure call]]. Available in the purchase list.

7F|D|A special 60+x variable that reads GRF parameter whose number is given by the 60+x parameter. Available in the purchase list.

80+x| |feature-specific variable, see following feature-specific pages||

The definition of variable 1B is slightly feature-dependent. For features that can be drawn transparently (stations, bridges, houses, industry tiles and objects) bit 4 is set if the current feature will be drawn normally, and clear if the current feature will be drawn transparently. For these purposes, airports are stations. For all other features, bit 4 is undefined.

For all features, the 80+x variables are offsets into the corresponding structure in TTD's game data.  The 40+x and 60+x variables are special variables that are computed on-the-fly, and aren't actually stored anywhere in memory, unless stated otherwise. Therefore they should be used as little as necessary so as not to slow down the game too much with the calculation of these variables (which can be called thousands of times per second, whenever any vehicle moves).

When displaying a vehicle (etc.) in the purchase list, the game will show those variations based on external variables (dates etc.) correctly, but variations based on vehicle variables (variables 40+x, 60+x and 80+x) will always show the first (not the default) cargo-ID unless otherwise specified for the given variable. If you do a calculation, the first cargo-ID will be selected if any of the needed variables is inaccessible.

The lists of 80+x variables on the following pages are not exhaustive; only the useful variables are listed there. For a full list check the definition of corresponding structures in TTD. Marcin Grzegorczyk has a pretty good list of the structure definitions on his [http://marcin.ttdpatch.net/sv1codec/TTD-locations.html|savegame internals page].

{toc}

===varadjust===

Adjust variable to a more useful range. It has the following format:

<pre> -+ <shift-num> <and-mask> <nowiki><nowiki>[<add-val> <divide-val>/<modulo-val>]</nowiki></nowiki>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

shift-num|B|value to right-shift the variable, and some special bits. See below.

and-mask|B/W/D|value with which to AND the variable after shifting. Return this value if neither bit 6 nor bit 7 of shift-num are set.

add-val|B/W/D|value to add to the variable after ANDing. Only present if bits 6 or 7 are set in shift-num.

divide-val|B/W/D|return the sum divided by this value. Only present if bit 6 is set in shift-num.

modulo-val|B/W/D|return the sum modulo (remainder of division by) this value. Only present if bit 7 is set in shift-num.||

<shift-num> is a partial bit-mask; its bits have the following meanings:

||Bit(s)|value|meaning

0..4|0..1F|number of bits to right shift <variable>

5|20|This is an [[VarAction2Advanced|advanced var.action 2]]

6|40|This is a shift-and-add-divide adjustment.

7|80|This is a shift-and-add-modulo adjustment.||

Bits 6 and 7 may not both be set. If neither are set, this varadjust is a shift-and adjustment.

Note that for the add and divide operations, both the variable and the divisor are taken to be signed numbers. This means that if the high bit is set, the number is taken to be negative, so you may need to mask out the most significant bit to do an unsigned division.

===nvar===

Here you set how many different ranges to check for. If the value of the variable, after the above manipulations, is not within one of these ranges, the default will be used.  When displayed in the purchase window, the game will always show the first range if the variable is of the 40+x or 80+x type (because the variable is undefined since the vehicle doesn't exist yet).

Since 2.0.1 alpha 57, nvar=0 is a special case. Instead of using ranges, nvar=0 means that the result of an [[VarAction2Advanced|advanced]] calculation (or, if no calculation is performed, the adjusted variable value itself) is returned as callback result, with bit 15 set.  This is useful for those callbacks where many different return values are possible and it is easier to calculate them than list them in ranges.  The default value must still be specified, and will be used in case the variable(s) used are not available.

===sets and ranges===

For each of the ranges to check, you give the set-id as a '''WORD''' value (i.e. with a 00 following, e.g. set-id 5 becomes -+05 00+-, or - in case of a callback result - by setting the high bit, e.g. -+05 80+-), followed by the low and high limits of this range.  The first range that matches will be used.

The various \b, \w, and \d escape sequences can be useful for <min-range> and <max-range>. See [[GRFActionsDetailed#Byte_order|the discussion of escape sequences]] for further information.

===default===

The set-id to use if none of the ranges matches.

-=Example=-

Something to go here

VariationalAction2/Vehicles

2011-06-12T19:23:28Z

Orudge: 14 revisions

'''''Variational Action 2 Variables for Vehicles'''''

=Variational Action 2 Variables for Vehicles=

{maketoc}

||Variable|[[GRFActionsDetailed|'''Size''']]|Content|Available in purchase list

40|D|Position in consist and length of consist|no

41|D|Position in and length of chain of consecutive vehicles with same ID|no

42|D|Cargo types transported by consist|no

43|D|Player info|TTDP 2.5 beta 2, OTTD r4611

44|D|Aircraft info|no

45|D|Curvature info|no

46|D|Motion counter|no

47|D|Vehicle cargo info|(b) OTTD r15542

48|D|Vehicle type information|TTDP 2.5 beta 2, OTTD r5338

49 (a)|D|Year of construction (long format, 0 based)|(c) OTTD r13376

4A (d)|D|Info about current rail type for trains|no

60|D|Count Veh.ID occurence|no

97|B|Tick counter, increased every engine tick|no

B4|W|Current speed. Note, units differ for each vehicle type (e).|no

B9|B|Cargo type (type B from the list at [[CargoTypes]]; climate dependent)|no

C0|W|Vehicle age in days (not valid for wagons bought before alpha 61)|no

C4|B|Year built (counted from 1920), note this is modified when Cht: Year is used|(c) OTTD r4611

C6|W|Vehicle type ID (useful for [[Callbacks#Can_wagon_be_attached_1D_|Callback 1D]])|no

C8|B|Sprite type; FD for trains forward, FE or FF when reversed|no

C9|B|Day counter; increased daily|no

DA|W|Next wagon index, FFFF if last wagon (use shift-num=08 and check for FF)|no

F2|B|Refit cycle, how many times refitted to the same cargo type|(b) OTTD r15542

FE|W|Modflags|no

FF|B|Modflags|no||

<nowiki><nowiki>a</nowiki></nowiki> OpenTTD r13376, TTDPatch r2216

<nowiki><nowiki>b</nowiki></nowiki> Variable 47 refers to the default cargo of the vehicle, when in purchase list. This differs from the cargo used in Action 3, which is 0xFF in purchase list. The "refit cycle" (F2) is currently always zero in the purchase list.

<nowiki><nowiki>c</nowiki></nowiki> This is the current date.

<nowiki><nowiki>d</nowiki></nowiki> OpenTTD r20165.

<nowiki><nowiki>e</nowiki></nowiki> See [[Action0Trains#Speed_09_|train property 09]], [[Action0RoadVehicles|road vehicle property 08]] (not 15, even when using realistic acceleration), [[Action0Ships|ship property 0B]] and [[Action0Planes|aircraft property 0C]].

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

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

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

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

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

Format: 00nnbbff

||Variable|Value

ff|position of vehicle within the consist counted from the engine (front), e.g. the engine would have ff=0, the 1st wagon or mail compartment of planes would have ff=1, the 2nd wagon or the rotor of helicopters would have ff=2, the 3rd wagon would have ff=3 etc

bb|same as ff, but counted from the end, i.e. the last wagon has bb=0, the next-to-last wagon has bb=1 etc.

nn|total number of vehicles in the consist minus one (i.e. a train with engine and three wagons has nn=3), including shadow and rotor for aircraft.||

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

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

==Consist cargo (42)==

Format: uuiicctt

||Variable|Value

tt|a bit mask of all [[Action0Cargos#Cargo_classes_16_|cargo classes]] transported by the consist

cc|the most common [[CargoTypes|cargo type]] (from the column for type A)

ii|the most common refit cycle (var. F2) of cargo type cc

uu|the result of ORing the bits of prop. 25 from all vehicles in the train||

Note that even if the grf file has installed a [[Action0GeneralVariables#Cargo+translation+table+%2809%29|cargo translation table]], the value in "cc" is the actual bit number of that cargo. The reason for this is that it cannot be translated in general, because different vehicles can be from different .grf files and have different translation tables. Use variable 47 if you want the translated cargo type.

If used with variational action 2 type 81 (vehicle) it returns only cargo from this vehicle on, with type 82 (engine) that of the whole consist.

==Player info (43)==

Format: Ccttmmnn

||Variable|Value

nn|the number of the current player from 0 to 7 (up to E (14) in OpenTTD since r14735)

mm|the multiplayer player number with the host player (or the single player) being 0 and the client player being 1

tt|the player type, see below for possible values

c|the primary player colour

C|the secondary player colour, equal to c if none (since r1405)||

||tt value|Meaning

0|Player is human player (permanent company)

1|Player is AI player (not managed)

2|Player is a human managing an AI company

3|Player is human player's original company, now temporarily AI controlled||

This variable is available in the purchase list as well (since 2.5 beta 2).

Since r1497, when the vehicle sprite is being displayed in an exclusive offer window or new vehicle news message, or in other circumstances when no player is associated with the vehicle, nn will be FF.

==Aircraft info (44)==

Format: xxxxhhtt

(available from 2.0.1 alpha 48)

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

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

==Curvature info (45)==

Format: xxxTxBxF

(available from 2.0.1 alpha 58)

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

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

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

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

Possible values:

||Decimal|Hex|Meaning

-4|C|180° curve left (T only)

-3|D|135° curve left (T only)

-2|E|90° curve left

-1|F|45° curve left

0|0|no curve

1|1|45° curve right

2|2|90° curve right

3|3|135° curve right (T only)

4|4|180° curve right (T only)||

==Motion counter (46)==

Format: 32-bit value

(available from 2.0.1 alpha 59)

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

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

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

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

==Vehicle cargo info (47)==

Format: ccccwwtt

||Variable|Value

tt|the [[CargoTypes|cargo type]] transported by the vehicle (from the column for type A); translated if a translation table has been installed

ww|cargo unit weight in 1/16 tons, same as [[Action0Cargos#Weight_of_one_unit_of_the_cargo_0F_|cargo prop. 0F]]

cccc|the [[Action0Cargos#Cargo_classes_16_|cargo class]] value of the cargo transported by the vehicle||

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

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

==Vehicle type information (48)==

Format: xxxxxxff

The bits of ff are:

||Bit|Value|Meaning

0|1|Vehicle type is available on the market

1|2|Vehicle type is in the testing phase

2|4|Exclusive testing offer for a human player active||

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

This variable is available in the purchase list as well (since 2.5 beta 2).

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

Format: xxxxFFrr

(available from OpenTTD r20165)

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

The next byte (FF) contains the following flags:

||Bit|Value|Meaning

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

All other bits are undefined.

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

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

Format: xxxxxxnn

(available from 2.0.1 alpha 57)

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

==Modflags (FE and FF)==

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

||Bit|Value of the bit

5|Vehicle is powered (engine or powered wagon, mainly useful for the latter)

6|Vehicle would be powered (engine or powered wagon) if there were suitable track. (E.g. electric train in mixed train on normal track)

8 *|This bit is flipped every time the train reverses direction

10|Vehicle was built during the exclusive preview (since 2.5 r1334)||

<nowiki><nowiki>*</nowiki></nowiki> This bit is only accurate for the first vehicle in the consist.

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

VariationalAction2/Stations

2011-06-12T19:23:28Z

Orudge: 13 revisions

'''''Variational Action 2 Variables for Stations'''''

=Variational Action 2 Variables for Stations=

{maketoc}

||Variable|[[GRFActionsDetailed|'''Size''']]|Content

40|D|Platform info and relative position

41|D|Platform info and relative position for individually built sections

42|D|Terrain and track type

43 *|D|Player info, see [[VarAction2Vehicles#Player_info_43_|vehicle variable 43]]

44|B|Path-based signalling info

45|W|Rail continuation info

46,47|D|Platform info, counted from the middle

48|D|Bitmask of accepted cargos

49|D|Platform info and relative position of same-direction section

4A|B|Current animation frame

60|D|Amount of cargo waiting

61|D|Time since the cargo was last picked up

62|D|Rating of the cargo

63|D|Time spent en-route

64|W|Information about the last vehicle picking this cargo up

65|B|Amount of cargo acceptance

66|D|Animation frame of nearby tile

67|D|Land info of nearby tiles

68|D|Station info of nearby tiles

69|D|Information about cargo accepted in the past

80|B|Number and length of train platforms

F0|B|Bit mask of facilities attached to station (not appropriate for irregular stations)

FA|W|Date when station was built in days since 1920||

<nowiki><nowiki>*</nowiki></nowiki> Available in the purchase list as well (since 2.5 beta 2).

For other 80+x variables confer the [http://marcin.ttdpatch.net/sv1codec/TTD-locations.html#_StationArray|TTD station structure]. Note that you have to subtract 0x10 from the offsets there, or else the facility bit mask and construction date would not be accessible; instead you lose access to variables 00..0F which are meaningless anyway.

'''WARNING''': Please do not use variables 8C..EB directly. The meaning of these variables changes if the newcargos switch is on. Use the variables 60..64 instead (see below). Those always work correctly.

===Platform info (40, 41, 46, 47, 49)===

Variables 40, 41, 46, 47 and 49 all return information about the current tile, which platform it is on and how far along the platform. The difference is in the section of the station that they consider.

||Variables|Regular station|Irregular station

40, 46|Whole station|Counting entire length and all adjacent platforms

41, 47|Individually built sections

49|Whole station|Counting length and platforms that have the same direction||

The term "counting" here refers to starting at the tile in question, and counting tiles in all four directions. The two directions aligned with the station direction will be the length of the station, and the other two directions give the number of platforms. For variables 40 and 46, this counting stops at the edge of the station, i.e. the first non-station tile. For variable 49, it stops either at the edge, or at a station tile that is in the wrong direction.  The resulting information is probably not really useful in the case of irregular stations, with the exception of edge detection. To correctly detect edges, you have the choice of either the station->non-station transition (vars. 40, 46), or additional an opposite-direction transition (var. 49).

Variable 41 is largely unaffected by irregular stations, because it only refers to individually built sections. However, when these individual sections are built over existing tiles, the var. 41 information of surrounding tiles changes as well, due to an internal limitation in how it is stored.

For variables 40, 41 and 49, the position is counted from the northern most edge of the station, and returned in the form xTNLcCpP, where:

||Variable|Meaning

x|undefined, use bit mask to mask it out

T|Tile type: the current tile type; only valid for callback 14

N|Total number of platforms

L|Total platform length

c|Platform number current being drawn, counted from the end (starting at zero)

C|Platform number currently being drawn (starting from zero)

p|Position along this platform counted from the end, zero at the end

P|Position along this platform, zero at the beginning

||

Here, the "beginning" of a station is its northern-most (up on the screen) tile, and the "end" is the southern-most (down on the screen) tile. Each variable consists of 4 bits.

For variables 46 and 47, the position is counted from the middle, i.e. the center tile has C=0 and P=0. For even lengths and numbers of platforms, the middle tile is at position L/2 resp. N/2, e.g. for length 6, it is tile 3, which is the fourth tile. The return format is xTNLxxCP, where T, N and L are as above, and C and P are the positions counted from the middle.

Since C and P can have negative numbers, here's how this is encoded:

||Hex|Binary|Decimal

0|0000|0

1|0001|1

7|0111|7

8|1000|-8

9|1001|-7

E|1110|-2

F|1111|-1||

The counting goes like this, preferring an extra negative number for an even count (because there are 8 negative numbers available but only 7 positive ones):

||Count|Numbers

1|~pp~          0~/pp~

2|~pp~      -1  0~/pp~

3|~pp~      -1  0  1~/pp~

4|~pp~   -2 -1  0  1~/pp~

5|~pp~   -2 -1  0  1  2~/pp~

6|~pp~-3 -2 -1  0  1  2~/pp~||

(etc.)

===Terrain and track type (42)===

Variable 42 is of the format xxxxttTT, where TT is the terrain type and tt is the railway track type.

They can have the following values:

||TT|Meaning

0|normal (grass)

1|desert

2|rainforest

4|on or above snowline||

||tt|Meaning

0|railroad, regular

1|railroad, electrified

2|monorail

3|maglev||

===Path-based signalling info (44)===

This returns the following value in bits 0-2: (bit 2 only available from alpha 47 and up)

||State|Value (binary)|Value (decimal)

Reserved|111|7

Not reserved|100|4

No PBS|010|2||

At the moment, PBS on/off refers to the switch setting, in a future alpha version it will actually refer to whether the switch is on ''and'' the current block actually uses PBS.

The bits are defined this way to allow easy fallback to non-PBS cases. If you need graphics to show the "unreserved" state in non-PBS cases, use bit 0, but if you need the "reserved" state in non-PBS cases, use bit 1. To explicitly check whether PBS is active or not, use bit 2.

All other bits are reserved and must be masked out.

===Rail continuation info (45)===

This variable returns 16 bits of info whether the rail tracks continue in the eight tiles adjacent to the station tile.

||Bit|Value|Set if rail continues in direction of...

0|01|+Length

1|02|-Length

2|04|+Platforms

3|08|-Platforms

4|10|+Length, +Platforms

5|20|-Length, +Platforms

6|40|+Length, -Platforms

7|80|-Length, -Platforms||

The following picture illustrates which bits represent which tile for the two possible station orientations:

{picture file=img/wiki_up//directions.png}

Bits 0 to 3 are set if there is track on the given tile, and it has a connection to the station tile. For bits 2, 3, the station of course has itself no connection to those tiles, but this doesn't matter for this variable. Bits 4 to 7 check connections to the neighbouring platform tile, i.e. bits 4 and 5 resp. 6 and 7 indicate a connection from that tile to tile 2 resp. 3. (This has changed again with 2.5 beta 4 r325.)

Bits 8..15 repeat the above, but are set if there are any train tracks on the tile and disregard whether the track is connected to the station or not entirely.

===Bitmask of accepted cargos (48)===

(This variable is available from 2.0.1 alpha 55 vcs 3 only)

Returns a doubleword where the '''n'''th bit is set if and only if the station accepts the cargo whose climate-dependent ID is '''n'''. If newcargos is off, bits 12..31 are guaranteed to be zero. If you need to check acceptance for a climate-independent ID, you can use variable 65 instead.

'''NOTE''':Variables 60..64 are available from 2.0.1 alpha 55 vcs 3 only!

===Amount of cargo waiting (60)===

The parameter is a cargo number (see note below). Currently, the returned value is between 0 and 32767, but this may later change to support the range -32768..32767.

===Time since the cargo was last picked up (61)===

The parameter is a cargo number (see note below). The unit is 185 ticks (approx. 2.5 TTD days). If the given type has never been seen on the station, the returned value is zero, otherwise, the return value isn't larger than 255.

===Rating of the cargo (62)===

The parameter is a cargo number (see note below). The returned value is between 0 and 255 (255 means 100% rating), or FFFFFFFFh if the cargo is unrated.

===Time spent en-route (63)===

The parameter is a cargo number (see note below). Returns the time elapsed since the cargo appeared on a station. If the cargo has never been seen on the station, the returned value is 0, otherwise it's between 0 and 255. The unit is 185 ticks (approx. 2.5 TTD days).

===Information about the last vehicle picking this cargo up (64)===

The parameter is a cargo number (see note below). Bits 0..7 contain the speed of the last vehicle, while bits 8..15 contain the age of the last vehicle in years. If no vehicle has attempted to pick up this cargo yet, the result is FF00h.

===Amount of cargo acceptance (65)===

(From TTDPatch 2.5 beta 2)

The parameter is a cargo number (see note below). The return value contains the acceptance of the given cargo type in 1/8 units. The station accepts the cargo if its acceptance is at least 8/8 units. Without newcargos, the returned value is between 0 and 15 (inclusive). With newcargos enabled, the return value is either 8 or 0.

'''NOTE''': In GRF version 6, parametrized variables 60..65 accept a climate-dependent cargo number. In GRF version 7 and later, these variables accept a climate-independent cargo ID. If your GRF has a cargo translation table, then this ID is the index in that table; otherwise, it's the cargo bit.

===Animation frame of nearby tile (66)===

(From TTDPatch 2.5 beta 5)

The parameter defines the offset relative to the current tile. Both nibbles are considered signed (that is, 8h=-8, 9h=-7, ...., Fh=-1, 0h=0, 1h=1, ..., 7h=7). The high nibble contains the amount to move sideways (between platforms), the low one is the amount to move along the platform. Negative offsets move northwards, positive ones southwards. If the selected tile is a rail station tile that belongs to the current station, its animation state is returned. Otherwise, FFFFFFFFh is returned.

===Land info of nearby tiles (67)===

This variable works like [[VarAction2IndustryTiles#Land_info_of_nearby_tiles_60_|industry tile variable 60]], except for three things:
* The offsets in the parameter are interpreted relatively to the alignment of the station, the same way as for variable 66
* The '''ss''' part is "mirrored" (bit 0 and 2 swapped) for the NW-SE orientation; this will allow you to handle analogous slopes of the two orientations without checking the orientation explicitly (since TTDPatch 2.6 r1693)
* Bit 0 of the '''bb''' part is undefined

===Station info of nearby tiles (68)===

The parameter of this variable works the same way as the parameter of variable 66. The returned value is FFFFFFFFh if the selected tile isn't a railway station tile. Otherwise, the returned value can be separated to the following parts:

||Bits|Meaning

0..7|If the tile is defined in the current GRF, this is the setID used in the definition. Otherwise, the content is undefined.

8..9|~pp~0 - the tile uses original TTD graphics

1 - the tile is defined in the current GRF

2 - the tile is defined in another GRF~/pp~

10|set if the selected tile belongs to the current station, clear otherwise

11|clear if the selected tile is parallel with the current one, set if perpendicular to it

12..13|~pp~0 - plain platform

1 - platform with building

2 - platform with roof, left side

3 - platform with roof, right side~/pp~

14..31|Undefined, reserved for future use||

===Information about cargo accepted in the past (69)===

The parameter of this variable has the same format as for variables 60..65. The returned value looks like this:

||Bits|Meaning

0|Set if the given cargo was ever accepted at this station

1|Set if the given cargo was accepted last month

2|Set if the given cargo was accepted this month

3|Set if the given cargo was accepted since last periodic processing (which happens every 250 ticks)

4..31|Undefined, reserved for future use||

The information required for this variable is stored in the station2 structure, and therefore works only if the station2 structure is present. The station2 structure is present if any of the following is true:
* Generalfixes is on, and miscmods.noextendstationrange is off
* Any of fifoloading, newcargos or irregularstations is on

If the station2 structure isn't present, the returned value is always zero.

VariationalAction2/Railtypes

2011-06-12T19:23:27Z

Orudge: 3 revisions

'''''Variational Action 2 for Railtypes'''''

=Variational Action 2 for Railtypes=

available in OpenTTD r19056

||Variable|[[GRFActionsDetailed|'''Size''']]|Content

40|B|Terrain type: 0 normal, 1 desert, 2 rainforest, 4 on or above snowline.

41|B|Enhanced tunnels; entrance has track above. Always 0 in OpenTTD.

42|B|Level crossing status: 0 if open (or not a crossing), 1 if closed.

43|D|Depot construction date (long format, 0 based); other: current date||

== Terrain type (40)==

Format: byte

||value|Meaning

0|normal tile

1|desert tile

2|rain forest tile

4|tile on or above snow line||

==Enhanced tunnels (41)==

Format: byte

This variable will always return 0 and is reserved for future use with enhanced tunnels.

==Level crossing status (42)==

Format: byte

This variable returns 1, if a crossing is closed. If the crossing is open or the tile is no level crossing, the return value is 0.

VariationalAction2/Objects

2011-06-12T19:23:27Z

Orudge: 14 revisions

'''''Variational Action 2 Variables for Objects'''''

=Variational Action 2 Variables for Objects=

||Variable|Size|Content

40|D|Relative position, like [[VarAction2IndustryTiles|Industry Tile var43]]

41|W|Tile information, see below

42|D|Construction date from year 0

43|B|Animation counter, see below

44|B|Object founder information

45|D|Get town zone and Manhattan distance of closest town

46|D|Get square of Euclidian distance of closest town

47|B|Object colour

48|B|Object views

60|W|Get object type at offset

61|B|Get random bits at offset

62|D|Land info of nearby tiles

63|W|Animation counter of nearby tile

64|D|Count of object, distance of closest instance||

==Tile information (41)==

The return value has the format of ss0t where t is the terrain type which the tile is on, same values as [[VarAction2Canals|canal var81]].

As of TTDPatch r2088, ss contains the slope data of the tile, same format as for [[VarAction2IndustryTiles| industrytile var60]]. The meaning of the individual bits is:

||Bit|Meaning

0|West corner is above the lowest

1|South corner is above the lowest

2|East corner is above the lowest

3|North corner is above the lowest

4|The tile is a steep slope (*)||

(*) - Steep slopes have this bit plus 3 points raised, giving them values of 0x17, 0x1B, 0x1D and 0x1E.

==Animation Counter (43)==

This byte gets the actual value of the animation counter (note that action0, property 10, bit 6 must be set for this to work).

==Object founder information (44)==

This byte contains the ID of the company that funded the object, or 10h if the object was placed in the scenario editor.

==Get town zone and Manhattan distance of closest town (45)==

Like [[VarAction2Industries#Get_town_zone_and_Manhattan_distance_of_closest_town_65_|industry var65]] but instead of an offset the current tile is used.

==Get square of Euclidian distance of closest town (46)==

Like [[VarAction2Industries#Get_square_of_Euclidean_distance_of_closest_town_66_|industry var66]] but instead of an offset the current tile is used.

==Object colour (47)==

This byte returns the colour of the object.

(since TTDPatch r2351 and OpenTTD r21259)

==Get object views (48)==

Returned value stands for a particular view of an object. Number and rank of set-IDs must match the value given in the object's action0 prop17, i.e. for an object with 4 views, prop48 may return values 0 .. 4. Since OpenTTD r21455.

==Get object type at offset (60)==

The parameter of this variable is an offset from the current tile. The low nibble contains the signed X offset (that is 0h=0, 1h=+1 ... 7h=+7, 8h=-8, 9h=-7 ... Fh=-1), the high nibble contains the Y offset. Therefore the parameter 00h accesses the current tile itself. The high word of the return value is currently reserved, and the low word can be:

   * 00xxh if the tile is an object tile and was defined in the current GRF with ID xx.

   * FFFEh if the tile is an object tile that was defined in another GRF file or it's a default object.

   * FFFFh if the tile isn't an object tile.

==Get random bits at offset (61)==

Returns the same values as [[VarAction2Industries#Get_random_tile_bits_at_offset_61_|industry var61]]. The offset it from the current tile and is signed.

To get the random bits from a tile using a offset relative to the north tile of the object, see the example below.

==Land info of nearby tiles (62)==

Returns the same values as [[VarAction2IndustryTiles#Land_info_of_nearby_tiles_60_|industry tile var60]]. The offset it from the current tile and is signed.

To get the land ifno from a tile using a offset relative to the north tile of the object, see the example below.

==Animation counter of nearby tile (63)==

Returns the var 43 of another tile given by the signed offset.

To get the animation counter from a tile using a offset relative to the north tile of the object, see the example below.

==Count of object, distance of closest instance (64)==

Returns the same values as [[VarAction2Industries#Count_of_industry_distance_of_closest_instance_67_68_|industry var67]]. The distance is from the current tile.

-=Example=-

The following code uses variable 40, 61 and 7B to read the random bits of the north tile of the object.

<pre>~pp~

-1 * -1   02 0F xx 81

            40    30 FF   // Get relative position of object tile as yx

     \\2</pre>    1A    20 77   // Negate the numbers in bits 0..3 and 4..7 ...

     \\2+    1A    20 11   // ... (here we can optionally insert another (positive) offset, to get some other tile relative to the north tile)

     \\2<pre>    1A    20 88   // ... (we need to split the xor in two parts, so bits 0..3 do not influence bits 4..7)

     \\2rst  7B 61 00 FF   // Get the random bits at the northern tile

            ...  ~/pp~</pre>

VariationalAction2/Signals

2011-06-12T19:22:45Z

Orudge: 4 revisions

'''''Variational Action 2 Variables for New Signals'''''

=Variational Action 2 Variables for New Signals=

This is available from 2.6 alpha 0 r1247 onwards.

This type of variational action 2 requires the use of advanced calculations: [[VarAction2Advanced]]

=Inputs:=

===Variable 10:===

||Bit|Meaning

0|Green

1-3|Front facing: 0=SW, 1=NE, 2=NW, 3=SE, 4=E, 5=W, 6=S, 7=N

4-5|Presignals: 0=norm, 1=entrance, 2=exit, 3=combo

6|Semaphore

7|PBS

8|Restricted

9|Programmed

10|Through

11|Inverted||

Note: that these are the same bits as would be used to order action5 block type 4.

===Variable 18===

||Bit|Meaning

0-7|~pp~L5 of signal tile

  0: track in X

  1: track in Y

  2: track in N

  3: track in S

  4: track in W

  5: track in E~/pp~

8-15|Low half of L3 of tile, bits 4-7 bitmask of which signals present as shown below, bits 0-3: track type

16-23|~pp~Which signal is currently being drawn, bit index of L3 signal mask:

  * For track in the X direction:

      6:  signal in the SW direction

      7:  signal in the NE direction

  * For track in the Y direction:

      6:  signal in the NW direction

      7:  signal in the SE direction

  * For tracks in the W-E direction:

      4:  signal in the W direction on the track in the S corner

      5:  signal in the E direction on the track in the S corner

      6:  signal in the W direction on the track in the N corner

      7:  signal in the E direction on the track in the N corner

  * For tracks in the N-S direction:

      4:  signal in the S direction on the track in the E corner

      5:  signal in the N direction on the track in the E corner

      6:  signal in the S direction on the track in the W corner

      7:  signal in the N direction on the track in the W corner~/pp~

24-27|Land/Fence type

28-31|Terrain type: 0=normal, 1=desert, 2=rainforest, 4=snow||

===Parameterised var 60===

Parameter is two signed nybble offsets to add to coordinates of tile.

The low nybble is added to the X coordinate (top-right to bottom-left).

The high nybble is added to the Y coordinate (top-left to bottom-right).

The information is retrieved from the tile after the coordinates have been adjusted, starting from the tile which is currently being drawn.

||Bit|Meaning

0-7|L5

8-15|L3 low

16-20|Altitude of tile<<3

21-25|Slope map of tile

26|Tile has same owner

27|Semaphores

28|Tile has same track bits

29|Tile has same slope and altitude

30|Tile has signals

31|Tile is a track tile||

Return value cached in varaction2var 10

=Output=

===Callback return value:===

||Bit|Meaning

0|Use new sprites

1-4|Num sprites, varaction2vars 0x20-2F

5|Use recolour sprite specified in varaction2var 0x30

6|Use ordinary signal sprite number: varaction2var 0x20, (this overrides all other bits)||

===Varaction2var 20-2F value===

||Bit|Meaning

0-12|Sprite offset into action5 block 0E.

13|Add sprite yrel to Y correction for next sprite (sub from 3D Z), (yrel must fit in a signed byte)

14-18|Sprite Y (-3D Z) correction for next sprite, (signed), (added to total)~010~Overall change to 3D Z, (-Y correction), must be positive, else risk of TTD crashing

19-23|Sprite Y (-3D Z) correction for this sprite only, (signed), (not added to total)

24-27|Sprite X correction for next sprite << 1, (signed), (added to total)

28-31|Sprite X correction for this sprite only << 1, (signed), (not added to total)||

---

A generic action 3 feature 0E should be used to reference the action 2.

Callback 0x146 will call this action 3 when a signal is drawn.

Should the GRF not support the type of signal indicated in variable 10, an invalid callback result should be returned. Returning 0 will prevent further new signal GRF files from being queried and will cause the default signal graphics to be used. Returning 0 should only be done to explicitly prevent lower priority new signals GRFs from possibly drawing the signal.

The result to the callback should be returned as a calculation result.

Bits 1-4 of the callback result indicate how many varaction2vars starting from 0x20 will be used to specify sprites, to be drawn. Operator 0E should be used to store the appropriate values in vars 0x20-2F and 30 as appropriate.

Recolour sprites, specifed in varaction2var 0x30 and bit 5 of the callback result are applied for all of the sprites to be drawn.

---

===Example===

[http://tt-forums.net/viewtopic.php?p=529007#529007|Example GRF with NFO, PCX components.]

VariationalAction2/Industry Tiles

2011-06-12T19:22:45Z

Orudge: 14 revisions

'''''Variational Action 2 Variables for Industry and Airport Tiles'''''

=Variational Action 2 Variables for Industry and Airport Tiles=

VarAction2 for airport tiles is only available in OpenTTD r19204 or later

||Variable|[[GRFActionsDetailed|'''Size''']]|Content

40|B|Construction state of the tile: a value between 0 and 3 (only defined for industries)

41|B|Ground type, the same as variable 81 for [[VarAction2Canals|canals]]

42|B|Current town zone of the tile in the nearest town

43|D|Relative position

44|B|Animation frame. Like [[VarAction2Houses#Current_animation_frame_46_|house variable 46]] but can contain anything 0..FF.

60|D|Land info of nearby tiles

61|D|Animation stage of nearby tiles

62|D|Get industry or airport tile ID at offset||

No 80+x variables are available (nor will they ever be). Try to access one will crash TTD.

===Town zone (42)===

Town zone where the building is situated (which is not necessarily the founder of the town). Zero if the tile isn't in a town. This is mostly useful for banks and other urban industries.

===Relative position (43)===

This is the position of the tile relative to the northernmost tile of the industry or airport.

Format: 00yxYYXX

||Variable|Content

x|the x offset from the northernmost tile

XX|same, but stored in a byte instead of a nibble

y|the y offset from the northernmost tile

YY|same, but stored in a byte instead of a nibble||

Because of the fact that y and x are nibbles, they may contain incorrect values if your industry exceeds 16 tiles in either direction. This variable can be used to spare industry or airport tile IDs: the same tile type can choose different representation depending on where exactly it is inside the industry.

===Land info of nearby tiles (60)===

The parameter of this variable is an offset from the position of the current tile. The low nibble contains the signed X offset (that is 0h=0, 1h=+1 ... 7h=+7, 8h=-8, 9h=-7 ... Fh=-1), the high nibble contains the Y offset. Therefore the parameter 00h accesses the current tile itself. The returned doubleword is in the format rczzbbss, where the meaning of the letters is:
* '''r''' is reserved for future use
* '''c''' contains the [http://marcin.ttdpatch.net/sv1codec/TTD-locations.html#Landscape|landscape class] of the tile. (only from alpha 72 and above)
* '''zz''' is the height of the lowest corner of the tile. Always a multiple of 8
* '''bb''' is a bit field, the meaning of the individual bits are: ||Bit|Value|Meaning

0|1|The tile is an industry tile, and belongs to the same industry as the current one

1|2|The tile has water on it. This flag is set for coasts as well. If you need a full water tile, check the slope data as well. If it's zero (flat tile), the tile is fully watered.

2..4| |(From alpha 70) 0 - normal tile; 1 - desert; 2 - rainforest; 4 - snowy tile

other bits| |reserved for future use||
* '''ss''' contains the slope data of the tile. The meaning of the individual bits is: ||Bit|Value|Meaning

0|1|West corner is above the lowest

1|2|South corner is above the lowest

2|4|East corner is above the lowest

3|8|North corner is above the lowest

4|16|The tile is a steep slope (i.e. the corner opposite to the lowest one is two units higher)

other bits| |always zero||

The resulting, possible values for this byte are illustrated in this image (from OpenTTD docs):

It is sometimes more useful to know the height of the highest corner of the tile. This can be computed with "zz/8 +

VariationalAction2/Industries

2011-06-12T19:22:45Z

Orudge: 12 revisions

'''''Variational Action 2 Variables for Industries'''''

=Variational Action 2 Variables for Industries=

{maketoc}

||Variable|Content

40..42|Waiting cargo

43|Manhattan distance of closest dry/land tile

44|Layout number (1-based)

45|Player info

46|Date when industry was built in days since year 0

60|Get industry tile ID at offset

61|Get random tile bits at offset

62|Land info of nearby tiles

63|Animation stage of nearby tiles

64|Distance of nearest industry with given type

65|Get town zone and Manhattan distance of closest town

66|Get square of Euclidean distance of closest town

67|Count of industry, distance of closest instance

68|Like the above, but with layout filter

A7|Industry founder information

B0|Date when industry was built in days since 1920

B3|Construction type

B4|Date when cargo was last accepted in days since 1920, or 0 if no cargo was ever accepted (available since 2.6 r1321)||

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

===Waiting cargo (40..42)===

If bit 1 or 2 is set in property 21, these variables contain the amount of incoming cargo waiting to be processed. (40 gives the amount of the first type waiting, 41 gives the same for the second type etc.) These variables are capped at FFFFh (65535).

===Manhattan distance of closest dry/land tile (43)===

(from r1298)

This variable works the same way as var. 8B does during callback 28: if your industry is built on water, it gives the distance of the closest dry land tile, otherwise it gives the distance of the closest water tile. However, you can't use this variable during callback 28; you must always use 8B.

'''PLEASE NOTE''': This variable is rather expensive to compute because, in the worst case, it has to check all tiles on the map before it gives up looking for a good tile. Try to avoid it in frequent callbacks such as the production callback, animation callbacks (unless the animation is slow, around 1 frame per game day or slower). It is, however, OK to use it during the production change callbacks.

===Layout number (44)===

If the industry was created running TTDPatch 2.6 r1594 or later, this variable returns the number of the current layout. The first layout will return 01, the second 02, etc. In other words, this is one larger than what you get in variable 86 during callback 28.

If the industry was created using an earlier version of TTDPatch, or while newindustries was off, the result will be zero.

===Player info (45)===

(From 2.6 r1711)

As [[VarAction2Vehicles#Player_info_43_|vehicle variable 43]], except that the no-player state is indicated by var A7 being 10h.

===Date when industry was built in days since year 0 (46)===

(From OpenTTD r13443, 2.6 r2047)

Exact same behaviour as var B0, but based on year 0, instead of year 1920

In TTDPatch, industry age is limited to 65535 days (approximately 180 years) -- build date is never more than 65535 days ago.

===Get industry tile ID at offset (60)===

(from TTDPatch 2.0.1 alpha 73 and above only)

The parameter of this variable is an offset from the northernmost tile of the industry: the high nibble contains the Y offset, the low one the X offset; both are unsigned. The high word of the return value is currently reserved, and the low word can be:
* 00xxh if the tile is an industry tile and was defined in the current GRF with ID xx.
* FFxxh if the tile is an industry tile of an old type, and has the ID xx.
* FFFEh if the tile is an industry tile that was defined in another GRF file
* FFFFh if the tile isn't an industry tile, or doesn't belong to the current industry

===Get random tile bits at offset (61)===

(from TTDPatch 2.0.1 alpha 73 and above only)

The parameter of this variable is an offset from the northernmost tile of the industry: the high nibble contains the Y offset, the low one the X offset; both are unsigned. If there's an industry tile on that offset and it belongs to the current industry, the lowest byte of the return value will contain the random bits of that tile. Otherwise, the lowest byte will be zero.

The other bytes are reserved for future use.

===Land info of nearby tiles (62)===

(from TTDPatch 2.0.1 alpha 74 and above only)

The parameter of this variable is an offset from the northernmost tile of the industry: the high nibble contains the Y offset, the low one the X offset; both are unsigned. This variable returns the same values as [[VarAction2IndustryTiles#Land_info_of_nearby_tiles_60_|industry tile variable 60]], in the same format, except that bit 0 in the '''bb''' part is undefined. The offset should be given relatively to the north corner of the industry.

===Animation stage of nearby tiles (63)===

The parameter of this variable is an offset from the northernmost tile of the industry: the high nibble contains the Y offset, the low one the X offset; both are unsigned. This variable returns the same values as [[VarAction2IndustryTiles#Animation_stage_for_nearby_tiles_61_|industry tile variable 61]], in the same format. The offset should be given relatively to the north corner of the industry.

===Distance of nearest industry with given type (64)===

The format of the parameter is the same as for industry property 16: either the ID of a new type with bit 7 set, or the ID of an old type. The returned value is FFFFFFFFh if there are no industries with the given type (not counting the current one, if it has the given type); otherwise, the returned value is the Manhattan distance of the closest industry with the given type.

===Get town zone and Manhattan distance of closest town (65)===

The parameter gives an offset from the northernmost tile of the industry: the high nibble means the Y offset, the low nibble means the X offset, both signed. The returned value is rrzzdddd, where rr is reserved for future use, zz is the town zone of the selected tile, while dddd is the Manhattan distance of the closest town.

===Get square of Euclidean distance of closest town (66)===

The parameter works like for var. 65, but the result is the Euclidean distance of the closest town, squared.

===Count of industry, distance of closest instance (67, 68)===

Variable 67 gets two parameters: the GRFID of the GRF where the industry is defined in register 100h (can be written using operator 0E of [[VarAction2Advanced|variational action 2]]) and the setID of the industry as the regular parameter. There are two special cases for the GRFID: 00000000h means you're checking for a default TTD industry type, while FFFFFFFFh can be used instead of the GRFID of the current GRF.

The return value has the format rrccdddd, where rr is reserved for future use, cc is the number of instances of the industry type and dddd is the Manhattan distance of the closest instance, of FFFFh if not appliable.

You may note that this variable can be used instead of variable 64. This variable is the preferred way to get this information since it allows you to check industries defined in other GRFs as well. Variable 64 will stay for backward compatibility only.

Variable 68 works like variable 67, except that you can put a layout number in the lowest byte of register 101. (The other bits are reserved for future use, leave them zero for now.) This layout number should be 1-based (the first layout is 01, not 00). Only industries with the given layout are considered for counting and calculating distance. As a special case, if the layout number is 00, all layouts are counted, and so the result is the same as with variable 67.

Since OpenTTD r22434, it is possible to filter by the town of the current industry. If the bit number 8 is set, only industries in the same town than the current one will be considered.

===Industry founder information (A7)===

Since TTDPatch 2.0.1 alpha 74, this byte contains the ID of the company that funded the industry, or 10h if the industry was generated randomly. If the industry was built using an earlier TTDPatch version or with newindustries turned off, this field is 10h.

===Construction type (B3)===

This byte tells you how the industry got onto the map. The following values are possible:

||Value|Meaning

0|Unknown - This industry was built with newindustries being off, or in a TTDPatch version prior to 2.0.1 alpha 74

1|Created during normal gameplay, either by a player or the in-game random industry generator

2|Created during random map generation

3|Created in the scenario editor||

In case 1, you can check variable A7 to find out whether the industry was funded by a player or by the random generator.

VariationalAction2/Houses

2011-06-12T19:22:45Z

Orudge: 13 revisions

'''''Variational Action 2 Variables for Houses'''''

=Variational Action 2 Variables for Houses=

{maketoc}

||Variable|Version*|[[GRFActionsDetailed|'''Size''']]|Content

40| |B|Construction stage and pseudo-random values

41| |B|Age of the building in years (or, strictly speaking, the difference between the current year and the year the building was built). Returns 255 for buildings older than 255 years.

42|2.0.1a43|B|Town zone where the building is situated.

43| |B|Terrain type: 0 normal, 1 desert, 2 rainforest, 4 on or above snowline

44|2.0.1a43|D|Building counts

45|2.0.1a38|B|Town expansion bits

46|2.0.1a67|B|Current animation frame

47|2.6r2020 / r14294|D|XY Coordinate of the building

60|2.0.1a56|D|Other building counts

61|2.0.1a56|D|Other building counts

62|2.0.1a72|D|Land info for nearby tiles

63|2.6r1665|B|Current animation frame of nearby house tiles

64|2.6r1672|B|Cargo acceptance history of nearby stations

65|2.6r2242 / r13603|B|Distance of nearest house matching a given criterion

66|2.6r2246|D|Class and ID of nearby house tile

67|2.6r2246|D|GRFID of nearby house tile

80+x|None defined, and none ever will because town buildings don't have an internal structure. Trying to access these variables crashes TTD.||

<nowiki><nowiki>*</nowiki></nowiki> Specified version is earliest known to support the variable in its current form. Some variables may have been available earlier.

===Construction stage and pseudo-random values (40)===

||Bits|Meaning

0..1|Construction state: 0..2: various states of construction, 3: construction finished

2..3|A pseudo-random value. It isn't actually random, but is derived from the position of the building. Old buildings use this value to randomize their colors. TTDPatch has a better way to randomize things, but you can still use that value to mimic unpatched TTD behaviour. Note that adjacent tiles aren't guaranteed to have the same pseudo-random bits||

===Town zone (42)===

Town zone where the building is situated. The value is between 0 and 4, where 0 is the outermost zone of the town. Smaller towns have fewer zones. Roads are plain in zone 0 and 1, paved in zone 2, have trees in zone 3 and streetlights in zone 4

===Building counts (44)===

Returns dword LLllCCcc, where cc means how many buildings of the current type can be found in the current town, while CC is the same for the whole map. ll and LL are similar to cc and CC, but contain the number of tiles that have the same class as the current one. For tiles that have no class, ll and LL are always zero. Overridden old types are considered to be the new type they were overridden with. During callback 17, the current building isn't on the map yet, and therefore isn't counted. In other cases, the building count is at least one, since the current building is counted as well.

===Town expansion bits (45)===

||Bit|Value|Meaning

0|1|Set if TTD is currently creating a random town, clear otherwise. PLEASE NOTE: while TTD is generating a random town, town variables 82 (town population) and B6 (number of buildings) are incorrect. The population counter contains the population of buildings generated _yet_, which means the final value may be larger than you get. The building count variable, on the other hand, is surely higher than the final value will be. If you want to check these variables during callback 17, you may need to check variable 45 as well and make adjustments if this bit is set.||

Other bits are currently reserved for future use.

===Current animation frame (46)===

The current animation frame being displayed. If you don't use animation callbacks, it's between zero and the value set in property 1A. Animation callbacks can set this to anything between 0 and 127.

Enabling animation on a house tile by setting properties 9, 1A and probably 1B ensures that property 46 will indeed change with time, and the building is redrawn every time property 46 changes. This means that you can use a variational action 2 to choose the current frame according to property 46. Please note that this kind of animation needs more CPU time and more sprites, so you should prefer palette animation if possible.

===XY Coordinate of the building (47)===

The coordinate of the tile this part of the building is located.  If the building is not yet constructed, like during callback 17, the returned value will be the proposed location.  The format of the var is YYYYXXXX.

===Other building counts (60, 61)===

For variable 60, the parameter is an old house type number. For variable 61, it is a new house type number defined in the current GRF file.

These variables work like variable 44, but they count the given house type instead of the current one.

Please note that, unlike random graphics, changes of deterministic building graphics don't automatically redraw the building (except when either the construction state or property 46 changes), resulting in temporary graphics glitches when a visible building changes its graphics. These glitches can be fixed by scrolling the building out of view, then back again.

===Land info for nearby tiles (62)===

This variable works exactly like [[VarAction2IndustryTiles#Land_info_of_nearby_tiles_60_|var. 60 for industry tiles]], except that bit 0 of the '''bb''' part is undefined.

===Current animation frame of nearby house tiles (63)===

The parameter of this variable is an offset from the position of the current tile. The low nibble contains the signed X offset (that is 0h=0, 1h=+1 ... 7h=+7, 8h=-8, 9h=-7 ... Fh=-1), the high nibble contains the Y offset. Although you can query a 16x16 area with these parameters, it's currently useless to use offsets other than -1, 0 and +1; if you query a tile that doesn't belong to the same building as the current tile, the result is meaningless. It may even be junk if the queried tile isn't a house tile at all.

===Cargo acceptance history of nearby stations (64)===

The parameter of this variable is a cargo identifier. If your GRF is version 7 or later and has a cargo translation table, this is an index to that table; otherwise, it's a cargo slot number. Additionally, GRF register 100h should contain an offset relative to the current tile (use 0 for the current tile). The returned value looks like this:

||Bit number|Meaning

0|This cargo was accepted in a nearby station some time in the past

1|This cargo was accepted in a nearby station last month

2|This cargo was accepted in a nearby station this month

3|This cargo was accepted in a nearby station since the last periodic processing (which happens every 250 ticks)

4|This cargo is one of the types that triggered callback 148 (only during callback 148)

other bits|undefined; reserved for future use||

A station is considered nearby if the selected tile is inside its acceptance area. That's why you can give an offset - other tiles of your multi-tile building may have different stations "nearby".

The information required for this variable is stored in the station2 structure, and therefore works only if the station2 structure is present. The station2 structure is present if any of the following is true:
* Generalfixes is on, and miscmods.noextendstationrange is off
* Any of fifoloading, newcargos or irregularstations is on

If the station2 structure isn't present, the returned value is always zero.

===Distance of nearest house matching a given criterion (65)===

This will perform a circular search around the current tile, trying to find another house tile that will match the same type, class or grfID. (Note: other tiles of the originating house will not match.)  Search result will be the [http://en.wikipedia.org/wiki/Taxicab_geometry|Manhattan distance] between both tiles or 0, if no house tile matching the given criteria has been found.

The parameter of this variable is composed of two parts:

Bits 0..5 indicate the radius of the search going to be performed (given in Manhattan metric). Maximum search radius is 63 while the minimum is 1. A radius of 0 is considered reserved - do not use.

Bits 6..7 indicate the type of search to be carried out:

0 : Search by house type as defined in the grf file

1 : Search by building class

2 : Search by grfID

Just like other search variables, be aware that this is a CPU intensive one

===Class and ID of nearby house tile (66)===

The parameter of this variable is an offset from the position of the current tile. The low nibble contains the signed X offset (that is 0h=0, 1h=+1 ... 7h=+7, 8h=-8, 9h=-7 ... Fh=-1), the high nibble contains the Y offset. The returned value is structured like this:

||High word|Information about house class

|'''FFFFh''' if the selected tile isn't a house tile

|'''0000h''' if the selected house doesn't have a class specified (including old houses, which cannot have a class)

|'''01XXh''' if the selected house has been defined in the current GRF with class XX

|'''02XXh''' if the selected house has been defined in a different GRF with class XX

Low word|Information about house ID

|'''FFFFh''' if the selected tile isn't a house tile

|'''00XXh''' if the selected house is old house type XX

|'''01XXh''' if the selected house has been defined in the current GRF with ID XX

|'''02XXh''' if the selected house has been defined in a different GRF with ID XX||

In case the selected house comes from another GRF, you need to use variable 67 (see below) to find out the corresponding GRFID and identify the exact type of the house. Please note that variable 67 is cheaper to calculate than this one, so if you are looking for a specific GRFID/houseID combination, you should try matching the GRFID first, and get variable 66 only if the GRFID matches.

===GRFID of nearby house tile (67)===

The parameter of this variable is an offset from the position of the current tile. The low nibble contains the signed X offset (that is 0h=0, 1h=+1 ... 7h=+7, 8h=-8, 9h=-7 ... Fh=-1), the high nibble contains the Y offset. The returned value is one of the following:
* '''FFFFFFFFh''' if the selected tile isn't a house tile
* '''00000000h''' if the selected house is an old house type
* otherwise, the GRFID of the GRF which defined the type of the selected house

VariationalAction2/Towns

2011-06-12T19:22:45Z

Orudge: 7 revisions

'''''Variational Action 2 Variables for Cities'''''

=Variational Action 2 Variables for Cities=

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

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

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

==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)

VariationalAction2/Cargos

2011-06-12T19:22:45Z

Orudge: 4 revisions

'''''Variational Action 2 Variables for cargos'''''

=Variational Action 2 Variables for cargos=

Currently, cargos don't have 40+x, 60+x, or 80+x variables, but they might be added later.

VariationalAction2/Canals

2011-06-12T19:22:44Z

Orudge: 4 revisions

'''''Variational Action 2 Variables for Canals'''''

=Variational Action 2 Variables for Canals=

||'''Variable'''|'''Version'''|[[GRFActionsDetailed|'''Size''']]|'''Content'''

80| |B|Height above ground, top parts of locks have the same height as the lower parts.

81| |B|Terrain type: 0 normal, 1 desert, 2 rainforest, 4 on or above snowline

82| |B|reversed for internal usage, dikemap

83|a|B|Random byte for plain canals and river tiles, otherwise zero (under bridges as example, or old savegames)||

(a) 2.6 r1562

Variational Action 2 are available for IDs 0/1/2/5/6  (Watercliffs, Locks, Dikes, River Slopes, River waterside)

VariationalAction2/Bridges

2011-06-12T19:22:44Z

Orudge: 4 revisions

'''''Variational Action 2 Variables for Bridges'''''

=Variational Action 2 Variables for Bridges=

{maketoc}

||Variable|[[GRFActionsDetailed|'''Size''']]|Content

40|B|Age of the bridge in years (or, strictly speaking, the difference between the current year and the year the building was built). Returns 255 for buildings older than 255 years.

41|B|Terrain type: 0 normal, 1 desert, 2 rainforest, 4 on or above snowline

80+x| |None defined yet, Trying to access these variables crashes TTD.||

===Age of the bridge in years (40)===

The age of the bridge

===Terrain type (41)===

Terrain type: 0 normal, 1 desert, 2 rainforest, 4 on or above snowline

VarAction2Advanced

2011-06-12T19:22:44Z

Orudge: 13 revisions

'''''Advanced features of Variational Action 2'''''

=Advanced features of Variational Action 2=

Using advanced calculations instead of simple variable access

-=Introduction=-

A regular action 2 can access one variable and perform limited modifications on it (shift, and, add, divide/modulo). Using an advanced action 2, it is possible to do a nearly unlimited number of many different operations on several variables.

In addition, using procedure calls (with variable 7E), it is possible to reuse variational action 2 blocks in several places on the NFO code.

-=Format=-

An advanced variational action 2 looks as follows:

<pre> -+<Sprite-number> * <Length> 02 <feature> <set-id> <type> <variable> <varadjust> '''<nowiki><nowiki>[<operator> <variable> <varadjust>]</nowiki></nowiki>...''' <nvar> (<set-id> <low-range> <high-range>){n} <default>+-</pre>

The new elements are the <operator> (a byte), followed by another <variable> and <varadjust> pair.  This sequence may be repeated as often as necessary, by setting the appropriate bit in the previous <varadjust> (see below).

===varadjust===

<varadjust> itself has the same format as a regular var. action 2, however to perform a calculation, bit 5 in <shift-num> has to be set:

||Bit(s)|value|meaning

0..4|0..1F|number of bits to right shift <variable>

5|20|'''an <operator> <variable> <varadjust> triple follows this <varadjust>'''

6|40|This is a shift-and-add-divide adjustment.

7|80|This is a shift-and-add-modulo adjustment.||

Bit 5 needs to be set for each <shift-num>, except the last one that isn't going to be followed by another calculation (i.e., <operator> <variable> <varadjust> set). Bit 5 clear terminates the calculation and uses the resulting value for checking the ranges determining the set-id to use (or, if nvar=0, as a callback result).

===operator===

This field, and the following variable/varadjust pair, exist only if the previous shift-num had bit 5 set. This field has escape sequences for each of its valid values, as shown in the table below. See [[GRFActionsDetailed#Byte_order|the discussion of escape sequences]] for further information on escape sequences in general. Can have the following values:

||Value|Escape|Effect|Notes

00|\2+|result = val1 + val2|

01|\2-|result = val1 - val2|

02|\2<|result = min(val1, val2)|val1 and val2 are both considered signed

03|\2>|result = max(val1, val2)|val1 and val2 are both considered signed

04,05|\2u<, \2u>|<center>-"-</center>|Same as 02/03, but operands are considered unsigned

06|\2/|result = val1 / val2|val1 and val2 are both considered signed

07|\2%|result = val1 mod val2|val1 and val2 are both considered signed

08,09|\2u/, \2u%|<center>-"-</center>|Same as 06/07, but operands are considered unsigned

0A|\2*|result = val1 * val2|result will be truncated to B/W/D (that makes it the same for signed/unsigned operands)

0B|\2&|result = val1 & val2|bitwise AND

0C|\2<nowiki><nowiki>|</nowiki></nowiki>|result = val1 <nowiki><nowiki>|</nowiki></nowiki> val2|bitwise OR

0D|\2<nowiki><nowiki><pre></nowiki></nowiki>|result = val1 <nowiki><nowiki></pre></nowiki></nowiki> val2|bitwise XOR

0E|\2s or \2sto (a)|var7D<nowiki><nowiki>[val2]</nowiki></nowiki> = val1, result = val1|Store result, available since 2.6 r1246. val2 must not exceed FF (before r1301) or 10F (starting from r1301) (*)

0F|\2r or \2rst (a)|result = val2|Available since 2.6 r1246

10|\2psto (c)|var7C<nowiki><nowiki>[val2]</nowiki></nowiki> = val1, result = val1|Store result into persistent storage, available since 2.6 r1315 (**)

11|\2ror or \2rot (b)|result = val1 rotate right val2|Always a 32-bit rotation. Available since 2.6 r1651

12|\2cmp (c)|see notes|Result is 0 if val1<val2, 1 if val1=val2 and 2 if val1>val2. Both values are considered signed. Available since 2.6 r1698 (***)

13|\2ucmp (c)|see notes|The same as 12, but operands are considered unsigned. Available since 2.6 r1698 (***)

14|\2<< (c)|result = val1 << val2|shift left; val2 should be in the range 0 to 31. Available since OpenTTD r20332 and TTDPatch r2335.

15|\2u>> (c)|result = val1 >> val2|shift right (unsigned); val2 should be in the range 0 to 31. Available since OpenTTD r20332 and TTDPatch r2335.

16|\2>> (c)|result = val1 >> val2|shift right (signed); val2 should be in the range 0 to 31. Available since OpenTTD r20332 and TTDPatch r2335.||

where val1 is the value resulting from the current variable/varadjust pair (or the result of the previous calculations if this isn't the first pair) and val2 is the value resulting from the following variable/varadjust pair. By setting bit 5 of shift-num repeatedly, you can combine several variables together before making your decision.

(a) Supported since grfcodec and nforenum r1265 (1.0.0 and 3.4.4, respectively.)

(b) Supported since grfcodec and nforenum r1655 (1.0.0 and 3.4.6, respectively.)

(c) Supported since grfcodec 1.0.0 and nforenum 4.0.0.

<nowiki><nowiki>*</nowiki></nowiki> Registers above FFh are write-only because you can't give a value bigger than FFh to var 7D. These registers are special; they allow passing extra data to some 4x and 6x variables, as well as returning extra data from callbacks.

<nowiki><nowiki>**</nowiki></nowiki> Currently only feature A (industries) is supported, you have 16 4-byte slots per industry. This storage can be reached from industry tiles as well by using var. action 2 type 82/86/8A. This operation shouldn't be used when the industry structure isn't available.

<nowiki><nowiki>***</nowiki></nowiki> Operations 12 and 13 should be preferred over operation 01 (subtraction) when only the relation of the two values is needed and the difference itself is irrelevant. This is because operation 01 can overflow and give the wrong sign if the difference is too big, but comparisons work correctly for all values.

Registers (temporary and persistent alike) always have the size of 4 bytes. If you're writing them using smaller sizes (anything but type 89/8A), the given value will be sign-extended to 4 bytes. Therefore, be careful when you read a register using a bigger size than it was written with. This also applies to registers read by TTDPatch; if not indicated specifically, TTDPatch reads all 4 bytes of the register.

Note that a bitwise NOT can be done by XORing with variable 1A. Similarly, you can specify literal values (i.e. plain numbers instead of variables), by using variable 1A and an and-mask of the value you want. For example, to specify a literal 26, use variable=1A, shift-num=00 (or the higher bits set if you need further calculations), and and-mask=26. This works with B, W or D sized literals if you use the right and-mask size for the given type of action 2. The appropriate \b, \w, or \d escape sequence can be useful for specifying literals. See [[GRFActionsDetailed#Byte_order|the discussion of escape sequences]] for further information.

Operator 0F is only useful when using variable 7B, or immediately after operators 0E or 10, to store the result of a calculation, and then discard that result and start fresh.

==Using types 81/82 (etc) simultaneously==

Since 2.0.1 alpha 59, it is possible to access variables using both var.action 2 type 81 and 82 (and their W/D cousins) indirectly through the new variable 1C.

This variable stores the result of the current var.action 2 and makes it available to the next var.action 2 in the chain.  Therefore, to access, for instance when drawing a house, both house variables (type 81) and town variables (type 82), you would read the house variables in one var. action 2, type 81, and then chain to the next var.action 2, type 82.  There, you now have access to the house variable value stored in variable 1C as well as the town variables in the regular variables. Since 2.6 r1246, you may also store values in the 7D array, where they will persist for the life of the action 2 chain, unless overwritten.

Note that to chain to the next var.action 2, you ''must not'' use nvar=0, because that returns the result value as a callback result.  Instead, you need to use nvar=1, and specify the chained var.action 2 in both the <set-id> and <default> positions.

==Using procedures==

When the variable in a var.action 2 is 7E, the procedure given by the 60+x parameter is invoked. This means that the byte following the variable number (7E) specifies a variational or random action 2 ID to call, similarly to how a regular var.action 2 branches to other action 2 entries. However, instead of branching, it is a subroutine call, with the value calculated by the called entry being used as variable value.

The called action 2 must return a callback result. If the chain ends in a regular action 2 instead of returning a callback result, the variable 7E value is undefined.  Because callback results are limited to 15 bits, to access the full 32 bit result you can read variable 1C instead (e.g. by anding the 7E result with 0 and then adding var. 1C).

In TTDPatch 2.5 beta 9 and earlier and in TTDPatch 2.6 prior to r846, var.action 2s that attempt to perform multiple sequential (as opposed to nested) procedure calls will have undefined results.

The feature of this called action 2 is ignored, and all variables accessed use the same feature as the calling var.action 2. It is however valid to use any type of var.action 2, e.g. types 81 and 82 and the various byte/word/dword sizes may be mixed. It is also valid to use nvar=00 to return the computed value as callback result, instead of specifying ranges, although this way the return value is still limited to 15 bits. When using a random action 2 in the called chain, random triggers are processed in the same way as in "normal" chains.

GRFActionsDetailed

2011-06-12T19:22:44Z

Orudge: 9 revisions

'''''Technical reference of the new .grf actions'''''

=Technical reference of the new .grf actions=

-=General Information=-

The next few pages detail the syntax of TTDPatch's GRF actions.  In each page, you will find a list of syntax elements that make up a line for this action in the .nfo file.

Each element has a size (how many bytes it uses in the pseudo sprite data).  These are the possible sizes:

||Size|Description

dec|This value is given in decimal, not hexadecimal; the size is therefore irrelevant

B|This parameter is a single byte

B*|This parameter is an extended byte (either a byte, or a word value)

W|This parameter is a two-byte word, specified in little-endian byte order

D|This parameter is a four-byte dword, again in little-endian byte order

S|This parameter is variable-length, zero terminated text string

V|This parameter has a variable length, which depends on one of the previous parameters; it will be described there.||

Extended bytes work like this:
* To specify a value of 0..FE, simply use that byte value
* To specify a value of FF..FFFF, use a literal FF followed by the word value, e.g. for 320d (140 hex) use FF 40 01.

-=Comments=-

==Byte order==

For values larger than one byte (i.e. W and D), the value must be split into individual bytes in the right order.  This order is the so-called [http://en.wikipedia.org/w/wiki.phtml?title=Little-endian|little-endian] order, with the least significant bytes first.

Here's how you convert a hexadecimal number into its little-endian bytes
#Pad with zeroes from the left until you have twice as many digits as you need bytes (i.e. 4 digits for W, 8 digits for D)
#Split into groups of two digits
#Write these groups backwards

Examples:

123 in W becomes 0123, then 01 23, so finally 23 01

12345 in D becomes 00012345, then 00 01 23 45, so finally 45 23 01 00

In Info version 7 and later (supported by grfcodec version 0.9.9 and later), grfcodec can do some of this work for you. Instead of doing the above, you may use any of the following escape sequences:

\b<dec>

\b<year>

\b*<dec>

\w<dec>

\wx<hex>

\w<date>

\d<dec>

\dx<hex>

\d<date> (Only supported by nforenum 3.4.6 and grfcodec 0.9.11 (r1703) and later.)

Where:

The second character (or, in the case of \b*, the second and third characters) indicates the number of required bytes: b for a byte, b* for an extended byte, w for a word, and d for a dword.

<dec> is any positive decimal integer that fits in the given width.

<year> is a year; the resultant byte will be <year>-1920

<hex> is any big-endian hexadecimal integer that fits in the given width.

<date> is a date in one of the four formats YYYY-MM-DD, YYYY/MM/DD, DD-MM-YYYY, or DD/MM/YYYY. In all cases, leading zeros may be omitted.

In the word-sized dates, the years 1932..2000 may be specified with only two digits.

To avoid ambiguity, dword-sized dates before 1 Jan 32 must be specified with the YMD formats, not the DMY formats. eg 10 Feb 20 is \d20-2-10.

There are also certain action-specific escape sequences; these are of the format \<action><operator>, where the sequence is used for the action <action>, and <operator> is a C operator related to the function of the sequence's byte value, or something vaguely related to a C operator. Or something else.

These are discussed in further detail on the appropriate action's page.

Note that this behaviour is only supported in Info version 7 and later; in Info version 6 and earlier, such escape sequences are errors.

==Strings==

Strings are written as individual characters in hex codes, with a final 00 to indicate the end of the string.  For example, "Hello" is 48 65 6D 6D 6F 00.

To convert text into the syntax needed for .nfo files, you can use the [http://www.ttdpatch.net/cgi-bin/str2hex.pl|str2hex] converter. As of grfcodec 0.9.6, you may also put literal strings right in the .nfo. Note that you may only use characters in the latin1 character set, which is what TTD uses.  Other characters will either not show up in TTD or they will mess up the entire display.

If you end up with any characters in the range 7B to 9F, remove them from the string. See StringCodes for more details.

In Info version 7 and later, strings behave mostly as they do in the C family of languages: \\, \n, and \" insert a single backslash, a line feed (0D), and a double quote (22), respectively. In addition, \<hex> (up to two characters) inserts the byte <hex>, and \U<hex> (up to four characters) inserts the UTF-8 encoding of the character U+<hex>

Note that this behaviour is only supported in Info version 7 and later; in Info version 6 and earlier, the backslash is not an escape character. ("\\" encodes as one byte in Info version 7, but two bytes in Info version 6.)

-=List of Actions=-

{toc}

ActionF

2011-06-12T19:22:44Z

Orudge: 8 revisions

'''''Define new town name styles'''''

=Action F - Town names=

Define new town name styles

-=Introduction=-

This action can be used to define new town name styles for random games and random cities placed in the scenario editor.

-=Format=-

The data looks as follows:

<pre> -+<Sprite-number> * <Length> 0F <ID> <stylenames> <num-parts> <parts>...+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

<Sprite-number>|dec|A sequential sprite number

<length>|dec|The total number of bytes used in this action.

<ID>|B|    ID of this definition in the bottom 7 bits. If bit 7 is set, this is a final definition (it will be displayed in the Options window), if it's clear, this is an intermediate definition that can be used to create more complex decision chains, see below. Final and intermediate definitions share the same 128 IDs, so 01h and 81h define the same ID for different usages, and not two separate IDs.

<style-names>|V|This is only present in final definitions, see below for the format

<num-parts>|B|How many parts this name is put together from.

<parts>|V|Data about the various parts, see below||

==Style names==

This item is only present if bit 7 is set in the ID.  Its contents are in the format:

<pre> -+<nowiki><nowiki>[<langs> <name>]</nowiki></nowiki>... 00+-</pre>

||Element|Size|Meaning

langs|B|Language ID definition, see below

name|S|Null-terminated style name to be displayed in the Options window.||

There can be any number of style names, until a literal "00" terminates the style name definition. If no appliable name is found, "(unnamed style)" will be displayed in the Options window.

The language selection works the same as the [[Action4#language_id|action 4 language ID]], including the difference for grf version 7 and up, however bit 7 is ignored. This means that there is an ambiguity whether a value of "00" is a list terminator, or the ID of the American language. To resolve this, the first style name definition is never a list terminator (starting with 2.5 beta 4). This means that the definition of the American language name must be the first in the list. Alternatively, since bit 7 is ignored, it is valid to use the value "80" for the ID of the American language as well, but putting it first in the list is the preferred way of defining it.

==Parts==

The following fields are repeated for every part (num-parts times):

<pre> -+ <textcount> <firstbit> <bitcount> <nowiki><nowiki>[ <probability> <part/ID> ]</nowiki></nowiki>... +-</pre>

||Element|Size|Meaning

textcount|B|The number of possible values for this part

firstbit|B|Number of the lowest bit that counts for determining the value of the part

bitcount|B|How many bits are used for determining the value of this part||

Every town has 32 random bits for random naming. You can use the <firstbit> field to make the decisions for every part linearly independent, or at least as independent as possible.

The minimal number for the <bitcount> field should be the lowest power of 2 that is higher than the sum of all probabilities (e.g. 2 if the sum is <=4, 3 if it's <=8, 4 if <=16 and so on), but allowing more bits can make the distribution of decisions smoother.

The following fields are repeated for every text (textcount times) in every part:

||Element|Size|Meaning

probability|B|The relative probability of the following name to appear in the bottom 7 bits. Bit 7 decides the meaning of the following field.

part|S|If bit 7 of probability is clear, the following field is a null-terminated string containing a name part itself. This can be an empty string (just a plain zero byte) to avoid generating this part. (This can be useful for an optional part: give a high probability to an empty part to appear, and low probablities to many non-empty parts, so you effectively decrease the chance that the part appears at all)

ID|B|If bit 7 of the probability is set, the following byte is an ID for an intermediate action F. The random name defined by the given ID is generated, then inserted into the current name as a name part. Specifying an ID that isn't defined yet results in an error and therefore disabling all town name definitions in the file.||

-=Notes=-

That town name styles are special since they have to be available on the title screen as well, where the graphics files aren't activated yet. This means they're processed at the initialization stage only, and can be skipped only by action 9, but doing so will prevent them from working for the rest of the game. The only way to disable a new town name style once it's loaded is to disable the entire GRF file it's situated in (by using the "New GRF status" window or by putting an exclamation mark next to the filename in newgrf(w).txt).

A town name generated this way must meet some requirements to be accepted by TTD: it can't be empty (so you don't have to worry even if your chain can generate an empty string), can't be a name that's already given to a town (to avoid duplicate town names),  can't be longer than 31 characters and its displayed form can't be wider than 130 pixels. If a generated name doesn't meet all these requirements, TTD tries again with a different random value. For this reason, your town name style must be able to generate at least 70 different acceptable combinations, since this is the maximum number of towns possible on a map, and TTD may deadlock if it can't find different names for every town on the map.

The town name style dropdown menu doesn't support more than 19 entries, and since six entries are already reserved for the old styles, only 13 remain for new styles. If there are more than 13 final style definitions available, only the first 13 will be displayed in the dropdown menu, and therefore be selectable. The other definitions will still be available (e.g. they'll show up in games started with them), but cannot be selected from the user interface.

If your GRF isn't available while its name style definition is used in a savegame, the town name style reverts back to German, but the towns get both English and German names; they appear in the wrong order in the town list and duplicate town names may appear. However, no data loss occurs, so the correct names are restored as soon as your definition becomes available again.

-=Example=-

<pre> -+ 2 * 52 0F 80 7F "Mars" 00 00 02 +-

-+ 02 00 02+-

-+     03 "Alpha" 00 01 "Beta" 00+-

-+ 03 02 04+-

-+     01 " Andromedæ" 00 01 " Carinæ" 00 81 01 +- </pre>

||Byte(s)|Meaning

0F|Action F

80|<ID> Final definition; show in town-name list.

7F|<lang-id>: Name for all languages follows

"Mars" 00|Style name

00|End of style names

02|<num-parts>: Two <parts> fields follow:

'''First <parts> field:'''

02|<textcount>: two options for this part.

00|<firstbit>: start with bit 0, and

02|<bitcount>: use two bits (sum of probabilities is 04; minimum number of bits is 2)

03|<probability> (probability is 3/4)

"Alpha" 00|<part>: First option for first part

01 "Beta" 00|<probability>/<part>: Second option for first part, probability 1/4

'''Second <parts> field:'''

03|<textcount>: three options for this part:

02|<firstbit>: start with bit 2, and

04|<bitcount>: use four bits (sum of probabilities is 3; minimum number of bits is 2)

01 " Andromedæ" 00 |<probability>/<part>: First option for second part, probability ~1/3

01 " Carinæ" 00 |<probability>/<part>: Second option for second part, probability ~1/3

81 01|<probability>/<ID>: Third option, chain to the action F with ID 01, probability ~1/3||

Notes:
# ID 01 (and any Action F's chained to by ID 01 should all have <firstbit>s of 06 or higher, since bits 00..05 were used by ID 00, and if they are used again, the decision will be related to the decision in ID 00.
# Unless ID 01 produces at least 33 (dec) different strings, this will not provide a sufficient number of town names.
# The second <parts> uses four bits; the probabilities for each <part> are 5/16, 5/16, and 6/16, which are reasonably close to 1/3, and far better than the 1/4, 1/4, 1/2 that would have resulted if only two bits had been used. There is no reliable determination of which <part> will get the extra probability; if you want to know for certain which will have the extra probability, code the action F so that some <part>s have a higher or lower probability than the others.
# The <probability>/<ID> pair 81 01 could also chain to the action F with ID 81, but this is probably not a desirable result.

ActionE

2011-06-12T19:22:44Z

Orudge: 7 revisions

'''''Deactivate other graphics files or force activation of current file'''''

=Action E=

Deactivate other graphics files or force activation of current file.

-=Introduction=-

Normally, graphics files should use [[Action7]] to deactivate themselves, if they find that other incompatible graphics have been loaded.

However, when new sets come out, it is often not feasible to change all existing sets so that they can detect the new set. This action therefore allows the new graphics set to deactivate older sets with which it is incompatible.

-=Format=-

The data looks as follows:

<pre> -+<Sprite-number> * <Length> 0E <num> <grfids...>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

<Sprite-number>|dec|A sequential sprite number

<length>|dec|The total number of bytes used in this action.

0E|B|Defines action 0E

<num>|B|Number of sets which should be deactivated

<grfids...>|4*B|GRF IDs of the sets to deactivate||

-=Filling in the terms=-

===Sprite-number===

This is just the number you are at.

===Length===

Count the number of bytes in this action.

===num===

This is the number of sets you want to deactivate.

===grfids===

Here you give the list of GRF IDs, in the same format as in [[Action8]], which should be deactivated.

-=Notes=-

Note that it is invalid to attempt the deactivation of already active graphics files.  You can only prevent files lower down the newgrf(w).cfg from becoming active later.  Therefore, you must check that none of the GRF IDs in this list are active already using the appropriate action 7.  If the deactivation of an already active set is attempted, the current set is considered invalid and will be disabled.

If you attempt to deactivate a set that isn't loaded, nothing happens.

To handle the cases of incompatible sets being loaded and activated earlier, you can either attempt to overwrite all their settings and graphics, or simply deactivate this set in turn.

If the given GRFID is identical to the GRFID of the file currently being processed, the current file is force-activated.  This is most useful for making changes to the title screen menu, which would otherwise not be possible.  It is strongly recommended not to use this feature in any way other than in combination with an action 7 that checks variable 92 (game mode) so that the activation only happens in the title screen.  Otherwise the GRF Status Windows (de)activation is bypassed entirely.

It is best to limit this forced activation to as few actions as possible for maximum compatibility.

In principle, there can be four cases and your .grf file must be able to handle all of them properly:
* The .grf file is active and can not be deactivated.

+ You cannot use action E in this case.
* The .grf file is inactive but will be activated.

+ This is the only case in which action E is useful, the .grf file coming below the current one in newgrf(w).cfg but being set to be activated. Action E will set it to not be activated when it is processed.
* The .grf file is inactive and will not be activated.

+ This can happen because it has been processed already (it comes earlier in newgrf(w).cfg) and was deactivated, either by default or manually. Another possibility is that the file is disabled either by default or manually.

-=Example=-

The following is an example to deactivate GRFID 54570105 if possible, and deactivate the current file instead if not.

<pre>-+ 47 * 9 07 88 04 06 54 57 01 05 02+-

-+ 48 * 9 07 88 04 08 54 57 01 05 03+-

-+ 49 * 6 07 83 01 03 7F 04+-

-+ 50 * x 0B 01 1F FF +-... (e.g. "This file is deactivated because incompatible graphics are active.")

-+ 51 * 6 07 83 01 03 7F 00+-

-+ 52 * x 0B 01 1F FF +-... (e.g. "Deactivating GRFID 54570105.")

-+ 53 * 6 0E 01 54 57 01 05+-</pre>

This carries out the following instructions:

<pre>47: if (GRFID 54570105 is active) goto 50

48: if (GRFID 54570105 is inactive but will be activated) goto 52

49: goto 54

50: showmessage("This file is deactivated because incompatible graphics are active.")

51: deactivate_current_file

52: showmessage("Deactivating GRFID 54570105.")

53: deactivate(54570105);

continue_with_current_file;</pre>

The reason for this particular order of pseudo-sprites is that action 7 will not take a branch if the queried GRFID is not present at all.  In that case, both sprites 47 and 48 fall through, which means the jump in 49 is carried out and the file resumes processing.  The unconditional gotos in 49 and 51 are actually conditional on the climate not being 7F, which it never can be.

Conceptually, without goto-logic, the code could be described by

<pre>if (GRFID 54570105 is active) {

   showerror("This file is deactivated because incompatible graphics are active.")

deactivate_current_file

} else if (GRFID 54570105 is inactive but will be activated) {

showmessage("Deactivating GRFID 54570105.")

deactivate(54570105);

}</pre>

ActionD

2011-06-12T19:22:43Z

Orudge: 13 revisions

'''''Assign parameters and calculate results'''''

=Action D=

Assign parameters and calculate results.

{maketoc}

-=Introduction=-

Action D allows you to set the value of grf parameter (i.e. those usually set as options in the newgrf(w).cfg file), as well as do math on them.

-=Format=-

The data looks as follows:

<pre> -+<Sprite-number> * <Length> 0D <target> <operation> <source1> <source2> <nowiki><nowiki>[<data>]</nowiki></nowiki>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

<Sprite-number>|dec|A sequential sprite number

<length>|dec|The total number of bytes used in this action

0D|B|Defines action 0D

<target>|B|Target parameter

<operation>|B|Calculation to carry out

<source1>|B|First argument

<source2>|B|Second argument

<data>|D|Value to use as source if not parameter||

-=Filling in the terms=-

===target, source1, source2===

These bytes specify the target parameter and source parameters.  They can either be simply the numbers of grf parameters, or they can be the special variables from [[Action7|action 7]], see the description of param-num there.

Note that the only special variables which may be given as target are listed below, all others should be considered read-only.

If either source1 or source2 is FF, the value from <data> is used instead of a parameter value.

If <source2> is FE, then this action D will perform one of the following special variable accesses. In this case, <operation> must be assignment and <data> is an argument to the data access, not a source value.

{toc}

===operation===

The operation to carry out on the source arguments. This byte has an escape sequence for each of its possible values, as listed below. See [[GRFActionsDetailed#Byte_order|the discussion of escape sequences]] for further information on escape sequences in general. The result of this calculation will be stored in the target parameter.

||Operation|Escape|Name|Result

00|\D=|Equal|target = source1

01|\D+|Addition|target = source1 + source2

02|\D-|Subtraction|target = source1 - source2

03|\Du*|Unsigned multiplication|target = source1 * source2, with both sources being considered to be unsigned

04|\D*|Signed multiplication|target = source1 * source2, with both sources considered signed

05|\Du<<|Unsigned bit shift|target = source1 << source2 if source2>0, or target = source1 >> abs(source2) if source2 < 0. source1 is considered to be unsigned

06|\D<<|Signed bit shift|same as 05, but source1 is considered signed)

07|\D&|Bitwise AND*|target = source1 AND source2

08|\D<nowiki><nowiki>|</nowiki></nowiki>|Bitwise OR*|target = source1 OR source2

09|\Du/|Unsigned division**|target = source1 / source2

0A|\D/|Signed division**|target = source1 / source2

0B|\Du%|Unsigned modulo**|target = source1 % source2

0C|\D%|Signed modulo**|target = source1 % source2||

<nowiki><nowiki>*</nowiki></nowiki> Only available in 2.0.1 alpha 48  or higher

<nowiki><nowiki>**</nowiki></nowiki> Only available in 2.0.1 alpha 59  or higher

You can add 80 to the operation number to make it apply only if the target is not defined yet.  In this respect, a parameter is taken to be defined if any of the following applies:
* it has been set to any value in the newgrf(w).cfg parameter list
* it '''or a parameter with higher number''' has been set to any value by an earlier action D

If, for example, parameters 0 and 1 are set in the newgrf(w).cfg file, and action D sets parameter 4, then parameters 2 and 3 automatically become defined and get a value of zero.

==Notes==

You can do a bitwise NOT of <param> by calculating "-1 - <param>", i.e. operation=02, source1=FF, source2=param, data=FF FF FF FF.

The target operand can also refer to the special variables from action 7, see below for the list of variables that it is valid to write to.

Because the patch has to reallocate memory for the whole parameter list whenever a new parameter is added, you should set the parameter with the highest number first (whenever possible, at least) so that all memory can be allocated right away.

Note that parameters are never reset after the game has started, therefore you must not modify newgrf(w).cfg parameters with any kind of irreversible operation.  It is valid to, for example, add a value to a parameter only if the same value is later subtracted, to keep the parameter the same across loading or starting several games.

==Writable variables (global)==

The following global variables can be written to:

||Variable|Size(*)|Meaning

8E|B|Y-Offset for train sprites

8F|3*B|Rail track type cost factors

93|W|Tile refresh offset to left

94|W|Tile refresh offset to right

95|W|Tile refresh offset upwards

96|W|Tile refresh offset downwards

97|B|Snow line height

99|D|Global ID offset

9E|D|Misc. GRF Features

9F|D|Locale-dependent settings||

(*) Action D only supports writing dword values. The size given here is merely used to convey how much of that dword value will be used by the game, i.e. what the maximum value is.

===Y-Offset for train sprites (8E)===

Since train sprites must normally have the same offsets on the map and in the depot view, they will appear either too low on the map or too high in the depot view.  This variable moves all vehicles in the depot view down by this many pixels.

Since OpenTTD r16867 this variable works per grf file, that is: It only affects trains defined in the same grf.

===Rail track type cost factors (8F)===

This variable is a collection of three bytes that are used as multipliers for track costs when the "trackcostdiff" switch is on.  The value of 08 is the baseline value that is used by standard TTD.

The defaults are the following:

||Values|Track types|Electrified railways setting

08, 10, 18|Regular, Monorail, Maglev|off

08, 0D, 10|Regular, Electric, Monorail/Maglev|on||

===Tile refresh offsets (93, 94, 95, 96)===

These four offsets define the size and position of the rectangle refreshed when TTD decides to refresh a tile. The basis of the calculations is the pixel coordinate of the north corner of the tile.

After calculating it, TTD subtracts offset_left from it to get the x coordinate of the left edge, adds offset_right to get the x coordinate of the right edge, subtracts offset_up to get the y coordinate of the top edge and adds offset_down to get the y coordinate of the bottom edge. This results in refreshing (offset_left+offset_right)*(offset_up+offset_down) pixels. The default values of these variables are 31, 36, 122 and 32, respectively.

Reading these values is not too useful, but you can modify them using action D as well, so your sprites that would exceed the original limits can still be redrawn and animated properly. Please note that TTD uses these values for every tile, so specifying too high values may slow the game down. Please also note that these variables are specified as dwords for technical reasons, but only the bottom word will be used.

Since these values are global to the entire game, you shouldn't just overwrite them with an action D. Instead, you should first check if they're big enough for you by using action 7, and skip your action D if they are. This way, the variables will be set to the maximal value needed, not just the value needed for the last grf in the list.

===Snow line height (97)===

This is only active if the tempsnowline switch is on. It defaults to FF (no snow) and 38 in the temperate and arctic climates, respectively. It must be set to a multiple of 8, which is one level of height difference.

===Global ID offset (99)===

Setting this variable will add the given value to all the relevant IDs in subsequent action 0, action 3 (''except'' livery overrides), action 4 (''except'' generic texts) and action A entries. This is a more convenient way of applying the result of a GRF resource request. Setting this variable applies only to the current .grf file only.

In detail, it affects the following elements:

||Action|Element modified

0|-+<Id>+- (i.e., not property numbers)

3|-+<Ids...>+- (i.e., not cargo types or cargo IDs, also not for livery overrides)

4|-+<Offset>+- (not for generic texts, though)

A|-+<First-sprite>+-||

===Misc. GRF Features (9E)===

This variable is a global bit mask of various patch features a grf file can enable.  Please only set the bits using operation 08 (bitwise OR), or, if absolutely necessary, remove certain bits with operation 07 (bitwise AND).  This ensures that you don't mess up the settings of other grf files.

||Bit|Value|Feature|Min. version

0|1|Allow trees and fields in the desert

1|2|Show pavement and lights in desert towns

2|4|Fields have a height, using a 3D bounding box

3|8|Display train vehicles with full width of 32 pixels in depot window (instead of 29 pixels)|(a)

4|10|Enable ambient sound effect callback 144|2.6 r821

5|20|Enable catenaries over the third track type (only with electrifiedrailway on)|2.6 r826, 2.5 r1439 (beta 10)

31|80000000|Only to be set by ttdpbase(w).grf for identification||

(a) Since OpenTTD r16867 this flag works per grf file, that is: It only affects trains defined in the same grf.

Example code for setting bit 3:

<pre>-+  24 * 9     0D 9E 08 9E FF 08 00 00 00+-</pre>

(Here, the first 08 indicates the bitwise OR operation, and 08 00 00 00 is the value to OR var.9E with.)

===Locale-dependent settings (9F)===

This variable is a doubleword in the format rrccmmll, where the meaning of the bytes is:

||Byte|Meaning

rr|Reserved for future use, just put zero here for now

cc|Default currency to be used when the game is first started. It can be larger than 5 to select one of the currencies added via morecurrencies. If this value is larger than 5 while morecurrencies is disabled, US dollars will be used instead.

mm|Default measurement system to be used when the game is first started. 00h means the imperial system (miles), 01h means the metric system (kilometers), other values are forbidden.

ll|Language ID. By setting this byte, you can override the default language ID and allow other GRFs to supply correctly localized texts. (The other GRF can check for this value in action 4s)||

Reading this variable isn't reliable, so you must only write to it. Please also note that the cc and mm parts are considered only while loading the title screen for the first time, changing them later is ignored.

'''NOTE''': This variable is reset after the initialization stage. Only changes during the activation stage are considered. This way, GRFs disabled in newgrf.cfg won't change the language and/or default settings. If you want to modify the cc or mm part, make sure the corresponding action D isn't skipped by an earlier action 7 or 9. In particular, if your GRF isn't available for the tropic climate, make sure you set variable 9F before the climate check, since the default title screen is tropic, and your climate check will fail on it.

-=Example=-

Something to go here

ActionC

2011-06-12T19:22:43Z

Orudge: 4 revisions

'''''Do nothing.'''''

=Action C=

Do nothing.

-=Introduction=-

Action C is a NOP (no operation). It can be used to temporarily comment out a sprite while testing.

-=Format=-

The data looks as follows:

<pre> -+<Sprite-number> * <Length> 0C <nowiki><nowiki>[<ignored>]</nowiki></nowiki>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

<Sprite-number>|dec|A sequential sprite number

<length>|dec|The total number of bytes used in this action

0C|B|Defines action 0C

<ignored>|V|Anything following the action byte 0C is ignored entirely||

-=Filling in the terms=-

===Sprite-number===

This is just the number you are at.

===Length===

Count the number of bytes in this action.

===ignored===

These bytes, if present at all, are ignored. The action does nothing.

-=Example=-

Something to go here

ActionB

2011-06-12T19:22:43Z

Orudge: 13 revisions

'''''Generate error messages'''''

=Action B=

Generate error messages.

-=Introduction=-

With this action, you can alert the user to problems in the way the grf file is loaded, e.g. not in the right order, not the right patch version, or wrong parameters.

-=Format=-

The data looks as follows:

<pre> -+<Sprite-number> * <Length> 0B <severity> <language-id> <message-id> <nowiki><nowiki>[<message>] [<data> [<parnum> [<parnum>]]]</nowiki></nowiki>+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

<Sprite-number>|dec|A sequential sprite number

<length>|dec|The total number of bytes used in this action

0B|B|Defines action 0B

<severity>|B|How severe the message is (notice/warning/error/fatal error)

<language-id>|B|What languages to display this message for

<message-id>|B|What message to show

<message>|S|Text of a custom message, only present if <message-id>==FF

<data>|S|String to insert in built-in or custom messages

<parnum>|B|GRF parameter(s) to display in message||

-=Filling in the terms=-

===Sprite-number===

This is just the number you are at.

===Length===

Count the number of bytes in this action.

===severity===

This sets how severe the message is.

||Severity|Meaning|Prefix|Action taken

00|Notice|(none)|continue loading grf file

01|Warning|"Warning: "|continue loading grf file

02|Error|"Error: "|continue loading grf file

03|Fatal error|"Error: "|abort loading of grf file, and do not attempt again until patch is restarted||

Normally Action B is ignored during initialization. If the severity has bit 7 set, a fatal action B will be applied even during initialization.  This can be useful to prevent errors due to invalid sprites during initialization.  Note that this only works properly since 2.0.1 alpha 66, for earlier versions the error popup that is shown is corrupted if bit 7 is set.

Messages are shown with a "/!\" sign in the [[GRFStatusWindow|GRF Status window]]. The first fatal message during each activation is shown as a red popup box as well.

===language-id===

This has the same format as the [[Action4#language-id|language-id in action 4]].

Use 7F (all languages) for built-in messages, because they are automatically using the right language.

===message-id===

Set what kind of message to show. You have the following options:

||Message ID|Content

00|80 " requires at least TTDPatch version " 80 00

01|80 " is for the " 80 " version of TTD." 00

|<data> should be "DOS" or "Windows"

02|80 " is designed to be used with " 80 00

|<data> should be a switchname + value, e.g. "multihead 0"

03|"Invalid parameter for " 80 ": parameter " 80 " (" 7B ")" 00

|<data> should be the switch number written out ("5")

04|80 " must be loaded before " 80 "." 00

05|80 " must be loaded after " 80 "." 00

06|80 " requires OpenTTD version " 80 " or better." 00

FF|Custom message, use text from <message>||

Message IDs 04 and 05 are available since TTDPatch 2.6 alpha 1 (r858).

Message ID 06 is available since OpenTTD r11330. This message should only be used when Action 7/9 variable 9D is 1 (OpenTTD).

===message===

Custom message text to show.

===parnum===

Parameter numbers (up to two) to display instead of 7B in the message text.

-=Notes=-

In all messages (built-in and custom), the first 80 is replaced by the filename of the grf file, the second 80 is replaced by the content of <data>.  After the two 80 bytes, you may have one or two 7B bytes that are replaced by the value of the parameter(s) specified by <parnum>. Note that it is invalid to have a 7B before exactly two 80 bytes were encountered. This means the following combinations of special bytes are allowed:

<pre>(none)~pp~

80

80 80

80 80 7B

80 80 7B 7B~/pp~</pre>

Before, after, or in-between the bytes you may have arbitrary characters.

The advantage of the built-in messages is that they can be translated using the mkpttxt mechanism, whereas custom messages will only be available in the languages that come with the grf file.

Note that if several grf files attempt to show fatal error messages, only the first message is actually shown at the moment since TTD does not have a queue for the red error popups.  All others will however be shown in the GRF Status window.

Also note that since this action has only been introduced in 2.0.1 alpha 13, it makes no sense to check whether the version is at least alpha 13 if you want to use the error message 00.  In earlier versions, the patch will display the "invalid sprite" error message anyway because the action is unknown.

-=Example=-

Below is an example of what a real Action B pseudo-sprite could look like, along with the [[Action7|Action 7]] required to skip it under the appropriate circumstances.

<pre>2 * 6  07 85 01 01 37 01

3 * 17 0B 03 7F 02 "newtrains on" 00</pre>

||'''Byte(s)'''|'''Name'''|'''Meaning'''

07|<action>|Sets this pseudo-sprite to function as action 7

85|<variable>|Check [[TTDPatchFlags|patch flags]]

01|<size>|variable size; ignored because this is a bit test

01|<cond>|skip if bit is set

37|<val>|check bit 37 (newtrains)

01|<num-sprites>|skip one sprite

0B|<action>|Sets this pseudo-sprite to function as action B

03|<severity>|Sets this to a fatal error

7F|<language-id>|Execute this sprite for all languages

02|<message-id>|Use message 02 (80 " is designed to be used with " 80)

"newtrains on" 00|<data>|String to insert in place of the second 80 in the message||

ActionA

2011-06-12T19:22:43Z

Orudge: 11 revisions

'''''Modify TTD's sprites'''''

=Action A=

Modify TTD's sprites.

-=Introduction=-

Unlike actions 1 and 5, which add new sprites for new features or vehicles, action A modifies TTD's built-in sprites.

-=Format=-

The data looks as follows:

<pre> -+<Sprite-number> * <Length> 0A <num-sets> <num-sprites> <first-sprite>...+-</pre>

||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''

<Sprite-number>|dec|A sequential sprite number

<length>|dec|The total number of bytes used in this action

0A|B|Defines action 0A

<num-sets>|B|How many sets of sprites to replace

<num-sprites>|B|How many consecutive sprites in this set

<first-sprite>|W|Number of first sprite in this set||

The set of <num-sprites> and <first-sprite> is repeated as often as <num-sets> specifies.

The following sprites will be RealSprites or RecolorSprites that replace the given TTD sprites.  There must be as many of them as num-sprites of all sets added up.

-=Filling in the terms=-

===Sprite-number===

This is just the number you are at.

===Length===

Count the number of bytes in this action.

===num-sets===

This sets how many different sets of sprites to replace. Each set are a number of consecutive sprites.

===num-sprites===

How many consecutive sprites to replace in this particular set.

===first-sprite===

The first sprite number to replace in this set.

-=Notes=-

You can find the sprite numbers by looking in trg1.pcx, they're the little numbers above each sprite, except for the climate-specific sprites which are more complicated.

Unlike actions 1 and 5, the real sprites of action A do not count towards the sprite limit.

To replace sprites in other climates, you first need to find out what the sprite number is trg1.grf.

You set it to replace that number and add an Action7 which turns it off if it is not in the right climate.

One easy way to do this is to edit trg?<nowiki><nowiki>[r]</nowiki></nowiki>.grf, use grfdiff (part of the grfcodec package) to create a grd, and then use [http://www.bytetransfer.de/projects/ttdpatch/grdtogrf/|grdtogrf] to create a simple grf with the action A(s) written for you. The action7s still have to be added by hand.

You can as well use [http://www.bytetransfer.de/projects/ttdpatch/docs/|the online sprite id converter] found on the same site.

-=Example=-

Below is an example of what a real Action A pseudo-sprite could look like with the sprite entries under it.

<pre>3 * 5     0A 01 0C 3A 08

4 c:\ttd\sprites\farmset.pcx 66 8 09 31 64 -31 0

5 c:\ttd\sprites\farmset.pcx 146 8 09 31 64 -31 0

6 c:\ttd\sprites\farmset.pcx 226 8 09 45 48 -15 -11

7 c:\ttd\sprites\farmset.pcx 290 8 09 33 22 1 -10

8 c:\ttd\sprites\farmset.pcx 322 8 09 31 64 -31 0

9 c:\ttd\sprites\farmset.pcx 402 8 09 29 57 -26 -4

10 c:\ttd\sprites\farmset.pcx 466 8 09 31 64 -31 0

11 c:\ttd\sprites\farmset.pcx 546 8 09 31 39 -19 -6

12 c:\ttd\sprites\farmset.pcx 594 8 09 31 64 -31 0

13 c:\ttd\sprites\farmset.pcx 674 8 09 49 28 -6 -28

14 c:\ttd\sprites\farmset.pcx 722 8 09 31 64 -31 0

15 c:\ttd\sprites\farmset.pcx 2 72 09 30 55 -29 0</pre>

||'''Byte'''|'''Meaning'''

3|<sprite-number>

5|<length> of the action in bytes; start counting at 0A (<action>)

0A|<action>: sets this pseudo-sprite to function as action A

01|<num-sets>: sets it to 1 set to replace

0C|<num-sprites>: sets it to 12 sprites in this set.

3A 08|<first-sprite>: First Sprite of the set (3A 08 - Farms)||