GRFSpecs - User contributions [en-gb]

TracktypeLabels

2018-09-07T10:23:30Z

Oberhümer:

This page lists existing rail type labels.

== Default rail type labels ==
These labels are used for the trains and tracks in the base game, as well as for train sets that are not rail-type-aware. Consequently, track NewGRFs should always override their properties, or at least make their tracks compatible to them.

{| class="wikitable"
|-
!'''Label'''
!'''Rail Type'''
|-
|RAIL
|Normal rail
|-
|ELRL
|electrified rail
|-
|MONO
|Monorail tracks
|-
|MGLV
|Maglev tracks
|}

== Standardized Rail Type Scheme ==
Several members of the TT Forums have collaborated to define a rail type label scheme that allows for compatibility between train and track sets by different authors. At the same time it allows fancy stuff like axle weight limits, speed limits, different track and electrification types, etc. It is strongly encouraged to follow this scheme in train and track NewGRFs.

See [[Standardized Railtype Scheme]].

== Non-standard railtype labels ==

The following labels were defined before the adoption of the Standardized Rail Type Scheme. They should no longer be used nor supported, and recent versions of the respective NewGRFs generally have dropped them.

{| class="wikitable"
|-
!'''Label'''
!'''Rail Type'''
!'''Notes'''
|-
|_040
|speed limit 40 km/h
|Slowrails, SwedishRails
|-
|_080
|speed limit 80 km/h
|Slowrails, SwedishRails
|-
|E040
|speed limit 40 km/h, with catenary
|Slowrails, SwedishRails
|-
|E080
|speed limit 80 km/h, with catenary
|Slowrails, SwedishRails
|-
|3RDR
|Tracks with third rail
|MetroTracks, NuTracks, UK Railway Set tracks, Japanese Track Set
|-
|3RDC
|Tracks with third rail and catenary
|MetroTracks, NuTracks, UK Railway Set tracks, Japanese Track Set
|-
|RLOW
|Low speed tracks
|NuTracks, SwedishRails, Japanese Track Set
|-
|ELOW
|Low speed tracks with catenary
|NuTracks, SwedishRails, Japanese Track Set
|-
|3LOW
|Low speed tracks with 3rd rail
|NuTracks,
|-
|CLOW
|Low speed tracks, 3rd rail and catenary
|NuTracks
|-
|RMED
|Medium speed tracks
|NuTracks, SwedishRails
|-
|EMED
|Medium speed tracks with catenary
|NuTracks, SwedishRails
|-
|3MED
|Medium speed tracks with 3rd rail
|NuTracks
|-
|CMED
|Medium speed tracks, 3rd rail and catenary
|NuTracks
|-
|RHIG
|High speed tracks
|NuTracks, SwedishRails, Japanese Track Set
|-
|EHIG
|High speed tracks with catenary
|NuTracks, SwedishRails, Japanese Track Set
|-
|HSTR
|Very high speed tracks with catenary
|NuTracks, SwedishRails, Japanese Track Set
|-
|NGRL
|Narrow gauge tracks
|Narrow Gauge Track Types, Japanese Track Set
|-
|ELNG
|Narrow gauge tracks with catenary
|Narrow Gauge Track Types, Japanese Track Set
|-
|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 plain landscape 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
|-
|NAAN
|Narrow gauge, unelectrified
|French Set Rails
|-
|NAAE
|Narrow gauge, catenary powered
|French Set Rails
|-
|NAA3
|Narrow gauge, third-rail powered
|French Set Rails
|-
|NRAN
|Narrow gauge, unelectrified, rack rail
|French Set Rails
|-
|NRAE
|Narrow gauge, catenary powered, rack rail
|French Set Rails
|-
|NBAN
|Narrow gauge, unelectrified, high speed
|French Set Rails
|-
|NLOW
|Low speed narrow gauge tracks
|Japanese Track Set
|-
|ENLW
|Low speed narrow gauge tracks with catenary
|Japanese Track Set
|-
|ENHI
|Modern narrow gauge tracks with catenary
|Japanese Track Set
|-
|RLA0
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 60 km/h
|xUSSR train set
|-
|RLA1
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 100 km/h
|xUSSR train set
|-
|RLA2
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 140 km/h
|xUSSR train set
|-
|RLA3
|Broad (1520 mm) gauge unelectrified tracks. Speed limit 250 km/h
|xUSSR train set
|-
|ERD1
|Broad (1520 mm) gauge tracks with generic DC catenary 3kV. Speed limit 100 km/h
|xUSSR train set
|-
|ERD2
|Broad (1520 mm) gauge tracks with generic DC catenary 3kV. Speed limit 140 km/h
|xUSSR train set
|-
|ERD3
|Broad (1520 mm) gauge tracks with generic DC catenary 3kV. Speed limit 250 km/h
|xUSSR train set
|-
|ERA1
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. Speed limit 100 km/h
|xUSSR train set
|-
|ERA2
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. Speed limit 140 km/h
|xUSSR train set
|-
|ERA3
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. Speed limit 250 km/h
|xUSSR train set
|-
|ERA4
|Broad (1520 mm) gauge tracks with generic AC catenary 25kV. No speed limit
|xUSSR train set
|-
|ER2S
|Broad (1520 mm) gauge tracks with AC/DC catenary 25kV/3kV. Speed limit 120 km/h
|xUSSR train set
|-
|WGWY
|Wagonway
|Early Rails set
|-
|LIHT
|Light Rails
|Early Rails set
|-
|TYTX
|ToyTrax
|ToyTrax
|-
|ELTX
|ElecTrax
|ToyTrax
|}

NML:Spriteset

2014-11-01T15:04:21Z

Oberhümer:

{{NMLNavBlocksyntax}}

A spriteset associates a name with a number piece of an existing image file and describes the offsets with respect to some origin the graphics will be painted within the game. Different features and situations require that a single set has a certain amount of actual sprites associated. E.g. a vehicle usually requires eight sprites in order to provide on view for each of the eight possible ingame orientations of a vehicle.

spriteset (<spriteset-name>[, <image-file>]) {
[[NML:Realsprites|list of realsprites]]
...
}

