GRFSpecs - User contributions [en-gb]

Action3

2025-12-03T08:24:58Z

Peter1138: /* Feature */

== Introduction ==

Action 3 assigns graphics sets (referenced to by (chains of) [[Action2|action 2(s]]) to feature IDs (vehicles, stations, houses, industries, ...).

== Format ==

The format of the data is feature-dependent.

The data is:

<pre> <Sprite-number> * <Length> 03 <feature> <n-id> <ids...> <num-cid> (<cargo-type> <set-ID>)... <default set-ID></pre>

{| class="wikitable"
|-
!'''Element'''
![[GRFActionsDetailed|'''Size''']]
!'''Description'''
|-
|<Sprite-number>
|dec
|A sequential sprite number
|-
|<length>
|dec
|The total number of bytes used in this action
|-
|03
|B
|Defines action 03
|-
|<feature>
|B
|What type of feature the IDs refer to
|-
|<n-id>
|B
|Number of IDs this action 3 associates graphics with
|-
|<ids...>
|B/B*
|IDs of the current feature this action 3 associates graphics with. There must be as many IDs as <n-id> specifies
|-
|<num-cid>
|B
|Number of different cargo types to support
|-
|<cargo-type>
|B
|Cargo type for which to use the following set-ID
|-
|<set-ID>
|W
|Set-ID (from action 2 or from a varaction2 chain) to use for this cargo type
|-
|<default set-ID>
|W
|Default set-ID to use if none of the above matches
|}

== Description ==

=== 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 [[Features|feature]] that you wish to change. Set it to:

{|- |
!Value!![[Features|Feature]]
|-
|00||Trains
|-
|01||Road Vehicles
|-
|02||Ships
|-
|03||Aircraft
|-
|04||Stations
|-
|05||[[Action3/Canals|Canals/Rivers]]
|-
|07||Houses
|-
|09||Industry Tiles
|-
|0A||Industries
|-
|0B||Cargos
|-
|0C||Sound Effects (generic callback only)
|-
|0D||Airports
|-
|0E||Signals (generic callback only)
|-
|0F||Objects
|-
|10||[[Action3/Railtypes|Railtypes]]
|-
|11||Airport Tiles
|-
|12||[[Action3/Roadtypes|Roadtypes]]
|-
|13||[[Action3/Tramtypes|Tramtypes]]
|-
|14||Road Stops
|-
|15||Badges
|}

=== n-id ===

How many items of the current feature this action 3 defines new graphics for. If this is more than one, all items listed will get the same graphics. If this value has bit 7 set (i.e. 80 added), it is a wagon override. See [[Action3LiveryOverride|Action 3 - Livery Override]] for more info on this feature.

You can make a definition with n-id equal to zero (and thus no ids that follow).  This creates a generic feature-specific definition not associated with any particular item.  At the moment, this is used for generic callbacks, but might be extended to other functions eventually.

=== ids ===

Feature IDs to use this action 3 for. All IDs are counted from the first of their class, i.e. the first road vehicle has 00, as does the first plane, the first ship, and the first train vehicle.

In OpenTTD since r13482, each ID is an extended byte for vehicles, otherwise the ID is a regular byte.

Since OpenTTD 14.0, each ID is an extended byte for all features.

For canals and rivers the id has a special meaning, see its [[Action3/Canals|own Action 3 page]]

For town buildings, the IDs are the house IDs, and specifying a house ID that haven't been defined before (by setting its property 08) doesn't do anything, but doesn't cause an error, either. Note that you don't necessarily have to assign a set-ID to a house ID, the old TTD sprite of the substitute type will be used if you don't do so.  Industry tile IDs work in the same manner.

=== num-cid ===

Number of cargo type definitions that follow. Can be zero if only the default follows.

For features 05 (canals/rivers), 07 (houses), 09 (industry tiles), 0A (industries), and 0B (cargoes) this must always be zero.

=== cargo-type ===

{|
|-
! Feature !! cids
|-
| 00..03 vehicles ||
* 00..FE: cargo-type (index in [[Action0/Global Settings#Cargo translation table 09|cargo translation table]]; cargobit if no table present)
* FF: purchase list <ref>For dual-headed trains (prop 13) special rules for the purchase menu sprite apply: two sprites are drawn (for front and back) as if the vehicle is normally constructed. If you supply one purchase menu sprite, it will be used for both vehicle parts in the purchase menu. Provide a set of 8 sprites, and the 7th resp. 3rd sprite will
be drawn; provide a set of 8 blank sprites except the 7th if you want to fully control a single purchase menu sprite for a dual-headed engine.</ref>
* default: used if none of the listed cids apply
|-
| 04 stations ||
* 00..FD: cargo-type (index in [[Action0/Global Settings#Cargo translation table 09|cargo translation table]]; cargobit if no table present) waiting at the station. The waiting amount of this cargo is used in [[Action2/Stations|Action2]] to decide the spriteset.
* FE: used if none of the listed cids apply. [[Action2/Stations|Action2]] will assume "zero waiting cargo".
* FF: purchase list
* default: used if none of the listed cids apply. [[Action2/Stations|Action2]] will use "sum of all waiting cargos".
|-
| 05 canals || default only
|-
| 07 houses ||
* FF: {{ottdp|15|no}} purchase list (callbacks when not constructed yet; and house picker GUI)
* default: used if none of the listed cids apply
|-
| 09 industry tiles ||
* FF: {{ottdp|15|no}} purchase list (callbacks when not constructed yet)
* default: used if none of the listed cids apply
|-
| 0A industries ||
* FF: {{ottdp|15|no}} purchase list (callbacks when not constructed yet)
* default: used if none of the listed cids apply
|-
| 0B cargos || default only
|-
| 0C sound effects || default only
|-
| 0D airports ||
* FF: {{ottdp|15|no}} purchase list (callbacks when not constructed yet)
* default: used if none of the listed cids apply
|-
| 0E signals || default only
|-
| 0F objects ||
* FF: purchase list
* default: used if none of the listed cids apply
|-
| 10 rail types || special cids, see [[Action3/Railtypes#cargo-type|here]]
|-
| 11 airport tiles ||
* FF: {{ottdp|15|no}} purchase list (callbacks when not constructed yet)
* default: used if none of the listed cids apply
|-
| 12 road types || special cids, see [[Action3/Tramtypes#cargo-type|here]]
|-
| 13 tram types || special cids, see [[Action3/Roadtypes#cargo-type|here]]
|-
| 14 road stops ||
* 00..FD: cargo-type (index in [[Action0/Global Settings#Cargo translation table 09|cargo translation table]]; cargobit if no table present) waiting at the road stop.
* FE: used if none of the listed cids apply.
* FF: purchase list
* default: used if none of the listed cids apply.
|-
| 15 badges || special cids:
* 00..14: feature
* default: used if specific feature is not assigned.
|-
|}

<references/>

=== default set-ID ===

Default set-ID if no entry from the cargo-type list above matches, or if there are no special cargo-types listed at all.

== Example ==

Below is an example of what a real action 3 pseudo-sprite could look like for a train engine.

<pre> 13 * 7   03 00 01 02 00 00 00</pre>

{| class="wikitable"
|-
!'''Byte'''
!'''Meaning'''
|-
|13
|<sprite-number>
|-
|7
|<length> of the action in bytes; start counting at 03 (<action>)
|-
|03
|<action>: sets this pseudo-sprite to function as action 3
|-
|00
|<feature>: 00 for trains
|-
|01
|<n-id>: One ID to change in this case
|-
|02
|<ids...>: vehicle ID (02 - Ploddyphut Choo-Choo)
|-
|00
|<num-cid>: this engine doesn't have cargo-specific graphics
|-
|00 00
|<default set-ID>: Use action 2 ID 00, because it is a word value you add 00
|}

Action1

2025-12-03T08:24:14Z

Peter1138: /* Feature */

==Introduction==
Defining a set of real sprites.
Action 01 is used to define sets of real sprites (as opposed to pseudo-sprites). It can be put anywhere in the .nfo file after [[Action8|Action 8]].

== Syntax ==

=== Basic format ===
{{ottdp|0.6|2.0}}
<sprite-number> * <length> '''01''' <feature> <num-sets> <num-ent>

{| |-
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action
|-
|01||B||Defines action 01
|-
|<feature>||B||The feature that following sprites should be used for (s.b.)
|-
|<num-sets>||B||The number of sprite sets you have (one sprite set is one vehicle/station/ship etc). Setting this to 00 makes it an extended format (see below).
|-
|<num-ent>||B*||The number of views the sprite has
|}

The block of data that always follows after action 01 should consist of num-sets * num-ent RealSprites or RecolorSprites.

=== Extended format ===
{{ottdp|1.2.2|no|ottdrev=r24361}}
<sprite-number> * <length> '''01''' <feature> '''00''' <first-set> <num-sets> <num-ent>

{| |-
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action
|-
|01||B||Defines action 01
|-
|<feature>||B||The feature that following sprites should be used for (s.b.)
|-
|00||B||Identfies the extended format.
|-
|<first-set>||B*||The ID of the first spriteset to define
|-
|<num-sets>||B*||The number of sprite sets you have (one sprite set is one vehicle/station/ship etc)
|-
|<num-ent>||B*||The number of views the sprite has
|}

The block of data that always follows after action 01 should consist of num-sets * num-ent RealSprites or RecolorSprites.

== Description ==

=== 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 [[Features|feature]] that you wish to change. Set it to:

{|- |
!Value!![[Features|Feature]]
|-
|00||Trains
|-
|01||Road Vehicles
|-
|02||Ships
|-
|03||Aircraft
|-
|04||Stations
|-
|05||Canals/Rivers
|-
|07||Houses
|-
|09||Industry Tiles
|-
|0A||Industries
|-
|0B||Cargos
|-
|0D||Airports
|-
|0F||Objects
|-
|10||Railtypes
|-
|11||Airport Tiles
|-
|12||Roadtypes
|-
|13||Tramtypes
|-
|14||Road Stops
|-
|15||Badges
|}

=== first-set ===
This specifies the first set ID to define.

{{ottdp|1.2|no|ottdrev=r22925}} Since OpenTTD r22925 spritesets stay valid across multiple Action1. That is, if one Action1 defines spritesets 0 to 4, and later a second Action1 redefines spriteset 0, spritesets 1 to 4 still refer to the first Action1. Spritesets are feature-specific, each feature maintains its own mapping of ids to Action1 spritesets. (Prior to OpenTTD r22925 and in TTDPatch only spritesets from a single Action1 are referencible from an Action2 at a time. Referencing an Action1 with a different feature than the Action2 is an error.)

This behaviour of Action1 applies to both the basic as well as the extended format.

{{ottdp|1.2|no|ottdrev=r22926}} In addition the extended format allows to specify an ID for the first spriteset to define. That way individual spritesets and be redefined individually.

There are no restriction on the order the spritesets are defined. If you define spritesets 23..25 in one Action 1, define spritesets 0..5 in another Action 1, then an Action 2 can access sets 0..5 and 23..25. Later another Action 1 can redefine spritesets 2..3, and following Action 2 could access spritesets 0..1, 2..3, 4, 23..25 from various Action 1.

Note that all spriteset defined in a single Action1 have the same amount of sprites per spriteset. Using multiple Action1 you can define spriteset with different amounts of sprites per set. Action2 will individually use the size of each referenced spriteset. There is no requirement for consistent numbers of sprites in Action2 or spritelayouts.

=== num-sets ===
The amount of stations, vehicles, ships, etc that the following sprites represent (be warned, one spriteset can be used for more as one vehicle, or truck; you will see this when you reach [[Action2|Action 2]] and [[Action3|Action 3]])

=== num-ent ===

This sets how many different views each entry has.

For vehicles, this corresponds to the different directions it can be in. If your vehicle is symmetrical you need 4 views, and if it isn't symmetrical then use 8 views.

A station should normally be 12 (hex) because a station is made out of 18 (decimal) sprites, although if you use a different sprite layout for your station this number may vary.
For canals, it depends on the canal feature, see [[Action3|Action 3]].

For houses and industry tiles, this should be between 1 and 4 and specifies the number of different construction stages. Sprites after the first four are always ignored. See also action 2 and 3.

For cargos, this should always be 1. The following sprites should be no larger than 10x10 pixels or they won't fit into the station window correctly.

{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 49}} Since TTDPatch 2.0.1 alpha 49, this value is a so-called "extended byte" (see [[GRFActionsDetailed]]).

{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 63}} Since TTDPatch 2.0.1 alpha 63, it is possible to have <num-ent>=0. This is useful for defining an action 1/2 combination that only serves as invalid callback result. If the .grf file defines no graphics otherwise, this way callbacks can return an explicit failure code without needing any actual sprites to be allocated. This is also needed if the feature has [[Action2/Only_Callback_Failure | no graphics at all]].

== Example ==

Below is an example of what a real Action 1 pseudo-sprite could look like with the sprite entries under it.

2 * 4 01 00 01 08
3 C:\TTD\SPRITES\mytrain.pcx 66 8 01 18 8 -3 -10
4 C:\TTD\SPRITES\mytrain.pcx 82 8 09 15 20 -14 -6
5 C:\TTD\SPRITES\mytrain.pcx 114 8 01 12 28 -14 -6
6 C:\TTD\SPRITES\mytrain.pcx 162 8 09 16 20 -4 -8
7 C:\TTD\SPRITES\mytrain.pcx 194 8 01 18 8 -3 -10
8 C:\TTD\SPRITES\mytrain.pcx 210 8 09 16 20 -14 -7
9 C:\TTD\SPRITES\mytrain.pcx 242 8 01 12 28 -14 -6
10 C:\TTD\SPRITES\mytrain.pcx 290 8 09 15 20 -4 -7

{| |-
!'''Byte'''!!'''Meaning'''
|-
|2||<sprite-number>
|-
|4||<length> of the action in bytes; start counting at 01 (<action>)
|-
|01||<action>: sets this pseudo-sprite to function as action 1
|-
|00||<feature>: In this case Train
|-
|01||<num-sets>: 1 Set of views
|-
|08||<num-ent>: 8 views of this train

Action0/Stations

2025-08-26T19:27:25Z

Peter1138: /* Properties */

==Introduction==

Defining properties of new stations.

Unlike vehicles, the new stations have no equivalent in TTD. The IDs are therefore free to be chosen and will in fact be allocated automatically. In action 0, you only specify IDs relative to the set, i.e. the ID of the first station type is 00, the second station type is 01 and so on.

{{ttdp|}} In TTDPatch each game can only have 255 station IDs for all active grf files.

The only property you '''must''' set for each station ID is 08 (in addition to defining an [[Action3|action 3]] for it), anything else can be left at the default. It must be the first property you set for each station ID, because the station ID is actually undefined until it has been assigned a class through property 08. Also, all station IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|0.6|2.5|ttdprev=alpha 19}}||Class ID, see below
|-
|09||V||{{ottdp|0.6|2.5|ttdprev=alpha 20}}||Sprite layout, see below
|-
|0A||B/B*||{{ottdp|0.6|2.5|ttdprev=alpha 20}}/{{ottdp|14.0}}||Copy sprite layout
|-
|0B||B||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Callback flags
|-
|0C||B||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Bit mask of disabled numbers of platforms
|-
|0D||B||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Bit mask of disabled platform lengths
|-
|0E||V||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Define custom layout, see below
|-
|0F||B/B*||{{ottdp|0.6|2.5|ttdprev=alpha 22}}/{{ottdp|14.0}}||Copy custom layout from stationid given by argument
|-
|10||W||{{ottdp|0.6|2.5|ttdprev=alpha 25}}||Little/lots threshold
|-
|11||B||{{ottdp|0.6|2.5|ttdprev=alpha 27}}||Pylon placement
|-
|12||D||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Bit mask of cargo type triggers for random sprites
|-
|13||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||General flags
|-
|14||B||{{ottdp|0.6|2.5|ttdprev=alpha 47}}||Overhead wire placement
|-
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 51}}||Can train enter tile
|-
|16||W||{{ottdp|0.7|2.5|ttdprev=beta 9}}||Animation information
|-
|17||B||{{ottdp|0.7|2.5|ttdprev=beta 9}}||Animation speed
|-
|18||W||{{ottdp|0.7|2.5|ttdprev=beta 9}}||Animation triggers
|-
|1A||V||{{ottdp|1.2|no|ottdrev=r22518}}||Advanced sprite layout with register modifiers
|-
|1B|| || ||Reserved
|-
|1C||W||{{ottdp|14}}||Station name
|-
|1D||W||{{ottdp|14}}||Station class name
|-
|1E||V||{{ottdp|15}}||Station sprite layout flags
|-
|1F||W n*W||{{ottdp|15}}||List of badges
|-
|20||B* n*B||{{ottdp|15}}||Minimum height list.
|-
|21||B* n*B||{{ottdp|15}}||Blocked bridge pillars list.
|}

Unofficial additions and changes. Don't rely on them to ever work this way in OpenTTD or TTDPatch:
{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|1B||8*B||whatever-PP||Minimum bridge height for bridges over stations
|}

== Description ==

=== Station class (08) ===
TTDPatch groups sets of new station graphics into various classes.  The classes can be selected by the top dropdown list in the construction window, and the individual stations within the class from the bottom dropdown list.  In addition, each station can alter its appearance using [[VariationalAction2|variational]] and/or [[RandomAction2|random]] action 2 entries.

Only two classes are pre-defined:

{| |-
!Name!!Class ID!!Intended use for station
|-
|DFLT||44 46 4C 54||Default, no special station type
|-
|WAYP||57 41 59 50||Non-cargo stations, waypoints, signal boxes etc.
|}

You may simply use other classes than the above, as long as no more than (at the moment) 16 classes are used among all active .grf files at any time.

{{ottdp|15}} Station classes which start with the byte FF are considered waypoint classes, and will appear in the waypoint construction window instead of the station construction window.

When a waypoint station is built, it will not accept cargo nor will any cargo appear from nearby industries or towns.  Trains will not stop at waypoint stations, regardless of the non-stop order and/or the nonstop switch.

=== Sprite layout (09) ===
This controls what sprites are displayed, where they are displayed, and in what order.  The property is variable sized, and contains the data for all 8 possible station tile types.  If this property is set, the num-ent in the corresponding [[Action1|action 1]] need not be equal to 12 (hex), it can in fact be any number, and any number of sprites can be displayed in any order.

The data is specified as data for all eight tiles in this way:

<pre><num> <data1> <data2> ... <datan></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported (see below)
|-
|V||data1...||The variable size data for each of the <num> tiles, as specified below
|}

===== Number of tiles supported =====
* Normally this is 8, but you can specify fewer as well
* Using callback flags bit 1, specifying more makes sense too
* This value must be the same for all stations set by this action 0, even though it must be repeated for the prop. 09 definition of each station ID as well

(Note that num is an extended byte, see [[GRFActionsDetailed]].)

The content of each of the (usually eight) data sets is either a new sprite layout:

{| |-
!Size!!Name!!Meaning
|-
|D||groundsprite||the sprite to draw for the rails; this is by default a TTD sprite, but with bit 31 set an [[Action1|action 1]] sprite (42D+X) may be specified
|-
|V||spritedata||the data for station sprites, see below; each has a size of 10 bytes, and there may be several
|-
|B||80||a literal 80 ends the list of sprites for this tile
|}
or, alternatively, the instruction to use TTD's layout by using four zero bytes 00 00 00 00 instead of the groundsprite bytes. You can use [http://www.bytetransfer.de/projects/ttdpatch/docs/spriteidmapping.php the online sprite ID converter] to look up the sprite IDs you can use for all the climates.

One can draw two types of sprites.  One type is one that establishes a new 3D bounding box for use by the sprite sorter.  The other type shares the 3D bounding box of the previous sprite(s).  It must not be larger than the sprite which established the bounding box, nor must any part of it be outside this box.  For simplicity, it should have the exact same dimensions as the sprite it shares the bounding box with.  The latter type is supported in the station construction window display only since TTDPatch 2.6 r1684.

The spritedata of sprites with their own bounding box has this format:

{| |-
!Size!!Name!!Meaning
|-
|B||xofs||x-offset from northern tile corner
|-
|B||yofs||y-offset from northern tile corner
|-
|B||zofs||z-offset from northern tile corner
|-
|B||xextent||size of sprite in x direction
|-
|B||yextent||size of sprite in y direction
|-
|B||zextent||size of sprite in z direction
|-
|D||sprite||sprite number to draw
|}

The spritedata of sprites sharing the bounding box has this format:

{| |-
!Size!!Name!!Meaning
|-
|B||xofs||x-offset relative to previous sprite
|-
|B||yofs||y-offset relative to previous sprite
|-
|B||80||a literal 80
|-
|B||00||(ignored)
|-
|B||00||(ignored)
|-
|B||00||(ignored)
|-
|D||sprite||sprite number to draw
|}

Since OpenTTD r18959 you can draw multiple ground sprites for a tile, which is useful if you want to use the usual rail/grass/concrete groundtile, but still need to add features to it without using a new bounding box. To do so use the syntax of sprites sharing the previous bounding box, but use it before the first bounding box definition. xpixeloffset and ypixeloffset refer to the usual spot of groundtiles. The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2312: TTDPatch ignores the xofs and yofs fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xofs and yofs zero to get the same effect in both games.
Note however that both implementations do not consider the [[Action0/Stations#General_Flags_.2813.29|setting of prop13 bit 0]], hence these "multiple ground sprites" have to be always part of the building sprites set and cannot be part of the different sprite set for ground sprites.

The sprite number can have the following values (remember to use little endian, i.e. reversed byte order):

{| |-
!Number!!Sprite
|-
|0000042D+X||use sprite X from the corresponding [[Action1|action 1]] block (i.e. 0000042D for the first, 0000042E for the second, etc.)
|-
|0000842D+X||same, but draw it using company colour translation
|-
|0322442D+X||same, but draw in transparent mode (actual colours of the sprite are disregarded entirely); supported in station construction window display since TTDPatch 2.6 r1683
|-
|RRRR842D+X||draw sprite with colour translation defined in sprite RRRR; available since TTDPatch 2.6 r1683
|}

With bit 31 set, this sprite will refer to a TTD sprite, not the action 1 sprite. For the first ground sprite the reverse meaning applies.

Depending on the railtype the sprites may get additional offsets:

{| |-
! !! Normal/electrified rail !! Monorail !! Maglev
|-
|TTD sprites || 0 || 82 || 164
|-
|Action 1 sprite (first ground sprite) || 0 || 1 || 2
|-
|Action 1 sprite (other sprites in the layout) || 0 || 0 || 0
|}

So, TTD sprites and the first ground sprite are affected by the railtype, while other action 1 sprites in the layout are not. The offset "82" refers to the offset between the default TTD track sprites; if you are using non-track ground sprites which are not from an action 1, you need to supply fake spritenumbers which preemptively reverse the offsets (that is, you need different sprite layouts for every railtype your station is available for).

Setting bit 30 forces this sprite to be displayed normally even in "transparent buildings" mode (supported only in TTDPatch 2.6 r1695 and later).

See below for an example of linked sprites as well as transparent sprites (e.g. for a station roof).

Note that the coordinates here are 3D coordinates with x running from top-right to bottom-left and y running from top-left to bottom-right, with the tile dimensions being 16x16 (and 8 for one height level). This means the x and y values should always be within 0-15 (decimal).

This is different to and independent from the x/y offsets used in the actual .NFO file.  The 3D bounding box is used by TTD's sprite sorter to figure out the order in which to draw the sprites, as well as telling it which sprites to draw, because those whose bounding box falls outside the currently updated screen rectangle will not be drawn.  Make sure the 3D bounding box is large enough to contain the entire sprite, but not so large that the sprite sorter can't determine which sprites should be in front.

This means that the order in which you specify sprites is irrelevant.  Sprites will get drawn from back to front, in the order which the sprite sorter determines as correct, from their bounding boxes.  There are two exceptions, however:
* Sprites sharing the same bounding box will always be drawn in the given order.
* The station construction window display doesn't use the sprite sorter. Tiles that may be displayed in that window need to be specified in the correct drawing order, back to front.

=== Copy sprite layout (0A) ===

This is not a property as such, but an action.  It takes as argument a byte which is interpreted as station-ID to copy the custom sprite layout from.

Since {{ottdp|14.0}} this property is now an extended byte.

=== Callback flags (0B) ===
For stations, the following [[callbacks]] can be defined by setting the corresponding bit in property 0B:

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||13||Whether to make station available in construction window (non-zero callback return) or not (callback returns zero)
|-
|1||2||14||Use callback to select sprite layout
|-
|2||4||141||Decide next animation frame
|-
|3||8||142||Decide animation speed
|-
|4||10||149||Custom slope check
|}
Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the [[VariationalAction2|VarAction2]] for callbacks.

=== Selection of numbers of platforms and length (0C, 0D) ===

By default all platform lengths and any number of platforms is available for the new stations.  Using these properties, you can choose which ones should be unavailable by setting the corresponding bit in the property.

The values are a byte, used as a bit mask.  Bits 0 to 6 control the availability of number or length 1 to 7, and bit 7 controls the availability of the "+7" button.  Each bit that is set disables the corresponding length or number of platforms.

For compatibility with "largestations off", at least one length between 1 and 5 (bits 0 to 4) and one number of platforms between 1 and 4 (bits 0 to 3) must be available, i.e. at least one of these bits must be unset.

=== Define custom layout (0E) ===

This allows choosing which tile type is built at which tile of a newly built station.  There are four different types, which TTD normally defines as

{| |-
!Tile type!!Appearance
|-
|00||plain platform
|-
|02||platform with building
|-
|04||platform with roof, left side
|-
|06||platform with roof, right side
|}

Since {{ottdp|15}}, all even values up to FE are supported if the sprite layout is defined via property 09/0A.

These numbers are used for stations in NE-SW direction, or these numbers plus one for stations in the NW-SE direction.  To define a custom layout, use this format:

{| |-
!Size!!Name!!Meaning
|-
|B||length||length of platforms for this layout
|-
|B||number||number of platforms for this layout
|-
|V||tiles||length*number bytes of tile types, one platform after another, only 00, 02, 04 or 06 are allowed as values
|}

Repeat this as often as necessary to define the layouts for all supported combinations of length and number.  End the definitions with a 00 00 (zero length and zero number).  Any combinations that are not defined will be built using TTD's default layout.
Note that it may be easier to draw different sprite sets using a [[VariationalAction2|VarAction2]] based on [[VarAction2Stations#Platform info 40 41 46 47 49|station variable 40]], rather than redefining the layout.  In addition, [[Callbacks#Custom station layout 24|callback 24]] will be used to further customize the layout as defined by this property (or by TTD if no prop 0E layout is available). This may also be easier than defining a prop 0E layout for every combination of length and number of platforms.

=== Copy custom layout (0F) ===

Similar to property 0A, this copies the custom layout from the station-ID given by the argument.

Since {{ottdp|14.0}} this property is now an extended byte.

=== Little/lots threshold (10) ===
Amount of cargo for switching from "little" to "lots" of cargo.  TTDPatch separates the full range of cargo amounts (0 to 4095) into two separate subranges, "little" and "lots" of cargo.  This allows better control of cargo amount based graphics (if needed).  Property 10 specifies at what amount of cargo the patch is to switch from one to the other subrange.  See [[Action2Stations|Action 2 for stations]] for more information.

=== Pylon placement (11) and wire placement (14) ===
Prop. 11 sets which tile types should have pylons when used with electrified tracks. By default, tiles 0-3 (default stations without roof) have pylons, and tiles 4-7 (default stations with roof) don't. This is a bit mask of tile types, with a bit set meaning that a pylon should be drawn. The tile types here do not consider [[Callbacks#Station sprite layout 14|callback 14]], but rather the type as it was built, i.e. from prop. 0E.

Prop. 14 works in a similar way, except that it sets the tile types on which there should be ''no'' wires displayed. With the default value of "00", wires are displayed everywhere, and for each bit set, the wire is omitted on that tile type.

This property should only be used when the wires cause problems with the sprite sorter, because even when the wire is obscured by a station hall or similar, it should still show up in transparent mode so that each tile can easily be verified as being electrified.

{{ottdp|15}} Note: This property only allows setting the flags of the first 8 sprite layouts. Use Property 1E instead to set flags when more sprite layouts are used via prop. 0E or [[Callbacks#Custom_station_layout_.2824.29|callback 24]].

=== Cargo types for random triggers (12) ===

This sets which cargo types should trigger re-randomizing. The cargo types are given as a bitmask of the bits from column 3 (type B) in CargoTypes.  If nothing is set (the default), the no random triggers will happen, to conserve CPU time.

With GRF version 7 and above, the interpretation of bits changes. Instead of climate-dependent cargo slot numbers (type B), you have to set the bits of climate-independent cargo ID (type A).

{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.

=== General Flags (13) ===

{| |-
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|0.7|2.5}}||use different sprite set for ground sprites ([[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|var. 10]] is 1 for ground sprites, 0 otherwise)
|-
|1||2||{{ottdp|0.6|2.5}}||when calculating the cargo amount to display, divide the amount by the station size (to simulate cargo distributed over the area of the station)
|-
|2||4||{{ottdp|0.7|2.5}}||[[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] needs random bits in var. 10
|-
|3||8||{{ottdp|1.0|2.6}}||Use custom foundations on sloped tiles (the lowest byte of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|var. 10]] is 2 for foundation sprites)
|-
|4||10||{{ottdp|1.0|2.6}}||When bit 3 is set, use extended foundation block instead of the simple one
|}

Bit 3 works somewhat similarly to bit 0: your sprite selection will be called again, with 2 in the lowest byte of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 10]]. If the chain ends on a callback result, the program will assume the foundation selection has failed and will use the default foundaton sprites. The low word of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 18]] will contain the tile type of the current tile; if you have [[Callbacks#Station sprite layout (14)|callback 14]] enabled, this will be the its return value - otherwise, the default TTD types (platform with building, platform with left roof etc.) are used. In either case, one is added for the NW-SE orientation, in case your station needs different foundations depending on its orientation. Bits 16 and 17 are set if the NW and and NE foundations are to merged with the corresponding neighbour tile, so you shouldn't draw the corresponding edge in the foundation sprite. Other bits of variable 10 and variable 18 are reserved for future use.

Your sprite selection code should select a foundation sprite block. The contents of this block depends on whether bit 4 is set or not.
* Bit 4 clear (simple foundations):
[[File:simple_foundations.png]]

The programme will combine the needed foundation from these 8 sprites depending on the current slope. You don't need to care about the merge data in bits 16..17 of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 18]]; it will be taken care of that automatically by adding the 7th and 8th sprite only when necessary.
* Bit 4 set (extended foundations):
[[File:extended_foundations.png]]

You need to have one sprite for every slope that's possible below a rail station. The correct one will be automatically selected depending on the current slope. It can't handle the merging itself, however, so you need four foundation blocks: one with no edges removed, one with the NW edge removed, one with the NE edge removed and one with both north edges removed. Your sprite selection code is responsible for selecting the correct of those blocks according to the merge info in [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 18]].

In both cases, you can put an additional value into register 100h, which will serve as an offset into the selected block. If you don't modify register 100h during the chain, it will default to 0. It is important that the dimensions of these sprites remain the same - thus bit 6 in the real sprites must be set to prevent GRFCodec from trimming the empty blue areas. The offset of these foundations must be -31 to the X direction and -9 to the Y direction.

=== Can train enter tile (15) ===

Like props. 11 and 14, this value contains eight bits relating to the eight possible tile types. If a bit is set, trains are prevented from routing through or entering any tile of this type.

{{ottdp|15}} Note: This property only allows setting the flags of the first 8 sprite layouts. Use Property 1E instead to set flags when more sprite layouts are used via prop. 0E or [[Callbacks#Custom_station_layout_.2824.29|callback 24]].

=== Animation information (16) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this station (this is the default value).
Since you can't have properties for individual station tiles, this property applies for every tile of the station. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] for that.

=== Animation speed (17) ===
The meaning is the same as for [[Action0Houses#Animation Speed 1B|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.

=== Animation triggers (18) ===
This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]], allowing to change the animation state

{| |-
!Property bit, var18 byte 0!!Property value!!Version!!Meaning!!Happens on!!Var 18 byte 1
|-
|0||1||{{ottdp|0.7|2.5}}||Station part is built||the newly built tiles||
|-
|1||2||{{ottdp|0.7|2.5}}||New cargo arrives to station||whole station||Cargo type <ref name="cargotype">Bits 8..15 of var 18 contain the triggering cargo type. If your GRF has a cargo translation table, the cargo type will be an index in that table, or FFh if the cargo isn't in the table. If you don't have a cargo translation table, the cargo type will simply be the climate-dependent cargo type number.</ref>
|-
|2||4||{{ottdp|0.7|2.5}}||A cargo type gets removed from station||whole station||Cargo type <ref name="cargotype"/>
|-
|3||8||{{ottdp|0.7|2.5}}||Train enters station (starts loading/unloading)||platform where the train is||
|-
|4||10||{{ottdp|0.7|2.5}}||Train leaves station (done loading/unloading)||platform where the train is||
|-
|5||20||{{ottdp|1.2|2.5|ottdrev=r22746}}||Train loads/unloads cargo||platform where the train is||
|-
|6||40||{{ottdp|0.7|2.5}}||Every 250 ticks||whole station||
|-
|7||80||{{ottdp|15|no}}||Tile is processed in the periodic processing loop||single tile||
|-
|8||100||{{ottdp|15|no}}||Train reserves platform (using PBS)||platform where the train reserved||
|}

The remaining bits are reserved for future triggers, they must be zero for now.

The "happens on" column tells which tiles will [[Callbacks#Animation control (1B/25/140/152/159) |callback 140]] be called on.

<references/>

=== Advanced sprite layout with register modifiers (1A) ===

{{ottdp|1.2|no|ottdrev=r22518}}
Format:
1A <num-layouts> <0x40 + num-sprites>
<groundsprite> <flags> [<register/value>]...
[ <buildingsprite> <flags>
( <xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>
| <xpixeloffset> <ypixeloffset> 80)
[<register/value>]...
]...

For further details see [https://wiki.openttd.org/en/Archive/Development/Advanced%20Sprite%20Layout#stations here] for now.

=== Minimum bridge height (1B) ===

This property allows building bridges over stations.

The bridge height property defines minimum clearances required for a bridge for each of the four [[Action0/Stations#Define_custom_layout_.280E.29|tile types]] of this station (or zero to not allow any bridge). Values are given in "height level" units (1 level == 8px).

{| class="wikitable" |-
!Height (1)!!Appearance
|-
| style="text-align:center;" |x1 y1 ||plain platform
|-
| style="text-align:center;" |x2 y2 ||platform with building
|-
| style="text-align:center;" |x3 y3 ||platform with roof, left side
|-
| style="text-align:center;" |x4 y4 ||platform with roof, right side
|}
(1) where the values are one byte pairs (x-direction, y-direction) expressed in hexadecimal notation.

Syntax:

1B <1st pair> <2nd pair> <3rd pair> <4th pair> 
1B x1 y1 x2 y2 x3 y3 x4 y4 
1B 01 01 02 02 03 03 03 03 // 8px 16px 24px 24px

This property is currently only available for JGR's Patch Pack (v0.26.0 and later) and the developmental "New Map Features" (NMF) fork of OpenTTD.

=== Station name (1C) ===

=== Station class name (1D) ===

=== Station sprite layout flags (1E) ===

{{ottdp|15}} Since OpenTTD supports more than 8 sprite layouts to be used, props. 11, 14 and 15 are not sufficient to set the flags for all usable sprite layouts. This property is variable length and allows these flags to be set for each tile beyond the original limit of 8.

The data is specified as flags for all sprite layouts in this way:

<pre><num> <flags1> <flags2> ... <flagsn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported (see below)
|-
|B||flags1...||The flags for each of the <num> tiles, as specified below
|}

The flag values are as follows:

{| |-
|Bit||Value||Meaning
|-
|0||01||Tile should contain catenary pylons.
|-
|1||02||Tile should NOT contain catenary wires.
|-
|2||04||Tile is blocked to vehicles.
|}

These should be combined as needed.

===Minimum Bright Height (20)===

{{ottdp|15}} This property allows building bridges over stations.

The bridge height property defines minimum clearances required for a bridge for the sprite layouts of this station (or zero to not allow any bridge). Values are given in "height level" units (1 level == 8px).

The data is specified as minimum height for all sprite layouts in this way:

<pre><num> <height1> <height2> ... <heightn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported (see below)
|-
|B||height...||The minimum heights for each of the <num> tiles.
|}

===Blocked Pillar Information (21)===

{{ottdp|15}} Allows information to provided about blocked bridge pillars to assist the game in hiding pillars if necessary depending on what is above the station tile. Blocking a pillar prevents the pillar from being drawn. It does not prevent the station being bridgeable.

The data is specified as blocked pillar flags for all sprite layouts in this way:

<pre><num> <flags1> <flags2> ... <flagsn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported (see below)
|-
|B||flags...||The blocked pillar flags for each of the <num> tiles.
|}

The flag bits are as follows:

{| |-
|Bit||Value||Meaning
|-
|0||01||Tile layout blocks a pillar on the west corner of the tile.
|-
|1||02||Tile layout blocks a pillar on the south corner of the tile.
|-
|2||04||Tile layout blocks a pillar on the east corner of the tile.
|-
|3||08||Tile layout blocks a pillar on the north corner of the tile.
|-
|4||10||Tile layout blocks a wall on the north east side of the tile.
|-
|5||20||Tile layout blocks a wall on the south east side of the tile.
|-
|6||40||Tile layout blocks a wall on the south west side of the tile.
|-
|7||80||Tile layout blocks a wall on the north west side of the tile.
|}

These should be combined as needed.

== Examples ==

=== Using TTD's sprite layouts for certain tiles ===

To use TTD's layout, you use <code>00 00 00 00</code> for the ground sprite number and leave off everything else.

So instead of for example

F4 03 00 00
00 00 00 10 05 02 2E 84 00 00
00 0B 00 10 05 02 30 84 00 00
80

you just put

00 00 00 00

=== Using transparent sprites ===

You can use transparent sprites to make for example the roof translucent like in TTD's stations. The roof of TTD's stations is made like this:

00 00 10 10 10 0A 37 84 00 00
00 00 80 00 00 00 3B 44 22 03

The first sprite here is the non-transparent frame of the roof, drawn in company colours (it has bit 15 set). The second part is a special "linked" sprite without its own bounding box, it shares that of the previous sprite. That's done by setting the z offset to 80.

To make that second sprite transparent, bit 14 is set in the sprite number, and the upper word is set to 322 (*), so 0322443B means to take sprite 43B and draw it in transparent mode. The colours of that sprite are ignored entirely, every pixel in colour 0 is fully transparent, and all other pixels are semi-transparent (essentially just causing what they are drawn over to become darker).

(*) This is the [[RecolorSprites#Default_recolour_sprites | recolour sprite]] for the glass effect.

Action0/Road Stops

2025-08-26T19:26:48Z

Peter1138: /* Properties */

==Introduction==
Defining properties of road stops.

Road stop IDs may be freely chosen. In action 0, you need only specify IDs relative to the set, i.e. the ID of the first road stop type is 00, the second road type is 01 and so on.

OpenTTD supports 64000 road stops per game, and 64000 road stop IDs per GRF file.

The property you '''must''' set for each road stop ID is 08 (in addition to defining an action 3 for it). Also, all road stop IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==
{|
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|14}}||Class label, see below
|-
|09||B||{{ottdp|14}}||Road stop type
|-
|0A||W||{{ottdp|14}}||Road stop name text ID
|-
|0B||W||{{ottdp|14}}||Class name text ID
|-
|0C||B||{{ottdp|14}}||Draw mode
|-
|0D||D||{{ottdp|14}}||Random trigger cargoes
|-
|0E||W||{{ottdp|14}}||Animation information
|-
|0F||B||{{ottdp|14}}||Animation speed
|-
|10||W||{{ottdp|14}}||Animation triggers
|-
|11||B||{{ottdp|14}}||Callback flags, see below
|-
|12||D||{{ottdp|14}}||General flags, see below
|-
|13||B* n*B||{{ottdp|15}}||Minimum height list.
|-
|14||B* n*B||{{ottdp|15}}||Blocked bridge pillars list.
|-
|15||W||{{ottdp|14}}||Cost multipiers, see below
|-
|16||W n*W||{{ottdp|15}}||List of badges
|}

== Descriptions ==

=== Road stop class (08) ===

New road stops are grouped graphics into classes.

Only two classes are pre-defined:

{| |-
!Name!!Class ID!!Intended use for road stops
|-
|DFLT||44 46 4C 54||Default road stops
|-
|WAYP||57 41 59 50||{{ottdp|15}} Road waypoints
|}

{{ottdp|15}} Road stop classes which start with the byte FF are considered road waypoint classes, and will appear in the road waypoint construction window instead of the road bus/truck stop construction windows.

It is recommended that the class identifier used is unique to your GRF(s).

=== Road stop type (09) ===

{| |-
!Value!!Meaning
|-
|0||Passenger/bus stop
|-
|1||Freight/lorry stop
|-
|2||Both passenger/bus and freight/lorry stops
|}

The default value is 2: Both passenger/bus and freight/lorry stops

=== Road stop name text ID (0A) ===

The text ID for this road stop (word value). This textid should be either a TTD textid or a D4xx textid (set via D0xx in action4).

=== Class name text ID (0B) ===

The text ID for the road stop class.

When specifying a road stop, you don't need to set a class name again if you already did for another one with the same class.

=== Draw mode (0C) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||Bay stops: Draw road type ground sprite
|-
|1||2||Drive through stops: Draw road/tram type overlays
|-
|2||4||{{ottdp|15}} Road waypoints: Draw the sprite layout ground tile (on top of the road)
|}

The default value is 3 (bits 0 and 1 both set).

The remaining bits are reserved for future use.

=== Cargo types for random triggers (0D) ===

This sets which cargo types should trigger re-randomizing. The cargo types are given as a bitmask of the bits from column 3 (type B) in CargoTypes.  If nothing is set (the default), the no random triggers will happen, to conserve CPU time.

With GRF version 7 and above, the interpretation of bits changes. Instead of climate-dependent cargo slot numbers (type B), you have to set the bits of climate-independent cargo ID (type A).

=== Animation information (0E) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this station (this is the default value).
Since you can't have properties for individual station tiles, this property applies for every tile of the station. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] for that.

=== Animation speed (0F) ===
The meaning is the same as for [[Action0Houses#Animation Speed 1B|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.

=== Animation triggers (10) ===
This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]], allowing to change the animation state

Roadstops have the same animation triggers as [[Action0/Stations#Animation_triggers_.2818.29|rail stations]].

=== Callback flags (11) ===
For road stops, the following [[callbacks]] can be defined by setting the corresponding bit in property 0B:

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||13||Whether to make the road stop available in construction window (non-zero callback return) or not (callback returns zero)
|-
|1||2||141||Decide next animation frame
|-
|2||4||142||Decide animation speed
|}
Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the [[VariationalAction2|VarAction2]] for callbacks.

=== General Flags (12) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||[[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] needs random bits in var. 10
|-
|2||4||Do not show catenary graphics
|-
|3||8||Only allow drive-through stops (not bay stops)
|-
|4||10||Do not automatically build connecting road pieces
|-
|5||20||Only show in the road build menu (not tram)
|-
|6||40||Only show in the tram build menu (not road)
|-
|8||100||{{ottdp|15}} Read the draw mode from register 0x100, overriding the default value in property 0C

|}

The default value is 0 (no bits set).

The remaining bits are reserved for future use.

===Minimum Bright Height (13)===

{{ottdp|15}} This property allows building bridges over roadstops

The bridge height property defines minimum clearances required for a bridge for the sprite layouts of this roadstop (or zero to not allow any bridge). Values are given in "height level" units (1 level == 8px).

The data is specified as minimum height for all sprite layouts in this way:

<pre><num> <height1> <height2> ... <heightn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported
|-
|B||height...||The minimum heights for each of the <num> tiles.
|}

===Blocked Pillar Information (14)===

{{ottdp|15}} Allows information to provided about blocked bridge pillars to assist the game in hiding pillars if necessary depending on what is above the roadstop tile. Blocking a pillar prevents the pillar from being drawn. It does not prevent the roadstop being bridgeable.

The data is specified as blocked pillar flags for all sprite layouts in this way:

<pre><num> <flags1> <flags2> ... <flagsn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported
|-
|B||flags...||The blocked pillar flags for each of the <num> tiles.
|}

<pre><num> <flagsx1> <flagsy1> <flagsx2> <flagsy2> ... <flagsxn> <flagsyn></pre>

The flag bits are as follows:

{| |-
|Bit||Value||Meaning
|-
|0||01||Tile layout blocks a pillar on the west corner of the tile.
|-
|1||02||Tile layout blocks a pillar on the south corner of the tile.
|-
|2||04||Tile layout blocks a pillar on the east corner of the tile.
|-
|3||08||Tile layout blocks a pillar on the north corner of the tile.
|-
|4||10||Tile layout blocks a wall on the north east side of the tile.
|-
|5||20||Tile layout blocks a wall on the south east side of the tile.
|-
|6||40||Tile layout blocks a wall on the south west side of the tile.
|-
|7||80||Tile layout blocks a wall on the north west side of the tile.
|}

These should be combined as needed.

=== Cost multipliers (15) ===

The first byte is the build cost multiplier.

The second byte is the removal cost multiplier.

The total property length is 2 bytes.

A value of 16 produces a build or removal cost the same as non-NewGRF road stops.

== Examples ==

Action0/Road Stops

2025-08-26T19:26:35Z

Peter1138: /* Properties */

==Introduction==
Defining properties of road stops.

Road stop IDs may be freely chosen. In action 0, you need only specify IDs relative to the set, i.e. the ID of the first road stop type is 00, the second road type is 01 and so on.

OpenTTD supports 64000 road stops per game, and 64000 road stop IDs per GRF file.

The property you '''must''' set for each road stop ID is 08 (in addition to defining an action 3 for it). Also, all road stop IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==
{|
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|14}}||Class label, see below
|-
|09||B||{{ottdp|14}}||Road stop type
|-
|0A||W||{{ottdp|14}}||Road stop name text ID
|-
|0B||W||{{ottdp|14}}||Class name text ID
|-
|0C||B||{{ottdp|14}}||Draw mode
|-
|0D||D||{{ottdp|14}}||Random trigger cargoes
|-
|0E||W||{{ottdp|14}}||Animation information
|-
|0F||B||{{ottdp|14}}||Animation speed
|-
|10||W||{{ottdp|14}}||Animation triggers
|-
|11||B||{{ottdp|14}}||Callback flags, see below
|-
|12||D||{{ottdp|14}}||General flags, see below
|-
|13||B* n*B||{ottdp|15}}||Minimum height list.
|-
|14||B* n*B||{ottdp|15}}||Blocked bridge pillars list.
|-
|15||W||{{ottdp|14}}||Cost multipiers, see below
|-
|16||W n*W||{{ottdp|15}}||List of badges
|}

== Descriptions ==

=== Road stop class (08) ===

New road stops are grouped graphics into classes.

Only two classes are pre-defined:

{| |-
!Name!!Class ID!!Intended use for road stops
|-
|DFLT||44 46 4C 54||Default road stops
|-
|WAYP||57 41 59 50||{{ottdp|15}} Road waypoints
|}

{{ottdp|15}} Road stop classes which start with the byte FF are considered road waypoint classes, and will appear in the road waypoint construction window instead of the road bus/truck stop construction windows.

It is recommended that the class identifier used is unique to your GRF(s).

=== Road stop type (09) ===

{| |-
!Value!!Meaning
|-
|0||Passenger/bus stop
|-
|1||Freight/lorry stop
|-
|2||Both passenger/bus and freight/lorry stops
|}

The default value is 2: Both passenger/bus and freight/lorry stops

=== Road stop name text ID (0A) ===

The text ID for this road stop (word value). This textid should be either a TTD textid or a D4xx textid (set via D0xx in action4).

=== Class name text ID (0B) ===

The text ID for the road stop class.

When specifying a road stop, you don't need to set a class name again if you already did for another one with the same class.

=== Draw mode (0C) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||Bay stops: Draw road type ground sprite
|-
|1||2||Drive through stops: Draw road/tram type overlays
|-
|2||4||{{ottdp|15}} Road waypoints: Draw the sprite layout ground tile (on top of the road)
|}

The default value is 3 (bits 0 and 1 both set).

The remaining bits are reserved for future use.

=== Cargo types for random triggers (0D) ===

This sets which cargo types should trigger re-randomizing. The cargo types are given as a bitmask of the bits from column 3 (type B) in CargoTypes.  If nothing is set (the default), the no random triggers will happen, to conserve CPU time.

With GRF version 7 and above, the interpretation of bits changes. Instead of climate-dependent cargo slot numbers (type B), you have to set the bits of climate-independent cargo ID (type A).

=== Animation information (0E) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this station (this is the default value).
Since you can't have properties for individual station tiles, this property applies for every tile of the station. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] for that.

=== Animation speed (0F) ===
The meaning is the same as for [[Action0Houses#Animation Speed 1B|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.

=== Animation triggers (10) ===
This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]], allowing to change the animation state

Roadstops have the same animation triggers as [[Action0/Stations#Animation_triggers_.2818.29|rail stations]].

=== Callback flags (11) ===
For road stops, the following [[callbacks]] can be defined by setting the corresponding bit in property 0B:

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||13||Whether to make the road stop available in construction window (non-zero callback return) or not (callback returns zero)
|-
|1||2||141||Decide next animation frame
|-
|2||4||142||Decide animation speed
|}
Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the [[VariationalAction2|VarAction2]] for callbacks.

=== General Flags (12) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||[[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] needs random bits in var. 10
|-
|2||4||Do not show catenary graphics
|-
|3||8||Only allow drive-through stops (not bay stops)
|-
|4||10||Do not automatically build connecting road pieces
|-
|5||20||Only show in the road build menu (not tram)
|-
|6||40||Only show in the tram build menu (not road)
|-
|8||100||{{ottdp|15}} Read the draw mode from register 0x100, overriding the default value in property 0C

|}

The default value is 0 (no bits set).

The remaining bits are reserved for future use.

===Minimum Bright Height (13)===

{{ottdp|15}} This property allows building bridges over roadstops

The bridge height property defines minimum clearances required for a bridge for the sprite layouts of this roadstop (or zero to not allow any bridge). Values are given in "height level" units (1 level == 8px).

The data is specified as minimum height for all sprite layouts in this way:

<pre><num> <height1> <height2> ... <heightn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported
|-
|B||height...||The minimum heights for each of the <num> tiles.
|}

===Blocked Pillar Information (14)===

{{ottdp|15}} Allows information to provided about blocked bridge pillars to assist the game in hiding pillars if necessary depending on what is above the roadstop tile. Blocking a pillar prevents the pillar from being drawn. It does not prevent the roadstop being bridgeable.

The data is specified as blocked pillar flags for all sprite layouts in this way:

<pre><num> <flags1> <flags2> ... <flagsn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported
|-
|B||flags...||The blocked pillar flags for each of the <num> tiles.
|}

<pre><num> <flagsx1> <flagsy1> <flagsx2> <flagsy2> ... <flagsxn> <flagsyn></pre>

The flag bits are as follows:

{| |-
|Bit||Value||Meaning
|-
|0||01||Tile layout blocks a pillar on the west corner of the tile.
|-
|1||02||Tile layout blocks a pillar on the south corner of the tile.
|-
|2||04||Tile layout blocks a pillar on the east corner of the tile.
|-
|3||08||Tile layout blocks a pillar on the north corner of the tile.
|-
|4||10||Tile layout blocks a wall on the north east side of the tile.
|-
|5||20||Tile layout blocks a wall on the south east side of the tile.
|-
|6||40||Tile layout blocks a wall on the south west side of the tile.
|-
|7||80||Tile layout blocks a wall on the north west side of the tile.
|}

These should be combined as needed.

=== Cost multipliers (15) ===

The first byte is the build cost multiplier.

The second byte is the removal cost multiplier.

The total property length is 2 bytes.

A value of 16 produces a build or removal cost the same as non-NewGRF road stops.

== Examples ==

Action0/Road Stops

2025-08-26T19:25:30Z

Peter1138: /* Cost multipiers (15) */

==Introduction==
Defining properties of road stops.

Road stop IDs may be freely chosen. In action 0, you need only specify IDs relative to the set, i.e. the ID of the first road stop type is 00, the second road type is 01 and so on.

OpenTTD supports 64000 road stops per game, and 64000 road stop IDs per GRF file.

The property you '''must''' set for each road stop ID is 08 (in addition to defining an action 3 for it). Also, all road stop IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==
{|
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|14}}||Class label, see below
|-
|09||B||{{ottdp|14}}||Road stop type
|-
|0A||W||{{ottdp|14}}||Road stop name text ID
|-
|0B||W||{{ottdp|14}}||Class name text ID
|-
|0C||B||{{ottdp|14}}||Draw mode
|-
|0D||D||{{ottdp|14}}||Random trigger cargoes
|-
|0E||W||{{ottdp|14}}||Animation information
|-
|0F||B||{{ottdp|14}}||Animation speed
|-
|10||W||{{ottdp|14}}||Animation triggers
|-
|11||B||{{ottdp|14}}||Callback flags, see below
|-
|12||D||{{ottdp|14}}||General flags, see below
|-
|15||W||{{ottdp|14}}||Cost multipiers, see below
|-
|16||W n*W||{{ottdp|15}}||List of badges
|}

== Descriptions ==

=== Road stop class (08) ===

New road stops are grouped graphics into classes.

Only two classes are pre-defined:

{| |-
!Name!!Class ID!!Intended use for road stops
|-
|DFLT||44 46 4C 54||Default road stops
|-
|WAYP||57 41 59 50||{{ottdp|15}} Road waypoints
|}

{{ottdp|15}} Road stop classes which start with the byte FF are considered road waypoint classes, and will appear in the road waypoint construction window instead of the road bus/truck stop construction windows.

It is recommended that the class identifier used is unique to your GRF(s).

=== Road stop type (09) ===

{| |-
!Value!!Meaning
|-
|0||Passenger/bus stop
|-
|1||Freight/lorry stop
|-
|2||Both passenger/bus and freight/lorry stops
|}

The default value is 2: Both passenger/bus and freight/lorry stops

=== Road stop name text ID (0A) ===

The text ID for this road stop (word value). This textid should be either a TTD textid or a D4xx textid (set via D0xx in action4).

=== Class name text ID (0B) ===

The text ID for the road stop class.

When specifying a road stop, you don't need to set a class name again if you already did for another one with the same class.

=== Draw mode (0C) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||Bay stops: Draw road type ground sprite
|-
|1||2||Drive through stops: Draw road/tram type overlays
|-
|2||4||{{ottdp|15}} Road waypoints: Draw the sprite layout ground tile (on top of the road)
|}

The default value is 3 (bits 0 and 1 both set).

The remaining bits are reserved for future use.

=== Cargo types for random triggers (0D) ===

This sets which cargo types should trigger re-randomizing. The cargo types are given as a bitmask of the bits from column 3 (type B) in CargoTypes.  If nothing is set (the default), the no random triggers will happen, to conserve CPU time.

With GRF version 7 and above, the interpretation of bits changes. Instead of climate-dependent cargo slot numbers (type B), you have to set the bits of climate-independent cargo ID (type A).

=== Animation information (0E) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this station (this is the default value).
Since you can't have properties for individual station tiles, this property applies for every tile of the station. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] for that.

=== Animation speed (0F) ===
The meaning is the same as for [[Action0Houses#Animation Speed 1B|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.

=== Animation triggers (10) ===
This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]], allowing to change the animation state

Roadstops have the same animation triggers as [[Action0/Stations#Animation_triggers_.2818.29|rail stations]].

=== Callback flags (11) ===
For road stops, the following [[callbacks]] can be defined by setting the corresponding bit in property 0B:

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||13||Whether to make the road stop available in construction window (non-zero callback return) or not (callback returns zero)
|-
|1||2||141||Decide next animation frame
|-
|2||4||142||Decide animation speed
|}
Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the [[VariationalAction2|VarAction2]] for callbacks.

=== General Flags (12) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||[[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] needs random bits in var. 10
|-
|2||4||Do not show catenary graphics
|-
|3||8||Only allow drive-through stops (not bay stops)
|-
|4||10||Do not automatically build connecting road pieces
|-
|5||20||Only show in the road build menu (not tram)
|-
|6||40||Only show in the tram build menu (not road)
|-
|8||100||{{ottdp|15}} Read the draw mode from register 0x100, overriding the default value in property 0C

|}

The default value is 0 (no bits set).

The remaining bits are reserved for future use.

===Minimum Bright Height (13)===

{{ottdp|15}} This property allows building bridges over roadstops

The bridge height property defines minimum clearances required for a bridge for the sprite layouts of this roadstop (or zero to not allow any bridge). Values are given in "height level" units (1 level == 8px).

The data is specified as minimum height for all sprite layouts in this way:

<pre><num> <height1> <height2> ... <heightn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported
|-
|B||height...||The minimum heights for each of the <num> tiles.
|}

===Blocked Pillar Information (14)===

{{ottdp|15}} Allows information to provided about blocked bridge pillars to assist the game in hiding pillars if necessary depending on what is above the roadstop tile. Blocking a pillar prevents the pillar from being drawn. It does not prevent the roadstop being bridgeable.

The data is specified as blocked pillar flags for all sprite layouts in this way:

<pre><num> <flags1> <flags2> ... <flagsn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported
|-
|B||flags...||The blocked pillar flags for each of the <num> tiles.
|}

<pre><num> <flagsx1> <flagsy1> <flagsx2> <flagsy2> ... <flagsxn> <flagsyn></pre>

The flag bits are as follows:

{| |-
|Bit||Value||Meaning
|-
|0||01||Tile layout blocks a pillar on the west corner of the tile.
|-
|1||02||Tile layout blocks a pillar on the south corner of the tile.
|-
|2||04||Tile layout blocks a pillar on the east corner of the tile.
|-
|3||08||Tile layout blocks a pillar on the north corner of the tile.
|-
|4||10||Tile layout blocks a wall on the north east side of the tile.
|-
|5||20||Tile layout blocks a wall on the south east side of the tile.
|-
|6||40||Tile layout blocks a wall on the south west side of the tile.
|-
|7||80||Tile layout blocks a wall on the north west side of the tile.
|}

These should be combined as needed.

=== Cost multipliers (15) ===

The first byte is the build cost multiplier.

The second byte is the removal cost multiplier.

The total property length is 2 bytes.

A value of 16 produces a build or removal cost the same as non-NewGRF road stops.

== Examples ==

Action0/Stations

2025-08-26T19:22:42Z

Peter1138: Document station minimum height and blocked pillars

==Introduction==

Defining properties of new stations.

Unlike vehicles, the new stations have no equivalent in TTD. The IDs are therefore free to be chosen and will in fact be allocated automatically. In action 0, you only specify IDs relative to the set, i.e. the ID of the first station type is 00, the second station type is 01 and so on.

{{ttdp|}} In TTDPatch each game can only have 255 station IDs for all active grf files.

The only property you '''must''' set for each station ID is 08 (in addition to defining an [[Action3|action 3]] for it), anything else can be left at the default. It must be the first property you set for each station ID, because the station ID is actually undefined until it has been assigned a class through property 08. Also, all station IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|0.6|2.5|ttdprev=alpha 19}}||Class ID, see below
|-
|09||V||{{ottdp|0.6|2.5|ttdprev=alpha 20}}||Sprite layout, see below
|-
|0A||B/B*||{{ottdp|0.6|2.5|ttdprev=alpha 20}}/{{ottdp|14.0}}||Copy sprite layout
|-
|0B||B||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Callback flags
|-
|0C||B||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Bit mask of disabled numbers of platforms
|-
|0D||B||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Bit mask of disabled platform lengths
|-
|0E||V||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Define custom layout, see below
|-
|0F||B/B*||{{ottdp|0.6|2.5|ttdprev=alpha 22}}/{{ottdp|14.0}}||Copy custom layout from stationid given by argument
|-
|10||W||{{ottdp|0.6|2.5|ttdprev=alpha 25}}||Little/lots threshold
|-
|11||B||{{ottdp|0.6|2.5|ttdprev=alpha 27}}||Pylon placement
|-
|12||D||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Bit mask of cargo type triggers for random sprites
|-
|13||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||General flags
|-
|14||B||{{ottdp|0.6|2.5|ttdprev=alpha 47}}||Overhead wire placement
|-
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 51}}||Can train enter tile
|-
|16||W||{{ottdp|0.7|2.5|ttdprev=beta 9}}||Animation information
|-
|17||B||{{ottdp|0.7|2.5|ttdprev=beta 9}}||Animation speed
|-
|18||W||{{ottdp|0.7|2.5|ttdprev=beta 9}}||Animation triggers
|-
|1A||V||{{ottdp|1.2|no|ottdrev=r22518}}||Advanced sprite layout with register modifiers
|-
|1B|| || ||Reserved
|-
|1C||W||{{ottdp|14}}||Station name
|-
|1D||W||{{ottdp|14}}||Station class name
|-
|1E||V||{{ottdp|15}}||Station sprite layout flags
|-
|1F||W n*W||{{ottdp|15}}||List of badges
|}

Unofficial additions and changes. Don't rely on them to ever work this way in OpenTTD or TTDPatch:
{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|1B||8*B||whatever-PP||Minimum bridge height for bridges over stations
|}

== Description ==

=== Station class (08) ===
TTDPatch groups sets of new station graphics into various classes.  The classes can be selected by the top dropdown list in the construction window, and the individual stations within the class from the bottom dropdown list.  In addition, each station can alter its appearance using [[VariationalAction2|variational]] and/or [[RandomAction2|random]] action 2 entries.

Only two classes are pre-defined:

{| |-
!Name!!Class ID!!Intended use for station
|-
|DFLT||44 46 4C 54||Default, no special station type
|-
|WAYP||57 41 59 50||Non-cargo stations, waypoints, signal boxes etc.
|}

You may simply use other classes than the above, as long as no more than (at the moment) 16 classes are used among all active .grf files at any time.

{{ottdp|15}} Station classes which start with the byte FF are considered waypoint classes, and will appear in the waypoint construction window instead of the station construction window.

When a waypoint station is built, it will not accept cargo nor will any cargo appear from nearby industries or towns.  Trains will not stop at waypoint stations, regardless of the non-stop order and/or the nonstop switch.

=== Sprite layout (09) ===
This controls what sprites are displayed, where they are displayed, and in what order.  The property is variable sized, and contains the data for all 8 possible station tile types.  If this property is set, the num-ent in the corresponding [[Action1|action 1]] need not be equal to 12 (hex), it can in fact be any number, and any number of sprites can be displayed in any order.

The data is specified as data for all eight tiles in this way:

<pre><num> <data1> <data2> ... <datan></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported (see below)
|-
|V||data1...||The variable size data for each of the <num> tiles, as specified below
|}

===== Number of tiles supported =====
* Normally this is 8, but you can specify fewer as well
* Using callback flags bit 1, specifying more makes sense too
* This value must be the same for all stations set by this action 0, even though it must be repeated for the prop. 09 definition of each station ID as well

(Note that num is an extended byte, see [[GRFActionsDetailed]].)

The content of each of the (usually eight) data sets is either a new sprite layout:

{| |-
!Size!!Name!!Meaning
|-
|D||groundsprite||the sprite to draw for the rails; this is by default a TTD sprite, but with bit 31 set an [[Action1|action 1]] sprite (42D+X) may be specified
|-
|V||spritedata||the data for station sprites, see below; each has a size of 10 bytes, and there may be several
|-
|B||80||a literal 80 ends the list of sprites for this tile
|}
or, alternatively, the instruction to use TTD's layout by using four zero bytes 00 00 00 00 instead of the groundsprite bytes. You can use [http://www.bytetransfer.de/projects/ttdpatch/docs/spriteidmapping.php the online sprite ID converter] to look up the sprite IDs you can use for all the climates.

One can draw two types of sprites.  One type is one that establishes a new 3D bounding box for use by the sprite sorter.  The other type shares the 3D bounding box of the previous sprite(s).  It must not be larger than the sprite which established the bounding box, nor must any part of it be outside this box.  For simplicity, it should have the exact same dimensions as the sprite it shares the bounding box with.  The latter type is supported in the station construction window display only since TTDPatch 2.6 r1684.

The spritedata of sprites with their own bounding box has this format:

{| |-
!Size!!Name!!Meaning
|-
|B||xofs||x-offset from northern tile corner
|-
|B||yofs||y-offset from northern tile corner
|-
|B||zofs||z-offset from northern tile corner
|-
|B||xextent||size of sprite in x direction
|-
|B||yextent||size of sprite in y direction
|-
|B||zextent||size of sprite in z direction
|-
|D||sprite||sprite number to draw
|}

The spritedata of sprites sharing the bounding box has this format:

{| |-
!Size!!Name!!Meaning
|-
|B||xofs||x-offset relative to previous sprite
|-
|B||yofs||y-offset relative to previous sprite
|-
|B||80||a literal 80
|-
|B||00||(ignored)
|-
|B||00||(ignored)
|-
|B||00||(ignored)
|-
|D||sprite||sprite number to draw
|}

Since OpenTTD r18959 you can draw multiple ground sprites for a tile, which is useful if you want to use the usual rail/grass/concrete groundtile, but still need to add features to it without using a new bounding box. To do so use the syntax of sprites sharing the previous bounding box, but use it before the first bounding box definition. xpixeloffset and ypixeloffset refer to the usual spot of groundtiles. The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2312: TTDPatch ignores the xofs and yofs fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xofs and yofs zero to get the same effect in both games.
Note however that both implementations do not consider the [[Action0/Stations#General_Flags_.2813.29|setting of prop13 bit 0]], hence these "multiple ground sprites" have to be always part of the building sprites set and cannot be part of the different sprite set for ground sprites.

The sprite number can have the following values (remember to use little endian, i.e. reversed byte order):

{| |-
!Number!!Sprite
|-
|0000042D+X||use sprite X from the corresponding [[Action1|action 1]] block (i.e. 0000042D for the first, 0000042E for the second, etc.)
|-
|0000842D+X||same, but draw it using company colour translation
|-
|0322442D+X||same, but draw in transparent mode (actual colours of the sprite are disregarded entirely); supported in station construction window display since TTDPatch 2.6 r1683
|-
|RRRR842D+X||draw sprite with colour translation defined in sprite RRRR; available since TTDPatch 2.6 r1683
|}

With bit 31 set, this sprite will refer to a TTD sprite, not the action 1 sprite. For the first ground sprite the reverse meaning applies.

Depending on the railtype the sprites may get additional offsets:

{| |-
! !! Normal/electrified rail !! Monorail !! Maglev
|-
|TTD sprites || 0 || 82 || 164
|-
|Action 1 sprite (first ground sprite) || 0 || 1 || 2
|-
|Action 1 sprite (other sprites in the layout) || 0 || 0 || 0
|}

So, TTD sprites and the first ground sprite are affected by the railtype, while other action 1 sprites in the layout are not. The offset "82" refers to the offset between the default TTD track sprites; if you are using non-track ground sprites which are not from an action 1, you need to supply fake spritenumbers which preemptively reverse the offsets (that is, you need different sprite layouts for every railtype your station is available for).

Setting bit 30 forces this sprite to be displayed normally even in "transparent buildings" mode (supported only in TTDPatch 2.6 r1695 and later).

See below for an example of linked sprites as well as transparent sprites (e.g. for a station roof).

Note that the coordinates here are 3D coordinates with x running from top-right to bottom-left and y running from top-left to bottom-right, with the tile dimensions being 16x16 (and 8 for one height level). This means the x and y values should always be within 0-15 (decimal).

This is different to and independent from the x/y offsets used in the actual .NFO file.  The 3D bounding box is used by TTD's sprite sorter to figure out the order in which to draw the sprites, as well as telling it which sprites to draw, because those whose bounding box falls outside the currently updated screen rectangle will not be drawn.  Make sure the 3D bounding box is large enough to contain the entire sprite, but not so large that the sprite sorter can't determine which sprites should be in front.

This means that the order in which you specify sprites is irrelevant.  Sprites will get drawn from back to front, in the order which the sprite sorter determines as correct, from their bounding boxes.  There are two exceptions, however:
* Sprites sharing the same bounding box will always be drawn in the given order.
* The station construction window display doesn't use the sprite sorter. Tiles that may be displayed in that window need to be specified in the correct drawing order, back to front.

=== Copy sprite layout (0A) ===

This is not a property as such, but an action.  It takes as argument a byte which is interpreted as station-ID to copy the custom sprite layout from.

Since {{ottdp|14.0}} this property is now an extended byte.

=== Callback flags (0B) ===
For stations, the following [[callbacks]] can be defined by setting the corresponding bit in property 0B:

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||13||Whether to make station available in construction window (non-zero callback return) or not (callback returns zero)
|-
|1||2||14||Use callback to select sprite layout
|-
|2||4||141||Decide next animation frame
|-
|3||8||142||Decide animation speed
|-
|4||10||149||Custom slope check
|}
Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the [[VariationalAction2|VarAction2]] for callbacks.

=== Selection of numbers of platforms and length (0C, 0D) ===

By default all platform lengths and any number of platforms is available for the new stations.  Using these properties, you can choose which ones should be unavailable by setting the corresponding bit in the property.

The values are a byte, used as a bit mask.  Bits 0 to 6 control the availability of number or length 1 to 7, and bit 7 controls the availability of the "+7" button.  Each bit that is set disables the corresponding length or number of platforms.

For compatibility with "largestations off", at least one length between 1 and 5 (bits 0 to 4) and one number of platforms between 1 and 4 (bits 0 to 3) must be available, i.e. at least one of these bits must be unset.

=== Define custom layout (0E) ===

This allows choosing which tile type is built at which tile of a newly built station.  There are four different types, which TTD normally defines as

{| |-
!Tile type!!Appearance
|-
|00||plain platform
|-
|02||platform with building
|-
|04||platform with roof, left side
|-
|06||platform with roof, right side
|}

Since {{ottdp|15}}, all even values up to FE are supported if the sprite layout is defined via property 09/0A.

These numbers are used for stations in NE-SW direction, or these numbers plus one for stations in the NW-SE direction.  To define a custom layout, use this format:

{| |-
!Size!!Name!!Meaning
|-
|B||length||length of platforms for this layout
|-
|B||number||number of platforms for this layout
|-
|V||tiles||length*number bytes of tile types, one platform after another, only 00, 02, 04 or 06 are allowed as values
|}

Repeat this as often as necessary to define the layouts for all supported combinations of length and number.  End the definitions with a 00 00 (zero length and zero number).  Any combinations that are not defined will be built using TTD's default layout.
Note that it may be easier to draw different sprite sets using a [[VariationalAction2|VarAction2]] based on [[VarAction2Stations#Platform info 40 41 46 47 49|station variable 40]], rather than redefining the layout.  In addition, [[Callbacks#Custom station layout 24|callback 24]] will be used to further customize the layout as defined by this property (or by TTD if no prop 0E layout is available). This may also be easier than defining a prop 0E layout for every combination of length and number of platforms.

=== Copy custom layout (0F) ===

Similar to property 0A, this copies the custom layout from the station-ID given by the argument.

Since {{ottdp|14.0}} this property is now an extended byte.

=== Little/lots threshold (10) ===
Amount of cargo for switching from "little" to "lots" of cargo.  TTDPatch separates the full range of cargo amounts (0 to 4095) into two separate subranges, "little" and "lots" of cargo.  This allows better control of cargo amount based graphics (if needed).  Property 10 specifies at what amount of cargo the patch is to switch from one to the other subrange.  See [[Action2Stations|Action 2 for stations]] for more information.

=== Pylon placement (11) and wire placement (14) ===
Prop. 11 sets which tile types should have pylons when used with electrified tracks. By default, tiles 0-3 (default stations without roof) have pylons, and tiles 4-7 (default stations with roof) don't. This is a bit mask of tile types, with a bit set meaning that a pylon should be drawn. The tile types here do not consider [[Callbacks#Station sprite layout 14|callback 14]], but rather the type as it was built, i.e. from prop. 0E.

Prop. 14 works in a similar way, except that it sets the tile types on which there should be ''no'' wires displayed. With the default value of "00", wires are displayed everywhere, and for each bit set, the wire is omitted on that tile type.

This property should only be used when the wires cause problems with the sprite sorter, because even when the wire is obscured by a station hall or similar, it should still show up in transparent mode so that each tile can easily be verified as being electrified.

{{ottdp|15}} Note: This property only allows setting the flags of the first 8 sprite layouts. Use Property 1E instead to set flags when more sprite layouts are used via prop. 0E or [[Callbacks#Custom_station_layout_.2824.29|callback 24]].

=== Cargo types for random triggers (12) ===

This sets which cargo types should trigger re-randomizing. The cargo types are given as a bitmask of the bits from column 3 (type B) in CargoTypes.  If nothing is set (the default), the no random triggers will happen, to conserve CPU time.

With GRF version 7 and above, the interpretation of bits changes. Instead of climate-dependent cargo slot numbers (type B), you have to set the bits of climate-independent cargo ID (type A).

{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.

=== General Flags (13) ===

{| |-
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|0.7|2.5}}||use different sprite set for ground sprites ([[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|var. 10]] is 1 for ground sprites, 0 otherwise)
|-
|1||2||{{ottdp|0.6|2.5}}||when calculating the cargo amount to display, divide the amount by the station size (to simulate cargo distributed over the area of the station)
|-
|2||4||{{ottdp|0.7|2.5}}||[[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] needs random bits in var. 10
|-
|3||8||{{ottdp|1.0|2.6}}||Use custom foundations on sloped tiles (the lowest byte of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|var. 10]] is 2 for foundation sprites)
|-
|4||10||{{ottdp|1.0|2.6}}||When bit 3 is set, use extended foundation block instead of the simple one
|}

Bit 3 works somewhat similarly to bit 0: your sprite selection will be called again, with 2 in the lowest byte of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 10]]. If the chain ends on a callback result, the program will assume the foundation selection has failed and will use the default foundaton sprites. The low word of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 18]] will contain the tile type of the current tile; if you have [[Callbacks#Station sprite layout (14)|callback 14]] enabled, this will be the its return value - otherwise, the default TTD types (platform with building, platform with left roof etc.) are used. In either case, one is added for the NW-SE orientation, in case your station needs different foundations depending on its orientation. Bits 16 and 17 are set if the NW and and NE foundations are to merged with the corresponding neighbour tile, so you shouldn't draw the corresponding edge in the foundation sprite. Other bits of variable 10 and variable 18 are reserved for future use.

Your sprite selection code should select a foundation sprite block. The contents of this block depends on whether bit 4 is set or not.
* Bit 4 clear (simple foundations):
[[File:simple_foundations.png]]

The programme will combine the needed foundation from these 8 sprites depending on the current slope. You don't need to care about the merge data in bits 16..17 of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 18]]; it will be taken care of that automatically by adding the 7th and 8th sprite only when necessary.
* Bit 4 set (extended foundations):
[[File:extended_foundations.png]]

You need to have one sprite for every slope that's possible below a rail station. The correct one will be automatically selected depending on the current slope. It can't handle the merging itself, however, so you need four foundation blocks: one with no edges removed, one with the NW edge removed, one with the NE edge removed and one with both north edges removed. Your sprite selection code is responsible for selecting the correct of those blocks according to the merge info in [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 18]].

In both cases, you can put an additional value into register 100h, which will serve as an offset into the selected block. If you don't modify register 100h during the chain, it will default to 0. It is important that the dimensions of these sprites remain the same - thus bit 6 in the real sprites must be set to prevent GRFCodec from trimming the empty blue areas. The offset of these foundations must be -31 to the X direction and -9 to the Y direction.

=== Can train enter tile (15) ===

Like props. 11 and 14, this value contains eight bits relating to the eight possible tile types. If a bit is set, trains are prevented from routing through or entering any tile of this type.

{{ottdp|15}} Note: This property only allows setting the flags of the first 8 sprite layouts. Use Property 1E instead to set flags when more sprite layouts are used via prop. 0E or [[Callbacks#Custom_station_layout_.2824.29|callback 24]].

=== Animation information (16) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this station (this is the default value).
Since you can't have properties for individual station tiles, this property applies for every tile of the station. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] for that.

=== Animation speed (17) ===
The meaning is the same as for [[Action0Houses#Animation Speed 1B|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.

=== Animation triggers (18) ===
This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]], allowing to change the animation state

{| |-
!Property bit, var18 byte 0!!Property value!!Version!!Meaning!!Happens on!!Var 18 byte 1
|-
|0||1||{{ottdp|0.7|2.5}}||Station part is built||the newly built tiles||
|-
|1||2||{{ottdp|0.7|2.5}}||New cargo arrives to station||whole station||Cargo type <ref name="cargotype">Bits 8..15 of var 18 contain the triggering cargo type. If your GRF has a cargo translation table, the cargo type will be an index in that table, or FFh if the cargo isn't in the table. If you don't have a cargo translation table, the cargo type will simply be the climate-dependent cargo type number.</ref>
|-
|2||4||{{ottdp|0.7|2.5}}||A cargo type gets removed from station||whole station||Cargo type <ref name="cargotype"/>
|-
|3||8||{{ottdp|0.7|2.5}}||Train enters station (starts loading/unloading)||platform where the train is||
|-
|4||10||{{ottdp|0.7|2.5}}||Train leaves station (done loading/unloading)||platform where the train is||
|-
|5||20||{{ottdp|1.2|2.5|ottdrev=r22746}}||Train loads/unloads cargo||platform where the train is||
|-
|6||40||{{ottdp|0.7|2.5}}||Every 250 ticks||whole station||
|-
|7||80||{{ottdp|15|no}}||Tile is processed in the periodic processing loop||single tile||
|-
|8||100||{{ottdp|15|no}}||Train reserves platform (using PBS)||platform where the train reserved||
|}

The remaining bits are reserved for future triggers, they must be zero for now.

The "happens on" column tells which tiles will [[Callbacks#Animation control (1B/25/140/152/159) |callback 140]] be called on.

<references/>

=== Advanced sprite layout with register modifiers (1A) ===

{{ottdp|1.2|no|ottdrev=r22518}}
Format:
1A <num-layouts> <0x40 + num-sprites>
<groundsprite> <flags> [<register/value>]...
[ <buildingsprite> <flags>
( <xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>
| <xpixeloffset> <ypixeloffset> 80)
[<register/value>]...
]...

For further details see [https://wiki.openttd.org/en/Archive/Development/Advanced%20Sprite%20Layout#stations here] for now.

=== Minimum bridge height (1B) ===

This property allows building bridges over stations.

The bridge height property defines minimum clearances required for a bridge for each of the four [[Action0/Stations#Define_custom_layout_.280E.29|tile types]] of this station (or zero to not allow any bridge). Values are given in "height level" units (1 level == 8px).

{| class="wikitable" |-
!Height (1)!!Appearance
|-
| style="text-align:center;" |x1 y1 ||plain platform
|-
| style="text-align:center;" |x2 y2 ||platform with building
|-
| style="text-align:center;" |x3 y3 ||platform with roof, left side
|-
| style="text-align:center;" |x4 y4 ||platform with roof, right side
|}
(1) where the values are one byte pairs (x-direction, y-direction) expressed in hexadecimal notation.

Syntax:

1B <1st pair> <2nd pair> <3rd pair> <4th pair> 
1B x1 y1 x2 y2 x3 y3 x4 y4 
1B 01 01 02 02 03 03 03 03 // 8px 16px 24px 24px

This property is currently only available for JGR's Patch Pack (v0.26.0 and later) and the developmental "New Map Features" (NMF) fork of OpenTTD.

=== Station name (1C) ===

=== Station class name (1D) ===

=== Station sprite layout flags (1E) ===

{{ottdp|15}} Since OpenTTD supports more than 8 sprite layouts to be used, props. 11, 14 and 15 are not sufficient to set the flags for all usable sprite layouts. This property is variable length and allows these flags to be set for each tile beyond the original limit of 8.

The data is specified as flags for all sprite layouts in this way:

<pre><num> <flags1> <flags2> ... <flagsn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported (see below)
|-
|B||flags1...||The flags for each of the <num> tiles, as specified below
|}

The flag values are as follows:

{| |-
|Bit||Value||Meaning
|-
|0||01||Tile should contain catenary pylons.
|-
|1||02||Tile should NOT contain catenary wires.
|-
|2||04||Tile is blocked to vehicles.
|}

These should be combined as needed.

===Minimum Bright Height (20)===

{{ottdp|15}} This property allows building bridges over stations.

The bridge height property defines minimum clearances required for a bridge for the sprite layouts of this station (or zero to not allow any bridge). Values are given in "height level" units (1 level == 8px).

The data is specified as minimum height for all sprite layouts in this way:

<pre><num> <height1> <height2> ... <heightn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported (see below)
|-
|B||height...||The minimum heights for each of the <num> tiles.
|}

===Blocked Pillar Information (21)===

{{ottdp|15}} Allows information to provided about blocked bridge pillars to assist the game in hiding pillars if necessary depending on what is above the station tile. Blocking a pillar prevents the pillar from being drawn. It does not prevent the station being bridgeable.

The data is specified as blocked pillar flags for all sprite layouts in this way:

<pre><num> <flags1> <flags2> ... <flagsn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported (see below)
|-
|B||flags...||The blocked pillar flags for each of the <num> tiles.
|}

The flag bits are as follows:

{| |-
|Bit||Value||Meaning
|-
|0||01||Tile layout blocks a pillar on the west corner of the tile.
|-
|1||02||Tile layout blocks a pillar on the south corner of the tile.
|-
|2||04||Tile layout blocks a pillar on the east corner of the tile.
|-
|3||08||Tile layout blocks a pillar on the north corner of the tile.
|-
|4||10||Tile layout blocks a wall on the north east side of the tile.
|-
|5||20||Tile layout blocks a wall on the south east side of the tile.
|-
|6||40||Tile layout blocks a wall on the south west side of the tile.
|-
|7||80||Tile layout blocks a wall on the north west side of the tile.
|}

These should be combined as needed.

== Examples ==

=== Using TTD's sprite layouts for certain tiles ===

To use TTD's layout, you use <code>00 00 00 00</code> for the ground sprite number and leave off everything else.

So instead of for example

F4 03 00 00
00 00 00 10 05 02 2E 84 00 00
00 0B 00 10 05 02 30 84 00 00
80

you just put

00 00 00 00

=== Using transparent sprites ===

You can use transparent sprites to make for example the roof translucent like in TTD's stations. The roof of TTD's stations is made like this:

00 00 10 10 10 0A 37 84 00 00
00 00 80 00 00 00 3B 44 22 03

The first sprite here is the non-transparent frame of the roof, drawn in company colours (it has bit 15 set). The second part is a special "linked" sprite without its own bounding box, it shares that of the previous sprite. That's done by setting the z offset to 80.

To make that second sprite transparent, bit 14 is set in the sprite number, and the upper word is set to 322 (*), so 0322443B means to take sprite 43B and draw it in transparent mode. The colours of that sprite are ignored entirely, every pixel in colour 0 is fully transparent, and all other pixels are semi-transparent (essentially just causing what they are drawn over to become darker).

(*) This is the [[RecolorSprites#Default_recolour_sprites | recolour sprite]] for the glass effect.

Action0/Bridges

2025-08-15T22:21:29Z

Peter1138: Bridge pillars

==Introduction==

Defining properties of bridges. By default the following bridges are defined:

{| |-
!'''ID (dec)'''!!'''ID (hex)'''!!'''Description'''
|-
|0||00||Wooden Bridge
|-
|1||01||Concrete Bridge
|-
|2||02||Girder, Steel Bridge
|-
|3||03||Suspension, Concrete Bridge
|-
|4||04||Suspension, Steel (Bronze) Bridge
|-
|5||05||Suspension, Steel (Golden) Bridge
|-
|6||06||Cantilever, Steel (Bronze) Bridge
|-
|7||07||Cantilever, Steel (Brown) Bridge
|-
|8||08||Cantilever, Steel (Red) Bridg
|-
|9||09||Girder, Steel Bridge
|-
|10||0A||Tubular, Steel (Bronze) Bridge
|-
|11||0B||{{ottdp|0.6|no}} Tubular, Steel (Golden) Bridge
|-
|12||0C||{{ottdp|0.6|no}} Tubular, Silicon Bridge
|}

==Properties==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|00||B||{{ottdp|no|2.6|ttdprev=r1994}}||Failback Type, a default TTD Bridge ID
|-
|08<ref>The meaning of prop. 08 has changed in TTDPatch 2.0.1 alpha 34, it used to be what is now prop. 0D.</ref>||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Year of availability, counted from 1920 (set to 1920 for first bridge if newstartyear<1930)
|-
|09||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Minimum length, not counting ramps
|-
|0A||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Maximum length, not counting ramps
|-
|0B||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Cost factor
|-
|0C||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Max. speed
|-
|0D||V||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Sprite layout, see below
|-
|0E||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Various flags, bitcoded
|-
|0F||D||{{ottdp|0.6|2.5|ttdprev=r1702|ottdrev=r7191}}||Long format year of availability, counted from year 0
|-
|10||W||{{ottdp|0.6|2.5|ttdprev=r1824|ottdrev=r10269}}||Purchase text
|-
|11||W||{{ottdp|0.6|2.5|ttdprev=r1824|ottdrev=r10269}}||Description of a rail bridge
|-
|12||W||{{ottdp|0.6|2.5|ttdprev=r1824|ottdrev=r10269}}||Description of a road bridge
|-
|13||W||{{ottdp|0.7|2.6|ttdprev=r1994|ottdrev=r14172}}||Cost factor word access
|-
|15||V||{{ottdp|15.0}}||Pillar information
|}
<references/>

Unofficial additions and changes. Don't rely on them to ever work this way or at all in OpenTTD or TTDPatch:
{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|14||D||New Map Features||Menu icons <ref name="nmf">New Map Features (NMF) adds three bridge IDs (0x0D ... 0x0F). There are no graphics. Currently Graphic Resource Management (GRM) must be used to assign real sprites.</ref>
|}
<references/>

==Descriptions==

===Maximum speed (0C)===
Speed limit in mph*1.6 (approx. km/h). From {{ottdp|13|no}} set to "0" for no limit at all.

===Sprite layout (0D)===

Property 0D sets the sprite layout for bridges. Each part of a bridge has eight sprites for each of the four types (rail, road, monorail, maglev), making 32 sprites in total. Each bridge has 7 parts, though not all of them have different graphics.

The data for property 0D is variable sized, with the format being

{| |-
!Size!!Field!!Description
|-
|B||tableid||First table to define sprites for
|-
|B||numtables||Number of tables to define sprites for
|-
|V||spritedata||spritedata, numtables*32 DWORDs with sprite numbers
|}

The tableid is the number of the first table to change. There are seven tables for each bridge, with the first six (0-5) being various middle parts and the last one (6) being the end pieces.

In each of the six middle part tables, there are four entries each for the following:
* Rail X, Rail Y, Road X, Road Y, Monorail X, Monorail Y, Maglev X, Maglev Y

Where X is a bridge in /-direction and Y a bridge in \-direction.

The four entries are
* Back & Floor, Front, Pillars, 0

Front and Pillars can be 0, meaning no sprite to draw. The fourth entry is always ignored.

In the end part table, there are again four entries each, but now for Rail flat, Rail ramp, Road flat, Road ramp, Monorail flat, Monorail ramp and Maglev flat, Maglev ramp.

The four entries in this case are
* northern end X, northern end Y, southern end X, southern end Y

The sprite numbers can be any of TTD's sprite numbers.

To summarize, there are 7 tables for each of the 11 bridges. Each table contains 4*8 entries, making it 128 (80h) bytes large. The first six tables, number 0 to 5, are middle pieces, the last table, number 6, is the end pieces.

====Colour Translations====

In order to recolour a bridge, you can add one of the values from the table below to the sprite number of the sprite you wish to recolour. The colour translations from the table will use the default colour translation tables from the base sets. These translation tables will translate the 'brownish red' as used in the default bridges to the colour you specify.

{| |-
!'''Added value'''!!'''Little Endian'''!!'''Colour'''
|-
|031B8000h||00 80 1B 03||Blue
|-
|031C8000h||00 80 1C 03||Brown
|-
|031D8000h||00 80 1D 03||Pure white
|-
|031E8000h||00 80 1E 03||Red
|-
|031F8000h||00 80 1F 03||Green
|-
|03208000h||00 80 20 03||Blueish white (concrete)
|-
|03218000h||00 80 21 03||Yellow (golden steel)
|}

Take a look at the [[RecolorSprites#Default_recolour_sprites | default recolour tables]] for other colour translations. However, other recolor maps than the seven listed above will translate other colours than those uses by original bridges.

''Example: Translate sprite 4366 to yellow''
:4366 translates to 0E 11 in little endian value and as such to 0E 11 00 00 in a dword. In order to convert to yellow you'll have to add 00 80 21 03 to the dword value. This yields 0E 91 21 03. Use the latter in your bridge table to colour one of the monorail bridgeheads grey.

====Bridge Layouts====

There are five possible bridge layouts in TTD. The numbers in the table below reflect the bridge table numbers in the NFO code.

{| |-
!Layout!!Description
|-
|__ ||Bridge without middle part
|-
|_0_||Bridge of length 3
|-
|_0(23)1_||Bridge of even length
|-
|_0(23)4(23)1_||Bridge of (uneven) lengths 5, 9, 13, 17 etc.
|-
|_0(23)253(23)1_||Bridge of (uneven) lengths 7, 11, 15, 19 etc.
|}

_ is used as a symbol to indicate bridgeheads (as defined in table 6).

Part 0 is always at the farthest end from the viewer.

Parts (23) are repeated ''n'' times as necessary, where ''n'' is any number equal or greater than 0.

===Flags (0E)===

The following flags can be set here:

{| |-
!'''Bit'''!!'''Value'''!!'''Meaning'''
|-
|0||1||Do not draw the far pillars for higher bridges
|}

===Long format year of availability (0F)===

Set the year of availability of the bridge in years since 0. The date range is from 0 to 5000000. This property must be set after property 08 to take effect.

{{ottdp|no||}} In TTDPatch, bridge introduction dates outside the range 1920..2175 will be limited to this range.

===Purchase text (10)===

Set the text appearing in the purchase window, describing what this bridge is made of, or what kind of bridge it is.

This should be the ID of an original bridge name, or a TextID in the DCxx range.

===Description of a rail(11) or road(12) bridge===

Set the text used as a description by the query tool. When the bridge is used for carrying a rail, it will use property 11, and will use property 12 when it will be for road.

This should be the ID of an original bridge name, or a TextID in the DCxx range.

===Menu icons (14)===

Previously menu icons could be replaced by an ActionA, with the exception of the six recolor bridges which always retained a recolored icon of one of the three parent bridges.
Property 14 allows all icons to be accessed including the three new bridge IDs (0D, 0E, 0F) in cirdan's New Map Features.

Note: This property is currently only available for the developmental "New Map Features" (NMF) fork of OpenTTD.

===Pillar information (15)===

{{ottdp|15}} Allows information to provided about bridge pillars to assist the game in hiding pillars if necessary depending on what is below a bridge.

The data is specified a pair of flags (for x-axis and y-axis) for all bridge pieces in this way:

<pre><num> <flagsx1> <flagsy1> <flagsx2> <flagsy2> ... <flagsxn> <flagsyn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different bridge pieces supported (see below)
|-
|B||flagsx||The flags for the x-axis of a bridge piece.
|-
|B||flagsy||The flags for the y-axis of a bridge piece.
|}

The flag bits are as follows:

{| |-
|Bit||Value||Meaning
|-
|0||01||Bridge piece has a pillar on the west corner of the tile.
|-
|1||02||Bridge piece has a pillar on the south corner of the tile.
|-
|2||04||Bridge piece has a pillar on the east corner of the tile.
|-
|3||08||Bridge piece has a pillar on the north corner of the tile.
|-
|4||10||Bridge piece has a wall on the north east side of the tile.
|-
|5||20||Bridge piece has a wall on the south east side of the tile.
|-
|6||40||Bridge piece has a wall on the south west side of the tile.
|-
|7||80||Bridge piece has a wall on the north west side of the tile.
|}

These should be combined as needed.

==Example==

Below is an example code which rebuilds the bronze steel suspension bridge (ID 04). The code fragment by itself has no use (no visual difference in game), but might be useful in order to understand the bridge code. Sprite numbers refer to the numbers in the base grf. The code might also be useful to re-enstate the default bridge if you only want to replace only one certain tracktype.

The complete recode of all default bridges including colour translations is available at TT-Forums: https://www.tt-forums.net/viewtopic.php?f=26&t=75209&p=1221899#p1221899

<pre>//SUSPENSION, STEEL (BRONZE) bridge (04)

-1 * 0 00 06 01 01 04 0D 00 07 //action 00 bridges, 01 property, 01 ID, ID, prop 0D, tableID 00, 07 tables

//table 00

A9 09 00 00 9F 09 00 00 B1 09 00 00 00 00 00 00 //rail X: Back&Floor, Front, Pillars, 0
A5 09 00 00 97 09 00 00 AD 09 00 00 00 00 00 00 //rail Y: Back&Floor, Front, Pillars, 0
9D 09 00 00 9F 09 00 00 B1 09 00 00 00 00 00 00 //Road X: Back&Floor, Front, Pillars, 0
95 09 00 00 97 09 00 00 AD 09 00 00 00 00 00 00 //Road Y: Back&Floor, Front, Pillars, 0
F2 10 00 00 9F 09 00 00 B1 09 00 00 00 00 00 00 //Mono X: Back&Floor, Front, Pillars, 0
EE 10 00 00 97 09 00 00 AD 09 00 00 00 00 00 00 //Mono Y: Back&Floor, Front, Pillars, 0
1A 11 00 00 9F 09 00 00 B1 09 00 00 00 00 00 00 //Mlev X: Back&Floor, Front, Pillars, 0
16 11 00 00 97 09 00 00 AD 09 00 00 00 00 00 00 //Mlev Y: Back&Floor, Front, Pillars, 0
//table 01
AA 09 00 00 A0 09 00 00 B2 09 00 00 00 00 00 00 //rail X: Back&Floor, Front, Pillars, 0
A6 09 00 00 98 09 00 00 AE 09 00 00 00 00 00 00 //rail Y: Back&Floor, Front, Pillars, 0
9E 09 00 00 A0 09 00 00 B2 09 00 00 00 00 00 00 //Road X: Back&Floor, Front, Pillars, 0
96 09 00 00 98 09 00 00 AE 09 00 00 00 00 00 00 //Road Y: Back&Floor, Front, Pillars, 0
F3 10 00 00 A0 09 00 00 B2 09 00 00 00 00 00 00 //Mono X: Back&Floor, Front, Pillars, 0
EF 10 00 00 98 09 00 00 AE 09 00 00 00 00 00 00 //Mono Y: Back&Floor, Front, Pillars, 0
1B 11 00 00 A0 09 00 00 B2 09 00 00 00 00 00 00 //Mlev X: Back&Floor, Front, Pillars, 0
17 11 00 00 98 09 00 00 AE 09 00 00 00 00 00 00 //Mlev Y: Back&Floor, Front, Pillars, 0
//table 02
AC 09 00 00 A4 09 00 00 B4 09 00 00 00 00 00 00 //rail X: Back&Floor, Front, Pillars, 0
A8 09 00 00 9C 09 00 00 B0 09 00 00 00 00 00 00 //rail Y: Back&Floor, Front, Pillars, 0
A2 09 00 00 A4 09 00 00 B4 09 00 00 00 00 00 00 //Road X: Back&Floor, Front, Pillars, 0
9A 09 00 00 9C 09 00 00 B0 09 00 00 00 00 00 00 //Road Y: Back&Floor, Front, Pillars, 0
F5 10 00 00 A4 09 00 00 B4 09 00 00 00 00 00 00 //Mono X: Back&Floor, Front, Pillars, 0
F1 10 00 00 9C 09 00 00 B0 09 00 00 00 00 00 00 //Mono Y: Back&Floor, Front, Pillars, 0
1D 11 00 00 A4 09 00 00 B4 09 00 00 00 00 00 00 //Mlev X: Back&Floor, Front, Pillars, 0
19 11 00 00 9C 09 00 00 B0 09 00 00 00 00 00 00 //Mlev Y: Back&Floor, Front, Pillars, 0
//table 03
AB 09 00 00 A3 09 00 00 B3 09 00 00 00 00 00 00 //rail X: Back&Floor, Front, Pillars, 0
A7 09 00 00 9B 09 00 00 AF 09 00 00 00 00 00 00 //rail Y: Back&Floor, Front, Pillars, 0
A1 09 00 00 A3 09 00 00 B3 09 00 00 00 00 00 00 //Road X: Back&Floor, Front, Pillars, 0
99 09 00 00 9B 09 00 00 AF 09 00 00 00 00 00 00 //Road Y: Back&Floor, Front, Pillars, 0
F4 10 00 00 A3 09 00 00 B3 09 00 00 00 00 00 00 //Mono X: Back&Floor, Front, Pillars, 0
F0 10 00 00 9B 09 00 00 AF 09 00 00 00 00 00 00 //Mono Y: Back&Floor, Front, Pillars, 0
1C 11 00 00 A3 09 00 00 B3 09 00 00 00 00 00 00 //Mlev X: Back&Floor, Front, Pillars, 0
18 11 00 00 9B 09 00 00 AF 09 00 00 00 00 00 00 //Mlev Y: Back&Floor, Front, Pillars, 0
//table 04
B6 09 00 00 BA 09 00 00 BC 09 00 00 00 00 00 00 //rail X: Back&Floor, Front, Pillars, 0
B5 09 00 00 B9 09 00 00 BB 09 00 00 00 00 00 00 //rail Y: Back&Floor, Front, Pillars, 0
B8 09 00 00 BA 09 00 00 BC 09 00 00 00 00 00 00 //Road X: Back&Floor, Front, Pillars, 0
B7 09 00 00 B9 09 00 00 BB 09 00 00 00 00 00 00 //Road Y: Back&Floor, Front, Pillars, 0
F7 10 00 00 BA 09 00 00 BC 09 00 00 00 00 00 00 //Mono X: Back&Floor, Front, Pillars, 0
F6 10 00 00 B9 09 00 00 BB 09 00 00 00 00 00 00 //Mono Y: Back&Floor, Front, Pillars, 0
1F 11 00 00 BA 09 00 00 BC 09 00 00 00 00 00 00 //Mlev X: Back&Floor, Front, Pillars, 0
1E 11 00 00 B9 09 00 00 BB 09 00 00 00 00 00 00 //Mlev Y: Back&Floor, Front, Pillars, 0
//table 05
BD 09 00 00 C1 09 00 00 00 00 00 00 00 00 00 00 //rail X: Back&Floor, Front, Pillars, 0
BE 09 00 00 C2 09 00 00 00 00 00 00 00 00 00 00 //rail Y: Back&Floor, Front, Pillars, 0
BF 09 00 00 C1 09 00 00 00 00 00 00 00 00 00 00 //Road X: Back&Floor, Front, Pillars, 0
C0 09 00 00 C2 09 00 00 00 00 00 00 00 00 00 00 //Road Y: Back&Floor, Front, Pillars, 0
F8 10 00 00 C1 09 00 00 00 00 00 00 00 00 00 00 //Mono X: Back&Floor, Front, Pillars, 0
F9 10 00 00 C2 09 00 00 00 00 00 00 00 00 00 00 //Mono Y: Back&Floor, Front, Pillars, 0
20 11 00 00 C1 09 00 00 00 00 00 00 00 00 00 00 //Mlev X: Back&Floor, Front, Pillars, 0
21 11 00 00 C2 09 00 00 00 00 00 00 00 00 00 00 //Mlev Y: Back&Floor, Front, Pillars, 0
//table 06
86 09 00 00 88 09 00 00 85 09 00 00 87 09 00 00 //rail flat: northern end X, northern end Y, southern end X, southern end Y
8A 09 00 00 8C 09 00 00 89 09 00 00 8B 09 00 00 //rail ramp: northern end X, northern end Y, southern end X, southern end Y
8E 09 00 00 90 09 00 00 8D 09 00 00 8F 09 00 00 //road flat: northern end X, northern end Y, southern end X, southern end Y
92 09 00 00 94 09 00 00 91 09 00 00 93 09 00 00 //road ramp: northern end X, northern end Y, southern end X, southern end Y
E7 10 00 00 E9 10 00 00 E6 10 00 00 E8 10 00 00 //mono flat: northern end X, northern end Y, southern end X, southern end Y
EB 10 00 00 ED 10 00 00 EA 10 00 00 EC 10 00 00 //mono ramp: northern end X, northern end Y, southern end X, southern end Y
0F 11 00 00 11 11 00 00 0E 11 00 00 10 11 00 00 //mlev flat: northern end X, northern end Y, southern end X, southern end Y
13 11 00 00 15 11 00 00 12 11 00 00 14 11 00 00 //mlev ramp: northern end X, northern end Y, southern end X, southern end Y

NML:Objects

2025-06-06T11:15:02Z

Peter1138: /* Object properties */

{{NMLNavPropVarCB}}

==Object IDs==
OpenTTD supports 64000 object types per game, and 255 object IDs per grf file.

{{ottdp|14.0|no}} 64000 object IDs per grf file are supported since OpenTTD 14.0.

Object IDs are NewGRF-local and can therefore freely be chosen within the ID ranges.

An object is allocated by setting the 'class'-property, which should therefore be set first.

Overriding the default objects (e.g. transmitter, lighthouse) is not (yet) possible.

==Object properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| class
| String literal of length 4
|
Unlike station classes, there is currently no default yet. '''This property ''must'' be set first, before any other properties or graphics.''' Characters allowed in the IDs are A-Z, 0-9. While you are technically free to chose your own class, it's highly recommended you stick to one of the [[#Default object classes|default classes]].
|-
| classname
| string
| You only need to set this for one object in every class.
|-
| name
| string
|
|-
| climates_available
| bitmask(CLIMATE_XXX, CLIMATE_YYY, ...)
| XXX = [TEMPERATE <nowiki>|</nowiki> ARCTIC <nowiki>|</nowiki> TROPICAL <nowiki>|</nowiki> TOYLAND], alternatively NO_CLIMATE or ALL_CLIMATES
|-
| size
| [x, y]
| Size in x and y direction. Both x and y must be compiletime constants
|-
| build_cost_multiplier
|
| multiplicator to the base purchase cost
|-
| remove_cost_multiplier
|
| multiplicator to the base removal cost
|-
| introduction_date
| date
| The date this object becomes available to build.
|-
| end_of_life_date
| date
| The last date this object is buildable. Must be at least 365 days after introduction_date
|-
| object_flags
| bitmask(OBJ_FLAG_XXX, OBJ_FLAG_YYY)
|
See [[#List of object flags|list of object flags]]
|-
| animation_info
| Array [ANIMATION_XXX, frame-count]
| XXX = [LOOPING <nowiki>|</nowiki> NON_LOOPING], 1..253 frames
|-
| animation_speed
| 0..16
|
Speed of animation, see [[NML:Animation speed|animation speed table]] for the meaning of the values.
|-
| animation_triggers
|
|
See [[#Animation_triggers|list of animation triggers]]
|-
| callback_flags
| bitmask(OBJ_CBF_XXX, OBJ_CBF_YYY)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| height
| 0..255
| Height of the object / 8. For example if your object is 16 pixels height you should set height to 2. In OpenTTD this property is used to determine the height of the build object window; the height for the object preview is set to 32 + "value of property" * 8. The property is also used to determine how high a bridge must be if it is allowed by the bit in object_flags.
|-
| num_views
| 1, 2 or 4
| Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. For non-square objects, x and y sizes are swapped for odd views. Use variable <code style="color:darkgreen">view</code> to determine the view of a built object. Views should be used for rotations or minor variations, not for objects of different types as those should just be different object types which provides a better experience for players. Using separate objects is better for discoverability, naming, filtering, used state, favourite state, and badges.
|-
| count_per_map256
| 0..255
| {{ottd|1.4|r25878}} Measure for the amount of objects placed on a map of 256^2 tiles. (Comparison: there are 15 transmitter)
|}

===Default object classes===

Please refer to the [[ObjectLabels|list of object labels]] in the NewGRF Specs. The default class names listed there are recommended, you still need to set the class name for at least one object in every class or you risk to end up with objects in a class without a name. If multiple NewGRFs define objects for the same class the name defined in the last NewGRF will be used.

===List of object flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| OBJ_FLAG_ONLY_SE
| Only available in the scenario editor (incompatible with OBJ_FLAG_ONLY_INGAME).
|-
| OBJ_FLAG_IRREMOVABLE
| Object cannot be removed with the normal dynamite tool. In OpenTTD you can only remove the object with the magic bulldozer cheat, in TTDPatch you can remove it by holding ctrl while using the bulldozer tool. The cost of removing this object is multiplied by 25.
|-
| OBJ_FLAG_ANYTHING_REMOVE
| Anything can remove this object (owned land behavior).
|-
| OBJ_FLAG_ON_WATER
| Allow construction of the object on water. Note that if an object is allowed to be built both on land and on water, then it will resist being flooded and will not flood adjacent tiles.
This flag has the same effect as using ''GROUNDSPRITE_WATER'' for the ground sprite in the spritelayout.
|-
| OBJ_FLAG_REMOVE_IS_INCOME
| Removal cost is actually income (owned land behaviour).
|-
| OBJ_FLAG_NO_FOUNDATIONS
| Do not display foundations if on a slope.
|-
| OBJ_FLAG_ANIMATED
| Setting this flag will allow the object's animation counter to be increased, must be set if you plan to make use of animations.
|-
| OBJ_FLAG_ONLY_INGAME
| Only available during game play (incompatible with OBJ_FLAG_ONLY_SE).
|-
| OBJ_FLAG_2CC
| Allows 2cc mapping for objects instead of the default 1cc.
|-
| OBJ_FLAG_NOT_ON_LAND
| Disallows construction on land (implies OBJ_FLAG_ON_WATER).
|-
| OBJ_FLAG_DRAW_WATER
| Draws the water under the object. Only applies when built on top of a water tile, also replaces the ground tile of the object completely. Does not work when object built on sloped water tiles.
|-
| OBJ_FLAG_ALLOW_BRIDGE
| Allow bridge over the object taking the building height into account.
|-
| OBJ_FLAG_RANDOM_ANIMATION
| Random bits in the "next animation frame" callback.
|-
| OBJ_FLAG_SCALE_BY_WATER
| Scale amount of objects placed on map generation not by map area, but roughly by the length of the coastline
|}

==Object variables==

{| class="wikitable sortable"
! name
! value range
! comment
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| terrain_type
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|
|-
| tile_slope
| SLOPE_XXX
|
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| build_date
|
| The date this object was build.
|-
| animation_frame
| 0 .. (frame_count - 1)
| Current animation frame, with the maximum defined in the object's <code style="color:darkgreen">animation_info</code> property.
|-
| colour
| COLOUR_XXX
|
Colour used for the company colour mask. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| owner
| 0..0x10
| CompanyID of the owner of the object or 0x10 if it was build in the scenario editor
|-
| town_manhattan_dist
|
| Manhattan distance to the nearest town
|-
| town_euclidean_dist
|
| Euclidean distance to the nearest town
|-
| town_zone
|
[[NML:List of town zones|town zone]]
| The town zone of the current tile. The town zone from the closest town (measured in manhattan distance) is used.
|-
| view
| 0 .. (<code style="color:darkgreen">num_views</code> - 1)
|
{{ottd|1.1|r21455}} The view of the particular object. See also the <code style="color:darkgreen">num_views</code> property.
|}

Variables that require one or more parameters:

{| class="wikitable sortable"
! name
! arguments
! value range
! comment
|-
| nearby_tile_object_type
| x, y offset (-8..7)
|
| ID of the object on a nearby tile, if defined by the same grf. OBJECT_TYPE_OTHER_GRF if the object is defined by a different grf (or none at all). OBJECT_TYPE_NO_OBJECT if the tile does not contain an object.
|-
| nearby_tile_object_view
| x, y offset (-8..7)
|
| {{ottdp|1.4|no|ottdrev=r26316}} View of the object on a nearby tile, if defined by the same grf.
|-
| nearby_tile_random_bits
| x, y offset (-8..7)
|
| Random bits of the given tile. Only valid for tiles of the same object.
|-
| nearby_tile_slope
| x, y offset (-8..7)
|
| See tile_slope
|-
| nearby_tile_is_same_object
| x, y offset (-8..7)
| 0 .. 1
| Is the given tile part of the same object?
|-
| nearby_tile_is_water
| x, y offset (-8..7)
| 0 .. 1
| Is the given tile a water tile?
|-
| nearby_tile_terrain_type
| x, y offset (-8..7)
|
| See terrain_type
|-
| nearby_tile_water_class
| x, y offset (-8..7)
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| x, y offset (-8..7)
| 0 .. 120
| The minimum height of the given tile. 8 units correspond to one height level
|-
| nearby_tile_class
| x, y offset (-8..7)
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| x, y offset (-8..7)
|
| See animation_frame. Only valid for tiles of the same object.
|-
| object_count
| object id [, grfid]
| 0..0xFFFF
|
Number of objects with the given object id currently on the map. Grfid is the grfid of the newgrf you want to check the object count of (default is current grf). Use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert a grfid to its numeric representation.
|-
| object_distance
| object id [, grfid]
| 0..0xFFFF
|
Manhattan distance to the closest object of the given type. Grfid is the grfid of the newgrf you want to check the minimum object distance of (default is current grf). Use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert a grfid to its numeric representation. If the given object type is not yet built, this will return 0xFFFF
|}

==Object callbacks==

{| class="wikitable sortable"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Normal graphics for an object placed on the map
|-
| purchase <ref name="notyetbuilt">These callbacks are called when the object is not yet built, so object- specific variables cannot be accessed. Trying to do so will result in undefined behaviour.</ref>
| Sprite layout
| Graphics shown in the build menu
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played (e.g. <code>return (sound("mysound.wav") << 8) <nowiki>|</nowiki> CB_RESULT_NEXT_FRAME;</code>).
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.
Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
Called whenever an object animation trigger happens. Return the animation frame to show, or CB_RESULT_XXX with XXX = [CB_RESULT_START_ANIMATION <nowiki>|</nowiki> STOP_ANIMATION <nowiki>|</nowiki> DO_NOTHING] to respectively start the animation in its current frame, stop the animation or do nothing. Returning a sound effect in the high byte will cause that sound effect to be played.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers| table]] below.
Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| colour
| colour2*16 + colour1
|
Called once, just after construction.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>: Colour scheme of the constructing company in the same format as the return value, or random colours if not available (scenario editor). If OBJ_FLAG_2CC is not set, colour2 is zero.
This callback can be used to alter the colour scheme of an object. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible colour values.
|-
| autoslope
| CB_RESULT[_NO]_AUTOSLOPE
| Return CB_RESULT_AUTOSLOPE to allow autoslope (altering the ground below a tile) or CB_RESULT_NO_AUTOSLOPE to disallow it.
|-
| tile_check <ref name="notyetbuilt"/>
|
See the [[#Location check results|table]] below
|
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 5)</code>: Tile slope, see below
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The location of the tile within the object as 16*y + x.
If this callback is not implemented or fails, the default behaviour is to allow building the object if it can be placed on a flat surface. This means that steep slopes are not allowed and that the highest corner of each tile of a multi-tile object should have the same height. Additionally, all tiles must be flat if "build on slopes" is disabled.
|-
| additional_text <ref name="notyetbuilt"/>
| String
| Additional text to show in the purchase menu
|}

<references/>

{{NML:LocationCheckResults}}

===Animation triggers===

{| class="wikitable sortable"
! Animation trigger
! Description
|-
| ANIM_TRIGGER_OBJ_BUILT
| Object is built (all tiles at the same time)
|-
| ANIM_TRIGGER_OBJ_TILELOOP
| Object tile is processed in the tileloop (at different times for different tiles)
|-
| ANIM_TRIGGER_OBJ_256_TICKS
| Every 256 ticks (all tiles at the same time)
|}

Action0/Objects

2025-06-06T11:14:38Z

Peter1138: /* Number of views (17) */

==Introduction==
Defining properties of new objects.

Unlike vehicles or new stations, most new objects have no real equivalent in TTD.

The IDs are therefore free to be chosen and will in fact be allocated automatically by the patch. In action 0, you only specify IDs relative to the set, i.e. the ID of the first object type is 00, the second object type is 01 and so on.

OpenTTD supports 64000 object types per game, and 255 object IDs per grf file.

{{ottdp|14.0|no}} 64000 object IDs per grf file are supported since OpenTTD 14.0.

The property you '''must''' set for each object ID is 08 (in addition to defining an action 3 for it). Also, all object IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==
{|
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Class label, see below
|-
|09||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Text ID for class
|-
|0A||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Text ID for this object
|-
|0B||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||[[Action0General#Climate availability|Climate availability]]
|-
|0C||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Byte representing size, see below
|-
|0D||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object build cost factor (sets object removal cost factor as well)
|-
|0E||D||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Introduction date, see below
|-
|0F||D||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||End of life date, see below
|-
|10||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object flags, see below
|-
|11||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Animation information
|-
|12||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Animation speed
|-
|13||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Animation triggers
|-
|14||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object removal cost factor (set after object build cost factor)
|-
|15||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Callback flags, see below
|-
|16||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Height of the building
|-
|17||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Number of object views
|-
|18||B||{{ottdp|1.4|no|ottdrev=r25879}}||Measure for number of objects placed upon map creation
|-
|19||W n*W||{{ottdp|15}}||List of badges
|}

Check [http://pics.lakie.net/newObject-ActionStructure.png Lakie's Graphical Representation of the newObject Specifications]

== Descriptions ==

=== Object class (08) ===

Class labels are unique identifiers composed of the letters A-Z and/or the numbers 0-9,  analoguous to [[Action0Stations#Station class (08)|station class labels]].

Their main use is to combine objects into classes and make them available by the top dropdown list in the object construction window.

Unlike for stations, there is no default class for objects. Set authors have to specify their [[ObjectLabels|own labels]], although it is strongly recommended to follow a general scheme to try to avoid confusion.

Class IDs must be set before any other property.

=== Object class text ID (09) ===

The text ID for this class (word value). This textid should be either a TTD textid or a D4xx textid (set via D0xx in action4).

When specifying an object, you don't need to set a class name again if you already did for another one with the same class.

=== Object text ID (0A) ===

The text ID for the object for query and selection (word value). Same requirements as for property09.

=== Object size (0C) ===

The object size up to 15x15 tiles.

This byte value is divided into two nibbles. The first defines the size in y direction and the second defines the size in x (i.e., stored as YX).

Note that any value lower than 0x11 will be rejected.

=== Build Cost (0D) ===

The build cost multiplier. This is multiplied by the number of tiles for evaluation of construction and removal costs of an object.

=== Introduction date (0E) ===

Introduction date of an object, in days since the year 0. This takes account of leap years; divisible by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). In TTDPatch anything before 1920 is considered to be always available, and it should allow for objects to work past 2044, the date is also the very first date you can build the object.

=== End of life date (0F) ===

Last year an object can be build, in days since the year 0. Same requirements as above. Also note that it must be a minimum of a year (365 days) after the introduction date or TTDPatch will ignore it.

=== Object flags (10) ===

The following flags control object behaviour and are cached for built objects, so changing these flags will have no effect on already constructed objects.

{|
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Only Available in the scenario editor<ref name="incompatible">Note that bits 0 and 7 are incompatible and setting both will make an object completely unavailable.</ref>
|-
|1||2||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Irremovable<ref>Object cannot be removed through normal dynamite, control must be held and the removal cost will be multiplied by 25 (this is the usual behaviour for most class A objects in TTDPatch).</ref>
|-
|2||4||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Anything Can Remove (owned land behaviour)
|-
|3||8||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Allow construction of the object on water
|-
|4||16||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Removal cost is actually income (owned land behaviour)
|-
|5||32||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Do not display foundations if on a slope
|-
|6||64||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object has animation<ref>Setting this flag will allow the object's animation counter to be increased, must be set if you plan to make use of animations. Like stations you must enable animation on a per tile basis by means of the "built tile" trigger and callback 159.</ref>
|-
|7||128||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Only available during game play<ref name="incompatible" />
|-
|8||256||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Allows 2cc mapping for objects instead of the default 1cc
|-
|9||512||{{ottdp|1.1|2.6|ttdprev=r2331}}||Disallows construction on land (also has bit 3 behaviour)
|-
|10||1024||{{ottdp|1.1|2.6|ttdprev=r2331}}||Draws the water under the object<ref>Only applies when built on top of a water tile, also replaces the ground tile of the object completely. (Does not work when object built on sloped water tiles).</ref>
|-
|11||2048||{{ottdp|1.1|no|ottdrev=r21455}}||Allow bridge over the object taking the building height into account
|-
|12||4096||{{ottdp|1.1|2.6|ottdrev=r21455|ttdprev=r2360}}||Random bits in the "next animation frame" callback
|-
|13||8192||{{ottdp|1.4|no|ottdrev=r25878}}||Scale amount of objects placed on map generation not by map area, but roughly by the length of the coastline
|}

<references />

=== Animation information (11) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this object (this is the default value).

Since you can't have properties for individual object tiles, this property applies for every tile of the object. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 159]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 158]] for that.

=== Animation speed (12) ===

The meaning is the same as for [[Action0Houses#Animation Speed (1B)|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 0.

=== Animation triggers (13) ===

This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 159]], allowing to change the animation state

{|
!Property bit, var18 byte 0!!Property value!!Meaning!!Happens on!!Var 18 byte 1
|-
|0||1||Object is built||all tiles||
|-
|1||2||Periodic tile loop||single tile||
|-
|2||4||Synchronised periodic tile loop||all tiles||
|}
Currently no trigger provides additional information in var 18 byte 1.

The synchronised periodic tile loop is called directly after the (unsynchronised) periodic tile loop of the northern tile.

=== Object removal cost factor (14) ===

Cost factor for the removal of an object. This must be set after property 0D (object build cost factor) as that overwrites this value.

=== Callback flags (15) ===

For objects, the following [[callbacks]] can be defined by setting the corresponding bit in property 15:

{|
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||157||Custom slope check
|-
|1||2||158||Decide next animation frame
|-
|2||4||15A||Decide animation speed
|-
|3||8||15B||Decide colour of building
|-
|4||16||15C||Show additional text in the build object window
|-
|5||32||15D||Allow/disallow autosloping
|}

=== Building height (16) ===

Set the height of the building in heightlevels (8 pixels). For example if the structure is 16 pixels high you set this property to 2.

{{ottdp|1.1|no|ottdrev=r21455}} In OpenTTD this property is used to determine the height of the build object window; the height for the object preview is set to 32 + "value of property 16" * 8. The property is also uses to determine how high a bridge must be if it is allowed by the bit in property 10.

=== Number of views (17) ===

Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. Views should be used for rotations or minor variations, not for objects of different types as those should just be different object types which provides a better experience for players. Using separate objects is better for discoverability, naming, filtering, used state, favourite state, and badges.

For non-square objects, x and y sizes are swapped for odd views. I.e., giving an object size of 1*2 (x = 1, y = 2), it will be displayed as 1*2 for num = <nowiki>[</nowiki>0,2] (x-direction) but as 2*1 for num = <nowiki>[</nowiki>1,3] (y-direction).

Use object varaction2 var48 to access particular views of an object.

==Examples==

Action0/Objects

2025-06-06T09:25:43Z

Peter1138: /* Number of views (17) */

==Introduction==
Defining properties of new objects.

Unlike vehicles or new stations, most new objects have no real equivalent in TTD.

The IDs are therefore free to be chosen and will in fact be allocated automatically by the patch. In action 0, you only specify IDs relative to the set, i.e. the ID of the first object type is 00, the second object type is 01 and so on.

OpenTTD supports 64000 object types per game, and 255 object IDs per grf file.

{{ottdp|14.0|no}} 64000 object IDs per grf file are supported since OpenTTD 14.0.

The property you '''must''' set for each object ID is 08 (in addition to defining an action 3 for it). Also, all object IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==
{|
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Class label, see below
|-
|09||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Text ID for class
|-
|0A||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Text ID for this object
|-
|0B||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||[[Action0General#Climate availability|Climate availability]]
|-
|0C||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Byte representing size, see below
|-
|0D||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object build cost factor (sets object removal cost factor as well)
|-
|0E||D||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Introduction date, see below
|-
|0F||D||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||End of life date, see below
|-
|10||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object flags, see below
|-
|11||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Animation information
|-
|12||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Animation speed
|-
|13||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Animation triggers
|-
|14||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object removal cost factor (set after object build cost factor)
|-
|15||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Callback flags, see below
|-
|16||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Height of the building
|-
|17||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Number of object views
|-
|18||B||{{ottdp|1.4|no|ottdrev=r25879}}||Measure for number of objects placed upon map creation
|-
|19||W n*W||{{ottdp|15}}||List of badges
|}

Check [http://pics.lakie.net/newObject-ActionStructure.png Lakie's Graphical Representation of the newObject Specifications]

== Descriptions ==

=== Object class (08) ===

Class labels are unique identifiers composed of the letters A-Z and/or the numbers 0-9,  analoguous to [[Action0Stations#Station class (08)|station class labels]].

Their main use is to combine objects into classes and make them available by the top dropdown list in the object construction window.

Unlike for stations, there is no default class for objects. Set authors have to specify their [[ObjectLabels|own labels]], although it is strongly recommended to follow a general scheme to try to avoid confusion.

Class IDs must be set before any other property.

=== Object class text ID (09) ===

The text ID for this class (word value). This textid should be either a TTD textid or a D4xx textid (set via D0xx in action4).

When specifying an object, you don't need to set a class name again if you already did for another one with the same class.

=== Object text ID (0A) ===

The text ID for the object for query and selection (word value). Same requirements as for property09.

=== Object size (0C) ===

The object size up to 15x15 tiles.

This byte value is divided into two nibbles. The first defines the size in y direction and the second defines the size in x (i.e., stored as YX).

Note that any value lower than 0x11 will be rejected.

=== Build Cost (0D) ===

The build cost multiplier. This is multiplied by the number of tiles for evaluation of construction and removal costs of an object.

=== Introduction date (0E) ===

Introduction date of an object, in days since the year 0. This takes account of leap years; divisible by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). In TTDPatch anything before 1920 is considered to be always available, and it should allow for objects to work past 2044, the date is also the very first date you can build the object.

=== End of life date (0F) ===

Last year an object can be build, in days since the year 0. Same requirements as above. Also note that it must be a minimum of a year (365 days) after the introduction date or TTDPatch will ignore it.

=== Object flags (10) ===

The following flags control object behaviour and are cached for built objects, so changing these flags will have no effect on already constructed objects.

{|
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Only Available in the scenario editor<ref name="incompatible">Note that bits 0 and 7 are incompatible and setting both will make an object completely unavailable.</ref>
|-
|1||2||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Irremovable<ref>Object cannot be removed through normal dynamite, control must be held and the removal cost will be multiplied by 25 (this is the usual behaviour for most class A objects in TTDPatch).</ref>
|-
|2||4||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Anything Can Remove (owned land behaviour)
|-
|3||8||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Allow construction of the object on water
|-
|4||16||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Removal cost is actually income (owned land behaviour)
|-
|5||32||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Do not display foundations if on a slope
|-
|6||64||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object has animation<ref>Setting this flag will allow the object's animation counter to be increased, must be set if you plan to make use of animations. Like stations you must enable animation on a per tile basis by means of the "built tile" trigger and callback 159.</ref>
|-
|7||128||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Only available during game play<ref name="incompatible" />
|-
|8||256||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Allows 2cc mapping for objects instead of the default 1cc
|-
|9||512||{{ottdp|1.1|2.6|ttdprev=r2331}}||Disallows construction on land (also has bit 3 behaviour)
|-
|10||1024||{{ottdp|1.1|2.6|ttdprev=r2331}}||Draws the water under the object<ref>Only applies when built on top of a water tile, also replaces the ground tile of the object completely. (Does not work when object built on sloped water tiles).</ref>
|-
|11||2048||{{ottdp|1.1|no|ottdrev=r21455}}||Allow bridge over the object taking the building height into account
|-
|12||4096||{{ottdp|1.1|2.6|ottdrev=r21455|ttdprev=r2360}}||Random bits in the "next animation frame" callback
|-
|13||8192||{{ottdp|1.4|no|ottdrev=r25878}}||Scale amount of objects placed on map generation not by map area, but roughly by the length of the coastline
|}

<references />

=== Animation information (11) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this object (this is the default value).

Since you can't have properties for individual object tiles, this property applies for every tile of the object. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 159]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 158]] for that.

=== Animation speed (12) ===

The meaning is the same as for [[Action0Houses#Animation Speed (1B)|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 0.

=== Animation triggers (13) ===

This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 159]], allowing to change the animation state

{|
!Property bit, var18 byte 0!!Property value!!Meaning!!Happens on!!Var 18 byte 1
|-
|0||1||Object is built||all tiles||
|-
|1||2||Periodic tile loop||single tile||
|-
|2||4||Synchronised periodic tile loop||all tiles||
|}
Currently no trigger provides additional information in var 18 byte 1.

The synchronised periodic tile loop is called directly after the (unsynchronised) periodic tile loop of the northern tile.

=== Object removal cost factor (14) ===

Cost factor for the removal of an object. This must be set after property 0D (object build cost factor) as that overwrites this value.

=== Callback flags (15) ===

For objects, the following [[callbacks]] can be defined by setting the corresponding bit in property 15:

{|
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||157||Custom slope check
|-
|1||2||158||Decide next animation frame
|-
|2||4||15A||Decide animation speed
|-
|3||8||15B||Decide colour of building
|-
|4||16||15C||Show additional text in the build object window
|-
|5||32||15D||Allow/disallow autosloping
|}

=== Building height (16) ===

Set the height of the building in heightlevels (8 pixels). For example if the structure is 16 pixels high you set this property to 2.

{{ottdp|1.1|no|ottdrev=r21455}} In OpenTTD this property is used to determine the height of the build object window; the height for the object preview is set to 32 + "value of property 16" * 8. The property is also uses to determine how high a bridge must be if it is allowed by the bit in property 10.

=== Number of views (17) ===

Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. Views should be used for rotations or minor variations, not for objects of different types as those should just be different object types which provides a better experience for players.

For non-square objects, x and y sizes are swapped for odd views. I.e., giving an object size of 1*2 (x = 1, y = 2), it will be displayed as 1*2 for num = <nowiki>[</nowiki>0,2] (x-direction) but as 2*1 for num = <nowiki>[</nowiki>1,3] (y-direction).

Use object varaction2 var48 to access particular views of an object.

==Examples==

NML:Objects

2025-05-17T12:46:50Z

Peter1138: /* Object properties */

{{NMLNavPropVarCB}}

==Object IDs==
OpenTTD supports 64000 object types per game, and 255 object IDs per grf file.

{{ottdp|14.0|no}} 64000 object IDs per grf file are supported since OpenTTD 14.0.

Object IDs are NewGRF-local and can therefore freely be chosen within the ID ranges.

An object is allocated by setting the 'class'-property, which should therefore be set first.

Overriding the default objects (e.g. transmitter, lighthouse) is not (yet) possible.

==Object properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| class
| String literal of length 4
|
Unlike station classes, there is currently no default yet. '''This property ''must'' be set first, before any other properties or graphics.''' Characters allowed in the IDs are A-Z, 0-9. While you are technically free to chose your own class, it's highly recommended you stick to one of the [[#Default object classes|default classes]].
|-
| classname
| string
| You only need to set this for one object in every class.
|-
| name
| string
|
|-
| climates_available
| bitmask(CLIMATE_XXX, CLIMATE_YYY, ...)
| XXX = [TEMPERATE <nowiki>|</nowiki> ARCTIC <nowiki>|</nowiki> TROPICAL <nowiki>|</nowiki> TOYLAND], alternatively NO_CLIMATE or ALL_CLIMATES
|-
| size
| [x, y]
| Size in x and y direction. Both x and y must be compiletime constants
|-
| build_cost_multiplier
|
| multiplicator to the base purchase cost
|-
| remove_cost_multiplier
|
| multiplicator to the base removal cost
|-
| introduction_date
| date
| The date this object becomes available to build.
|-
| end_of_life_date
| date
| The last date this object is buildable. Must be at least 365 days after introduction_date
|-
| object_flags
| bitmask(OBJ_FLAG_XXX, OBJ_FLAG_YYY)
|
See [[#List of object flags|list of object flags]]
|-
| animation_info
| Array [ANIMATION_XXX, frame-count]
| XXX = [LOOPING <nowiki>|</nowiki> NON_LOOPING], 1..253 frames
|-
| animation_speed
| 0..16
|
Speed of animation, see [[NML:Animation speed|animation speed table]] for the meaning of the values.
|-
| animation_triggers
|
|
See [[#Animation_triggers|list of animation triggers]]
|-
| callback_flags
| bitmask(OBJ_CBF_XXX, OBJ_CBF_YYY)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| height
| 0..255
| Height of the object / 8. For example if your object is 16 pixels height you should set height to 2. In OpenTTD this property is used to determine the height of the build object window; the height for the object preview is set to 32 + "value of property" * 8. The property is also used to determine how high a bridge must be if it is allowed by the bit in object_flags.
|-
| num_views
| 1, 2 or 4
| Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. For non-square objects, x and y sizes are swapped for odd views. Use variable <code style="color:darkgreen">view</code> to determine the view of a built object. Views should be used for rotations or minor variations, not for objects of different types as those should just be different object types which provides a better experience for players.
|-
| count_per_map256
| 0..255
| {{ottd|1.4|r25878}} Measure for the amount of objects placed on a map of 256^2 tiles. (Comparison: there are 15 transmitter)
|}

===Default object classes===

Please refer to the [[ObjectLabels|list of object labels]] in the NewGRF Specs. The default class names listed there are recommended, you still need to set the class name for at least one object in every class or you risk to end up with objects in a class without a name. If multiple NewGRFs define objects for the same class the name defined in the last NewGRF will be used.

===List of object flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| OBJ_FLAG_ONLY_SE
| Only available in the scenario editor (incompatible with OBJ_FLAG_ONLY_INGAME).
|-
| OBJ_FLAG_IRREMOVABLE
| Object cannot be removed with the normal dynamite tool. In OpenTTD you can only remove the object with the magic bulldozer cheat, in TTDPatch you can remove it by holding ctrl while using the bulldozer tool. The cost of removing this object is multiplied by 25.
|-
| OBJ_FLAG_ANYTHING_REMOVE
| Anything can remove this object (owned land behavior).
|-
| OBJ_FLAG_ON_WATER
| Allow construction of the object on water. Note that if an object is allowed to be built both on land and on water, then it will resist being flooded and will not flood adjacent tiles.
This flag has the same effect as using ''GROUNDSPRITE_WATER'' for the ground sprite in the spritelayout.
|-
| OBJ_FLAG_REMOVE_IS_INCOME
| Removal cost is actually income (owned land behaviour).
|-
| OBJ_FLAG_NO_FOUNDATIONS
| Do not display foundations if on a slope.
|-
| OBJ_FLAG_ANIMATED
| Setting this flag will allow the object's animation counter to be increased, must be set if you plan to make use of animations.
|-
| OBJ_FLAG_ONLY_INGAME
| Only available during game play (incompatible with OBJ_FLAG_ONLY_SE).
|-
| OBJ_FLAG_2CC
| Allows 2cc mapping for objects instead of the default 1cc.
|-
| OBJ_FLAG_NOT_ON_LAND
| Disallows construction on land (implies OBJ_FLAG_ON_WATER).
|-
| OBJ_FLAG_DRAW_WATER
| Draws the water under the object. Only applies when built on top of a water tile, also replaces the ground tile of the object completely. Does not work when object built on sloped water tiles.
|-
| OBJ_FLAG_ALLOW_BRIDGE
| Allow bridge over the object taking the building height into account.
|-
| OBJ_FLAG_RANDOM_ANIMATION
| Random bits in the "next animation frame" callback.
|-
| OBJ_FLAG_SCALE_BY_WATER
| Scale amount of objects placed on map generation not by map area, but roughly by the length of the coastline
|}

==Object variables==

{| class="wikitable sortable"
! name
! value range
! comment
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| terrain_type
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|
|-
| tile_slope
| SLOPE_XXX
|
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| build_date
|
| The date this object was build.
|-
| animation_frame
| 0 .. (frame_count - 1)
| Current animation frame, with the maximum defined in the object's <code style="color:darkgreen">animation_info</code> property.
|-
| colour
| COLOUR_XXX
|
Colour used for the company colour mask. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| owner
| 0..0x10
| CompanyID of the owner of the object or 0x10 if it was build in the scenario editor
|-
| town_manhattan_dist
|
| Manhattan distance to the nearest town
|-
| town_euclidean_dist
|
| Euclidean distance to the nearest town
|-
| town_zone
|
[[NML:List of town zones|town zone]]
| The town zone of the current tile. The town zone from the closest town (measured in manhattan distance) is used.
|-
| view
| 0 .. (<code style="color:darkgreen">num_views</code> - 1)
|
{{ottd|1.1|r21455}} The view of the particular object. See also the <code style="color:darkgreen">num_views</code> property.
|}

Variables that require one or more parameters:

{| class="wikitable sortable"
! name
! arguments
! value range
! comment
|-
| nearby_tile_object_type
| x, y offset (-8..7)
|
| ID of the object on a nearby tile, if defined by the same grf. OBJECT_TYPE_OTHER_GRF if the object is defined by a different grf (or none at all). OBJECT_TYPE_NO_OBJECT if the tile does not contain an object.
|-
| nearby_tile_object_view
| x, y offset (-8..7)
|
| {{ottdp|1.4|no|ottdrev=r26316}} View of the object on a nearby tile, if defined by the same grf.
|-
| nearby_tile_random_bits
| x, y offset (-8..7)
|
| Random bits of the given tile. Only valid for tiles of the same object.
|-
| nearby_tile_slope
| x, y offset (-8..7)
|
| See tile_slope
|-
| nearby_tile_is_same_object
| x, y offset (-8..7)
| 0 .. 1
| Is the given tile part of the same object?
|-
| nearby_tile_is_water
| x, y offset (-8..7)
| 0 .. 1
| Is the given tile a water tile?
|-
| nearby_tile_terrain_type
| x, y offset (-8..7)
|
| See terrain_type
|-
| nearby_tile_water_class
| x, y offset (-8..7)
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| x, y offset (-8..7)
| 0 .. 120
| The minimum height of the given tile. 8 units correspond to one height level
|-
| nearby_tile_class
| x, y offset (-8..7)
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| x, y offset (-8..7)
|
| See animation_frame. Only valid for tiles of the same object.
|-
| object_count
| object id [, grfid]
| 0..0xFFFF
|
Number of objects with the given object id currently on the map. Grfid is the grfid of the newgrf you want to check the object count of (default is current grf). Use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert a grfid to its numeric representation.
|-
| object_distance
| object id [, grfid]
| 0..0xFFFF
|
Manhattan distance to the closest object of the given type. Grfid is the grfid of the newgrf you want to check the minimum object distance of (default is current grf). Use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert a grfid to its numeric representation. If the given object type is not yet built, this will return 0xFFFF
|}

==Object callbacks==

{| class="wikitable sortable"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Normal graphics for an object placed on the map
|-
| purchase <ref name="notyetbuilt">These callbacks are called when the object is not yet built, so object- specific variables cannot be accessed. Trying to do so will result in undefined behaviour.</ref>
| Sprite layout
| Graphics shown in the build menu
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played (e.g. <code>return (sound("mysound.wav") << 8) <nowiki>|</nowiki> CB_RESULT_NEXT_FRAME;</code>).
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.
Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
Called whenever an object animation trigger happens. Return the animation frame to show, or CB_RESULT_XXX with XXX = [CB_RESULT_START_ANIMATION <nowiki>|</nowiki> STOP_ANIMATION <nowiki>|</nowiki> DO_NOTHING] to respectively start the animation in its current frame, stop the animation or do nothing. Returning a sound effect in the high byte will cause that sound effect to be played.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers| table]] below.
Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| colour
| colour2*16 + colour1
|
Called once, just after construction.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>: Colour scheme of the constructing company in the same format as the return value, or random colours if not available (scenario editor). If OBJ_FLAG_2CC is not set, colour2 is zero.
This callback can be used to alter the colour scheme of an object. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible colour values.
|-
| autoslope
| CB_RESULT[_NO]_AUTOSLOPE
| Return CB_RESULT_AUTOSLOPE to allow autoslope (altering the ground below a tile) or CB_RESULT_NO_AUTOSLOPE to disallow it.
|-
| tile_check <ref name="notyetbuilt"/>
|
See the [[#Location check results|table]] below
|
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 5)</code>: Tile slope, see below
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The location of the tile within the object as 16*y + x.
If this callback is not implemented or fails, the default behaviour is to allow building the object if it can be placed on a flat surface. This means that steep slopes are not allowed and that the highest corner of each tile of a multi-tile object should have the same height. Additionally, all tiles must be flat if "build on slopes" is disabled.
|-
| additional_text <ref name="notyetbuilt"/>
| String
| Additional text to show in the purchase menu
|}

<references/>

{{NML:LocationCheckResults}}

===Animation triggers===

{| class="wikitable sortable"
! Animation trigger
! Description
|-
| ANIM_TRIGGER_OBJ_BUILT
| Object is built (all tiles at the same time)
|-
| ANIM_TRIGGER_OBJ_TILELOOP
| Object tile is processed in the tileloop (at different times for different tiles)
|-
| ANIM_TRIGGER_OBJ_256_TICKS
| Every 256 ticks (all tiles at the same time)
|}

NML:Objects

2025-05-17T12:46:25Z

Peter1138: /* Object properties */

{{NMLNavPropVarCB}}

==Object IDs==
OpenTTD supports 64000 object types per game, and 255 object IDs per grf file.

{{ottdp|14.0|no}} 64000 object IDs per grf file are supported since OpenTTD 14.0.

Object IDs are NewGRF-local and can therefore freely be chosen within the ID ranges.

An object is allocated by setting the 'class'-property, which should therefore be set first.

Overriding the default objects (e.g. transmitter, lighthouse) is not (yet) possible.

==Object properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| class
| String literal of length 4
|
Unlike station classes, there is currently no default yet. '''This property ''must'' be set first, before any other properties or graphics.''' Characters allowed in the IDs are A-Z, 0-9. While you are technically free to chose your own class, it's highly recommended you stick to one of the [[#Default object classes|default classes]].
|-
| classname
| string
| You only need to set this for one object in every class.
|-
| name
| string
|
|-
| climates_available
| bitmask(CLIMATE_XXX, CLIMATE_YYY, ...)
| XXX = [TEMPERATE <nowiki>|</nowiki> ARCTIC <nowiki>|</nowiki> TROPICAL <nowiki>|</nowiki> TOYLAND], alternatively NO_CLIMATE or ALL_CLIMATES
|-
| size
| [x, y]
| Size in x and y direction. Both x and y must be compiletime constants
|-
| build_cost_multiplier
|
| multiplicator to the base purchase cost
|-
| remove_cost_multiplier
|
| multiplicator to the base removal cost
|-
| introduction_date
| date
| The date this object becomes available to build.
|-
| end_of_life_date
| date
| The last date this object is buildable. Must be at least 365 days after introduction_date
|-
| object_flags
| bitmask(OBJ_FLAG_XXX, OBJ_FLAG_YYY)
|
See [[#List of object flags|list of object flags]]
|-
| animation_info
| Array [ANIMATION_XXX, frame-count]
| XXX = [LOOPING <nowiki>|</nowiki> NON_LOOPING], 1..253 frames
|-
| animation_speed
| 0..16
|
Speed of animation, see [[NML:Animation speed|animation speed table]] for the meaning of the values.
|-
| animation_triggers
|
|
See [[#Animation_triggers|list of animation triggers]]
|-
| callback_flags
| bitmask(OBJ_CBF_XXX, OBJ_CBF_YYY)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| height
| 0..255
| Height of the object / 8. For example if your object is 16 pixels height you should set height to 2. In OpenTTD this property is used to determine the height of the build object window; the height for the object preview is set to 32 + "value of property" * 8. The property is also used to determine how high a bridge must be if it is allowed by the bit in object_flags.
|-
| num_views
| 1, 2 or 4
| Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. For non-square objects, x and y sizes are swapped for odd views. Use variable <code style="color:darkgreen">view</code> to determine the view of a built object. Views should be used for rotations or minor variations, not for objects of different types as those should just be different object types which providers a better experience for players.
|-
| count_per_map256
| 0..255
| {{ottd|1.4|r25878}} Measure for the amount of objects placed on a map of 256^2 tiles. (Comparison: there are 15 transmitter)
|}

===Default object classes===

Please refer to the [[ObjectLabels|list of object labels]] in the NewGRF Specs. The default class names listed there are recommended, you still need to set the class name for at least one object in every class or you risk to end up with objects in a class without a name. If multiple NewGRFs define objects for the same class the name defined in the last NewGRF will be used.

===List of object flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| OBJ_FLAG_ONLY_SE
| Only available in the scenario editor (incompatible with OBJ_FLAG_ONLY_INGAME).
|-
| OBJ_FLAG_IRREMOVABLE
| Object cannot be removed with the normal dynamite tool. In OpenTTD you can only remove the object with the magic bulldozer cheat, in TTDPatch you can remove it by holding ctrl while using the bulldozer tool. The cost of removing this object is multiplied by 25.
|-
| OBJ_FLAG_ANYTHING_REMOVE
| Anything can remove this object (owned land behavior).
|-
| OBJ_FLAG_ON_WATER
| Allow construction of the object on water. Note that if an object is allowed to be built both on land and on water, then it will resist being flooded and will not flood adjacent tiles.
This flag has the same effect as using ''GROUNDSPRITE_WATER'' for the ground sprite in the spritelayout.
|-
| OBJ_FLAG_REMOVE_IS_INCOME
| Removal cost is actually income (owned land behaviour).
|-
| OBJ_FLAG_NO_FOUNDATIONS
| Do not display foundations if on a slope.
|-
| OBJ_FLAG_ANIMATED
| Setting this flag will allow the object's animation counter to be increased, must be set if you plan to make use of animations.
|-
| OBJ_FLAG_ONLY_INGAME
| Only available during game play (incompatible with OBJ_FLAG_ONLY_SE).
|-
| OBJ_FLAG_2CC
| Allows 2cc mapping for objects instead of the default 1cc.
|-
| OBJ_FLAG_NOT_ON_LAND
| Disallows construction on land (implies OBJ_FLAG_ON_WATER).
|-
| OBJ_FLAG_DRAW_WATER
| Draws the water under the object. Only applies when built on top of a water tile, also replaces the ground tile of the object completely. Does not work when object built on sloped water tiles.
|-
| OBJ_FLAG_ALLOW_BRIDGE
| Allow bridge over the object taking the building height into account.
|-
| OBJ_FLAG_RANDOM_ANIMATION
| Random bits in the "next animation frame" callback.
|-
| OBJ_FLAG_SCALE_BY_WATER
| Scale amount of objects placed on map generation not by map area, but roughly by the length of the coastline
|}

==Object variables==

{| class="wikitable sortable"
! name
! value range
! comment
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| terrain_type
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|
|-
| tile_slope
| SLOPE_XXX
|
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| build_date
|
| The date this object was build.
|-
| animation_frame
| 0 .. (frame_count - 1)
| Current animation frame, with the maximum defined in the object's <code style="color:darkgreen">animation_info</code> property.
|-
| colour
| COLOUR_XXX
|
Colour used for the company colour mask. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| owner
| 0..0x10
| CompanyID of the owner of the object or 0x10 if it was build in the scenario editor
|-
| town_manhattan_dist
|
| Manhattan distance to the nearest town
|-
| town_euclidean_dist
|
| Euclidean distance to the nearest town
|-
| town_zone
|
[[NML:List of town zones|town zone]]
| The town zone of the current tile. The town zone from the closest town (measured in manhattan distance) is used.
|-
| view
| 0 .. (<code style="color:darkgreen">num_views</code> - 1)
|
{{ottd|1.1|r21455}} The view of the particular object. See also the <code style="color:darkgreen">num_views</code> property.
|}

Variables that require one or more parameters:

{| class="wikitable sortable"
! name
! arguments
! value range
! comment
|-
| nearby_tile_object_type
| x, y offset (-8..7)
|
| ID of the object on a nearby tile, if defined by the same grf. OBJECT_TYPE_OTHER_GRF if the object is defined by a different grf (or none at all). OBJECT_TYPE_NO_OBJECT if the tile does not contain an object.
|-
| nearby_tile_object_view
| x, y offset (-8..7)
|
| {{ottdp|1.4|no|ottdrev=r26316}} View of the object on a nearby tile, if defined by the same grf.
|-
| nearby_tile_random_bits
| x, y offset (-8..7)
|
| Random bits of the given tile. Only valid for tiles of the same object.
|-
| nearby_tile_slope
| x, y offset (-8..7)
|
| See tile_slope
|-
| nearby_tile_is_same_object
| x, y offset (-8..7)
| 0 .. 1
| Is the given tile part of the same object?
|-
| nearby_tile_is_water
| x, y offset (-8..7)
| 0 .. 1
| Is the given tile a water tile?
|-
| nearby_tile_terrain_type
| x, y offset (-8..7)
|
| See terrain_type
|-
| nearby_tile_water_class
| x, y offset (-8..7)
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| x, y offset (-8..7)
| 0 .. 120
| The minimum height of the given tile. 8 units correspond to one height level
|-
| nearby_tile_class
| x, y offset (-8..7)
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| x, y offset (-8..7)
|
| See animation_frame. Only valid for tiles of the same object.
|-
| object_count
| object id [, grfid]
| 0..0xFFFF
|
Number of objects with the given object id currently on the map. Grfid is the grfid of the newgrf you want to check the object count of (default is current grf). Use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert a grfid to its numeric representation.
|-
| object_distance
| object id [, grfid]
| 0..0xFFFF
|
Manhattan distance to the closest object of the given type. Grfid is the grfid of the newgrf you want to check the minimum object distance of (default is current grf). Use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert a grfid to its numeric representation. If the given object type is not yet built, this will return 0xFFFF
|}

==Object callbacks==

{| class="wikitable sortable"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Normal graphics for an object placed on the map
|-
| purchase <ref name="notyetbuilt">These callbacks are called when the object is not yet built, so object- specific variables cannot be accessed. Trying to do so will result in undefined behaviour.</ref>
| Sprite layout
| Graphics shown in the build menu
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played (e.g. <code>return (sound("mysound.wav") << 8) <nowiki>|</nowiki> CB_RESULT_NEXT_FRAME;</code>).
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.
Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
Called whenever an object animation trigger happens. Return the animation frame to show, or CB_RESULT_XXX with XXX = [CB_RESULT_START_ANIMATION <nowiki>|</nowiki> STOP_ANIMATION <nowiki>|</nowiki> DO_NOTHING] to respectively start the animation in its current frame, stop the animation or do nothing. Returning a sound effect in the high byte will cause that sound effect to be played.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers| table]] below.
Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| colour
| colour2*16 + colour1
|
Called once, just after construction.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>: Colour scheme of the constructing company in the same format as the return value, or random colours if not available (scenario editor). If OBJ_FLAG_2CC is not set, colour2 is zero.
This callback can be used to alter the colour scheme of an object. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible colour values.
|-
| autoslope
| CB_RESULT[_NO]_AUTOSLOPE
| Return CB_RESULT_AUTOSLOPE to allow autoslope (altering the ground below a tile) or CB_RESULT_NO_AUTOSLOPE to disallow it.
|-
| tile_check <ref name="notyetbuilt"/>
|
See the [[#Location check results|table]] below
|
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 5)</code>: Tile slope, see below
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The location of the tile within the object as 16*y + x.
If this callback is not implemented or fails, the default behaviour is to allow building the object if it can be placed on a flat surface. This means that steep slopes are not allowed and that the highest corner of each tile of a multi-tile object should have the same height. Additionally, all tiles must be flat if "build on slopes" is disabled.
|-
| additional_text <ref name="notyetbuilt"/>
| String
| Additional text to show in the purchase menu
|}

<references/>

{{NML:LocationCheckResults}}

===Animation triggers===

{| class="wikitable sortable"
! Animation trigger
! Description
|-
| ANIM_TRIGGER_OBJ_BUILT
| Object is built (all tiles at the same time)
|-
| ANIM_TRIGGER_OBJ_TILELOOP
| Object tile is processed in the tileloop (at different times for different tiles)
|-
| ANIM_TRIGGER_OBJ_256_TICKS
| Every 256 ticks (all tiles at the same time)
|}

Action5

2025-03-04T20:53:22Z

Peter1138: /* type */

== Introduction ==

Define base graphics specific sets

Action 5 is used to define graphics for several new features of OpenTTD and TTDPatch. This is similar to action 1.

== Syntax ==

The data looks as follows:

<Sprite-number> * <Length> 05 <type> <num-sprites> [<offset>]

{|
!Element!![[GRFActionsDetailed|Size]]!!Description

|-
|<Sprite-number>||dec||A sequential sprite number

|-
|<length>||dec||The total number of bytes used in this action

|-
|05||B||Defines action 05

|-
|<type>||B||What type of graphics follow

|-
|<num-sprites>||B*||How many regular sprites follow

|-
|<offset>||B*||Offset in the Action 5 assignable block of sprites
|}

The following num-sprites sprites in the .nfo file have to be RealSprites that will be used as graphics for the given TTDPatch feature, except for type 0A, which requires RecolorSprites.

{{ottdp|0.7|2.5|ttdprev=alpha 19}}Action 5 entries in a .grf file which has a regular GRFID (not FFFFFFFF) will always override those from .grf files with a GRFID of FFFFFFFF.

== Description ==

=== Sprite-number ===

This is just the number you are at.

=== Length ===

Count the number of bytes in this action.

=== type ===

This sets the type of feature that the graphics are for. If bit 7 is set, the offset variable needs to be set. Bit 7 may only be set if the type supports it. The type can be one of:

{|
!Type!!Version!!Feature!!num-sprites (decimal)

|-
|04||{{ottdp|0.6|2.0}}||Pre-signal graphics||48

|-
|04||{{ottdp|0.6|2.0}}||Pre-signal and semaphore graphics||112

|-
|04,84<ref name="offset">Offset allowed since {{ottdp|1.2|no|ottdrev=r23005}}</ref>||{{ottdp| |2.5|ttdprev=alpha 41}}||Pre-signal, semaphore, and PBS graphics||240

|-
|05,85<ref name="offset" />||{{ottdp|0.6|2.0}}||Overhead wires and pylon graphics||48

|-
|06 ||{{ottdp|0.6| }}||Foundations (retaining walls) for BuildOnSlopes ||74

|-
|06,86<ref name="offset" />||{{ottdp|0.6|no|ottdrev=r11321}}||Foundations for BuildOnSlopes and half tiles (NS and EW foundations) ||90

|-
|07||{{ottdp|no|2.5|ttdprev=alpha 43}}||TTDPatch GUI sprites||93 <ref>Type 07 only requires 73 sprites in the stable (2.5 branch); the extra sprites are the clone train and build canal cursors.</ref>

|-
|08,88<ref name="offset" />||{{ottdp|0.6|no}}<ref>TTDPatch supported canals via Action5 from 2.0.1 alpha 17 up to alpha 25. In alpha 26 it was removed again in favour of an action-1-2-3 method; see [[Action3/Canals|Action3]]. The method via Action5 is no longer supported by TTDpatch 2.0.1 alpha 26 and newer.</ref>||Canals||65

|-
|09,89<ref name="offset" />||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||One-way road arrows||{{ottdp|13|no}} 18 {{ottdp|0.6 - 12|2.5}} 6

|-
|0A,8A<ref name="offset" />||{{ottdp|0.6|2.5|ttdprev=alpha 67}}||Two company color translation maps||256

|-
|0B,8B<ref name="offset" />||{{ottdp|0.6|2.5|ttdprev=alpha 68}}||Tram tracks||{{ottdp|1.10|no}} 119 {{ottdp|0.6 - 1.9|2.5}} 113

|-
|0C||{{ottdp|no|2.5|ttdprev=alpha 74}}||Snowy temperate trees||133

|-
|0D||{{ottdp|0.6|2.5|ottdrev=r7325 (r11726)|ttdprev=beta 5}}||Coast Tile graphics||16 (18)

|-
|0E||{{ottdp|no|2.6|ttdprev=r1247}}||New Signals||Any

|-
|0F,8F<ref name="offset" />||{{ottdp|0.7|2.6|ottdrev=r13469|ttdprev=r1487}}||Sprites for marking tracks on slopes (for track reservation systems like PBS or YAPP)||Up to 12

|-
|10,90<ref name="offset" />||{{ottdp|0.6|no|ottdrev=r9645}}||Additional airport graphics||15

|-
|11,91<ref name="offset" />||{{ottdp|0.6|2.6|ottdrev=r9645|ttdprev=r1589}}||Road stop graphics||8

|-
|12,92<ref name="offset" />||{{ottdp|0.7|2.6|ottdrev=r13464|ttdprev=r1498}}||Aqueduct graphics||8

|-
|13,93<ref name="offset" />||{{ottdp|0.6|no|ottdrev=r11433}}||Autorail sprites||55

|-
|14,94||{{ottdp|0.6 - 1.11|no|ottdrev=11433}}||Flag sprites (no longer used)||Up to 36

|-
|15,95||{{ottdp|0.6|no|ottdrev=r11433}}||OpenTTD GUI sprites||Up to 191

|-
|16,96||{{ottdp|1.1|no|ottdrev=r20370}}||Airport preview sprites||Up to 9

|-
|17,97||{{ottdp|1.2|no|ottdrev=r23952}}||Railtype tunnel base sprites||16

|-
|18,98||{{ottdp|1.5|no|ottdrev=r26869}}||Extra all black palette||1

|-
|19,99||{{ottdp|15|no|}}||Road waypoint graphics||4

|-
|1A,9A||{{ottdp|15|no|}}||Rocky overlay sprites, 5 sets of 19 (normal, 1/4 snowy, 2/4 snowy, 3/4 snowy and 4/4 snowy) base rock overlay sprites||95
|}

<references/>

==== 04 Signal graphics. ====

Signal graphics come in groups of 16. These groups contain sprites in the same order as sprites 1275-1290 in trg1[r].grf; red, then green, for each of: SW-facing, NE-facing, NW-facing, SE-facing, E-facing, W-facing, S-facing, N-facing.

{|
!Group(s)!!Contents

|-
|0||lighted entrance signals

|-
|1||lighted exit signals

|-
|2||lighted combo signals

|-
|3||standard (non-pre-signal) semaphore signals

|-
|4..6||repeat 0..2 for semaphores

|-
|7||standard lighted PBS signals

|-
|8..14||repeat 0..6 for PBS signals
|}

==== 09 One-way road arrows ====

Overlay sprites to indicate the direction of one-way roads.
The 6 sprites originally supported from {{ottdp|0.6|2.5}} are, in order:

arrow facing SW, arrow NE, impassable NE-SW, arrow NW, arrow SE, impassable NW-SE.

Before {{ottdp|13|no}} these are used on both flat and sloped roads.

From {{ottdp|13|no}} the grf can optionally provide 18 sprites instead of 6.
In this case the first 6 sprites are used for flat tiles only. The next 6 are used in the same sequence for slopes with the N corner raised, and the last 6 for slopes with the S corner raised.

==== 0C Snowy temperate trees ====

If the temperate snow line is enabled, you can use this to specify the snowy versions of temperate trees. The sprites must be the snowy versions of sprites 1576-1708 from TRG1.GRF, in the same order as they appear there.

==== 0D Coast tile sprites ====

===== In NewGRFs =====
If diagonal flooding is enabled then due to new corner coasts, you can use this to give a complete set of replacement coast tile sprites. There are 16 in total, 8 original Transport Tycoon Deluxe sprites and 8 for the corner slopes. Order of the sprites<ref name=numbers>Sprite numbers from trg1(r).pcx.</ref> is as follows:

3997, 4063, 4064, 4068, 4062, 3998, 4066, 3988,
4065, 4069, 3996, 3992, 4067, 3994, 3995, 3999.

<references />

[[File:Action5Coast16Sprites.png]]

''The 16 sprites for feature 0D''

===== In Base Set's extra grf =====
Additionally, OpenTTD (since r11726) supports another method of supplying all additional coast tile sprites, but this is only allowed in the ''extra'' NewGRF of [http://wiki.openttd.org/Base_graphics Base Graphic Sets]. In this, only 10 sprites are supplied in the same order as the 16 sprites above, but without the coast sprites already in the base grf. Note that the 10 sprites version supplies two additional slopes, but they are not used, and are currently unlikely to be ever used.

[[File:Action5Coast10Sprites.png]]

''Only 10 sprites are required for OpenTTD base graphic sets''

''In OpenTTD 10 sprites for type 0D is enough in base graphic sets. The 16 sprites version should not be used for base graphics.''

The reason for the existence of a 10 sprite version is to remove the need for including original graphics, and to keep compatibility with old NewGRFs that replace the original shore graphics using Action A without adding new shores using Action 5: When a NewGRF uses the 16 sprites version it takes precedence above any NewGRF replacing the shore graphics using Action A; when a NewGRF uses Action A to replace shore graphics it takes precedence above a 10-sprite Action 5, effectively disabling diagonal flooding. Also due to compatibility the 10 sprites version is invalid for normal NewGRFs, which are not the "extra" NewGRF of some Base Graphics Set.

==== 0E New Signals ====

Any number of real and recolour sprites can be specified in the action in any order.

Sprites are referenced by their offset into the action5 block by a [[VarAction2NewSignals]], hence a logically easily calculable order is advised.

As of TTDPatch 2.6 alpha 0 r1346, the action 5 block defined in the same GRF file as the varaction2, will be used as the base sprite block for the offsets returned by the callback even if it is overridden by a higher priority GRF action 5 definition of the same feature (0E).

==== 0F Tracks for Slopes ====

This should be in the same order as sprites 1031 to 1035 (1). These should only be the rails, basically the same format as sprites 1005 to 1010 (1). There should be 3 groups of these sprites, one for each rail type (railroad, monorail, maglev).

(1) Sprite numbers from trg1r.pcx / ogfx1_base.grf

==== 11 Road stop graphics ====

Road stop graphics consist of 2 groups of 4 sprites. The first group contains graphics for bus stops, second for truck stops. In each group, the sprites are in the following order: SW, NE, NW, SE.

SW and NE sprites are used with road going along the Y axis ( .\' ), NW and SE with road along the X axis( '/. ).

Internally, the stations are defined using the following station layouts:

<pre>\d1313

\b13 \b0 \b0 \b3 \b16 \b16 <SW sprite>

\b0 \b0 \b0 \b3 \b16 \b16 <NE sprite>

80</pre>

and

<pre>\d1314

\b0 \b0 \b0 \b16 \b3 \b16 <NW sprite>

\b0 \b13 \b0 \b16 \b3 \b16 <SE sprite>

80</pre>

where 1313 and 1314 are town road sprites.

[[File:roadstops.png]]

Further sprites can be found in '''openttd.grf''' (OpenTTD), '''ogfxe_extra.grf''' (OpenGFX) or '''ttdpbase(w).grf''' (TTDPatch).

'''Note''': As of OpenTTD r10185, the behaviour of this feature is identical in both games.

==== 12 Aqueducts ====

8 real sprites should be given. Firstly: 4 bridge end sprites in the order: SW, SE, NE, NW, where the direction is that heading onto the aqueduct. Then 2 middle part sprites for the X and Y directions. Followed by two pillar sprites for the X and Y directions. For examples of where the division between middle sprites and pillars should be made see sprites 2437 to 2592 (1), or an existing aqueduct GRF. Note, that for higher bridges to work effectively, pillars should be approximately 8px in height.

[[File:aqueduct.png]]

==== 15 / 95 OpenTTD GUI sprites ====

OpenTTD defines 190 GUI sprites. Additional sprites not needed by an OpenTTD are simply ignored, so that new(er) base sets can be used by old OpenTTD versions. One can (re-)define a subset of the GUI sprites by giving an offset into the GUI sprites. The sprites are:
{|
!Offset !! Meaning
|-
|0 .. 11|| Halftile selections
|-
|12 .. 13 || Title screen letters E and D
|-
|14 .. 37 || Bridge piers colours 1 .. 4
|-
|38 || square indicating NewGRF compatibility
|-
|39 || blob indicating server compatibility
|-
|40 || lock icon
|-
|41 || empty check box
|-
|42 || checked check box
|-
|43 || warning sign
|-
|44 || window resize right
|-
|45 .. 48|| arrows
|-
|49 || house
|-
|50 || shared orders
|-
|51 .. 52 || pin / pinned
|-
|53 .. 62 || rail build icons and cursors
|-
|63 .. 68 || monorail build icons and cursors
|-
|69 .. 74 || maglev build icons and cursors
|-
|75 || ??
|-
|76 .. 77 || waypoint toolbar and cursor icon
|-
|78 .. 81 || waypoint buildings
|-
|82 .. 85 || autoroad toobar and cursor for road and trams
|-
|86 || helipad
|-
|87 || build ship lift cursor
|-
|88 .. 89 || build canal toolbar and cursor
|-
|90 || fast forward
|-
|91 .. 92 || level land toolbar and cursor
|-
|93 .. 96 || sell vehicle
|-
|97 .. 100 || sell all vehicles
|-
|101 .. 104 || replace vehicle
|-
|105 || sell chain of rail vehicles
|-
|106 .. 113 || clone vehicles button and cursors
|-
|114 .. 117 || create vehicle group button
|-
|118 .. 121 || delete vehicle group button
|-
|122 .. 125 || rename vehicle group button
|-
|126 .. 133 || group replace on / off button
|-
|134 || road toolbar: build one-way roads
|-
|135 || signal toolbar: convert signals
|-
|136 .. 137|| build rivers toolbar and cursor
|-
|138 .. 143 || OSK
|-
|144 || switch toolbar
|-
|145 .. 146 || build aqueduct toolbar and cursor
|-
|147 .. 148 || (+) and (-) icon
|-
|149 || window resize left
|-
|150 || play music right-to-left languages
|-
|151 .. 152 || shade / unshade
|-
|153 || debug
|-
|154 .. 157 || vehicle profit icons
|-
|158 || unread news
|-
|159 || exclusive transport rights
|-
|160 || autoreplace protection
|-
|161 || autoreplace defined
|-
|162 .. 165 || Town happiness indicator: N/A, appalling, mediocre and good
|-
|166 .. 167 || Icons for delete to the left resp. right
|-
|168 || Default window size
|-
|169 .. 173 || Story book: Main toolbar icon, goto place, unfinished goal, finished goal, broken goal
|-
|174 || Smallmap cargoflow button
|-
|175 .. 178 || Icons for group livery selection
|-
|179 .. 183 || NotRoadTypes toolbar and cursor icons
|-
|184 || {{ottd|1.11|g8dda0ec4f}} window title bar: rename vehicle/station/town/...
|-
|185 || {{ottd|1.11|g8dda0ec4f}} window title bar: go to location of vehicle/station/town/industry/...
|-
|186 .. 190 || {{ottd|1.12|gfda1a590f6}} multiplayer GUI: chat, admin action, join team, self player, host player
|}

==== 16 / 96 Airport preview sprites ====
[[File:airport_preview_commuter.png|right]]
Preview sprites for the airports in the order
# Small airport
# City airport
# Heliport
# Metropolitan airport
# International airport
# Commuter airport
# Heli depot
# Intercontinental airport
# Heli station

Sprites are without any offsets and should all be the same size. Make sure so by using the forbid cropping.

==== 17 / 97 Tunnel overlay sprites ====
[[File:tunnel_overlays.png|right]]
The sprites provide the ground for the tunnel sprites to be used by railtype NewGRFs which only need to provide the tunnel portals. They must be provided for both terrain types which could be used in any given climate (grass; grass+snow; grass+desert; grass).

=== num-sprites ===

The number of sprites that follow.

Since TTDPatch 2.0.1 alpha 49, this value is an extended byte.

Note that it is not generally an error to provide more sprites than required, but this does expend sprite slots unnecessarily.

=== offset ===

The offset in the Action 5 assignable block of sprites. This term is only read when bit 7 of the type has been set. It can be used to only replace a subset of sprites from a set.

'''Note:''' When creating a TTDPatch compatible grf, you have to skip the OpenTTD specific Action 05's using an Action 09 rather than an Action 07. Using the latter will result in an error on your Action 05 when using the grf in TTDPatch.

'''Note:''' NFORenum distinguishes Action5 with no offset and Action5 with offset 0. While they have technically the same effect, NFORenum assumes an Action5 with no offset has the intention to replace all sprites and checks the number of sprites accordingly. An Action5 with offset is considered to only replace a subset of the sprites, so the sprites are not checked for completeness.

== Example ==

<pre>
// Replace the piers for the aqueduct
1457 * 3 05 12 02 06 // action5, type 12, 2 sprites, at offset 6 into that type
9 sprites/png/terrain/waterfeatures.png 546 8 09 23 33 -26 0
10 sprites/png/terrain/waterfeatures.png 594 8 09 23 33 -5 0
</pre>

Action0/Badges

2025-02-25T12:29:31Z

Peter1138: /* Badge label (08) */

''''''Action 0 properties for badges''''''

= Action 0 - Properties for badges =

Defining properties of badges.

== Properties ==

{| class="wikitable"
|-
!'''Number'''
!'''Version'''
!'''Size'''
!'''Description'''
|-
|08
|{{ottdp|15}}
|S
|Badge label. A zero-terminated string.
|-
|09
|{{ottdp|15}}
|D
|Flags.
|}

<references />

== Badge label (08) ==

These are globally unique strings.

Badge labels comprise a badge class, for grouping similar badges, and badge name, separated by a '/'.

Classes and names are arbitrary, but to be useful must follow a standard scheme. For instance, the badge label power/steam will define a badge for steam powered vehicles within the power class.

Proposed initial classes are:

* flag
* role
* manufacturer
* operator
* power
* livery

It is also possible to assign a badge to everything within a NewGRF by defining the badge label `newgrf/<GRFID>`, with the GRFID in full hexadecimal form. This will work even if the badge is defined outside of the NewGRF it is for.

=== Naming Proposal ===

To work consistently, a naming standard needs to be agreed on, e.g.:

/role/passenger
/role/freight

/livery/<country>/<operator>/<name>
/livery/uk/british_rail/blue
/livery/uk/british_rail/swallow
/livery/fr/sncf/tgv

The game could then present these as a filterable list, e.g.:

Role
Passenger
Freight

Livery
UK
British Rail - Blue
British Rail - Swallow
France
SNCF - TGV

== Flags (09) ==

{| class="wikitable"
|-
!'''Bit'''
!'''Value'''
!'''Meaning'''
|-
|0
|1
|Copy. Badge can be copied to related entity (e.g. badge on a railtype can be copied to rail vehicles of that railtype.)
|-
|1
|2
|NameListStop. Stops adding more names to the visible name list.
|-
|2
|4
|NameListFirstOnly. Add this name to the visible name list only if this is the first name.
|-
|3
|8
|UseCompanyColour. Apply appropriate company colour palette to the icon. If the icon is applied to a vehicle with 2CC support, then the 2CC palette will be used.
|}

Action3

2025-02-24T09:04:55Z

Peter1138: /* cargo-type */

== Introduction ==

Action 3 assigns graphics sets (referenced to by (chains of) [[Action2|action 2(s]]) to feature IDs (vehicles, stations, houses, industries, ...).

== Format ==

The format of the data is feature-dependent.

The data is:

<pre> <Sprite-number> * <Length> 03 <feature> <n-id> <ids...> <num-cid> (<cargo-type> <set-ID>)... <default set-ID></pre>

{| class="wikitable"
|-
!'''Element'''
![[GRFActionsDetailed|'''Size''']]
!'''Description'''
|-
|<Sprite-number>
|dec
|A sequential sprite number
|-
|<length>
|dec
|The total number of bytes used in this action
|-
|03
|B
|Defines action 03
|-
|<feature>
|B
|What type of feature the IDs refer to
|-
|<n-id>
|B
|Number of IDs this action 3 associates graphics with
|-
|<ids...>
|B/B*
|IDs of the current feature this action 3 associates graphics with. There must be as many IDs as <n-id> specifies
|-
|<num-cid>
|B
|Number of different cargo types to support
|-
|<cargo-type>
|B
|Cargo type for which to use the following set-ID
|-
|<set-ID>
|W
|Set-ID (from action 2 or from a varaction2 chain) to use for this cargo type
|-
|<default set-ID>
|W
|Default set-ID to use if none of the above matches
|}

== Description ==

=== 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 [[Features|feature]] that you wish to change. Set it to:

{|- |
!Value!![[Features|Feature]]
|-
|00||Trains
|-
|01||Road Vehicles
|-
|02||Ships
|-
|03||Aircraft
|-
|04||Stations
|-
|05||[[Action3/Canals|Canals/Rivers]]
|-
|07||Houses
|-
|09||Industry Tiles
|-
|0A||Industries
|-
|0B||Cargos
|-
|0C||Sound Effects (generic callback only)
|-
|0D||Airports
|-
|0E||Signals (generic callback only)
|-
|0F||Objects
|-
|10||[[Action3/Railtypes|Railtypes]]
|-
|11||Airport Tiles
|-
|12||[[Action3/Roadtypes|Roadtypes]]
|-
|13||[[Action3/Tramtypes|Tramtypes]]
|-
|14||Road Stops
|}

=== n-id ===

How many items of the current feature this action 3 defines new graphics for. If this is more than one, all items listed will get the same graphics. If this value has bit 7 set (i.e. 80 added), it is a wagon override. See [[Action3LiveryOverride|Action 3 - Livery Override]] for more info on this feature.

You can make a definition with n-id equal to zero (and thus no ids that follow).  This creates a generic feature-specific definition not associated with any particular item.  At the moment, this is used for generic callbacks, but might be extended to other functions eventually.

=== ids ===

Feature IDs to use this action 3 for. All IDs are counted from the first of their class, i.e. the first road vehicle has 00, as does the first plane, the first ship, and the first train vehicle.

In OpenTTD since r13482, each ID is an extended byte for vehicles, otherwise the ID is a regular byte.

Since OpenTTD 14.0, each ID is an extended byte for all features.

For canals and rivers the id has a special meaning, see its [[Action3/Canals|own Action 3 page]]

For town buildings, the IDs are the house IDs, and specifying a house ID that haven't been defined before (by setting its property 08) doesn't do anything, but doesn't cause an error, either. Note that you don't necessarily have to assign a set-ID to a house ID, the old TTD sprite of the substitute type will be used if you don't do so.  Industry tile IDs work in the same manner.

=== num-cid ===

Number of cargo type definitions that follow. Can be zero if only the default follows.

For features 05 (canals/rivers), 07 (houses), 09 (industry tiles), 0A (industries), and 0B (cargoes) this must always be zero.

=== cargo-type ===

{|
|-
! Feature !! cids
|-
| 00..03 vehicles ||
* 00..FE: cargo-type (index in [[Action0/Global Settings#Cargo translation table 09|cargo translation table]]; cargobit if no table present)
* FF: purchase list <ref>For dual-headed trains (prop 13) special rules for the purchase menu sprite apply: two sprites are drawn (for front and back) as if the vehicle is normally constructed. If you supply one purchase menu sprite, it will be used for both vehicle parts in the purchase menu. Provide a set of 8 sprites, and the 7th resp. 3rd sprite will
be drawn; provide a set of 8 blank sprites except the 7th if you want to fully control a single purchase menu sprite for a dual-headed engine.</ref>
* default: used if none of the listed cids apply
|-
| 04 stations ||
* 00..FD: cargo-type (index in [[Action0/Global Settings#Cargo translation table 09|cargo translation table]]; cargobit if no table present) waiting at the station. The waiting amount of this cargo is used in [[Action2/Stations|Action2]] to decide the spriteset.
* FE: used if none of the listed cids apply. [[Action2/Stations|Action2]] will assume "zero waiting cargo".
* FF: purchase list
* default: used if none of the listed cids apply. [[Action2/Stations|Action2]] will use "sum of all waiting cargos".
|-
| 05 canals || default only
|-
| 07 houses || default only
|-
| 09 industry tiles || default only
|-
| 0A industries || default only
|-
| 0B cargos || default only
|-
| 0C sound effects || default only
|-
| 0D airports || default only
|-
| 0E signals || default only
|-
| 0F objects ||
* FF: purchase list
* default: used if none of the listed cids apply
|-
| 10 rail types || special cids, see [[Action3/Railtypes#cargo-type|here]]
|-
| 11 airport tiles || default only
|-
| 12 road types || special cids, see [[Action3/Tramtypes#cargo-type|here]]
|-
| 13 tram types || special cids, see [[Action3/Roadtypes#cargo-type|here]]
|-
| 14 road stops ||
* 00..FD: cargo-type (index in [[Action0/Global Settings#Cargo translation table 09|cargo translation table]]; cargobit if no table present) waiting at the road stop.
* FE: used if none of the listed cids apply.
* FF: purchase list
* default: used if none of the listed cids apply.
|-
| 15 badges || special cids:
* 00..14: feature
* default: used if specific feature is not assigned.
|-
|}

<references/>

=== default set-ID ===

Default set-ID if no entry from the cargo-type list above matches, or if there are no special cargo-types listed at all.

== Example ==

Below is an example of what a real action 3 pseudo-sprite could look like for a train engine.

<pre> 13 * 7   03 00 01 02 00 00 00</pre>

{| class="wikitable"
|-
!'''Byte'''
!'''Meaning'''
|-
|13
|<sprite-number>
|-
|7
|<length> of the action in bytes; start counting at 03 (<action>)
|-
|03
|<action>: sets this pseudo-sprite to function as action 3
|-
|00
|<feature>: 00 for trains
|-
|01
|<n-id>: One ID to change in this case
|-
|02
|<ids...>: vehicle ID (02 - Ploddyphut Choo-Choo)
|-
|00
|<num-cid>: this engine doesn't have cargo-specific graphics
|-
|00 00
|<default set-ID>: Use action 2 ID 00, because it is a word value you add 00
|}

Action0/Badges

2025-02-24T01:53:17Z

Peter1138: /* Badge label (08) */

''''''Action 0 properties for badges''''''

= Action 0 - Properties for badges =

Defining properties of badges.

== Properties ==

{| class="wikitable"
|-
!'''Number'''
!'''Version'''
!'''Size'''
!'''Description'''
|-
|08
|{{ottdp|15}}
|S
|Badge label. A zero-terminated string.
|-
|09
|{{ottdp|15}}
|D
|Flags.
|}

<references />

== Badge label (08) ==

These are globally unique strings.

Badge labels comprise a badge class, for grouping similar badges, and badge name, separated by a '/'.

Classes and names are arbitrary, but to be useful must follow a standard scheme. For instance, the badge label power/steam will define a badge for steam powered vehicles within the power class.

Proposed initial classes are:

* flag
* role
* manufacturer
* operator
* power
* livery

It is also possible to assign a badge to everything within a NewGRF by defining the badge label `newgrf/<GRFID>`, with the GRFID in full hexadecimal form. This will work even if the badge is defined outside of the NewGRF it is for.

== Flags (09) ==

{| class="wikitable"
|-
!'''Bit'''
!'''Value'''
!'''Meaning'''
|-
|0
|1
|Copy. Badge can be copied to related entity (e.g. badge on a railtype can be copied to rail vehicles of that railtype.)
|-
|1
|2
|NameListStop. Stops adding more names to the visible name list.
|-
|2
|4
|NameListFirstOnly. Add this name to the visible name list only if this is the first name.
|-
|3
|8
|UseCompanyColour. Apply appropriate company colour palette to the icon. If the icon is applied to a vehicle with 2CC support, then the 2CC palette will be used.
|}

Action0/Global Settings

2025-02-17T16:43:28Z

Peter1138: /* Tramtype translation table (17) */

== Introduction ==

Global variables can be set in one of two ways. (This) action 0 using feature 8, or [[ActionD|Action D]]. Variables in arrays will usually be set using an action 0, whereas action D will most commonly set single variables.

In addition to global variables, this action can also set some general grf-specific variables.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 40}}||Cost base multipliers
|-
|09||D||{{ottdp|0.6|2.5|ttdprev=alpha 66}}||Cargo translation table
|-
|0A||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency display names
|-
|0B||D||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency multipliers
|-
|0C||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency options
|-
|0D,0E||D||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Currency symbols
|-
|0F||W||{{ottdp|0.6|2.5|ttdprev=alpha 69}}||Euro introduction dates
|-
|10||12*32*B||{{ottdp|0.6|2.5|ttdprev=alpha 74}}||Snow line height table
|-
|11||2*D||{{ottdp|0.7|no|ottdrev=r12924}}||GRFID overrides for engines
|-
|12||D||{{ottdp|0.7|no|ottdrev=r15417}}||Railtype translation table
|-
|13,14||V||{{ottdp|1.1|no|ottdrev=r21208}} {{grfFrom|7}}||Gender/case translation table
|-
|15||B||{{ottdp|1.1|no|ottdrev=r21216}} {{grfFrom|7}}||Plural form
|-
|16,17||D||{{ottdp|1.10|no}}||Road-/tramtype translation table
|-
|18||S||{{ottdp|15}}||Badge translation table
|}

== Descriptions ==

=== Cost base multipliers (08) ===

TTD has 49 [[BaseCosts|base costs]] (66 in OpenTTD currently) which govern how much everything costs. Each cost is calculated from a (fixed) factor times the base cost, which is adjusted by inflation every month.

Setting this property allows changing these base costs by factors of two. The default value of the property is 08 which leaves the base cost unchanged. Adding one to the property doubles the base cost, subtracting one halves it.

Using math: NewBaseCost = OldBaseCost * 2^(n-8), where n is the value of property 08.

Modifying the base costs incurs a small rounding error every time the game is saved, because the costs have to be set back to the default in the savegame. However, this error is unnoticable until many years of inflation have passed and should therefore be of little concern.

{{ottdp|1.0|no}} In OpenTTD rounding happens towards 1 or -1 depending on the old base cost; i.e. if the old base cost is positive round towards 1, if negative round towards -1. This prevents the base cost to be zero.

=== Cargo translation table (09) ===

To aid with coding vehicle grf files that wish to support more than the standard cargo types, the easiest way is to install a cargo translation table using this property.

The cargo translation table is a list of [[Action0Cargos#Cargo label 17|cargo labels]]. Each entry means that the corresponding cargo is meant when using this ID in an [[Action3|action 3]] or for a bit in the vehicle's refit mask.

In other words, if for example the fourth entry (number 03) in the list is "MAIL", then defining graphics for cargo 03 will define graphics for mail, and bit 3 in the refit mask will be for mail as well.

This way, the vehicle grf file doesn't need to know or care which cargo slot and cargo bit a certain cargo type uses, it can define its own ID for each cargo that it wishes to support, and thus be independent of both what cargo types are really available in the game and what slots/bits they use.

Because the refit mask contains only 32 bits, only the first 32 entries in the translation table can make use of the refit mask. Other cargo types have to be added via the cargo classes, so put the cargos that need exceptions to the cargo class based refitting first so that they can go in the refit mask.

Note that this property cannot be set incrementally, you must set all types in a single action 0 starting from ID 0.

See below for an example.

==== Example ====

// Cargo translation table
1 * 169 00 08 01 29 00 09
"COAL" "WATR" "RUBB" "MAIL" "OIL_" // 0-4
"LVST" "GOOD" "CERE" "GRAN" "WHET" // 5-9
"MAIZ" "WOOD" "WODT" "IORE" "CORE" // 10-14
"STEL" "PLAS" "VALU" "GOLD" "DIAM" // 15-19
"PAPR" "FOOD" "FRUT" "FISH" "WOOL" // 20-24
"POTA" "SAND" "GLAS" "WDPR" "DYES" // 25-29
"FERT" "OLSD" "RFPR" "VEHI" "PETR" // 30-34
"BRCK" "SULP" "CMNT" "FICR" "LIME" // 35-39
"MILK" // 40
// Train wagon that has special graphics for grain (8),
// wheat (9), maize (10) and cereals (7)
2 * 29 03 00 01 1B 04
08 <grain-cid> 09 <wheat-cid> 0A <maize-cid>
07 <cereals-cid> <default-cid>
// Train wagon that has graphics for water (1), rubber (2),
// oil (4), petrol (34) and milk (40)
3 * 31 03 00 01 1C 05
01 <water-cid> 02 <rubber-cid> 04 <oil-cid>
22 <petrol-cid> 28 <milk-cid> <default-cid>

=== Currency display names (0A) ===
This and the following properties can be used to modify currencies. Each of them can have IDs 0-18 (decimal), the IDs being ordered the same as in the Currency drop-down list.

This property allows changing currency names that are displayed in the Currency drop-down in the Game Options window. This property is a textID, and if you need to supply your own text, it must be a DCxx one.

=== Currency multipliers (0B) ===

The equivalent of 1 British pound in this currency, multiplied by 1000. For example, 1 GBP=2 USD, so this should be 2000 for US dollars. The multiplication by 1000 allows you to have decimals in the multiplier without requiring floating-point calculations. This value is used for display purposes only, TTD always uses British pounds for internal calculations.

=== Currency options (0C) ===

The low byte of this word specifies the thousands separator to be used for this currency ( usually dot "." or comma ","). The high byte should be zero if the currency symbol should be in front of the number ($123,456) and should be 1 if the currency symbol should be shown after the number (123,456$). The symbol placement can be overridden by the TTDPatch settings.

=== Currency symbols (0D,0E) ===

These doublewords are interpreted as a string of up to 4 characters. If you need fewer characters, the remaining bytes should be zero. Property 0D is printed before the number, property 0E is printed after the number. These two usually differ only if the symbol is separated by a space from the number (for example, "$ " vs. " $"). You should specify both properties since the player can override your preferred symbol placement.

=== Euro introduction dates (0F) ===

This value allows you to have Euro introduced instead the currency at a given time. If this value is zero, the currency is never substituted with the Euro (USD, for example). If it's nonzero, it gives the year when the currency is replaced by Euro (for example, 2002 for DM).

=== Snow line height table (10) ===

This property allows you to specify the snow line height for every day of the year. The only ID you can set is 0, and the value must be 12*32=384 bytes long. To simplify things for the patch, every month has 32 entries, and the impossible combinations (like 32th January or 31th April) will never be read.

{{grfTill|7}} For GRF version 7 and below: The values should be multiple of 8 between 10h and 88h.
Values below 10h and above EFh may result in overflow and should not be used. Since the highest possible land is 78h high, giving 88h or above will effectively disable the snow line.

{{grfFrom|8}} For GRF version 8 and above: The values can be any value between 0 and FFh.
FF means 'no snow'; other values are scaled to the number of possible heightlevels of the map.

{{ottdp|no|2.5}} If the temperate snow line is enabled, this table applies on temperate as well.

'''WARNING:''' Some code in TTD assumes that the snow line will remain constant: Some industries are built only above/below snowline and assume that the snow line won't move when they're already built. Similarly, snowy houses on arctic will still appear snowy even when the snow disappears around them. If you want to use this feature, make sure to counter these effects by overriding arctic houses and industries with snow-aware versions.

=== GRFID overrides for engines (11) ===

Allows you to provide a list of 'source' and 'target' GRFIDs to let vehicles in the source GRF override those in the target GRF, when dynamic engines is enabled. Each entry is 8 bytes, containing two GRFIDs. Multiple entries can be used, and different GRFs can be set to override the same 'target' GRF, but only the last instance of a 'source' GRF is active. GRFIDs that are not present will have no effect.

The scope of this feature is quite limited and it should be used only for sets that modify data of another set, for example the DBSetXL ECS addon for DBSetXL, or the censored version of LV4.

=== Railtype translation table (12) ===

Provides ability to specify railtypes via a translation table, similar to using a cargo translation table. Each railtype label is a DWord. The default labels are RAIL, ELRL, MONO and MGLV. If a table is installed, then changing engine traction type will not affect the railtype.

Note that labels are not shared between features, so the same label can be used for multiple items. For example, the label "RAIL" can be used for a railtype, roadtype, tramtype, and cargotype simultaneously without conflict.

=== Gender/case translation table (13,14) ===

Provides ability to specify genders or cases via a translation table. These map NewGRF internal IDs for the genders or cases to the genders or cases as defined in OpenTTD's language files so NewGRF strings and OpenTTD strings can interact on eachother's gender or cases. Property 13 is for mapping genders whereas property 14 is for mapping cases.

The ID used for these translation tables is the Action 4 (GRF version 7 or higher) language-id, i.e. this mapping only works with GRF version 7 or higher. Language-id 7F (any) is not allowed. You can can define an ID multiple times in which case the new mappings are simply appended to the already known mappings.

The format is simply a 00 terminated list of mappings:

(<id> <name>)+ 00

{| |-
!Size!!Name!!Meaning
|-
|B||id||NewGRF internal ID for the gender or case name, may not be 00
|-
|V||name||A 00 terminated string with the gender or case name as in OpenTTD's translation
|}

An NewGRF internal ID may be mapped multiple times for the same language as may an OpenTTD gender or case name be (reverse) mapped multiple times. This can be used for coping with OpenTTD translators adding or removing genders or cases over time. The NewGRF internal ID may not be 00 as this ID will be used in the Action 4 strings which may not contain 00 except for terminating the string.

These mappings are used for [[StringCodes]] 9A 0E, 9A 0F, 9A 13 and 9A 14. How the mapping is used precisely can be found there.

=== Plural form (15) ===

Defines the plural form for a language. The ID used is the Action 4 (GRF version 7 or higher) language-id, i.e. this only works with GRF version 7 or higher. Language-id 7F (any) is not allowed. More information about the different valid plural forms can be found on the [[StringCodes]] page. This property is used for [[StringCodes|StringCode]] 9A 15.

=== Roadtype translation table (16) ===

Provides ability to specify roadtypes via a translation table, similar to using a cargo translation table. Each roadtype label is a DWord. The default labels are ROAD and ELRD.

Note that labels are not shared between features, so the same label can be used for multiple items. For example, the label "RAIL" can be used for a railtype, roadtype, tramtype, and cargotype simultaneously without conflict.

=== Tramtype translation table (17) ===

Provides ability to specify tramtypes via a translation table, similar to using a cargo translation table. Each tramtype label is a DWord. The default labels are RAIL and ELRL.

Note that labels are not shared between features, so the same label can be used for multiple items. For example, the label "RAIL" can be used for a railtype, roadtype, tramtype, and cargotype simultaneously without conflict.

=== Badge translation table (18) ===

Required to allow badges to be assigned to other items. Each badge translation table entry is zero-terminated string corresponding to the badge's label.

Unlike the other DWord label systems, a badge listed in a translation will automatically be created if it is not otherwise provided, and is fully usable internally.

Action0/Global Settings

2025-02-17T14:59:18Z

Peter1138: /* Properties */

Action0/Road Stops

2025-02-17T14:58:23Z

Peter1138: /* Properties */

==Introduction==
Defining properties of road stops.

Road stop IDs may be freely chosen. In action 0, you need only specify IDs relative to the set, i.e. the ID of the first road stop type is 00, the second road type is 01 and so on.

OpenTTD supports 64000 road stops per game, and 64000 road stop IDs per GRF file.

The property you '''must''' set for each road stop ID is 08 (in addition to defining an action 3 for it). Also, all road stop IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==
{|
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|14}}||Class label, see below
|-
|09||B||{{ottdp|14}}||Road stop type
|-
|0A||W||{{ottdp|14}}||Road stop name text ID
|-
|0B||W||{{ottdp|14}}||Class name text ID
|-
|0C||B||{{ottdp|14}}||Draw mode
|-
|0D||D||{{ottdp|14}}||Random trigger cargoes
|-
|0E||W||{{ottdp|14}}||Animation information
|-
|0F||B||{{ottdp|14}}||Animation speed
|-
|10||W||{{ottdp|14}}||Animation triggers
|-
|11||B||{{ottdp|14}}||Callback flags, see below
|-
|12||D||{{ottdp|14}}||General flags, see below
|-
|15||W||{{ottdp|14}}||Cost multipiers, see below
|-
|16||W n*W||{{ottdp|15}}||List of badges
|}

== Descriptions ==

=== Road stop class (08) ===

New road stops are grouped graphics into classes.

Only two classes are pre-defined:

{| |-
!Name!!Class ID!!Intended use for road stops
|-
|DFLT||44 46 4C 54||Default road stops
|-
|WAYP||57 41 59 50||{{ottdp|15}} Road waypoints
|}

{{ottdp|15}} Road stop classes which start with the byte FF are considered road waypoint classes, and will appear in the road waypoint construction window instead of the road bus/truck stop construction windows.

It is recommended that the class identifier used is unique to your GRF(s).

=== Road stop type (09) ===

{| |-
!Value!!Meaning
|-
|0||Passenger/bus stop
|-
|1||Freight/lorry stop
|-
|2||Both passenger/bus and freight/lorry stops
|}

The default value is 2: Both passenger/bus and freight/lorry stops

=== Road stop name text ID (0A) ===

The text ID for this road stop (word value). This textid should be either a TTD textid or a D4xx textid (set via D0xx in action4).

=== Class name text ID (0B) ===

The text ID for the road stop class.

When specifying a road stop, you don't need to set a class name again if you already did for another one with the same class.

=== Draw mode (0C) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||Bay stops: Draw road type ground sprite
|-
|1||2||Drive through stops: Draw road/tram type overlays
|-
|2||4||{{ottdp|15}} Road waypoints: Draw the sprite layout ground tile (on top of the road)
|}

The default value is 3 (bits 0 and 1 both set).

The remaining bits are reserved for future use.

=== Cargo types for random triggers (0D) ===

This sets which cargo types should trigger re-randomizing. The cargo types are given as a bitmask of the bits from column 3 (type B) in CargoTypes.  If nothing is set (the default), the no random triggers will happen, to conserve CPU time.

With GRF version 7 and above, the interpretation of bits changes. Instead of climate-dependent cargo slot numbers (type B), you have to set the bits of climate-independent cargo ID (type A).

=== Animation information (0E) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this station (this is the default value).
Since you can't have properties for individual station tiles, this property applies for every tile of the station. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] for that.

=== Animation speed (0F) ===
The meaning is the same as for [[Action0Houses#Animation Speed 1B|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.

=== Animation triggers (10) ===
This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]], allowing to change the animation state

=== Callback flags (11) ===
For road stops, the following [[callbacks]] can be defined by setting the corresponding bit in property 0B:

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||13||Whether to make the road stop available in construction window (non-zero callback return) or not (callback returns zero)
|-
|1||2||141||Decide next animation frame
|-
|2||4||142||Decide animation speed
|}
Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the [[VariationalAction2|VarAction2]] for callbacks.

=== General Flags (12) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||[[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] needs random bits in var. 10
|-
|2||4||Do not show catenary graphics
|-
|3||8||Only allow drive-through stops (not bay stops)
|-
|4||10||Do not automatically build connecting road pieces
|-
|5||20||Only show in the road build menu (not tram)
|-
|6||40||Only show in the tram build menu (not road)
|-
|8||100||{{ottdp|15}} Read the draw mode from register 0x100, overriding the default value in property 0C

|}

The default value is 0 (no bits set).

The remaining bits are reserved for future use.

=== Cost multipiers (15) ===

The first byte is the build cost multiplier.

The second byte is the removal cost multiplier.

The total property length is 2 bytes.

A value of 16 produces a build or removal cost the same as non-NewGRF road stops.

== Examples ==

Action0/Road Stops

2025-02-17T14:58:13Z

Peter1138: /* Properties */

==Introduction==
Defining properties of road stops.

Road stop IDs may be freely chosen. In action 0, you need only specify IDs relative to the set, i.e. the ID of the first road stop type is 00, the second road type is 01 and so on.

OpenTTD supports 64000 road stops per game, and 64000 road stop IDs per GRF file.

The property you '''must''' set for each road stop ID is 08 (in addition to defining an action 3 for it). Also, all road stop IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==
{|
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|14}}||Class label, see below
|-
|09||B||{{ottdp|14}}||Road stop type
|-
|0A||W||{{ottdp|14}}||Road stop name text ID
|-
|0B||W||{{ottdp|14}}||Class name text ID
|-
|0C||B||{{ottdp|14}}||Draw mode
|-
|0D||D||{{ottdp|14}}||Random trigger cargoes
|-
|0E||W||{{ottdp|14}}||Animation information
|-
|0F||B||{{ottdp|14}}||Animation speed
|-
|10||W||{{ottdp|14}}||Animation triggers
|-
|11||B||{{ottdp|14}}||Callback flags, see below
|-
|12||D||{{ottdp|14}}||General flags, see below
|-
|15||W||{{ottdp|14}}||Cost multipiers, see below
|-
|16||{{ottdp|15}}||W n*W||List of badges
|}

== Descriptions ==

=== Road stop class (08) ===

New road stops are grouped graphics into classes.

Only two classes are pre-defined:

{| |-
!Name!!Class ID!!Intended use for road stops
|-
|DFLT||44 46 4C 54||Default road stops
|-
|WAYP||57 41 59 50||{{ottdp|15}} Road waypoints
|}

{{ottdp|15}} Road stop classes which start with the byte FF are considered road waypoint classes, and will appear in the road waypoint construction window instead of the road bus/truck stop construction windows.

It is recommended that the class identifier used is unique to your GRF(s).

=== Road stop type (09) ===

{| |-
!Value!!Meaning
|-
|0||Passenger/bus stop
|-
|1||Freight/lorry stop
|-
|2||Both passenger/bus and freight/lorry stops
|}

The default value is 2: Both passenger/bus and freight/lorry stops

=== Road stop name text ID (0A) ===

The text ID for this road stop (word value). This textid should be either a TTD textid or a D4xx textid (set via D0xx in action4).

=== Class name text ID (0B) ===

The text ID for the road stop class.

When specifying a road stop, you don't need to set a class name again if you already did for another one with the same class.

=== Draw mode (0C) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||Bay stops: Draw road type ground sprite
|-
|1||2||Drive through stops: Draw road/tram type overlays
|-
|2||4||{{ottdp|15}} Road waypoints: Draw the sprite layout ground tile (on top of the road)
|}

The default value is 3 (bits 0 and 1 both set).

The remaining bits are reserved for future use.

=== Cargo types for random triggers (0D) ===

This sets which cargo types should trigger re-randomizing. The cargo types are given as a bitmask of the bits from column 3 (type B) in CargoTypes.  If nothing is set (the default), the no random triggers will happen, to conserve CPU time.

With GRF version 7 and above, the interpretation of bits changes. Instead of climate-dependent cargo slot numbers (type B), you have to set the bits of climate-independent cargo ID (type A).

=== Animation information (0E) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this station (this is the default value).
Since you can't have properties for individual station tiles, this property applies for every tile of the station. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] for that.

=== Animation speed (0F) ===
The meaning is the same as for [[Action0Houses#Animation Speed 1B|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.

=== Animation triggers (10) ===
This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]], allowing to change the animation state

=== Callback flags (11) ===
For road stops, the following [[callbacks]] can be defined by setting the corresponding bit in property 0B:

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||13||Whether to make the road stop available in construction window (non-zero callback return) or not (callback returns zero)
|-
|1||2||141||Decide next animation frame
|-
|2||4||142||Decide animation speed
|}
Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the [[VariationalAction2|VarAction2]] for callbacks.

=== General Flags (12) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||[[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] needs random bits in var. 10
|-
|2||4||Do not show catenary graphics
|-
|3||8||Only allow drive-through stops (not bay stops)
|-
|4||10||Do not automatically build connecting road pieces
|-
|5||20||Only show in the road build menu (not tram)
|-
|6||40||Only show in the tram build menu (not road)
|-
|8||100||{{ottdp|15}} Read the draw mode from register 0x100, overriding the default value in property 0C

|}

The default value is 0 (no bits set).

The remaining bits are reserved for future use.

=== Cost multipiers (15) ===

The first byte is the build cost multiplier.

The second byte is the removal cost multiplier.

The total property length is 2 bytes.

A value of 16 produces a build or removal cost the same as non-NewGRF road stops.

== Examples ==

Action0/Airport Tiles

2025-02-17T14:57:52Z

Peter1138: /* Properties */

== Introduction ==

{{ottdp|1.1|ottdrev=r19204}}
Airport tiles work like industry tiles and similarly to town buildings, except that they are not stand-alone. This means an airport tile can't stand alone, it's always part of an airport.

== Properties ==

{| |-
!Number!!Version!![[GRFActionsDetailed|Size]]!!Description
|-
|08||{{ottdp|1.1|ottdrev=r19204}}||B||Substitute airport tile type
|-
|09||{{ottdp|1.1|ottdrev=r19204}}||B||Airport tile override
|-
|0E||{{ottdp|1.1|ottdrev=r19204}}||B||Callback flags
|-
|0F||{{ottdp|1.1|ottdrev=r19204}}||W||Animation information
|-
|10||{{ottdp|1.1|ottdrev=r19204}}||B||Animation speed.
|-
|11||{{ottdp|1.1|ottdrev=r19204}}||B||Animation triggers
|-
|12||{{ottdp|15}}||W n*W||List of badges
|}

== Descriptions ==

=== Substitute tile type (08) ===

This tile type will be used instead of your new one if your definition isn't available for any reason. Assigning this property copies the properties of the old type just like it does with houses. If this tile's action 3 appears before this property is set, the action 3 will have no effect.

=== Airport tile override (09) ===

Works like the house override property for houses and industry tiles.

=== Callback flags (0E) ===

{| |-
!Bit!!value!!version!!meaning
|-
|0||1||{{ottdp|1.1|ottdrev=r19204}}||use [[Callbacks#Next animation frame (1A/26/141/153/158) |callback 153]] to decide the next animation frame
|-
|1||2||{{ottdp|1.1|ottdrev=r19204}}||use [[Callbacks#Length of animation frame (20/27/142/154/15A) |callback 154]] to decide animation speed
|-
|2||4||{{ottdp}}||(reserved)
|-
|3||8||{{ottdp}}||(reserved)
|-
|4||10||{{ottdp|1.1|ottdrev=r19204}}||use callback xx to check if a slope is suitable (not yet implemented)
|-
|5||20||{{ottdp|1.1|ottdrev=r19204}}||use [[Callbacks#Decide drawing default foundations (30/14E/150) |callback 150]] to decide if default foundations need to be drawn
|-
|6||40||{{ottdp|1.1|ottdrev=r19204}}||use callback xx to allow or deny autosloping below the tile (not yet implemented)
|}

Please note that callback 152 doesn't have a bit here. To use [[Callbacks#Animation control (1B/25/140/152/159) |callback 152]], simply set the wanted bits in property 11 and it will work as intended.

=== Animation information (0F) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this tile (this is the default value).

=== Animation speed (10) ===

The meaning is the same as for house property 1B, but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.

=== Animation triggers via [[Callback:_Animation_control |callback 152]] (11) ===

This shares some flags with industry tiles and others with stations. Call [[Callback:_Animation_control|callback 152]] when:

{| |-
!Bit!!Value!!Version!!Meaning!!Var 18
|-
|0||1||{{ottdp|1.1|ottdrev=r19204}}||airport was just constructed||
|-
|1||2||{{ottdp|1.1|ottdrev=r19204}}||the tile is processed in the periodic processing loop||
|-
|2||4||{{ottdp|1.1|ottdrev=r19204}}||new cargo arrives at the station (for all airport tiles the same)||<ref name="cargotype">Bits 8..15 of var 18 contain the triggering cargo type. If your GRF has a cargo translation table, the cargo type will be an index in that table, or FFh if the cargo isn't in the table. If you don't have a cargo translation table, the cargo type will simply be the climate-dependent cargo type number.</ref>
|-
|3||8||{{ottdp|1.1|ottdrev=r19204}}||a cargo type gets removed from the station (for all airport tiles the same)||<ref name="cargotype"/>
|-
|4||10||{{ottdp|1.1|ottdrev=r19204}}||every 250 ticks (for all airport tiles the same)||
|-
|5||20||{{ottdp|1.9}}||Triggered when an airplane (not a helicopter!) lands at airport (single tile only)||
|}

<references/>

== Example ==

Action0/Tramtypes

2025-02-17T14:57:07Z

Peter1138: /* Properties */

'''''Action 0 properties for tram types'''''

= Action 0 - Properties for tram types =

Defining properties of tram types.

Up to 63 tramtypes can be defined.

== Properties ==

{| class="wikitable"
|-
!'''Number'''
!'''Version'''
!'''Size'''
!'''Description'''
|-
|08
|{{ottdp|1.10}}
|4*B
|Tram type label
|-
|09
|{{ottdp|1.10}}
|W
|StringID: Build tram toolbar caption
|-
|0A
|{{ottdp|1.10}}
|W
|StringID: Tram construction dropdown text
|-
|0B
|{{ottdp|1.10}}
|W
|StringID: Build vehicle window caption
|-
|0C
|{{ottdp|1.10}}
|W
|StringID: Autoreplace text
|-
|0D
|{{ottdp|1.10}}
|W
|StringID: New engine text
|-
|0F
|{{ottdp|1.10}}
|B n*D
|Powered tram type list<ref name="alt_label">Tram type labels in this list are ''not'' resolved using the alternate label list.</ref>
|-
|10
|{{ottdp|1.10}}
|B
|Tram type flags
|-
|13
|{{ottdp|1.10}}
|W
|Construction costs
|-
|14
|{{ottdp|1.10}}
|W
|Speed limit
|-
|16
|{{ottdp|1.10}}
|B
|Minimap colour
|-
|17
|{{ottdp|1.10}}
|D
|Introduction date
|-
|18
|{{ottdp|1.10}}
|B n*D
|Introduction required tram type list<ref name="alt_label" />
|-
|19
|{{ottdp|1.10}}
|B n*D
|Introduced tram type list<ref name="alt_label" />
|-
|1A
|{{ottdp|1.10}}
|B
|Sort order
|-
|1B
|{{ottdp|1.10}}
|W
|StringID: Tram type name
|-
|1C
|{{ottdp|1.10}}
|W
|Infrastructure maintenance cost factor
|-
|1D
|{{ottdp|1.10}}
|B n*D
|Alternate tram type labels that shall be "redirected" to this tram type
|-
|1E
|{{ottdp|15}}
|W n*W
|List of badges
|}

<references />

In NFO, tram type IDs will be GRF local, with an ID to label mapping. Therefore to modify an existing tram type, specify its label in property 08. To create a new tram type, again just specify its label in property 08. This way there is no need for complex GRM mechanisms to allocate IDs. If a label 'clashes' with another GRF, then one GRF will end up modifying the properties instead of creating a new tram type.

When a new tram type is created, it is populated with the information from the first tram type, except that the powered list contains only the tram type being created. However, no default values should be assumed, as the first tram type may have been modified.

== Vehicle and Tramtype availability ==

Vehicle and tramtype availability and compatibility is influenced by multiple properties.
Generally, the vehicle defines which tramtype it is, and the tramtypes define the compatibility between each other.
* A vehicle exists, if its tramtype (road vehicle prop 05) is defined. Otherwise the vehicle is disabled.
* When a vehicle is introduced, it always introduces its tramtype (road vehicle prop 05).
* A tramtype is introduced, if at least one of the following conditions is met:
** A vehicle is introduced, that references the tramtype (road vehicle prop 05).
** Another tramtype is introduced, that references the tramtype via the introduced tramtype list (tramtype prop 19).
** The introduction date (tramtype prop 17) is passed and all required tramtypes (tramtype prop 18) are available.

Via tramtype property 1D multiple tramtypes can be defined, which shall be considered equivalent to a tramtype.
This affects the interpretation of road vehicle property 05. If road vehicle property 05 references an undefined tramtype, then
tramtype property 1D is checked for all defined tramtypes, whether the vehicle can be reassigned to some other tramtype.
Otherwise the vehicle is disabled.

== Tram type label (08) ==

These are globally unique four-letter identifiers for specific tram types (analoguous to [[Action0Cargos#Cargo label 17|cargo labels]]), used to make various tram types accessible from road vehicle grfs. Reserved labels for default tram types are:

{| class="wikitable
|-
!'''Label'''
!'''Tram Type'''
|-
|RAIL
| Normal Tram
|-
|ELRL
| Electrified Tram
|}

Tram type sets may use up to 63 tramtypes and have to specify their own [[TramtypeLabels|labels]].

See also [[Action0/Global Settings#Tram type translation table 12|Tram Type Translation Table]] for further info.

== Build tram toolbar caption (09) ==

String ID of the name of the tram type as shown in the toolbar caption.

== Tram construction dropdown text (0A) ==

String ID for text in the dropdown of all tram types.

This string must never start with a colour control code.

== Build vehicle window caption (0B) ==

String ID for build vehicle window caption.

== Autoreplace text (0C) ==

String ID for tram type shown in autoreplace window.

== New engines (0D) ==

StringID to use for showing texts of the type "We have invented a new <tram type> engine".

== Powered tram type list (0F) ==

List of tram types on which road vehicles of this tram type are powered. E.g. vehicles of "normal tram"-type are powered on "electrified tram"- and "haul-tram"-type as well. Note that there is no "compatible tram type list" since there is no difference between "powered" and "compatible" for tramtypes

The format is:

<pre>0E <nvar> (<tram type label>){n}</pre>

That is you give the number of compatible tram types in a single byte followed by a list of that length of tram type labels. A tram type is automatically powered with itself, so you don't need to list the current tram type.

Note that these properties apply to road vehicles of this tram type, not the tram itself. If you want road vehicles of other tram types to be able to run on your tram types, you must set the powered tram types property for each tram type. Setting these properties behaves always incremental, so you only need to the set additional bits for each other tram type, you cannot remove poweredness once it is set (by some other grf).

== Tram type flags (10) ==

Flags to define properties related to the tram type:

{| class="wikitable"
|-
!'''Bit'''
!'''Value'''
!'''Meaning'''
|-
|0
|1
|Draw catenary for this tram type
|-
|1
|2
|Disallow level crossings for this tram type
|-
|2
|4
|Disallow construction of houses along tramtype
|-
|3
|8
|Hide this tram type from construction menu
|-
|4
|16
|Enables towns to build tramtype, but towns don't build trams...
|}

== Speed limit (14) ==

Speed limit in mph*0.8 (approx. 0.5km/h). Set to "0" for no limit at all.

== Map colour (16) ==

This property defines the colour this tram type is drawn in the minimap view. The byte value specifies the colour entry in the [[PalettesAndCoordinates|DOS palette]].

== Introduction date (17) ==

This property defines the long date formatted introduction date of this tram type. With this property set the tram type will be introduced at (or after) this date when all of the introduction required tram types are available to the company of the player, or whenever a vehicle using this tram type gets introduced whichever is first.

== Introduction required tram type list (18) ==

List of tram types on that need to be available to the company of the player for this tram type to be introduced at (or after) the introduction date. This limit does not apply when the tram type is introduced by the introduction of a vehicle.

Same format as for property 0F above.

This can, for example, be used to introduce a tram type with catenary when both normal tram and electrified tram types are available.

== Introduced tram type list (19) ==

List of tram types that get introduced when this tram type is introduced. For example, to make sure that when a fast tram type is introduced the slow variant exists.

Same format as for property 0F above.

== Sort order (1A) ==

Property for influencing the sort order of the drop down lists with tram types. Default values are as follows:

{| class="wikitable"
|-
!'''Value'''
!'''Meaning'''
|-
|07
|Normal Tram
|-
|17
|Electrified Tram
|-
|n7
|Tramtype #n
|}

Thus the tram 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.

== Tram type name (1B) ==

String ID of the name of the tram type.

== Alternate tram type labels (1D) ==

A list of alternate labels that get "redirected" to this tram type when used e.g. as tram type of road vehicle or when testing if a label is defined. The redirection only happens if the alternate label isn't defined as a real tram type. Same format as for property 0F above.

Alternate labels are not considered when evaluating properties 0F, 18, and 19.

= Example =

To be written

Action0/Roadtypes

2025-02-17T14:56:54Z

Peter1138: /* Properties */

'''''Action 0 properties for road types'''''

= Action 0 - Properties for road types =

Defining properties of road types.

Up to 63 roadtypes can be defined.

== Properties ==

{| class="wikitable"
|-
!'''Number'''
!'''Version'''
!'''Size'''
!'''Description'''
|-
|08
|{{ottdp|1.10}}
|4*B
|Road type label
|-
|09
|{{ottdp|1.10}}
|W
|StringID: Build road toolbar caption
|-
|0A
|{{ottdp|1.10}}
|W
|StringID: Road construction dropdown text
|-
|0B
|{{ottdp|1.10}}
|W
|StringID: Build vehicle window caption
|-
|0C
|{{ottdp|1.10}}
|W
|StringID: Autoreplace text
|-
|0D
|{{ottdp|1.10}}
|W
|StringID: New engine text
|-
|0F
|{{ottdp|1.10}}
|B n*D
|Powered road type list<ref name="alt_label">Road type labels in this list are ''not'' resolved using the alternate label list.</ref>
|-
|10
|{{ottdp|1.10}}
|B
|Road type flags
|-
|13
|{{ottdp|1.10}}
|W
|Construction costs
|-
|14
|{{ottdp|1.10}}
|W
|Speed limit
|-
|16
|{{ottdp|1.10}}
|B
|Minimap colour
|-
|17
|{{ottdp|1.10}}
|D
|Introduction date
|-
|18
|{{ottdp|1.10}}
|B n*D
|Introduction required road type list<ref name="alt_label" />
|-
|19
|{{ottdp|1.10}}
|B n*D
|Introduced road type list<ref name="alt_label" />
|-
|1A
|{{ottdp|1.10}}
|B
|Sort order
|-
|1B
|{{ottdp|1.10}}
|W
|StringID: Road type name
|-
|1C
|{{ottdp|1.10}}
|W
|Infrastructure maintenance cost factor
|-
|1D
|{{ottdp|1.10}}
|B n*D
|Alternate road type labels that shall be "redirected" to this road type
|-
|1E
|{{ottdp|15}}
|W n*W
|List of badges
|}

<references />

In NFO, road type IDs will be GRF local, with an ID to label mapping. Therefore to modify an existing road type, specify its label in property 08. To create a new road type, again just specify its label in property 08. This way there is no need for complex GRM mechanisms to allocate IDs. If a label 'clashes' with another GRF, then one GRF will end up modifying the properties instead of creating a new road type.

When a new road type is created, it is populated with the information from the first road type, except that the powered list contains only the road type being created. However, no default values should be assumed, as the first road type may have been modified.

== Vehicle and Roadtype availability ==

Vehicle and roadtype availability and compatibility is influenced by multiple properties.
Generally, the vehicle defines which roadtype it is, and the roadtypes define the compatibility between each other.
* A vehicle exists, if its roadtype (road vehicle prop 05) is defined. Otherwise the vehicle is disabled.
* When a vehicle is introduced, it always introduces its roadtype (road vehicle prop 05).
* A roadtype is introduced, if at least one of the following conditions is met:
** A vehicle is introduced, that references the roadtype (road vehicle prop 05).
** Another roadtype is introduced, that references the roadtype via the introduced roadtype list (roadtype prop 19).
** The introduction date (roadtype prop 17) is passed and all required roadtypes (roadtype prop 18) are available.

Via roadtype property 1D multiple roadtypes can be defined, which shall be considered equivalent to a roadtype.
This affects the interpretation of road vehicle property 05. If road vehicle property 05 references an undefined roadtype, then
roadtype property 1D is checked for all defined roadtypes, whether the vehicle can be reassigned to some other roadtype.
Otherwise the vehicle is disabled.

== Road type label (08) ==

These are globally unique four-letter identifiers for specific road types (analoguous to [[Action0Cargos#Cargo label 17|cargo labels]]), used to make various road types accessible from road vehicle grfs. Reserved labels for default road types are:

{| class="wikitable
|-
!'''Label'''
!'''Road Type'''
|-
|ROAD
| Normal Road
|-
|ELRD
| Electrified Road
|}

Road type sets may use up to 63 roadtypes and have to specify their own [[RoadtypeLabels|labels]].

See also [[Action0/Global Settings#Road type translation table 12|Road Type Translation Table]] for further info.

== Build road toolbar caption (09) ==

String ID of the name of the road type as shown in the toolbar caption.

== Road construction dropdown text (0A) ==

String ID for text in the dropdown of all road types.

This string must never start with a colour control code.

== Build vehicle window caption (0B) ==

String ID for build vehicle window caption.

== Autoreplace text (0C) ==

String ID for road type shown in autoreplace window.

== New engines (0D) ==

StringID to use for showing texts of the type "We have invented a new <road type> engine".

== Powered road type list (0F) ==

List of road types on which road vehicles of this road type are powered. E.g. vehicles of "normal road"-type are powered on "electrified road"- and "haul-road"-type as well. Note that there is no "compatible road type list" since there is no difference between "powered" and "compatible" for roadtypes

The format is:

<pre>0E <nvar> (<road type label>){n}</pre>

That is you give the number of compatible road types in a single byte followed by a list of that length of road type labels. A road type is automatically powered with itself, so you don't need to list the current road type.

Note that these properties apply to road vehicles of this road type, not the road itself. If you want road vehicles of other road types to be able to run on your road types, you must set the powered road types property for each road type. Setting these properties behaves always incremental, so you only need to the set additional bits for each other road type, you cannot remove poweredness once it is set (by some other grf).

== Road type flags (10) ==

Flags to define properties related to the road type:

{| class="wikitable"
|-
!'''Bit'''
!'''Value'''
!'''Meaning'''
|-
|0
|1
|Draw catenary for this road type
|-
|1
|2
|Disallow level crossings for this road type
|-
|2
|4
|Disallow construction of houses along roadtype
|-
|3
|8
|Hide this road type from construction menu
|-
|4
|16
|Enables road type to be built by towns, picked by highest speed limit (defaults to ROAD label if no speed limits?)
|}

== Speed limit (14) ==

Speed limit in mph*0.8 (approx. 0.5km/h). Set to "0" for no limit at all.

== Map colour (16) ==

This property defines the colour this road type is drawn in the minimap view. The byte value specifies the colour entry in the [[PalettesAndCoordinates|DOS palette]].

== Introduction date (17) ==

This property defines the long date formatted introduction date of this road type. With this property set the road type will be introduced at (or after) this date when all of the introduction required road types are available to the company of the player, or whenever a vehicle using this road type gets introduced whichever is first.

== Introduction required road type list (18) ==

List of road types on that need to be available to the company of the player for this road type to be introduced at (or after) the introduction date. This limit does not apply when the road type is introduced by the introduction of a vehicle.

Same format as for property 0F above.

This can, for example, be used to introduce a road type with streetlights when both paved road and electrified road types are available.

== Introduced road type list (19) ==

List of road types that get introduced when this road type is introduced. For example, to make sure that when a fast road type is introduced the slow variant exists.

Same format as for property 0F above.

== Sort order (1A) ==

Property for influencing the sort order of the drop down lists with road types. Default values are as follows:

{| class="wikitable"
|-
!'''Value'''
!'''Meaning'''
|-
|07
|Normal Road
|-
|17
|Electrified Road
|-
|n7
|Roadtype #n
|}

Thus the road 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.

== Road type name (1B) ==

String ID of the name of the road type.

== Alternate road type labels (1D) ==

A list of alternate labels that get "redirected" to this road type when used e.g. as road type of road vehicle or when testing if a label is defined. The redirection only happens if the alternate label isn't defined as a real road type. Same format as for property 0F above.

Alternate labels are not considered when evaluating properties 0F, 18, and 19.

= Example =

To be written

Action0/Railtypes

2025-02-17T14:56:36Z

Peter1138: /* Properties */

'''''Action 0 properties for rail types'''''

= Action 0 - Properties for rail types =

Defining properties of rail types.

{{ottdp|1.0|no|ottdrev=r18969}} 16 railtypes can be defined.

{{ottdp|1.9|no|ottdrev=bf8d7df7}} 64 railtypes can be defined.

== Properties ==

{| class="wikitable"
|-
!'''Number'''
!'''Version'''
!'''Size'''
!'''Description'''
|-
|08
|{{ottdp|1.0}}
|4*B
|Rail type label
|-
|09
|{{ottdp|1.0}}
|W
|StringID: Build rail toolbar caption<ref>{{grfTill|7}} For GRF version 7 or earlier, setting property 09 sets property 1B as well.</ref>
|-
|0A
|{{ottdp|1.0}}
|W
|StringID: Rail construction dropdown text
|-
|0B
|{{ottdp|1.0}}
|W
|StringID: Build vehicle window caption
|-
|0C
|{{ottdp|1.0}}
|W
|StringID: Autoreplace text
|-
|0D
|{{ottdp|1.0}}
|W
|StringID: New engine text
|-
|0E
|{{ottdp|1.0}}
|B n*D
|Compatible rail type list<ref name="alt_label">Rail type labels in this list are ''not'' resolved using the alternate label list.</ref>
|-
|0F
|{{ottdp|1.0}}
|B n*D
|Powered rail type list<ref name="alt_label" />
|-
|10
|{{ottdp|1.0}}
|B
|Rail type flags
|-
|11
|{{ottdp|1.0}}
|B
|Curve speed advantage multiplier
|-
|12
|{{ottdp|1.0}}
|B
|Station (and depot) graphics
|-
|13
|{{ottdp|1.0}}
|W <ref>In r18969 to 19306 this property was byte-sized.</ref>
|Construction costs
|-
|14
|{{ottdp|1.0}}
|W
|Speed limit
|-
|15
|{{ottdp|1.0}}
|B
|Acceleration model
|-
|16
|{{ottdp|1.0|no|ottdrev=r19307}}
|B
|Minimap colour
|-
|17
|{{ottdp|1.1|no|ottdrev=r21842}}
|D
|Introduction date
|-
|18
|{{ottdp|1.1|no|ottdrev=r21842}}
|B n*D
|Introduction required rail type list<ref name="alt_label" />
|-
|19
|{{ottdp|1.1|no|ottdrev=r21841}}
|B n*D
|Introduced rail type list<ref name="alt_label" />
|-
|1A
|{{ottdp|1.1|no|ottdrev=r21866}}
|B
|Sort order
|-
|1B
|{{ottdp|1.2|no|ottdrev=r23129}}
|W
|StringID: Rail type name<ref>{{grfTill|7}} For GRF version 7 or earlier, set property 1B ''after'' setting property 09, as property 09 sets the rail type name as well for backwards compatibility.</ref>
|-
|1C
|{{ottdp|1.2|no|ottdrev=r23415}}
|W
|Infrastructure maintenance cost factor
|-
|1D
|{{ottdp|1.2|no|ottdrev=r23758}}
|B n*D
|Alternate rail type labels that shall be "redirected" to this rail type
|-
|1E
|{{ottdp|15}}
|W n*W
|List of badges
|}

<references />

In NFO, rail type IDs will be GRF local, with an ID to label mapping. Therefore to modify an existing rail type, specify its label in property 08. To create a new rail type, again just specify its label in property 08. This way there is no need for complex GRM mechanisms to allocate IDs. If a label 'clashes' with another GRF, then one GRF will end up modifying the properties instead of creating a new rail type.

When a new rail type is created, it is populated with the information from the first rail type, except that the compatible and powered list contain only the rail type being created. However, no default values should be assumed, as the first rail type may have been modified.

== Vehicle and Railtype availability ==

Vehicle and railtype availability and compatibility is influenced by multiple properties.
Generally, the vehicle defines which railtype it is, and the railtypes define the compatibility between each other.
* A vehicle exists, if its railtype (train prop 05) is defined. Otherwise the vehicle is disabled.
* When a vehicle is introduced, it always introduces its railtype (train prop 05).
* A railtype is introduced, if at least one of the following conditions is met:
** A vehicle is introduced, that references the railtype (train prop 05).
** Another railtype is introduced, that references the railtype via the introduced railtype list (railtype prop 19).
** The introduction date (railtype prop 17) is passed and all required railtypes (railtype prop 18) are available.

Via railtype property 1D multiple railtypes can be defined, which shall be considered equivalent to a railtype.
This affects the interpretation of train property 05. If train property 05 references an undefined railtype, then
railtype property 1D is checked for all defined railtypes, whether the vehicle can be reassigned to some other railtype.
Otherwise the vehicle is disabled.

== Rail type label (08) ==

These are globally unique four-letter identifiers for specific rail types (analoguous to [[Action0Cargos#Cargo label 17|cargo labels]]), used to make various rail types accessible from train vehicle grfs. Reserved labels for default rail types are:

{| class="wikitable
|-
!'''Label'''
!'''Rail Type'''
|-
|RAIL
| Normal Rail
|-
|ELRL
| Electrified Rail
|-
|MONO
| Mono Rail
|-
|MGLV
| Maglev Rail
|}

{{ottdp|1.0|no|ottdrev=r18969}} 16 railtypes can be defined.

{{ottdp|1.9|no|ottdrev=bf8d7df7}} 64 railtypes can be defined.

Rail type sets may use up to 64 railtypes and have to specify their own [[RailtypeLabels|labels]].

See also [[Action0/Global Settings#Rail type translation table 12|Rail Type Translation Table]] for further info.

== Build rail toolbar caption (09) ==

String ID of the name of the rail type as shown in the toolbar caption.

{{grfTill|7}} {{ottd|1.2|ottdrev=r23129}} For backwards compatibility, setting this property sets the rail type name (property 1B) to this string as well for GRF versions 7 or below.

OpenTTD before r20342 and 1.0.3 require the string to start with the white control code. Later versions of OpenTTD will automatically default to white.

== Rail construction dropdown text (0A) ==

String ID for text in the dropdown of all rail types.

This string must never start with a colour control code.

== Build vehicle window caption (0B) ==

String ID for build vehicle window caption.

OpenTTD before r20342 and 1.0.3 require the string to start with the white control code. Later versions of OpenTTD will automatically default to white.

== Autoreplace text (0C) ==

String ID for rail type shown in autoreplace window.

== New engines (0D) ==

StringID to use for showing texts of the type "We have invented a new <rail type> engine".

== Compatible rail type list (0E) ==

List of rail types on which trains of this rail type can run, even though they might not be powered. E.g. wagons/engines of "eletrified rail"-type are also compatible to "normal rail" and "third rail" type, but they are not powered (there need to be an other powered engine in the consist to move the train).

The format is:

<pre>0E <nvar> (<rail type label>){n}</pre>

That is you give the number of compatible rail types in a single byte followed by a list of that length of rail type labels. A rail type is automatically compatible (and powered) with itself, so you don't need to list the current rail type.

Note that these properties apply to trains of this rail type, not the track. If you want trains of other rail types to be able to run on your rail types, you must set the compatible rail types property for each rail type. Setting these properties behaves always incremental, so you only need to the set additional bits for each
other rail type, you cannot remove compatibility/poweredness once it is set (by some other grf).

Note that when routing trains, the compatibility is only evaluated for the lead engine of a consist. This means that trains will run on incompatible rail types if they are in a consist where the lead engine is compatible with the rail type. This applies to both engines and wagons.

== Powered rail type list (0F) ==

List of rail types on which trains of this rail type are powered. E.g. engines of "normal rail"-type are powered on "electrified rail"- and "third-rail"-type as well.

Same format as for property 0E above.

== Rail type flags (10) ==

Flags to define properties related to the rail type:

{| class="wikitable"
|-
!'''Bit'''
!'''Value'''
!'''Version'''
!'''Meaning'''
|-
|0
|1
||{{ottdp|1.0}}
|Draw catenary for this rail type
|-
|1
|2
||{{ottdp|1.1|no|ottdrev=r20049}}
|Disallow level crossings for this rail type
|-
|2
|4
||{{ottdp|1.9|no|ottdrev=e3b440c9c5}}
|Hide this rail type from construction menu
|-
|3
|8
||{{ottdp|1.10|no|ottdrev=g42046af933}}
|Enable use of precombined overlay sprites
|-
|4
|16
||{{ottdp|1.10|no|ottdrev=gcc5f175615}}
|Always allow 90 degree turns
|-
|5
|32
||{{ottdp|1.10|no|ottdrev=gcc5f175615}}
|Always prohibit 90 degree turns (takes precedence over bit 4)
|}

== Curve Speed advantage multiplier (11) ==

This property sets the multiplier to the curve speed advantage which all trains running on this track type get. The base curve speed advantage is given by the multiplication of the value of this property with the base speed advantage - which depends on the curve length in wagons:

{| class="wikitable"
|-
!'''Curve Length'''
!'''Base Speed Adv.'''
|-
|0 (90° turn)
|30
|-
|1 (2x45° turn)
|44
|-
|2
| 55
|-
|3
| 66
|-
|4
| 75
|-
|5
| 84
|-
|6
| 91
|-
|7
| 98
|-
|8
| 103
|-
|9
| 108
|-
|10
| 111
|-
|11
| 114
|-
|12+
| 115
|}

"Curve length" is the average number of wagons of the train between turns. However, very sharp turns (values 0 and 1) are not averaged out in longer trains.

The maximum speed for a train in a curve is defined by "base speed advantage" * (2 + "property 11"). Tilting trains get an additional bonus of 20% to this value.

For the default rail types this property is 0 for normal rail and electrified rail, 1 for monorail, and 2 for maglev.

== Station (and depot) graphics (12) ==

This property defines the default graphics for the stations. If no depot sprites are defined, this also defines at the same time the depot sprites to be used. There are three kind of default stations (and depots), usually associated with rail, monorail and maglev tracks. Valid values are:

{| class="wikitable"
|-
!'''Value'''
!'''Meaning'''
|-
|0
|Normal Rail
|-
|1
|Monorail
|-
|2
|Maglev
|}

== Speed limit (14) ==

Speed limit in mph*1.6 (approx. km/h). Set to "0" for no limit at all.

== Acceleration model (15) ==

This property defines the acceleration model used. Valid values range from 0 to 2:

{| class="wikitable"
|-
!'''Value'''
!'''Meaning'''
|-
|0
|Normal Rail
|-
|1
|Monorail
|-
|2
|Maglev
|}

There is currently no difference between normal rail and monorail.

== Map colour (16) ==

This property defines the colour this track type is drawn in the minimap view. The byte value specifies the colour entry in the [[PalettesAndCoordinates|DOS palette]].

== Introduction date (17) ==

This property defines the long date formatted introduction date of this rail type. With this property set the rail type will be introduced at (or after) this date when all of the introduction required rail types are available to the company of the player, or whenever a vehicle using this rail type gets introduced whichever is first.

== Introduction required rail type list (18) ==

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.

Same format as for property 0E above.

This can, for example, be used to introduce a third rail with catenary track type when both third rail and catenary rail types are available.

== Introduced rail type list (19) ==

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.

Same format as for property 0E above.

== Sort order (1A) ==

Property for influencing the sort order of the drop down lists with rail types. Default values are as follows:

{| class="wikitable"
|-
!'''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.

== Rail type name (1B) ==

String ID of the name of the rail type.

{{grfTill|7}} For GRF versions 7 or earlier, set property 1B ''after'' setting property 09, as property 09 sets the rail type name as well for backwards compatibility.

== Alternate rail type labels (1D) ==

A list of alternate labels that get "redirected" to this rail type when used e.g. as track type of train or when testing if a label is defined. The redirection only happens if the alternate label isn't defined as a real rail type. Same format as for property 0E above.

Alternate labels are not considered when evaluating properties 0E, 0F, 18, and 19.

= Example =

To be written

Action0/Railtypes

2025-02-17T14:56:08Z

Peter1138: /* Properties */

'''''Action 0 properties for rail types'''''

= Action 0 - Properties for rail types =

Defining properties of rail types.

{{ottdp|1.0|no|ottdrev=r18969}} 16 railtypes can be defined.

{{ottdp|1.9|no|ottdrev=bf8d7df7}} 64 railtypes can be defined.

== Properties ==

{| class="wikitable"
|-
!'''Number'''
!'''Version'''
!'''Size'''
!'''Description'''
|-
|08
|{{ottdp|1.0}}
|4*B
|Rail type label
|-
|09
|{{ottdp|1.0}}
|W
|StringID: Build rail toolbar caption<ref>{{grfTill|7}} For GRF version 7 or earlier, setting property 09 sets property 1B as well.</ref>
|-
|0A
|{{ottdp|1.0}}
|W
|StringID: Rail construction dropdown text
|-
|0B
|{{ottdp|1.0}}
|W
|StringID: Build vehicle window caption
|-
|0C
|{{ottdp|1.0}}
|W
|StringID: Autoreplace text
|-
|0D
|{{ottdp|1.0}}
|W
|StringID: New engine text
|-
|0E
|{{ottdp|1.0}}
|B n*D
|Compatible rail type list<ref name="alt_label">Rail type labels in this list are ''not'' resolved using the alternate label list.</ref>
|-
|0F
|{{ottdp|1.0}}
|B n*D
|Powered rail type list<ref name="alt_label" />
|-
|10
|{{ottdp|1.0}}
|B
|Rail type flags
|-
|11
|{{ottdp|1.0}}
|B
|Curve speed advantage multiplier
|-
|12
|{{ottdp|1.0}}
|B
|Station (and depot) graphics
|-
|13
|{{ottdp|1.0}}
|W <ref>In r18969 to 19306 this property was byte-sized.</ref>
|Construction costs
|-
|14
|{{ottdp|1.0}}
|W
|Speed limit
|-
|15
|{{ottdp|1.0}}
|B
|Acceleration model
|-
|16
|{{ottdp|1.0|no|ottdrev=r19307}}
|B
|Minimap colour
|-
|17
|{{ottdp|1.1|no|ottdrev=r21842}}
|D
|Introduction date
|-
|18
|{{ottdp|1.1|no|ottdrev=r21842}}
|B n*D
|Introduction required rail type list<ref name="alt_label" />
|-
|19
|{{ottdp|1.1|no|ottdrev=r21841}}
|B n*D
|Introduced rail type list<ref name="alt_label" />
|-
|1A
|{{ottdp|1.1|no|ottdrev=r21866}}
|B
|Sort order
|-
|1B
|{{ottdp|1.2|no|ottdrev=r23129}}
|W
|StringID: Rail type name<ref>{{grfTill|7}} For GRF version 7 or earlier, set property 1B ''after'' setting property 09, as property 09 sets the rail type name as well for backwards compatibility.</ref>
|-
|1C
|{{ottdp|1.2|no|ottdrev=r23415}}
|W
|Infrastructure maintenance cost factor
|-
|1D
|{{ottdp|1.2|no|ottdrev=r23758}}
|B n*D
|Alternate rail type labels that shall be "redirected" to this rail type
|-
|1E||W n*W||{{ottdp|15}}||List of badges
|}

<references />

In NFO, rail type IDs will be GRF local, with an ID to label mapping. Therefore to modify an existing rail type, specify its label in property 08. To create a new rail type, again just specify its label in property 08. This way there is no need for complex GRM mechanisms to allocate IDs. If a label 'clashes' with another GRF, then one GRF will end up modifying the properties instead of creating a new rail type.

When a new rail type is created, it is populated with the information from the first rail type, except that the compatible and powered list contain only the rail type being created. However, no default values should be assumed, as the first rail type may have been modified.

== Vehicle and Railtype availability ==

Vehicle and railtype availability and compatibility is influenced by multiple properties.
Generally, the vehicle defines which railtype it is, and the railtypes define the compatibility between each other.
* A vehicle exists, if its railtype (train prop 05) is defined. Otherwise the vehicle is disabled.
* When a vehicle is introduced, it always introduces its railtype (train prop 05).
* A railtype is introduced, if at least one of the following conditions is met:
** A vehicle is introduced, that references the railtype (train prop 05).
** Another railtype is introduced, that references the railtype via the introduced railtype list (railtype prop 19).
** The introduction date (railtype prop 17) is passed and all required railtypes (railtype prop 18) are available.

Via railtype property 1D multiple railtypes can be defined, which shall be considered equivalent to a railtype.
This affects the interpretation of train property 05. If train property 05 references an undefined railtype, then
railtype property 1D is checked for all defined railtypes, whether the vehicle can be reassigned to some other railtype.
Otherwise the vehicle is disabled.

== Rail type label (08) ==

These are globally unique four-letter identifiers for specific rail types (analoguous to [[Action0Cargos#Cargo label 17|cargo labels]]), used to make various rail types accessible from train vehicle grfs. Reserved labels for default rail types are:

{| class="wikitable
|-
!'''Label'''
!'''Rail Type'''
|-
|RAIL
| Normal Rail
|-
|ELRL
| Electrified Rail
|-
|MONO
| Mono Rail
|-
|MGLV
| Maglev Rail
|}

{{ottdp|1.0|no|ottdrev=r18969}} 16 railtypes can be defined.

{{ottdp|1.9|no|ottdrev=bf8d7df7}} 64 railtypes can be defined.

Rail type sets may use up to 64 railtypes and have to specify their own [[RailtypeLabels|labels]].

See also [[Action0/Global Settings#Rail type translation table 12|Rail Type Translation Table]] for further info.

== Build rail toolbar caption (09) ==

String ID of the name of the rail type as shown in the toolbar caption.

{{grfTill|7}} {{ottd|1.2|ottdrev=r23129}} For backwards compatibility, setting this property sets the rail type name (property 1B) to this string as well for GRF versions 7 or below.

OpenTTD before r20342 and 1.0.3 require the string to start with the white control code. Later versions of OpenTTD will automatically default to white.

== Rail construction dropdown text (0A) ==

String ID for text in the dropdown of all rail types.

This string must never start with a colour control code.

== Build vehicle window caption (0B) ==

String ID for build vehicle window caption.

OpenTTD before r20342 and 1.0.3 require the string to start with the white control code. Later versions of OpenTTD will automatically default to white.

== Autoreplace text (0C) ==

String ID for rail type shown in autoreplace window.

== New engines (0D) ==

StringID to use for showing texts of the type "We have invented a new <rail type> engine".

== Compatible rail type list (0E) ==

List of rail types on which trains of this rail type can run, even though they might not be powered. E.g. wagons/engines of "eletrified rail"-type are also compatible to "normal rail" and "third rail" type, but they are not powered (there need to be an other powered engine in the consist to move the train).

The format is:

<pre>0E <nvar> (<rail type label>){n}</pre>

That is you give the number of compatible rail types in a single byte followed by a list of that length of rail type labels. A rail type is automatically compatible (and powered) with itself, so you don't need to list the current rail type.

Note that these properties apply to trains of this rail type, not the track. If you want trains of other rail types to be able to run on your rail types, you must set the compatible rail types property for each rail type. Setting these properties behaves always incremental, so you only need to the set additional bits for each
other rail type, you cannot remove compatibility/poweredness once it is set (by some other grf).

Note that when routing trains, the compatibility is only evaluated for the lead engine of a consist. This means that trains will run on incompatible rail types if they are in a consist where the lead engine is compatible with the rail type. This applies to both engines and wagons.

== Powered rail type list (0F) ==

List of rail types on which trains of this rail type are powered. E.g. engines of "normal rail"-type are powered on "electrified rail"- and "third-rail"-type as well.

Same format as for property 0E above.

== Rail type flags (10) ==

Flags to define properties related to the rail type:

{| class="wikitable"
|-
!'''Bit'''
!'''Value'''
!'''Version'''
!'''Meaning'''
|-
|0
|1
||{{ottdp|1.0}}
|Draw catenary for this rail type
|-
|1
|2
||{{ottdp|1.1|no|ottdrev=r20049}}
|Disallow level crossings for this rail type
|-
|2
|4
||{{ottdp|1.9|no|ottdrev=e3b440c9c5}}
|Hide this rail type from construction menu
|-
|3
|8
||{{ottdp|1.10|no|ottdrev=g42046af933}}
|Enable use of precombined overlay sprites
|-
|4
|16
||{{ottdp|1.10|no|ottdrev=gcc5f175615}}
|Always allow 90 degree turns
|-
|5
|32
||{{ottdp|1.10|no|ottdrev=gcc5f175615}}
|Always prohibit 90 degree turns (takes precedence over bit 4)
|}

== Curve Speed advantage multiplier (11) ==

This property sets the multiplier to the curve speed advantage which all trains running on this track type get. The base curve speed advantage is given by the multiplication of the value of this property with the base speed advantage - which depends on the curve length in wagons:

{| class="wikitable"
|-
!'''Curve Length'''
!'''Base Speed Adv.'''
|-
|0 (90° turn)
|30
|-
|1 (2x45° turn)
|44
|-
|2
| 55
|-
|3
| 66
|-
|4
| 75
|-
|5
| 84
|-
|6
| 91
|-
|7
| 98
|-
|8
| 103
|-
|9
| 108
|-
|10
| 111
|-
|11
| 114
|-
|12+
| 115
|}

"Curve length" is the average number of wagons of the train between turns. However, very sharp turns (values 0 and 1) are not averaged out in longer trains.

The maximum speed for a train in a curve is defined by "base speed advantage" * (2 + "property 11"). Tilting trains get an additional bonus of 20% to this value.

For the default rail types this property is 0 for normal rail and electrified rail, 1 for monorail, and 2 for maglev.

== Station (and depot) graphics (12) ==

This property defines the default graphics for the stations. If no depot sprites are defined, this also defines at the same time the depot sprites to be used. There are three kind of default stations (and depots), usually associated with rail, monorail and maglev tracks. Valid values are:

{| class="wikitable"
|-
!'''Value'''
!'''Meaning'''
|-
|0
|Normal Rail
|-
|1
|Monorail
|-
|2
|Maglev
|}

== Speed limit (14) ==

Speed limit in mph*1.6 (approx. km/h). Set to "0" for no limit at all.

== Acceleration model (15) ==

This property defines the acceleration model used. Valid values range from 0 to 2:

{| class="wikitable"
|-
!'''Value'''
!'''Meaning'''
|-
|0
|Normal Rail
|-
|1
|Monorail
|-
|2
|Maglev
|}

There is currently no difference between normal rail and monorail.

== Map colour (16) ==

This property defines the colour this track type is drawn in the minimap view. The byte value specifies the colour entry in the [[PalettesAndCoordinates|DOS palette]].

== Introduction date (17) ==

This property defines the long date formatted introduction date of this rail type. With this property set the rail type will be introduced at (or after) this date when all of the introduction required rail types are available to the company of the player, or whenever a vehicle using this rail type gets introduced whichever is first.

== Introduction required rail type list (18) ==

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.

Same format as for property 0E above.

This can, for example, be used to introduce a third rail with catenary track type when both third rail and catenary rail types are available.

== Introduced rail type list (19) ==

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.

Same format as for property 0E above.

== Sort order (1A) ==

Property for influencing the sort order of the drop down lists with rail types. Default values are as follows:

{| class="wikitable"
|-
!'''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.

== Rail type name (1B) ==

String ID of the name of the rail type.

{{grfTill|7}} For GRF versions 7 or earlier, set property 1B ''after'' setting property 09, as property 09 sets the rail type name as well for backwards compatibility.

== Alternate rail type labels (1D) ==

A list of alternate labels that get "redirected" to this rail type when used e.g. as track type of train or when testing if a label is defined. The redirection only happens if the alternate label isn't defined as a real rail type. Same format as for property 0E above.

Alternate labels are not considered when evaluating properties 0E, 0F, 18, and 19.

= Example =

To be written

Action0/Objects

2025-02-17T14:55:49Z

Peter1138: /* Properties */

==Introduction==
Defining properties of new objects.

Unlike vehicles or new stations, most new objects have no real equivalent in TTD.

The IDs are therefore free to be chosen and will in fact be allocated automatically by the patch. In action 0, you only specify IDs relative to the set, i.e. the ID of the first object type is 00, the second object type is 01 and so on.

OpenTTD supports 64000 object types per game, and 255 object IDs per grf file.

{{ottdp|14.0|no}} 64000 object IDs per grf file are supported since OpenTTD 14.0.

The property you '''must''' set for each object ID is 08 (in addition to defining an action 3 for it). Also, all object IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==
{|
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Class label, see below
|-
|09||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Text ID for class
|-
|0A||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Text ID for this object
|-
|0B||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||[[Action0General#Climate availability|Climate availability]]
|-
|0C||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Byte representing size, see below
|-
|0D||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object build cost factor (sets object removal cost factor as well)
|-
|0E||D||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Introduction date, see below
|-
|0F||D||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||End of life date, see below
|-
|10||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object flags, see below
|-
|11||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Animation information
|-
|12||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Animation speed
|-
|13||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Animation triggers
|-
|14||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object removal cost factor (set after object build cost factor)
|-
|15||W||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Callback flags, see below
|-
|16||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Height of the building
|-
|17||B||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Number of object views
|-
|18||B||{{ottdp|1.4|no|ottdrev=r25879}}||Measure for number of objects placed upon map creation
|-
|19||W n*W||{{ottdp|15}}||List of badges
|}

Check [http://pics.lakie.net/newObject-ActionStructure.png Lakie's Graphical Representation of the newObject Specifications]

== Descriptions ==

=== Object class (08) ===

Class labels are unique identifiers composed of the letters A-Z and/or the numbers 0-9,  analoguous to [[Action0Stations#Station class (08)|station class labels]].

Their main use is to combine objects into classes and make them available by the top dropdown list in the object construction window.

Unlike for stations, there is no default class for objects. Set authors have to specify their [[ObjectLabels|own labels]], although it is strongly recommended to follow a general scheme to try to avoid confusion.

Class IDs must be set before any other property.

=== Object class text ID (09) ===

The text ID for this class (word value). This textid should be either a TTD textid or a D4xx textid (set via D0xx in action4).

When specifying an object, you don't need to set a class name again if you already did for another one with the same class.

=== Object text ID (0A) ===

The text ID for the object for query and selection (word value). Same requirements as for property09.

=== Object size (0C) ===

The object size up to 15x15 tiles.

This byte value is divided into two nibbles. The first defines the size in y direction and the second defines the size in x (i.e., stored as YX).

Note that any value lower than 0x11 will be rejected.

=== Build Cost (0D) ===

The build cost multiplier. This is multiplied by the number of tiles for evaluation of construction and removal costs of an object.

=== Introduction date (0E) ===

Introduction date of an object, in days since the year 0. This takes account of leap years; divisible by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). In TTDPatch anything before 1920 is considered to be always available, and it should allow for objects to work past 2044, the date is also the very first date you can build the object.

=== End of life date (0F) ===

Last year an object can be build, in days since the year 0. Same requirements as above. Also note that it must be a minimum of a year (365 days) after the introduction date or TTDPatch will ignore it.

=== Object flags (10) ===

The following flags control object behaviour and are cached for built objects, so changing these flags will have no effect on already constructed objects.

{|
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Only Available in the scenario editor<ref name="incompatible">Note that bits 0 and 7 are incompatible and setting both will make an object completely unavailable.</ref>
|-
|1||2||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Irremovable<ref>Object cannot be removed through normal dynamite, control must be held and the removal cost will be multiplied by 25 (this is the usual behaviour for most class A objects in TTDPatch).</ref>
|-
|2||4||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Anything Can Remove (owned land behaviour)
|-
|3||8||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Allow construction of the object on water
|-
|4||16||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Removal cost is actually income (owned land behaviour)
|-
|5||32||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Do not display foundations if on a slope
|-
|6||64||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Object has animation<ref>Setting this flag will allow the object's animation counter to be increased, must be set if you plan to make use of animations. Like stations you must enable animation on a per tile basis by means of the "built tile" trigger and callback 159.</ref>
|-
|7||128||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Only available during game play<ref name="incompatible" />
|-
|8||256||{{ottdp|1.1|2.6|ottdrev=r20670|ttdprev=r2340}}||Allows 2cc mapping for objects instead of the default 1cc
|-
|9||512||{{ottdp|1.1|2.6|ttdprev=r2331}}||Disallows construction on land (also has bit 3 behaviour)
|-
|10||1024||{{ottdp|1.1|2.6|ttdprev=r2331}}||Draws the water under the object<ref>Only applies when built on top of a water tile, also replaces the ground tile of the object completely. (Does not work when object built on sloped water tiles).</ref>
|-
|11||2048||{{ottdp|1.1|no|ottdrev=r21455}}||Allow bridge over the object taking the building height into account
|-
|12||4096||{{ottdp|1.1|2.6|ottdrev=r21455|ttdprev=r2360}}||Random bits in the "next animation frame" callback
|-
|13||8192||{{ottdp|1.4|no|ottdrev=r25878}}||Scale amount of objects placed on map generation not by map area, but roughly by the length of the coastline
|}

<references />

=== Animation information (11) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this object (this is the default value).

Since you can't have properties for individual object tiles, this property applies for every tile of the object. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 159]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 158]] for that.

=== Animation speed (12) ===

The meaning is the same as for [[Action0Houses#Animation Speed (1B)|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 0.

=== Animation triggers (13) ===

This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 159]], allowing to change the animation state

{|
!Bit!!Value!!Meaning!!Happens on!!Var 18
|-
|0||1||Object is built||all tiles||
|-
|1||2||Periodic tile loop||single tile||
|-
|2||4||Synchronised periodic tile loop||all tiles||
|}
Currently no trigger provides additional information in var 18.

The synchronised periodic tile loop is called directly after the (unsynchronised) periodic tile loop of the northern tile.

=== Object removal cost factor (14) ===

Cost factor for the removal of an object. This must be set after property 0D (object build cost factor) as that overwrites this value.

=== Callback flags (15) ===

For objects, the following [[callbacks]] can be defined by setting the corresponding bit in property 15:

{|
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||157||Custom slope check
|-
|1||2||158||Decide next animation frame
|-
|2||4||15A||Decide animation speed
|-
|3||8||15B||Decide colour of building
|-
|4||16||15C||Show additional text in the build object window
|-
|5||32||15D||Allow/disallow autosloping
|}

=== Building height (16) ===

Set the height of the building in heightlevels (8 pixels). For example if the structure is 16 pixels high you set this property to 2.

{{ottdp|1.1|no|ottdrev=r21455}} In OpenTTD this property is used to determine the height of the build object window; the height for the object preview is set to 32 + "value of property 16" * 8. The property is also uses to determine how high a bridge must be if it is allowed by the bit in property 10.

=== Number of views (17) ===

Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1.

For non-square objects, x and y sizes are swapped for odd views. I.e., giving an object size of 1*2 (x = 1, y = 2), it will be displayed as 1*2 for num = <nowiki>[</nowiki>0,2] (x-direction) but as 2*1 for num = <nowiki>[</nowiki>1,3] (y-direction).

Use object varaction2 var48 to access particular views of an object.
==Examples==

Action0/Airports

2025-02-17T14:55:32Z

Peter1138: /* Properties */

== Introduction ==

Airports work similarly to industries and town buildings. The maximum number of possible airports is 128. All (even overridden) original types count towards this limit.

Defining airports follows the same schema as industries do: to start using an ID, you first need to define it by setting property 8 or 9 for it. If you try to reference an ID (either via action0 or via action3) that isn't defined, your request is ignored, but not reported as an error, either. This means that if you want to conditionally define an ID, all you need to do is skipping the action0 that sets property8/property9, and everything else gets skipped automatically.

==Properties==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|1.1|no|ottdrev=r19459}}||Airport type override
|-
|0A||V||{{ottdp|1.1|no|ottdrev=r20377}}||Set airport layout(s)
|-
|0C||2*W||{{ottdp|1.1|no|ottdrev=r19459}}||Availability years
|-
|0D||B||{{ottdp|1.1|no|ottdrev=r19459}}||Best compatible TTD airport type
|-
|0E||B||{{ottdp|1.1|no|ottdrev=r19459}}||Catchment area
|-
|0F||B||{{ottdp|1.1|no|ottdrev=r19459}}||Noise level
|-
|10||W||{{ottdp|1.1|no|ottdrev=r19459}}||TextID to be used as airport name
|-
|11||W||{{ottdp|1.2|no|ottdrev=r23415}}||Infrastructure maintenance cost factor
|-
|12||W n*W||{{ottdp|15}}||List of badges
|}

==Descriptions==

===Airport type override (08)===

Works as both substitute type and override. The assignment of this property copies all properties of the old type to this new type. List of valid types: [[AirportTypes]]

There's a special use of this property: if you set it to FFh, you can disable an original airport. In this case, the ID used must be the number of airport you want to disable. Disable requests are ignored for airports that have already been overridden.

===Set airportlayout(s) (0A)===

Format of airport layout tables:

{| |-
!Size!!Variable!!Meaning
|-
|B||numlayouts||The total number of layouts following
|-
|D||size||The size in bytes of the whole definition, excluding numlayouts and size
|-
|V||layouts||numlayout layouts, see format below
|}

Format of an airport layout:

{| |-
!Size!!Variable!!Meaning
|-
|B||xoffs
|-
|B||yoffs||Offsets counted from the northernmost tile of the airport, specifying the position of the current tile. Both are taken as signed integers, but cannot go negative except the special case mentioned below.
|-
|B||oldtile||An old tile type to be put on the given tile
|-
|||--or--||
|-
|0xFE,W||newtile||The ID of an already defined airport tile, padded with 0 to create a word value. This tile type will be placed on the given tile.
|-
|||--or--||
|-
|0xFF|| ||The given tile is checked for clearance, but nothing will be placed on it. Useful to ensure some free space around your airport. This is the only case where xoffs and yoffs can be negative. If xoffs is negative, yoffs must be one lower than the wanted value.
|}

The layout consists of a single byte giving the rotation of the layout (0: north, 2: east, 4: south, 6: west) followed by a list of the above tile definitions, terminated by two bytes: 0,80h

===Availability years (0C)===

First year and last year the airport is available. 0 and FFFF respectively are forever.

===Best compatible TTD airport type (0D)===

Used for compatibility with [[VariationalAction2/Vehicles#Aircraft_info_.2844.29| vehicle var 44]]. Valid values:

0: small airport

1: large airport

2: heliport

3: oilrig

== Example ==

Action0/Industries

2025-02-17T14:55:07Z

Peter1138: /* Properties */

==Introduction==

Industries work similarly to town buildings. The limit for the number of industry types is:
* {{ttdp|2.5}} TTDPatch: 37
* {{ottd|<1.6}} OpenTTD < 1.6: 64
* {{ottd|1.6}} OpenTTD ⩾ 1.6: 128 per NewGRF, 240 in total
The non-overridden original types count towards the (total) limit. Industries don't have a climate mask; you should simply not define an industry if it would be for the wrong climate.

Defining industries follows the same schema as houses do: to start using an ID, you first need to define it by setting property 8 for it. If you try to reference an ID (either via action0 or via action3) that isn't defined, your request is ignored, but not reported as an error, either. This means that if you want to conditionally define an ID, all you need to do is skipping the action0 that sets property8, and everything else gets skipped automatically.

== Properties ==
{| |-
!Property !![[GRFActionsDetailed|Size]] !!Version !! Description
|-
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Substitute industry type
|-
|09||B||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Industry type override
|-
|0A||V||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Set industry layout(s)
|-
|0B||B||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Industry production flags
|-
|0C||W||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Industry closure message
|-
|0D||W||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Production increase message
|-
|0E||W||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Production decrease message
|-
|0F||B||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Fund cost multiplier
|-
|10||W||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Production cargo types
|-
|11||D||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Acceptance cargo types
|-
|12,13||B||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Production multipliers
|-
|14||B||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Minimal amount of cargo distributed
|-
|15||V||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Random sound effects
|-
|16||3*B||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Conflicting industry types
|-
|17||B||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Probability in random game
|-
|18||B||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Probability during gameplay
|-
|19||B||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Map color
|-
|1A||D||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Special industry flags to define special behavior
|-
|1B||W||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||New industry text ID
|-
|1C,1D,1E||D||{{ottdp|0.6|2.5|ttdprev=alpha 45}}||Input cargo multipliers for the three input cargo types
|-
|1F||W||{{ottdp|0.6|2.5|ttdprev=alpha 49}}||Industry name
|-
|20||D||{{ottdp|0.6|2.5|ttdprev=alpha 49}}||Prospecting success chance
|-
|21,22||B||{{ottdp|0.6|2.5|ttdprev=alpha 49}}||Callback flags
|-
|23||D||{{ottdp|0.6|2.5|ttdprev=alpha 73}}||Destruction cost multiplier
|-
|24||W||{{ottdp|0.6|2.6|ttdprev=r1782}}||Default text for nearby station
|-
|25||V||{{ottdp|1.9|no|ottdrev=e66cec8f}}||Production cargo type list
|-
|26||V||{{ottdp|1.9|no|ottdrev=e66cec8f}}||Acceptance cargo type list
|-
|27||V||{{ottdp|1.9|no|ottdrev=e66cec8f}}||Production multiplier list
|-
|28||V||{{ottdp|1.9|no|ottdrev=e66cec8f}}||Input cargo multiplier list
|-
|29||W n*W||{{ottdp|15}}||List of badges
|}

== Description ==

=== Substitute industry type (08) ===

Substitute industry type. The first assignment of this property copies all properties of the old type to this new type. Unlike for houses, the substitute type won't replace this new type if the definition becomes unavailable. List of [[IndustryDefaultProps#Climate_independent_properties |valid industry types]]

There's a special use of this property beginning from alpha 70: if you set it to FFh, you can disable an original industry. In this case, the ID used must be the number of industry you want to disable. Disable requests are ignored for industries not present on the current climate and industries already overridden.

{{ottdp|1.1|ottdrev=r20108}} AIs can use the substitute type to make decisions about station graphics and vehicle choice via [[Callbacks#AI_construction.2Fpurchase_selection_.2818.29| callback 18]].

=== Industry type override (09) ===

Industry type override. The overridden industry type won't be built in new random games. If the GRF file becomes active after the game was started, industries of the overridden new type won't be replaced by the new type. List of [[IndustryDefaultProps#Climate_independent_properties |valid industry types]]

By overriding an old type, you're saying "my type is a substitute for that old type". When GRFs ask information about the old type you've overridden (via industry variable 67, for example), they will get information about your type instead. If you want to replace an old industry type with something completely different, use the "disable" function of property 08 (see above), then define the new industry type ''without'' using property 09. A rule of thumb: if your industry accepts or produces different cargoes than the original one, it should not override the original one.

For example, if you want to replace the old coal mine with something that changes its coal production more dynamically, use property 09 to override industry 00. This way, other industries that want to be far from coal mines will stay far from your industry type too. If, however, you want to replace the coal mine with a potash mine, do not use property 09. This will ensure that other industries don't consider your type as a coal mine.

Please note, however, that only one new industry can override an old type. If two new types want to override the same old type, the first one wins, and the second is added normally, ignoring its property 09.

=== Set industry layout(s) (0A) ===

Format of industry layout tables:

{| |-
!Size!!Variable!!Meaning
|-
|B||numlayouts||The total number of layouts following
|-
|D||size||The size of the whole definition, excluding numlayouts and size
|-
|V||layouts||numlayout layouts, see format below
|}

Format of an industry layout:

As a special case, if the first byte of a new industry layout is FEh, then only two bytes follow: the industry number and the layout number. The specified layout of the specified old industry type will be added to the layout list of the current industry. The following applies only if the first byte wasn't FEh

{| |-
!Size!!Variable!!Meaning
|-
|B||xoffs
|-
|B||yoffs||Offsets counted from the northernmost tile of the industry, specifying the position of the current tile. Both are taken as signed integers, but cannot go negative except the special case mentioned below.
|-
|B||oldtile||An old tile type to be put on the given tile
|-
|||--or--||
|-
|0xFE,W||newtile||The ID of an already defined industry tile, padded with 0 to create a word value. This tile type will be placed on the given tile.
|-
|||--or--||
|-
|0xFF|| ||The given tile is checked for clearance, but nothing will be placed on it. Useful to ensure some free space around your industry. This is the only case where xoffs and yoffs can be negative.

{{grfTill|7}} For GRF versions <= 7, if xoffs is negative, yoffs must be one lower than the wanted value.
|
|}

The layout consists of a list of the above tile definitions, terminated by two bytes: 0,80h

=== Industry production type (0B) ===

{| |-
!Value!!Meaning!!{{ottdp|0.6|no}} Effect on nearby stations!!Effect if [[Callbacks#Random_production_change_.2829.29|CB 29]] is disabled
|-
|00||consuming industry (e.g. power plant)||none||No production changes; no closure
|-
|01||extractive industry (e.g. coal mine)||suffix 'Mines' if some non-liquid, non-passenger, non-mail cargo is produced||Standard primary-industry production change
|-
|02||organic industry (e.g. forest)||suffix 'Forest' or 'Woods' if wood is produced||Standard primary-industry production change
|-
|04||processing industry (e.g. steel mill)||none||Standard processing-industry closing-behaviour
|}
Other values are reserved; do not set any other values.

=== Industry messages (0C..0E), new industry text ID (1B) ===

The text associated with these textID will be shown if the industry announces closedown, if the industry increases production, if the industry decreases production or when the industry is generated during the game.

For the generation message, by default, all industries have "New xxx is being constructed near yyy", except forests, that have "New Forest is being planted near yyy".

=== Production cargo types (10) ===

Two climate-dependent cargo numbers representing the cargo types the industry can produce. Unused slots can be filled with FFh. List of valid types: [[CargoTypes]]

{{ottdp|1.9|no|ottdrev=e66cec8f}} This property only supports two output cargos. Use property 25 instead to output more cargo types.

=== Acceptance cargo types (11) ===

Three climate-dependent cargo numbers representing the cargo types the industry can accept, plus a fourth filler byte which is always ignored. Unused slots can be filled with FFh. List of valid types: [[CargoTypes]]

These cargo types will only be really accepted if the according acceptance of the industry tiles adds up to 8/8 or more.

From GRF version 7 and above, the meaning of the above two properties will change: instead of climate-dependent cargo slot numbers, you have to give climate-independent cargo IDs. If your GRF has a cargo translation table, then this ID is the index in that table; otherwise, it's the cargo bit. Cargoes not currently present will be changed to FFh. Please note that TTD stops processing these lists at the first FFh value, so specifying absent cargoes isn't always safe.

{{ottdp|1.9|no|ottdrev=e66cec8f}} This property only supports three input cargos. Use property 26 instead to output more cargo types.

=== Production multipliers (12, 13) ===

If nonzero, the industry periodically (every 256 ticks, that is 8 or 9 times in a month) produces the given amount from the according cargo type. The properties specify the amount produced at default production level, they are scaled equally on [[Callbacks#Random production change 29|production changes]].

{{ottdp|1.9|no|ottdrev=e66cec8f}} This properties only supports two output cargos. Use property 27 instead to output more cargo types.

=== Minimal amount of cargo distributed (14) ===

The produced cargo will be distributed to stations only after it exceeds this amount.

=== Random sound effects (15) ===

The data starts with a byte defining the number of available effects, then one byte per effect. TTD periodically picks one of the available effects randomly, and plays it.

=== Conflicting industry types (16) ===

3 bytes define 3 types that won't appear in the vicinity of this industry. If a byte has bit 7 set, the bottom 6 bits are the ID of a new type already defined in the current GRF file. If bit 7 is clear, the bottom 6 bits specify an old industry type. FFh can be used to fill unused entries. You shouldn't modify property 9 after the type has been referenced by a property 16. List of [[IndustryDefaultProps#Climate_independent_properties |valid industry types]]

=== Probability in random game (17), Probability during gameplay (18) ===

Old types have probabilities between 0 and 10. If the random game probability value is nonzero, at least one instance of this type is guaranteed to appear on the map.

These probabilities are "relative probabilities". That is, if you set the probability of industry A to twice the probability of industry B, industry A will appear about twice as often as B. Increasing the probabilities of all industries on the other hand changes nothing. The appearance probabilities have no influence on how many industries are placed in total.

=== Map colour (19) ===

The value must be a color index from the DOS pallette. The following values are used by default industries:

{| |-
!Number!!Colour!!Example
|-
|01||Black||Coal mine
|-
|0A||Gray||Steel mill
|-
|0F||White||Bank
|-
|25||Dark beige||Water supply
|-
|27||Light beige||Rubber plantation
|-
|30||Pink||Farm
|-
|37||Brown||Food processing plant
|-
|56||Green||Forest
|-
|98||Blue||Oil wells/oil rig
|-
|AE||Purple||Factory
|-
|B8||Red||Power station
|-
|BF||Yellow||Oil refinery
|-
|C2||Orange||Saw mill
|-
|D0||Light green||Water tower
|}

=== Special industry flags to define special behavior (1A) ===

{| |-
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|0.6|2.5}}||The industry periodically plants fields around itself (temperate and arctic farms)
|-
|1||2||{{ottdp|0.6|2.5}}||The industry cuts trees around itself and produces its first output cargo from them (lumber mill)
|-
|2||4||{{ottdp|0.6|2.5}}||The industry is built on water (oil rig)
|-
|3||8||{{ottdp|0.6|2.5}}||The industry can only be built in towns (i.e. it has to replace houses) with population larger than 1200 (temperate bank)
|-
|4||10||{{ottdp|0.6|2.5}}||The industry can only be built in towns (i.e. it has to replace houses) (arctic and tropic banks, water tower)
|-
|5||20||{{ottdp|0.6|2.5}}||The industry is always built near towns (i.e. near town sign; additionally the industry is allowed to replace houses) (toy shop)
|-
|6||40||{{ottdp|0.6|2.5}}||Fields are planted around the industry when it's built (all farms)
|-
|7||80||{{ottdp|0.6|2.5}}||The industry cannot increase its production on the temperate climate (oil wells)
|-
|8||100||{{ottdp|0.6|2.5}}||The industry is built only before 1950 (oil wells)
|-
|9||200||{{ottdp|0.6|2.5}}||The industry is built only after 1960 (oil rig)
|-
|10||400||{{ottdp|0.6|2.5}}||AI players will attempt to establish air and ship routes going to this industry (oil rig)
|-
|11||800||{{ottdp|0.6|2.5}}||The industry can be exploded by a military airplane (oil refinery)
|-
|12||1000||{{ottdp|0.6|2.5}}||The industry can be exploded by a military helicopter (factory)
|-
|13||2000||{{ottdp|0.6|2.5}}||The industry can cause a subsidence (coal mine)
|-
|14||4000||{{ottdp|0.6|2.5}}||Automatic production multiplier handing (No industry has this bit set by default.)<ref>If bit 14 is set, variables 40..42 will be divided by industry.prodmultiplier (variable 93), and the resulting instructions will be multiplied by the same amount before applying them. If you set this bit, please use small amounts in your instructions, since industry.prodmultiplier is 16 for default production, and can get as high as 128.</ref>
|-
|15||8000||{{ottdp|0.6|2.5}}||The production callback needs random bits in var. 10 (No industry has this bit set by default.)
|-
|16||10000||{{ottdp|1.0|2.6|ttdprev=r1925}}||Do not force one instance of this type to appear during initial map generation (No industry has this bit set by default.)
|-
|17||20000||{{ottdp|0.6|2.6|ttdprev=r1925}}||Allow closing down the last instance of this type (No industry has this bit set by default.)
|-
|18||40000||{{ottdp|1.9|no|ottdrev=e66cec8f}}||New format for callback 37, 14B, 14C to support more input/output cargos. See the callbacks for details.
|-
|19||80000||{{ottdp|1.11|no|ottdrev=b3d048dfc}}||By default OpenTTD's smooth economy clamps the production of passenger (like for oil rigs). This flag disables the clamping.
|}

<references />

By default, TTDPatch tries to ensure that cargo chains don't get broken. To achieve this, TTDPatch always generates at least one instance from every available industry type during random map generation, and prevents the last instance from closing down even when the production change callback says it should. If your industry type isn't essential for gameplay, or you want to handle this situation yourself, you can set bits 16 and/or 17 to turn off the default TTDPatch behavior.

If you supply a lot of industry types but also want to support OpenTTD's small map sizes you should set bit 16 for the less important industry types which can be ommitted (there will likely not be enough space for an industry of every type).

=== Input cargo multipliers for the three input cargo types (1C..1E) ===

If the first (low) word of the property is M1 and the second (high) word is M2, and X units of the corresponding cargo is delivered to the industry, the output amounts are calculated this way:

<pre>output_type1 = X*M1/256

output_type2 = X*M2/256</pre>

The default value for old industry types is 0100h,0000h , so every unit of input cargo produces one unit of output cargo of the first type. Exceptions are temperate banks and oil rigs, that have the default value of 0000h,0000h ,so input cargo doesn't affect output.

{{ottdp|1.9|no|ottdrev=e66cec8f}} This property only supports three input and two output cargos. Use property 28 instead, if you have more cargo types.

=== Industry name (1F) ===

This is the text ID that will be attached to the town name when TTD texts refer to the industry.

=== Prospecting success chance (20) ===

This value is currently used only for extractive and organic industries (see property 0B for details). The higher this value is, the higher the chance that your industry can be built on a random place after prospecting. 0 means constant failure, while FFFFFFFFh means constant success.

=== Callback flags (21,22) ===

Property 21 can have the following bits set:

{| |-
!Bit!!Value!!Var. 0C!!Version!!Callback
|-
|0||1||22||{{ottdp| |2.5}}||Determine whether the industry can be built
|-
|1||2||00||{{ottdp| |2.5}}||Call the [[Action2Industries|production callback]] when cargo arrives at the industry <ref name="smootheconomy">{{ottdp|0.6|no}} If none of the production change callbacks is activated, OpenTTD will use "smooth economy" if enabled. If any of the callbacks is enabled, "smooth economy" will be disabled for the industry.</ref>
|-
|2||4||00||{{ottdp| |2.5}}||Call the [[Action2Industries|production callback]] every 256 ticks <ref name="smootheconomy"/>
|-
|3||8||28||{{ottdp| |2.5}}||Determine whether the industry can be built on given spot
|-
|4||10||29||{{ottdp| |2.5}}||Control random production changes
|-
|5||20||35||{{ottdp| |2.5}}||Monthly random production change
|-
|6||40||37||{{ottdp| |2.5}}||Cargo sub-type display
|-
|7||80||38||{{ottdp| |2.5|ttdprev=2.0.1 alpha 72}}||Additional text in industry fund window
|}
<references/>

Property 22 can have the following bits set:

{| |-
!Bit!!Value!!Var. 0C!!Version!!Callback
|-
|0||1||3A||{{ottdp| |2.5|ttdprev=2.0.1 alpha 72}}||Show additional text in industry window
|-
|1||2||3B||{{ottdp| |2.5|ttdprev=2.0.1 alpha 73}}||Control special industry effects
|-
|2||4||3D||{{ottdp| |2.5|ttdprev=2.5 beta 4 }}||Opt out of accepting cargo
|-
|3||8||14A||{{ottdp| |2.6|ttdprev=r1712}}||Decide industry color
|-
|4||10||14B||{{ottdp| |2.6|ttdprev=r1718}}||Decide input cargo types
|-
|5||20||14C||{{ottdp| |2.6|ttdprev=r1718}}||Decide output cargo types
|-
|6||40||15F||{{ottdp|1.3|no|ottdrev=r24186}}||Set initial production level on construction.
|}

=== Destruction cost multiplier (23) ===

This value specifies the cost of removing the industry when the ctrl-dynamite function of morebuildoptions.removeindustry is enabled. This value is multiplied by the house removal cost multiplier to get the final cost. The default value is 1000 in TTDPatch, and 0 (zero) in OpenTTD.

=== Default name for nearby station (24) ===

If non-zero, this text ID specifies an additional name option for stations built near this industry, which will be used before any of the standard TTD names. The text should contain a \80, which will be the name of the nearby town.

If the newly built station cannot use the specified text (because that name has been used for another station in the same town) the default TTD naming system will be used, but without the names "\80 Oilfield" or "\80 Mines".

Setting this to zero disables "\80 Oilfield" and "\80 Mines" without adding any additional station name options.

=== Production cargo type list (25) ===
{{ottdp|1.9|no|ottdrev=e66cec8f}}

Format:
<numoutput> (<cargotype>)*

{| |-
!Size!!Variable!!Meaning
|-
|B||numoutput||Number of <cargotype> to follow,
|-
|B||cargotype||Cargotype (from CTT) to produce.
|}

This property defines up to 16 cargotypes, which are produced by the industry.
Use this property instead of property 10.

=== Acceptance cargo type list (26) ===
{{ottdp|1.9|no|ottdrev=e66cec8f}}

Format:
<numinput> (<cargotype>)*

{| |-
!Size!!Variable!!Meaning
|-
|B||numinput||Number of <cargotype> to follow,
|-
|B||cargotype||Cargotype (from CTT) to accept.
|}

This property defines up to 16 cargotypes, which are accepted by the industry.
Use this property instead of property 11.

=== Production multiplier list (27) ===
{{ottdp|1.9|no|ottdrev=e66cec8f}}

Format:
<numoutput> (<amount>)*

{| |-
!Size!!Variable!!Meaning
|-
|B||numinput||Number of <amount> to follow,
|-
|B||amount||Amount of cargo to produce.
|}

If nonzero, the industry periodically (every 256 ticks, that is 8 or 9 times in a month) produces the given amount from the according cargo type.
The amounts correlate to the cargotypes set by property 25. If fewer/more amounts are set, the extra items are not produced/ignored.

The properties specify the amount produced at default production level, they are scaled equally on [[Callbacks#Random production change 29|production changes]].

Use this property instead of property 12 and 13.

=== Input cargo multiplier list (28) ===
{{ottdp|1.9|no|ottdrev=e66cec8f}}

Format:
<numinput> <numoutput> (<multiplier>)*

{| |-
!Size!!Variable!!Meaning
|-
|B||numinput||Number of input cargos to use.
|-
|B||numoutput||Number of output cargos to use.
|-
|W||multiplier||Cargo multipliers in 1/256 units. <numinput>*<numoutput> items.
|}

This property defines a matrix which described how input cargos from property 26 are processed into output cargos from property 25.

Example:
03 04 // 3 input cargos, 4 output cargos
\wx0100 \wx0000 \wx0000 \wx0100 // input cargo 0 is converted to output cargos 0 and 3
\wx0000 \wx0100 \wx0000 \wx0100 // input cargo 1 is converted to output cargos 1 and 3
\wx0000 \wx0000 \wx0100 \wx0100 // input cargo 2 is converted to output cargos 2 and 3

The matrix correlates to the cargotypes set by property 25 and 26. If fewer/more cargotypes are used, the extra items are not produced/ignored.

Use this property instead of property 1C..1E.

Action0/Industry Tiles

2025-02-17T14:54:46Z

Peter1138: /* Properties */

==Introduction==

Industry tiles work similarly to town buildings, except that they are not stand-alone; they are always part of an industry.

Defining industry tiles follows the same schema as houses do: to start using an ID, you first need to define it by setting property 8 for it. If you try to reference an ID (either via action0 or via action3) that isn't defined, your request is ignored, but not reported as an error, either. This means that if you want to conditionally define an ID, all you need to do is skipping the action0 that sets property8, and everything else gets skipped automatically.

Industry tile IDs are unique within each grf file. The per-GRF ID is specified as a byte, which means no GRF can define more than 256 tile IDs. You should use your industry tile IDs sparingly. [[VariationalAction2/Industry_Tiles#Relative_position_.2843.29| Variational action 2 variable 43]] for industry tiles can help you limiting tile consumption to 2 or 3 per industry. Avoid using tile FFh, so the tileID can be turned into an extended byte (in Action 3) in the distant future without breaking your NewGRF.

{{ttdp|}} In total, TTDPatch can have up to a total of 256 new industry tile IDs (i.e. old tile types don't count).

{{ottd|}} OpenTTD can have 512 IDs for all active grf files, but that includes non-overridden original tiles.

== Properties ==

{| |-
!Property !![[GRFActionsDetailed|Size]] !!Version !! Description
|-
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 43}}||Substitute building type
|-
|09||B||{{ottdp|0.6|2.5|ttdprev=alpha 43}}||Industry tile override
|-
|0A,0B,0C||W||{{ottdp|0.6|2.5}}||Tile acceptance
|-
|0D||B||{{ottdp|0.6|2.5|ttdprev=alpha 49}}||Land shape flags
|-
|0E||B||{{ottdp|0.6|2.5|ttdprev=alpha 54}}||Callback flags
|-
|0F||W||{{ottdp|0.6|2.5|ttdprev=alpha 54}}||Animation information
|-
|10||B||{{ottdp|0.6|2.5|ttdprev=alpha 54}}||Animation speed.
|-
|11||B||{{ottdp|0.6|2.5|ttdprev=alpha 54}}||Triggers for callback 25
|-
|12||B||{{ottdp|0.6|2.5|ttdprev=beta 2}}||Special flags
|-
|13||V||{{ottdp|1.9|no|ottdrev=e66cec8f}}||Tile acceptance list
|-
|14||W n*W||{{ottdp|15}}||List of badges
|}

== Description ==

=== Substitute tile type (08) ===

This tile type will be used instead of your new one if your definition isn't available for any reason. Valid values are [http://marcin.ttdpatch.net/sv1codec/TTD-locations.html#Class8 00h-AEh]. Assigning this property copies the properties of the old type just like it does with houses.

If this tile's action 3 appears before this property is set, the action 3 will have no effect.

=== Industry tile override (09) ===

Works like the house override property for houses.

=== Tile acceptance (0A, 0B, 0C) ===

These three words define what cargoes the tile accepts, and how much of them. The low byte defines the type of the cargo according to the current climate, while the high byte defines the degree of acceptance in 1/8 units. If you don't need all three cargo types, just zero out the high byte of the extra properties.

{{grfFrom|7}} From GRF version 7 and above, the meaning of the low byte changes: instead of a climate-dependent cargo slot number, you have to give 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. Acceptance of cargoes not currently present will automatically be disabled.

{{ottdp|1.9|no|ottdrev=e66cec8f}} These properties only support three cargos. Use property 13 instead to list more cargo types.

=== Land shape flags (0D) ===

This property defines which slopes the tile can be built on.

{| |-
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|0.6|2.5}}||NW edge cannot be lowered
|-
|1||2||{{ottdp|0.6|2.5}}||NE edge cannot be lowered
|-
|2||4||{{ottdp|0.6|2.5}}||SW edge cannot be lowered
|-
|3||8||{{ottdp|0.6|2.5}}||SE edge cannot be lowered
|-
|4||10||{{ottdp|0.6|2.5}}||Can only be built on flat land
|-
|5||20||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||The tile is allowed on both land and water
|}

Industry tiles are never built on steep slopes unless [[Callbacks#Custom shape check (2F) |callback 2F]] is enabled, but bits 0..4 are ignored in that case.

Bit 5 can be used to allow tiles of land industries built on water or vice versa. It effectively disables the land/water check code for the tile. If you need to customize the behavior further, you can use [[Callbacks#Custom shape check (2F) |callback 2F]] to decide what kind of water/land is allowed.

;'''PLEASE NOTE''': Be careful when setting this property. If you fail to set it correctly, your industry may end up building on a hillside, which is probably not what you want. The easiest way is to set bit 4 for middle tiles, bit 0 for the tiles along the SE edge, bit 1 for those along the SW edge and so on.

=== Callback flags (0E) ===

{| |-
!Bit!!value!!version!!meaning
|-
|0||1||{{ottdp| | }}||use [[Callbacks#Next animation frame (1A/26/141/153/158) |callback 26]] to decide the next animation frame
|-
|1||2||{{ottdp| | }}||use [[Callbacks#Length of animation frame (20/27/142/154/15A) |callback 27]] to decide animation speed
|-
|2||4||{{ottdp| |2.5|ttdprev=alpha 55 vcs 3}}||use [[Callbacks#Decide cargo acceptance (2B) |callback 2B]] to decide amount of acceptance
|-
|3||8||{{ottdp| |2.5|ttdprev=alpha 55 vcs 3}}||use [[Callbacks#Get accepted cargo types (2A/2C) |callback 2C]] to decide accepted types
|-
|4||10||{{ottdp| | }}||use [[Callbacks#Custom shape check (2F) |callback 2F]] to check if a slope is suitable
|-
|5||20||{{ottdp| | }}||use [[Callbacks#Decide drawing default foundations (30/14E/150) |callback 30]] to decide if default foundations need to be drawn
|-
|6||40||{{ottdp| |2.5|ttdprev=beta 3}}||use [[Callbacks#Disable autosloping (3C/14F/15D) |callback 3C]] to allow or deny autosloping below the tile
|}

Please note that [[Callbacks#Animation control (1B/25/140/152/159) |callback 25]] doesn't have a bit here. To use [[Callbacks#Animation control (1B/25/140/152/159) |callback 25]], simply set the wanted bits in property 11 and it will work as intended.

=== Animation information (0F) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this tile (this is the default value).

=== Animation speed (10) ===

The meaning is the same as for house property 1B, but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.

=== Triggers for [[Callbacks#Animation control (1B/25/140/152/159) |callback 25]] (11) ===

Call [[Callbacks#Animation control (1B/25/140/152/159) |callback 25]] when:

{| |-
!Bit!!Value!!Version!!Meaning||Var 18
|-
|0||1||{{ottdp|0.6|2.5}}||the construction state changes||
|-
|1||2||{{ottdp|0.6|2.5}}||the tile is processed in the periodic processing loop||
|-
|2||4||{{ottdp|0.6|2.5}}||the industry of the tile is processed in the periodic processing loop (synchronized animation)||
|-
|3||8||{{ottdp|0.6|2.5}}||the industry of the tile receives input cargo from a station||
|-
|4||10||{{ottdp|0.6|2.5|ttdprev=beta 2}}||the industry distributes its output cargo to one of the stations nearby||
|}
Currently no trigger provides additional information in var 18.

=== Special flags (12) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||[[Callbacks#Next animation frame (1A/26/141/153/158) |Callback 26]] needs random bits
|-
|1||2||{{ottdp|1.9|no|ottdrev=e66cec8f}} In addition to the cargotypes set by property 0A..0C and 13, the tile accepts all cargotypes which the industry accepts.
* This considers industry properties 11 and 26 and callback 14B.
* This does not consider industry callback 3D.
* This property adds 8/8 acceptance for the matching cargotypes. You can list negative acceptances (-8/8) in property 13 to exclude specific cargos.
* Tile callback 2C overrides all acceptances including those added by this flag.
|}

=== Tile acceptance list (13) ===
{{ottdp|1.9|no|ottdrev=e66cec8f}}

Format:
<numinput> (<cargotype> <acceptance>)*

{| |-
!Size!!Variable!!Meaning
|-
|B||numinput||Number of (<cargotype> <acceptance>) pairs to follow,
|-
|B||cargotype||Cargotype (from CTT) to accept.
|-
|B||acceptance||Acceptance in 1/8 units. May be negative to negate property 12 bit 1.
|}

This property defines up to 16 cargotypes, which are accepted by the industry tile.
Use this property instead of property 0A..0C.

==Example==

Action0/Houses

2025-02-17T14:54:21Z

Peter1138: /* Properties */

== Introduction ==

For town buildings (or simply houses), the offset defines the first house ID for this action 0. House IDs, like station IDs, are unique within each grf file, and in total each game can only have 255 IDs in TTDPatch and 512 IDs in OpenTTD for all active grf files.

{{ottdp|15}} Since OpenTTD 15, the limits are increased to 4096 IDs, both per-grf and in total.

To start using a house ID, you must first define it by setting its property 08 (see below). If you try to modify a house ID whose property 08 isn't set, your request is ignored, but not reported as an error, either.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Substitute building type
|-
|09||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building flags
|-
|0A||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Availability years
|-
|0B||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Population
|-
|0C||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Mail generation multiplier
|-
|0D||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Passenger acceptance
|-
|0E||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Mail acceptance
|-
|0F||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Goods, food or fizzy drinks acceptance
|-
|10||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||LA rating decrease on removal (should be set to the same value for every tile for multi-tile buildings)
|-
|11||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Removal cost multiplier (should be set to the same value for every tile for multi-tile buildings)
|-
|12||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building name ID
|-
|13||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building availability mask
|-
|14||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||House callback flags
|-
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||House override byte
|-
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Periodic refresh multiplier
|-
|17||4*B||{{ottdp|0.6|2.5|ttdprev=alpha 35}}||Four random colours to use
|-
|18||B||{{ottdp|0.6|2.5|ttdprev=alpha 35}}||Relative probability of appearing
|-
|19||B||{{ottdp|0.6|2.5|ttdprev=alpha 38}}||Extra flags
|-
|1A||B||{{ottdp|0.6|2.5|ttdprev=alpha 39}}||Animation frames
|-
|1B||B||{{ottdp|0.6|2.5|ttdprev=alpha 39}}||Animation speed
|-
|1C||B||{{ottdp|0.6|2.5|ttdprev=alpha 43}}||Class of the building type
|-
|1D||B||{{ottdp|0.6|2.5|ttdprev=alpha 55 vcs 2}}||Callback flags 2
|-
|1E||D||{{ottdp|0.6|2.5|ttdprev=alpha 55 vcs 2}}||Accepted cargo types
|-
|1F||B||{{ottdp|0.6|2.6|ttdprev=r1554}}||Minimum life span in years
|-
|20||V||{{ottdp|1.2|2.6|ottdrev=r23072|ttdprev=r1677}}||Cargo acceptance watch list
|-
|21||W||{{ottdp|0.7|no|ottdrev=r13437}}||Long year (zero based) of minimum appearance
|-
|22||W||{{ottdp|0.7|no|ottdrev=r13437}}||Long year (zero based) of maximum appearance
|-
|23||V||{{ottdp|1.9|no|ottdrev=48b334cf}}||Tile acceptance list
|-
|24||W n*W||{{ottdp|15}}||List of badges
|}

When a town decides to expand, each active house type (both old and new ones) has a uniform probability to appear, so the more new houses you define, the fewer old TTD buildings will appear.

== Descriptions ==

=== Substitute building type (08) ===

This building type will be used instead of your new one if your definition isn't available for any reason (the grf file is not found, for example).

Don't set a substitute building type that is larger than your new one (for example, don't set 14 (stadium) for an 1x1 building) because this may corrupt savegames. Setting this property automatically copies every property of the substitute building to your new building, so you don't have to change properties that are the same as the substitute.

House flags 40 and 80 are exceptions; these flags are never set automatically. Only the first property 08 setting copies properties; if you later change it, properties will stay.

There's a special use of this property beginning from alpha 72: if you set it to FFh, you can disable an old house type. In this case, the ID used must be the number of old house type you want to disable. Disabling only prevents building the type in towns; houses already present on the map will stay unchanged. The type can still be overridden, and overriding affects houses present on the map.

If this house's action 3 appears before this property is set, the action 3 will have no effect.

=== Building flags (09) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||This is a 1x1 building
|-
|1||2||This building can be built only on flat land (if clear, foundations are automatically displayed on sloped land)
|-
|2||4||This is a 2x1 building<ref name="large">If your building isn't 1x1, set flags for the north tile, then define the next 1 or 3 tiles tiles (by setting their property 8). The only bit that can be set in the flags of additional tiles is bit 5 (animation). There should be no property 8 setting between the first tile and the additional tiles.</ref>
|-
|3||8||This is a 1x2 building<ref name="large" />
|-
|4||10||This is a 2x2 building<ref name="large" /><ref>For 2x2 buildings, the first additional tile is the east one, the second is the west part and the third is the south part. You probably want to set the substitute for additional tiles to a TTD additional tile whose flags are already zero. 2x2 buildings are always built on flat land no matter how bit 1 is set.</ref>
|-
|5||20||Animation flag, set in tiles 04 and 05 (large office block). New buildings have a different animation scheme than large office blocks, but animation is still enabled with this bit.<ref>The animation flag works on a per-tile basis, so you should enable it for additional tiles of multi-tile buildings as well if you want all tiles to be animated.</ref>
|-
|6||40||This building is a church<ref name="only1">Only one church and one stadium can exist in a town. The town won't build buildings with the according flag set until the old church/stadium is removed. (This can be done by either the town or a player)</ref>
|-
|7||80||This building is a stadium<ref name="only1" />
|}

<references />

=== Availability years (0A) ===

The low byte is the minimum year, the high is the maximum. The building can only be built between these two years (inclusive). 1920 is added to both bytes before using the values.

{{ottdp|no| }}
Since the year counting stops in TTDPatch in 2070 even with [[ttwiki:EternalGame|EternalGame]] on, start years above 150 mean "never", and end years above 150 mean "forever". In OpenTTD there is no limit for the maximum year (resp. it is 5000000).

'''WARNING:''' Don't set the start year below 1930 (0Ah) unless you know what you're doing!

{{ttdp|}} If TTDPatch finds a building that is available before 1930, it will not build old building types until that year, so you have to provide at least one custom building type that is available before 1930 for every [[TownZones|town zone]], or TTD may deadlock while trying to create a random game or expand a town.

{{ottd|}} The availability of all active houses with the lowest availability year is set to start from year 0, so that always at least one house is available irrespective of starting year. Thus, if you de-activate default houses or set an introduction date prior to the default houses introduction year 1930, you should have at least for each [[TownZones|town zone]] a house with the same earliest availability year or you might end up with a situation where no house can be placed in a [[TownZones|town zone]].

=== Population (0B) and Mail generation multiplier (0C) ===
[[Image:House_production.png|frame|right|Actual house production roughly depends on squared value of the population / mail generation multiplier.]]

The population of the town will be increased by the amount set in prop. 0B if this building is built. Additional house parts should have a population of zero. The higher this value is, the more passengers this building generates.

The higher the mail generation multiplier is, the more mail the building generates. For multi-tile buildings, mail generation is done in per-tile basis, so you can specify different values for every tile, although distributing the generation equally between tiles is suggested.

This is how exactly passengers are generated: In each periodic processing (i.e. every 256 ticks), a random value 0<=X<=255 is generated for each house tile. If X isn't smaller than the population of the tile, no passengers are generated. Otherwise, X/8+1 passengers are generated (rounded down). If there is a recession going on, the number of generated passengers is halved, but this division gets rounded up instead of down. Mail generation happens in a similar manner, but with a new random value, and checking against the mail generation multiplier instead of the population.

You can further customize how the cargo is generated with the [[Callbacks#Custom_cargo_production_.282E.29 |callback 2E]]. 

=== Passenger (0D), Mail (0E) and Good/Food/Fizzy drinks (0F) acceptance ===

The acceptance is given in units of 1/8th and must not be larger than 8 eighths.

For property 0F, positive values indicate that the building accepts goods, and negative values (i.e. FF = 1/8th, FE = 2/8ths etc.) indicate acceptance of food or fizzy drinks, depending on the climate.

All the above three values can be set independently for tiles of multi-tile buildings, since every tile is processed individually when determining what a station accepts.

The type of accepted cargo can be modified using [[Action0Houses#Accepted_cargo_types|property 1E]].

{{ottdp|no| }} Note that in TTDPatch the officefood switch may modify acceptance in the sub-arctic and subtropical climates.

=== Building name ID (12) ===

The ID of the text that should be displayed in the land query window. The name can also be set by [[Action4|action 4]] (see there). Should be set to the same value for every tile for multi-tile buildings.

=== Building availability mask (13) ===

{| |-
!Bit!!Value!!Meaning
|-
|0..4||1,2,4,8,10||which [[VariationalAction2/Houses#Town zone (42)|town zone(s)]] the building can be built in
|-
|11||800||can appear in sub-arctic climate above the snow line
|-
|12||1000||can appear in temperate climate
|-
|13||2000||can appear in sub-arctic climate below the snow line
|-
|14||4000||can appear in subtropical climate
|-
|15||8000||can appear in toyland climate
|}

This property should be set to zero for additional building tiles.

=== House callback flags (14,1D) ===

For houses, the following [[callbacks]] can be defined by setting the corresponding bit in property 14:

{| |-
!Bit!!Value!!Variable 0C value!!Version!!Callback
|-
|0||1||17||{{ottdp| | }}||decide whether the house can be built on a given tile
|-
|1||2||1A||{{ottdp| | }}||decide the following frame of the animations
|-
|2||4||1B||{{ottdp| | }}||periodically start/stop the animation
|-
|3||8||1C||{{ottdp| | }}||change animation when construction state changes
|-
|4||10||1E||{{ottdp| | }}||decide the color of the building
|-
|5||20||1F||{{ottdp| | }}||decide the cargos amounts accepted
|-
|6||40||20||{{ottdp| | }}||decide the length of the current animation frame
|-
|7||80||21||{{ottdp| | }}||trigger destruction of building
|}

Property 1D was introduced after all bits of property 14 were filled. Its usage is the same, only the meaning of bits is different:

{| |-
!Bit!!Value!!Variable 0C value!!Version!!Callback
|-
|0||1||2A||{{ottdp| | }}||decide the cargo types accepted
|-
|1||2||2E||{{ottdp| | }}||custom cargo production
|-
|2||4||143||{{ottdp| | }}||conditional protection
|-
|3||8||14E||{{ottdp|1.0|2.6|ottdrev=r17558|ttdprev=2249}}||decide if default foundations need to be drawn
|-
|4||10||14F||{{ottdp|1.0|2.6|ottdrev=r17558|ttdprev=2249}}||allow or deny autosloping below the tile
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the variational Action2 for callbacks.

Callback flags are ignored for additional building tiles.

=== House override byte (15) ===

Setting this property makes this building appear instead of the given old TTD building type. Setting the property is ignored if the given old house type is already overridden. You can set this property more than once to override more old building types.

No new house of the overridden types will be built in towns.

This property works in a per-tile basis, so you override tiles of old multi-tile buildings individually, although the old type will still be built if you don't override its north tile.

=== Periodic refresh multiplier (16) ===

This is used for random triggers, and sets how often the tile is re-randomized. When set to X, the tile will be re-randomized on every (X+1)-th periodic processing. (In other words, every (X+1)*256 game ticks.) If you want all tiles to be re-randomized, you must set this (but not necessarily to the same value) for each tile.

If callback 1B is enabled in property 14, it is also called after re-randomizing random bits.

{{ottdp|1.1|2.5|ttdprev=2.5 beta 9}} In TTDPatch versions before TTDPatch 2.6 r1639 and TTDPatch 2.5 beta 9 (including beta 9), this variable could have any value between 0 and 255. After these versions, the upper limit has been lowered to 63. To maintain compatibility, values above 63 will be interpreted as 63.

=== Random colours (17) ===

This specifies four colors used for random painting (see [[Action2HousesIndustryTiles]]). Each byte of the dword defines a color, the values are the same as in Action2, except that numbering starts from zero instead of 775. If not set, this defaults to 04 08 0c 06 (red, blue, orange and green, the colors of the modern office building). Can be set to different values for tiles of multi-tile buildings.

=== Probability (18) ===

This sets the relative probability of this house being built. Old TTD house types have a probability of 16, and this is the default for new types as well.

Increase (or better multiply) this value to make your building appear relatively more often, or decrease (divide) it to make it rarer. If you set this to zero, the house type never appears. The minimal useful value 1 means it's sixteen times less probable to build this type than a normal type, while the maximum setting of 255 means it's almost sixteen times more probable.

The probability is relative since the absolute probability depends on the count and probability of other houses as well: the more types are available (and the higher their probabilities are), the less the chance is that your type will be chosen.

=== Extra Flags (19) ===

{| |-
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|0.6|2.5}}||This building appears during the generation of a town, but not later, i.e. will appear in random games, but new ones won't be built during the game. Useful for buildings that are intended to be historical.
|-
|1||2||{{ottdp|0.6|2.5}}||This building is protected, i.e. towns and AI players won't remove it. Human players can still remove it, so you may need to set a high remove cost/rating to make them think twice.
|-
|2||4||{{ottdp|0.6|2.5}}||Synchronized [[Callbacks#Animation_control_.281B.2F25.2F140.2F152.2F159.29| callback 1B]]. (for multi-tile buildings)<ref>If synchronized callbacks are enabled, callback 1B will be called when the periodic processing reaches the main tile of the building, and not when it reaches the current tile. This is useful if your animation must run synchronously on every tile of the building. If this bit is set, callback 1B is called according to the main tile's property 16, not the current one, to make sure every tile stays in sync.</ref>
|-
|3||8||{{ottdp|0.6|2.5|ttdprev=beta 2}}||[[Callbacks#Next animation frame (1A/26/141/153/158) |Callback 1A]] needs random bits
|}

<references />

=== Animation Frames (1A) ===

The bottom seven bits define how many frames the animation consists of, minus one. (I.e. 0 means 1 frame, 1 means 2 frames etc.) The highest bit has another purpose (see below), so the biggest supported value is 7F (128 frames).

The highest bit is set if the animation is looping, i.e. it should start again from the first frame after showing the last frame. Non-looping animations stop after the last frame, leaving it on the screen. Both kinds of animations start automatically when the building is created. It's recommended to use callback 1B with non-looping animations, so they are played multiple times.

{{ottdp|0.6|2.5|ottdrev=r12347|ttdprev=r1639}} In TTDPatch versions before TTDPatch 2.6 r1639 and TTDPatch 2.5 beta 9 (including beta 9) and OpenTTD before r12347, the frame number was limited to 32. If you intend to maintain compatibility with those versions, you should not use animations longer than 32 frames.

=== Animation Speed (1B) ===

This is the amount of time between switching frames.

The default value is 2, which means the switch occurs every 108 milliseconds. Increasing this value by one doubles the wait, i.e. 3 will cause 216 ms delay, while 4 will pause 432 ms, and so on. Values below 2 have the same effect as 2, so the default is the fastest possible setting. The maximum is 16, which means 1769 seconds (approx. half an hour) delay. Settings above this value may cause strange behaviour.

=== Building Class (1C) ===

Types that were given the same class byte are considered to be in the same class. If you don't explicitly set this value, the type is considered to have no class (it won't be considered to be class 0). The scope of a class is the current GRF file, so two types are never in the same class if they were defined by different GRF files. Currently, this property affects variable 44 only.

This property is a per-tile one, you can set it for additional tiles as well. It's a better idea, however, to set it for the main tile only, since var. 44 counts tiles, not buildings, and you may count multi-tile multiple times otherwise.

=== Accepted cargo types (1E) ===

There may be cases when you want your house to accept something other than the default types (passenger, mail, goods and food). This property allows you to do that. If this property is set to FFFFFFFFh (the default), the meaning of properties 0D, 0E and 0F aren't changed, that is, they are the passenger, mail and goods/food acceptances, accordingly. If this property isn't FFFFFFFFh, the first three bytes must be climate-dependent cargo slot numbers (the fourth byte is ignored). In this case property 0D is the amount of acceptance of the first cargo type given, 0E is the same for the second type and 0F is the same for the third type.

From GRF version 7 and above, the meaning of this property changes: instead of climate-dependent cargo slot numbers, you have to give climate-independent cargo IDs. If your GRF has a cargo translation table, then this ID is the index in that table; otherwise, it's the cargo slot number. Acceptance of cargoes not currently present will automatically be disabled.

{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.

=== Minimum life span in years (1F) ===

Towns are prevented from destroying the house if it hasn't yet reached the age given here. The default is 0, which means towns are free to remove the house any time they like. Please note that this setting doesn't prevent AI players from removing the house; only towns are affected. If you need to protect your building from AI players as well, you can set the "protected" flag (property 19 bit 1), or use [[Callbacks#Protect building conditionally (143) |callback 143]] and use your custom code to decide who (and when) is allowed to remove the building.

For this to operate consequently on multi-tile buildings, you must set the same minimum lifespan for all tiles of the building.

=== Cargo acceptance watch list (20) ===

This property is a list of cargo types, types whose acceptance should be watched. The first byte is the length of the list, the remaining bytes identify cargo types. {{grfFrom|7}} If your GRF is version 7 or above, and has a cargo translation table, the bytes are indexes in the table; otherwise, they are cargo slot numbers. When a cargo from this list is accepted by the current tile, [[Callbacks#Watched cargo accepted (148) |callback 148]] is called on ''all'' tiles of the building. See [[Callbacks#Watched cargo accepted (148) |callback 148]] for more details about how this happens.

{{ttdp|}} This property has no effect if the station2 structure isn't 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

=== Availability years (long format) - Minimum (21) - Maximum (22) ===

Those two properties allow to specify a range of dates (based on year zero(0) that are not limited to the 1930 dates. So earlier buildings can be introduced. Be sure to add substantial houses to the sets, if you do not wat to have uniform towns, since the current earliest houses will remain in their current 1920 era. Mind also the warning wrt. introduction years as described at property 0A.

{{ottdp|15|no}} A value of FFFF is treated as the game's MAX_YEAR instead of a literal year 65535.

=== Tile acceptance list (23) ===
{{ottdp|1.9|no|ottdrev=48b334cf}}

Format:
<numinput> (<cargotype> <acceptance>)*

{| |-
!Size!!Variable!!Meaning
|-
|B||numinput||Number of (<cargotype> <acceptance>) pairs to follow,
|-
|B||cargotype||Cargotype (from CTT) to accept.
|-
|B||acceptance||Acceptance in 1/8 units.
|}

This property defines up to 16 cargotypes, which are accepted by the house.
Use this property instead of property 0D..0F.

Action0/Vehicles/Ships

2025-02-17T14:53:18Z

Peter1138: /* Properties */

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

== Introduction ==

Defining properties of ships.
== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.0}}||Sprite (FF for new graphics)
|-
|09||B||{{ottdp|0.6|2.0}}||Refittable (0 no, 1 yes)
|-
|0A||B||{{ottdp|0.6|2.0}}||Cost factor
|-
|0B||B||{{ottdp|0.6|2.0}}||Speed in mph*3.2, use property 23 for speeds > 255
|-
|0C||B||{{ottdp|0.6|2.0}}||Cargo type, see [[CargoTypes]] 
{{grfTill|7}} For GRF version 7 and below: Type B 'cargo slot' 
{{grfFrom|8}} For GRF version 8 and above: Type A '(translated) cargo bit' 
{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.
|-
|0D||W||{{ottdp|0.6|2.0}}||Capacity
|-
|0F||B||{{ottdp|0.6|2.0}}||Running cost factor
|-
|10||B||{{ottdp|0.6|2.0}}||Sound effect type (4=cargo ship, 5=passenger ship) {{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also custom sound effects from Action11 are allowed here.
|-
|11||D||{{ottdp|0.6|2.0}} {{grfFrom|1}}||Bit mask of cargo types available for refitting, see column 2 (bit values) in [[CargoTypes]]. Obsoleted by properties 1E/1F
|-
|12||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Callback flags bit mask, see below
|-
|13||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Refit cost, using 1/32 of the default refit cost base
|-
|14||B||{{ottdp|1.2|2.5|ttdprev=alpha 44|ottdrev=r22639}}||Ocean speed fraction, sets fraction of top speed available in the ocean; e.g. 00=100%, 80=50%, FF=0.4%
|-
|15||B||{{ottdp|1.2|2.5|ttdprev=alpha 44|ottdrev=r22639}}||Canal speed fraction, same as above but for canals and rivers
|-
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||Retire vehicle early, this many years before the end of phase 2 (see [[Action0General]])
|-
|17||B||{{ottdp|0.6|2.5|ttdprev=alpha 55}}||Miscellaneous vehicle flags
|-
|18||W||{{ottdp|0.6|2.5|ttdprev=alpha 55}}||Refittable cargo classes, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 28]]
|-
|19||W||{{ottdp|0.6|2.5|ttdprev=alpha 55}}||Non-refittable cargo classes, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 29]]
|-
|1A||D||{{ottdp|0.6|2.6|ttdprev=r1210|ottdrev=r7191}}||Long format introduction date
|-
|1B||B*||{{ottdp|0.7|no|ottdrev=r13831}}||Sort the purchase list
|-
|1C||B||{{ottdp|1.1|no|ottdrev=r21240}}||Visual effect
|-
|1D||W||{{ottdp|1.2|no|ottdrev=r22713}}||Custom cargo ageing period
|-
|1E||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of always refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2C]]
|-
|1F||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of never refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2D]]
|-
|20||W||{{ottdp|13|no}}||Vehicle variant group, see [[Action0/Vehicles/Trains#Vehicle_variant_group_.282F.29|train property 2F]]
|-
|21||D||{{ottdp|13|no}}||Extra flags, see [[Action0/Vehicles/Trains#Extra_flags_.2830.29|train property 30]]
|-
|22||B||{{ottdp|14|no|ottdrev=g2d73076056}}||Additional callback flags bit mask, see below
|-
|23||W||{{ottdp|14|no|ottdrev=g5a55c4a934}}||Speed in mph*3.2
|-
|24||B||{{ottdp|14|no|ottdrev=g5a55c4a934}}||Acceleration in mph*3.2/h (0.5 km-ish/h). Minimum 1, defaults to 1 when omitted
|-
|25||W||{{ottdp|15|no|ottdrev=gd2496b6ec4}}||Cargo classes required for refittability, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 32]]
|-
|26||W n*W||{{ottdp|15}}||List of badges
|}

== Descriptions ==

=== Callbacks (12, 22) ===
For ships, the following [[callbacks]] have to be enabled by setting the corresponding bit in properties 12 and 22 (certain other, not as frequently used callbacks are available without setting a bit here):

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|2||4||12||Load amount
|-
|3||8||15||Set refitted capacity
|-
|5||20||19||show a suffix after the cargo type name
|-
|6||40||2D||Select color mapping for vehicle
|-
|7||80||33||Sound effect callbacks
|-
|8||100||161||{{ottd|14|ottdrev=gf5394ed2ef}}Engine name
|-
|9||200||163||{{ottdp|15|no|ottdrev=gd2496b6ec4}}Custom refit
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the VarAction2 for callbacks.

=== Refit cost (13) ===

Refit cost, using 1/32 of the default refit cost base. This property can be overridden by callback 15E.

{{ottdp|1.2|no|ottdrev=r23087}} If the refit cost factor is set to zero and bit 4 of the miscellaneous flags (17) is set, auto-refitting is allowed.

=== Miscellaneous flags (17) ===

This is a bit mask, with the following bits:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||reserved, do not use
|-
|1||2||Uses two company colors
|-
|2||4||reserved, do not use
|-
|3||8||reserved, do not use
|-
|4||10||{{ottdp|1.2|no|ottdrev=r23087}} Auto-refitting is enabled for refits where callback 15E allows it or prop 13 specifies zero cost.
|-
|5|| 20||{{ottdp|1.2|no|ottdrev=r23861}} Use cargo multiplier for default cargo. See page about [[VehicleRefitting#Misc._vehicle_flag_5_.27use_of_capacity_multiplier_for_default_cargo.27_set|vehicle refitting]].
|-
|6|| 40||{{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect.
|-
|7|| 80||{{ottdp|1.7|no|ottdrev=r27668}} [[Action2/Vehicles#Composing_vehicles_from_multiple_sprites|Compose vehicle from multiple sprites.]]
|}

=== Long format introduction date (1A) ===

Set the vehicle introduction date, in days since the year 0. This takes account of leap years; dividable by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). This property must be set after property 00 to take effect.

{{ottdp|no|}} In TTDPatch, dates after 2044 will be limited to 2044.

=== Sort vehicle list (1B) ===
See sort vehicle list for [[Action0Trains#Sort_vehicle_list_.281A.29|trains]] for details.

=== Visual effect (1C) ===
See the equivalent [[Action0Trains#Visual_effects_and_wagon_power_.2822.29|train property]] for information about the meaning of all bits. There is no default effect for ships, therefore values of 00..0F will show no visual effect. Bit 7 (disable wagon power) currently has no meaning and should be left at 0.

=== Custom cargo ageing period (1D) ===
See custom cargo ageing period for [[Action0Trains#Custom_cargo_ageing_period_.282B.29|trains]] for details.

== Example ==

To be written

Action0/Vehicles/Planes

2025-02-17T14:53:07Z

Peter1138: /* Properties */

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

== Introduction ==

Defining properties of planes.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.0}}||Sprite (FF for new graphics)
|-
|09||B||{{ottdp|0.6|2.0}}||Is helicopter? 2=no, 0=yes
|-
|0A||B||{{ottdp|0.6|2.0}}||Is large? 0=no, 1=yes (i.e. can't safely land on small airports)
|-
|0B||B||{{ottdp|0.6|2.0}}||Cost factor
|-
|0C||B||{{ottdp|0.6|2.0}}||Speed in units of 8 mph, that is: property = (speed in mph) / 8
|-
|0D||B||{{ottdp|0.6|2.0}}||Acceleration in units of 3/8 mph/tick, that is: property = (acceleration in mph/tick) * 8/3 <ref>{{ottd|<1.3.1}} In OpenTTD before r25115 the units for acceleration were messed up. The unit used was about 1 mph/tick, so aircraft accelerated more than twice as fast. Also values bigger than 19 failed.</ref>
|-
|0E||B||{{ottdp|0.6|2.0}}||Running cost factor
|-
|0F||W||{{ottdp|0.6|2.0}}||Primary cargo capacity (passenger or refitted cargo)
|-
|11||B||{{ottdp|0.6|2.0}}||Secondary cargo capacity (mail)
|-
|12||B||{{ottdp|0.6|2.0}}||Sound effect
|-
|13||D||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Bit mask of cargo types available for refitting, see column 2 (Bit Value) in [[CargoTypes]]. Obsoleted by properties 1D/1E
|-
|14||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Callback flags bit mask, see below
|-
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Refit cost, using 1/32 of the default refit cost base
|-
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||Retire vehicle early, this many years before the end of phase 2 (see [[Action0General]])
|-
|17||B||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Miscellaneous vehicle flags
|-
|18||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Refittable cargo classes, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 28]]
|-
|19||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Non-refittable cargo classes, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 29]]
|-
|1A||D||{{ottdp|0.6|2.5|ttdprev=r1210|ottdrev=r7191}}||Long format introduction date
|-
|1B||B*||{{ottdp|0.7|no|ottdrev=r13831}}||Sort the purchase list
|-
|1C||W||{{ottdp|1.2|no|ottdrev=r22713}}||Custom cargo ageing period
|-
|1D||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of always refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2C]]
|-
|1E||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of never refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2D]]
|-
|1F||W||{{ottdp|1.2|no|ottdrev=r23504}}||Aircraft range in tiles. Distance is euclidean, a value of 0 means range is unlimited
|-
|20||W||{{ottdp|13|no}}||Vehicle variant group, see [[Action0/Vehicles/Trains#Vehicle_variant_group_.282F.29|train property 2F]]
|-
|21||D||{{ottdp|13|no}}||Extra flags, see [[Action0/Vehicles/Trains#Extra_flags_.2830.29|train property 30]]
|-
|22||B||{{ottdp|14|no|ottdrev=g2d73076056}}||Additional callback flags bit mask, see below
|-
|23||W||{{ottdp|15|no|ottdrev=gd2496b6ec4}}||Cargo classes required for refittability, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 32]]
|-
|24||W n*W||{{ottdp|15}}||List of badges
|}
<references/>

== Descriptions ==

=== Primary (0F) and secondary (11) cargo capacity ===
Aircraft can transport up to two cargo types.
The first (primary) cargo type can be changed when refitting the aircraft.

The secondary cargo type is always mail, and is only present when the primary cargo type is part of the [[Action0/Cargos#CargoClasses_.2816.29|passenger cargo class]].

See also the page about [[VehicleRefitting|vehicle refitting]].

=== Sound effect (12) ===

The following sound effects are used by planes (note, the setting is ignored for helicopters):

{| |-
!Number!!Sound
|-
|06||Propeller sound 1
|-
|07||Jet sound 1
|-
|3B||Supersonic
|-
|3D||Jet sound 2
|-
|45||Propeller sound 2
|-
|46||Jet sound 3
|}

{{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also custom sound effects from Action11 are allowed here.

{{ottdp|1.11|no|ottdrev=6198a47}} Since OpenTTD g6198a47 this prop can be used to to set custom Action11 sound effects for helicopers. Default sound effects are ignored as before.

=== Callbacks (14, 22) ===
For planes, the following [[callbacks]] have to be enabled by setting the corresponding bit in property 14 (certain other, not as frequently used callbacks are available without setting a bit here)::

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|2||4||12||Load amount
|-
|3||8||15||Set refitted capacity
|-
|5||20||19||show a suffix after the cargo type name
|-
|6||40||2D||Select color mapping for vehicle
|-
|7||80||33||Sound effect callbacks
|-
|8||100||161||{{ottd|14|ottdrev=gf5394ed2ef}}Engine name
|-
|9||200||163||{{ottdp|15|no|ottdrev=gd2496b6ec4}}Custom refit
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the VarAction2 for callbacks.

=== Refit cost (15) ===

Refit cost, using 1/32 of the default refit cost base. This property can be overridden by callback 15E.

{{ottdp|1.2|no|ottdrev=r23087}} If the refit cost factor is set to zero and bit 4 of the miscellaneous flags (17) is set, auto-refitting is allowed.

=== Miscellaneous flags (17) ===

This is a bit mask, with the following bits:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||reserved, do not use
|-
|1||2||Uses two company colors
|-
|2||4||reserved, do not use
|-
|3||8||reserved, do not use
|-
|4||10||{{ottdp|1.2|no|ottdrev=r23087}} Auto-refitting is enabled for refits where callback 15E allows it or prop 15 specifies zero cost.
|-
|5||20||{{ottdp|1.2|no|ottdrev=r23861}} Use cargo multiplier for default cargo. See page about [[VehicleRefitting#Misc._vehicle_flag_5_.27use_of_capacity_multiplier_for_default_cargo.27_set|vehicle refitting]].
|-
|6||40||{{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect.
|-
|7|| 80||{{ottdp|1.7|no|ottdrev=r27668}} [[Action2/Vehicles#Composing_vehicles_from_multiple_sprites|Compose vehicle from multiple sprites.]]
Note: This also applies to the rotor sprite, if custom rotor sprites are used.
|}

=== Long format introduction date (1A) ===

Set the vehicle introduction date, in days since the year 0. This takes account of leap years; dividable by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). This property must be set after property 00 to take effect.

{{ottdp|no|}} In TTDPatch, dates after 2044 will be limited to 2044.

=== Sort vehicle list (1B) ===
See sort vehicle list for [[Action0Trains#Sort vehicle list 1A|trains]] for details.

=== Custom cargo ageing period (1C) ===
See custom cargo ageing period for [[Action0Trains#Custom_cargo_ageing_period_.282B.29|trains]] for details.

== Example ==

To be written

Action0/Stations

2025-02-17T14:52:50Z

Peter1138: /* Properties */

==Introduction==

Defining properties of new stations.

Unlike vehicles, the new stations have no equivalent in TTD. The IDs are therefore free to be chosen and will in fact be allocated automatically. In action 0, you only specify IDs relative to the set, i.e. the ID of the first station type is 00, the second station type is 01 and so on.

{{ttdp|}} In TTDPatch each game can only have 255 station IDs for all active grf files.

The only property you '''must''' set for each station ID is 08 (in addition to defining an [[Action3|action 3]] for it), anything else can be left at the default. It must be the first property you set for each station ID, because the station ID is actually undefined until it has been assigned a class through property 08. Also, all station IDs must get their classes in the right order, starting from ID 00 onwards.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||D||{{ottdp|0.6|2.5|ttdprev=alpha 19}}||Class ID, see below
|-
|09||V||{{ottdp|0.6|2.5|ttdprev=alpha 20}}||Sprite layout, see below
|-
|0A||B/B*||{{ottdp|0.6|2.5|ttdprev=alpha 20}}/{{ottdp|14.0}}||Copy sprite layout
|-
|0B||B||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Callback flags
|-
|0C||B||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Bit mask of disabled numbers of platforms
|-
|0D||B||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Bit mask of disabled platform lengths
|-
|0E||V||{{ottdp|0.6|2.5|ttdprev=alpha 22}}||Define custom layout, see below
|-
|0F||B/B*||{{ottdp|0.6|2.5|ttdprev=alpha 22}}/{{ottdp|14.0}}||Copy custom layout from stationid given by argument
|-
|10||W||{{ottdp|0.6|2.5|ttdprev=alpha 25}}||Little/lots threshold
|-
|11||B||{{ottdp|0.6|2.5|ttdprev=alpha 27}}||Pylon placement
|-
|12||D||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Bit mask of cargo type triggers for random sprites
|-
|13||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||General flags
|-
|14||B||{{ottdp|0.6|2.5|ttdprev=alpha 47}}||Overhead wire placement
|-
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 51}}||Can train enter tile
|-
|16||W||{{ottdp|0.7|2.5|ttdprev=beta 9}}||Animation information
|-
|17||B||{{ottdp|0.7|2.5|ttdprev=beta 9}}||Animation speed
|-
|18||W||{{ottdp|0.7|2.5|ttdprev=beta 9}}||Animation triggers
|-
|1A||V||{{ottdp|1.2|no|ottdrev=r22518}}||Advanced sprite layout with register modifiers
|-
|1B|| || ||Reserved
|-
|1C||W||{{ottdp|14}}||Station name
|-
|1D||W||{{ottdp|14}}||Station class name
|-
|1E||V||{{ottdp|15}}||Station sprite layout flags
|-
|1F||W n*W||{{ottdp|15}}||List of badges
|}

Unofficial additions and changes. Don't rely on them to ever work this way in OpenTTD or TTDPatch:
{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|1B||8*B||whatever-PP||Minimum bridge height for bridges over stations
|}

== Description ==

=== Station class (08) ===
TTDPatch groups sets of new station graphics into various classes.  The classes can be selected by the top dropdown list in the construction window, and the individual stations within the class from the bottom dropdown list.  In addition, each station can alter its appearance using [[VariationalAction2|variational]] and/or [[RandomAction2|random]] action 2 entries.

Only two classes are pre-defined:

{| |-
!Name!!Class ID!!Intended use for station
|-
|DFLT||44 46 4C 54||Default, no special station type
|-
|WAYP||57 41 59 50||Non-cargo stations, waypoints, signal boxes etc.
|}

You may simply use other classes than the above, as long as no more than (at the moment) 16 classes are used among all active .grf files at any time.

{{ottdp|15}} Station classes which start with the byte FF are considered waypoint classes, and will appear in the waypoint construction window instead of the station construction window.

When a waypoint station is built, it will not accept cargo nor will any cargo appear from nearby industries or towns.  Trains will not stop at waypoint stations, regardless of the non-stop order and/or the nonstop switch.

=== Sprite layout (09) ===
This controls what sprites are displayed, where they are displayed, and in what order.  The property is variable sized, and contains the data for all 8 possible station tile types.  If this property is set, the num-ent in the corresponding [[Action1|action 1]] need not be equal to 12 (hex), it can in fact be any number, and any number of sprites can be displayed in any order.

The data is specified as data for all eight tiles in this way:

<pre><num> <data1> <data2> ... <datan></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported (see below)
|-
|V||data1...||The variable size data for each of the <num> tiles, as specified below
|}

===== Number of tiles supported =====
* Normally this is 8, but you can specify fewer as well
* Using callback flags bit 1, specifying more makes sense too
* This value must be the same for all stations set by this action 0, even though it must be repeated for the prop. 09 definition of each station ID as well

(Note that num is an extended byte, see [[GRFActionsDetailed]].)

The content of each of the (usually eight) data sets is either a new sprite layout:

{| |-
!Size!!Name!!Meaning
|-
|D||groundsprite||the sprite to draw for the rails; this is by default a TTD sprite, but with bit 31 set an [[Action1|action 1]] sprite (42D+X) may be specified
|-
|V||spritedata||the data for station sprites, see below; each has a size of 10 bytes, and there may be several
|-
|B||80||a literal 80 ends the list of sprites for this tile
|}
or, alternatively, the instruction to use TTD's layout by using four zero bytes 00 00 00 00 instead of the groundsprite bytes. You can use [http://www.bytetransfer.de/projects/ttdpatch/docs/spriteidmapping.php the online sprite ID converter] to look up the sprite IDs you can use for all the climates.

One can draw two types of sprites.  One type is one that establishes a new 3D bounding box for use by the sprite sorter.  The other type shares the 3D bounding box of the previous sprite(s).  It must not be larger than the sprite which established the bounding box, nor must any part of it be outside this box.  For simplicity, it should have the exact same dimensions as the sprite it shares the bounding box with.  The latter type is supported in the station construction window display only since TTDPatch 2.6 r1684.

The spritedata of sprites with their own bounding box has this format:

{| |-
!Size!!Name!!Meaning
|-
|B||xofs||x-offset from northern tile corner
|-
|B||yofs||y-offset from northern tile corner
|-
|B||zofs||z-offset from northern tile corner
|-
|B||xextent||size of sprite in x direction
|-
|B||yextent||size of sprite in y direction
|-
|B||zextent||size of sprite in z direction
|-
|D||sprite||sprite number to draw
|}

The spritedata of sprites sharing the bounding box has this format:

{| |-
!Size!!Name!!Meaning
|-
|B||xofs||x-offset relative to previous sprite
|-
|B||yofs||y-offset relative to previous sprite
|-
|B||80||a literal 80
|-
|B||00||(ignored)
|-
|B||00||(ignored)
|-
|B||00||(ignored)
|-
|D||sprite||sprite number to draw
|}

Since OpenTTD r18959 you can draw multiple ground sprites for a tile, which is useful if you want to use the usual rail/grass/concrete groundtile, but still need to add features to it without using a new bounding box. To do so use the syntax of sprites sharing the previous bounding box, but use it before the first bounding box definition. xpixeloffset and ypixeloffset refer to the usual spot of groundtiles. The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2312: TTDPatch ignores the xofs and yofs fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xofs and yofs zero to get the same effect in both games.
Note however that both implementations do not consider the [[Action0/Stations#General_Flags_.2813.29|setting of prop13 bit 0]], hence these "multiple ground sprites" have to be always part of the building sprites set and cannot be part of the different sprite set for ground sprites.

The sprite number can have the following values (remember to use little endian, i.e. reversed byte order):

{| |-
!Number!!Sprite
|-
|0000042D+X||use sprite X from the corresponding [[Action1|action 1]] block (i.e. 0000042D for the first, 0000042E for the second, etc.)
|-
|0000842D+X||same, but draw it using company colour translation
|-
|0322442D+X||same, but draw in transparent mode (actual colours of the sprite are disregarded entirely); supported in station construction window display since TTDPatch 2.6 r1683
|-
|RRRR842D+X||draw sprite with colour translation defined in sprite RRRR; available since TTDPatch 2.6 r1683
|}

With bit 31 set, this sprite will refer to a TTD sprite, not the action 1 sprite. For the first ground sprite the reverse meaning applies.

Depending on the railtype the sprites may get additional offsets:

{| |-
! !! Normal/electrified rail !! Monorail !! Maglev
|-
|TTD sprites || 0 || 82 || 164
|-
|Action 1 sprite (first ground sprite) || 0 || 1 || 2
|-
|Action 1 sprite (other sprites in the layout) || 0 || 0 || 0
|}

So, TTD sprites and the first ground sprite are affected by the railtype, while other action 1 sprites in the layout are not. The offset "82" refers to the offset between the default TTD track sprites; if you are using non-track ground sprites which are not from an action 1, you need to supply fake spritenumbers which preemptively reverse the offsets (that is, you need different sprite layouts for every railtype your station is available for).

Setting bit 30 forces this sprite to be displayed normally even in "transparent buildings" mode (supported only in TTDPatch 2.6 r1695 and later).

See below for an example of linked sprites as well as transparent sprites (e.g. for a station roof).

Note that the coordinates here are 3D coordinates with x running from top-right to bottom-left and y running from top-left to bottom-right, with the tile dimensions being 16x16 (and 8 for one height level). This means the x and y values should always be within 0-15 (decimal).

This is different to and independent from the x/y offsets used in the actual .NFO file.  The 3D bounding box is used by TTD's sprite sorter to figure out the order in which to draw the sprites, as well as telling it which sprites to draw, because those whose bounding box falls outside the currently updated screen rectangle will not be drawn.  Make sure the 3D bounding box is large enough to contain the entire sprite, but not so large that the sprite sorter can't determine which sprites should be in front.

This means that the order in which you specify sprites is irrelevant.  Sprites will get drawn from back to front, in the order which the sprite sorter determines as correct, from their bounding boxes.  There are two exceptions, however:
* Sprites sharing the same bounding box will always be drawn in the given order.
* The station construction window display doesn't use the sprite sorter. Tiles that may be displayed in that window need to be specified in the correct drawing order, back to front.

=== Copy sprite layout (0A) ===

This is not a property as such, but an action.  It takes as argument a byte which is interpreted as station-ID to copy the custom sprite layout from.

Since {{ottdp|14.0}} this property is now an extended byte.

=== Callback flags (0B) ===
For stations, the following [[callbacks]] can be defined by setting the corresponding bit in property 0B:

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||13||Whether to make station available in construction window (non-zero callback return) or not (callback returns zero)
|-
|1||2||14||Use callback to select sprite layout
|-
|2||4||141||Decide next animation frame
|-
|3||8||142||Decide animation speed
|-
|4||10||149||Custom slope check
|}
Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the [[VariationalAction2|VarAction2]] for callbacks.

=== Selection of numbers of platforms and length (0C, 0D) ===

By default all platform lengths and any number of platforms is available for the new stations.  Using these properties, you can choose which ones should be unavailable by setting the corresponding bit in the property.

The values are a byte, used as a bit mask.  Bits 0 to 6 control the availability of number or length 1 to 7, and bit 7 controls the availability of the "+7" button.  Each bit that is set disables the corresponding length or number of platforms.

For compatibility with "largestations off", at least one length between 1 and 5 (bits 0 to 4) and one number of platforms between 1 and 4 (bits 0 to 3) must be available, i.e. at least one of these bits must be unset.

=== Define custom layout (0E) ===

This allows choosing which tile type is built at which tile of a newly built station.  There are four different types, which TTD normally defines as

{| |-
!Tile type!!Appearance
|-
|00||plain platform
|-
|02||platform with building
|-
|04||platform with roof, left side
|-
|06||platform with roof, right side
|}

Since {{ottdp|15}}, all even values up to FE are supported if the sprite layout is defined via property 09/0A.

These numbers are used for stations in NE-SW direction, or these numbers plus one for stations in the NW-SE direction.  To define a custom layout, use this format:

{| |-
!Size!!Name!!Meaning
|-
|B||length||length of platforms for this layout
|-
|B||number||number of platforms for this layout
|-
|V||tiles||length*number bytes of tile types, one platform after another, only 00, 02, 04 or 06 are allowed as values
|}

Repeat this as often as necessary to define the layouts for all supported combinations of length and number.  End the definitions with a 00 00 (zero length and zero number).  Any combinations that are not defined will be built using TTD's default layout.
Note that it may be easier to draw different sprite sets using a [[VariationalAction2|VarAction2]] based on [[VarAction2Stations#Platform info 40 41 46 47 49|station variable 40]], rather than redefining the layout.  In addition, [[Callbacks#Custom station layout 24|callback 24]] will be used to further customize the layout as defined by this property (or by TTD if no prop 0E layout is available). This may also be easier than defining a prop 0E layout for every combination of length and number of platforms.

=== Copy custom layout (0F) ===

Similar to property 0A, this copies the custom layout from the station-ID given by the argument.

Since {{ottdp|14.0}} this property is now an extended byte.

=== Little/lots threshold (10) ===
Amount of cargo for switching from "little" to "lots" of cargo.  TTDPatch separates the full range of cargo amounts (0 to 4095) into two separate subranges, "little" and "lots" of cargo.  This allows better control of cargo amount based graphics (if needed).  Property 10 specifies at what amount of cargo the patch is to switch from one to the other subrange.  See [[Action2Stations|Action 2 for stations]] for more information.

=== Pylon placement (11) and wire placement (14) ===
Prop. 11 sets which tile types should have pylons when used with electrified tracks. By default, tiles 0-3 (default stations without roof) have pylons, and tiles 4-7 (default stations with roof) don't. This is a bit mask of tile types, with a bit set meaning that a pylon should be drawn. The tile types here do not consider [[Callbacks#Station sprite layout 14|callback 14]], but rather the type as it was built, i.e. from prop. 0E.

Prop. 14 works in a similar way, except that it sets the tile types on which there should be ''no'' wires displayed. With the default value of "00", wires are displayed everywhere, and for each bit set, the wire is omitted on that tile type.

This property should only be used when the wires cause problems with the sprite sorter, because even when the wire is obscured by a station hall or similar, it should still show up in transparent mode so that each tile can easily be verified as being electrified.

{{ottdp|15}} Note: This property only allows setting the flags of the first 8 sprite layouts. Use Property 1E instead to set flags when more sprite layouts are used via prop. 0E or [[Callbacks#Custom_station_layout_.2824.29|callback 24]].

=== Cargo types for random triggers (12) ===

This sets which cargo types should trigger re-randomizing. The cargo types are given as a bitmask of the bits from column 3 (type B) in CargoTypes.  If nothing is set (the default), the no random triggers will happen, to conserve CPU time.

With GRF version 7 and above, the interpretation of bits changes. Instead of climate-dependent cargo slot numbers (type B), you have to set the bits of climate-independent cargo ID (type A).

{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.

=== General Flags (13) ===

{| |-
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|0.7|2.5}}||use different sprite set for ground sprites ([[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|var. 10]] is 1 for ground sprites, 0 otherwise)
|-
|1||2||{{ottdp|0.6|2.5}}||when calculating the cargo amount to display, divide the amount by the station size (to simulate cargo distributed over the area of the station)
|-
|2||4||{{ottdp|0.7|2.5}}||[[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] needs random bits in var. 10
|-
|3||8||{{ottdp|1.0|2.6}}||Use custom foundations on sloped tiles (the lowest byte of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|var. 10]] is 2 for foundation sprites)
|-
|4||10||{{ottdp|1.0|2.6}}||When bit 3 is set, use extended foundation block instead of the simple one
|}

Bit 3 works somewhat similarly to bit 0: your sprite selection will be called again, with 2 in the lowest byte of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 10]]. If the chain ends on a callback result, the program will assume the foundation selection has failed and will use the default foundaton sprites. The low word of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 18]] will contain the tile type of the current tile; if you have [[Callbacks#Station sprite layout (14)|callback 14]] enabled, this will be the its return value - otherwise, the default TTD types (platform with building, platform with left roof etc.) are used. In either case, one is added for the NW-SE orientation, in case your station needs different foundations depending on its orientation. Bits 16 and 17 are set if the NW and and NE foundations are to merged with the corresponding neighbour tile, so you shouldn't draw the corresponding edge in the foundation sprite. Other bits of variable 10 and variable 18 are reserved for future use.

Your sprite selection code should select a foundation sprite block. The contents of this block depends on whether bit 4 is set or not.
* Bit 4 clear (simple foundations):
[[File:simple_foundations.png]]

The programme will combine the needed foundation from these 8 sprites depending on the current slope. You don't need to care about the merge data in bits 16..17 of [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 18]]; it will be taken care of that automatically by adding the 7th and 8th sprite only when necessary.
* Bit 4 set (extended foundations):
[[File:extended_foundations.png]]

You need to have one sprite for every slope that's possible below a rail station. The correct one will be automatically selected depending on the current slope. It can't handle the merging itself, however, so you need four foundation blocks: one with no edges removed, one with the NW edge removed, one with the NE edge removed and one with both north edges removed. Your sprite selection code is responsible for selecting the correct of those blocks according to the merge info in [[GlobalVariables#Extra_callback_info_.2810_.2F_-.29_and_.2818_.2F_-.29|variable 18]].

In both cases, you can put an additional value into register 100h, which will serve as an offset into the selected block. If you don't modify register 100h during the chain, it will default to 0. It is important that the dimensions of these sprites remain the same - thus bit 6 in the real sprites must be set to prevent GRFCodec from trimming the empty blue areas. The offset of these foundations must be -31 to the X direction and -9 to the Y direction.

=== Can train enter tile (15) ===

Like props. 11 and 14, this value contains eight bits relating to the eight possible tile types. If a bit is set, trains are prevented from routing through or entering any tile of this type.

{{ottdp|15}} Note: This property only allows setting the flags of the first 8 sprite layouts. Use Property 1E instead to set flags when more sprite layouts are used via prop. 0E or [[Callbacks#Custom_station_layout_.2824.29|callback 24]].

=== Animation information (16) ===

The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this station (this is the default value).
Since you can't have properties for individual station tiles, this property applies for every tile of the station. If you don't want to animate some tiles, you should check the current position during [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]] and return FD if the current tile doesn't need to be animated. If you also need animations of different length per tile, you'll have to use [[Callbacks#Next animation frame (1A/26/141/153/158)|callback 141]] for that.

=== Animation speed (17) ===
The meaning is the same as for [[Action0Houses#Animation Speed 1B|house property 1B]], but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.

=== Animation triggers (18) ===
This is a bit mask of events that should trigger [[Callbacks#Animation control (1B/25/140/152/159)|callback 140]], allowing to change the animation state

{| |-
!Bit!!Value!!Version!!Meaning!!Happens on!!Var 18
|-
|0||1||{{ottdp|0.7|2.5}}||Station part is built||the newly built tiles||
|-
|1||2||{{ottdp|0.7|2.5}}||New cargo arrives to station||whole station||<ref name="cargotype">Bits 8..15 of var 18 contain the triggering cargo type. If your GRF has a cargo translation table, the cargo type will be an index in that table, or FFh if the cargo isn't in the table. If you don't have a cargo translation table, the cargo type will simply be the climate-dependent cargo type number.</ref>
|-
|2||4||{{ottdp|0.7|2.5}}||A cargo type gets removed from station||whole station||<ref name="cargotype"/>
|-
|3||8||{{ottdp|0.7|2.5}}||Train enters station (starts loading/unloading)||platform where the train is||
|-
|4||10||{{ottdp|0.7|2.5}}||Train leaves station (done loading/unloading)||platform where the train is||
|-
|5||20||{{ottdp|1.2|2.5|ottdrev=r22746}}||Train loads/unloads cargo||platform where the train is||
|-
|6||40||{{ottdp|0.7|2.5}}||Every 250 ticks||whole station||
|}

The remaining bits are reserved for future triggers, they must be zero for now.

The "happens on" column tells which tiles will [[Callbacks#Animation control (1B/25/140/152/159) |callback 140]] be called on.

<references/>

=== Advanced sprite layout with register modifiers (1A) ===

{{ottdp|1.2|no|ottdrev=r22518}}
Format:
1A <num-layouts> <0x40 + num-sprites>
<groundsprite> <flags> [<register/value>]...
[ <buildingsprite> <flags>
( <xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>
| <xpixeloffset> <ypixeloffset> 80)
[<register/value>]...
]...

For further details see [https://wiki.openttd.org/en/Archive/Development/Advanced%20Sprite%20Layout#stations here] for now.

=== Minimum bridge height (1B) ===

This property allows building bridges over stations.

The bridge height property defines minimum clearances required for a bridge for each of the four [[Action0/Stations#Define_custom_layout_.280E.29|tile types]] of this station (or zero to not allow any bridge). Values are given in "height level" units (1 level == 8px).

{| class="wikitable" |-
!Height (1)!!Appearance
|-
| style="text-align:center;" |x1 y1 ||plain platform
|-
| style="text-align:center;" |x2 y2 ||platform with building
|-
| style="text-align:center;" |x3 y3 ||platform with roof, left side
|-
| style="text-align:center;" |x4 y4 ||platform with roof, right side
|}
(1) where the values are one byte pairs (x-direction, y-direction) expressed in hexadecimal notation.

Syntax:

1B <1st pair> <2nd pair> <3rd pair> <4th pair> 
1B x1 y1 x2 y2 x3 y3 x4 y4 
1B 01 01 02 02 03 03 03 03 // 8px 16px 24px 24px

This property is currently only available for JGR's Patch Pack (v0.26.0 and later) and the developmental "New Map Features" (NMF) fork of OpenTTD.

=== Station name (1C) ===

=== Station class name (1D) ===

=== Station sprite layout flags (1E) ===

{{ottdp|15}} Since OpenTTD supports more than 8 sprite layouts to be used, props. 11, 14 and 15 are not sufficient to set the flags for all usable sprite layouts. This property is variable length and allows these flags to be set for each tile beyond the original limit of 8.

The data is specified as flags for all sprite layouts in this way:

<pre><num> <flags1> <flags2> ... <flagsn></pre>

{| |-
!Size!!Name!!Meaning
|-
|B*||num||Number of different tiles supported (see below)
|-
|B||flags1...||The flags for each of the <num> tiles, as specified below
|}

The flag values are as follows:

{| |-
|Bit||Value||Meaning
|-
|0||01||Tile should contain catenary pylons.
|-
|1||02||Tile should NOT contain catenary wires.
|-
|2||04||Tile is blocked to vehicles.
|}

These should be combined as needed.

== Examples ==

=== Using TTD's sprite layouts for certain tiles ===

To use TTD's layout, you use <code>00 00 00 00</code> for the ground sprite number and leave off everything else.

So instead of for example

F4 03 00 00
00 00 00 10 05 02 2E 84 00 00
00 0B 00 10 05 02 30 84 00 00
80

you just put

00 00 00 00

=== Using transparent sprites ===

You can use transparent sprites to make for example the roof translucent like in TTD's stations. The roof of TTD's stations is made like this:

00 00 10 10 10 0A 37 84 00 00
00 00 80 00 00 00 3B 44 22 03

The first sprite here is the non-transparent frame of the roof, drawn in company colours (it has bit 15 set). The second part is a special "linked" sprite without its own bounding box, it shares that of the previous sprite. That's done by setting the z offset to 80.

To make that second sprite transparent, bit 14 is set in the sprite number, and the upper word is set to 322 (*), so 0322443B means to take sprite 43B and draw it in transparent mode. The colours of that sprite are ignored entirely, every pixel in colour 0 is fully transparent, and all other pixels are semi-transparent (essentially just causing what they are drawn over to become darker).

(*) This is the [[RecolorSprites#Default_recolour_sprites | recolour sprite]] for the glass effect.

Action0/Vehicles/Planes

2025-02-17T14:52:24Z

Peter1138: /* Properties */

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

== Introduction ==

Defining properties of planes.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.0}}||Sprite (FF for new graphics)
|-
|09||B||{{ottdp|0.6|2.0}}||Is helicopter? 2=no, 0=yes
|-
|0A||B||{{ottdp|0.6|2.0}}||Is large? 0=no, 1=yes (i.e. can't safely land on small airports)
|-
|0B||B||{{ottdp|0.6|2.0}}||Cost factor
|-
|0C||B||{{ottdp|0.6|2.0}}||Speed in units of 8 mph, that is: property = (speed in mph) / 8
|-
|0D||B||{{ottdp|0.6|2.0}}||Acceleration in units of 3/8 mph/tick, that is: property = (acceleration in mph/tick) * 8/3 <ref>{{ottd|<1.3.1}} In OpenTTD before r25115 the units for acceleration were messed up. The unit used was about 1 mph/tick, so aircraft accelerated more than twice as fast. Also values bigger than 19 failed.</ref>
|-
|0E||B||{{ottdp|0.6|2.0}}||Running cost factor
|-
|0F||W||{{ottdp|0.6|2.0}}||Primary cargo capacity (passenger or refitted cargo)
|-
|11||B||{{ottdp|0.6|2.0}}||Secondary cargo capacity (mail)
|-
|12||B||{{ottdp|0.6|2.0}}||Sound effect
|-
|13||D||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Bit mask of cargo types available for refitting, see column 2 (Bit Value) in [[CargoTypes]]. Obsoleted by properties 1D/1E
|-
|14||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Callback flags bit mask, see below
|-
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Refit cost, using 1/32 of the default refit cost base
|-
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||Retire vehicle early, this many years before the end of phase 2 (see [[Action0General]])
|-
|17||B||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Miscellaneous vehicle flags
|-
|18||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Refittable cargo classes, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 28]]
|-
|19||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Non-refittable cargo classes, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 29]]
|-
|1A||D||{{ottdp|0.6|2.5|ttdprev=r1210|ottdrev=r7191}}||Long format introduction date
|-
|1B||B*||{{ottdp|0.7|no|ottdrev=r13831}}||Sort the purchase list
|-
|1C||W||{{ottdp|1.2|no|ottdrev=r22713}}||Custom cargo ageing period
|-
|1D||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of always refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2C]]
|-
|1E||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of never refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2D]]
|-
|1F||W||{{ottdp|1.2|no|ottdrev=r23504}}||Aircraft range in tiles. Distance is euclidean, a value of 0 means range is unlimited
|-
|20||W||{{ottdp|13|no}}||Vehicle variant group, see [[Action0/Vehicles/Trains#Vehicle_variant_group_.282F.29|train property 2F]]
|-
|21||D||{{ottdp|13|no}}||Extra flags, see [[Action0/Vehicles/Trains#Extra_flags_.2830.29|train property 30]]
|-
|22||B||{{ottdp|14|no|ottdrev=g2d73076056}}||Additional callback flags bit mask, see below
|-
|23||W||{{ottdp|15|no|ottdrev=gd2496b6ec4}}||Cargo classes required for refittability, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 32]]
|-
|24||W n*W||{{ottdp|15}}||List of badges||??
|}
<references/>

== Descriptions ==

=== Primary (0F) and secondary (11) cargo capacity ===
Aircraft can transport up to two cargo types.
The first (primary) cargo type can be changed when refitting the aircraft.

The secondary cargo type is always mail, and is only present when the primary cargo type is part of the [[Action0/Cargos#CargoClasses_.2816.29|passenger cargo class]].

See also the page about [[VehicleRefitting|vehicle refitting]].

=== Sound effect (12) ===

The following sound effects are used by planes (note, the setting is ignored for helicopters):

{| |-
!Number!!Sound
|-
|06||Propeller sound 1
|-
|07||Jet sound 1
|-
|3B||Supersonic
|-
|3D||Jet sound 2
|-
|45||Propeller sound 2
|-
|46||Jet sound 3
|}

{{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also custom sound effects from Action11 are allowed here.

{{ottdp|1.11|no|ottdrev=6198a47}} Since OpenTTD g6198a47 this prop can be used to to set custom Action11 sound effects for helicopers. Default sound effects are ignored as before.

=== Callbacks (14, 22) ===
For planes, the following [[callbacks]] have to be enabled by setting the corresponding bit in property 14 (certain other, not as frequently used callbacks are available without setting a bit here)::

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|2||4||12||Load amount
|-
|3||8||15||Set refitted capacity
|-
|5||20||19||show a suffix after the cargo type name
|-
|6||40||2D||Select color mapping for vehicle
|-
|7||80||33||Sound effect callbacks
|-
|8||100||161||{{ottd|14|ottdrev=gf5394ed2ef}}Engine name
|-
|9||200||163||{{ottdp|15|no|ottdrev=gd2496b6ec4}}Custom refit
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the VarAction2 for callbacks.

=== Refit cost (15) ===

Refit cost, using 1/32 of the default refit cost base. This property can be overridden by callback 15E.

{{ottdp|1.2|no|ottdrev=r23087}} If the refit cost factor is set to zero and bit 4 of the miscellaneous flags (17) is set, auto-refitting is allowed.

=== Miscellaneous flags (17) ===

This is a bit mask, with the following bits:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||reserved, do not use
|-
|1||2||Uses two company colors
|-
|2||4||reserved, do not use
|-
|3||8||reserved, do not use
|-
|4||10||{{ottdp|1.2|no|ottdrev=r23087}} Auto-refitting is enabled for refits where callback 15E allows it or prop 15 specifies zero cost.
|-
|5||20||{{ottdp|1.2|no|ottdrev=r23861}} Use cargo multiplier for default cargo. See page about [[VehicleRefitting#Misc._vehicle_flag_5_.27use_of_capacity_multiplier_for_default_cargo.27_set|vehicle refitting]].
|-
|6||40||{{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect.
|-
|7|| 80||{{ottdp|1.7|no|ottdrev=r27668}} [[Action2/Vehicles#Composing_vehicles_from_multiple_sprites|Compose vehicle from multiple sprites.]]
Note: This also applies to the rotor sprite, if custom rotor sprites are used.
|}

=== Long format introduction date (1A) ===

Set the vehicle introduction date, in days since the year 0. This takes account of leap years; dividable by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). This property must be set after property 00 to take effect.

{{ottdp|no|}} In TTDPatch, dates after 2044 will be limited to 2044.

=== Sort vehicle list (1B) ===
See sort vehicle list for [[Action0Trains#Sort vehicle list 1A|trains]] for details.

=== Custom cargo ageing period (1C) ===
See custom cargo ageing period for [[Action0Trains#Custom_cargo_ageing_period_.282B.29|trains]] for details.

== Example ==

To be written

Action0/Vehicles/Ships

2025-02-17T14:52:11Z

Peter1138: /* Properties */

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

== Introduction ==

Defining properties of ships.
== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.0}}||Sprite (FF for new graphics)
|-
|09||B||{{ottdp|0.6|2.0}}||Refittable (0 no, 1 yes)
|-
|0A||B||{{ottdp|0.6|2.0}}||Cost factor
|-
|0B||B||{{ottdp|0.6|2.0}}||Speed in mph*3.2, use property 23 for speeds > 255
|-
|0C||B||{{ottdp|0.6|2.0}}||Cargo type, see [[CargoTypes]] 
{{grfTill|7}} For GRF version 7 and below: Type B 'cargo slot' 
{{grfFrom|8}} For GRF version 8 and above: Type A '(translated) cargo bit' 
{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.
|-
|0D||W||{{ottdp|0.6|2.0}}||Capacity
|-
|0F||B||{{ottdp|0.6|2.0}}||Running cost factor
|-
|10||B||{{ottdp|0.6|2.0}}||Sound effect type (4=cargo ship, 5=passenger ship) {{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also custom sound effects from Action11 are allowed here.
|-
|11||D||{{ottdp|0.6|2.0}} {{grfFrom|1}}||Bit mask of cargo types available for refitting, see column 2 (bit values) in [[CargoTypes]]. Obsoleted by properties 1E/1F
|-
|12||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Callback flags bit mask, see below
|-
|13||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Refit cost, using 1/32 of the default refit cost base
|-
|14||B||{{ottdp|1.2|2.5|ttdprev=alpha 44|ottdrev=r22639}}||Ocean speed fraction, sets fraction of top speed available in the ocean; e.g. 00=100%, 80=50%, FF=0.4%
|-
|15||B||{{ottdp|1.2|2.5|ttdprev=alpha 44|ottdrev=r22639}}||Canal speed fraction, same as above but for canals and rivers
|-
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||Retire vehicle early, this many years before the end of phase 2 (see [[Action0General]])
|-
|17||B||{{ottdp|0.6|2.5|ttdprev=alpha 55}}||Miscellaneous vehicle flags
|-
|18||W||{{ottdp|0.6|2.5|ttdprev=alpha 55}}||Refittable cargo classes, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 28]]
|-
|19||W||{{ottdp|0.6|2.5|ttdprev=alpha 55}}||Non-refittable cargo classes, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 29]]
|-
|1A||D||{{ottdp|0.6|2.6|ttdprev=r1210|ottdrev=r7191}}||Long format introduction date
|-
|1B||B*||{{ottdp|0.7|no|ottdrev=r13831}}||Sort the purchase list
|-
|1C||B||{{ottdp|1.1|no|ottdrev=r21240}}||Visual effect
|-
|1D||W||{{ottdp|1.2|no|ottdrev=r22713}}||Custom cargo ageing period
|-
|1E||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of always refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2C]]
|-
|1F||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of never refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2D]]
|-
|20||W||{{ottdp|13|no}}||Vehicle variant group, see [[Action0/Vehicles/Trains#Vehicle_variant_group_.282F.29|train property 2F]]
|-
|21||D||{{ottdp|13|no}}||Extra flags, see [[Action0/Vehicles/Trains#Extra_flags_.2830.29|train property 30]]
|-
|22||B||{{ottdp|14|no|ottdrev=g2d73076056}}||Additional callback flags bit mask, see below
|-
|23||W||{{ottdp|14|no|ottdrev=g5a55c4a934}}||Speed in mph*3.2
|-
|24||B||{{ottdp|14|no|ottdrev=g5a55c4a934}}||Acceleration in mph*3.2/h (0.5 km-ish/h). Minimum 1, defaults to 1 when omitted
|-
|25||W||{{ottdp|15|no|ottdrev=gd2496b6ec4}}||Cargo classes required for refittability, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 32]]
|-
|26||W n*W||{{ottdp|15}}||List of badges||??
|}

== Descriptions ==

=== Callbacks (12, 22) ===
For ships, the following [[callbacks]] have to be enabled by setting the corresponding bit in properties 12 and 22 (certain other, not as frequently used callbacks are available without setting a bit here):

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|2||4||12||Load amount
|-
|3||8||15||Set refitted capacity
|-
|5||20||19||show a suffix after the cargo type name
|-
|6||40||2D||Select color mapping for vehicle
|-
|7||80||33||Sound effect callbacks
|-
|8||100||161||{{ottd|14|ottdrev=gf5394ed2ef}}Engine name
|-
|9||200||163||{{ottdp|15|no|ottdrev=gd2496b6ec4}}Custom refit
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the VarAction2 for callbacks.

=== Refit cost (13) ===

Refit cost, using 1/32 of the default refit cost base. This property can be overridden by callback 15E.

{{ottdp|1.2|no|ottdrev=r23087}} If the refit cost factor is set to zero and bit 4 of the miscellaneous flags (17) is set, auto-refitting is allowed.

=== Miscellaneous flags (17) ===

This is a bit mask, with the following bits:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||reserved, do not use
|-
|1||2||Uses two company colors
|-
|2||4||reserved, do not use
|-
|3||8||reserved, do not use
|-
|4||10||{{ottdp|1.2|no|ottdrev=r23087}} Auto-refitting is enabled for refits where callback 15E allows it or prop 13 specifies zero cost.
|-
|5|| 20||{{ottdp|1.2|no|ottdrev=r23861}} Use cargo multiplier for default cargo. See page about [[VehicleRefitting#Misc._vehicle_flag_5_.27use_of_capacity_multiplier_for_default_cargo.27_set|vehicle refitting]].
|-
|6|| 40||{{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect.
|-
|7|| 80||{{ottdp|1.7|no|ottdrev=r27668}} [[Action2/Vehicles#Composing_vehicles_from_multiple_sprites|Compose vehicle from multiple sprites.]]
|}

=== Long format introduction date (1A) ===

Set the vehicle introduction date, in days since the year 0. This takes account of leap years; dividable by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). This property must be set after property 00 to take effect.

{{ottdp|no|}} In TTDPatch, dates after 2044 will be limited to 2044.

=== Sort vehicle list (1B) ===
See sort vehicle list for [[Action0Trains#Sort_vehicle_list_.281A.29|trains]] for details.

=== Visual effect (1C) ===
See the equivalent [[Action0Trains#Visual_effects_and_wagon_power_.2822.29|train property]] for information about the meaning of all bits. There is no default effect for ships, therefore values of 00..0F will show no visual effect. Bit 7 (disable wagon power) currently has no meaning and should be left at 0.

=== Custom cargo ageing period (1D) ===
See custom cargo ageing period for [[Action0Trains#Custom_cargo_ageing_period_.282B.29|trains]] for details.

== Example ==

To be written

Action0/Vehicles/RoadVehicles

2025-02-17T14:51:52Z

Peter1138: /* Properties */

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

== Introduction ==

Defining properties of road vehicles.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description!!Available for articulated parts
|-
|05||B||{{ottdp|1.10|no}}||Roadtype / tramtype (see below)||should be same as front
|-
|08||B||{{ottdp|0.6|2.0}}||Speed in mph*3.2||no
|-
|09||B||{{ottdp|0.6|2.0}}||Running cost factor||should be zero
|-
|0A||D||{{ottdp|0.6|2.0}}||Running cost base, see below||should be zero
|-
|0E||B||{{ottdp|0.6|2.0}}||Sprite ID (FF for new graphics)||yes
|-
|0F||B||{{ottdp|0.6|2.0}}||Capacity||yes
|-
|10||B||{{ottdp|0.6|2.0}}||Cargo type, see [[CargoTypes]] 
{{grfTill|7}} For GRF version 7 and below: Type B 'cargo slot' 
{{grfFrom|8}} For GRF version 8 and above: Type A '(translated) cargo bit' 
{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.
||yes
|-
|11||B||{{ottdp|0.6|2.0}}||Cost factor||should be zero
|-
|12||B||{{ottdp|0.6|2.0}}||Sound effect: 17/19/1A for regular, 3C/3E for toyland {{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also custom sound effects from Action11 are allowed here.||no
|-
|13||B||{{ottdp|1.1|2.0}} {{grfFrom|2}}||Power in 10 hp, see below||should be zero
|-
|14||B||{{ottdp|1.1|2.0}} {{grfFrom|2}}||Weight in 1/4 tons, see below||should be zero
|-
|15||B||{{ottdp|0.7|2.0}} {{grfFrom|2}}||Speed in mph*0.8, see below||no
|-
|16||D||{{ottdp|0.6|2.0}} {{grfFrom|2}}||Bit mask of cargo types available for refitting (not refittable if 0 or unset), see column 2 (bit values) in [[CargoTypes]]. Obsoleted by properties 24/25||yes
|-
|17||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Callback flags bit mask, see below||yes
|-
|18||B||{{ottdp|1.1|2.5|ttdprev=alpha 30}}||Coefficient of tractive effort||should be zero
|-
|19||B||{{ottdp|1.1|2.5|ttdprev=alpha 30}}||Coefficient of air drag||should be zero
|-
|1A||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Refit cost, using 25% of the [[BaseCosts|purchase price cost base]]||yes
|-
|1B||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||Retire vehicle early, this many years before the end of phase 2 (see [[Action0General]])||no
|-
|1C||B||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Miscellaneous vehicle flags||partly ("tram" should be same as front)
|-
|1D||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Refittable cargo classes, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 28]]||yes
|-
|1E||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Non-refittable cargo classes, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 29]]||yes
|-
|1F||D||{{ottdp|0.6|2.5|ttdprev=r1210|ottdrev=r7191}}||Long format introduction date||no
|-
|20||B*||{{ottdp|0.7|no|ottdrev=r13831}}||Sort the purchase list||no
|-
|21||B||{{ottdp|1.1|no|ottdrev=r21240}}||Visual effect||yes
|-
|22||W||{{ottdp|1.2|no|ottdrev=r22713}}||Custom cargo ageing period||yes
|-
|23||B||{{ottdp|1.2|no|ottdrev=r23164}}||Make vehicle shorter, see [[Action0/Vehicles/Trains#Shorter_train_vehicles_.2821.29|train property 21]]||yes
|-
|24||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of always refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2C]]||yes
|-
|25||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of never refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2D]]||yes
|-
|26||W||{{ottdp|13|no}}||Vehicle variant group, see [[Action0/Vehicles/Trains#Vehicle_variant_group_.282F.29|train property 2F]]
|-
|27||D||{{ottdp|13|no}}||Extra flags, see [[Action0/Vehicles/Trains#Extra_flags_.2830.29|train property 30]]
|-
|28||B||{{ottdp|14|no|ottdrev=g2d73076056}}||Additional callback flags bit mask, see below||yes
|-
|29||W||{{ottdp|15|no|ottdrev=gd2496b6ec4}}||Cargo classes required for refittability, see [[Action0Trains#Cargo_classes (28, 29, 32)|train prop. 32]]||yes
|-
|2A||W n*W||{{ottdp|15}}||List of badges||??
|}

== Description ==

=== Roadtype or tramtype (05) ===
{{ottdp|1.10|no}} Roadtype or tramtype for the vehicle. This is an index into the [[Action0/Global_Settings#Roadtype_translation_table_.2816.29|roadtype]] or [[Action0/Global_Settings#Tramtype_translation_table_.2817.29|tramtype]] translation table.

This property:
* will use property 1C bit 0 (flag 'vehicle is tram') to determine whether to use a roadtype or tramtype table
* requires an appropriate roadtype or tramtype table to be loaded

=== Running cost base (0A) and factor (09) ===

TTD calculates all costs by multiplying a 48-bit base amount with an 8-bit factor.  The base amount is changed according to inflation, whereas the factor remains constant.

For the running costs of road vehicles, the following base amounts are available:

{| |-
!Type!!Value!!in little-endian notation
|-
|Road vehicle running cost base||4C48||48 4C 00 00
|}

Theoretically, you could use pointers to other [[BaseCosts|base amounts]] available in TTD, but these are the numbers TTD uses for road vehicles.

=== Cost factor (11) ===

The cost factor is a bit-coded value which determines how expensive a vehicle is. The table below gives you some values to use for finding the right price for your vehicles.

{| |-
!Cost factor!!Price
|-
|00||$ 0
|-
|01||$ 108
|-
|10||$ 1,750
|-
|20||$ 3,500
|-
|80||$ 14,000
|-
|FF||$ 27,890
|}

=== Realistic acceleration properties (13, 14, 15) ===

Using property 15 to set the speed, it is possible to achieve speeds larger than 80 mph (127 km/h), to which property 08 is limited. When setting property 15, always set property 08 as well, so that the vehicle works reasonably well whether realistic acceleration is turned on or off. If property 15 is not set, the value from property 08 is used instead.

{{ttdp|}} TTDPatch uses these properties only if road vehicles are set to realistic acceleration in the NewCurveAndMountainHandling switch. They are ignored otherwise.

{{ottd|}} OpenTTD uses these properties always, if they are defined and gives the speed defined here precedence over the one defined in property 08.

=== Callbacks (17, 28) ===

For road vehicles, the following [[callbacks]] have to be enabled by setting the corresponding bit in properties 17 and 28 (certain other, not as frequently used callbacks are available without setting a bit here):

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|1||2||11||Wagon length
|-
|2||4||12||Load amount
|-
|3||8||15||Set refitted capacity
|-
|4||10||16||Build articulated vehicle
|-
|5||20||19||show a suffix after the cargo type name
|-
|6||40||2D||Select color mapping for vehicle
|-
|7||80||33||Sound effect callbacks
|-
|8||100||161||{{ottd|14|ottdrev=gf5394ed2ef}}Engine name
|-
|9||200||163||{{ottdp|15|no|ottdrev=gd2496b6ec4}}Custom refit
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the VarAction2 for callbacks.

=== Coefficient of tractive effort (18) ===

This cofficient sets what fraction of the vehicle weight is equal to the maximum tractive effort.  This includes the effect of having some unpowered axles, as well as the coefficient of friction that is available.

For a value of FF, the tractive effort is equal to the vehicle weight, for 80, it is half, and so on.  If not set, a default of 4C is used, for a fraction of 0.30, corresponding to Wadh=W and a coefficient of friction of 0.30, which is the value used by the patch before TTDPatch 2.0.1 alpha 19.

=== Coefficient of air drag (19) ===

This property sets the air drag coefficient c2 used for the realistic acceleration model, from 01 (no airdrag) to FF (most air drag) in arbitrary units.  00 means to use the default value that depends on the top speed (to simulate the fact that high-speed engines are more streamlined).

The default values are the following:

{| |-
!top speed (mph/1.6)!!<16!!16!!24!!32!!48!!64!!96!!128!!192!!256!!...
|-
|c2||192||128||96||64||48||32||24||16||12||8
|}

For higher speeds, the series is continued in the same manner.

Air drag in Newtons will then be c2*v*v with v in m/s, although it is probably futile to attempt to make c2 a realistic number due to the lack of TTd's consistent scaling.  If a vehicle doesn't reach its historical top speed, you might try setting prop. 19 one or two higher than the default above, otherwise it's probably a good idea to leave it at the default.

=== Refit cost (1A) ===

Refit cost, using 25% of the [[BaseCosts|purchase price cost base]]. This property can be overridden by callback 15E.

{{ottdp|1.2|no|ottdrev=r23087}} If the refit cost factor is set to zero and bit 4 of the miscellaneous flags (1C) is set, auto-refitting is allowed.

=== Miscellaneous flags (1C) ===

This is a bit mask, with the following bits:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||Vehicle is a tram/light rail vehicle and requires tram tracks to operate
|-
|1||2||Uses two company colors
|-
|2||4||reserved, do not use
|-
|3||8||reserved, do not use
|-
|4||10||{{ottdp|1.2|no|ottdrev=r23087}} Auto-refitting is enabled for refits where callback 15E allows it or prop 1A specifies zero cost.
|-
|5|| 20||{{ottdp|1.2|no|ottdrev=r23861}} Use cargo multiplier for default cargo. See page about [[VehicleRefitting#Misc._vehicle_flag_5_.27use_of_capacity_multiplier_for_default_cargo.27_set|vehicle refitting]].
|-
|6|| 40||{{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect.
|-
|7|| 80||{{ottdp|1.7|no|ottdrev=r27668}} [[Action2/Vehicles#Composing_vehicles_from_multiple_sprites|Compose vehicle from multiple sprites.]]
|}

=== Long format introduction date (1F) ===

Set the vehicle introduction date, in days since the year 0. This takes account of leap years; dividable by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). This property must be set after property 00 to take effect.

{{ottdp|no|}} In TTDPatch, dates after 2044 will be limited to 2044.

=== Sort vehicle list (20) ===
See sort vehicle list for [[Action0Trains#Sort vehicle list 1A|trains]] for details.

=== Visual effect (21) ===
See the equivalent [[Action0Trains#Visual effects and wagon power 22|train property]] for information about the meaning of all bits. There is no default effect for road vehicles, therefore values of 00..0F will show no visual effect. Bit 7 (disable wagon power) currently has no meaning and should be left at 0.

=== Custom cargo ageing period (22) ===
See custom cargo ageing period for [[Action0Trains#Custom_cargo_ageing_period_.282B.29|trains]] for details.

== Example ==

To be written

Action0/Vehicles/Trains

2025-02-17T14:51:27Z

Peter1138: /* Properties */

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

=Introduction=
Defining properties of train vehicles.

= Properties =

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description!!Available for articulated parts
|-
|05||B||{{ottdp|0.6|2.0}}||Track type (see below)||should be same as front
|-
|08||B||{{ottdp|0.6|2.0}}||AI special flag: set to 1 if engine is 'optimized' for passenger service (AI won't use it for other cargo), 0 otherwise||no
|-
|09||W||{{ottdp|0.6|2.0}}||Speed in mph*1.6 (see below)||no
|-
|0B||W||{{ottdp|0.6|2.0}}||Power (0 for wagons)||should be zero
|-
|0D||B||{{ottdp|0.6|2.0}}||Running cost factor (0 for wagons)||should be zero
|-
|0E||D||{{ottdp|0.6|2.0}}||Running cost base, see below||should be zero
|-
|12||B||{{ottdp|0.6|2.0}}||Sprite ID (FD for new graphics)||yes
|-
|13||B||{{ottdp|0.6|2.0}}||Dual-headed flag; 1 if dual-headed engine, 0 otherwise||should be zero also for front
|-
|14||B||{{ottdp|0.6|2.0}}||Cargo capacity||yes
|-
|15||B||{{ottdp|0.6|2.0}}||Cargo type, see [[CargoTypes]] 
{{grfTill|7}} For GRF version 7 and below: Type B 'cargo slot' 
{{grfFrom|8}} For GRF version 8 and above: Type A '(translated) cargo bit' 
{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.
||yes
|-
|16||B||{{ottdp|0.6|2.0}}||Weight in tons||should be zero
|-
|17||B||{{ottdp|0.6|2.0}}||Cost factor||should be zero
|-
|18||B||{{ottdp|<0.7|2.0}}<ref>This property is not used by OpenTTDs NoAI API.</ref>||Engine rank for the AI (AI selects the highest-rank engine of those it can buy)||no
|-
|19||B||{{ottdp|0.6|2.0}} {{grfFrom|1}}||Engine traction type (see below)||no
|-
|1A||B/B*<ref>{{ottdp|0.7|no|ottdrev=r13831}} Since OpenTTD r13831 this is an extended byte.</ref>||{{ottdp|0.6|2.0}} {{grfFrom|1}}||Not a property, but an action: sort the purchase list.||no
|-
|1B||W||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Power added by each wagon connected to this engine, see below||should be zero
|-
|1C||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Refit cost, using 50% of the [[BaseCosts|purchase price cost base]]||yes
|-
|1D||D||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Bit mask of cargo types available for refitting, see column 2 (bit value) in [[CargoTypes]]. Obsoleted by properties 2C/2D||yes
|-
|1E||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Callback flags bit mask, see below||yes
|-
|1F||B||{{ottdp|0.6|2.5|ttdprev=alpha 19}}||Coefficient of tractive effort||should be zero
|-
|20||B||{{ottdp|1.1|2.5|ttdprev=alpha 27}}||Coefficient of air drag||should be zero
|-
|21||B||{{ottdp|0.6|2.0}} {{grfFrom|2}}||Make vehicle shorter by this amount, see below||yes
|-
|22||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Set visual effect type (steam/smoke/sparks) as well as position, see below||yes
|-
|23||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Set how much weight is added by making wagons powered (i.e. weight of engine), see below||should be zero
|-
|24||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||High byte of vehicle weight, weight will be prop.24*256+prop.16||should be zero
|-
|25||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||User-defined bit mask to set when checking veh. var. 42||yes
|-
|26||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||Retire vehicle early, this many years before the end of phase 2 (see [[Action0General]])||no
|-
|27||B||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Miscellaneous flags||partly
|-
|28||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Refittable cargo classes||yes
|-
|29||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Non-refittable cargo classes||yes
|-
|2A||D||{{ottdp|0.6|2.5|ottdrev=r7191|ttdprev=r1210}}||Long format introduction date||no
|-
|2B||W||{{ottdp|1.2|no|ottdrev=r22713}}||Custom cargo ageing period||yes
|-
|2C||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of always refittable cargo types||yes
|-
|2D||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of never refittable cargo types||yes
|-
|2E||W||{{ottdp|12|no|ottdrev=g2183fd4dab}}||Maximum curve speed modifier||yes
|-
|2F||W||{{ottdp|13|no}}||Vehicle variant group||no
|-
|30||D||{{ottdp|13|no}}||Extra flags||??
|-
|31||B||{{ottdp|14|no|ottdrev=g2d73076056}}||Additional callback flags bit mask, see below||yes
|-
|32||W||{{ottdp|15|no|ottdrev=gd2496b6ec4}}||Cargo classes required for refittability||yes
|-
|33||W n*W||{{ottdp|15}}||List of badges||??
|}
<references/>

= Description =

== Track type (05) ==
Set track type of vehicle: 0 = rail, 1 = monorail, 2 = maglev. For setting the appropriate traction type, see [[Action0Trains#Engine traction type 19|prop19]].

{{ottdp|1.0|no}} In OpenTTD, if a [[Action0Railtypes|rail type]] translation table is loaded, this property is an index into the table instead.

== Speed (09) ==

Train speed is in units of mph*1.6, i.e. approximately km/h.

For wagons, this value is only used if the "wagonspeedlimit" switch is on, and it limits the speed of the train to that of the lowest wagon speed.  This limit is ignored for wagons with a livery override for the current train, so that train sets always get their max speed from the engine's max speed.

For wagons, a value of 0 means "default" (which depends on cargo type and date of introduction), and FFFF means no limit.

== Power (0B) ==

The power of the engine, in HP.

A value of 0 means that the vehicle will be a wagon, otherwise it will be an engine.

== Running cost base (0E) and factor (0D) ==

TTD calculates all costs by multiplying a 32-bit [[BaseCosts|base amount]] with an 8-bit factor.  The base amount is changed according to inflation, whereas the factor remains constant.

For the running costs of train vehicles, the following base amounts are available depending on the vehicle type (the value here is a pointer into TTD's memory where the actual amount is stored):

{| |-
!Type!!Value!!in little-endian notation
|-
|Steam engines||4C30||30 4C 00 00
|-
|Diesel engines||4C36||36 4C 00 00
|-
|Electric engines||4C3C||3C 4C 00 00
|-
|Wagons||0||00 00 00 00
|}

Theoretically, you could use pointers to other base amounts available in TTD, but these are the numbers TTD uses for train vehicles.

The following are some real values for maintenance costs depending on the setting of the above two factors.  This value is correct for medium difficulty, but increases and decreases for hard and easy difficulties respectively.  These are the costs of a new game starting in 1921, because they obviously increase with inflation over time (unless noinflation is turned on).

'''Running cost base 4C30 (steam)'''

{| |-
!Running cost factor!!Maintenance cost
|-
|01||$ 42
|-
|10||$ 700
|-
|20||$ 1.400
|-
|80||$ 5.600
|-
|A0||$ 7.000
|-
|FF||$ 11.112
|}

'''Running cost base 4C36 (diesel)'''

{| |-
!Running cost factor!!Maintenance cost
|-
|01||$ 40
|-
|10||$ 650
|-
|20||$ 1.300
|-
|80||$ 5.200
|-
|A0||$ 6.500
|-
|FF||$ 10.318
|}

'''Running cost base 4C3C (electric)'''

{| |-
!Running cost factor!!Maintenance cost
|-
|01||$ 36
|-
|10||$ 600
|-
|20||$ 1.200
|-
|80||$ 4.800
|-
|A0||$ 6.000
|-
|FF||$ 9.524
|}

== Cost factor (17) ==

The cost factor is a bit-coded value which determines how expensive an engine is. There is no distinction between steam, diesel or electric engines, they all use the same cost factor. The table below gives you some values to use for finding the right price for your engines.

{| |-
!Cost factor!!Price
|-
|01||$ 3.124
|-
|10||$ 50.000
|-
|20||$ 100.000
|-
|80||$ 400.000
|-
|A0||$ 500.000
|-
|FF||$ 796.874
|}

== Engine traction type (19) ==

This sets the traction type of a train engine, i.e. whether it is powered by steam, diesel, electric, monorail or maglev technology.  It also sets the corresponding sound effect of the engine, and if property 22 is not set, the visual effect as well.

The following ranges are available (and it does not matter which value you pick):

{| |-
!Values!!Traction type
|-
|00..07||Steam
|-
|08..27||Diesel
|-
|28..31||Electric
|-
|32..37||Monorail
|-
|38..41||Maglev
|}
Default value is 00, i.e. steam. For setting the appropriate track type, see [[Action0Trains#Track type 05|prop05]].

{{ottdp|1.1|no}} In OpenTTD, if a [[Action0Railtypes|rail type]] translation table is loaded, setting this property does NOT alter the track type.

== Sort vehicle list (1A) ==

This is not a property as such, but an action.  It forces TTDPatch to shuffle the vehicle this "property" is being set for in front of the vehicle with the given value of the property.  The order of this list is only used in the train purchase window.

For example, setting prop. 1A for vehicle 09 to a value of 07 would lead to the following internal list: ... 05 06 09 07 08 0A 0B ...

This property can not simply be overwritten, because the list is already shuffled when trying to do so.

{{ottdp|no|2.0}} It is possible to reset the list to its original order with a special action 0 that has num-info set to 0, and only sets property 1A for trains:
<pre>00 00 01 00 00 1A</pre>

Resetting the list should however only be done by sets that contain replacements for all train vehicles.

{{ottdp|0.7|no|ottdrev=r13831}} This property is an extended byte in OpenTTD since r13831!

== Powered train wagons (1B and 23, see also 22) ==

Normally, train wagons are unpowered in TTD, and if you set property 0B to a non-zero value, they become engines instead.  Therefore, to model real-life trains where wagons have power, a different mechanism is needed.
To make train wagons powered, you set property 1B of the '''engine''' instead of the wagon. This determines how much power each wagon adds to the train when attached to this engine. This only applies to wagons with a [[Action3|graphics override]] for this engine as well.  This means that for example passenger wagons (with an override) will add power, but coal wagons (with no override) will not.

In addition to adding power, these wagons are also heavier by the amount set in property 23.

== Refit cost (1C) ==

Refit cost, using 50% of the [[BaseCosts|purchase price cost base]]. This property can be overridden by callback 15E.

{{ottdp|1.2|no|ottdrev=r23087}} If the refit cost factor is set to zero and bit 4 of the miscellaneous flags (27) is set, auto-refitting is allowed.

== Callbacks (1E, 31) ==
For trains, the following [[callbacks]] have to be enabled by setting the corresponding bit in properties 1E and 31 (certain other, not as frequently used callbacks are available without setting a bit here):

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|0||1||10||Powered wagons and visual effect
|-
|1||2||11||Wagon length
|-
|2||4||12||Load amount
|-
|3||8||15||Set refitted capacity
|-
|4||10||16||Build articulated engines
|-
|5||20||19||show a suffix after the cargo type name
|-
|6||40||2D||Select color mapping for vehicle
|-
|7||80||33||Sound effect callbacks
|-
|8||100||161||{{ottd|14|ottdrev=gf5394ed2ef}}Engine name
|-
|9||200||163||{{ottdp|15|no|ottdrev=gd2496b6ec4}}Custom refit
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the VarAction2 for callbacks.

These callbacks do not need a bit to activate them, they are always active and will be used if defined in the action 3/action 2 chain.
{| |-
!Variable 0C value!!Callback
|-
|1D||Can wagon be attached
|-
|23||Additional text in purchase screen
|-
|31||Start/stop check
|-
|32||32-day callback
|-
|36||Change Vehicle Properties
|-
|15E||Refit cost
|}

== Coefficient of tractive effort (1F) ==

This cofficient sets what fraction of the vehicle weight is equal to the maximum tractive effort.  This includes the effect of having some unpowered axles, as well as the coefficient of friction that is available.

Theoretically, this value should be calculated by taking the ratio of adhesive weight Wadh (i.e. the vehicle weight that rests on powered axles) times the coefficient of friction µ between the wheels and the rails to the total vehicle weight W, times 255, and convert to hex:

prop. 1F = HEX ((Wadh * µ / W) * 255)

With prop. 1F having a value of FF, the tractive effort is equal to the vehicle weight, for 80, it is half, and so on. If not set, a default of 4C is used, for a fraction of 0.30, corresponding to Wadh=W and a coefficient of friction of 0.30, which is the value used by the patch before TTDPatch 2.0.1 alpha 19.

Sometimes you know the real-life tractive effort instead of adhesive weight and coefficient of friction. To help calculating prop. 1F in that case, here's a small example using the NS 1600 (Electric) with a mass of 84 tons and real-life tractive effort (TEreal) of 259 kN. To quickly find the value for property 1F you fill in the following formula:

prop. 1F = HEX ((TEreal / (Mass * g) * 255)

That may look confusing but you already know all variables:

prop. 1F = HEX ((259 / (84 * 9.8) * 255)

prop. 1F = HEX (0.3146 *255) = HEX(80.229)

HEX calculations only work with figures in the natural domain: each figure has to be a positive and round figure. Therefore the value you convert to HEX isn't 80.229 but 80:

HEX 80 = 50

Property 1F for the NS 1600 (Electric) would then be: 1F 50.

== Coefficient of air drag (20) ==

This property sets the air drag coefficient c2 used for the realistic acceleration model, from 01 (no airdrag) to FF (most air drag) in arbitrary units. 00 means to use the default value that depends on the top speed (to simulate the fact that high-speed engines are more streamlined).

The default values are the following:

{| |-
!top speed (mph/1.6)!! <16!! 16!! 24!! 32!! 48!! 64!! 96!! 128!! 192!! 256!! ...
|-
|c2|| 192|| 128|| 96|| 64|| 48|| 32|| 24|| 16|| 12|| 8
|}

For higher speeds, the series is continued in the same manner.

Air drag in Newtons will then be c2*v*v with v in m/s, although it is probably futile to attempt to make c2 a realistic number due to the lack of TTD's consistent scaling. If a train doesn't reach its historical top speed, you might try setting the value of prop. 20 one or two steps lower than the default above, otherwise it's probably a good idea to leave it at the default.

== Shorter train vehicles (21) ==

This property reduces the length of train vehicles, in units of 1/8th (12.5%). The value 00 means the vehicle has the full length, 01 means shorter by 1/8th (12.5%), up to 05=shorter by 5/8ths (62.5%). Larger numbers will not work properly
<ref>{{ottdp|1.0|no|ottdrev=r15793}} This restriction has been removed in OpenTTD r15793. Every vehicle can have a length between 1/8 and 8/8 independent of its position in the chain.</ref>,
except at the end of the train
<ref>{{ottdp|<1.0|}} This means that it is only safe to use values larger than 05 in the length callback making sure that they are only returned for the very last vehicle in the train. Otherwise the train will occasionally fall apart, with the wagons after the shortest one stopping to move.</ref>. The vehicle length is set whenever it leaves a depot. This property does not work for the first vehicle in a train (i.e. the engine).

<references/>

== Visual effects and wagon power (22) ==

By default, the visual effect of train engines is determined by the traction type (property 19). With this option you can change the type of effect as well as the position of it relative to the vehicle. (Note: for TTDPatch and OpenTTD up to r21229 only the positioning of steam actually works. For {{ottdp|1.1|no|ottdrev=r21230}} positioning diesel smoke and electric sparks works as well) The position of the effect provides a range from 0 to F that is added to the type of the effect.

Position 0 corresponds to a point half a vehicle length ahead of the vehicle, 4 is the front of the vehicle, 8 the middle, C the end and F is a half length behind the vehicle. Intermediate values are in-between.

Additionally, this property can be used to disable powered wagons of this type, although that is usually done with [[Callbacks#Visual_effect_and_wagon_power_.2810.29| callback 10]] instead (which has the same meaning as prop. 22, but is more flexible).

{| |-
!Range !!Effect type
|-
|00..0F||Use the default effect type, but reposition it. For engines this is defined via property 19, wagons have no default effect.
|-
|10..1F||Steam puffs
|-
|20..2F||Diesel fumes
|-
|30..3F||Electric sparks
|-
|40||Disable visual effect
|-
|41..7F||{{ottdp|1.5|no|ottdrev=r26747}} Create effects with [[Callbacks#Advanced_effect_creation_.28160.29|Callback 160]] using one of these spawning models:
* 41 Steam: Gradually less effects when approaching max speed
* 42 Diesel: Effect proportional to acceleration, no effect when idling at top speed
* 43 Electric: Random effect, gradually less likely when approaching max spped
* 44-7F Reserved
|-
|80+00..80+7F||Same as 00..7F above, but disable wagon power
|}

For example, 28 would make the wagon powered and emit diesel fumes, but 80+28 = A8 would only emit the diesel fumes without adding power.

== Miscellaneous flags (27) ==

This is a bit mask, with the following bits:

{| |-
!Bit!! Value!! Version !!Meaning
|-
|0|| 1||{{ottdp|0.6|2.5}}|| Vehicle tilts in curves, and thus gets speed bonus <ref>The tilting speed bonus only applies if all vehicles in the train have this bit set. In TTDPatch it requires the "curves" switch to be on. For realistic curves, it gives the train two free curving pieces with no speed decrease, and for other settings, it increases the curves setting by one (0->1, 1->2, 2->2). In OpenTTD, the curve speed limit increases by 20% if 'realistic' acceleration is enabled, else there is no effect.
</ref>
|-
|1|| 2||{{ottdp|0.6|2.5}}|| Uses two company colors
|-
|2|| 4||{{ottdp|0.6|2.5}}|| Vehicle is a multiple unit (DMU/EMU), for colour selection
|-
|3|| 8||Varies|| {{ottdp|1.1|no|ottdrev=r21966}}Vehicle can be flipped around in the depot. {{ottdp|13|no|no}}This flag is no longer required, vehicles can always be flipped.
<ref>From {{ottd|13|no}} onwards, OpenTTD will again allow all vehicles to flip, and will automatically adjust offsets accordingly. From {{ottd|13|no}}, if this flag is set, OpenTTD will not automatically apply the correct offsets for vehicles < 8/8 long, and will defer to offsets set by the grf. Do not set this flag unless you need it for a specific reason.
 
For {{ottd|1.1|r21966}} up to {{ottdp|12|no|no}} when you enable flipping of a vehicle in a depot you must make sure that the graphics are correctly aligned when flipped as well. Especially in the case of shortened vehicles.
 
Prior to {{ottd|1.1|r21966}} all non-multiheaded/non-articulated vehicles would be able to flip around in the depot. As such {{ottd|1.1|r21966}} disables a "feature" in OpenTTD, but often it makes no sense to flip vehicles around (symetric vehicles) or the graphics are wrong (most shortened vehicles), and thus only enabling this when the NewGRF developer says it is possible is better.
 
For all relevant OpenTTD versions, the flipping bit has no effect for multiheaded or articulated vehicles as they cannot be flipped in depot.
</ref>
|-
|4|| 10||{{ottdp|1.2|no|ottdrev=r23087}}|| Auto-refitting is enabled for refits where callback 15E allows it or prop 1C specifies zero cost
|-
|5|| 20||{{ottdp|1.2|no|ottdrev=r23861}}|| Use cargo multiplier for default cargo (and load amount). See page about [[VehicleRefitting#Misc._vehicle_flag_5_.27use_of_capacity_multiplier_for_default_cargo.27_set|vehicle refitting]].
|-
|6|| 40||{{ottdp|1.3|no|ottdrev=r24124}}|| Disable breakdown smoke effect.
|-
|7|| 80||{{ottdp|1.7|no|ottdrev=r27668}}|| [[Action2/Vehicles#Composing_vehicles_from_multiple_sprites|Compose vehicle from multiple sprites.]]
|}

<references />

== Cargo classes (28, 29, 32) ==

To make vehicle sets more compatible with future new cargo definitions, these three properties allow vehicles to define what type of cargo they should be refittable to. A wagon will be refittable to all cargo types that match any of the classes set in prop. 28 ''and'' have all of the classes set in prop. 32, except for the ones that match any of the classes set in prop. 29. In addition, afterwards those cargo types listed in prop. 1D will be toggled. In terms of logic, it is

Refit list = (cargos from prop. 28 filtered by prop. 32 AND NOT cargos from prop. 29) XOR cargos from prop. 1D

This means, if a cargo type is in the list because it matches props 28/31 but not prop 29, having the respective bit set in prop. 1D will disable it again. Conversely, if the cargo type is not in the list, the bit in prop. 1D will add it. This way, if props. 28/29 are unset, prop. 1D will retain the original meaning, but it is still able to selectively add or remove certain cargo types even if props. 28/29 are used.

As a consequence, you have both full control over the cargo types that you know of (using prop. 1D), and those you don't know of yet (using props. 28/29). Leave the bits for cargos that you don't know of unset in prop. 1D, and set/clear the bits for known cargos to add/remove them from the list as appropriate.

{{ottd|1.2|r23291}} It is recommended to use properties 2C and 2D instead of property 1D, as property 1D behaves badly if the cargo classes of a cargo are ever changed.

The class list is a bit mask. See the action0 cargos page for bits and classes defined so far.

Take a look at [[Action0Cargos#Cargo classes 16|Action0 for cargos]] for the classes defined so far.

Note that cargo types may belong to several classes. This is the reason for making three properties, an additive, a filter, and a subtractive one, because this way a vehicle can be specified to be refittable to, for example, all express cargo that does not require refrigeration (i.e., from the default cargos, no food).
For the cargo types added in this way, the vehicle will probably have no specific graphics (in [[Action3|action 3]]) to show the cargo load.  In this case, the default will be used, which should therefore be sufficiently generic-looking if possible. However, using [[VariationalAction2/Vehicles#Vehicle cargo info 47|vehicle variable 47]] you can at least select the graphics most appropriate for the cargo type's class.
About the interaction with other properties take a look at the summary page about [[VehicleRefitting|vehicle refitting]].

Disclaimer: there is no guarantee that classes won't vary over time or between sets. The classes of a cargo may change between different versions of a specific industry/cargo newgrf, or different classes may be set for the same cargo label by different industry/cargo newgrfs. Feel free to use classes in your set for conveniently refitting to cargos, but if you - the vehicle author - care about specific cargos being transported in specific vehicles, use label based refits (changing labels without a very good reason is considered to be bad practice).

== Long format introduction date (2A) ==

Set the vehicle introduction date, in days since the year 0. This takes account of leap years; dividable by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). This property must be set after property 00 to take effect.

{{ottdp|no|}} In TTDPatch, dates after 2044 will be limited to 2044.

== Custom cargo ageing period (2B) ==

This property allows to modify the period in ticks after which cargo carried by the vehicle is aged. By default, cargo is aged every 185 ticks. A value of 0 disables ageing of cargo. This property can be modified via [[Callbacks#Change_vehicle_properties_.2836.29|callback 36]].

Changing this value from the default does not automatically make the vehicle earn more or less. Predicting the effect is complicated, as it depends on many things, including: vehicle speed, route length, route delays, transfer credits, the payment curve set by the cargo, and whether the cargo is already aged from a previous transfer when the vehicle loads it.

Authors are advised that tests show this property can lead to disappointment. Avoid, or use with caution.

== List of always refittable cargo types (2C, 2D) ==

These two properties allows to unconditionally include or exclude cargo types for refittability independent of any of the other refit properties or the cargo classes. If you specify a cargo type that is not available, the cargo type will be silently ignored.

The format for both properties is:

<pre>2C/2D <nvar> (<Index into cargo type table>){n}</pre>

That is you give the number of cargos in a single byte followed by a list of that length of indexes into the cargo translation table ([[CargoTypes|Type A]]).

== Maximum curve speed modifier (2E) ==

This property allows to give vehicles a maximum curve speed modifier. The given value is treated as a signed word with 8 fractional bits. This property can be modified via [[Callbacks#Change_vehicle_properties_.2836.29|callback 36]].

The modifier is applied after the normal curve speed calculation is done using the formula max_curve_speed * (1 + prop 2E). This means that the default property value of 0 is equivalent to no change. While values less than -1.0 are technically possible, the resulting vehicle curve speed is clamped at 2 mph-ish to make sure vehicles don't become permanently stuck.

If different vehicles in a train have different curve speed modifiers, the lowest value wins.

== Vehicle variant group (2F) ==

This property supports grouping vehicles in the purchase menu (also the autoreplace menu). The property value is the ID of another vehicle in the same GRF which will act as the parent for vehicles in the group.

Groups can also be nested (this is experimental as of December 2022 and may change with testing).

See also [[Action0Trains#Extra flags (30)|vehicle extra flags]] which can influence the behaviour of vehicles in variant groups.

See also https://github.com/OpenTTD/OpenTTD/pull/10220

== Extra flags (30) ==

This is a bit mask, with the following bits:

{| |-
!Bit!! Value!! Version !!Meaning
|-
|0|| 1||{{ottdp|13|no}}|| Disable "New Vehicle" news message for this engine
|-
|1|| 2||{{ottdp|13|no}}|| Disable "Exclusive Preview" for this engine
|-
|2|| 4||{{ottdp|13|no}}|| Variants - Include this variant when primary engine has "Exclusive Preview"
|-
|3|| 8||{{ottdp|13|no}}|| Variants - (Attempt to) Synchronize reliability the primary engine
|-
|}

== Extra callback flags (31) ==

See [[#Callbacks_.281E.2C_31.29]]

= Example =

Below is an example of what a real Action 0 pseudo-sprite could look like for a train engine.

(A basic version)

<pre>10 * 14  00 00 03 01 02 09 C0 00 0B D8 0E 12 FD</pre>

{| |-
!'''Bytes'''!!'''Meaning'''
|-
|10||<Sprite-number>
|-
|14||<Length>: of the action in bytes; start counting at 0 (<action>)
|-
|00||<action>: sets this pseudo-sprite to function as action 0
|-
|00||<Feature>: In this case Train
|-
|03||<Num-props>: 3 Properties to change
|-
|01||<Num-info>: 1 vehicle ID to make changes to
|-
|02||<ids...>: vehcile ID (02 - Ploddyphut Choo-Choo)
|-
|||'''Properties'''
|-
|09||<Speed>
|-
|C0 00||<Value>: Value for Speed (192 Km/h)
|-
|0B||<Power>
|-
|D8 0E||<value>: value for Power (3800 HP)
|-
|12||<Sprite ID>
|-
|FD||<value>: FD for new graphics
|}
Since nfo version 7, so-called [[GRFActionsDetailed#Byte order|"escape sequences"]] have been introduced in an attempt to offer a more human-readable form.

Below is the same example as above, with escape sequences being used:

<pre>-1 * 0 00 00 \b3 01 \b*2 // \b<number of props to change> \b*<vehicle ID>

       09 \w192 // value for speed (192 Km/h)

       0B \w3800 // value for power (3800 hp)

       12 FD // use new graphics</pre>

Action0/Badges

2025-02-17T14:48:56Z

Peter1138:

Action0/Badges

2025-02-17T13:33:38Z

Peter1138: Created page with '''''''Action 0 properties for badges'''''' = Action 0 - Properties for badges = Defining properties of badges. == Properties == {| class="wikitable" |- !'''Number''' !'''V...'

Main Page

2025-02-17T13:26:17Z

Peter1138: /* Sprite types */

== Sprite types ==
;[[Action0]] - Defines new properties for anything added or changed by the NewGRF
:{| |-
|rowspan="5" 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]]
| [[Action0/Roadtypes | Roadtypes]]
|-
| [[Action0/Tramtypes | Tramtypes]]
| [[Action0/Road Stops| Road Stops]]
| [[Action0/Badges | Badges]]
| ''Towns''
|
|}
;[[Action1]] - Defines one or more graphics sets
;[[Action2]] - Defines graphics set IDs
* Basic Action2
:{| |-
|rowspan="5" 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]]
| [[Action2/Single Set | Roadtypes]]
|-
| [[Action2/Single Set | Tramtypes]]
| [[Action2/Sprite Layout | Road Stops]]
| [[Action2/Single Set | Badges]]
| ''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="5" 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/Roadtypes | Roadtypes]]
|-
| [[VariationalAction2/Tramtypes | Tramtypes]]
| [[VariationalAction2/Road Stops | Road Stops]]
| [[VariationalAction2/Badges | Badges]]
| [[VariationalAction2/Towns | Towns]]
|
|}
* [[RandomAction2]] - A randomized Variational Action 2
:{| |-
|rowspan="5" 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]]
| [[RandomAction2#Road_types | Roadtypes]]
|-
| [[RandomAction2#Tram_types | Tramtypes]]
| [[RandomAction2#Road_stops | Road Stops]]
| ''Badges''
| ''Towns''
|
|}

* [[Callbacks]] - List of available callbacks

;[[Action3]] - Associates Action 2s with an Action 0
:{| |-
|rowspan="5" 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]]
| [[Action3/Roadtypes | Roadtypes]]
|-
| [[Action3/Tramtypes | Tramtypes]]
| [[Action3 | Road Stops]]
| [[Action3/Badges | Badges]]
| ''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
* [[NML:Default_Vehicle_Properties]] - Default Vehicle Properties (NML)
* [[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
* [[TracktypeLabels | Rail/road/tram type labels]] - Commonly used labels for rail/road/tram types

== 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]]
* [[Version numbers | Types of version numbers used throughout the specs]]
* [[DebuggingGRFCode | Debugging NewGRFs]]
* [[SpriteErrors | TTDPatch error codes on loading NewGRFs]]

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

Main Page

2025-02-17T13:25:33Z

Peter1138: /* Sprite types */

== Sprite types ==
;[[Action0]] - Defines new properties for anything added or changed by the NewGRF
:{| |-
|rowspan="5" 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]]
| [[Action0/Roadtypes | Roadtypes]]
|-
| [[Action0/Tramtypes | Tramtypes]]
| [[Action0/Road Stops| Road Stops]]
| [[Action0/Badges | Badges]]
| ''Towns''
|
|}
;[[Action1]] - Defines one or more graphics sets
;[[Action2]] - Defines graphics set IDs
* Basic Action2
:{| |-
|rowspan="5" 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]]
| [[Action2/Single Set | Roadtypes]]
|-
| [[Action2/Single Set | Tramtypes]]
| [[Action2/Sprite Layout | Road Stops]]
| ''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="5" 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/Roadtypes | Roadtypes]]
|-
| [[VariationalAction2/Tramtypes | Tramtypes]]
| [[VariationalAction2/Road Stops | Road Stops]]
| [[VariationalAction2/Badges | Badges]]
| [[VariationalAction2/Towns | Towns]]
|
|}
* [[RandomAction2]] - A randomized Variational Action 2
:{| |-
|rowspan="5" 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]]
| [[RandomAction2#Road_types | Roadtypes]]
|-
| [[RandomAction2#Tram_types | Tramtypes]]
| [[RandomAction2#Road_stops | Road Stops]]
| ''Badges''
| ''Towns''
|
|}

* [[Callbacks]] - List of available callbacks

;[[Action3]] - Associates Action 2s with an Action 0
:{| |-
|rowspan="5" 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]]
| [[Action3/Roadtypes | Roadtypes]]
|-
| [[Action3/Tramtypes | Tramtypes]]
| [[Action3 | Road Stops]]
| [[Action3/Badges | Badges]]
| ''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
* [[NML:Default_Vehicle_Properties]] - Default Vehicle Properties (NML)
* [[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
* [[TracktypeLabels | Rail/road/tram type labels]] - Commonly used labels for rail/road/tram types

== 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]]
* [[Version numbers | Types of version numbers used throughout the specs]]
* [[DebuggingGRFCode | Debugging NewGRFs]]
* [[SpriteErrors | TTDPatch error codes on loading NewGRFs]]

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

Action11

2025-01-06T15:53:37Z

Peter1138: /* Description */

==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 use WAV format, PCM encoding:
* mono
* 8-bit or {{ottdp|1.0|no}} 16-bit
* 11025 Hz, 22050 Hz, or {{ottdp|1.0|no}} 44100 Hz <ref>Technically OpenTTD 0.6 already supported resampling of any sample rate, but playback only used 11025 Hz anyway. Since OpenTTD 1.0 the default playback rate is 44100 Hz.</ref>
When using [[Version_numbers#GRF_container_version|GRF container version 1]], the file size cannot exceed 64 kB.

{{ottdp|15}} Since OpenTTD 15, compressed sound effects are supported in Ogg Opus format, with no restriction on quality, bit depth or sample rate.

<references/>

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]

NML:Houses

2024-12-23T09:23:54Z

Peter1138: /* House IDs */

{{NMLNavPropVarCB}}
==House IDs==
House IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range. You should start your item definition with the 'substitute'-property, which allocates a new house. The value of this property should be the ID of a [[NML:List_of_default_house_properties|default house type]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).

{{ottdp|15}} Since OpenTTD 15 the allowed ID range is increased to 0..4095.

Although the majority of all original houses occupy a single tile, it is possible to define a larger house of up to 2x2 tiles. For this, you should set the fourth 'size' parameter in the item-block. Valid values are HOUSE_SIZE_XXX, XXX = <nowiki>[1X1 | 1X2 | 2X1 | 2X2]</nowiki>. This size should match the size of the substitute house type.

Note, setting the 4th parameter requires to also set the 3rd parameter. If you want automatic id assignment (mind the notes on the [[NML:Item|Item page]]), you need to set the 3rd parameter to -1. Example:
<pre style="color:blue">
item(FEAT_HOUSES, item_brewery, -1, HOUSE_SIZE_2X2) {
}
</pre>

===Multi-tile houses===
Internally, due to the way NewGRF houses work, a multi-tile house will occupy more than one item ID. If you assign item ID X to a house, item IDs X+1 (for a 2-tile house) and (X+1) .. (X+3) (for a 4-tile house) will also be used. Normally you don't have to care about this, but there are two exceptions:
* If you manually assign numeric ids to your houses. You are recommended to just set all ids to -1 and let NML figure it out for you.
* When working with several variables that work with house type IDs. Keep in mind that tiles of a multi-tile house may have IDs X .. X + N - 1, with X being the assigned id and N the number of house tiles.

==House properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| substitute
| 0 ... 109
| Number of the default house that replaces this one, if this house is not available for some reason. '''This property ''must'' be set first, before any other properties or graphics.''' All properties of the old type are copied to your new house, except for the church / stadium flags (see below). The old house must have the same size as the new house, see the list of [[NML:List_of_default_house_properties|default house types]] for a list of possible substitute IDs.
|-
| name
| string
| for example string(STR_NAME_EIFFEL_TOWER)
|-
| override
| 0 ... 109
| id of the default house which this house replaces (and thus disabling the default). This is ignored, if the default house has already been overridden (disabling it another time is pointless). You can define this property multiple times. Your house and the overridden house must have the same size, see the list of [[NML:List_of_default_house_properties|default house types]].
|-
| building_flags.
| bitmask(HOUSE_FLAG_XXX,...)
|
;HOUSE_FLAG_NOT_SLOPED
:Can only be built on flat terrain. Note that 2x2 buildings will always only be built on flat land, even if this bit isn't set.
;HOUSE_FLAG_ANIMATE
:Enable animation unconditionally on (the beginning of) construction. If not set, animation can still be started (conditionally) via the callbacks <code style="color:darkgreen">anim_control</code>, <code style="color:darkgreen">construction_anim</code> or <code style="color:darkgreen">watched_cargo_accepted</code>.
;HOUSE_FLAG_CHURCH
:House is a church (only 1 will be built per town)
;HOUSE_FLAG_STADIUM
:House is a stadium (only 1 will be built per town)
;HOUSE_FLAG_ONLY_SE
:Can only be built in the scenario editor
;HOUSE_FLAG_PROTECTED
:Will not be removed by the game
;HOUSE_FLAG_SYNC_CALLBACK
:Animation callback <code style="color:darkgreen">anim_control</code> is called at the same time for all tiles.
;HOUSE_FLAG_RANDOM_ANIMATION
:Enable random bits in the <code style="color:darkgreen">anim_next_frame</code>-callback.
|-
| population
| 0 ... 255
| Number of inhabitants the building adds to the town, if present. This also affects how many passengers the house generates, unless the <code>cargo_production</code> callback is used.
|-
| mail_multiplier
| 0 ... 255
| Affects how much mail the building generates. Not used if the <code>cargo_production</code> callback is used.
|-
| accepted_cargos
| Array with up to 3 [cargo_id, amount]-pairs.
{{nml|0.5}}{{ottdp|1.9|no}} Array with up to 16 [cargo_id, amount]-pairs.
| The cargos that are accepted by each tile of the house. CargoID is a cargo type from your cargo translation table, amount is the acceptance of the given cargo in 1/8 units. Example: to make a tile fully accept both PASS and MAIL you could use this: <code style="color:darkgreen"><nowiki>accepted_cargos: [[PASS, 8], [MAIL, 8]];</nowiki></code> Example: for a house tile that doesn't accept any cargos at all you'd use: <code style="color:darkgreen">accepted_cargos: [];</code>
|-
| local_authority_impact
| 0 ... 65525
| amount of happiness decrease of the city council, if the building is destroyed. Town ratings can vary between -1000 (appalling) and +1000 (outstanding).
|-
| removal_cost_multiplier
| 0 ... 255
|
|-
| probability
| 0 ... 15 (float)
| Probability with respect to the default houses (=1). Mind that these are relative probabilities with respect to all houses defined. If all probabilities are defined as 16, they'll all have the same probability as if they had all a probability of 1.
|-
| years_available
| array of two int
| [xx, yy] where xx and yy indicate the introduction year and the last year the building can be built
|-
| minimum_lifetime
| 0 ... 255
| number of years the building will remain at least
|-
| availability_mask
|
[bitmask([[NML:List of town zones|town zones]]), bitmask(CLIMATE_XXX, ...)]
|
An array with two bitmasks, the first bitmask is a mask of town zones where this house is available. The second bitmask is a mask of climates combined with the special value ABOVE_SNOWLINE which you need to set for houses available in the arctic climate above the snowline. Examples:

* Available in the centre town zone in toyland only: <code>[bitmask(TOWNZONE_CENTRE), bitmask(CLIMATE_TOYLAND)]</code>
* Available in all town zones in the arctic climate both above and below the snowline: <code>[ALL_TOWNZONES, bitmask(CLIMATE_ARCTIC, ABOVE_SNOWLINE)]</code>
* Available everywhere except on the town edge: <code>[ALL_TOWNZONES & ~bitmask(TOWNZONE_EDGE), ALL_CLIMATES | bitmask(ABOVE_SNOWLINE)</code>
|-
| callback_flags
| bitmask(HOUSE_CBF_XX)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| random_colours
| array of 4, each COLOUR_XXX
|
colour values in an array, refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for a list of possible values.
|-
| refresh_multiplier
| 0 ... 63
| Defines the frequency with which the tile will be re-randomized which has an impact for random animation. The tile will be processed by the periodic tile processing loop every (X + 1)*256 ticks, with X being the value of this property.
|-
| animation_info
| Array [ANIMATION_XXX, frame-count]
|
Type of animation and its length (1...128 frames):

;ANIMATION_LOOPING
;ANIMATION_NON_LOOPING
|-
| animation_speed
| 2 ... 16
|
Speed of animation, see [[NML:Animation speed|animation speed table]] for the meaning of the values.
|-
| building_class
| 0 .. 254
| An arbitrary number. You can check for the presence of buildings of the same class when building new buildings or using animation. Only the north tile of a multi-tile building is assigned a class.
|
|-
| watched_cargo_types
| array of values from your [[NML:Cargotable|cargo table]]
| {{ottdp|1.2|2.6|ottdrev=r23072|ttdprev=r1677}}List of cargo types to watch, to be used with the <code style:darkgreen>watched_cargo_accepted</code> callback.
|}

==House variables==

{| class="wikitable sortable"
! name
! value range
! comment
|-
| construction_state
| 0..3
| Current construction state of the house tile. 0..2 = under construction, 3 = finished.
|-
| pseudo_random_bits
| 0..3
| Some pseudo-random bits, based on the tile position. TTD houses use this to randomize their appearance.
|-
| random_bits
| 0..255
| 8 random bits, also used for [[NML:Random_switch|random switch]]-blocks. Initially these are the same for all tiles of a multi-tile house.
|-
| age
| 0..255
| Age of the house in years, limited to 255
|-
| town_zone
| [[NML:List of town zones|town zone]]
| The town zone of the current tile
|-
| terrain_type
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| same_house_count_town
| 0..255
| Number of the houses with the same ID in the same town as this house
|-
| same_house_count_map
| 0..255
| Number of the houses with the same ID on the entire map
|-
| same_class_count_town
| 0..255
| Number of the houses with the same <code style="color:darkgreen">building_class</code> in the same town as this house. The class of the north tile of the use is used for this purpose, as other tiles don't normally have a class.
|-
| same_class_count_map
| 0..255
| Number of the houses with the same <code style="color:darkgreen">building_class</code> on the entire map. The class of the north tile of the use is used for this purpose, as other tiles don't normally have a class.
|-
| generating_town
| [0 <nowiki>|</nowiki> 1]
| 1 a random town is currently being created, 0 otherwise. Note that while generating a random town, [[NML:Towns#Town variables|town variables]] <code style="color:darkgreen">population</code> and <code style="color:darkgreen">building_count</code> are incorrect. The population variable contains the population of buildings generated ''yet'', the final value may be larger. The building_count is surely higher than the final value will be.
|-
| animation_frame
| 0..255
| Current animation frame
|-
| x_coordinate
| 0..4095
| X-coordinate (top right -> bottom left) of the tile on the map
|-
| y_coordinate
| 0..4095
| Y-coordinate (top left -> bottom right) of the tile on the map
|-
| relative_x
| 0..1
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..1
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| house_tile
| HOUSE_TILE_XXX, XXX = <nowiki>[NORTH | EAST | WEST | SOUTH]</nowiki>
| What tile of a multi-tile house this is.
|-
| house_type_id
| 0..255
| Item ID of this house type, that was assigned to the item. See the note above about [[#Multi-tile houses|multi-tile houses]].
|}

The following variables require one or more arguments
{| class="wikitable sortable"
! name
! arguments
! value range
! comment
|-
| old_house_count_town
| ID of old house type (0..109)
| 0..255
| Number of old houses with a given ID in the same town as the current house
|-
| old_house_count_map
| ID of old house type (0..109)
| 0..255
| Number of old houses with a given ID on the whole map
|-
| other_house_count_town
| ID of house defined in this NewGRF (0..255)
| 0..255
| Number of houses with a given ID in the same town as the current house.
|-
| other_house_count_map
| ID of house defined in this NewGRF (0..255)
| 0..255
| Number of houses with a given ID on the whole map
|-
| other_class_count_town
| ID of house defined in this NewGRF (0..255)
| 0..255
| Number of houses, with the same class as the house with the given ID, in the same town as the current house
|-
| other_class_count_map
| ID of house defined in this NewGRF (0..255)
| 0..255
| Number of houses, with the same class as the house with the given ID, on the whole map
|-
| nearby_tile_slope
| x- and y-offset (both signed, range -8..7)
| SLOPE_XXX
| See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| nearby_tile_is_water
| x- and y-offset (both signed, range -8..7)
| [0 <nowiki>|</nowiki> 1]
| 1 if the tile is water, 0 otherwise
|-
| nearby_tile_terrain_type
| x- and y-offset (both signed, range -8..7)
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| nearby_tile_water_class
| x- and y-offset (both signed, range -8..7)
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| x- and y-offset (both signed, range -8..7)
| 0..255 (currently limited to 0..15)
| Height of the lowest corner of the tile. 1 unit is one height level of 8 pixels.
|-
| nearby_tile_class
| x- and y-offset (both signed, range -8..7)
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| x- and y-offset (both signed, range -8..7)
| 0..255
| Animation frame of the given tile
|-
| cargo_accepted_nearby_ever
| cargo type, x- and y-offset <ref name="cargo_accepted_nearby">Cargo type should be from your cargo translation table. X- and y-offset are optional, if provided both must be in range -128..127. A station is considered nearby if the tile is in the station's acceptance area. This is the purpose of the x- and y-offset, as other tiles may have other stations nearby.</ref>
| [0 <nowiki>|</nowiki> 1]
| 1 if the given cargo type was ever accepted at a nearby station, 0 otherwise
|-
| cargo_accepted_nearby_last_month
| cargo type, x- and y-offset <ref name="cargo_accepted_nearby" />
| [0 <nowiki>|</nowiki> 1]
| 1 if the given cargo type was accepted at a nearby station in the last month, 0 otherwise
|-
| cargo_accepted_nearby_this_month
| cargo type, x- and y-offset <ref name="cargo_accepted_nearby" />
| [0 <nowiki>|</nowiki> 1]
| 1 if the given cargo type was ever accepted at a nearby station in this month, 0 otherwise
|-
| cargo_accepted_nearby_last_bigtick
| cargo type, x- and y-offset <ref name="cargo_accepted_nearby" />
| [0 <nowiki>|</nowiki> 1]
| 1 if the given cargo type was ever accepted at a nearby station since the last periodic processing, which happens every 250 ticks. 0 otherwise
|-
| cargo_accepted_nearby_watched
| cargo type, x- and y-offset <ref name="cargo_accepted_nearby" />
| [0 <nowiki>|</nowiki> 1]
| 1 if the given cargo type was one of the cargo types that triggered the <code style="color:darkgreen">watched_cargo_accepted</code>-callback (only during this callback), 0 otherwise
|-
| nearest_house_matching_criterion
| radius (1..63) and criterion (SEARCH_HOUSE_BY_XXX, XXX = [<nowiki>TYPE | CLASS | GRFID</nowiki>])
| 1..63, or 0 if not found
| Perform a circular search for a house matching either the id, <code style="color:darkgreen">building_class</code> or GRFID of this house, depending on the second parameter. The first parameter specifies the maximum search radius. Return value is the Manhattan distance of the closest matching house tile, or 0 if no match was found. Note that tiles of the originating house never match. See also the note above about [[#Multi-tile houses|multi-tile houses]].
|-
| nearby_tile_house_id
| x- and y-offset (both signed, range -8..7)
| -1, or 0 .. 767
| Return value is -1 if the tile is not a house tile, X (0..255) if the tile contains old house type X, 256+X if the tile contains a house from this NewGRF with ID X, 512+X if the tile contains a house from a different NewGRF with ID X. See the note above about [[#Multi-tile houses|multi-tile houses]].
|-
| nearby_tile_house_class
| x- and y-offset (both signed, range -8..7)
| -1, 0, or 256 .. 767
| Return value is -1 if the tile is not a house tile, 0 if the house tile does not have a class (this includes all old house types), 256+X (X = 0..255) if the house has been defined by this NewGRF with <code style="color:darkgreen">building_class</code> X or 512+X if the house has been defined by a different NewGRF with <code style="color:darkgreen">building_class</code> X. Note that for a multi-tile house, generally only the north tile has a sensible class value.
|-
| nearby_tile_house_grfid
| x- and y-offset (both signed, range -8..7)
| -1, 0 or a GRFID
| Return value is -1 if the tile is not a house tile, 0 if the house tile contains an old house type, or else the GRFID of the NewGRF defining the house.
|}
<references/>

==House callbacks==
Unless noted otherwise, callbacks may be called for any of the tiles of a multi-tile house.

{| class="wikitable sortable"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Graphics for the house tile
|-
| graphics_xxx, xxx = <nowiki>[north | east | south | west]</nowiki>
| Sprite layout
| Tile-specific graphics for one of the tiles of a multi-tile house. Of course, this is callback is called for that tile only.
|-
| random_trigger
| N/A
|
See [[NML:Random switch|random switch]] for more information.
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played.
* <code>extra_callback_info1</code>: 32 random bits, if enabled in the <code>building_flags</code> property.
Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
| Called every 256 ticks. Return the animation frame to show, or CB_RESULT_XXX with XXX = <nowiki>[CB_RESULT_START_ANIMATION | STOP_ANIMATION | DO_NOTHING]</nowiki> to respectively start the animation in its current frame, stop the animation or do nothing. Returning a sound effect in the high byte will cause that sound effect to be played.
* <code>extra_callback_info1</code>: 32 random bits. The low 16 bits are always different for each house tile, but the high 16 bits are the same for each tile if synchronized animation is enabled in the <code>building_flags</code>-property.
Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
|-
| construction_anim
| Same as <code>anim_control</code>
| Works the same as the <code>anim_control</code> callback, except that it's called when the construction state changes.
|-
| watched_cargo_accepted
| Same as <code>anim_control</code>
| Works the same as the <code>anim_control</code> callback, except that it's called when one of the watched cargo types is accepted.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| cargo_type_accept
| type1 + (type2 << 5) + (type3 << 10)
| Decide the cargo types that this tile accepts. If this callback is not implemented or fails, the values from <code>accepted_cargo</code> are used instead. Bits 0..4: First cargo type. Bits 5..9: Second cargo type. Bits 10..14: Third cargo type.
|-
| cargo_amount_accept
| amt1 + (amt2 << 4) + (amt3 << 8)
| Acceptance for each cargo amount in 1/8th. If this callback is not implemented or fails, the values from the acceptance properties are used instead. Cargo types are from the <code>cargo_type_accept</code> callback, or the <code>accepted_cargo</code> property if that callback failed. Bits 0..3: Acceptance of first cargo type. Bits 4..7: Acceptance of second cargo type. Bits 8..11: Acceptance of third cargo type.
|-
| cargo_production
| (cargo_type * 256) + amount, or <code>CB_RESULT_HOUSE_NO_MORE_PRODUCTION</code>
| Called every 256 ticks. The return value specifies what cargo and what amount is produced. The callback is called multiple times until <code>CB_RESULT_HOUSE_NO_MORE_PRODUCTION</code> is returned.
* <code>getbits(extra_callback_info1, 0, 8)</code>: The number of iterations so far.
* <code>extra_callback_info2</code>: 32 random bits.
|-
| foundations
| CB_RESULT[_NO]_FOUNDATIONS
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.
|-
| autoslope
| CB_RESULT[_NO]_AUTOSLOPE
| Return CB_RESULT_AUTOSLOPE to allow autoslope (altering the ground below a tile) or CB_RESULT_NO_AUTOSLOPE to disallow it.
|-
| name
| String
| Name of the building (when using tile query tool)
|-
| colour
| Palette number
|
Used to recolour the building. See here [[NML:List of default colour translation palettes|here]] for an overview of default palettes.
|-
| construction_check
| 0 or 1
| Return 1 to allow building the house or 0 to disallow. Called only for the north tile.
|-
| destruction
| 0 or 1
| Called periodically. Return 0 to keep the building or 1 to destroy it. Called only for the north tile.
|-
| protection
| 0 or 1
| Return 0 to allow destruction, or 1 to disallow
|}

Action0/Houses

2024-12-23T09:22:53Z

Peter1138: /* Introduction */

== Introduction ==

For town buildings (or simply houses), the offset defines the first house ID for this action 0. House IDs, like station IDs, are unique within each grf file, and in total each game can only have 255 IDs in TTDPatch and 512 IDs in OpenTTD for all active grf files.

{{ottdp|15}} Since OpenTTD 15, the limits are increased to 4096 IDs, both per-grf and in total.

To start using a house ID, you must first define it by setting its property 08 (see below). If you try to modify a house ID whose property 08 isn't set, your request is ignored, but not reported as an error, either.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Substitute building type
|-
|09||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building flags
|-
|0A||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Availability years
|-
|0B||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Population
|-
|0C||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Mail generation multiplier
|-
|0D||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Passenger acceptance
|-
|0E||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Mail acceptance
|-
|0F||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Goods, food or fizzy drinks acceptance
|-
|10||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||LA rating decrease on removal (should be set to the same value for every tile for multi-tile buildings)
|-
|11||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Removal cost multiplier (should be set to the same value for every tile for multi-tile buildings)
|-
|12||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building name ID
|-
|13||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building availability mask
|-
|14||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||House callback flags
|-
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||House override byte
|-
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Periodic refresh multiplier
|-
|17||4*B||{{ottdp|0.6|2.5|ttdprev=alpha 35}}||Four random colours to use
|-
|18||B||{{ottdp|0.6|2.5|ttdprev=alpha 35}}||Relative probability of appearing
|-
|19||B||{{ottdp|0.6|2.5|ttdprev=alpha 38}}||Extra flags
|-
|1A||B||{{ottdp|0.6|2.5|ttdprev=alpha 39}}||Animation frames
|-
|1B||B||{{ottdp|0.6|2.5|ttdprev=alpha 39}}||Animation speed
|-
|1C||B||{{ottdp|0.6|2.5|ttdprev=alpha 43}}||Class of the building type
|-
|1D||B||{{ottdp|0.6|2.5|ttdprev=alpha 55 vcs 2}}||Callback flags 2
|-
|1E||D||{{ottdp|0.6|2.5|ttdprev=alpha 55 vcs 2}}||Accepted cargo types
|-
|1F||B||{{ottdp|0.6|2.6|ttdprev=r1554}}||Minimum life span in years
|-
|20||V||{{ottdp|1.2|2.6|ottdrev=r23072|ttdprev=r1677}}||Cargo acceptance watch list
|-
|21||W||{{ottdp|0.7|no|ottdrev=r13437}}||Long year (zero based) of minimum appearance
|-
|22||W||{{ottdp|0.7|no|ottdrev=r13437}}||Long year (zero based) of maximum appearance
|-
|23||V||{{ottdp|1.9|no|ottdrev=48b334cf}}||Tile acceptance list
|}

When a town decides to expand, each active house type (both old and new ones) has a uniform probability to appear, so the more new houses you define, the fewer old TTD buildings will appear.

== Descriptions ==

=== Substitute building type (08) ===

This building type will be used instead of your new one if your definition isn't available for any reason (the grf file is not found, for example).

Don't set a substitute building type that is larger than your new one (for example, don't set 14 (stadium) for an 1x1 building) because this may corrupt savegames. Setting this property automatically copies every property of the substitute building to your new building, so you don't have to change properties that are the same as the substitute.

House flags 40 and 80 are exceptions; these flags are never set automatically. Only the first property 08 setting copies properties; if you later change it, properties will stay.

There's a special use of this property beginning from alpha 72: if you set it to FFh, you can disable an old house type. In this case, the ID used must be the number of old house type you want to disable. Disabling only prevents building the type in towns; houses already present on the map will stay unchanged. The type can still be overridden, and overriding affects houses present on the map.

If this house's action 3 appears before this property is set, the action 3 will have no effect.

=== Building flags (09) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||This is a 1x1 building
|-
|1||2||This building can be built only on flat land (if clear, foundations are automatically displayed on sloped land)
|-
|2||4||This is a 2x1 building<ref name="large">If your building isn't 1x1, set flags for the north tile, then define the next 1 or 3 tiles tiles (by setting their property 8). The only bit that can be set in the flags of additional tiles is bit 5 (animation). There should be no property 8 setting between the first tile and the additional tiles.</ref>
|-
|3||8||This is a 1x2 building<ref name="large" />
|-
|4||10||This is a 2x2 building<ref name="large" /><ref>For 2x2 buildings, the first additional tile is the east one, the second is the west part and the third is the south part. You probably want to set the substitute for additional tiles to a TTD additional tile whose flags are already zero. 2x2 buildings are always built on flat land no matter how bit 1 is set.</ref>
|-
|5||20||Animation flag, set in tiles 04 and 05 (large office block). New buildings have a different animation scheme than large office blocks, but animation is still enabled with this bit.<ref>The animation flag works on a per-tile basis, so you should enable it for additional tiles of multi-tile buildings as well if you want all tiles to be animated.</ref>
|-
|6||40||This building is a church<ref name="only1">Only one church and one stadium can exist in a town. The town won't build buildings with the according flag set until the old church/stadium is removed. (This can be done by either the town or a player)</ref>
|-
|7||80||This building is a stadium<ref name="only1" />
|}

<references />

=== Availability years (0A) ===

The low byte is the minimum year, the high is the maximum. The building can only be built between these two years (inclusive). 1920 is added to both bytes before using the values.

{{ottdp|no| }}
Since the year counting stops in TTDPatch in 2070 even with [[ttwiki:EternalGame|EternalGame]] on, start years above 150 mean "never", and end years above 150 mean "forever". In OpenTTD there is no limit for the maximum year (resp. it is 5000000).

'''WARNING:''' Don't set the start year below 1930 (0Ah) unless you know what you're doing!

{{ttdp|}} If TTDPatch finds a building that is available before 1930, it will not build old building types until that year, so you have to provide at least one custom building type that is available before 1930 for every [[TownZones|town zone]], or TTD may deadlock while trying to create a random game or expand a town.

{{ottd|}} The availability of all active houses with the lowest availability year is set to start from year 0, so that always at least one house is available irrespective of starting year. Thus, if you de-activate default houses or set an introduction date prior to the default houses introduction year 1930, you should have at least for each [[TownZones|town zone]] a house with the same earliest availability year or you might end up with a situation where no house can be placed in a [[TownZones|town zone]].

=== Population (0B) and Mail generation multiplier (0C) ===
[[Image:House_production.png|frame|right|Actual house production roughly depends on squared value of the population / mail generation multiplier.]]

The population of the town will be increased by the amount set in prop. 0B if this building is built. Additional house parts should have a population of zero. The higher this value is, the more passengers this building generates.

The higher the mail generation multiplier is, the more mail the building generates. For multi-tile buildings, mail generation is done in per-tile basis, so you can specify different values for every tile, although distributing the generation equally between tiles is suggested.

This is how exactly passengers are generated: In each periodic processing (i.e. every 256 ticks), a random value 0<=X<=255 is generated for each house tile. If X isn't smaller than the population of the tile, no passengers are generated. Otherwise, X/8+1 passengers are generated (rounded down). If there is a recession going on, the number of generated passengers is halved, but this division gets rounded up instead of down. Mail generation happens in a similar manner, but with a new random value, and checking against the mail generation multiplier instead of the population.

You can further customize how the cargo is generated with the [[Callbacks#Custom_cargo_production_.282E.29 |callback 2E]]. 

=== Passenger (0D), Mail (0E) and Good/Food/Fizzy drinks (0F) acceptance ===

The acceptance is given in units of 1/8th and must not be larger than 8 eighths.

For property 0F, positive values indicate that the building accepts goods, and negative values (i.e. FF = 1/8th, FE = 2/8ths etc.) indicate acceptance of food or fizzy drinks, depending on the climate.

All the above three values can be set independently for tiles of multi-tile buildings, since every tile is processed individually when determining what a station accepts.

The type of accepted cargo can be modified using [[Action0Houses#Accepted_cargo_types|property 1E]].

{{ottdp|no| }} Note that in TTDPatch the officefood switch may modify acceptance in the sub-arctic and subtropical climates.

=== Building name ID (12) ===

The ID of the text that should be displayed in the land query window. The name can also be set by [[Action4|action 4]] (see there). Should be set to the same value for every tile for multi-tile buildings.

=== Building availability mask (13) ===

{| |-
!Bit!!Value!!Meaning
|-
|0..4||1,2,4,8,10||which [[VariationalAction2/Houses#Town zone (42)|town zone(s)]] the building can be built in
|-
|11||800||can appear in sub-arctic climate above the snow line
|-
|12||1000||can appear in temperate climate
|-
|13||2000||can appear in sub-arctic climate below the snow line
|-
|14||4000||can appear in subtropical climate
|-
|15||8000||can appear in toyland climate
|}

This property should be set to zero for additional building tiles.

=== House callback flags (14,1D) ===

For houses, the following [[callbacks]] can be defined by setting the corresponding bit in property 14:

{| |-
!Bit!!Value!!Variable 0C value!!Version!!Callback
|-
|0||1||17||{{ottdp| | }}||decide whether the house can be built on a given tile
|-
|1||2||1A||{{ottdp| | }}||decide the following frame of the animations
|-
|2||4||1B||{{ottdp| | }}||periodically start/stop the animation
|-
|3||8||1C||{{ottdp| | }}||change animation when construction state changes
|-
|4||10||1E||{{ottdp| | }}||decide the color of the building
|-
|5||20||1F||{{ottdp| | }}||decide the cargos amounts accepted
|-
|6||40||20||{{ottdp| | }}||decide the length of the current animation frame
|-
|7||80||21||{{ottdp| | }}||trigger destruction of building
|}

Property 1D was introduced after all bits of property 14 were filled. Its usage is the same, only the meaning of bits is different:

{| |-
!Bit!!Value!!Variable 0C value!!Version!!Callback
|-
|0||1||2A||{{ottdp| | }}||decide the cargo types accepted
|-
|1||2||2E||{{ottdp| | }}||custom cargo production
|-
|2||4||143||{{ottdp| | }}||conditional protection
|-
|3||8||14E||{{ottdp|1.0|2.6|ottdrev=r17558|ttdprev=2249}}||decide if default foundations need to be drawn
|-
|4||10||14F||{{ottdp|1.0|2.6|ottdrev=r17558|ttdprev=2249}}||allow or deny autosloping below the tile
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the variational Action2 for callbacks.

Callback flags are ignored for additional building tiles.

=== House override byte (15) ===

Setting this property makes this building appear instead of the given old TTD building type. Setting the property is ignored if the given old house type is already overridden. You can set this property more than once to override more old building types.

No new house of the overridden types will be built in towns.

This property works in a per-tile basis, so you override tiles of old multi-tile buildings individually, although the old type will still be built if you don't override its north tile.

=== Periodic refresh multiplier (16) ===

This is used for random triggers, and sets how often the tile is re-randomized. When set to X, the tile will be re-randomized on every (X+1)-th periodic processing. (In other words, every (X+1)*256 game ticks.) If you want all tiles to be re-randomized, you must set this (but not necessarily to the same value) for each tile.

If callback 1B is enabled in property 14, it is also called after re-randomizing random bits.

{{ottdp|1.1|2.5|ttdprev=2.5 beta 9}} In TTDPatch versions before TTDPatch 2.6 r1639 and TTDPatch 2.5 beta 9 (including beta 9), this variable could have any value between 0 and 255. After these versions, the upper limit has been lowered to 63. To maintain compatibility, values above 63 will be interpreted as 63.

=== Random colours (17) ===

This specifies four colors used for random painting (see [[Action2HousesIndustryTiles]]). Each byte of the dword defines a color, the values are the same as in Action2, except that numbering starts from zero instead of 775. If not set, this defaults to 04 08 0c 06 (red, blue, orange and green, the colors of the modern office building). Can be set to different values for tiles of multi-tile buildings.

=== Probability (18) ===

This sets the relative probability of this house being built. Old TTD house types have a probability of 16, and this is the default for new types as well.

Increase (or better multiply) this value to make your building appear relatively more often, or decrease (divide) it to make it rarer. If you set this to zero, the house type never appears. The minimal useful value 1 means it's sixteen times less probable to build this type than a normal type, while the maximum setting of 255 means it's almost sixteen times more probable.

The probability is relative since the absolute probability depends on the count and probability of other houses as well: the more types are available (and the higher their probabilities are), the less the chance is that your type will be chosen.

=== Extra Flags (19) ===

{| |-
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|0.6|2.5}}||This building appears during the generation of a town, but not later, i.e. will appear in random games, but new ones won't be built during the game. Useful for buildings that are intended to be historical.
|-
|1||2||{{ottdp|0.6|2.5}}||This building is protected, i.e. towns and AI players won't remove it. Human players can still remove it, so you may need to set a high remove cost/rating to make them think twice.
|-
|2||4||{{ottdp|0.6|2.5}}||Synchronized [[Callbacks#Animation_control_.281B.2F25.2F140.2F152.2F159.29| callback 1B]]. (for multi-tile buildings)<ref>If synchronized callbacks are enabled, callback 1B will be called when the periodic processing reaches the main tile of the building, and not when it reaches the current tile. This is useful if your animation must run synchronously on every tile of the building. If this bit is set, callback 1B is called according to the main tile's property 16, not the current one, to make sure every tile stays in sync.</ref>
|-
|3||8||{{ottdp|0.6|2.5|ttdprev=beta 2}}||[[Callbacks#Next animation frame (1A/26/141/153/158) |Callback 1A]] needs random bits
|}

<references />

=== Animation Frames (1A) ===

The bottom seven bits define how many frames the animation consists of, minus one. (I.e. 0 means 1 frame, 1 means 2 frames etc.) The highest bit has another purpose (see below), so the biggest supported value is 7F (128 frames).

The highest bit is set if the animation is looping, i.e. it should start again from the first frame after showing the last frame. Non-looping animations stop after the last frame, leaving it on the screen. Both kinds of animations start automatically when the building is created. It's recommended to use callback 1B with non-looping animations, so they are played multiple times.

{{ottdp|0.6|2.5|ottdrev=r12347|ttdprev=r1639}} In TTDPatch versions before TTDPatch 2.6 r1639 and TTDPatch 2.5 beta 9 (including beta 9) and OpenTTD before r12347, the frame number was limited to 32. If you intend to maintain compatibility with those versions, you should not use animations longer than 32 frames.

=== Animation Speed (1B) ===

This is the amount of time between switching frames.

The default value is 2, which means the switch occurs every 108 milliseconds. Increasing this value by one doubles the wait, i.e. 3 will cause 216 ms delay, while 4 will pause 432 ms, and so on. Values below 2 have the same effect as 2, so the default is the fastest possible setting. The maximum is 16, which means 1769 seconds (approx. half an hour) delay. Settings above this value may cause strange behaviour.

=== Building Class (1C) ===

Types that were given the same class byte are considered to be in the same class. If you don't explicitly set this value, the type is considered to have no class (it won't be considered to be class 0). The scope of a class is the current GRF file, so two types are never in the same class if they were defined by different GRF files. Currently, this property affects variable 44 only.

This property is a per-tile one, you can set it for additional tiles as well. It's a better idea, however, to set it for the main tile only, since var. 44 counts tiles, not buildings, and you may count multi-tile multiple times otherwise.

=== Accepted cargo types (1E) ===

There may be cases when you want your house to accept something other than the default types (passenger, mail, goods and food). This property allows you to do that. If this property is set to FFFFFFFFh (the default), the meaning of properties 0D, 0E and 0F aren't changed, that is, they are the passenger, mail and goods/food acceptances, accordingly. If this property isn't FFFFFFFFh, the first three bytes must be climate-dependent cargo slot numbers (the fourth byte is ignored). In this case property 0D is the amount of acceptance of the first cargo type given, 0E is the same for the second type and 0F is the same for the third type.

From GRF version 7 and above, the meaning of this property changes: instead of climate-dependent cargo slot numbers, you have to give climate-independent cargo IDs. If your GRF has a cargo translation table, then this ID is the index in that table; otherwise, it's the cargo slot number. Acceptance of cargoes not currently present will automatically be disabled.

{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.

=== Minimum life span in years (1F) ===

Towns are prevented from destroying the house if it hasn't yet reached the age given here. The default is 0, which means towns are free to remove the house any time they like. Please note that this setting doesn't prevent AI players from removing the house; only towns are affected. If you need to protect your building from AI players as well, you can set the "protected" flag (property 19 bit 1), or use [[Callbacks#Protect building conditionally (143) |callback 143]] and use your custom code to decide who (and when) is allowed to remove the building.

For this to operate consequently on multi-tile buildings, you must set the same minimum lifespan for all tiles of the building.

=== Cargo acceptance watch list (20) ===

This property is a list of cargo types, types whose acceptance should be watched. The first byte is the length of the list, the remaining bytes identify cargo types. {{grfFrom|7}} If your GRF is version 7 or above, and has a cargo translation table, the bytes are indexes in the table; otherwise, they are cargo slot numbers. When a cargo from this list is accepted by the current tile, [[Callbacks#Watched cargo accepted (148) |callback 148]] is called on ''all'' tiles of the building. See [[Callbacks#Watched cargo accepted (148) |callback 148]] for more details about how this happens.

{{ttdp|}} This property has no effect if the station2 structure isn't 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

=== Availability years (long format) - Minimum (21) - Maximum (22) ===

Those two properties allow to specify a range of dates (based on year zero(0) that are not limited to the 1930 dates. So earlier buildings can be introduced. Be sure to add substantial houses to the sets, if you do not wat to have uniform towns, since the current earliest houses will remain in their current 1920 era. Mind also the warning wrt. introduction years as described at property 0A.

{{ottdp|15|no}} A value of FFFF is treated as the game's MAX_YEAR instead of a literal year 65535.

=== Tile acceptance list (23) ===
{{ottdp|1.9|no|ottdrev=48b334cf}}

Format:
<numinput> (<cargotype> <acceptance>)*

{| |-
!Size!!Variable!!Meaning
|-
|B||numinput||Number of (<cargotype> <acceptance>) pairs to follow,
|-
|B||cargotype||Cargotype (from CTT) to accept.
|-
|B||acceptance||Acceptance in 1/8 units.
|}

This property defines up to 16 cargotypes, which are accepted by the house.
Use this property instead of property 0D..0F.

Action0/Houses

2024-12-23T09:22:43Z

Peter1138: /* Introduction */

== Introduction ==

For town buildings (or simply houses), the offset defines the first house ID for this action 0. House IDs, like station IDs, are unique within each grf file, and in total each game can only have 255 IDs in TTDPatch and 512 IDs in OpenTTD for all active grf files.

{{ottdp|15} Since OpenTTD 15, the limits are increased to 4096 IDs, both per-grf and in total.

To start using a house ID, you must first define it by setting its property 08 (see below). If you try to modify a house ID whose property 08 isn't set, your request is ignored, but not reported as an error, either.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Substitute building type
|-
|09||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building flags
|-
|0A||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Availability years
|-
|0B||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Population
|-
|0C||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Mail generation multiplier
|-
|0D||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Passenger acceptance
|-
|0E||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Mail acceptance
|-
|0F||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Goods, food or fizzy drinks acceptance
|-
|10||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||LA rating decrease on removal (should be set to the same value for every tile for multi-tile buildings)
|-
|11||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Removal cost multiplier (should be set to the same value for every tile for multi-tile buildings)
|-
|12||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building name ID
|-
|13||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building availability mask
|-
|14||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||House callback flags
|-
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||House override byte
|-
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Periodic refresh multiplier
|-
|17||4*B||{{ottdp|0.6|2.5|ttdprev=alpha 35}}||Four random colours to use
|-
|18||B||{{ottdp|0.6|2.5|ttdprev=alpha 35}}||Relative probability of appearing
|-
|19||B||{{ottdp|0.6|2.5|ttdprev=alpha 38}}||Extra flags
|-
|1A||B||{{ottdp|0.6|2.5|ttdprev=alpha 39}}||Animation frames
|-
|1B||B||{{ottdp|0.6|2.5|ttdprev=alpha 39}}||Animation speed
|-
|1C||B||{{ottdp|0.6|2.5|ttdprev=alpha 43}}||Class of the building type
|-
|1D||B||{{ottdp|0.6|2.5|ttdprev=alpha 55 vcs 2}}||Callback flags 2
|-
|1E||D||{{ottdp|0.6|2.5|ttdprev=alpha 55 vcs 2}}||Accepted cargo types
|-
|1F||B||{{ottdp|0.6|2.6|ttdprev=r1554}}||Minimum life span in years
|-
|20||V||{{ottdp|1.2|2.6|ottdrev=r23072|ttdprev=r1677}}||Cargo acceptance watch list
|-
|21||W||{{ottdp|0.7|no|ottdrev=r13437}}||Long year (zero based) of minimum appearance
|-
|22||W||{{ottdp|0.7|no|ottdrev=r13437}}||Long year (zero based) of maximum appearance
|-
|23||V||{{ottdp|1.9|no|ottdrev=48b334cf}}||Tile acceptance list
|}

When a town decides to expand, each active house type (both old and new ones) has a uniform probability to appear, so the more new houses you define, the fewer old TTD buildings will appear.

== Descriptions ==

=== Substitute building type (08) ===

This building type will be used instead of your new one if your definition isn't available for any reason (the grf file is not found, for example).

Don't set a substitute building type that is larger than your new one (for example, don't set 14 (stadium) for an 1x1 building) because this may corrupt savegames. Setting this property automatically copies every property of the substitute building to your new building, so you don't have to change properties that are the same as the substitute.

House flags 40 and 80 are exceptions; these flags are never set automatically. Only the first property 08 setting copies properties; if you later change it, properties will stay.

There's a special use of this property beginning from alpha 72: if you set it to FFh, you can disable an old house type. In this case, the ID used must be the number of old house type you want to disable. Disabling only prevents building the type in towns; houses already present on the map will stay unchanged. The type can still be overridden, and overriding affects houses present on the map.

If this house's action 3 appears before this property is set, the action 3 will have no effect.

=== Building flags (09) ===

{| |-
!Bit!!Value!!Meaning
|-
|0||1||This is a 1x1 building
|-
|1||2||This building can be built only on flat land (if clear, foundations are automatically displayed on sloped land)
|-
|2||4||This is a 2x1 building<ref name="large">If your building isn't 1x1, set flags for the north tile, then define the next 1 or 3 tiles tiles (by setting their property 8). The only bit that can be set in the flags of additional tiles is bit 5 (animation). There should be no property 8 setting between the first tile and the additional tiles.</ref>
|-
|3||8||This is a 1x2 building<ref name="large" />
|-
|4||10||This is a 2x2 building<ref name="large" /><ref>For 2x2 buildings, the first additional tile is the east one, the second is the west part and the third is the south part. You probably want to set the substitute for additional tiles to a TTD additional tile whose flags are already zero. 2x2 buildings are always built on flat land no matter how bit 1 is set.</ref>
|-
|5||20||Animation flag, set in tiles 04 and 05 (large office block). New buildings have a different animation scheme than large office blocks, but animation is still enabled with this bit.<ref>The animation flag works on a per-tile basis, so you should enable it for additional tiles of multi-tile buildings as well if you want all tiles to be animated.</ref>
|-
|6||40||This building is a church<ref name="only1">Only one church and one stadium can exist in a town. The town won't build buildings with the according flag set until the old church/stadium is removed. (This can be done by either the town or a player)</ref>
|-
|7||80||This building is a stadium<ref name="only1" />
|}

<references />

=== Availability years (0A) ===

The low byte is the minimum year, the high is the maximum. The building can only be built between these two years (inclusive). 1920 is added to both bytes before using the values.

{{ottdp|no| }}
Since the year counting stops in TTDPatch in 2070 even with [[ttwiki:EternalGame|EternalGame]] on, start years above 150 mean "never", and end years above 150 mean "forever". In OpenTTD there is no limit for the maximum year (resp. it is 5000000).

'''WARNING:''' Don't set the start year below 1930 (0Ah) unless you know what you're doing!

{{ttdp|}} If TTDPatch finds a building that is available before 1930, it will not build old building types until that year, so you have to provide at least one custom building type that is available before 1930 for every [[TownZones|town zone]], or TTD may deadlock while trying to create a random game or expand a town.

{{ottd|}} The availability of all active houses with the lowest availability year is set to start from year 0, so that always at least one house is available irrespective of starting year. Thus, if you de-activate default houses or set an introduction date prior to the default houses introduction year 1930, you should have at least for each [[TownZones|town zone]] a house with the same earliest availability year or you might end up with a situation where no house can be placed in a [[TownZones|town zone]].

=== Population (0B) and Mail generation multiplier (0C) ===
[[Image:House_production.png|frame|right|Actual house production roughly depends on squared value of the population / mail generation multiplier.]]

The population of the town will be increased by the amount set in prop. 0B if this building is built. Additional house parts should have a population of zero. The higher this value is, the more passengers this building generates.

The higher the mail generation multiplier is, the more mail the building generates. For multi-tile buildings, mail generation is done in per-tile basis, so you can specify different values for every tile, although distributing the generation equally between tiles is suggested.

This is how exactly passengers are generated: In each periodic processing (i.e. every 256 ticks), a random value 0<=X<=255 is generated for each house tile. If X isn't smaller than the population of the tile, no passengers are generated. Otherwise, X/8+1 passengers are generated (rounded down). If there is a recession going on, the number of generated passengers is halved, but this division gets rounded up instead of down. Mail generation happens in a similar manner, but with a new random value, and checking against the mail generation multiplier instead of the population.

You can further customize how the cargo is generated with the [[Callbacks#Custom_cargo_production_.282E.29 |callback 2E]]. 

=== Passenger (0D), Mail (0E) and Good/Food/Fizzy drinks (0F) acceptance ===

The acceptance is given in units of 1/8th and must not be larger than 8 eighths.

For property 0F, positive values indicate that the building accepts goods, and negative values (i.e. FF = 1/8th, FE = 2/8ths etc.) indicate acceptance of food or fizzy drinks, depending on the climate.

All the above three values can be set independently for tiles of multi-tile buildings, since every tile is processed individually when determining what a station accepts.

The type of accepted cargo can be modified using [[Action0Houses#Accepted_cargo_types|property 1E]].

{{ottdp|no| }} Note that in TTDPatch the officefood switch may modify acceptance in the sub-arctic and subtropical climates.

=== Building name ID (12) ===

The ID of the text that should be displayed in the land query window. The name can also be set by [[Action4|action 4]] (see there). Should be set to the same value for every tile for multi-tile buildings.

=== Building availability mask (13) ===

{| |-
!Bit!!Value!!Meaning
|-
|0..4||1,2,4,8,10||which [[VariationalAction2/Houses#Town zone (42)|town zone(s)]] the building can be built in
|-
|11||800||can appear in sub-arctic climate above the snow line
|-
|12||1000||can appear in temperate climate
|-
|13||2000||can appear in sub-arctic climate below the snow line
|-
|14||4000||can appear in subtropical climate
|-
|15||8000||can appear in toyland climate
|}

This property should be set to zero for additional building tiles.

=== House callback flags (14,1D) ===

For houses, the following [[callbacks]] can be defined by setting the corresponding bit in property 14:

{| |-
!Bit!!Value!!Variable 0C value!!Version!!Callback
|-
|0||1||17||{{ottdp| | }}||decide whether the house can be built on a given tile
|-
|1||2||1A||{{ottdp| | }}||decide the following frame of the animations
|-
|2||4||1B||{{ottdp| | }}||periodically start/stop the animation
|-
|3||8||1C||{{ottdp| | }}||change animation when construction state changes
|-
|4||10||1E||{{ottdp| | }}||decide the color of the building
|-
|5||20||1F||{{ottdp| | }}||decide the cargos amounts accepted
|-
|6||40||20||{{ottdp| | }}||decide the length of the current animation frame
|-
|7||80||21||{{ottdp| | }}||trigger destruction of building
|}

Property 1D was introduced after all bits of property 14 were filled. Its usage is the same, only the meaning of bits is different:

{| |-
!Bit!!Value!!Variable 0C value!!Version!!Callback
|-
|0||1||2A||{{ottdp| | }}||decide the cargo types accepted
|-
|1||2||2E||{{ottdp| | }}||custom cargo production
|-
|2||4||143||{{ottdp| | }}||conditional protection
|-
|3||8||14E||{{ottdp|1.0|2.6|ottdrev=r17558|ttdprev=2249}}||decide if default foundations need to be drawn
|-
|4||10||14F||{{ottdp|1.0|2.6|ottdrev=r17558|ttdprev=2249}}||allow or deny autosloping below the tile
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the variational Action2 for callbacks.

Callback flags are ignored for additional building tiles.

=== House override byte (15) ===

Setting this property makes this building appear instead of the given old TTD building type. Setting the property is ignored if the given old house type is already overridden. You can set this property more than once to override more old building types.

No new house of the overridden types will be built in towns.

This property works in a per-tile basis, so you override tiles of old multi-tile buildings individually, although the old type will still be built if you don't override its north tile.

=== Periodic refresh multiplier (16) ===

This is used for random triggers, and sets how often the tile is re-randomized. When set to X, the tile will be re-randomized on every (X+1)-th periodic processing. (In other words, every (X+1)*256 game ticks.) If you want all tiles to be re-randomized, you must set this (but not necessarily to the same value) for each tile.

If callback 1B is enabled in property 14, it is also called after re-randomizing random bits.

{{ottdp|1.1|2.5|ttdprev=2.5 beta 9}} In TTDPatch versions before TTDPatch 2.6 r1639 and TTDPatch 2.5 beta 9 (including beta 9), this variable could have any value between 0 and 255. After these versions, the upper limit has been lowered to 63. To maintain compatibility, values above 63 will be interpreted as 63.

=== Random colours (17) ===

This specifies four colors used for random painting (see [[Action2HousesIndustryTiles]]). Each byte of the dword defines a color, the values are the same as in Action2, except that numbering starts from zero instead of 775. If not set, this defaults to 04 08 0c 06 (red, blue, orange and green, the colors of the modern office building). Can be set to different values for tiles of multi-tile buildings.

=== Probability (18) ===

This sets the relative probability of this house being built. Old TTD house types have a probability of 16, and this is the default for new types as well.

Increase (or better multiply) this value to make your building appear relatively more often, or decrease (divide) it to make it rarer. If you set this to zero, the house type never appears. The minimal useful value 1 means it's sixteen times less probable to build this type than a normal type, while the maximum setting of 255 means it's almost sixteen times more probable.

The probability is relative since the absolute probability depends on the count and probability of other houses as well: the more types are available (and the higher their probabilities are), the less the chance is that your type will be chosen.

=== Extra Flags (19) ===

{| |-
!Bit!!Value!!Version!!Meaning
|-
|0||1||{{ottdp|0.6|2.5}}||This building appears during the generation of a town, but not later, i.e. will appear in random games, but new ones won't be built during the game. Useful for buildings that are intended to be historical.
|-
|1||2||{{ottdp|0.6|2.5}}||This building is protected, i.e. towns and AI players won't remove it. Human players can still remove it, so you may need to set a high remove cost/rating to make them think twice.
|-
|2||4||{{ottdp|0.6|2.5}}||Synchronized [[Callbacks#Animation_control_.281B.2F25.2F140.2F152.2F159.29| callback 1B]]. (for multi-tile buildings)<ref>If synchronized callbacks are enabled, callback 1B will be called when the periodic processing reaches the main tile of the building, and not when it reaches the current tile. This is useful if your animation must run synchronously on every tile of the building. If this bit is set, callback 1B is called according to the main tile's property 16, not the current one, to make sure every tile stays in sync.</ref>
|-
|3||8||{{ottdp|0.6|2.5|ttdprev=beta 2}}||[[Callbacks#Next animation frame (1A/26/141/153/158) |Callback 1A]] needs random bits
|}

<references />

=== Animation Frames (1A) ===

The bottom seven bits define how many frames the animation consists of, minus one. (I.e. 0 means 1 frame, 1 means 2 frames etc.) The highest bit has another purpose (see below), so the biggest supported value is 7F (128 frames).

The highest bit is set if the animation is looping, i.e. it should start again from the first frame after showing the last frame. Non-looping animations stop after the last frame, leaving it on the screen. Both kinds of animations start automatically when the building is created. It's recommended to use callback 1B with non-looping animations, so they are played multiple times.

{{ottdp|0.6|2.5|ottdrev=r12347|ttdprev=r1639}} In TTDPatch versions before TTDPatch 2.6 r1639 and TTDPatch 2.5 beta 9 (including beta 9) and OpenTTD before r12347, the frame number was limited to 32. If you intend to maintain compatibility with those versions, you should not use animations longer than 32 frames.

=== Animation Speed (1B) ===

This is the amount of time between switching frames.

The default value is 2, which means the switch occurs every 108 milliseconds. Increasing this value by one doubles the wait, i.e. 3 will cause 216 ms delay, while 4 will pause 432 ms, and so on. Values below 2 have the same effect as 2, so the default is the fastest possible setting. The maximum is 16, which means 1769 seconds (approx. half an hour) delay. Settings above this value may cause strange behaviour.

=== Building Class (1C) ===

Types that were given the same class byte are considered to be in the same class. If you don't explicitly set this value, the type is considered to have no class (it won't be considered to be class 0). The scope of a class is the current GRF file, so two types are never in the same class if they were defined by different GRF files. Currently, this property affects variable 44 only.

This property is a per-tile one, you can set it for additional tiles as well. It's a better idea, however, to set it for the main tile only, since var. 44 counts tiles, not buildings, and you may count multi-tile multiple times otherwise.

=== Accepted cargo types (1E) ===

There may be cases when you want your house to accept something other than the default types (passenger, mail, goods and food). This property allows you to do that. If this property is set to FFFFFFFFh (the default), the meaning of properties 0D, 0E and 0F aren't changed, that is, they are the passenger, mail and goods/food acceptances, accordingly. If this property isn't FFFFFFFFh, the first three bytes must be climate-dependent cargo slot numbers (the fourth byte is ignored). In this case property 0D is the amount of acceptance of the first cargo type given, 0E is the same for the second type and 0F is the same for the third type.

From GRF version 7 and above, the meaning of this property changes: instead of climate-dependent cargo slot numbers, you have to give climate-independent cargo IDs. If your GRF has a cargo translation table, then this ID is the index in that table; otherwise, it's the cargo slot number. Acceptance of cargoes not currently present will automatically be disabled.

{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.

=== Minimum life span in years (1F) ===

Towns are prevented from destroying the house if it hasn't yet reached the age given here. The default is 0, which means towns are free to remove the house any time they like. Please note that this setting doesn't prevent AI players from removing the house; only towns are affected. If you need to protect your building from AI players as well, you can set the "protected" flag (property 19 bit 1), or use [[Callbacks#Protect building conditionally (143) |callback 143]] and use your custom code to decide who (and when) is allowed to remove the building.

For this to operate consequently on multi-tile buildings, you must set the same minimum lifespan for all tiles of the building.

=== Cargo acceptance watch list (20) ===

This property is a list of cargo types, types whose acceptance should be watched. The first byte is the length of the list, the remaining bytes identify cargo types. {{grfFrom|7}} If your GRF is version 7 or above, and has a cargo translation table, the bytes are indexes in the table; otherwise, they are cargo slot numbers. When a cargo from this list is accepted by the current tile, [[Callbacks#Watched cargo accepted (148) |callback 148]] is called on ''all'' tiles of the building. See [[Callbacks#Watched cargo accepted (148) |callback 148]] for more details about how this happens.

{{ttdp|}} This property has no effect if the station2 structure isn't 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

=== Availability years (long format) - Minimum (21) - Maximum (22) ===

Those two properties allow to specify a range of dates (based on year zero(0) that are not limited to the 1930 dates. So earlier buildings can be introduced. Be sure to add substantial houses to the sets, if you do not wat to have uniform towns, since the current earliest houses will remain in their current 1920 era. Mind also the warning wrt. introduction years as described at property 0A.

{{ottdp|15|no}} A value of FFFF is treated as the game's MAX_YEAR instead of a literal year 65535.

=== Tile acceptance list (23) ===
{{ottdp|1.9|no|ottdrev=48b334cf}}

Format:
<numinput> (<cargotype> <acceptance>)*

{| |-
!Size!!Variable!!Meaning
|-
|B||numinput||Number of (<cargotype> <acceptance>) pairs to follow,
|-
|B||cargotype||Cargotype (from CTT) to accept.
|-
|B||acceptance||Acceptance in 1/8 units.
|}

This property defines up to 16 cargotypes, which are accepted by the house.
Use this property instead of property 0D..0F.

NML:Vehicles

2024-12-03T12:47:15Z

Peter1138: Add articulated vehicle ID limit

{{NMLNavPropVarCB}}
==Properties common to all vehicle types==

{| class="wikitable sortable"
! property
! value range
! available for articulated vehicle
! comment
|-
| <code style="color:green">name</code>
| (string)
| yes
| for example <code style="color:darkgreen">string(STR_NAME_HEREFORD_TRAM)</code>
|-
| <code style="color:green">climates_available</code>
| bitmask(CLIMATE_XXX, CLIMATE_YYY, ...)
| set to <code style="color:green">NO_CLIMATE</code>
|
;CLIMATE_TEMPERATE
;CLIMATE_ARCTIC
;CLIMATE_TROPICAL
;CLIMATE_TOYLAND
;NO_CLIMATE
:Vehicle is availble in no climate (e.g. for articulated parts)
;ALL_CLIMATES
:Vehicle is available irrespective of climate

To make a vehicle available in all climates except toyland you could use: <code style="color:green">ALL_CLIMATES & ~bitmask(CLIMATE_TOYLAND)</code>.
|-
| <code style="color:green">introduction_date</code>
| <code style="color:green">date</code>(yyyy,mm,dd)
| no
| Valid range for yyyy is 0 ... 5000000. In TTDPatch, dates after 2044 will be limited to 2044. Unless the engine is introduced within two years after game-start (always 1920 in TTDPatch), a random number of days between 0 and 511 will be added to this.
|-
| <code style="color:green">model_life</code>
| 0 ... 254 (years) or <code style="color:green">VEHICLE_NEVER_EXPIRES</code>
| no
|
Number of years a model is "supported" by the manufacturer, see [[#Engine life cycle|below]].
|-
| <code style="color:green">retire_early</code>
| -128 ... 127 (years)
| no
|
Retire the vehicle (make it unavailable in the purchase menu) this many years before reliability starts dropping, see [[#Engine life cycle|below]]. May be negative.
|-
| <code style="color:green">vehicle_life</code>
| 0 ... 255 (years)
| no
| Life length of an individual vehicle, before it is considered too old and in need of replacement.
|-
| <code style="color:green">reliability_decay</code>
| 0 ... 255
| no
| Default vehicles use 20. The higher the value the faster reliability decays, the more frequent service is needed. 0 means reliability never decreases if the vehicle is not too old
|-
| <code style="color:green">refittable_cargo_classes</code>
|
bit set of [[NML:Cargos#Cargo classes|cargo classes]]
| yes
| for example: <code style="color:darkgreen">bitmask(CC_BULK, CC_COVERED)</code>
|-
| <code style="color:green">non_refittable_cargo_classes</code>
|
bit set of [[NML:Cargos#Cargo classes|cargo classes]]
| yes
| for example: <code style="color:darkgreen">bitmask(CC_OVERSIZED, CC_SPECIAL)</code>
|-
| <code style="color:green">refittable_cargo_types</code>
| bit mask of entries into the cargo translation table
| yes
| As of NML 0.3, do not use this. Use cargo_[dis]allow_refit (see below) instead.
|-
| <code style="color:green">cargo_allow_refit</code>
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Yes
| {{ottdp|1.2|no|ottdrev=r23291}} A list of cargo types to allow refitting to, irrespective of cargo classes. Example: <code style="color:darkgreen">[COAL, IORE]</code>
|-
| <code style="color:green">cargo_disallow_refit</code>
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Yes
| {{ottdp|1.2|no|ottdrev=r23291}} A list of cargo types to disallow refitting to, irrespective of cargo classes. Example: <code style="color:darkgreen">[MAIL]</code>
|-
| <code style="color:green">loading_speed</code>
| 0 ... 255 (cargo units)
| yes
| Units of cargo loaded per time unit. Default vehicles use 5 for trains and road vehicles, 10 for ships and 20 for aircraft. This amount of cargo is loaded to or unloaded from the vehicle every 40 ticks for trains, every 20 ticks for road vehicles and aircraft and every 10 ticks for ships.
|-
| <code style="color:green">cost_factor</code>
| 0 ... 255
| Set to 0
| multiplier to the base purchase cost
|-
| <code style="color:green">running_cost_factor</code>
| 0 ... 255
| Set to 0
| multiplier to the base running costs
|-
| <code style="color:green">cargo_age_period</code>
| 0 ... 65535
| yes
|
{{ottd|1.2|r22713}} This property specifies after how many ticks cargo is aged. Default value is 185. 74 ticks is equal to 1 day. If set to 0, cargo does not age. Repeated tests have shown that the gameplay effects of this property often do not match the expectations of grf authors. Explaining why requires a detailed understanding of the OpenTTD cargo aging algorithm, and how that works with e.g. different map sizes, vehicle speeds, multi-leg feeder systems, etc. TL;DR avoid using this property unless you absolutely understand the effect it will have.
|-
| <code style="color:green">variant_group</code>
| Vehicle ID or alternatively the vehicle numeric ID (0 ... 65535)
| no
|
{{ottd|13}} This property supports grouping vehicles in the purchase menu (also the autoreplace menu). The property value is the ID of another vehicle in the same GRF which will act as the parent for vehicles in the group.

Groups can also be nested (this is experimental as of December 2022 and may change with testing).

See also vehicle extra_flags which can influence the behaviour of vehicles in variant groups.

See also https://github.com/OpenTTD/OpenTTD/pull/10220
|-
| <code style="color:green">extra_flags</code>
| bitmask(VEHICLE_FLAG_XXX, ...)
| no
| {{ottd|13}}
;VEHICLE_FLAG_DISABLE_NEW_VEHICLE_MESSAGE
: Disable "New Vehicle" news message for this engine
;VEHICLE_FLAG_DISABLE_EXCLUSIVE_PREVIEW
: Disable "Exclusive Preview" for this engine
;VEHICLE_FLAG_SYNC_VARIANT_EXCLUSIVE_PREVIEW
: Variants - Include this variant when primary engine has "Exclusive Preview"
;VEHICLE_FLAG_SYNC_VARIANT_RELIABILITY
: Variants - (Attempt to) Synchronize reliability the primary engine.
|}

===Refittability===

To determine whether your vehicle can be refitted to a certain cargo, OpenTTD uses the following table

{| class="t"
! Cargo matches refittable_cargo_classes
! Cargo matches non_refittable_cargo_classes
! Cargo in cargo_allow_refit
! Cargo in cargo_disallow_refit
! Result
|-
| Yes
| No
| Doesn't matter
| No
| Refittable
|-
| No
| Doesn't matter
| No
| Doesn't matter
| Not refittable
|-
| Doesn't matter
| Doesn't matter
| Yes
| No
| Refittable
|-
| Doesn't matter
| Doesn't matter
| Doesn't matter
| Yes
| Not refittable
|}

For those that prefer boolean logic, the formula is as follows:

refittable = ((cargo classes in refittable_cargo_classes AND NOT cargo classes in non_refittable_cargo_classes) OR cargo in cargo_allow_refit) AND NOT (cargo in cargo_disallow_refit)

In general, you should use refittable_cargo_classes and non_refittable_cargo_classes to decide to which cargos your vehicle is refittable, and only then use cargo_allow_refit and cargo_disallow_refit to allow/disallow specific cargos.

===Engine life cycle===

The life cycle of a vehicle model consists of three phases, as outlined in the following table. The length of each phase and the starting, peak, and final reliabilities are randomized for each engine when starting a new game. Also note that phase 2 (the vehicle's peak performance) is actually about 8 years shorter than the <code style="color:darkgreen">model_life</code> parameter.

{| class="t"
! phase
! duration
! reliability
|-
| 1
| 7 to 38 months
| increases from 48-73% to 75-100%
|-
| 2
| <code style="color:darkgreen">model_life</code> - 8 years + (0 to 15 months)
| stays constant at peak, 75-100%
|-
| 3
| 10 to 20.6 years
| decreases from peak to 25-50%
|}

If <code style="color:darkgreen">model_life</code> is set to <code style="color:darkgreen">VEHICLE_NEVER_EXPIRES</code>, the engine remains in phase 2 forever.

Normally, the vehicle is removed from the purchase menu at the and of phase 3. However if you set the <code style="color:darkgreen">retire_early</code> property, it will be retired this many years before (or after, if the value is negative) the end of phase 2.

==Train properties==

{| class="wikitable sortable"
! property
! value range
! available for articulated vehicle
! comment
|-
| <code style="color:green">sprite_id</code>
| <code style="color:green">SPRITE_ID_NEW_TRAIN</code>
| yes
| Set this property to enable new graphics
|-
| <code style="color:green">speed</code>
| 0 ... 65000 (float, speed units)
| no
| Max speed for engines, speed limit for wagons
|-
| <code style="color:green">misc_flags</code>
| bitmask(TRAIN_FLAG_XXX, ...)
| FLIP should not be set, TILT and MU TO the same value as the 1st part
|
;TRAIN_FLAG_TILT
: enable the tilt bonus (20% speed in curves, if all vehicles in consist have it set). See also curve_speed_mod property.
;TRAIN_FLAG_2CC
:Enable use of the 2nd company colour
;TRAIN_FLAG_MU
:act as multiple unit (used for livery selection only)
;TRAIN_FLAG_FLIP
:Allow vehicle to be flipped (reversed) in depot. {{ottdp|13|no|no}} this flag is no longer required, flip is always allowed, except for multi-header or articulated vehicles which cannot be flipped. For vehicles shorter than 8/8, see [[Action0/Vehicles/Trains#cite_note-6|this note about sprite offsets]]
;TRAIN_FLAG_AUTOREFIT
:Allow autoreffitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;TRAIN_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
;TRAIN_FLAG_SPRITE_STACK
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]].
|-
| <code style="color:green">refit_cost</code>
| 0 ... 255
| yes
| in 50% units of the purchase price cost base
|-
| <code style="color:green">callback_flags</code>
| bitmask(VEH_CBF_XXX, ...)
| yes
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| <code style="color:green">track_type</code>
| item from railtypetable
| must be the same as front
| Default railtype table: RAIL, MONO, MGLV. If you install a railtypetable yourself you'll always get the railtype you specified. If you want a vehicle to run on electric rail and you don't have a railtypetable, set <code style="color:green">track_type</code> to RAIL and make sure that you set <code style="color:green">engine_class</code> to <code style="color:green">ENGINE_CLASS_ELECTRIC</code>.
|-
| <code style="color:green">ai_special_flag</code>
| [<code style="color:green">AI_FLAG_PASSENGER</code> <nowiki>|</nowiki> <code style="color:green">AI_FLAG_CARGO</code>]
| no
|
;<code style="color:green">AI_FLAG_PASSENGER</code>
:Tell computer players that it's an engine that should only be used for passenger service.
|-
| <code style="color:green">power</code>
| 0 ... 65000 hp (float, power units)
| Set to 0
|
|-
| <code style="color:green">running_cost_base</code>
| RUNNING_COST_XXX
| Set to RUNNING_COST_NONE
|
;RUNNING_COST_STEAM
;RUNNING_COST_DIESEL
;RUNNING_COST_ELECTRIC
;RUNNING_COST_ROADVEH
;RUNNING_COST_NONE
:no running costs
|-
| <code style="color:green">dual_headed</code>
| [0 <nowiki>|</nowiki> 1]
| Set to 0 for all parts of an articulated vehicle
| 1 = dual_headed, otherwise normal engine
|-
| <code style="color:green">default_cargo_type</code>
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE
| Yes
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).
|-
| <code style="color:green">cargo_capacity</code>
| 0 .. 255
| yes
| By default, passenger capacity is 4x, and mail/goods capacity 2x larger than capacity for other cargoes. The capacity set here is used for the default (i.e. first refittable) cargo. Use the <code style="color:green">cargo_capacity</code> callback to avoid this effect.
|-
| <code style="color:green">weight</code>
| 0 .. 1279 ton (float, mass units)
| Set to 0
|
|-
| <code style="color:green">ai_engine_rank</code>
| 0 ... 255
| no
| TTDPatch only: Higher values make the engine for the TTDPatch AI more attractive
|-
| <code style="color:green">engine_class</code>
| ENGINE_CLASS_XXX
| no
|
Defines which livery colour settings apply to the vehicle. It also sets the corresponding sound effect of the engine, and if visual_effect_and_powered is not set, the visual effect as well.
;ENGINE_CLASS_STEAM
;ENGINE_CLASS_DIESEL
;ENGINE_CLASS_ELECTRIC
;ENGINE_CLASS_MONORAIL
;ENGINE_CLASS_MAGLEV
|-
| <code style="color:green">extra_power_per_wagon</code>
| 0 ... 65000 hp (float, power units)
| Set to 0
| Only wagons with a livery override for this engine will add power
|-
| <code style="color:green">tractive_effort_coefficient</code>
| 0 ... 1 (float)
| Set to 0
| Fraction of the vehicle weight that is available as tractive effort. Tractive effort (in kN) is calculated as (TE coefficient) * 9.8 * weight (in tons), with 9.8 being an approximation of the acceleration of gravity (9.81 m/s).
|-
| <code style="color:green">air_drag_coefficient</code>
| 0 ... 1 (float)
| Set to 0
| Coefficient of the relative air drag, in arbitrary units. The default value is approximately (8 / max_speed), with max_speed in km/h, clamped to the range 0.004 .. 0.75.
|-
| <code style="color:green">length</code>
| 1 ... 8
| yes
| Length of the vehicle in arbitrary units. Use a value of 8 (equal to the predefined constant VEHICLE_LENGTH) for a full-length vehicle.
|-
| <code style="color:green">visual_effect_and_powered</code>
| <code style="color:green">visual_effect_and_powered</code> (VISUAL_EFFECT_XXX, offset, <code style="color:green">ENABLE_WAGON_POWER</code> or <code style="color:green">DISABLE_WAGON_POWER</code>)
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect_and_powered</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model_and_powered</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

Set the type of visual effect for the vehicle and its positional offset with respect to the vehicle. An offset of 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.

;VISUAL_EFFECT_DEFAULT
:No effect, unless for the default vehicles
;VISUAL_EFFECT_STEAM
:Steam like from steam engine
;VISUAL_EFFECT_DIESEL
:Steam from internal combustion engine
;VISUAL_EFFECT_ELECTRIC
:Electric sparks
;VISUAL_EFFECT_DISABLE
:No effect
|-
| <code style="color:green">effect_spawn_model_and_powered</code>
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code> or <code style="color:green">EFFECT_SPAWN_MODEL_XXX <nowiki>|</nowiki> ENABLE_WAGON_POWER</code>
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect_and_powered</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model_and_powered</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.
The visual appearance itself is defined by the callback 'create_effect'.

;EFFECT_SPAWN_MODEL_NONE
: Do not spawn any effects.
;EFFECT_SPAWN_MODEL_STEAM
: Gradually less effects when approaching max speed.
;EFFECT_SPAWN_MODEL_DIESEL
: Effect proportional to acceleration, no effect when idling at top speed.
;EFFECT_SPAWN_MODEL_ELECTRIC
: Random effect, gradually less likely when approaching max speed.
|-
| <code style="color:green">extra_weight_per_wagon</code>
| 0 ... 255 ton (float, mass units)
| Set to 0
| Adds extra weight for powered wagons, see <code style="color:green">extra_power_per_wagon</code>
|-
| <code style="color:green">bitmask_vehicle_info</code>
| 8-bit bitmask
| yes
|
Used for obtaining [[#bitmask consist info|<code style="color:green">bitmask_consist_info</code>]]
|-
| <code style="color:green">curve_speed_mod</code>
| -128 ... 127.996 (float)
| yes
| {{nml|0.7}} {{ottd|12.0}} Maximum curve speed modifier.

The modifier is applied after the normal curve speed calculation is done using the formula max_curve_speed * (1 + curve_speed_mod). This means that the default property value of 0 is equivalent to no change. Negative values are supported, but the resulting vehicle curve speed is clamped at 2 mph-ish to make sure vehicles don't become permanently stuck.

If different vehicles in a train have different curve speed modifiers, the lowest value wins.

See also TRAIN_FLAG_TILT, which is an older and less flexible way of managing vehicle curve speed.
|}

==Road vehicle properties==

{| class="wikitable sortable"
! property
! value range
! available for articulated vehicle
! comment
|-
| sprite_id
| SPRITE_ID_NEW_ROADVEH
| yes
| Set this property to enable new graphics
|-
| speed
| 0 ... 511km/h (float, speed units)
| no
|
|-
| road_type ''or'' tram_type
| item from [[NML:Railtypetable-Roadtypetable-Tramtypetable|roadtypetable]] or [[NML:Railtypetable-Roadtypetable-Tramtypetable|tramtypetable]]
| must be the same as front
| Only ''one'' of these properties may be set.
If <code style="color:green">tram_type</code> is set, <code style="color:green">ROADVEH_FLAG_TRAM</code> must also be set for the vehicle in <code style="color:green">misc_flags</code>.

If not set, road vehicles will default to ROAD and tram vehicles will default to RAIL (this does not overlap with railtype RAIL).
|-
| misc_flags
| bitmask(ROADVEH_FLAG_XXX, ...)
| partly; tram flag must the same
|
;ROADVEH_FLAG_TRAM
:The vehicle requires tram tracks to run on
;ROADVEH_FLAG_2CC
:Enable 2nd company colour
;ROADVEH_FLAG_AUTOREFIT
:Allow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;ROADVEH_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
;ROADVEH_FLAG_SPRITE_STACK
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]].
|-
| refit_cost
| 0 ... 255
| yes
| in 25% units of the purchase price cost base
|-
| callback_flags
| bitmask(VEH_CBF_XXX, ...)
| yes
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| running_cost_base
| RUNNING_COST_XXX
| set to RUNNING_COST_NONE
|
;RUNNING_COST_STEAM
;RUNNING_COST_DIESEL
;RUNNING_COST_ELECTRIC
;RUNNING_COST_ROADVEH
;RUNNING_COST_NONE
:no running costs
|-
| power
| 0 ... 2550hp (float, power units)
| Set to 0
|
|-
| weight
| 0 ... 63.75ton (float, mass units)
| Set to 0
|
|-
| tractive_effort_coefficient
| 0 ... 1 (float)
| Set to 0
| Fraction of the vehicle weight that is available as tractive effort. Tractive effort (in kN) is calculated as (TE coefficient) * 10 * weight (in tons), with 10 being an approximation of the acceleration of gravity (9.81 m/s). Default value is 0.3.
|-
| air_drag_coefficient
| 0 ... 1 (float)
| Set to 0
| Coefficient of the relative air drag, in arbitrary units. The default value is approximately (8 / max_speed), with max_speed in km/h, clamped to the range 0.004 .. 0.75.
|-
| <code style="color:green">default_cargo_type</code>
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE
| Yes
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).
|-
| cargo_capacity
| 0 ... 255
| yes
| By default, passenger capacity is 4x, and mail/goods capacity 2x larger than capacity for other cargoes. The capacity set here is used for the default (i.e. first refittable) cargo. Use the <code style="color:green">cargo_capacity</code> callback to avoid this effect.
|-
| sound_effect
| SOUND_XXX
| no
|
See available [[NML:List of sound effects|sound effects]].
 {{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also <code style="color:green">sound("sound.wav")</code> and <code style="color:green">import_sound(grfid, number)</code> are valid here.
|-
| visual_effect
| visual_effect( VISUAL_EFFECT_XXX, offset)
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

Set the type of visual effect for the vehicle and its positional offset with respect to the vehicle. An offset of 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.

;VISUAL_EFFECT_DEFAULT
:No effect, unless for the default vehicles
;VISUAL_EFFECT_STEAM
:Steam like from steam engine
;VISUAL_EFFECT_DIESEL
:Steam from internal combustion engine
;VISUAL_EFFECT_ELECTRIC
:Electric sparks
;VISUAL_EFFECT_DISABLE
:No effect
|-
| <code style="color:green">effect_spawn_model</code>
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code>
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.
The visual appearance itself is defined by the callback 'create_effect'.

;EFFECT_SPAWN_MODEL_NONE
: Do not spawn any effects.
;EFFECT_SPAWN_MODEL_STEAM
: Gradually less effects when approaching max speed.
;EFFECT_SPAWN_MODEL_DIESEL
: Effect proportional to acceleration, no effect when idling at top speed.
;EFFECT_SPAWN_MODEL_ELECTRIC
: Random effect, gradually less likely when approaching max speed.
|-
| length
| 1 ... 8
| yes
| Length of the vehicle in arbitrary units. Use a value of 8 (equal to the predefined constant VEHICLE_LENGTH) for a full-length vehicle.
|}

==Ship properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| sprite_id
| SPRITE_ID_NEW_SHIP
| Set this property to enable new graphics
|-
| speed
| 0 ... 127 km/h (float, speed units)
| {{ottd|14}}{{nml|7.5}} 0 .. 32767 km/h (float, speed units)
|-
| misc_flags
| bitmask(SHIP_FLAG_XXX)
| Bitmask with to possible flags, set to 0 to disable all.

;SHIP_FLAG_2CC
:Enable use of the 2nd company colour
;SHIP_FLAG_AUTOREFIT
:llow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;SHIP_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
;SHIP_FLAG_SPRITE_STACK
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]].
|-
| refit_cost
| 0 ... 255
| in 1/32 of the default refit cost base
|-
| callback_flags
| bitmask(VEH_CBF_XXX, ...)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| is_refittable
| [0 <nowiki>|</nowiki> 1]
| 0=false, 1=true. Note: if you do not set this property to 1, then refittable_cargo_classes / non_refittable_cargo_classes have no effect.
|-
| <code style="color:green">default_cargo_type</code>
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).
|-
| cargo_capacity
| 0 ... 255
| For ships (unlike other vehicle types) the capacity set here is not affected by the cargo type.
|-
| sound_effect
| SOUND_XXX
|
See available [[NML:List of sound effects|sound effects]].
 {{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also <code style="color:green">sound("sound.wav")</code> and <code style="color:green">import_sound(grfid, number)</code> are valid here.
|-
| ocean_speed_fraction
| 0 ... 1 (float)
|
{{ottd|1.2|r22639}} fraction of base speed on ocean tiles (default: 1)
|-
| canal_speed_fraction
| 0 ... 1 (float)
|
{{ottd|1.2|r22639}} fraction of base speed on canal tiles (default: 1)
|-
| visual_effect
| visual_effect(VISUAL_EFFECT_XXX, offset)
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

XXX=[DEFAULT <nowiki>|</nowiki> STEAM <nowiki>|</nowiki> DIESEL <nowiki>|</nowiki> ELECTRIC <nowiki>|</nowiki> DISABLE], it is the type of the visual effect you want for this ship. Default means no effect. Offset is the position of the effect. 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.
|-
| <code style="color:green">effect_spawn_model</code>
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code>
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.
The visual appearance itself is defined by the callback 'create_effect'.

;EFFECT_SPAWN_MODEL_NONE
: Do not spawn any effects.
;EFFECT_SPAWN_MODEL_STEAM
: Gradually less effects when approaching max speed.
;EFFECT_SPAWN_MODEL_DIESEL
: Effect proportional to acceleration, no effect when idling at top speed.
;EFFECT_SPAWN_MODEL_ELECTRIC
: Random effect, gradually less likely when approaching max speed.
|-
| acceleration
| 1 ... 255
| {{ottd|14}} Acceleration in units of ~0.5 km/h per tick. 1 is the default and is the acceleration of default ships.
|}

==Aircraft properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| sprite_id
| SPRITE_ID_NEW_AIRCRAFT
| Set this property to enable new graphics
|-
| speed
| 0 .. 3280 km/h (float, speed units)
|
|-
| range
| 0 .. 2894
| {{nml|0.3}} {{ottdp|1.2|no|ottdrev=r23504}} Maximum (euclidean) distance the aircraft can cover between two airports. Set to 0 for unlimited range.
|-
| misc_flags
| bitmask(AIRCRAFT_FLAG_2CC, AIRCRAFT_FLAG_AUTOREFIT)
| Bitmask with to possible flags, set to 0 to disable all.

;AIRCRAFT_FLAG_2CC
:Enable 2nd company colour
;AIRCRAFT_FLAG_AUTOREFIT
:Allow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;AIRCRAFT_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
;AIRCRAFT_FLAG_SPRITE_STACK
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]]. This also affects custom rotor sprites.
|-
| refit_cost
| 0 ... 255
| in 1/32 of default refit cost base
|-
| callback_flags
| bitmask(VEH_CBF_XXX, ...)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| aircraft_type
| AIRCRAFT_TYPE_XXX
|
;AIRCRAFT_TYPE_HELICOPTER
:Can land on helipad
;AIRCRAFT_TYPE_SMALL
:Can land on all airports with runway
;AIRCRAFT_TYPE_LARGE
:Can land on all airports with runway. But have a high crash chance on small airports
|-
| acceleration
| {{ottd|1.3.1}} 0 ... 255 {{ottd|<1.3.1}} 0 ... 19
| {{ottd|1.3.1}} Default aircraft use values in the range 18 to 50 (= 6.75 to 18.75 mph/tick = 499.5 to 1387.5 mph/day), which is generally considered quite fast. 
{{ottd|<1.3.1}} In older OpenTTD, aircraft provided by NewGRF accelerate 166% faster than intended.
|-
| passenger_capacity
| 0 ... 65536
| Capacity for the passenger compartment. See also the notes at <code style="color:darkgreen">mail_capacity</code> below.
|-
| mail_capacity
| 0 ... 255
| Capacity for the mail compartment, if refitted to a cargo in the CC_PASSENGERS class. When refitted to other cargoes, this capacity is added to the passenger capacity to determine the base capacity. The actual capacity is set to this base capacity divided by 1 for mail, 2 for goods and 4 for all other cargoes. To override this effect, use the <code style="color:darkgreen">passenger_capacity</code> and <code style="color:darkgreen">mail_capacity</code> callbacks.
|-
| sound_effect
| SOUND_XXX
|
See available [[NML:List of sound effects|sound effects]].
 {{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also <code style="color:green">sound("sound.wav")</code> and <code style="color:green">import_sound(grfid, number)</code> are valid here.
|}

==Vehicle variables==

Below an overview of all vehicle-specific variables. Note that in the purchase list, the vehicle is not built yet and as such many variables are not available. All general variables are available, refer to the table for info on vehicle-specific variables. Trying to access a non-available variable invokes undefined behaviour. Please note that while all variables are available for all vehicles types, some of them only make sense for one or more vehicle types. For example checking current_railtype for a non-rail vehicle doesn't make sense at all, similarly checking current_roadtype for a tram won't return a useful result.

===Variables without parameter===

{| class="wikitable sortable"
! name
! value range
! available in purchase list?
! comment
|-
| position_in_consist
| 0 ... 255
| No
| The position of the current vehicle-part from the start of the vehicle. The engine will get value 0, the first wagon (or second engine) gets value 1, etc.
|-
| position_in_consist_from_end
| 0 ... 255
| No
| Same as position_in_consist but counted from the end. The last wagon will get value 0.
|-
| num_vehs_in_consist
| 1 ... 256
| No
| The total number of vehicles-parts in this vehicle. For aircraft this will include the shadow and the rotor.
|-
| position_in_vehid_chain
| 0 ... 255
| No
| See position_in_consist, but not of the complete vehicle but only all consecutive parts with the same id.
|-
| position_in_vehid_chain_from_end
| 0 ... 255
| No
| See position_in_consist_from_end, but not of the complete vehicle but only all consecutive parts with the same id.
|-
| num_vehs_in_vehid_chain
| 1 ... 256
| No
| See num_vehs_in_consist, but not of the complete vehicle but only all consecutive parts with the same id.
|-
| position_in_articulated_veh
| 0 ... 255
| No
| {{nml|0.3}} {{ottdp|1.4|no|ottdrev=r26157}} The position of the current articulated vehicle from the start of the vehicle. The first will get value 0, the second one gets value 1, etc.
|-
| position_in_articulated_veh_from_end
| 0 ... 255
| No
| {{nml|0.3}} {{ottdp|1.4|no|ottdrev=r26157}} The position of the current articulated vehicle from the end of the vehicle. The last will get value 0, the second last one gets value 1, etc.
|-
| cargo_classes_in_consist
| Bitmask of CC_XXX
| No
|
[[NML:Cargos#Cargo classes|cargo classes]]
|-
| most_common_cargo_type
|
[[NML:Cargos#Cargo properties|Cargo label]]
| No
| The most common cargo type in the consist. Prior to nml r2320 this was known as most_common_refit, and didn't work, and was also incorrectly documented :)
|-
| most_common_cargo_subtype
| 0 ... 255
| No
| The most common cargo subtype for most_common_cargo_type
|-
| bitmask_consist_info
| Bitmask 8 bit
| No
|
Binary OR of the values of [[#bitmask vehicle info|bitmask_vehicle_info]] of all vehicles (engines, wagons) in the consist. Only available for rail vehicles.
|-
| company_num
| 0 ... 14
| Yes
| company number of the vehicle owner. TTDPatch only supports up to 8 companies (0 ... 7)
|-
| company_type
| PLAYERTYPE_XX
| Yes
|
;PLAYERTYPE_HUMAN
:human player
;PLAYERTYPE_AI
:AI player
;PLAYERTYPE_HUMAN_IN_AI
:human managing AI company
;PLAYERTYPE_AI_IN_HUMAN
:AI managing human company

OpenTTD only uses PLAYERTYPE_HUMAN and PLAYERTYPE_AI. If you cheat yourself to be part of an AI company OpenTTD will still report PLAYERTYPE_AI for the company with yourself and the AI and it'll report PLAYERTYPE_HUMAN for the now uncontrolled company.
|-
| company_colour1
| COLOUR_XXX
| Yes
|
Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| company_colour2
| COLOUR_XXX
| Yes
|
Same as company_colour1, if no 2nd company colour is chosen. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| aircraft_height
| 0 ... 255
| No
| Height difference between the aircraft and its shadow. 8 Units are equivalent to one height level on the map.
|-
| airport_type
| AIRPORTTYPE_XX
| No
|
;AIRPORTTYPE_SMALL
;AIRPORTTYPE_LARGE
;AIRPORTTYPE_HELIPORT
;AIRPORTTYPE_OILRIG
|-
| curv_info_prev_cur
| -2 ... 2
| No
| Difference in direction between the previous (towards engine) vehicle and this vehicle. Curvature to the right is positive. 1 unit is 45 degrees.
|-
| curv_info_cur_next
| -2 ... 2
| No
| Difference in direction between this vehicle and the next (towards rear end) vehicle. Curvature to the right is positive. 1 unit is 45 degrees.
|-
| curv_info_prev_next
| -4 ... 4
| No
| Difference in direction between the previous (towards engine) and next (towards rear end) vehicle. Curvature to the right is positive. 1 unit is 45 degrees. Equal to <code style="color:darkgreen">curve_invo_prev_cur + curv_info_cur_next</code>.
|-
| curv_info
| vehicle_curv_info(''prev_cur'', ''cur_next'')''''
| No
|
Returns a magic number that represents the curvature state of the prev-cur-next vehicle triplet. Do not try to make sense of this magic number, use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">vehicle_curv_info()</code> instead to make comparisons. <code style="color:darkgreen">curv_info == vehicle_curv_info(a, b)</code> is equivalent to <code style="color:darkgreen">(curv_info_prev_cur == a) && (curv_info_cur_next == b)</code>, however the former can easily be used in a switch-block.
|-
| motion_counter
| 0 ... 0xFFFFFF
| Yes, always 0
| Is increased every time the vehicle moves a single step on the map. Useful for driving animations.
For that, make the animation use a number of frames, which is a power of two, i.e. 2, 4, 8, 16, 32, ... frames, and then use the lower n bits of motion_counter.
|-
| cargo_type_in_veh
| entry in cargo translation table
| Yes, for the default cargo
| 0xFF if not present in the table
|-
| cargo_unit_weight
| weight per unit in 1/16t
| Yes, for the default cargo
|
|-
| cargo_classes
| Bitmask of [[NML:Cargos#Cargo properties|cargo class]]
| Yes, for the default cargo
| class of the currently transported cargo
|-
| vehicle_is_available
| [0 <nowiki>|</nowiki> 1]
| Yes
| Value is 1 if the vehicle is available on the open market
|-
| vehicle_is_testing
| [0 <nowiki>|</nowiki> 1]
| Yes
| Value is 1 if the vehicle is currently being tested
|-
| vehicle_is_offered
| [0 <nowiki>|</nowiki> 1]
| Yes
| Value is 1 if the vehicle is currently being offered for exclusive preview
|-
| build_year
| 0 ... 5000000
| Yes
| 0-based year when the vehicle was built, current year if the vehicle is not built yet
|-
| direction
| DIRECTION_XX
| No
|
See [[NML:List of direction constants|here]] for an overview of possible values and their meaning.
|-
| cargo_capacity
| 0 ... 65535
| No
| Cargo capacity (number of units) of the vehicle
|-
| cargo_count
| 0 ... 65535
| No
| Number of cargo units of cargo in the vehicle
|-
| cargo_subtype
| 0 ... 255
| Yes, always 0
| Cargo subtype, used to provide more than one refit option for the same cargo type. See also the <code style="color:darkgreen">cargo_subtype_text</code> callback.
|-
| vehicle_is_powered
| [0 <nowiki>|</nowiki> 1]
| No
| Vehicle provides power and is on the correct track type
|-
| vehicle_is_not_powered
| [0 <nowiki>|</nowiki> 1]
| No
| Vehicle is either on a wrong track type or it doesn't provide power at all
|-
| vehicle_is_potentially_powered
| [0 <nowiki>|</nowiki> 1]
| No
| Vehicle provides power, if it is on a suitable track type
|-
| vehicle_is_flipped
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the sprite is reversed via flip-vehicle-in-depot (trains only), or if it's the rear-most part of a dual-head engine.
|-
| vehicle_is_reversed
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle has reversed an odd number of times
|-
| built_during_preview
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle was built during the exclusive preview stage
|-
| current_railtype
| Entry from railtype translation table or 0xFF
| No
| This variable is useless due to equivalent railtypes, use tile_xxx_railtype instead. If you do use this variable, it will not work as expected unless you've defined a railtype translation table. If the train is running on a railtype that is not listed in your railtype translation table this variable will contain 0xFF.
|-
| current_roadtype
| Entry from current_roadtype translation table or 0xFF
| No
| {{nml|0.5}} {{ottdp|1.10|no}} This variable is useless due to equivalent roadtypes, use tile_xxx_roadtype instead. Don't use this variable unless you've defined a roadtype translation table. If the road vehicle is running on a roadtype that is not listed in your roadtype translation table this variable will contain 0xFF. Checking this for a tram is not supported and will not return a useful result.
|-
| current_tramtype
| Entry from tramtype translation table or 0xFF
| No
| {{nml|0.5}} {{ottdp|1.10|no}} This variable is useless due to equivalent tramtypes, use tile_xxx_tramtype instead. Don't use this variable unless you've defined a tramtype translation table. If the road vehicle is running on a tramtype that is not listed in your tramtype translation table this variable will contain 0xFF. Checking this for a road vehicle that is not a tram is not supported and will not return a useful result.
|-
| tile_has_catenary
| No
| [0 <nowiki>|</nowiki> 1]
| {{ottdp|1.11|no}} True if the track_type on the tile has catenary. This is a little simplified as it is intended for sprite changes (e.g. raise/lower pantograph) and only checks for "some catenary". To distinguish different types of electric track, AC and DC voltages etc, ... use tile_xxx_railtype/tile_xxx_roadtype/tile_xxx_tramtype instead.
|-
| waiting_triggers
|
| No
|
Random triggers waiting to be matched. (see [[NML:Random switch|Random switch]])
|-
| random_bits
| 0 ... 255
| No
|
Random data that can be used to randomize certain descisions. (see [[NML:Random switch|Random switch]])
|-
| grfid
| 0 ... 0xFFFFFFFF
| No
|
GRFID that defined the [[NML:Graphics|graphics]]-block for this vehicle. To compare this with other grfids, use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert the other GRFID to a number as well.
|-
| vehicle_type_id
| 0 ... 65535 or a name defined in item block
| No
| GRF-local ID of the vehicle, equal to the item ID. Note that vehicles from other NewGRFs may have the same ID, so you'll generally have to check the <code style="color:darkgreen">grfid</code> as well.
|-
| vehicle_is_hidden
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is hidden in a depot or tunnel.
|-
| vehicle_is_stopped
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is stopped, or if it is braking for a stop (trains only).
|-
| vehicle_is_crashed
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle has crashed.
|-
| vehicle_is_broken
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is broken down.
|-
| date_of_last_service
| date(year, month, day)
| No
|
|-
| breakdowns_since_last_service
| 0 ... 255
| No
| Number of breakdowns since the last service
|-
| reliability
| 0 ... 100
| No
| Reliability (percentage)
|-
| age_in_days
| 0 ... 65535
| No
| Vehicle age in days.
|-
| max_age_in_days
| 0 ... 65535
| No
| Maximum vehicle age in days.
|-
| current_speed
| (speed units)
| No
| The current speed of the vehicle in m/s
|-
| max_speed
| (speed units)
| No
| The maximum speed of the vehicle in m/s
|-
| current_max_speed
| (speed units)
| No
| {{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24246}} Current maximum speed of the vehicle in m/s. This includes e.g. track or timetable limits. Only valid for front vehicle.
|-
| vehicle_is_in_depot
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is inside a depot
|-
| vehicle_is_unloading
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottdp|1.5|2.5|ottdrev=r26430}} Value is 1 if the vehicle is unloading at a station and has not yet started loading new cargo.
|}

===Variables that require an argument===

{| class="wikitable sortable"
! name
! Argument
! value range
! available in purchase list?
! comment
|-
| count_veh_id
| The vehicle ID to look for.
| 0..255
| No
| The number of vehicles in the current consist that have the given ID.
|-
| other_veh_curv_info
| Offset in the chain from the current vehicle.<ref name="offset">Argument range is -128..127. 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.</ref>
| -4..4
| No
| Difference in direction between the other vehicle and this vehicle. Curvature to the right is positive. 1 unit is 45 degrees.
|-
| other_veh_is_hidden
| Offset in the chain from the current vehicle.<ref name="offset"/>
| [0 <nowiki>|</nowiki> 1]
| No
| 1 the other vehicle is hidden in a depot or tunnel, 0 otherwise
|-
| other_veh_x_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in X-position (top-right to bottom-left) between the other vehicle and this vehicle.
|-
| other_veh_y_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in Y-position (top-left to bottom-right) between the other vehicle and this vehicle.
|-
| other_veh_z_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in Z-position (upwards) between the other vehicle and this vehicle.
|-
| tile_supports_railtype tile_supports_roadtype tile_supports_tramtype
| Entry from rail/road/tram translation table
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottdp|1.11|no}} Vehicles of the track_type label used as parameter are compatible with the rail/road/tram track_type on the current tile. Example: <code style="color:darkgreen">tile_supports_railtype(ELRL)</code>
|-
| tile_powers_railtype tile_powers_roadtype tile_powers_tramtype
| Entry from rail/road/tram translation table
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottdp|1.11|no}} Vehicles of the track_type label used as parameter are powered on the rail/road/tram track_type on the current tile. Example: <code style="color:darkgreen">tile_powers_railtype(ELRL)</code>
|-
| tile_is_railtype tile_is_roadtype tile_is_tramtype
| Entry from rail/road/tram translation table
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottdp|1.11|no}} The track_type label used as parameter is identical or equivalent (listed as alternate label in rail-/road-/tram-type property 1D) to the rail/road/tram track_type on the current tile. Example: <code style="color:darkgreen">tile_is_railtype(ELRL)</code>

|}
<references/>

==Vehicle callbacks==
The following table contains a list of available vehicle callbacks. Additionally, it's possible to provide cargo-specific graphics, using the identifier from the [[NML:Cargotable|cargo table]] as callback name. These callbacks will be used if the vehicle is refitted to the corresponding cargo type. If no cargo-specific graphics match the cargo that the vehicle is carrying, the <code style="color:darkgreen">default</code> callback is used instead. Cargo-specific graphics callbacks are never called from the purchase menu, refer to the <code style="color:darkgreen">purchase</code> callback below instead.

Note that the above affects '''graphics only''', other callbacks are unaffected.

{| class="wikitable sortable"
! Name
! Available for
! In purchase menu?
! value range
! comment
|-
| default
| All
| Yes, unless <code style="color:darkgreen">purchase</code> is set separately
| Sprite group
| 'Normal' vehicle graphics, if no cargo-specific graphics apply. See also the section on [[#Sprites in GUI|GUI sprites]].
|-
| purchase
| All
| Yes, only
| Sprite group
| Graphics to show in the buy menu (only the horizontal view is needed, except for dual-headed trains. With the <code>dual_headed</code> property set, special rules for the purchase menu sprite apply: two sprites are drawn (for front and back) as if the vehicle is normally constructed. If you supply one purchase menu sprite, it will be used for both vehicle parts in the purchase menu. Provide a set of 8 sprites, and the 7th resp. 3rd sprite will be drawn; provide a set of 8 blank sprites except the 7th if you want to fully control a single purchase menu sprite for a dual-headed engine. ) See also the section on [[#Sprites in GUI|GUI sprites]].
|-
| rotor
| Aircraft (helicopters)
| No
| Sprite group
| Graphics for the helicopter rotor (4 sprites; 1 stopped and 3 moving)
|-
| random_trigger
| All
| No
| N/A
| See [[NML:Random switch|random switch]] for more information.
|-
| cargo_subtype_text
| All
| No
| String, or CB_RESULT_NO_TEXT
| NOTE: As of OpenTTD 13, this feature is considered deprecated for most uses. Use variants instead. With this callback, you can display extra text after the cargo in the vehicle information window. This callback is called during refitting, with succesively increased values of the <code style="color:darkgreen">cargo_subtype</code> variable, until the callback returns CB_RESULT_NO_TEXT. All returned strings are then displayed as refit options. The chosen refit option is saved in the <code style="color:darkgreen">cargo_subtype</code> variable, so it can be used to select specific sprites for the vehicle's current cargo subtype.
|-
| additional_text
| All
| Yes, only
| String
| Additional text to show in the purchase list.
|-
| colour_mapping
| All
| Yes, unless <code style="color:darkgreen">purchase_colour_mapping</code> is set separately
| Recolour sprite number
|
With this callback, you can use a different recolour sprite instead of the standard 1cc / 2cc company colour remappings. See [[NML:List of default colour translation palettes|here]] for a list of default palettes. See the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">reserve_sprites()</code> for info on how to allocate your own sprite. For performance, the result is cached and only updated if the <code style="color:darkgreen"> every_32_days</code> callback requires so. Add CB_RESULT_COLOUR_MAPPING_ADD_CC to the result to add the company colour to the sprites, this requires 16 (1cc) or 256 (2cc) sprites in total.
|-
| start_stop
| All
| No
| String or CB_RESULT_NO_TEXT
| Called when starting or stopping a vehicle. Mainly useful to prevent vehicles from leaving the depot unless a certain condition is met. Return CB_RESULT_NO_TEXT to allow or a string (containing an error message) to disallow starting/stopping.
|-
| every_32_days
| All
| No
| bitmask(CB_RESULT_32_DAYS_XXX, ...)
| Called every 32 days. Set CB_RESULT_32_DAYS_TRIGGER in the bitmask to trigger TRIGGER_VEHICLE_32_CALLBACK. Set CB_RESULT_32_DAYS_COLOUR_MAPPING in the bitmask to update the colour mapping by re-running the <code style="color:darkgreen">colour_mapping</code> callback.
|-
| sound_effect
| All
| No
| SOUND_XXX, sound("sound.wav"), import_sound(grfid, number) or CB_RESULT_NO_SOUND
|
Called to play various vehicle sounds.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> The sound event, see the [[#Sound events|table]] below.
Return SOUND_XXX (see [[NML:List_of_sound_effects|here]]) to return a default sound. <code style="color:darkgreen">sound("soundfile")</code> imports a sound from a .wav file. <code style="color:darkgreen">import_sound(grfid, number)</code> imports a sound from another grf. A failed (or not implemented) callback will cause the default sound to be played. Return CB_RESULT_NO_SOUND to play no sound at all.
|-
| articulated_part
| Trains, Road Vehicles
| Yes (no separate callback)
| Vehicle ID, or CB_RESULT_NO_MORE_ARTICULATED_PARTS
| With this callback, you can add articulated parts (e.g. tenders) to your vehicle. Called repeatedly, until CB_RESULT_NO_MORE_ARTICULATED_PARTS is returned. After each call, the returned vehicleID is added to your vehicle.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> contains 1 during the first call, 2 during the second, etc.
Note that callback may be called from the purchase list, using vehicle variables is not possible. Or CB_RESULT_REVERSED_VEHICLE to the returned vehicle ID to display the vehicle backwards.

The vehicle ID for the articulated part must be in the range 0 .. 16383.

For NML 0.2 and lower the vehicle ID of the articulated part must be in the range 0 .. 127.

|-
| can_attach_wagon
| Trains
| No
| String or CB_RESULT_ATTACH_XXX
| Called when a wagon is being attached, to allow or disallow attaching. If a wagon is inserted in the middle, all wagons are removed and attached one-by-one in the new order. This callback has to be defined at the engine. The scopes behave different than usual though:
* <code style="color:darkgreen">SELF</code> refers to the wagon being attached. (despite the callback being defined at the engine)
* <code style="color:darkgreen">PARENT</code> refers to the consist of the engine up to the wagon before <code style="color:darkgreen">SELF</code>, i.e. not (yet) including the wagon being attached.
Return a string to disallow with the string as error message. Return CB_RESULT_ATTACH_DISALLOW to disallow with standard message ("incompatible railtypes"), CB_RESULT_ATTACH_ALLOW to allow or CB_RESULT_ATTACH_ALLOW_IF_RAILTYPES to allow if the railtypes match (default).
|-
| refit_cost
| {{ottdp|1.2|no|ottdrev=r23089}} All
| Yes
| -8192 .. 8191 as refit cost. Add <code style="color:darkgreen">CB_RESULT_AUTOREFIT</code> if you want to allow autorefit.
| When returning a negative value, encode the cost as (cost & <code style="color:darkgreen">CB_RESULT_REFIT_COST_MASK</code>) before (possibly) adding <code style="color:darkgreen">CB_RESULT_AUTOREFIT</code>. To allow autorefitting, the corresponding bit in the <code style="color:darkgreen">misc_flags</code> must be set as well.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>: The new cargo type.
* <code style="color:darkgreen">getbits(extra_callback_info1, 8, 8)</code>: The new cargo subtype (see <code style="color:darkgreen">cargo_subtype_text</code>-callback).
* <code style="color:darkgreen">getbits(extra_callback_info1, 16, 16)</code>: A bitmask of the [[NML:Cargos#Cargo_classes|cargo classes]] of the target cargo type.
Note that this callback may also be called when the vehicle does not exist yet, so the available variables are limited.
|-
| create_effect
| {{ottdp|1.5|no|ottdrev=r26747}} Trains, Road Vehicles, Ships
| No
| 0 .. 3 for number of effects. Optionally add <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_CENTER</code> and/or <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>
| Called when a effect spawning model is defined via <code style="color:darkgreen">effect_spawn_model</code> resp. <code style="color:darkgreen">effect_spawn_model_and_powered</code>.

The result specifies how many effects shall be created.
The position and appearance of the individual effects is returned via registers 0x100 to 0x103:
<pre style="color:blue">
switch (FEAT_XXX, SELF, switch_name, [
STORE_TEMP(create_effect(EFFECT_SPRITE_XXX, 8, -3, 10), 0x100), // first effect,
STORE_TEMP(create_effect(EFFECT_SPRITE_YYY, 8, 3, 10), 0x101) // second effect, ...
]) {
return 2; // number of effects
}
</pre>
The register values are created using the <code style="color:darkgreen">create_effect(''effect_sprite'', ''l_x_offset'', ''t_y_offset'', ''z_offset'')</code> function:
* ''effect_sprite'': Sprite for the effect. One of <code style="color:darkgreen">EFFECT_SPRITE_</code>[<code style="color:darkgreen">NONE</code>|<code style="color:darkgreen">STEAM</code>|<code style="color:darkgreen">DIESEL</code>|<code style="color:darkgreen">ELECTRIC</code>|<code style="color:darkgreen">AIRCRAFT_BREAKDOWN_SMOKE</code>].
* ''l_x_offset'': Longitudinal or X position of the effect, depending on callback result <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>.
* ''t_y_offset'': Transversal or Y position of the effect, depending on callback result <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>.
* ''z_offset'': Z position of the effect.

Additional to the number of effects, the callback result may specify these flags:
;<code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_CENTER</code>
:(Train and road vehicle only) If set, position effect relative to vehicle center instead of relative to vehicle sprite. (behaves the same for vehicles with length 8/8)
;<code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>
*If not set, the parameters to <code style="color:darkgreen">effect_sprite</code> describe longitudinal/transversal positions, which are rotate wrt. vehicle orientation.
*If set, the parameters to <code style="color:darkgreen">effect_sprite</code> describe X and Y positions, which are not automatically rotated.
|-
| reverse_build_probability
| {{nml|0.7.5}} {{ottd|14.0}} Trains
| No
| 0 .. 100
| Probability of reversing rail vehicle, i.e. facing forward or backward, when purchased.
|}

The following callbacks all have an equivalent property. The property description applies here also, except where otherwise noted.

{| class="wikitable sortable"
! Name
! Available for
! In purchase menu?
! comment
|-
| loading_speed
| All
| No
|
|-
| speed
| All
| Yes, unless <code style="color:darkgreen">purchase_speed</code> is set separately
| Units are not (yet) available
|-
| cost_factor
| All
| Yes, only
|
|-
| running_cost_factor
| All
| Yes, unless <code style="color:darkgreen">purchase_running_cost_factor</code> is set separately
|
|-
| cargo_age_period
| All
| No
|
|-
| cargo_capacity
| All except aircraft
| Yes, unless <code style="color:darkgreen">purchase_cargo_capacity</code> is set separately
|
|-
| passenger_capacity
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_passenger_capacity</code> is set separately
|
|-
| mail_capacity
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_mail_capacity</code> is set separately
|
|-
| range
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_range</code> is set separately
|
|-
| visual_effect_and_powered
| Trains
| No
|
|-
| visual_effect
| Road Vehicles, Ships
| No
|
|-
| effect_spawn_model_and_powered
| Trains
| No
|
|-
| effect_spawn_model
| Road Vehicles, Ships
| No
|
|-
| power
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_power</code> is set separately
| Units are not (yet) available
|-
| weight
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_weight</code> is set separately
| Units are not (yet) available
|-
| length
| Trains, Road vehicles
| No
|
|-
| tractive_effort_coefficient
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_tractive_effort_coefficient</code> is set separately
| Value range is 0 .. 255 instead of 0 .. 1.
|-
| bitmask_vehicle_info
| Trains
| No
|
|-
| curve_speed_mod
| {{nml|0.7}} {{ottd|12.0}} Trains
| No
|
|-
| name
| {{nml|0.7.2}} {{ottd|14.0}} All
| Yes
| Can be used to display vehicle name differently depending on context (purchase menu, depot, nested variant depth etc). <code style="color:darkgreen">extra_callback_info1</code> contains detailed information about context - please see https://newgrf-specs.tt-wiki.net/wiki/Callbacks#Engine_name_.28161.29
|}

===Sprites in GUI===
{{ottdp|1.2|no|ottdrev=r23080}} Since OpenTTD r23080 you can use variable <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> to display different sprites in the GUI and on the map. Currently these cases are available:
{| |-
! getbits(extra_callback_info1, 0, 8) !! Meaning
|-
| 0x00 || Vehicle is drawn in a viewport, i.e. on the map.
|-
| 0x01..0x0F || reserved
|-
| 0x10 || Vehicle is drawn in the depot GUI. <ref>OpenTTD also uses this value with the purchase-list chain (cargotype FF) to determine the gridsize in ship and aircraft depots.</ref>
|-
| 0x11 || Vehicle is drawn in the vehicle details GUI. (This includes the refit GUI.)
|-
| 0x12 || Vehicle is drawn in the vehicle list.
|-
| 0x13..0x1F || reserved for other future GUIs.
|-
| 0x20 || Vehicle is drawn in the purchase list. (This includes the autoreplace GUI.)
|-
| 0x21 || Vehicle is drawn in the exclusive preview GUI or in the advertisement news.
|-
| 0x22..0x2F || reserved for other future GUIs with non-purchased vehicles.
|-
| 0x30..0xFF || reserved
|}
<references/>
The cases 0x20..0x2F are called using the <code style="color:darkgreen">purchase</code>-callback, the other cases are called for the <code style="color:darkgreen">default</code>- or cargo-specific callbacks. Exception is the the special depot-gridsize call, which uses the <code style="color:darkgreen">purchase</code>-callback.

===Composing vehicles from multiple sprites===
{{ottdp|1.7|no|ottdrev=r27668}} Since OpenTTD r27668 you can draw vehicles by drawing multiple sprites on top of each other.
* The sprites can use different recolouring.
* When using 32bpp sprites, the sprites can use the alpha channel to blend with the other sprites. In particular you can use this to alpha-blend company colours over other sprites.

To enable this, you need to set <code style="color:darkgreen">XXX_FLAG_SPRITE_STACK</code> in the <code style="color:darkgreen">misc_flags</code> property.

When enabled, sprites are resolved multiple times while incrementing an iteration number, that can be read via
<code style="color:darkgreen">getbits(extra_callback_info1, 8, 8)</code>

For OpenTTD 1.7 to 12.0, this is limited to at most 4 sprites per articulated part.

Increased to 8 sprites per articulated part for OpenTTD 13.0 {{ottdp|13.0|no}}

In addition you need to set register 100 as additional result:
* <code style="color:darkgreen">STORE_TEMP(CB_FLAG_MORE_SPRITES | recolouring, 0x100)</code> if there are more sprites to draw.
* <code style="color:darkgreen">STORE_TEMP(recolouring, 0x100)</code> if there are no more sprites to draw.
"recolouring" can be:
* <code>PALETTE_USE_DEFAULT</code> to use the default vehicle recolouring.
* <code>PALETTE_IDENTITY</code> to use no recolouring
* Any other default or custom recolouring sprite.

===Sound events===

{| class="wikitable sortable"
! Event
! Description
|-
| SOUND_EVENT_START
| Vehicle leaves station or depot, plane takes off
|-
| SOUND_EVENT_TUNNEL
| Vehicle enters tunnel
|-
| SOUND_EVENT_BREAKDOWN
| Vehicle breaks down (not for planes)
|-
| SOUND_EVENT_RUNNING
| Once per engine tick, but no more than once per vehicle motion
|-
| SOUND_EVENT_TOUCHDOWN
| Aircraft touches down
|-
| SOUND_EVENT_VISUAL_EFFECT
| Visual effect is generated (steam plume, diesel smoke, electric spark)
|-
| SOUND_EVENT_RUNNING_16
| Every 16 engine ticks if in motion
|-
| SOUND_EVENT_STOPPED
| Every 16 engine ticks if stopped
|-
| SOUND_EVENT_LOAD_UNLOAD
| Consist loads or unloads cargo
|}

== Vehicle IDs ==
Picking an item ID requires keeping two cases in mind: OpenTTD with the engine pool enabled and OpenTTD with engine pool disabled / TTDPatch. The status of the engine pool may be checked with the global variable [[NML:General#General_variables|dynamic_engines]].

Note that while vehicle ID affects the order in which vehicles appear in the purchase menu, this can be overridden using the [[NML:Sorting vehicles in the purchase list|sort block]].

=== Engine pool enabled ===
With the engine pool enabled, each NewGRF has its own ID range, NewGRFs don't influence each other. IDs may freely be chosen between 0 and 65535. If the chosen ID belongs to an existing vehicle, this vehicle is overridden by your vehicle. If another NewGRF is already overriding that vehicle, a new vehicle will be allocated, but all the properties will be copied from the old vehicle. If you define an ID for which no original vehicle exists, a new (blank) vehicle is allocated.

This behaviour can be modified using an [[NML:Overriding_vehicles_in_other_NewGRFs|engine_override]], this allows changing the properties of vehicles defined in other NewGRFs instead of allocating a new vehicle.

=== TTDPatch / Engine pool disabled ===
Each new vehicle has to replace an existing vehicle. If multiple NewGRFs try to replace the same vehicle, the last NewGRF loaded 'wins'. [[VehicleIDs|This page]] contains a list of valid vehicle IDs for each vehicle type, look in the 'NML ID' column. Note that IDs are not bound to a specific sort of vehicle (e.g. monorail wagons) but to a feature (e.g. trains, road vehicles).

In general, you should take the following steps:
* If your NewGRF is intended as a complete replacement for the default vehicles, disable the relevant default vehicles using [[NML:Disable_items|disable_item]].
* Re-use IDs of existing vehicles as much as possible.
* If your NewGRF uses IDs outside of the normal range (for example, because you there are more vehicles than slots available), let your code check if dynamic_engies is enabled. If not, skip the vehicles outside the normal range (using an if-statement) and make sure that the remaining vehicles allow for reasonable gameplay. It is recommended to issue a warning to the user about this. Alternatively, it is also possible to disable your entire NewGRF. If you don't do this check and dynamic_engines is off, OpenTTD may disable your NewGRF with the somewhat cryptic message 'Attempt to use invalid ID', which will likely lead to bug reports about your NewGRF and/or your OpenTTD.

Callback: Articulated engine

2024-12-03T10:42:26Z

Peter1138: Added note about ID numbers

== Articulated engine (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 as long as the callback says so.

{{grfTill|7}} For GRF version 7 and below the return value uses 8 bits.
Bit 0 to 6 define the ID of the vehicle to add. If 80 is added to the ID, the vehicle will be reversed. Returning FF means to finish the articulated vehicle, and not attach more parts. Therefore IDs used for articulated parts must be less than 7E (7F if not reversed).

{{grfFrom|8}} For GRF version 8 and above the return value uses 15 bits.
Bit 0 to 13 define the ID of the vehicle to add. If 4000 is added to the ID, the vehicle will be reversed. Returning 7FFF means to finish the articulated vehicle, and not attach more parts. Therefore IDs used for articulated parts must be less than 3FFE (3FFF if not reversed).

Note that since the train is not yet built, you cannot use train variables in action 2. Instead, use the first byte of variable 10 (extra callback info 1), which is set to 01 for the first articulated part, 02 for the second and so on.

{{ottdp|0.6|2.5|ttdprev=beta 8}} If more than the first vehicle contains cargo, the callback must work in the buy menu as well. 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.

{{ottd| }} 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]].
[[Category:Callbacks]]

Action0/Vehicles/Planes

2024-11-11T15:02:01Z

Peter1138: Obsolete prop 13

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

== Introduction ==

Defining properties of planes.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.0}}||Sprite (FF for new graphics)
|-
|09||B||{{ottdp|0.6|2.0}}||Is helicopter? 2=no, 0=yes
|-
|0A||B||{{ottdp|0.6|2.0}}||Is large? 0=no, 1=yes (i.e. can't safely land on small airports)
|-
|0B||B||{{ottdp|0.6|2.0}}||Cost factor
|-
|0C||B||{{ottdp|0.6|2.0}}||Speed in units of 8 mph, that is: property = (speed in mph) / 8
|-
|0D||B||{{ottdp|0.6|2.0}}||Acceleration in units of 3/8 mph/tick, that is: property = (acceleration in mph/tick) * 8/3 <ref>{{ottd|<1.3.1}} In OpenTTD before r25115 the units for acceleration were messed up. The unit used was about 1 mph/tick, so aircraft accelerated more than twice as fast. Also values bigger than 19 failed.</ref>
|-
|0E||B||{{ottdp|0.6|2.0}}||Running cost factor
|-
|0F||W||{{ottdp|0.6|2.0}}||Primary cargo capacity (passenger or refitted cargo)
|-
|11||B||{{ottdp|0.6|2.0}}||Secondary cargo capacity (mail)
|-
|12||B||{{ottdp|0.6|2.0}}||Sound effect
|-
|13||D||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Bit mask of cargo types available for refitting, see column 2 (Bit Value) in [[CargoTypes]]. Obsoleted by properties 1D/1E
|-
|14||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Callback flags bit mask, see below
|-
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Refit cost, using 1/32 of the default refit cost base
|-
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||Retire vehicle early, this many years before the end of phase 2 (see [[Action0General]])
|-
|17||B||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Miscellaneous vehicle flags
|-
|18||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Refittable cargo classes, see [[Action0Trains#Cargo classes 28 29|train prop. 28]]
|-
|19||W||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||Non-refittable cargo classes, see [[Action0Trains#Cargo classes 28 29|train prop. 29]]
|-
|1A||D||{{ottdp|0.6|2.5|ttdprev=r1210|ottdrev=r7191}}||Long format introduction date
|-
|1B||B*||{{ottdp|0.7|no|ottdrev=r13831}}||Sort the purchase list
|-
|1C||W||{{ottdp|1.2|no|ottdrev=r22713}}||Custom cargo ageing period
|-
|1D||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of always refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2C]]
|-
|1E||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of never refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2D]]
|-
|1F||W||{{ottdp|1.2|no|ottdrev=r23504}}||Aircraft range in tiles. Distance is euclidean, a value of 0 means range is unlimited
|-
|20||W||{{ottdp|13|no}}||Vehicle variant group, see [[Action0/Vehicles/Trains#Vehicle_variant_group_.282F.29|train property 2F]]
|-
|21||D||{{ottdp|13|no}}||Extra flags, see [[Action0/Vehicles/Trains#Extra_flags_.2830.29|train property 30]]
|-
|22||B||{{ottdp|14|no|ottdrev=g2d73076056}}||Additional callback flags bit mask, see below
|}
<references/>

== Descriptions ==

=== Primary (0F) and secondary (11) cargo capacity ===
Aircraft can transport up to two cargo types.
The first (primary) cargo type can be changed when refitting the aircraft.

The secondary cargo type is always mail, and is only present when the primary cargo type is part of the [[Action0/Cargos#CargoClasses_.2816.29|passenger cargo class]].

See also the page about [[VehicleRefitting|vehicle refitting]].

=== Sound effect (12) ===

The following sound effects are used by planes (note, the setting is ignored for helicopters):

{| |-
!Number!!Sound
|-
|06||Propeller sound 1
|-
|07||Jet sound 1
|-
|3B||Supersonic
|-
|3D||Jet sound 2
|-
|45||Propeller sound 2
|-
|46||Jet sound 3
|}

{{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also custom sound effects from Action11 are allowed here.

{{ottdp|1.11|no|ottdrev=6198a47}} Since OpenTTD g6198a47 this prop can be used to to set custom Action11 sound effects for helicopers. Default sound effects are ignored as before.

=== Callbacks (14, 22) ===
For planes, the following [[callbacks]] have to be enabled by setting the corresponding bit in property 14 (certain other, not as frequently used callbacks are available without setting a bit here)::

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|2||4||12||Load amount
|-
|3||8||15||Set refitted capacity
|-
|5||20||19||show a suffix after the cargo type name
|-
|6||40||2D||Select color mapping for vehicle
|-
|7||80||33||Sound effect callbacks
|-
|8||100||161||{{ottd|14|ottdrev=gf5394ed2ef}}Engine name
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the VarAction2 for callbacks.

=== Refit cost (15) ===

Refit cost, using 1/32 of the default refit cost base. This property can be overridden by callback 15E.

{{ottdp|1.2|no|ottdrev=r23087}} If the refit cost factor is set to zero and bit 4 of the miscellaneous flags (17) is set, auto-refitting is allowed.

=== Miscellaneous flags (17) ===

This is a bit mask, with the following bits:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||reserved, do not use
|-
|1||2||Uses two company colors
|-
|2||4||reserved, do not use
|-
|3||8||reserved, do not use
|-
|4||10||{{ottdp|1.2|no|ottdrev=r23087}} Auto-refitting is enabled for refits where callback 15E allows it or prop 15 specifies zero cost.
|-
|5||20||{{ottdp|1.2|no|ottdrev=r23861}} Use cargo multiplier for default cargo. See page about [[VehicleRefitting#Misc._vehicle_flag_5_.27use_of_capacity_multiplier_for_default_cargo.27_set|vehicle refitting]].
|-
|6||40||{{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect.
|-
|7|| 80||{{ottdp|1.7|no|ottdrev=r27668}} [[Action2/Vehicles#Composing_vehicles_from_multiple_sprites|Compose vehicle from multiple sprites.]]
Note: This also applies to the rotor sprite, if custom rotor sprites are used.
|}

=== Long format introduction date (1A) ===

Set the vehicle introduction date, in days since the year 0. This takes account of leap years; dividable by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). This property must be set after property 00 to take effect.

{{ottdp|no|}} In TTDPatch, dates after 2044 will be limited to 2044.

=== Sort vehicle list (1B) ===
See sort vehicle list for [[Action0Trains#Sort vehicle list 1A|trains]] for details.

=== Custom cargo ageing period (1C) ===
See custom cargo ageing period for [[Action0Trains#Custom_cargo_ageing_period_.282B.29|trains]] for details.

== Example ==

To be written

Action0/Vehicles/Ships

2024-11-11T15:01:22Z

Peter1138: Obsolete prop 11

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

== Introduction ==

Defining properties of ships.
== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.0}}||Sprite (FF for new graphics)
|-
|09||B||{{ottdp|0.6|2.0}}||Refittable (0 no, 1 yes)
|-
|0A||B||{{ottdp|0.6|2.0}}||Cost factor
|-
|0B||B||{{ottdp|0.6|2.0}}||Speed in mph*3.2, use property 23 for speeds > 255
|-
|0C||B||{{ottdp|0.6|2.0}}||Cargo type, see [[CargoTypes]] 
{{grfTill|7}} For GRF version 7 and below: Type B 'cargo slot' 
{{grfFrom|8}} For GRF version 8 and above: Type A '(translated) cargo bit' 
{{ottd|15.0}} Since 15.0, a default cargo translation table corresponding to the climate is used if one is not provided.
|-
|0D||W||{{ottdp|0.6|2.0}}||Capacity
|-
|0F||B||{{ottdp|0.6|2.0}}||Running cost factor
|-
|10||B||{{ottdp|0.6|2.0}}||Sound effect type (4=cargo ship, 5=passenger ship) {{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also custom sound effects from Action11 are allowed here.
|-
|11||D||{{ottdp|0.6|2.0}} {{grfFrom|1}}||Bit mask of cargo types available for refitting, see column 2 (bit values) in [[CargoTypes]]. Obsoleted by properties 1E/1F
|-
|12||B||{{ottdp|0.6|2.5}} {{grfFrom|6}}||Callback flags bit mask, see below
|-
|13||B||{{ottdp|0.6|2.5|ttdprev=alpha 30}}||Refit cost, using 1/32 of the default refit cost base
|-
|14||B||{{ottdp|1.2|2.5|ttdprev=alpha 44|ottdrev=r22639}}||Ocean speed fraction, sets fraction of top speed available in the ocean; e.g. 00=100%, 80=50%, FF=0.4%
|-
|15||B||{{ottdp|1.2|2.5|ttdprev=alpha 44|ottdrev=r22639}}||Canal speed fraction, same as above but for canals and rivers
|-
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 44}}||Retire vehicle early, this many years before the end of phase 2 (see [[Action0General]])
|-
|17||B||{{ottdp|0.6|2.5|ttdprev=alpha 55}}||Miscellaneous vehicle flags
|-
|18||W||{{ottdp|0.6|2.5|ttdprev=alpha 55}}||Refittable cargo classes, see [[Action0Trains#Cargo_classes_.2828.2C_29.29|train prop. 28]]
|-
|19||W||{{ottdp|0.6|2.5|ttdprev=alpha 55}}||Non-refittable cargo classes, see [[Action0Trains#Cargo_classes_.2828.2C_29.29|train prop. 29]]
|-
|1A||D||{{ottdp|0.6|2.6|ttdprev=r1210|ottdrev=r7191}}||Long format introduction date
|-
|1B||B*||{{ottdp|0.7|no|ottdrev=r13831}}||Sort the purchase list
|-
|1C||B||{{ottdp|1.1|no|ottdrev=r21240}}||Visual effect
|-
|1D||W||{{ottdp|1.2|no|ottdrev=r22713}}||Custom cargo ageing period
|-
|1E||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of always refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2C]]
|-
|1F||B n*B||{{ottdp|1.2|no|ottdrev=r23291}}||List of never refittable cargo types, see [[Action0/Vehicles/Trains#List_of_always_refittable_cargo_types_.282C.2C_2D.29|train property 2D]]
|-
|20||W||{{ottdp|13|no}}||Vehicle variant group, see [[Action0/Vehicles/Trains#Vehicle_variant_group_.282F.29|train property 2F]]
|-
|21||D||{{ottdp|13|no}}||Extra flags, see [[Action0/Vehicles/Trains#Extra_flags_.2830.29|train property 30]]
|-
|22||B||{{ottdp|14|no|ottdrev=g2d73076056}}||Additional callback flags bit mask, see below
|-
|23||W||{{ottdp|14|no|ottdrev=g5a55c4a934}}||Speed in mph*3.2
|-
|24||B||{{ottdp|14|no|ottdrev=g5a55c4a934}}||Acceleration in mph*3.2/h (0.5 km-ish/h). Minimum 1, defaults to 1 when omitted
|}

== Descriptions ==

=== Callbacks (12, 22) ===
For ships, the following [[callbacks]] have to be enabled by setting the corresponding bit in properties 12 and 22 (certain other, not as frequently used callbacks are available without setting a bit here):

{| |-
!Bit!!Value!!Variable 0C value!!Callback
|-
|2||4||12||Load amount
|-
|3||8||15||Set refitted capacity
|-
|5||20||19||show a suffix after the cargo type name
|-
|6||40||2D||Select color mapping for vehicle
|-
|7||80||33||Sound effect callbacks
|-
|8||100||161||{{ottd|14|ottdrev=gf5394ed2ef}}Engine name
|}

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the VarAction2 for callbacks.

=== Refit cost (13) ===

Refit cost, using 1/32 of the default refit cost base. This property can be overridden by callback 15E.

{{ottdp|1.2|no|ottdrev=r23087}} If the refit cost factor is set to zero and bit 4 of the miscellaneous flags (17) is set, auto-refitting is allowed.

=== Miscellaneous flags (17) ===

This is a bit mask, with the following bits:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||reserved, do not use
|-
|1||2||Uses two company colors
|-
|2||4||reserved, do not use
|-
|3||8||reserved, do not use
|-
|4||10||{{ottdp|1.2|no|ottdrev=r23087}} Auto-refitting is enabled for refits where callback 15E allows it or prop 13 specifies zero cost.
|-
|5|| 20||{{ottdp|1.2|no|ottdrev=r23861}} Use cargo multiplier for default cargo. See page about [[VehicleRefitting#Misc._vehicle_flag_5_.27use_of_capacity_multiplier_for_default_cargo.27_set|vehicle refitting]].
|-
|6|| 40||{{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect.
|-
|7|| 80||{{ottdp|1.7|no|ottdrev=r27668}} [[Action2/Vehicles#Composing_vehicles_from_multiple_sprites|Compose vehicle from multiple sprites.]]
|}

=== Long format introduction date (1A) ===

Set the vehicle introduction date, in days since the year 0. This takes account of leap years; dividable by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). This property must be set after property 00 to take effect.

{{ottdp|no|}} In TTDPatch, dates after 2044 will be limited to 2044.

=== Sort vehicle list (1B) ===
See sort vehicle list for [[Action0Trains#Sort_vehicle_list_.281A.29|trains]] for details.

=== Visual effect (1C) ===
See the equivalent [[Action0Trains#Visual_effects_and_wagon_power_.2822.29|train property]] for information about the meaning of all bits. There is no default effect for ships, therefore values of 00..0F will show no visual effect. Bit 7 (disable wagon power) currently has no meaning and should be left at 0.

=== Custom cargo ageing period (1D) ===
See custom cargo ageing period for [[Action0Trains#Custom_cargo_ageing_period_.282B.29|trains]] for details.

== Example ==

To be written