Parameter <spriteset-name> specifies the name of this spriteset. This name is used to refer to the spriteset later on.

Parameter two <image-file> (optional) is a literal (quoted) string that specifies the default file where the sprites are located. This may be overridden per-sprite (see [[NML:Realsprites|Real sprites]]).

Each sprite may be prefixed with a label, see [[NML:Spritelayout#Sprite| sprite layouts]] for more info. Example:

<pre style="color:blue">
some_label: [... real sprite ...]
</pre>

How to use a sprite set depends on the feature:

* For canals, cargos, airports (not tiles!) and railtypes, you can refer to sprite sets directly from the graphics block, or use intermediate (random)switches to make a descision.
* For vehicles, the same as above is possible. However, to facilitate the common case of having multiple loading stages, you can also define [[NML:Spritegroup|sprite groups]], see below. These sprite groups are then used in place of a single sprite set.
* Stations, houses, industry tiles, objects and airport tiles all define the look of a tile. This often requires more than one sprite, for example a concrete ground sprite with a building sprite on top of it. To combine and arrange these sprites a [[NML:Spritelayout|sprite layout]] is used, directly referring to sprite sets is not possible here
* Features not mentioned here have no use for sprite sets, as such they are not supported by NML.

Action11

2012-07-06T17:25:35Z

Oberhümer: /* number */

==Introduction==
{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 57}}

This action allows the definition of binary included sound samples.

Action 11 may only appear at most once per .grf file.
The newly defined sounds will be numbered consecutively, starting from 73 (49h) (numbers 0..72 represent original sounds). When you need to refer to your new sounds, you will have to use this numbering.

== Syntax ==

The data looks as follows:

<pre><sprite-number> * <length> 11 <number></pre>

{|
!Element !![[GRFActionsDetailed|Size]] !! Description
|-
|<sprite-number> ||dec ||A sequential sprite number
|-
|<length> ||dec||The total number of bytes in the action
|-
|11 ||B||Action 11
|-
|<number> ||W ||Number of binary include sprites that follow
|}

== Description ==

=== sprite-number ===

The current sprite number.

=== length ===

The total number of bytes in this action 11.

=== number ===

This defines the number of binary include sprites that follow.

These can only be added using GRFCodec 0.9.7 or later, using the following format:

<pre>17 ** sounds/e67_horn.wav
18 ** sounds/sheep.wav</pre>

All files included this way must be 8-bit mono sound files in WAV format, PCM encoding. There are two allowed frequencies: 11025 Hz and 22050 Hz. Due to some limitations of the GRF format, the file size cannot exceed 64 kB, at least not until GRF version 8.

For those need to know or are inordinately curious, the actual encoding of a binary include is the same as a pseudosprite:

<pre><sprite-number> * <length> FF <name-len> <name> 00 <data></pre>

{|
!Element !![[GRFActionsDetailed|Size]] !! Description
|-
|<name-len> ||B ||The return value of strlen(<name>);
|-
|<name> ||S ||The name of the included file, with any leading directories stripped
|-
|00 ||B ||Null byte terminating the string (not included in size)
|-
|<data> ||V ||A byte-for-byte copy of the contents of the file
|}

== Importing sound effects from other grf files ==
{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 61}}
Since TTDPatch 2.0.1 alpha 61, it is possible to import sound effects from other grf files (or even the current file).  This does not copy the sound effect data (thus reducing memory usage), but does provide a new sound effect entry with its own action 0 properties.

This is a way of either combining useful sound effects in a single grf file and using them in several, or to duplicate sounds with different amplification or priority settings without doubling the memory usage.

The referenced grf file can be anywhere in newgrf(w).cfg and does not have to be active.  If it is not loaded, no sound will be played but that is not an error condition. This makes it possible to separate sound effects and graphics into two files, to allow people with little memory to not load the sound effects yet get working graphics.

The format of such an import sprite is the following (replacing a "**" binary sprite within the action 11 sprite block):

<pre><sprite-number> * <length> FE 00 <GRFID> <number></pre>

{|
!Element !![[GRFActionsDetailed|Size]] !! Description
|-
|<sprite-number> ||dec ||A sequential sprite number
|-
|<length> ||dec||The total number of bytes in the action
|-
|FE ||B ||Code to identify a non-binary sprite in an action 11 block
|-
|00 ||B ||Code to identify a sound effect import
|-
|<GRFID> ||D ||GRFID of grf file to import sound effect from, may be the current one too
|-
|<number> ||W ||Sound effect number to import
|}

Note that unlike most other reference to sound numbers, the number here is simply the number within the referenced grf file's action 11 block, and does not refer to TTD's samples for numbers 0..72. Also, when importing the sound effect, the action 0 properties are not imported and have to be set separately.

== Example ==

Look at this tt-forums-page for how to add sounds to a train: [http://www.tt-forums.net/viewtopic.php?f=26&t=5033&p=735013#p735013]

PalettesAndCoordinates

2012-02-14T02:47:48Z

Oberhümer: /* Palettes */

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

Palette files for a number of graphics programmes are available on the [http://dev.openttdcoop.org/documents/1 DevZone]

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. Do use the DOS palette as it contains some additional colours and is easier to work with (all grays in one line).

[[File:windowspal.png]]
[[File:dospal.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 '''pink''' colours like the ones marked "WinAPI" in the Windows palette.
The '''Pure White''' at the bottom right of each palette is a palette colour, but you shouldn't use it in graphics; instead use the "almost white" from index 0x0F instead (colour code #FCFCFC). Use pure white for the background of your sprite sheet; [[GRFCodec]] and [[NML]] will issue a warning if a sprite containes pure white pixels. This warning is useful as it lets you know that the code referencing a sprite has the wrong position or size defined, but not so useful if your sprite actually contains pure white pixels.

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 [[ttwiki:George|George]], of the shades of player colours that will be used:

[[File:playercolours.png]]

The "Company 2" range is normally not a special colour range, but since TTDPatch 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:

[[File:TTD_Palettes.png]]

== Coordinates ==

TTD internally uses a pseudo-3D or [http://en.wikipedia.org/wiki/2.5D 2.5D engine], which uses an [http://en.wikipedia.org/wiki/Isometric_graphics_in_video_games isometric projection] to display graphics on a 2D screen. The graphics engine uses so-called "bounding boxes" for each sprite, which are 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:

[[File: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.

PalettesAndCoordinates

2012-02-14T02:47:26Z

Oberhümer: /* Palettes */

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

Palette files for a number of graphics programmes are available on the [http://dev.openttdcoop.org/documents/1 DevZone]

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. Do use the DOS palette as it contains a handful of additional colours over the Windows palette, and is easier to work with (all grays in one line).

[[File:windowspal.png]]
[[File:dospal.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 '''pink''' colours like the ones marked "WinAPI" in the Windows palette.
The '''Pure White''' at the bottom right of each palette is a palette colour, but you shouldn't use it in graphics; instead use the "almost white" from index 0x0F instead (colour code #FCFCFC). Use pure white for the background of your sprite sheet; [[GRFCodec]] and [[NML]] will issue a warning if a sprite containes pure white pixels. This warning is useful as it lets you know that the code referencing a sprite has the wrong position or size defined, but not so useful if your sprite actually contains pure white pixels.

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 [[ttwiki:George|George]], of the shades of player colours that will be used:

[[File:playercolours.png]]

The "Company 2" range is normally not a special colour range, but since TTDPatch 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:

[[File:TTD_Palettes.png]]

== Coordinates ==

TTD internally uses a pseudo-3D or [http://en.wikipedia.org/wiki/2.5D 2.5D engine], which uses an [http://en.wikipedia.org/wiki/Isometric_graphics_in_video_games isometric projection] to display graphics on a 2D screen. The graphics engine uses so-called "bounding boxes" for each sprite, which are 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:

[[File: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.

PalettesAndCoordinates

2012-02-14T02:46:56Z

Oberhümer:

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

Palette files for a number of graphics programmes are available on the [http://dev.openttdcoop.org/documents/1 DevZone]

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. Do use the DOS palette as it contains a handful of additional colours over the Windows palette.

[[File:windowspal.png]]
[[File:dospal.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 '''pink''' colours like the ones marked "WinAPI" in the Windows palette.
The '''Pure White''' at the bottom right of each palette is a palette colour, but you shouldn't use it in graphics; instead use the "almost white" from index 0x0F instead (colour code #FCFCFC). Use pure white for the background of your sprite sheet; [[GRFCodec]] and [[NML]] will issue a warning if a sprite containes pure white pixels. This warning is useful as it lets you know that the code referencing a sprite has the wrong position or size defined, but not so useful if your sprite actually contains pure white pixels.

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 [[ttwiki:George|George]], of the shades of player colours that will be used:

[[File:playercolours.png]]

The "Company 2" range is normally not a special colour range, but since TTDPatch 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:

[[File:TTD_Palettes.png]]

== Coordinates ==

TTD internally uses a pseudo-3D or [http://en.wikipedia.org/wiki/2.5D 2.5D engine], which uses an [http://en.wikipedia.org/wiki/Isometric_graphics_in_video_games isometric projection] to display graphics on a 2D screen. The graphics engine uses so-called "bounding boxes" for each sprite, which are 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:

[[File: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.

VariationalAction2/Vehicles

2012-02-08T16:29:54Z

Oberhümer: /* Variables */

<div style="float:right; padding-left:12px; background:none;">{{NFONavVehicles}}</div>

==Introduction==

== Variables ==

{|
!Variable!![[GRFActionsDetailed|Size]]!!Version!!Description!!Available in purchase list
|+
|40||D||{{ottdp|0.6|2.5}}||Position in consist and length of consist||no
|+
|41||D||{{ottdp|0.6|2.5}}||Position in and length of chain of consecutive vehicles with same ID||no
|+
|42||D||{{ottdp|0.6|2.5}}||Cargo types transported by consist||no
|+
|43||D||{{ottdp|0.6|2.5}}||Player info||{{ottdp|0.6|2.5|ottdrev=r4611|ttdprev=beta 2}}
|+
|44||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 48}}||Aircraft info||no
|+
|45||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 58}}||Curvature info||no
|+
|46||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 59}}||Motion counter||no
|+
|47||D||{{ottdp|0.6|2.5}}||Vehicle cargo info||{{ottdp|0.7|no|ottdrev=r15542}} <ref name="var47">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.</ref>
|+
|48||D||{{ottdp|0.6|2.5}}||Vehicle type information||{{ottdp|0.6|2.5|ottdrev=r5338|ttdprev=beta 2}}
|+
|49||D||{{ottdp|0.7|2.6|ottdrev=r13376|ttdprev=r2216}}||Year of construction (long format, 0 based)||{{ottdp|0.7|no|ottdrev=r13376}} <ref name="date">This is the current date</ref>
|+
|4A||D||{{ottdp|1.1|no|ottdrev=r20165}}||Info about current rail type for trains||no
|+
|4B||D||{{ottdp|1.2|no|ottdrev=r23068}}||Long date of last servicing||{{ottdp|1.2|no|ottdrev=r23068}} <ref name="date" />
|+
|60||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 57}}||Count Veh.ID occurence||no
|+
|61||-<ref>The size of the result matches the size of the queried variable.</ref>||{{ottdp|1.2|no|ottdrev=r22997}}||Query variable of n-th vehicle in chain||no
|+
|62||D||{{ottdp|1.2|no|ottdrev=r22998}}||Curvature/position difference for n-th vehicle in chain||no
|+
|97||B||{{ottdp|0.6|2.0}}||Tick counter, increased every engine tick||no
|+
|B2||W||||Vehicle status: bit0 = vehicle invisible (in tunnel/depot), bit1 = stopped, bit7 = crashed||no
|+
|B4||W||{{ottdp|0.6|2.0}}||Current speed. Note, units differ for each vehicle type<ref>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]].</ref>||no
|+
|B9||B||{{ottdp|0.6|2.0}}||Cargo type (type B from the list at [[CargoTypes]]; climate dependent)||no
|+
|C0||W||{{ottdp|0.6|2.0}}||Engine age in days<br/>{{ottdp|1.2|2.5|ottdrev=r22816|ttdprev=alpha 61}} Valid for wagons and articulated parts as well.||no
|+
|C4||B||{{ottdp|0.6|2.0}}||Year built (counted from 1920), note this is modified when Cht: Year is used||{{ottdp|0.6|no|ottdrev=r4611}} <ref name="date" />
|+
|C6||W||{{ottdp|0.6|2.0}}||Vehicle type ID <ref>{{ottdp|0.7|no}} In OpenTTD 0.7 and newer this is the GRF-local ID of the vehicle. Earlier versions of OpenTTD and TTDPatch report the [[VehicleIDs|TTD ID]]. For trains this is the same; for other vehicle types they differ.</ref> (useful for [[Callbacks#Can wagon be attached (1D)|Callback 1D]])||no
|+
|C8||B||{{ottdp|0.6|2.0}}||Sprite type; FD for trains forward, FE or FF when reversed||no
|+
|C9||B||{{ottdp|0.6|2.0}}||Day counter; increased daily||no
|+
|DA||W||{{ottdp|0.6|2.0}}||Next wagon index, FFFF if last wagon (use shift-num=08 and check for FF)||no
|+
|F2||B||{{ottdp|0.6|2.5}}||Refit cycle, how many times refitted to the same cargo type||{{ottdp|0.7|no|ottdrev=r15542}} <ref name="var47" />
|+
|FE||W||{{ottdp|0.6|2.5}}||Modflags||no
|+
|FF||B||{{ottdp|0.6|2.5}}||Modflags||no
|}

<references />

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.

== Description ==
=== 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):

[[File:vehicle_var40_41.png]]

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
|}

If used with VarAction2 type 81 (vehicle) it returns only cargo from this vehicle on, with type 82 (engine) that of the whole consist.
See also variable 47 for more details on the cargo carried by a vehicle.

{{grf|7}} For GRF versions 7 and before "cc" is the untranslated bit number from [[Action0/Cargos#Bit_number_for_bitmasks_.2808.29|cargo property 8]].

{{grf|8}} With GRF version 8 the meaning of "cc" changes. If the grf file has installed a [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]], the value in "cc" is the index of the cargo in that table; or FF if the cargo is not present in the table.

=== 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||{{ottdp|0.6|2.5|ttdprev=r1405}} 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||{{ottdp|no|2.5}} Player is a human managing an AI company
|-
|3||{{ottdp|no|2.5}} Player is human player's original company, now temporarily AI controlled
|}

{{ottdp|0.6|2.5|ttdprev=r1497}} 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

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

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

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 VarAction2 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 [[Action0/Global_Settings#Cargo_translation_table_.2809.29|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.

=== Information about current rail type for trains (4A) ===

'''Format:''' xxxxFFrr

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

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 VarAction2 type 81, only the current vehicle and onwards will be check, with VarAction2 type 82, all vehicles in the consist will be counted.

=== Query variable of n-th vehicle in chain (61) ===

This is a special variable to get the contents of another variable of a different vehicle in the vehicle chain. It is only supported for trains and road vehicles. It is not supported during a callback that is used to modify vehicle properties to avoid circular dependencies, which currently limits this variable to callbacks 1D, 31 and 32 plus outside callback scope.

Temporary register 10F is interpreted as a signed integer and specifies the offset in the chain from the current vehicle. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.

The 60+x parameter specifies the variable to access and temporary register 10E is passed as the new 60+x parameter. Passing 61 as the variable is not allowed. Currently only vehicle specific variables listed on this page plus global variable 25 are accessible through var 61. Esp. variable 5F is currently not supported.

The resulting value will have the size of whatever variable is queried.

=== Curvature/position difference for n-th vehicle in chain (62) ===

'''Format:''' zzyyxxFD

This variable is only supported for trains and road vehicles.

The 60+x parameter is interpreted as a signed integer and specifies the offset in the chain from the current vehicle. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.

The lowest nibble (D) contains the direction difference between the selected vehicle and this vehicle, the possible values are identical to those of [[#Curvature_info_.2845.29|variable 45]].

The next nibble (F) has the following meaning:
{| |-
!Bit!!Value!!Meaning
|-
|3||8||The vehicle is currently hidden
|}

The upper three bytes contain the signed difference of the X/Y/Z position between the selected vehicle and this vehicle.

=== Modflags (FE and FF) ===

The bits in FE mostly relate to gradualloading.  A few useful bits for grf authors are;

{| |-
!Bit!!Version!!Value of the bit
|-
|5||{{ottdp|0.6|2.5}}||Vehicle is powered (engine or powered wagon, mainly useful for the latter)
|-
|6||{{ottdp|0.6|2.5}}||Vehicle would be powered (engine or powered wagon) if there were suitable track. (E.g. electric train in mixed train on normal track)
|-
|8 <ref>This bit is only accurate for the first vehicle in the consist.</ref>||{{ottdp|0.6|2.5}}||This bit is flipped every time the train reverses direction
|-
|10||{{ottdp|0.6|2.5|ttdprev=r1334}}||Vehicle was built during the exclusive preview
|}
<references/>

variable FF is actually the high byte of variable FE, so FE bit 8 is the same as FF bit 0.

Other bits are reserved; most are actually used for TTDPatch internal states.

==Examples==

Main Page

2012-01-28T23:41:11Z

Oberhümer: /* Make some descriptions more understandable

== Sprite types ==
;[[Action0]] - Defines new properties for anything added or changed by the NewGRF
:{| |-
|rowspan="4" align="center" style="width:3em"|'''0'''
| [[Action0/Vehicles | Vehicles]]
| [[Action0/Vehicles/Trains | Trains]]
| [[Action0/Vehicles/RoadVehicles | RoadVehicles]]
| [[Action0/Vehicles/Ships | Ships]]
| [[Action0/Vehicles/Planes | Aircraft]]
|-
| [[Action0/Stations | Stations]]
| [[Action0/Canals | Canals & Rivers]]
| [[Action0/Bridges | Bridges]]
| [[Action0/Houses | Houses]]
| [[Action0/Global Settings | Global Settings]]
|-
| [[Action0/Industry Tiles | Industry Tiles]]
| [[Action0/Industries | Industries]]
| [[Action0/Cargos | Cargos]]
| [[Action0/Sound Effects | Sound Effects]]
| [[Action0/Airports | Airports]]
|-
| ''Signals''
| [[Action0/Objects | Objects]]
| [[Action0/Railtypes | Railtypes]]
| [[Action0/Airport Tiles | Airport Tiles]]
| ''Towns''
|}
;[[Action1]] - Defines one or more graphics sets
;[[Action2]] - Defines graphics set IDs
* Basic Action2
:{| |-
|rowspan="4" align="center" style="width:3em"|'''2'''
|colspan=5| [[Action2/Vehicles | Vehicles]]
|-
| [[Action2/Stations | Stations]]
| [[Action2/Single Set | Canals & Rivers]]
| ''Bridges''
| [[Action2/Sprite Layout | Houses]]
| ''Global Settings''
|-
| [[Action2/Sprite Layout | Industry Tiles]]
| [[Action2/Industries | Industries]]
| [[Action2/Single Set | Cargos]]
| [[Action2/Only Callback Failure | Sound Effects]]
| [[Action2/Single Set | Airports]]
|-
| [[Action2/Only Callback Failure | Signals]]
| [[Action2/Sprite Layout | Objects]]
| [[Action2/Single Set | Railtypes]]
| [[Action2/Sprite Layout | Airport Tiles]]
| ''Towns''
|}
* [[VariationalAction2]] - A conditional switch that determines a [[Callbacks|callback]] result or chains to another Action 2
: [[VarAction2Advanced]] - Advanced features of Variational Action 2
: [[GlobalVariables | Global Variables]]
:{| |-
|rowspan="4" align="center" style="width:3em"|'''VA2'''
|colspan=5| [[VariationalAction2/Vehicles | Vehicles]]
|-
| [[VariationalAction2/Stations | Stations]]
| [[VariationalAction2/Canals | Canals & Rivers]]
| [[VariationalAction2/Bridges | Bridges]]
| [[VariationalAction2/Houses | Houses]]
| ''Global Settings''
|-
| [[VariationalAction2/Industry Tiles | Industry Tiles]]
| [[VariationalAction2/Industries | Industries]]
| [[VariationalAction2/Cargos | Cargos]]
| ''Sound Effects''
| [[VariationalAction2/Airports | Airports]]
|-
| [[VariationalAction2/Signals | Signals]]
| [[VariationalAction2/Objects | Objects]]
| [[VariationalAction2/Railtypes | Railtypes]]
| [[VariationalAction2/Airport Tiles | Airport Tiles]]
| [[VariationalAction2/Towns | Towns]]
|}
* [[RandomAction2]] - A randomized Variational Action 2
:{| |-
|rowspan="4" align="center" style="width:3em"|'''R'''
|colspan=5| [[RandomAction2#Vehicles | Vehicles]]
|-
| [[RandomAction2#Stations | Stations]]
| [[RandomAction2#Canals | Canals & Rivers]]
| ''Bridges''
| [[RandomAction2#Town_building_triggers | Houses]]
| ''Global Settings''
|-
| [[RandomAction2#Industry_tile_triggers | Industry Tiles]]
| [[RandomAction2#Industry_tile_triggers | Industries]]
| ''Cargos''
| ''Sound Effects''
| [[RandomAction2#Stations | Airports]]
|-
| ''Signals''
| [[RandomAction2#Objects | Objects]]
| [[RandomAction2#Rail_types | Railtypes]]
| [[RandomAction2#Stations | Airport Tiles]]
| ''Towns''
|}

* [[Callbacks]] - List of available callbacks

;[[Action3]] - Associates Action 2s with an Action 0
:{| |-
|rowspan="4" align="center" style="width:3em"|'''3'''
|colspan=5| [[Action3 | Vehicles]]
|-
| [[Action3 | Stations]]
| [[Action3/Canals | Canals & Rivers]]
| ''Bridges''
| [[Action3 | Houses]]
| ''Global Settings''
|-
| [[Action3 | Industry Tiles]]
| [[Action3 | Industries]]
| [[Action3 | Cargos]]
| [[Action3 | Sound Effects]]
| [[Action3 | Airports]]
|-
| [[Action3 | Signals]]
| [[Action3 | Objects]]
| [[Action3/Railtypes | Railtypes]]
| [[Action3 | Airport Tiles]]
| ''Towns''
|}
: [[Action3LiveryOverride]] - Change wagon livery to match the engine
;[[Action4]] - Defines text strings
;[[Action5]] - Replaces base set sprites not present in the original TTD.
;[[Action6]] - Modifies the contents of the following sprite
;[[Action7]] - Conditionally skips sprites or jumps to a label
: [[TTDPatchFlags| GameConfigFlags]] - Configuration flags for Action 7/9 Variable 85
;[[Action8]] - Defines GRFID, Name and Description
;[[Action9]] - (see action 7 above)
;[[ActionA]] - Replaces TTD base set sprites
;[[ActionB]] - Generates an error message
;[[ActionC]] - Does nothing (can be used to embed comments)
;[[ActionD]] - Assigns parameters and calculates results
* [[ReadingOtherGRFParameters]] - Reading another GRF file's parameters
* [[ReadingPatchVariables| ReadingGameSettings]] - Reading game configuration settings
* [[GRFResourceManagement]] - Preventing conflicts with limited resources
;[[ActionE]] - Deactivates a NewGRF file
;[[ActionF]] - Defines new town name styles
;[[Action10]] - Defines a label for action 7/9
;[[Action11]] - Defines new sounds
;[[Action12]] - Adds Unicode font glyphs
;[[Action13]] - Translates GRF-specific strings
;[[Action14]] - Static NewGRF information (OpenTTD only)
;[[RealSprites]] - Sprites that actually are drawn on the screen
;[[RecolorSprites]] - Changing other sprites' colors

== Graphics properties ==
* [[PalettesAndCoordinates#Palettes | Palettes]] - Palettes used by the game
* [[PalettesAndCoordinates#Coordinates | Coordinates]] - Coordinates used for sprite alignement

== TTD defaults ==
* [[DefaultHouseProps]] - Default property values for TTD's houses
* [[IndustryTileDefaultProps]] - Default property values for TTD's industry tiles
* [[IndustryDefaultProps]] - Default properties values for TTD's industries
* [[CargoDefaultProps]] - Default property values for TTD's cargo types
* [[VehicleIDs]] - Default vehicle IDs
* [[AirportTypes]] - Default Airport IDs
* [[AirportTileDefaultProps]] - Default airport tile properties

== NewGRF commons ==
* [[Action0Cargos#CargoClasses_.2816.29 | Cargo classes]] - Commonly used cargo classes
* [[CargoTypes | Cargo labels]] - Commonly used cargo labels
* [[ObjectLabels | Object classes]] - Commonly used object clases
* [[RailtypeLabels | Railtype labels]] - Commonly used railtype labels

== Misc ==
* [[Features]] - List of all features and feature-specific actions.
* [[BaseCosts | Base Costs]]
* [[VehicleRefitting | Vehicle Refitting]]
* [[GrfLoadingStages | GRF loading stages]]
* [[GlobalVariables | Global variables]]
* [[Storages | Storages]]
* [[StringCodes | String control codes]]
* [[TextIDs | Text IDs (TTD + TTDPatch + NewGRF defined)]]
* [[GRFActionsDetailed | Syntax details]]
* [[DebuggingGRFCode | Debugging NewGRFs]]
* [[SpriteErrors | TTDPatch error codes on loading NewGRFs]]

== Game mechanics ==
* [[TownZones | Town zones]]
* [[NMLMain | NML]]

TracktypeLabels

2012-01-06T14:46:57Z

Oberhümer:

The following railtype labels have been defined so far:

{| class="wikitable"
|-
!'''Label'''
!'''Rail Type'''
!'''Notes'''
|-
| align="center" colspan="3" | OpenTTD Default Railtypes
|-
|RAIL
|Normal rail
|
|-
|ELRL
|electrified rail
|
|-
|MONO
|Monorail tracks
|
|-
|MGLV
|Maglev tracks
|
|-
| align="center" colspan="3" | New Railtypes
|-
|_040
|speed limit 40 km/h
|Slowrails, SwedishRails
|-
|_080
|speed limit 80 km/h
|Slowrails, SwedishRails
|-
|E040
|speed limit 40 km/h, with catenary
|Slowrails, SwedishRails
|-
|E080
|speed limit 80 km/h, with catenary
|Slowrails, SwedishRails
|-
|3RDR
|Tracks with third rail
|MetroTracks, NuTracks, UK Railway Set tracks
|-
|3RDC
|Tracks with third rail and catenary
|MetroTracks, NuTracks, UK Railway Set tracks
|-
|RLOW
|Low speed tracks
|NuTracks, SwedishRails
|-
|ELOW
|Low speed tracks with catenary
|NuTracks, SwedishRails
|-
|3LOW
|Low speed tracks with 3rd rail
|NuTracks,
|-
|CLOW
|Low speed tracks, 3rd rail and catenary
|NuTracks
|-
|RMED
|Medium speed tracks
|NuTracks, SwedishRails
|-
|EMED
|Medium speed tracks with catenary
|NuTracks, SwedishRails
|-
|3MED
|Medium speed tracks with 3rd rail
|NuTracks
|-
|CMED
|Medium speed tracks, 3rd rail and catenary
|NuTracks
|-
|RHIG
|High speed tracks
|NuTracks, SwedishRails
|-
|EHIG
|High speed tracks with catenary
|NuTracks, SwedishRails
|-
|HSTR
|Very high speed tracks with catenary
|NuTracks, SwedishRails
|-
|NGRL
|Narrow gauge tracks
|Narrow Gauge Track Types, Japanese Track Set
|-
|ELNG
|Narrow gauge tracks with catenary
|Narrow Gauge Track Types, Japanese Track Set
|-
|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 plain landscape 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
|-
|FRNN
|Metric gauge
|French Set Rails
|-
|FRCN
|Metric gauge, catenary powered
|French Set Rails
|-
|FR3N
|Metric gauge, third-rail powered
|French Set Rails
|-
|FRNR
|Metric gauge, rack rail
|French Set Rails
|-
|FRCR
|Metric gauge, catenary powered, rack rail
|French Set Rails
|-
|FMGV
|Metric gauge, high speed
|French Set Rails
|}

TracktypeLabels

2011-11-24T18:58:29Z

Oberhümer:

The following railtype labels have been defined so far:

{| class="wikitable"
|-
!'''Label'''
!'''Rail Type'''
!'''Notes'''
|-
| align="center" colspan="3" | OpenTTD Default Railtypes
|-
|RAIL
|Normal rail
|
|-
|ELRL
|electrified rail
|
|-
|MONO
|Monorail tracks
|
|-
|MGLV
|Maglev tracks
|
|-
| align="center" colspan="3" | New Railtypes
|-
|_040
|speed limit 40 km/h
|Slowrails, SwedishRails
|-
|_080
|speed limit 80 km/h
|Slowrails, SwedishRails
|-
|E040
|speed limit 40 km/h, with catenary
|Slowrails, SwedishRails
|-
|E080
|speed limit 80 km/h, with catenary
|Slowrails, SwedishRails
|-
|3RDR
|Tracks with third rail
|MetroTracks, NuTracks, UK Railway Set tracks
|-
|3RDC
|Tracks with third rail and catenary
|MetroTracks, NuTracks, UK Railway Set tracks
|-
|RLOW
|Low speed tracks
|NuTracks, SwedishRails
|-
|ELOW
|Low speed tracks with catenary
|NuTracks, SwedishRails
|-
|3LOW
|Low speed tracks with 3rd rail
|NuTracks,
|-
|CLOW
|Low speed tracks, 3rd rail and catenary
|NuTracks
|-
|RMED
|Medium speed tracks
|NuTracks, SwedishRails
|-
|EMED
|Medium speed tracks with catenary
|NuTracks, SwedishRails
|-
|3MED
|Medium speed tracks with 3rd rail
|NuTracks
|-
|CMED
|Medium speed tracks, 3rd rail and catenary
|NuTracks
|-
|RHIG
|High speed tracks
|NuTracks, SwedishRails
|-
|EHIG
|High speed tracks with catenary
|NuTracks, SwedishRails
|-
|HSTR
|Very high speed tracks with catenary
|NuTracks, SwedishRails
|-
|NGRL
|Narrow gauge tracks
|NuTracks, Narrow Gauge Track Types, Japanese Track Set
|-
|ELNG
|Narrow gauge tracks with catenary
|NuTracks, Narrow Gauge Track Types, Japanese Track Set
|-
|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 plain landscape 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
|-
|FRNN
|Metric gauge
|French Set Rails
|-
|FRCN
|Metric gauge, catenary powered
|French Set Rails
|-
|FR3N
|Metric gauge, third-rail powered
|French Set Rails
|-
|FRNR
|Metric gauge, rack rail
|French Set Rails
|-
|FRCR
|Metric gauge, catenary powered, rack rail
|French Set Rails
|-
|FMGV
|Metric gauge, high speed
|French Set Rails
|}

TracktypeLabels

2011-11-24T18:52:55Z

Oberhümer:

The following railtype labels have been defined so far:

{| class="wikitable"
|-
!'''Label'''
!'''Rail Type'''
!'''Notes'''
|-
| align="center" colspan="3" | OpenTTD Default Railtypes
|-
|RAIL
|Normal rail
|
|-
|ELRL
|electrified rail
|
|-
|MONO
|mono rail
|
|-
|MGLV
|maglev rail
|
|-
| align="center" colspan="3" | New Railtypes
|-
|_040
|speed limit 40 km/h
|Slowrails, SwedishRails
|-
|_080
|speed limit 80 km/h
|Slowrails, SwedishRails
|-
|E040
|speed limit 40 km/h, electrified
|Slowrails, SwedishRails
|-
|E080
|speed limit 80 km/h, electrified
|Slowrails, SwedishRails
|-
|3RDR
|third rail
|MetroTracks, NuTracks, UK Railway Set tracks
|-
|3RDC
|third rail and catenary
|MetroTracks, NuTracks, UK Railway Set tracks
|-
|RLOW
|Low speed rails
|NuTracks, SwedishRails
|-
|ELOW
|Low speed rails, Catenary
|NuTracks, SwedishRails
|-
|3LOW
|Low speed 3rd rails
|NuTracks,
|-
|CLOW
|Low speed 3rd rails, Catenary
|NuTracks
|-
|RMED
|Medium speed rails
|NuTracks, SwedishRails
|-
|EMED
|Medium speed rails, Catenary
|NuTracks, SwedishRails
|-
|3MED
|Medium speed 3rd rails
|NuTracks
|-
|CMED
|Medium speed 3rd rails, Catenary
|NuTracks
|-
|RHIG
|High speed rails
|NuTracks, SwedishRails
|-
|EHIG
|High speed rails, Catenary
|NuTracks, SwedishRails
|-
|HSTR
|Very high speed track, Catenary
|NuTracks, SwedishRails
|-
|NGRL
|Narrow gauge tracks
|NuTracks, Narrow Gauge Track Types, Japanese Track Set
|-
|ELNG
|Electrified narrow gauge tracks
|NuTracks, Narrow Gauge Track Types, Japanese Track Set
|-
|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
|-
|FRNN
|Metric gauge
|French Set Rails
|-
|FRCN
|Metric gauge, catenary powered
|French Set Rails
|-
|FR3N
|Metric gauge, third-rail powered
|French Set Rails
|-
|FRNR
|Metric gauge, rackrail
|French Set Rails
|-
|FRCR
|Metric gauge, catenary powered, rackrail
|French Set Rails
|-
|FMGV
|Metric gauge, high speed
|French Set Rails
|}

NML talk:Language files

2011-08-24T15:32:48Z

Oberhümer: Created page with "This ought to show which string codes are built into NML. I can't find this information anywhere else either."

This ought to show which string codes are built into NML. I can't find this information anywhere else either.

NML:Railtypes

2011-08-24T15:26:44Z

Oberhümer: 3RDR is not a default type and the label for maglev is MGLV, as can be seen on the very page linked to

{{NMLNavPropVarCB}}

Railtypes can only be defined in OpenTTD {{ottd|1.0|r18969}} or later.

==Railtype properties==

{| class="t"
! property
! value range
! comment
|-
| label
| 4-byte string
| names of default rail types: "RAIL", "ELRL", "MONO", "MGLV". See the [[RailtypeLabels|List of railtype labels]] in the NewGRF Specs for currently defined custom labels.
|-
| introduction_date
| date(yyyy,mm,dd)
|
{{ottd|1.1|r21842}} Valid range for yyyy is 0 ... 5000000.
|-
| name
| string
| Caption of the build rail toolbar
|-
| menu_text
| string
| Shown in the dropdown menu for all railtypes
|-
| build_window_caption
| string
| Caption of the build vehicle window
|-
| autoreplace_text
| string
| String for the autoreplace window
|-
| new_engine_text
| string
| String for the "We have invented a new <rail type> engine" news message
|-
| compatible_railtype_list
| list of railtype labels
| Provide a list of rail types that trains of this type can also run on. e.g. ["RAIL", "ELRL", "MONO"]
|-
| powered_railtype_list
| list of railtype labels
| Provide a list of rail types that trains of this type are powered on.
|-
| railtype_flags
| bitmask(RAILTYPE_FLAG_XXX, ...)
| XXX = [CATENARY|NO_LEVEL_CROSSING] Flags enable catenary and/or disable level crossings.
|-
| curve_speed_multiplier
| 0...65525
| max curve speed is defined as multiple of the base curve speed (see below)
|-
| station_graphics
| RAILTYPE_STATION_NORMAL, RAILTYPE_STATION_MONORAIL, RAILTYPE_STATION_MAGLEV
| Type of station graphics to use for the default stations
|-
| construction_cost
| 0 ... 65525
|
{{ottd|1.1|r19307}} per piece of track as multiplier to PR_BUILD_RAIL base cost.
|-
| speed_limit
| 0 ... 65525 km/h (speed units)
| A speed limit of 0 means unlimited speed
|-
| acceleration_model
| ACC_MODEL_RAIL, ACC_MODEL_MONORAIL, ACC_MODEL_MAGLEV
| ACC_MODEL_RAIL and ACC_MODEL_MONORAIL behave the same currently
|-
| map_colour
| 0 ... 255
|
{{ottd|1.1|r19307}} entry in the colour palette.
|-
| requires_railtype_list
| list of railtype labels
|
{{ottd|1.1|r21842}} List of rail types on that need to be available to the company of the player for this rail type to be introduced at (or after) the introduction date. This limit does not apply when the rail type is introduced by the introduction of a vehicle.
|-
| introduces_railtype_list
| list of railtype labels
|
{{ottd|1.1|r21841}} List of rail types that get introduced when this rail type is introduced. For example, to make sure that when a fast rail type is introduced the slow variant exists.
|-
| sort_order
| 0 ... 255
|
{{ottd|1.1|r21866}} number which defines the sort order among rail types. If this entry is not defined, it gets assigned sort order n*10+7 for the n-th railtype.
|}

===Sort order===

The sort_order influences the sort order of the drop down lists with rail types. Default values are as follows:

{| class="t"
! Value
! Meaning
|-
| 07
| normal rail
|-
| 17
| electrified rail
|-
| 27
| monorail
|-
| 37
| maglev
|-
| n7
| railtype #n
|}

Thus the rail type that (internally) gets index 8 will get a default value of 87. These defaults are to keep the ordering when this property is not supported as they were.

===Base speeds for curves===

The base speeds relevant for the curve_speed_multiplier are:

{| class="t"
! curve length
! base speed [km/h]
|-
| 0 (90 degree turn)
| 30
|-
| 1
| 44
|-
| 2
| 55
|-
| 3
| 66
|-
| 4
| 75
|-
| 5
| 84
|-
| 6
| 91
|-
| 7
| 98
|-
| 8
| 103
|-
| 9
| 108
|-
| 10
| 111
|-
| 11
| 114
|-
| 12+
| 115
|}

==Railtype variables==

{| class="t"
! name
! value range
! comment
|-
| terrain_type
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|
|-
| enhanced_tunnels
| 0
| should custom tunnel entrances be modified other values than 0 might be returned
|-
| level_crossing_status
| LEVEL_CROSSING_CLOSED, LEVEL_CROSSING_OPEN
|
|-
| build_date
| 0 .. 5000000
| for depots only: build date of the depot in days since 0
|}

==Railtype callbacks==

For rail types a number of callbacks are used to define rail type graphics. Each should refer to a sprite set containing the relevant sprites. Refer to the example railtype grf for an example on what sprites are needed in what order.

{| class="t"
! callbacks
! number of sprites
! meaning
|-
| gui
| 16
| 4 rail directions, autorail, depot, tunnel and convert rail sprites for rail menu
|-
| track_overlay*
| 10
| 6 flat and 4 slope sprites. Track without landscape
|-
| underlay*
| 16
| 6 flat and 4 slope, one crossing WITH track, 5 junction pieces without track. Tracks with foundations but without landscape
|-
| tunnels*
| 4
| 4 track sprites, one for each tunnel entrance. Only track with foundations, no landscape
|-
| catenary_wire
| 28
|
|-
| catenary_pylons
| 8
|
|-
| bridge_surfaces*
| 6
|
|-
| level_crossings*
| 10
| For each direction: one track sprite and 4 sprites for road lights etc
|-
| depot
| 6
| 2 sprites for each south-ish, 1 sprite for each north-ish depot. Like original depots.
|-
| fences
| 8
| x, y, vertical, horizontal, SW, SE, NE and NW slopes like original fences at sprite 1301
|}

The entries marked by * are required. If a non-required callback is not implemented or fails, graphics from the fallback railtype (picked via the <code style="color:darkgreen">station_graphics</code> property) will be used instead.<br /> Note that there is no "default graphics"-callback.

===Example===

A typical implementation for railtypes can look like:

<pre style="color:blue">
item(FEAT_RAILTYPES, elrail, 0x01) {
property {
label: "SHIN";
name: string(STR_EL_RAIL);
menu_text: string(STR_EL_RAIL);
build_window_caption: string(STR_BUILD_CAPTION);
autoreplace_text: string(STR_AUTOREPLACE);
new_engine_text: string(STR_NEW_ENGINE);
compatile_railtype_list: ["SHIN","RAIL","ELRL"]; // Tracks of rail and electrified rail are compatible
powered_railtype_list: ["ELRL","SHIN"]; // But we got only power when we have electricity
railtype_flags: bitmask(RAILTYPE_FLAG_NO_LEVEL_CROSSING); // High speed tracks should not have level crossings
curve_speed_multiplier: 1;
station_graphics: RAILTYPE_STATION_MAGLEV; // We want the most modern stations
construction_cost: 32; // should be pretty steep
speed_limit: 500 km/h;
acceleration_model: ACC_MODEL_RAIL; // This is still rail, though
}
graphics {
track_overlay: ground_switch_overlay; // defines the sprites drawn as overlay for junctions and highlight
underlay: ground_switch_underlay; // defines the usual tracks and the underlay for junctions
level_crossings: level_crossing_switch; // defines level crossings including traffic lights and blocking bars
tunnels: tunnel_switch; // defines the tracks drawn on a funnel tile
depots: depot_switch_electric; // defines the depot sprites
bridge_surfaces: bridge_terrain_switch; // defines the overlay drawn over bridges
fences: fences_set; // defines the look of fences
// we don't define catenery wire and pylons, thus we use the default which comes with the base graphics.
}
}
</pre>

The switches and graphics blocks are defined in the usual way as described in sections [[NML:Switch|switches]], [[NML:Random switch|random switches]] and [[NML:Graphics|graphics block]] sections.