GRFSpecs - User contributions [en-gb]

Action2/Advanced Sprite Layout

2025-08-19T21:33:09Z

Jgr: /* Colour translation special sprite number */

== Advanced sprite layout using register offsets ==

<Sprite-number> * <Length> 02 07/09/0F/11 <set-id> <0x40 + num-sprites>
<groundsprite> <flags> [<register/value>]...
[ <buildingsprite> <flags>
( <xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>
| <xpixeloffset> <ypixeloffset> 80)
[<register/value>]...
]...

{{ottdp|1.2|no|ottdrev=r22518}}
The spritelayout defines fixed spritesets to use from the Action 1. The registers can be used to individually select sprites from the spritesets instead of always using the construction stage. The registers are evaluated and their values are saved when the Action 2 sprite layout is evaluated. Other callbacks called during drawing (like CB 1E) have no effect on the used values of the registers.

{|
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<[[#Sprite-number|Sprite-number]]>||dec||A sequential sprite number
|-
|<[[#Length|length]]>||dec||The total number of bytes used in this action
|-
|02||B||Defines action 02
|-
|04/07/09/0F/11/14||B||feature: 07 town buildings, 09 industry tiles, 0F objects, 11 airport tiles, or 14 road stops
|-
|<[[#Set-id|set-id]]>||B||ID for this definition
|-
|40 + <num-sprites>||B||Number of following building sprites (the primary groundsprite mustn't be counted). Allowed range: 0x40+0 to 0x40+63 (0x40 to 0x7F).
|-
|<[[#Sprite definition for ground and building sprites|groundsprite]]>||D||Primary ground sprite for the building (see format below)
|-
|<[[#Flags in advanced sprite layouts|flags]]>||W||Flags for the primary ground sprite (see format below)
|-
|<[[#Register or value in advances sprite layouts|register/value]]>||V||Registers / values to be used. Depending on <flags> (see format below)
|-
|<[[#Sprite definition for ground and building sprites|buildingsprite]]>||D||The sprite to be drawn. Unlike the basic format, zero isn't allowed here.
|-
|<[[#Flags in advanced sprite layouts|flags]]>||W||Flags for the building sprite (see format below)
|-
!colspan="3"| -- for sprites defining a new bounding box --
|-
|<xofs>||B||x-offset from northern tile corner (as a signed byte)
|-
|<yofs>||B||y-offset from northern tile corner (as a signed byte)
|-
|<zofs>||B||z-offset from the ground
|-
|<xextent>||B||size of sprite in x direction
|-
|<yextent>||B||size of sprite in y direction
|-
|<zextent>||B||size of sprite in z direction
|-
!colspan="3"| -- for sprites sharing their bounding box with the previous sprite --
|-
|<xpixeloffset>||B||x offset from the top left corner of the previous sprite
|-
|<ypixeloffset>||B||y offset from the top left corner of the previous sprite
|-
|80||B||a literal 80h byte to distinguish from new-bounding-box definitions
|-
!colspan="3"|  
|-
|<[[#Register or value in advances sprite layouts|register/value]]>||V||Registers / values to be used. Depending on <flags> (see format below)
|}

== Descriptions of elements ==

=== Sprite-number ===

This is just the number you are at.

=== Length ===

Count the number of bytes in this action.

=== Set-id ===

The set-ID that you want to define for this set. You can choose any value between 00 and FF, and you can reuse them within a grf file at a later point (if being equal to an existing set ID, the existing one is overwritten and the new one is used).

=== Sprite definition for ground and building sprites ===

The ground and building sprite fields have the following format:

{|
!Bits!!Version!!Content
|-
|0-13||{{ottdp|0.6|2.5}}||Sprite number, exact meaning specified by bit 31
|-
|14-15||{{ottdp|0.6|2.5}}||0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite
|-
|16-29||{{ottdp|0.6|2.5}}||Color translation special sprite number, see below
|-
|30||{{ottdp|0.6|2.5|ttdprev=alpha 57}}||If set, sprite is drawn normally even in transparent buildings mode (for building sprites only)
|-
|31||{{ottdp|0.6|2.5}}||Sprite type, see below
|}

{{ottdp|0.6|2.5|ttdprev=alpha 57}} Since TTDPatch 2.0.1 alpha 57, the groundsprite value can be zero if no ground sprite is needed (this is useful if you need to draw custom foundations, see [[Callbacks#Decide drawing default foundations 30 14E 150|example]]). Ground sprites are always drawn normally, so bit 30 is ignored for them. Bit 30 may get a different meaning for ground sprites in a later version of TTDPatch, so please leave it zero for now. This does not apply to additional groundsprites using the "<xpixeloffset> <ypixeloffset> 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.

==== Colour translation special sprite number ====

This is used only if bits 14 or 15 are nonzero. Bits 16-29 must be the number of a regular TTD sprite containing a colour translation table (see below for available translation tables). For transparent mode, a suitable translation table is needed, e.g. that of TTD´s sprite number 802 (s.b.). See [[RecolorSprites]] for more information on the usage of transparent and recolouring sprites.

For houses, if no recolour sprite is given but recolouring is turned on in bits 14-15, there are two possibilities:
* If you have [[Callbacks#Building colour (1E) |callback 1E]] enabled, it is called to determine the colour mapping.
* If [[Callbacks#Building colour (1E) |callback 1E]] is disabled or fails, one of the colours specified in property 17 will be chosen randomly.

See [[RecolorSprites]] for a list of available colour translations.

For industry tiles, if this field is zero, but recolouring is turned on in bits 14 or 15, the colour of the containing industry will automatically be applied.

The ground sprite should be exactly the same size and shape as TTD's flat tile. In general, it shouldn't contain anything that has a z-dimension because any non-ground sprite will cover it.

Useful values for ground sprites:

{|
!Sprite number (decimal)!!Contents
|-
|3924||bare land
|-
|3981||grass
|-
|4061||water
|-
|4550||snow or desert (depending on climate)
|-
|1420||concrete
|-
|1314, 1313||straight road with pavement (X and Y)
|-
|1333, 1332||straight road with grass (X and Y)
|-
|2692 - 2695||bay road stop ground
|}

Please note that all the ground sprite becomes visible in "transparent buildings" mode, so you should draw parts that seem to be hidden as well.

For road stops, sprite layouts should always set a suitable ground tile sprite, and should not assume that a road type GRF will provide suitable overlay sprites.
Suggested ground sprite IDs include: 1333/1332 (straight road on grass), 1314/1313 (straight road with pavement), 2692 - 2695 (bay road stop ground).

==== Sprite type ====

If bit 31 is clear, the bottom 14 bits contain a regular TTD sprite number.

If bit 31 is set, the bottom 14 bits contain a number of a sprite set in the most recent action 1, and the used sprite is decided according to the current construction state and the number of sprites in the set:
* if there's only one sprite, it's used always
* if there are two sprites, the first is used during construction (stages 0-2), and the second is used for the finished building (stage 3)
* if there are three sprites, the first will be used in the beginning of the construction (stage 0), the second will be used during the rest of the construction (stages 1 and 2) and the third will be used for the complete building (stage 3)
* if there are four or more sprites, the first four will be used for the four construction stages. Sprites after the first four are always ignored.

=== Flags in advanced sprite layouts ===
<flags> is a bitset of word size with these meanings:
{| border="1"
|-
! Bit !! Hex !! Parentsprite !! Groundsprite/Childsprite
|-
|| 0 || 0001 || Skip bounding box including child sprites || Skip sprite
|-
|| 1 || 0002
| colspan="2" | Add offset to sprite, disable default usage of construction stage or railtype-offset
|-
|| 2 || 0004
| colspan="2" | Add offset to recoloursprite
|-
|| 3 || 0008
| colspan="2" | Recolour sprite is from Action 1 (will be affected by the same construction stage resp. railtype-offsets as sprites, unless bit 2 is set)
|-
|| 4 || 0010 || Add offset for <xoffset> and <yoffset> || Add offset for <xpixeloffset>
|-
|| 5 || 0020 || Add offset for <zoffset> || Add offset for <ypixeloffset>
|-
|| 6 || 0040
| colspan="2" | Resolve sprite with Variable 10 set to a specific value<ref name="action123">
Only valid for stations: The Action 1/2/3 chain is resolved multiple times, sprites can be part of different Action 1: The associated value in <register/value> is the raw value (not a register!) to put into Variable 10 while resolving the sprites.
 <ul>
<li>only allowed values currently 0-7</li>
<li>the value '2' is used when resolving custom foundations, (so, do not conflict with that)</li>
<li>even if the sprite is not from an Action 1, the value still defines which Action2 chains defines the values for the referenced registers.</li>
<li>The register for "Add offset to recoloursprite" is defined by the Action 1/2/3 chain with Variable 10 as defined for the recolour sprite.</li>
<li>The other registers are defined by the Action 1/2/3 chain with Variable 10 as defined for the sprite.</li>
<li>If no variable 10 values are defined, then station property 13 bit 0 takes effect; i.e. variable 10 is set to 0 or 1 depending on the bit and whether the first groundsprite is resolved or a different sprite. This applies to both the groundsprite and the palette of the groundsprite.</li>
</ul>
</ref>
|-
|| 7 || 0080
| colspan="2" | Resolve recoloursprite with Variable 10 set to a specific value<ref name="action123"/>
|-
|| 8..15 ||
| colspan="2" | Reserved, should be zero. If the GRF sets unknown bits, it will be disabled.
|-
|}

<references />

=== Register or value in advanced sprite layouts ===
These are the temporary storage registers to add to the individual parts. The register values are considered signed.
The order of the registers is the same as the bits in <flags>. If a bit is not set, then no registers appears for it.
Most bits require one register.
*<xoffset> and <yoffset> can only be enabled together, using two registers,
*the "skip bounding box"-register uses value 1 to draw the sprite, and 0 to skip it,
*the "recolorsprite from Action 1" uses no register at all,
*the Variable 10 values are not set via a register, but via a byte-constant.

NML:Roadstops

2025-08-19T21:30:26Z

Jgr: /* Road stop IDs */

{{NMLNavPropVarCB}}

Road stops can only be defined in OpenTTD {{ottd|14.0}} or later.

==Road stop IDs==
OpenTTD supports 64000 road stop types per game.

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

A road stop is allocated by setting the 'class'-property, which should therefore be set first.

Road stop sprite layouts should always set a suitable ground tile sprite, and should not assume that a road type GRF will provide suitable overlay sprites.
Suggested ground sprite IDs include: GROUNDSPRITE_ROAD_X/GROUNDSPRITE_ROAD_Y (straight road on grass), 1314/1313 (straight road with pavement), 2692 - 2695 (bay road stop ground).

==Road stop properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| class
| String literal of length 4
|
'''This property ''must'' be set first, before any other properties or graphics.''' 
Road stops belonging to the same class are grouped in the GUI. 
There is one special class:
* "WAYP": {{ottdp|15.0|no}} The road stop type will be shown in the waypoint construction window, instead of the station construction window.
{{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.
|-
| classname
| string
| You only need to set this for one road stop in every class.
|-
| name
| string
|
|-
| availability_type
| RST_AVAILABILITY_TYPE_XXX
| XXX = [PASSENGER <nowiki>|</nowiki> FREIGHT <nowiki>|</nowiki> ALL]
The default value is RST_AVAILABILITY_TYPE_ALL
|-
| draw_mode
| bitmask(RST_DRAW_FLAG_XXX, ...)
| See [[#List of draw mode flags|list of draw mode flags]]
The default value is bitmask(RST_DRAW_FLAG_BAY_ROAD, RST_DRAW_FLAG_DRIVE_THROUGH_ROAD_OVERLAY)
|-
| cargo_random_triggers
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Cargo types, which will [[NML:Random_switch#Stations|trigger re-randomization]] when delivered, loaded or unloaded at the station.
|-
| 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]]
|-
| general_flags
| bitmask(RST_GENERAL_FLAG_XXX, ...)
| See [[#List of general flags|list of general flags]]
|-
| cost_multipliers
| [build_cost, clear_cost]
| Build and clear cost multipliers, 16 is the same as a non-NewGRF road stop
|}

===List of draw mode flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| RST_DRAW_FLAG_BAY_ROAD
| Draw road type ground sprite for bay stops.
|-
| RST_DRAW_FLAG_DRIVE_THROUGH_ROAD_OVERLAY
| Draw road overlays for drive-through stops.
|-
| RST_DRAW_FLAG_WAYPOINT_GROUND
| {{ottdp|15.0|no}} Draw spritelayout ground sprite on top of underlying road (if unset, the spritelayout ground sprite is not drawn).
|}

===List of general flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| RST_GENERAL_FLAG_RANDOM_ANIMATION
| Animation callback requires random bits in variable extra_callback_info1.
|-
| RST_GENERAL_FLAG_NO_CATENARY
| Do not show catenary graphics.
|-
| RST_GENERAL_FLAG_DRIVE_THROUGH_ONLY
| Only allow drive-through stops (not bay stops).
|-
| RST_GENERAL_FLAG_NO_AUTO_ROAD_CONNECTION
| Do not automatically build connecting road pieces.
|-
| RST_GENERAL_FLAG_BUILD_MENU_ROAD_ONLY
| Only show in the road build menu (not tram).
|-
| RST_GENERAL_FLAG_BUILD_MENU_TRAM_ONLY
| Only show in the tram build menu (not road).
|-
| RST_GENERAL_FLAG_DRAW_MODE_REGISTER
| {{ottdp|15.0|no}} Read the road stop draw mode from variable 0x100 (set using STORE_TEMP), this overrides the draw_mode property.
|}

==Road stop variables==

===Base station variables===
The following variables are shared between road stops, [[NML:Stations|stations]] and [[NML:Airports|airports]]:

{| class="wikitable sortable"
! name
! value range
! comment
|-
| random_bits_station
| 0..65535
| 16 random bits, shared between all station sections (rail station sections, airports, ...)
|-
| had_vehicle_of_type
| bitmask(HAD_VEHICLE_OF_TYPE_XXX, ...)
| Bitmask of vehicle types that have visited the station. XXX = <nowiki>[TRAIN | BUS | TRUCK | AIRCRAFT | SHIP]</nowiki>.
|-
| is_waypoint
| [0 <nowiki>|</nowiki> 1]
| Whether the station is a waypoint
|-
| facilities
| bitmask(FACILITY_XXX, ...)
| Bitmask of facilities associated with the station. XXX = <nowiki>[TRAIN | TRUCK_STOP | BUS_STOP | AIRPORT | DOCK]</nowiki>.
|-
| airport_type
| AIRPORTTYPE_XXX
| Type of airport, contains a bogus value if the station has no airport. XXX = <nowiki>[SMALL | LARGE | HELIPORT | OILRIG]</nowiki>.
|-
| build_date
| <code style="color:green">date</code>(yyyy,mm,dd)
| Date when the station was built. Is clamped to the 1920-2099 range.
|}

The following variables are also shared with [[NML:Stations|stations]] and [[NML:Airports|airports]]. They all require a single argument: a cargo type from your [[NML:Cargotable|cargo translation table]].

{| class="wikitable sortable"
! name
! value range
! comment
|-
| cargo_amount_waiting
| 0..32767
| Units of cargo of waiting
|-
| cargo_rating
| 0..100
| Rating for this cargo type (in %)

|-
| cargo_time_since_pickup
| 0..255
| Time since the cargo was last picked up. 1 unit equals 185 ticks, or about 2.5 game days.
|-
| cargo_time_en_route
| 0..255
| Time this cargo has spent en-route. 1 unit equals 185 ticks, or about 2.5 game days.
|-
| cargo_last_vehicle_speed
| 0..255
| Speed of the last vehicle picking up this cargo type. The unit depends on the type of vehicle. For trains and road vehicles, one unit is 1 km/h; for ships, it's 0.5 km/h; for aircraft, it's 8 mph. If the max. speed is above 255 speed units, 255 is used instead. 0 if no vehicle as picked up the cargo type yet.
|-
| cargo_last_vehicle_age
| 0..255
| Age of the last vehicle picking up this cargo type, in years. 255 if no vehicle has picked up the cargo type yet.
|-
| cargo_accepted
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type is currently being accepted at the station, 0 otherwise.
|-
| cargo_accepted_ever
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type has ever been accepted at the station, 0 otherwise.
|-
| cargo_accepted_last_month
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted last month at the station, 0 otherwise.
|-
| cargo_accepted_this_month
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted this month at the station, 0 otherwise.
|-
| cargo_accepted_bigtick
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted at the station since the last periodic processing, which happens every 250 ticks. 0 otherwise.
|}

===Variables without a parameter===

{| class="wikitable sortable"
! name
! value range
! comment
|-
| view
| RST_VIEW_XXX
| The view/rotation of the road stop. See [[#List of road stop views|list of road stop views]]
|-
| stop_type
| RST_TYPE_XXX
| XXX = [BUS <nowiki>|</nowiki> TRUCK <nowiki>|</nowiki> {{ottdp|15}}WAYPOINT]
|-
| 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
|-
| has_road
| [0 <nowiki>|</nowiki> 1]
| 1 if this road stop has road
|-
| has_tram
| [0 <nowiki>|</nowiki> 1]
| 1 if this road stop has tram
|-
| road_type
| [Road type <nowiki>|</nowiki> 0xFF]
| Entry from [[NML:Railtypetable|roadtype translation table]], or 0xFF if there is no road
|-
| tram_type
| [Tram type <nowiki>|</nowiki> 0xFF]
| Entry from [[NML:Railtypetable|tramtype translation table]], or 0xFF if there is no tram
|-
| animation_frame
| 0 .. (frame_count - 1)
| Current animation frame, with the maximum defined in the <code style="color:darkgreen">animation_info</code> property.
|-
| 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.
|-
| company_num
| 0 ... 14
| company number of the vehicle owner. TTDPatch only supports up to 8 companies (0 ... 7)
|-
| company_type
| PLAYERTYPE_XX
|
;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
|
Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| company_colour2
| COLOUR_XXX
|
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.
|-
| random_bits_tile
| 0..255
| 8 random bits, specific to this road stop tile.
|-
| waiting_triggers
| 0..255
| Random triggers waiting to be matched. (see [[NML:Random switch|Random switch]])
|-
| drawn_in_gui
| [0 <nowiki>|</nowiki> 1]
| {{ottdp|15}} 1 if this road stop is being drawn in the build window
|}

===Variables that require one or more parameters===

{| class="wikitable sortable"
! name
! arguments
! value range
! comment
|-
| nearby_tile_slope
| x, y offset (-8..7)
|
| See tile_slope
|-
| 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.
|-
| nearby_tile_is_road_stop
| x, y offset (-8..7)
| 0 .. 1
| Is the given tile a road stop?
|-
| nearby_tile_road_stop_id
| x, y offset (-8..7)
|
| Is nearby_tile_same_grf is true, ID of a road stop on a nearby tile
|-
| nearby_tile_same_grf
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile defined by the same GRF?
|-
| nearby_tile_other_grf
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile defined by another GRF?
|-
| nearby_tile_original_gfx
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile using original graphics?
|-
| nearby_tile_same_station
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile the same station as this?
|-
| nearby_tile_view
| x, y offset (-8..7)
| RST_VIEW_XXX
| The view/rotation of a nearby road stop tile. See [[#List of road stop views|list of road stop views]]
|-
| nearby_tile_different_view
| x, y offset (-8..7)
| 0 .. 1
| Is the view/rotation of a road stop on a nearby tile different to that of this tile?
|-
| nearby_tile_is_drive_through
| x, y offset (-8..7)
| 0 .. 1
| Is nearby road stop tile a drive-through road stop?
|-
| nearby_tile_stop_type
| x, y offset (-8..7)
| RST_TYPE_XXX
| Road stop type of a nearby tile. See stop_type
|-
| nearby_tile_same_stop_type
| x, y offset (-8..7)
| 0 .. 1
| Is the stop type of a nearby road stop tile the same as this tile?
|-
| nearby_tile_grfid
| x, y offset (-8..7)
| [0xFFFFFFFF <nowiki>|</nowiki> 0 <nowiki>|</nowiki> GRFID]
| 0xFFFFFFFF if the nearby tile is not a road stop, 0 if the nearby tile is a non-custom road stop, or else the GRFID of the NewGRF defining the road stop on the nearby tile
|}

===List of road stop views===

{| class="wikitable sortable"
! Name
! Type
! Meaning
|-
| RST_VIEW_BAY_NE
| Bay
| Facing north-east
|-
| RST_VIEW_BAY_SE
| Bay
| Facing south-east
|-
| RST_VIEW_BAY_SW
| Bay
| Facing south-west
|-
| RST_VIEW_BAY_NW
| Bay
| Facing north-west
|-
| RST_VIEW_DRIVE_THROUGH_X
| Drive-through
| X-axis: north-east to south-west
|-
| RST_VIEW_DRIVE_THROUGH_Y
| Drive-through
| Y-axis: north-west to south-east
|}

==Road stop callbacks==

{| class="wikitable sortable"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Normal graphics for a road stop placed on the map
|-
| purchase <ref name="notyetbuilt">These callbacks are called when the road stop is not yet built</ref>
| Sprite layout
| Graphics shown in the build menu
|-
| availability
| 0 <nowiki>|</nowiki> 1
| Whether this road stop type is available in the build menu, 1 is available, 0 is unavailable
|-
| 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.
|-
| 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.
|-
| 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.
|}

===Animation triggers===

{| class="wikitable sortable"
! Animation trigger
! Description
! Happens on
! extra_callback_info2
|-
| ANIM_TRIGGER_ROAD_STOP_BUILT
| Road stop is built
| Newly built tile
|
|-
| ANIM_TRIGGER_ROAD_STOP_NEW_CARGO
| New cargo arrives at station
| All tiles
| Bits 8..15 contain the triggering cargo type
|-
| ANIM_TRIGGER_ROAD_STOP_CARGO_TAKEN
| CRGO removed from station
| All tiles
| Bits 8..15 contain the triggering cargo type
|-
| ANIM_TRIGGER_ROAD_STOP_VEH_ENTER
| Road vehicle enters stop (starts loading/unloading)
| Tile where the vehicle is
|
|-
| ANIM_TRIGGER_ROAD_STOP_VEH_LEAVE
| Road vehicle leaves stop (done loading/unloading)
| Tile where the vehicle is
|
|-
| ANIM_TRIGGER_ROAD_STOP_VEH_LOAD
| Road vehicle loads/unloads cargo
| Tile where the vehicle is
|
|-
| ANIM_TRIGGER_ROAD_STOP_250_TICKS
| Every 250 ticks
| All tiles
|
|}

Action2/Advanced Sprite Layout

2025-08-19T21:29:01Z

Jgr: /* Colour translation special sprite number */

== Advanced sprite layout using register offsets ==

<Sprite-number> * <Length> 02 07/09/0F/11 <set-id> <0x40 + num-sprites>
<groundsprite> <flags> [<register/value>]...
[ <buildingsprite> <flags>
( <xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>
| <xpixeloffset> <ypixeloffset> 80)
[<register/value>]...
]...

{{ottdp|1.2|no|ottdrev=r22518}}
The spritelayout defines fixed spritesets to use from the Action 1. The registers can be used to individually select sprites from the spritesets instead of always using the construction stage. The registers are evaluated and their values are saved when the Action 2 sprite layout is evaluated. Other callbacks called during drawing (like CB 1E) have no effect on the used values of the registers.

{|
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<[[#Sprite-number|Sprite-number]]>||dec||A sequential sprite number
|-
|<[[#Length|length]]>||dec||The total number of bytes used in this action
|-
|02||B||Defines action 02
|-
|04/07/09/0F/11/14||B||feature: 07 town buildings, 09 industry tiles, 0F objects, 11 airport tiles, or 14 road stops
|-
|<[[#Set-id|set-id]]>||B||ID for this definition
|-
|40 + <num-sprites>||B||Number of following building sprites (the primary groundsprite mustn't be counted). Allowed range: 0x40+0 to 0x40+63 (0x40 to 0x7F).
|-
|<[[#Sprite definition for ground and building sprites|groundsprite]]>||D||Primary ground sprite for the building (see format below)
|-
|<[[#Flags in advanced sprite layouts|flags]]>||W||Flags for the primary ground sprite (see format below)
|-
|<[[#Register or value in advances sprite layouts|register/value]]>||V||Registers / values to be used. Depending on <flags> (see format below)
|-
|<[[#Sprite definition for ground and building sprites|buildingsprite]]>||D||The sprite to be drawn. Unlike the basic format, zero isn't allowed here.
|-
|<[[#Flags in advanced sprite layouts|flags]]>||W||Flags for the building sprite (see format below)
|-
!colspan="3"| -- for sprites defining a new bounding box --
|-
|<xofs>||B||x-offset from northern tile corner (as a signed byte)
|-
|<yofs>||B||y-offset from northern tile corner (as a signed byte)
|-
|<zofs>||B||z-offset from the ground
|-
|<xextent>||B||size of sprite in x direction
|-
|<yextent>||B||size of sprite in y direction
|-
|<zextent>||B||size of sprite in z direction
|-
!colspan="3"| -- for sprites sharing their bounding box with the previous sprite --
|-
|<xpixeloffset>||B||x offset from the top left corner of the previous sprite
|-
|<ypixeloffset>||B||y offset from the top left corner of the previous sprite
|-
|80||B||a literal 80h byte to distinguish from new-bounding-box definitions
|-
!colspan="3"|  
|-
|<[[#Register or value in advances sprite layouts|register/value]]>||V||Registers / values to be used. Depending on <flags> (see format below)
|}

== Descriptions of elements ==

=== Sprite-number ===

This is just the number you are at.

=== Length ===

Count the number of bytes in this action.

=== Set-id ===

The set-ID that you want to define for this set. You can choose any value between 00 and FF, and you can reuse them within a grf file at a later point (if being equal to an existing set ID, the existing one is overwritten and the new one is used).

=== Sprite definition for ground and building sprites ===

The ground and building sprite fields have the following format:

{|
!Bits!!Version!!Content
|-
|0-13||{{ottdp|0.6|2.5}}||Sprite number, exact meaning specified by bit 31
|-
|14-15||{{ottdp|0.6|2.5}}||0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite
|-
|16-29||{{ottdp|0.6|2.5}}||Color translation special sprite number, see below
|-
|30||{{ottdp|0.6|2.5|ttdprev=alpha 57}}||If set, sprite is drawn normally even in transparent buildings mode (for building sprites only)
|-
|31||{{ottdp|0.6|2.5}}||Sprite type, see below
|}

{{ottdp|0.6|2.5|ttdprev=alpha 57}} Since TTDPatch 2.0.1 alpha 57, the groundsprite value can be zero if no ground sprite is needed (this is useful if you need to draw custom foundations, see [[Callbacks#Decide drawing default foundations 30 14E 150|example]]). Ground sprites are always drawn normally, so bit 30 is ignored for them. Bit 30 may get a different meaning for ground sprites in a later version of TTDPatch, so please leave it zero for now. This does not apply to additional groundsprites using the "<xpixeloffset> <ypixeloffset> 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.

==== Colour translation special sprite number ====

This is used only if bits 14 or 15 are nonzero. Bits 16-29 must be the number of a regular TTD sprite containing a colour translation table (see below for available translation tables). For transparent mode, a suitable translation table is needed, e.g. that of TTD´s sprite number 802 (s.b.). See [[RecolorSprites]] for more information on the usage of transparent and recolouring sprites.

For houses, if no recolour sprite is given but recolouring is turned on in bits 14-15, there are two possibilities:
* If you have [[Callbacks#Building colour (1E) |callback 1E]] enabled, it is called to determine the colour mapping.
* If [[Callbacks#Building colour (1E) |callback 1E]] is disabled or fails, one of the colours specified in property 17 will be chosen randomly.

See [[RecolorSprites]] for a list of available colour translations.

For industry tiles, if this field is zero, but recolouring is turned on in bits 14 or 15, the colour of the containing industry will automatically be applied.

The ground sprite should be exactly the same size and shape as TTD's flat tile. In general, it shouldn't contain anything that has a z-dimension because any non-ground sprite will cover it.

Useful values for ground sprites:

{|
!Sprite number (decimal)!!Contents
|-
|3924||bare land
|-
|3981||grass
|-
|4061||water
|-
|4550||snow or desert (depending on climate)
|-
|1420||concrete
|-
|1314, 1313||road with pavement (X and Y)
|-
|1333, 1332||road with grass (X and Y)
|-
|2692 - 2695||bay road stop ground
|}

Please note that all the ground sprite becomes visible in "transparent buildings" mode, so you should draw parts that seem to be hidden as well.

==== Sprite type ====

If bit 31 is clear, the bottom 14 bits contain a regular TTD sprite number.

If bit 31 is set, the bottom 14 bits contain a number of a sprite set in the most recent action 1, and the used sprite is decided according to the current construction state and the number of sprites in the set:
* if there's only one sprite, it's used always
* if there are two sprites, the first is used during construction (stages 0-2), and the second is used for the finished building (stage 3)
* if there are three sprites, the first will be used in the beginning of the construction (stage 0), the second will be used during the rest of the construction (stages 1 and 2) and the third will be used for the complete building (stage 3)
* if there are four or more sprites, the first four will be used for the four construction stages. Sprites after the first four are always ignored.

=== Flags in advanced sprite layouts ===
<flags> is a bitset of word size with these meanings:
{| border="1"
|-
! Bit !! Hex !! Parentsprite !! Groundsprite/Childsprite
|-
|| 0 || 0001 || Skip bounding box including child sprites || Skip sprite
|-
|| 1 || 0002
| colspan="2" | Add offset to sprite, disable default usage of construction stage or railtype-offset
|-
|| 2 || 0004
| colspan="2" | Add offset to recoloursprite
|-
|| 3 || 0008
| colspan="2" | Recolour sprite is from Action 1 (will be affected by the same construction stage resp. railtype-offsets as sprites, unless bit 2 is set)
|-
|| 4 || 0010 || Add offset for <xoffset> and <yoffset> || Add offset for <xpixeloffset>
|-
|| 5 || 0020 || Add offset for <zoffset> || Add offset for <ypixeloffset>
|-
|| 6 || 0040
| colspan="2" | Resolve sprite with Variable 10 set to a specific value<ref name="action123">
Only valid for stations: The Action 1/2/3 chain is resolved multiple times, sprites can be part of different Action 1: The associated value in <register/value> is the raw value (not a register!) to put into Variable 10 while resolving the sprites.
 <ul>
<li>only allowed values currently 0-7</li>
<li>the value '2' is used when resolving custom foundations, (so, do not conflict with that)</li>
<li>even if the sprite is not from an Action 1, the value still defines which Action2 chains defines the values for the referenced registers.</li>
<li>The register for "Add offset to recoloursprite" is defined by the Action 1/2/3 chain with Variable 10 as defined for the recolour sprite.</li>
<li>The other registers are defined by the Action 1/2/3 chain with Variable 10 as defined for the sprite.</li>
<li>If no variable 10 values are defined, then station property 13 bit 0 takes effect; i.e. variable 10 is set to 0 or 1 depending on the bit and whether the first groundsprite is resolved or a different sprite. This applies to both the groundsprite and the palette of the groundsprite.</li>
</ul>
</ref>
|-
|| 7 || 0080
| colspan="2" | Resolve recoloursprite with Variable 10 set to a specific value<ref name="action123"/>
|-
|| 8..15 ||
| colspan="2" | Reserved, should be zero. If the GRF sets unknown bits, it will be disabled.
|-
|}

<references />

=== Register or value in advanced sprite layouts ===
These are the temporary storage registers to add to the individual parts. The register values are considered signed.
The order of the registers is the same as the bits in <flags>. If a bit is not set, then no registers appears for it.
Most bits require one register.
*<xoffset> and <yoffset> can only be enabled together, using two registers,
*the "skip bounding box"-register uses value 1 to draw the sprite, and 0 to skip it,
*the "recolorsprite from Action 1" uses no register at all,
*the Variable 10 values are not set via a register, but via a byte-constant.

NML:Spritelayout

2025-08-19T21:23:28Z

Jgr: /* Sprite */

{{NMLNavBlocksyntax}}

Stations, houses, industry tiles, objects, and airport tiles use spritelayouts to define layouts how sprites are supposed to be arranged on a tile. A <code style="color:darkgreen">spritelayout</code> can combine multiple sprites into one entity, which represents everything that is to be drawn on a particular tile. A simple example to illustrate how it works:

<pre style="color:blue">
spritelayout airport_building1 {
ground { sprite: GROUNDSPRITE_NORMAL; }
childsprite {
sprite: spr_small_dirt_ne; // custom spriteset
always_draw: 1; // also draw in transparent mode
}
building {
sprite: 0xA67; // reuse this existing base set sprite
xoffset: 0x0F;
xextent: 1;
zextent: 6;
recolour_mode: RECOLOUR_REMAP;
palette: PALETTE_USE_DEFAULT;
}
}
</pre>

The sprite layout is composed of one or more sprites. Each sprite is defined by a <code style="color:darkgreen">ground</code>, <code style="color:darkgreen">building</code> or <code style="color:darkgreen">childsprite</code> block. What block to use depends on how the sprite is to be placed on the tile.

* <code style="color:darkgreen">ground</code> sprites are drawn at the base of the tile, like grass and concrete, rails etc. in normal TTD. With a few exceptions (e.g. when using custom foundations), you should always provide a ground sprite, even when the building above fully covers it. This because in transparent mode, the building becomes invisible. A tile can only have one ground sprite.
* <code style="color:darkgreen">building</code> sprites are drawn on top of the ground sprite. To determine their location and drawing order (what goes in front of what), they have a 3D bounding box.
* With <code style="color:darkgreen">childsprite</code>(s), you can effectively compose sprites from multiple parts. When placing these after a building sprite, they will use the same bounding box as the previous building sprite. When placing them before the first building sprite, they will have no bounding box, as if they would use the 'bounding box' of the ground tile. Multiple childsprites may be used per ground / building sprite.

The sprite order is genrally determined by the sprite sorter, that evaluates the bounding box (see below) of each sprite. Child sprites are always part of the building (or ground) sprite that precedes them. In the GUI, sprites are always drawn in the order specified in the layout, so be sure to get this correct for spritelayouts that are to be displayed there.

Per sprite, a number of parameters may be set. These are listed below. Unless otherwise indicated, each may have a value that is dependant on '''variables, parameters or registers'''. Accessed variables are always in the <code style="color:darkgreen">SELF</code> scope. Accessing variables inside the purchase list is '''not''' supported, make sure that layouts accessed from there do not use them. Using variables and parameters, it's possible to create wildly differing looks with few spritelayouts.

===Sprite===

The most important parameter is <code style="color:darkgreen">sprite</code>, this determines the actual sprite to be drawn. If you set this to a number, a TTD sprite will be drawn, usually from the base set. Pre-defined constants for some base set sprites are:

* <code style="color:darkgreen">GROUNDSPRITE_NORMAL<ref name="spritenames">These constants can be used for sprites on flat ground. There are also equivalent sprites for sloped ground, however. These sprites follow the initial ground sprite, the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">slope_to_sprite_offset(''slope'')</code> may be used to compute the required offset. Refer to the reference on [[NML:List of tile slopes|slopes]] or the [[#Example_.28advanced.29_Spritelayout|example]] below.</ref></code> default terrain type for that climate (temperate, toyland: normal, arctic: without snow, tropical: rainforest).
* <code style="color:darkgreen">GROUNDSPRITE_DESERT <ref name="spritenames" /></code> desert tile
* <code style="color:darkgreen">GROUNDSPRITE_DESERT_1_2 <ref name="spritenames" /></code> transition tile between desert and grass
* <code style="color:darkgreen">GROUNDSPRITE_SNOW <ref name="spritenames" /></code> snowy ground tile
* <code style="color:darkgreen">GROUNDSPRITE_SNOW_1_4 <ref name="spritenames" /></code> 1/4 snowy ground tile
* <code style="color:darkgreen">GROUNDSPRITE_SNOW_2_4 <ref name="spritenames" /></code> half-snowy ground tile
* <code style="color:darkgreen">GROUNDSPRITE_SNOW_3_4 <ref name="spritenames" /></code> 3/4 snowy ground tile
* <code style="color:darkgreen">GROUNDSPRITE_SNOW_4_4 <ref name="spritenames" /></code> snowy ground tile
* <code style="color:darkgreen">GROUNDSPRITE_CONCRETE</code> concrete ground tile
* <code style="color:darkgreen">GROUNDSPRITE_WATER</code> flat water tile, automatically choosen from sea, river and canal sprites, including river and canal borders.
* <code style="color:darkgreen">GROUNDSPRITE_CLEARED <ref name="spritenames" /></code> ground tile that has just been bulldozed (with brown colour)
* <code style="color:darkgreen">GROUNDSPRITE_RAIL_X <ref name="spritenames" /></code> ground tile with rail and terrain appropriate ground, NE-SW orientation (provided by railtype)
* <code style="color:darkgreen">GROUNDSPRITE_RAIL_Y <ref name="spritenames" /></code> ground tile with rail and terrain appropriate ground, NW-SE orientation (provided by railtype)
* <code style="color:darkgreen">GROUNDSPRITE_ROAD_X <ref name="spritenames" /></code> ground tile with straight road piece on grass, NE-SW orientation
* <code style="color:darkgreen">GROUNDSPRITE_ROAD_Y <ref name="spritenames" /></code> ground tile with straight road piece on grass, NW-SE orientation
<references />

Alternatively, you can set the value to (the name of) a [[NML:Spriteset|spriteset]], to provide a custom sprite. When the value is just a spriteset identifier, a sprite from that set will be selected depending on the construction stage, see below. All spritesets used in a layout '''must''' have the same number of sprites, due to a restriction in the NFO format. If you supply an argument (e.g. <code style="color:darkgreen">sprite: some_sprite_set(2);</code>), the corresponding sprite from the sprite set will be used, with an argument of 0 corresponding to the first sprite. Note that the argument may also be variable, so you could e.g. use <code style="color:darkgreen">sprite: some_set(construction_state);</code> to use the construction state to select the sprite (as is the default). If the spriteset has labels defined, you can use these labels in the argument expression.

* For stations, objects and airport tiles, there are no construction stages, so the first sprite from the set is used always.
* For houses and industry tiles, sprite chosen depends on the construction stage and the number of sprites available.
** If there is only one sprite in the set, it is used always.
** If there are two sprites, one is used during construction (stages 0-2) and one for the finished building (stage 3)
** If there are three sprites, one is used for the beginning of construction (stage 0), one for the other construction stages (stages 1-2) and one for the finished building (stage 3).
** If there are four sprites, one is used for each construction stage.
** Sprites after the first four are always ignored.
* For road stops the usage of the ground sprite depends on the [[NML:Roadstops#List of draw mode flags|''draw_mode'' property]].
* For objects the usage of the ground sprite may be skipped depending on the [[NML:Objects#List of object flags|''OBJ_FLAG_DRAW_WATER'' flag]], which has the same effect as ''GROUNDSPRITE_WATER''.

===Recolouring===

Next, you have the option to apply recolouring, i.e. to change the colours of the sprite. This is done via the following attributes:

* <code style="color:darkgreen">recolour_mode</code>: This must be compile-time constant. Available recolour modes are:
** <code style="color:darkgreen">RECOLOUR_NONE</code>: Use no colour translation (default)
** <code style="color:darkgreen">RECOLOUR_REMAP</code>: Use a colour translation table as defined by <code style="color:darkgreen">palette</code>. This tables maps all colours of the sprite to a new colour.
** <code style="color:darkgreen">RECOLOUR_TRANSPARENT</code>: Draw the sprite in transparant mode, using a colour translation table as defined by <code style="color:darkgreen">palette</code>. Normally the palette will be set to PALETTE_TO_TRANSPARANT to draw all underlying colours somewhat darker. Note that the selected palette is applied to the colours of the underlying sprite, whatever that happens to be. The supplied sprite is only used to determine what pixels to recolour.
* <code style="color:darkgreen">palette</code>: This defines the palette which is used for the colour translation. It may only (and must!) be set when <code style="color:darkgreen">recolour_mode</code> is set to <code style="color:darkgreen">RECOLOUR_REMAP</code> or <code style="color:darkgreen">RECOLOUR_TRANSPARENT</code>. The available values are the same as for <code style="color:darkgreen">sprite</code>, i.e. you can use either a default sprite or a sprite from a sprite set. In this case, however, the referenced sprite must not be a real sprite, but a [[NML:Recolour sprites|recolour sprite]]. For available default recolour sprites, see the appendix on [[NML:List of default colour translation palettes|available palettes]].

===Display yes/no===

The following attributes allow configuring whether the sprite will be displayed or not.

* <code style="color:darkgreen">hide_sprite</code>: If set to 1, this sprite will not be drawn at all. Default is 0. If a building sprite is not drawn, all child sprites that share its bounding box are not drawn either. Setting this to a constant value makes little sense, but you can use this to enable/disable drawing certain sprites at runtime depending on certain conditions.
* <code style="color:darkgreen">always_draw</code>: This must be a compile-time-constant. If set to 1, this sprite will also be drawn when the user has enabled transparant mode. The default value is 0. This is not available for ground sprites (those are drawn always), but it is for child sprites that share their bounding box with the ground sprite.

===Positioning===

How to position the sprite depends on the type of sprite:

* <code style="color:darkgreen">ground</code>: Ground sprites cannot be positioned.
* <code style="color:darkgreen">building</code>: A three-dimensional bounding box may be defined. The X-axis runs from top-right to bottom-left and the Y-axis from top-left to bottom-right. Both X and Y are measured in 1/16 length of the the tile border. The Z axis is vertical and measured in pixels. Extending the bounding box over the edges of a tile is possible, but not recommended as it may lead to glitches. '''Unless you know exactly what you are doing, please follow the recommendations below. They are most likely exactly what you need'''. In NewGRF developer mode in OpenTTD, it's possible to view the bounding boxes of all sprites by pressing Ctrl+B. In order to use and define a custom bounding box, the following attributes can be used:
** <code style="color:darkgreen">xoffset</code>: Offset from the northwestern edge to the start of the bounding box (X). Unit is 1/16 of the tile border. Default value is 0.
** <code style="color:darkgreen">yoffset</code>: Offset from the northeastern edge to the start of the bounding box (Y). Unit is 1/16 of the tile border. Default value is 0.
** <code style="color:darkgreen">zoffset</code>: Offset from the lowest tile corner (with foundation added) to the start of the bounding box (Z). Unit is pixels. Default value is 0.
** <code style="color:darkgreen">xextent</code>: Size of the bounding box, in the X-direction. Must be a compile-time constant. Unit is 1/16 of the tile border. Default value is 16.
** <code style="color:darkgreen">yextent</code>: Size of the bounding box, in the Y-direction. Must be a compile-time constant. Unit is 1/16 of the tile border. Default value is 16.
** <code style="color:darkgreen">zextent</code>: Size of the bounding box, in the Z-direction. Must be a compile-time constant. Unit is pixels. Default value is 16.
* <code style="color:darkgreen">childsprite</code>: Child sprites may be positioned relative to their 'parent' sprite that defines the bounding box. <code style="color:darkgreen">xoffset</code> and <code style="color:darkgreen">yoffset</code> may be set to specify an offset in pixels between the origin of the parent and child sprite. When the parent sprite is the ground sprite, TTDPatch does not support offsets other than 0,0. Note that all child sprites should fit inside the bounding box of the parent sprite to avoid visual glitches.

===Strong recommendations for bounding boxes===

For industries, houses, objects, and non-track station tiles:
* Use at most one building sprite; and child sprites for everything else.
** Do not set ''xoffset'', ''yoffset'' or ''zoffset''. The default value 0 applies.
** Do not set ''xextent'' or ''yextent''. The default value 16 applies.
** Set ''zextent'' to "<number of occupied height levels> * 8 - 2". The number of occupied height levels is important for objects allowed under bridges. Otherwise this only needs to be a rough estimate.
* If no sprite visually extends over the ground sprite, you do not need any building sprite: Child sprites can be used for further sprites.

For rail station track tiles:
* Use child sprites of the ground sprite for things "below the train".
* Use exactly two building sprites, possibly with child sprites.
* The first building sprite is used for things "behind the train".
** Set ''xoffset'', ''yoffset'', ''zoffset'' to 0.
** For track in X direction: Set ''xextent'' to 16, ''yextent'' to 5.
** For track in Y direction: Set ''xextent'' to 5, ''yextent'' to 16.
** Set ''zextent'' to "<number of occupied height levels> * 8 - 2". A rough estimate is good enough.
* The second building sprite is used for things "in-front or above the train".
** For track in X direction: Set ''xoffset'' to 0, ''yoffset'' to 11.
** For track in Y direction: Set ''xoffset'' to 11, ''yoffset'' to 0.
** Set ''zoffset'' to 0.
** For track in X direction: Set ''xextent'' to 16, ''yextent'' to 5.
** For track in Y direction: Set ''xextent'' to 5, ''yextent'' to 16.
** Set ''zextent'' to "<number of occupied height levels> * 8 - 2". A rough estimate is good enough.

===Maximum sprite size===

Ground sprites and their child sprites must not extend over the edges of a regular ground sprite of the slope.

Building sprites and their child sprites:
* must not extend below the south tile edges,
* must not extend left/right of the west/east tile corners,
* must not extend above the north corner by more than 200 pixels including the (default) foundation. If foundations are present, this is reduced by up to 16 pixels (steep slope S) to 184 pixels.

The following image shows the limitations for flat tiles, and the extreme cases of steep slopes:

[[File:Max_tile_sprite_size.png]]

These values apply since {{ottd|1.5}}.

===Example (advanced) Spritelayout===

OpenTTD 1.2 (r22723) allows for nice shorthands in defining multiple views, e.g. for different slopes: Spritelayout can have parameters and may use variables and temporary storage inside of a layout. A common usage for such parametrized spritelayout is taking care of the tile slope and ground type as illustrated in this example:

<pre style="color:blue">
spritelayout company_land_layout {
ground {
// normal ground sprite - always draw
sprite: LOAD_TEMP(0) + LOAD_TEMP(1);
}
childsprite {
// company-coloured border - always draw
sprite: cc_frame(LOAD_TEMP(0));
always_draw: 1;
recolour_mode: RECOLOUR_REMAP;
palette: PALETTE_USE_DEFAULT;
}
childsprite {
// again the normal ground sprite. Thus in non-transparent view
// only the normal ground sprite is shown. In transparent view
// this acts as sprite which darkens the other two sprites via
// a translation to transparency.
sprite: LOAD_TEMP(0) + LOAD_TEMP(1);
}
}

// A pseudo-switch which sets the temporary parameters for the sprite layout, storing the sprite number
// which belongs to the terrain type and the corresponding offset due to the tile slope
switch (FEAT_OBJECTS, SELF, company_land_terrain_switch, [
// We store the offset into the spriteset due to the tile slope into the 1st temporary variable
STORE_TEMP(slope_to_sprite_offset(tile_slope), 0),

// We store the offset to the flat groundsprite we use into the 2nd temporary variable
STORE_TEMP(GROUNDSPRITE_NORMAL, 1),
STORE_TEMP(terrain_type == TILETYPE_DESERT ? GROUNDSPRITE_DESERT : LOAD_TEMP(1), 1),
STORE_TEMP(terrain_type == TILETYPE_SNOW ? GROUNDSPRITE_SNOW : LOAD_TEMP(1), 1),

1
]) {
company_land_layout;
}
</pre>

Action2/Advanced Sprite Layout

2025-08-19T21:20:17Z

Jgr: /* Colour translation special sprite number */

== Advanced sprite layout using register offsets ==

<Sprite-number> * <Length> 02 07/09/0F/11 <set-id> <0x40 + num-sprites>
<groundsprite> <flags> [<register/value>]...
[ <buildingsprite> <flags>
( <xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent>
| <xpixeloffset> <ypixeloffset> 80)
[<register/value>]...
]...

{{ottdp|1.2|no|ottdrev=r22518}}
The spritelayout defines fixed spritesets to use from the Action 1. The registers can be used to individually select sprites from the spritesets instead of always using the construction stage. The registers are evaluated and their values are saved when the Action 2 sprite layout is evaluated. Other callbacks called during drawing (like CB 1E) have no effect on the used values of the registers.

{|
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<[[#Sprite-number|Sprite-number]]>||dec||A sequential sprite number
|-
|<[[#Length|length]]>||dec||The total number of bytes used in this action
|-
|02||B||Defines action 02
|-
|04/07/09/0F/11/14||B||feature: 07 town buildings, 09 industry tiles, 0F objects, 11 airport tiles, or 14 road stops
|-
|<[[#Set-id|set-id]]>||B||ID for this definition
|-
|40 + <num-sprites>||B||Number of following building sprites (the primary groundsprite mustn't be counted). Allowed range: 0x40+0 to 0x40+63 (0x40 to 0x7F).
|-
|<[[#Sprite definition for ground and building sprites|groundsprite]]>||D||Primary ground sprite for the building (see format below)
|-
|<[[#Flags in advanced sprite layouts|flags]]>||W||Flags for the primary ground sprite (see format below)
|-
|<[[#Register or value in advances sprite layouts|register/value]]>||V||Registers / values to be used. Depending on <flags> (see format below)
|-
|<[[#Sprite definition for ground and building sprites|buildingsprite]]>||D||The sprite to be drawn. Unlike the basic format, zero isn't allowed here.
|-
|<[[#Flags in advanced sprite layouts|flags]]>||W||Flags for the building sprite (see format below)
|-
!colspan="3"| -- for sprites defining a new bounding box --
|-
|<xofs>||B||x-offset from northern tile corner (as a signed byte)
|-
|<yofs>||B||y-offset from northern tile corner (as a signed byte)
|-
|<zofs>||B||z-offset from the ground
|-
|<xextent>||B||size of sprite in x direction
|-
|<yextent>||B||size of sprite in y direction
|-
|<zextent>||B||size of sprite in z direction
|-
!colspan="3"| -- for sprites sharing their bounding box with the previous sprite --
|-
|<xpixeloffset>||B||x offset from the top left corner of the previous sprite
|-
|<ypixeloffset>||B||y offset from the top left corner of the previous sprite
|-
|80||B||a literal 80h byte to distinguish from new-bounding-box definitions
|-
!colspan="3"|  
|-
|<[[#Register or value in advances sprite layouts|register/value]]>||V||Registers / values to be used. Depending on <flags> (see format below)
|}

== Descriptions of elements ==

=== Sprite-number ===

This is just the number you are at.

=== Length ===

Count the number of bytes in this action.

=== Set-id ===

The set-ID that you want to define for this set. You can choose any value between 00 and FF, and you can reuse them within a grf file at a later point (if being equal to an existing set ID, the existing one is overwritten and the new one is used).

=== Sprite definition for ground and building sprites ===

The ground and building sprite fields have the following format:

{|
!Bits!!Version!!Content
|-
|0-13||{{ottdp|0.6|2.5}}||Sprite number, exact meaning specified by bit 31
|-
|14-15||{{ottdp|0.6|2.5}}||0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite
|-
|16-29||{{ottdp|0.6|2.5}}||Color translation special sprite number, see below
|-
|30||{{ottdp|0.6|2.5|ttdprev=alpha 57}}||If set, sprite is drawn normally even in transparent buildings mode (for building sprites only)
|-
|31||{{ottdp|0.6|2.5}}||Sprite type, see below
|}

{{ottdp|0.6|2.5|ttdprev=alpha 57}} Since TTDPatch 2.0.1 alpha 57, the groundsprite value can be zero if no ground sprite is needed (this is useful if you need to draw custom foundations, see [[Callbacks#Decide drawing default foundations 30 14E 150|example]]). Ground sprites are always drawn normally, so bit 30 is ignored for them. Bit 30 may get a different meaning for ground sprites in a later version of TTDPatch, so please leave it zero for now. This does not apply to additional groundsprites using the "<xpixeloffset> <ypixeloffset> 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.

==== Colour translation special sprite number ====

This is used only if bits 14 or 15 are nonzero. Bits 16-29 must be the number of a regular TTD sprite containing a colour translation table (see below for available translation tables). For transparent mode, a suitable translation table is needed, e.g. that of TTD´s sprite number 802 (s.b.). See [[RecolorSprites]] for more information on the usage of transparent and recolouring sprites.

For houses, if no recolour sprite is given but recolouring is turned on in bits 14-15, there are two possibilities:
* If you have [[Callbacks#Building colour (1E) |callback 1E]] enabled, it is called to determine the colour mapping.
* If [[Callbacks#Building colour (1E) |callback 1E]] is disabled or fails, one of the colours specified in property 17 will be chosen randomly.

See [[RecolorSprites]] for a list of available colour translations.

For industry tiles, if this field is zero, but recolouring is turned on in bits 14 or 15, the colour of the containing industry will automatically be applied.

The ground sprite should be exactly the same size and shape as TTD's flat tile. In general, it shouldn't contain anything that has a z-dimension because any non-ground sprite will cover it.

Useful values for ground sprites:

{|
!Sprite number (decimal)!!Contents
|-
|3924||bare land
|-
|3981||grass
|-
|4061||water
|-
|4550||snow or desert (depending on climate)
|-
|1420||concrete
|-
|1313, 1314||road with pavement (X and Y)
|-
|1332, 1333||road with grass (X and Y)
|-
|2692 - 2695||bay road stop ground
|}

Please note that all the ground sprite becomes visible in "transparent buildings" mode, so you should draw parts that seem to be hidden as well.

==== Sprite type ====

If bit 31 is clear, the bottom 14 bits contain a regular TTD sprite number.

If bit 31 is set, the bottom 14 bits contain a number of a sprite set in the most recent action 1, and the used sprite is decided according to the current construction state and the number of sprites in the set:
* if there's only one sprite, it's used always
* if there are two sprites, the first is used during construction (stages 0-2), and the second is used for the finished building (stage 3)
* if there are three sprites, the first will be used in the beginning of the construction (stage 0), the second will be used during the rest of the construction (stages 1 and 2) and the third will be used for the complete building (stage 3)
* if there are four or more sprites, the first four will be used for the four construction stages. Sprites after the first four are always ignored.

=== Flags in advanced sprite layouts ===
<flags> is a bitset of word size with these meanings:
{| border="1"
|-
! Bit !! Hex !! Parentsprite !! Groundsprite/Childsprite
|-
|| 0 || 0001 || Skip bounding box including child sprites || Skip sprite
|-
|| 1 || 0002
| colspan="2" | Add offset to sprite, disable default usage of construction stage or railtype-offset
|-
|| 2 || 0004
| colspan="2" | Add offset to recoloursprite
|-
|| 3 || 0008
| colspan="2" | Recolour sprite is from Action 1 (will be affected by the same construction stage resp. railtype-offsets as sprites, unless bit 2 is set)
|-
|| 4 || 0010 || Add offset for <xoffset> and <yoffset> || Add offset for <xpixeloffset>
|-
|| 5 || 0020 || Add offset for <zoffset> || Add offset for <ypixeloffset>
|-
|| 6 || 0040
| colspan="2" | Resolve sprite with Variable 10 set to a specific value<ref name="action123">
Only valid for stations: The Action 1/2/3 chain is resolved multiple times, sprites can be part of different Action 1: The associated value in <register/value> is the raw value (not a register!) to put into Variable 10 while resolving the sprites.
 <ul>
<li>only allowed values currently 0-7</li>
<li>the value '2' is used when resolving custom foundations, (so, do not conflict with that)</li>
<li>even if the sprite is not from an Action 1, the value still defines which Action2 chains defines the values for the referenced registers.</li>
<li>The register for "Add offset to recoloursprite" is defined by the Action 1/2/3 chain with Variable 10 as defined for the recolour sprite.</li>
<li>The other registers are defined by the Action 1/2/3 chain with Variable 10 as defined for the sprite.</li>
<li>If no variable 10 values are defined, then station property 13 bit 0 takes effect; i.e. variable 10 is set to 0 or 1 depending on the bit and whether the first groundsprite is resolved or a different sprite. This applies to both the groundsprite and the palette of the groundsprite.</li>
</ul>
</ref>
|-
|| 7 || 0080
| colspan="2" | Resolve recoloursprite with Variable 10 set to a specific value<ref name="action123"/>
|-
|| 8..15 ||
| colspan="2" | Reserved, should be zero. If the GRF sets unknown bits, it will be disabled.
|-
|}

<references />

=== Register or value in advanced sprite layouts ===
These are the temporary storage registers to add to the individual parts. The register values are considered signed.
The order of the registers is the same as the bits in <flags>. If a bit is not set, then no registers appears for it.
Most bits require one register.
*<xoffset> and <yoffset> can only be enabled together, using two registers,
*the "skip bounding box"-register uses value 1 to draw the sprite, and 0 to skip it,
*the "recolorsprite from Action 1" uses no register at all,
*the Variable 10 values are not set via a register, but via a byte-constant.

GRFv9

2025-06-27T19:30:03Z

Jgr: Spelling/grammar

== Introduction ==

This page describes work so far, design considerations and other items of interest for a potential version 9 of the GRF specification (GRFv9), or equivalent specification evolution.

This page is a not a guarantee that any such changes will be occur in future, or that any such future work will closely match that described here.

== Existing Work ==

GRFv9 PRs (closed)
https://github.com/OpenTTD/OpenTTD/pull/13309 (NML: https://github.com/OpenTTD/nml/pull/357)

For 15.0:
Add explicit (Var)Action2 results for "callback failed" and "calculated result". https://github.com/OpenTTD/OpenTTD/pull/14149

== Design Considerations ==

The current GRF specification has several areas which are not ideal and could be improved in a subsequent specification version.

This section should list current pain points and non-ideal aspects of the specification, and where possible suggest improvements or general design principles for future additions.
This section is non-exhaustive.

=== Concurrent Action2 ID Limit ===

GRFs are currently limited to 256 simultaneous action2 IDs. This is a common pain point for NewGRF authors. NewGRF authors are encouraged to needlessly duplicate action2s (e.g. by use of templating mechanisms) to mitigate this, this results in larger GRF files which has a negative impact on content distribution and run-time performance.
Moving to 16 bit Action2 IDs would remove this problem without imposing significant technical difficulty.

=== General Design Comments on VariationalAction2 ===

Currently only variables 60 to 7F are parameterised, this ID space is too small and should be expanded.
Currently many 60x variables are multiplexed to return multiple unrelated or only partially related values, this is a non-ideal for the following reasons.
* Some 60x variables sub-parts are too small in order to fit them into a single 32-bit variable, this leads to surprising/buggy behaviour in some GRFs (e.g. house variables 60/61 and 44).
* 60x variable sub-parts can become too small when ID ranges are extended, creating a need for a replacement variable and more work than would otherwise be necessary (e.g. station variable 6B).
* Some 60x variables are needlessly expensive at run-time because expensive sub-parts are calculated even when the GRF only needed another part of the variable (e.g. industry variable 67/68) (this can be reasonably mitigated without a spec change).

The current "error group" behaviour for unavailable variables is unintuitive, especially when working from a higher abstraction layer such as NML. This also interacts unfavourably with the suggested callback topology where unhandled callbacks are routed onto the graphics chain.

Code patterns very commonly used by NewGRF authors such as <code>flag ? a : b</code> in NML read and immediately throw away the value of <code>a</code> when <code>flag</code> is false. The generated VarationalAction2 sequence for this is also overly verbose. It may be useful to consider adding operators or other mechanisms to enable these types of patterns to be expressed more efficiently.

Likewise, adding simple relational operators (as opposed to the current cmp/ucmp) could reduce the need for verbose sequences to do comparisons.

Procedure calls (variable 7E) truncate the result value to 15 bits, this is a source of surprising behaviour for NewGRF authors. Avoiding this requires using variable 1C. It may be useful to remove the need for this truncation.

GRFv9

2025-06-04T22:07:09Z

Jgr:

== Introduction ==

This page describes work so far, design considerations and other items of interest for a potential version 9 of the GRF specification (GRFv9), or equivalent specification evolution.

This page is a not a guarantee that any such changes will be occur in future, or that any such future work will closely match that described here.

== Existing Work ==

GRFv9 PRs (closed)
https://github.com/OpenTTD/OpenTTD/pull/13309 (NML: https://github.com/OpenTTD/nml/pull/357)

For 15.0:
Add explicit (Var)Action2 results for "callback failed" and "calculated result". https://github.com/OpenTTD/OpenTTD/pull/14149

== Design Considerations ==

The current GRF specification has several areas which are not ideal and could be improved in a subsequent specification version.

This section should list current pain points and non-idea specification aspects, and where possible suggest improvements or general design principles for future additions.
This section is non-exhaustive.

=== Concurrent Action2 ID Limit ===

GRFs are currently limited to 256 simultaneous action2 IDs. This is a common pain point for NewGRF authors. NewGRF authors are encouraged to needlessly duplicate action2s (e.g. by use of templating mechanisms) to mitigate this, this results in larger GRF files which has a negative impact on content distribution and run-time performance.
Moving to 16 bit Action2 IDs would remove this problem without imposing significant technical difficulty.

=== General Design Comments on VariationalAction2 ===

Currently only variables 60 to 7F are parameterised, this ID space is too small and should be expanded.
Currently many 60x variables are multiplexed to return multiple unrelated or only partially related values, this is a non-ideal for the following reasons.
* Some 60x variables sub-parts are too small in order to fit them into a single 32-bit variable, this leads to surprising/buggy behaviour in some GRFs (e.g. house variables 60/61 and 44).
* 60x variable sub-parts can become too small when ID ranges are extended, creating a need for a replacement variable and more work than would otherwise be necessary (e.g. station variable 6B).
* Some 60x variables are needlessly expensive at run-time because expensive sub-parts are calculated even when the GRF only needed another part of the variable (e.g. industry variable 67/68) (this can be reasonably mitigated without a spec change).

The current "error group" behaviour for unavailable variables is unintuitive, especially when working from a higher abstraction layer such as NML. This also interacts unfavourably with the suggested callback topology where unhandled callbacks are routed onto the graphics chain.

Code patterns very commonly used by NewGRF authors such as <code>flag ? a : b</code> in NML read and immediately throw away the value of <code>a</code> when <code>flag</code> is false. The generated VarationalAction2 sequence for this is also overly verbose. It may be useful to consider adding operators or other mechanisms to enable these types of patterns to be expressed more efficiently.

Likewise, adding simple relational operators (as opposed to the current cmp/ucmp) could reduce the need for verbose sequences to do comparisons.

Procedure calls (variable 7E) truncate the result value to 15 bits, this is a source of surprising behaviour for NewGRF authors. Avoiding this requires using variable 1C. It may be useful to remove the need for this truncation.

GRFv9

2025-06-04T22:06:39Z

Jgr: /* Existing Work */

== Introduction ==

This page describes work so far, design considerations and other items of interest for a potential version 9 of the GRF specification (GRFv9), or equivalent specification evolution.

This page is a not a guarantee that any such changes will be occur in future, or that any such future work will closely match that described here.

== Existing Work ==

GRFv9 PRs (closed)
https://github.com/OpenTTD/OpenTTD/pull/13309 (NML: https://github.com/OpenTTD/nml/pull/357)

For 15.0:
Add explicit (Var)Action2 results for "callback failed" and "calculated result". https://github.com/OpenTTD/OpenTTD/pull/14149

== Design Considerations ==

The current GRF specification has several areas which are not ideal and could be improved in a subsequent specification version.

This section should list current pain points and non-idea specification aspects, and where possible suggest improvements or general design principles for future additions.
This section is non-exhaustive.

=== Concurrent Action2 ID Limit ===

GRFs are currently limited to 256 simultaneous action2 IDs. This is a common pain point for NewGRF authors. NewGRF authors are encouraged to needlessly duplicate action2s (e.g. by use of templating mechanisms) to mitigate this, this results in larger GRF files which has a negative impact on content distribution and run-time performance.
Moving to 16 bit Action2 IDs would remove this problem without imposing significant technical difficult.

=== General Design Comments on VariationalAction2 ===

Currently only variables 60 to 7F are parameterised, this ID space is too small and should be expanded.
Currently many 60x variables are multiplexed to return multiple unrelated or only partially related values, this is a non-ideal for the following reasons.
* Some 60x variables sub-parts are too small in order to fit them into a single 32-bit variable, this leads to surprising/buggy behaviour in some GRFs (e.g. house variables 60/61 and 44).
* 60x variable sub-parts can become too small when ID ranges are extended, creating a need for a replacement variable and more work than would otherwise be necessary (e.g. station variable 6B).
* Some 60x variables are needlessly expensive at run-time because expensive sub-parts are calculated even when the GRF only needed another part of the variable (e.g. industry variable 67/68) (this can be reasonably mitigated without a spec change).

The current "error group" behaviour for unavailable variables is unintuitive, especially when working from a higher abstraction layer such as NML. This also interacts unfavourably with the suggested callback topology where unhandled callbacks are routed onto the graphics chain.

Code patterns very commonly used by NewGRF authors such as <code>flag ? a : b</code> in NML read and immediately throw away the value of <code>a</code> when <code>flag</code> is false. The generated VarationalAction2 sequence for this is also overly verbose. It may be useful to consider adding operators or other mechanisms to enable these types of patterns to be expressed more efficiently.

Likewise, adding simple relational operators (as opposed to the current cmp/ucmp) could reduce the need for verbose sequences to do comparisons.

Procedure calls (variable 7E) truncate the result value to 15 bits, this is a source of surprising behaviour for NewGRF authors. Avoiding this requires using variable 1C. It may be useful to remove the need for this truncation.

GRFv9

2025-06-04T21:45:44Z

Jgr: /* General Design Comments on VariationalAction2 */

== Introduction ==

This page describes work so far, design considerations and other items of interest for a potential version 9 of the GRF specification (GRFv9), or equivalent specification evolution.

This page is a not a guarantee that any such changes will be occur in future, or that any such future work will closely match that described here.

== Existing Work ==

GRFv9 PRs (closed)
https://github.com/OpenTTD/OpenTTD/pull/13309 (NML: https://github.com/OpenTTD/nml/pull/357)

== Design Considerations ==

The current GRF specification has several areas which are not ideal and could be improved in a subsequent specification version.

This section should list current pain points and non-idea specification aspects, and where possible suggest improvements or general design principles for future additions.
This section is non-exhaustive.

=== Concurrent Action2 ID Limit ===

GRFs are currently limited to 256 simultaneous action2 IDs. This is a common pain point for NewGRF authors. NewGRF authors are encouraged to needlessly duplicate action2s (e.g. by use of templating mechanisms) to mitigate this, this results in larger GRF files which has a negative impact on content distribution and run-time performance.
Moving to 16 bit Action2 IDs would remove this problem without imposing significant technical difficult.

=== General Design Comments on VariationalAction2 ===

Currently only variables 60 to 7F are parameterised, this ID space is too small and should be expanded.
Currently many 60x variables are multiplexed to return multiple unrelated or only partially related values, this is a non-ideal for the following reasons.
* Some 60x variables sub-parts are too small in order to fit them into a single 32-bit variable, this leads to surprising/buggy behaviour in some GRFs (e.g. house variables 60/61 and 44).
* 60x variable sub-parts can become too small when ID ranges are extended, creating a need for a replacement variable and more work than would otherwise be necessary (e.g. station variable 6B).
* Some 60x variables are needlessly expensive at run-time because expensive sub-parts are calculated even when the GRF only needed another part of the variable (e.g. industry variable 67/68) (this can be reasonably mitigated without a spec change).

The current "error group" behaviour for unavailable variables is unintuitive, especially when working from a higher abstraction layer such as NML. This also interacts unfavourably with the suggested callback topology where unhandled callbacks are routed onto the graphics chain.

Code patterns very commonly used by NewGRF authors such as <code>flag ? a : b</code> in NML read and immediately throw away the value of <code>a</code> when <code>flag</code> is false. The generated VarationalAction2 sequence for this is also overly verbose. It may be useful to consider adding operators or other mechanisms to enable these types of patterns to be expressed more efficiently.

Likewise, adding simple relational operators (as opposed to the current cmp/ucmp) could reduce the need for verbose sequences to do comparisons.

Procedure calls (variable 7E) truncate the result value to 15 bits, this is a source of surprising behaviour for NewGRF authors. Avoiding this requires using variable 1C. It may be useful to remove the need for this truncation.

GRFv9

2025-06-04T21:28:06Z

Jgr: Initial comments on VariationalAction2

== Introduction ==

This page describes work so far, design considerations and other items of interest for a potential version 9 of the GRF specification (GRFv9), or equivalent specification evolution.

This page is a not a guarantee that any such changes will be occur in future, or that any such future work will closely match that described here.

== Existing Work ==

GRFv9 PRs (closed)
https://github.com/OpenTTD/OpenTTD/pull/13309 (NML: https://github.com/OpenTTD/nml/pull/357)

== Design Considerations ==

The current GRF specification has several areas which are not ideal and could be improved in a subsequent specification version.

This section should list current pain points and non-idea specification aspects, and where possible suggest improvements or general design principles for future additions.
This section is non-exhaustive.

=== Concurrent Action2 ID Limit ===

GRFs are currently limited to 256 simultaneous action2 IDs. This is a common pain point for NewGRF authors. NewGRF authors are encouraged to needlessly duplicate action2s (e.g. by use of templating mechanisms) to mitigate this, this results in larger GRF files which has a negative impact on content distribution and run-time performance.
Moving to 16 bit Action2 IDs would remove this problem without imposing significant technical difficult.

=== General Design Comments on VariationalAction2 ===

Currently only variables 60 to 7F are parameterised, this ID space is too small and should be expanded.
Currently many 60x variables are multiplexed to return multiple unrelated or only partially related values, this is a non-ideal for the following reasons.
* Some 60x variables sub-parts are too small in order to fit them into a single 32-bit variable, this leads to surprising/buggy behaviour in some GRFs (e.g. house variables 60/61 and 44).
* 60x variable sub-parts can become too small when ID ranges are extended, creating a need for a replacement variable and more work than would otherwise be necessary (e.g. station variable 6B).
* Some 60x variables are needlessly expensive at run-time because expensive sub-parts are calculated even when the GRF only needed another part of the variable (e.g. industry variable 67/68) (this can be reasonably mitigated without a spec change).

The current "error group" behaviour for unavailable variables is extremely unintuitive, especially when working from a higher abstraction layer such as NML. This also interacts unfavourably with the suggested callback topology where unhandled callbacks are routed onto the graphics chain.

Returning a "failed" result currently requires returning a different value depending on the current value of variable 0C and the feature type (see CB_FAILED in NML), a VariationalAction2 type (or other equivalent mechanism) which results in an unambiguous callback failure in all contexts may be useful.

Code patterns very commonly used by NewGRF authors such as <code>flag ? a : b</code> in NML read and immediately throw away the value of <code>a</code> when <code>flag</code> is false. The generated VarationalAction2 sequence for this is also overly verbose. It may be useful to consider adding operators or other mechanisms to enable these types of patterns to be expressed more efficiently.

Likewise, adding simple relational operators (as opposed to the current cmp/ucmp) could reduce the need for verbose sequences to do comparisons.

GRFv9

2025-06-04T20:42:23Z

Jgr:

GRFv9

2025-06-04T20:27:09Z

Jgr: Initial page

== Introduction ==

This page describes work so far, design considerations and other items of interest for a potential version 9 of the GRF specification (GRFv9), or equivalent evolution of GRF the specification.

This page is a not a guarantee that any such changes will be occur in future, or that any such future work will closely match that described here.

== Existing Work ==

GRFv9 PRs (closed)
https://github.com/OpenTTD/OpenTTD/pull/13309 (NML: https://github.com/OpenTTD/nml/pull/357)

Main Page

2025-06-04T20:19:17Z

Jgr: Add link to stub GRFv9 page

== 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]]
* [[GRFv9 | GRFv9 Proposals]]
* [https://wiki.openttd.org/en/Development/NewGRF/Specification%20Status Specification Status]

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

Main Page

2025-06-04T20:15:08Z

Jgr: Add specification status link (this page is impossible to find otherwise)

== 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]]
* [https://wiki.openttd.org/en/Development/NewGRF/Specification%20Status Specification Status]

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

Action0/Road Stops

2024-07-09T23:43:18Z

Jgr: Fix table for property 0C (draw mode)

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

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

2024-06-15T22:40:28Z

Jgr: Adjust text for road stop classes starting with 0xFF

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

== 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
|-
|1||2||{{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 ==

NML:Roadstops

2024-05-03T20:56:33Z

Jgr: Add road stop callbacks and animation triggers

{{NMLNavPropVarCB}}

Road stops can only be defined in OpenTTD {{ottd|14.0}} or later.

==Road stop IDs==
OpenTTD supports 64000 road stop types per game.

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

A road stop is allocated by setting the 'class'-property, which should therefore be set first.

==Road stop properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| class
| String literal of length 4
|
'''This property ''must'' be set first, before any other properties or graphics.''' 
Road stops belonging to the same class are grouped in the GUI. 
There is one special class:
* "WAYP": {{ottdp|15.0|no}} The road stop type will be shown in the waypoint construction window, instead of the station construction window.
|-
| classname
| string
| You only need to set this for one road stop in every class.
|-
| name
| string
|
|-
| availability_type
| RST_AVAILABILITY_TYPE_XXX
| XXX = [PASSENGER <nowiki>|</nowiki> FREIGHT <nowiki>|</nowiki> ALL]
The default value is RST_AVAILABILITY_TYPE_ALL
|-
| draw_mode
| bitmask(RST_DRAW_FLAG_XXX, ...)
| See [[#List of draw mode flags|list of draw mode flags]]
The default value is bitmask(RST_DRAW_FLAG_BAY_ROAD, RST_DRAW_FLAG_DRIVE_THROUGH_ROAD_OVERLAY)
|-
| cargo_random_triggers
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Cargo types, which will [[NML:Random_switch#Stations|trigger re-randomization]] when delivered, loaded or unloaded at the station.
|-
| 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]]
|-
| general_flags
| bitmask(RST_GENERAL_FLAG_XXX, ...)
| See [[#List of general flags|list of general flags]]
|-
| cost_multipliers
| [build_cost, clear_cost]
| Build and clear cost multipliers, 16 is the same as a non-NewGRF road stop
|}

===List of draw mode flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| RST_DRAW_FLAG_BAY_ROAD
| Draw road type ground sprite for bay stops.
|-
| RST_DRAW_FLAG_DRIVE_THROUGH_ROAD_OVERLAY
| Draw road overlays for drive-through stops.
|-
| RST_DRAW_FLAG_WAYPOINT_GROUND
| {{ottdp|15.0|no}} Draw spritelayout ground sprite on top of underlying road (if unset, the spritelayout ground sprite is not drawn).
|}

===List of general flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| RST_GENERAL_FLAG_RANDOM_ANIMATION
| Animation callback requires random bits in variable extra_callback_info1.
|-
| RST_GENERAL_FLAG_NO_CATENARY
| Do not show catenary graphics.
|-
| RST_GENERAL_FLAG_DRIVE_THROUGH_ONLY
| Only allow drive-through stops (not bay stops).
|-
| RST_GENERAL_FLAG_NO_AUTO_ROAD_CONNECTION
| Do not automatically build connecting road pieces.
|-
| RST_GENERAL_FLAG_BUILD_MENU_ROAD_ONLY
| Only show in the road build menu (not tram).
|-
| RST_GENERAL_FLAG_BUILD_MENU_TRAM_ONLY
| Only show in the tram build menu (not road).
|-
| RST_GENERAL_FLAG_DRAW_MODE_REGISTER
| {{ottdp|15.0|no}} Read the road stop draw mode from variable 0x100 (set using STORE_TEMP), this overrides the draw_mode property.
|}

==Road stop variables==

===Base station variables===
The following variables are shared between road stops, [[NML:Stations|stations]] and [[NML:Airports|airports]]:

{| class="wikitable sortable"
! name
! value range
! comment
|-
| random_bits_station
| 0..65535
| 16 random bits, shared between all station sections (rail station sections, airports, ...)
|-
| had_vehicle_of_type
| bitmask(HAD_VEHICLE_OF_TYPE_XXX, ...)
| Bitmask of vehicle types that have visited the station. XXX = <nowiki>[TRAIN | BUS | TRUCK | AIRCRAFT | SHIP]</nowiki>.
|-
| is_waypoint
| [0 <nowiki>|</nowiki> 1]
| Whether the station is a waypoint
|-
| facilities
| bitmask(FACILITY_XXX, ...)
| Bitmask of facilities associated with the station. XXX = <nowiki>[TRAIN | TRUCK_STOP | BUS_STOP | AIRPORT | DOCK]</nowiki>.
|-
| airport_type
| AIRPORTTYPE_XXX
| Type of airport, contains a bogus value if the station has no airport. XXX = <nowiki>[SMALL | LARGE | HELIPORT | OILRIG]</nowiki>.
|-
| build_date
| <code style="color:green">date</code>(yyyy,mm,dd)
| Date when the station was built. Is clamped to the 1920-2099 range.
|}

The following variables are also shared with [[NML:Stations|stations]] and [[NML:Airports|airports]]. They all require a single argument: a cargo type from your [[NML:Cargotable|cargo translation table]].

{| class="wikitable sortable"
! name
! value range
! comment
|-
| cargo_amount_waiting
| 0..32767
| Units of cargo of waiting
|-
| cargo_rating
| 0..100
| Rating for this cargo type (in %)

|-
| cargo_time_since_pickup
| 0..255
| Time since the cargo was last picked up. 1 unit equals 185 ticks, or about 2.5 game days.
|-
| cargo_time_en_route
| 0..255
| Time this cargo has spent en-route. 1 unit equals 185 ticks, or about 2.5 game days.
|-
| cargo_last_vehicle_speed
| 0..255
| Speed of the last vehicle picking up this cargo type. The unit depends on the type of vehicle. For trains and road vehicles, one unit is 1 km/h; for ships, it's 0.5 km/h; for aircraft, it's 8 mph. If the max. speed is above 255 speed units, 255 is used instead. 0 if no vehicle as picked up the cargo type yet.
|-
| cargo_last_vehicle_age
| 0..255
| Age of the last vehicle picking up this cargo type, in years. 255 if no vehicle has picked up the cargo type yet.
|-
| cargo_accepted
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type is currently being accepted at the station, 0 otherwise.
|-
| cargo_accepted_ever
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type has ever been accepted at the station, 0 otherwise.
|-
| cargo_accepted_last_month
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted last month at the station, 0 otherwise.
|-
| cargo_accepted_this_month
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted this month at the station, 0 otherwise.
|-
| cargo_accepted_bigtick
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted at the station since the last periodic processing, which happens every 250 ticks. 0 otherwise.
|}

===Variables without a parameter===

{| class="wikitable sortable"
! name
! value range
! comment
|-
| view
| RST_VIEW_XXX
| The view/rotation of the road stop. See [[#List of road stop views|list of road stop views]]
|-
| stop_type
| RST_TYPE_XXX
| XXX = [BUS <nowiki>|</nowiki> TRUCK <nowiki>|</nowiki> {{ottdp|15}}WAYPOINT]
|-
| 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
|-
| has_road
| [0 <nowiki>|</nowiki> 1]
| 1 if this road stop has road
|-
| has_tram
| [0 <nowiki>|</nowiki> 1]
| 1 if this road stop has tram
|-
| road_type
| [Road type <nowiki>|</nowiki> 0xFF]
| Entry from [[NML:Railtypetable|roadtype translation table]], or 0xFF if there is no road
|-
| tram_type
| [Tram type <nowiki>|</nowiki> 0xFF]
| Entry from [[NML:Railtypetable|tramtype translation table]], or 0xFF if there is no tram
|-
| animation_frame
| 0 .. (frame_count - 1)
| Current animation frame, with the maximum defined in the <code style="color:darkgreen">animation_info</code> property.
|-
| 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.
|-
| company_num
| 0 ... 14
| company number of the vehicle owner. TTDPatch only supports up to 8 companies (0 ... 7)
|-
| company_type
| PLAYERTYPE_XX
|
;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
|
Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| company_colour2
| COLOUR_XXX
|
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.
|-
| random_bits_tile
| 0..255
| 8 random bits, specific to this road stop tile.
|-
| waiting_triggers
| 0..255
| Random triggers waiting to be matched. (see [[NML:Random switch|Random switch]])
|-
| drawn_in_gui
| [0 <nowiki>|</nowiki> 1]
| {{ottdp|15}} 1 if this road stop is being drawn in the build window
|}

===Variables that require one or more parameters===

{| class="wikitable sortable"
! name
! arguments
! value range
! comment
|-
| nearby_tile_slope
| x, y offset (-8..7)
|
| See tile_slope
|-
| 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.
|-
| nearby_tile_is_road_stop
| x, y offset (-8..7)
| 0 .. 1
| Is the given tile a road stop?
|-
| nearby_tile_road_stop_id
| x, y offset (-8..7)
|
| Is nearby_tile_same_grf is true, ID of a road stop on a nearby tile
|-
| nearby_tile_same_grf
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile defined by the same GRF?
|-
| nearby_tile_other_grf
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile defined by another GRF?
|-
| nearby_tile_original_gfx
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile using original graphics?
|-
| nearby_tile_same_station
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile the same station as this?
|-
| nearby_tile_view
| x, y offset (-8..7)
| RST_VIEW_XXX
| The view/rotation of a nearby road stop tile. See [[#List of road stop views|list of road stop views]]
|-
| nearby_tile_different_view
| x, y offset (-8..7)
| 0 .. 1
| Is the view/rotation of a road stop on a nearby tile different to that of this tile?
|-
| nearby_tile_is_drive_through
| x, y offset (-8..7)
| 0 .. 1
| Is nearby road stop tile a drive-through road stop?
|-
| nearby_tile_stop_type
| x, y offset (-8..7)
| RST_TYPE_XXX
| Road stop type of a nearby tile. See stop_type
|-
| nearby_tile_same_stop_type
| x, y offset (-8..7)
| 0 .. 1
| Is the stop type of a nearby road stop tile the same as this tile?
|-
| nearby_tile_grfid
| x, y offset (-8..7)
| [0xFFFFFFFF <nowiki>|</nowiki> 0 <nowiki>|</nowiki> GRFID]
| 0xFFFFFFFF if the nearby tile is not a road stop, 0 if the nearby tile is a non-custom road stop, or else the GRFID of the NewGRF defining the road stop on the nearby tile
|}

===List of road stop views===

{| class="wikitable sortable"
! Name
! Type
! Meaning
|-
| RST_VIEW_BAY_NE
| Bay
| Facing north-east
|-
| RST_VIEW_BAY_SE
| Bay
| Facing south-east
|-
| RST_VIEW_BAY_SW
| Bay
| Facing south-west
|-
| RST_VIEW_BAY_NW
| Bay
| Facing north-west
|-
| RST_VIEW_DRIVE_THROUGH_X
| Drive-through
| X-axis: north-east to south-west
|-
| RST_VIEW_DRIVE_THROUGH_Y
| Drive-through
| Y-axis: north-west to south-east
|}

==Road stop callbacks==

{| class="wikitable sortable"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Normal graphics for a road stop placed on the map
|-
| purchase <ref name="notyetbuilt">These callbacks are called when the road stop is not yet built</ref>
| Sprite layout
| Graphics shown in the build menu
|-
| availability
| 0 <nowiki>|</nowiki> 1
| Whether this road stop type is available in the build menu, 1 is available, 0 is unavailable
|-
| 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.
|-
| 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.
|-
| 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.
|}

===Animation triggers===

{| class="wikitable sortable"
! Animation trigger
! Description
! Happens on
! extra_callback_info2
|-
| ANIM_TRIGGER_ROAD_STOP_BUILT
| Road stop is built
| Newly built tile
|
|-
| ANIM_TRIGGER_ROAD_STOP_NEW_CARGO
| New cargo arrives at station
| All tiles
| Bits 8..15 contain the triggering cargo type
|-
| ANIM_TRIGGER_ROAD_STOP_CARGO_TAKEN
| CRGO removed from station
| All tiles
| Bits 8..15 contain the triggering cargo type
|-
| ANIM_TRIGGER_ROAD_STOP_VEH_ENTER
| Road vehicle enters stop (starts loading/unloading)
| Tile where the vehicle is
|
|-
| ANIM_TRIGGER_ROAD_STOP_VEH_LEAVE
| Road vehicle leaves stop (done loading/unloading)
| Tile where the vehicle is
|
|-
| ANIM_TRIGGER_ROAD_STOP_VEH_LOAD
| Road vehicle loads/unloads cargo
| Tile where the vehicle is
|
|-
| ANIM_TRIGGER_ROAD_STOP_250_TICKS
| Every 250 ticks
| All tiles
|
|}

NML:Roadstops

2024-05-03T20:41:54Z

Jgr: Add drawn_in_gui road stop variable

{{NMLNavPropVarCB}}

Road stops can only be defined in OpenTTD {{ottd|14.0}} or later.

==Road stop IDs==
OpenTTD supports 64000 road stop types per game.

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

A road stop is allocated by setting the 'class'-property, which should therefore be set first.

==Road stop properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| class
| String literal of length 4
|
'''This property ''must'' be set first, before any other properties or graphics.''' 
Road stops belonging to the same class are grouped in the GUI. 
There is one special class:
* "WAYP": {{ottdp|15.0|no}} The road stop type will be shown in the waypoint construction window, instead of the station construction window.
|-
| classname
| string
| You only need to set this for one road stop in every class.
|-
| name
| string
|
|-
| availability_type
| RST_AVAILABILITY_TYPE_XXX
| XXX = [PASSENGER <nowiki>|</nowiki> FREIGHT <nowiki>|</nowiki> ALL]
The default value is RST_AVAILABILITY_TYPE_ALL
|-
| draw_mode
| bitmask(RST_DRAW_FLAG_XXX, ...)
| See [[#List of draw mode flags|list of draw mode flags]]
The default value is bitmask(RST_DRAW_FLAG_BAY_ROAD, RST_DRAW_FLAG_DRIVE_THROUGH_ROAD_OVERLAY)
|-
| cargo_random_triggers
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Cargo types, which will [[NML:Random_switch#Stations|trigger re-randomization]] when delivered, loaded or unloaded at the station.
|-
| 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]]
|-
| general_flags
| bitmask(RST_GENERAL_FLAG_XXX, ...)
| See [[#List of general flags|list of general flags]]
|-
| cost_multipliers
| [build_cost, clear_cost]
| Build and clear cost multipliers, 16 is the same as a non-NewGRF road stop
|}

===List of draw mode flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| RST_DRAW_FLAG_BAY_ROAD
| Draw road type ground sprite for bay stops.
|-
| RST_DRAW_FLAG_DRIVE_THROUGH_ROAD_OVERLAY
| Draw road overlays for drive-through stops.
|-
| RST_DRAW_FLAG_WAYPOINT_GROUND
| {{ottdp|15.0|no}} Draw spritelayout ground sprite on top of underlying road (if unset, the spritelayout ground sprite is not drawn).
|}

===List of general flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| RST_GENERAL_FLAG_RANDOM_ANIMATION
| Animation callback requires random bits in variable extra_callback_info1.
|-
| RST_GENERAL_FLAG_NO_CATENARY
| Do not show catenary graphics.
|-
| RST_GENERAL_FLAG_DRIVE_THROUGH_ONLY
| Only allow drive-through stops (not bay stops).
|-
| RST_GENERAL_FLAG_NO_AUTO_ROAD_CONNECTION
| Do not automatically build connecting road pieces.
|-
| RST_GENERAL_FLAG_BUILD_MENU_ROAD_ONLY
| Only show in the road build menu (not tram).
|-
| RST_GENERAL_FLAG_BUILD_MENU_TRAM_ONLY
| Only show in the tram build menu (not road).
|-
| RST_GENERAL_FLAG_DRAW_MODE_REGISTER
| {{ottdp|15.0|no}} Read the road stop draw mode from variable 0x100 (set using STORE_TEMP), this overrides the draw_mode property.
|}

==Road stop variables==

===Base station variables===
The following variables are shared between road stops, [[NML:Stations|stations]] and [[NML:Airports|airports]]:

{| class="wikitable sortable"
! name
! value range
! comment
|-
| random_bits_station
| 0..65535
| 16 random bits, shared between all station sections (rail station sections, airports, ...)
|-
| had_vehicle_of_type
| bitmask(HAD_VEHICLE_OF_TYPE_XXX, ...)
| Bitmask of vehicle types that have visited the station. XXX = <nowiki>[TRAIN | BUS | TRUCK | AIRCRAFT | SHIP]</nowiki>.
|-
| is_waypoint
| [0 <nowiki>|</nowiki> 1]
| Whether the station is a waypoint
|-
| facilities
| bitmask(FACILITY_XXX, ...)
| Bitmask of facilities associated with the station. XXX = <nowiki>[TRAIN | TRUCK_STOP | BUS_STOP | AIRPORT | DOCK]</nowiki>.
|-
| airport_type
| AIRPORTTYPE_XXX
| Type of airport, contains a bogus value if the station has no airport. XXX = <nowiki>[SMALL | LARGE | HELIPORT | OILRIG]</nowiki>.
|-
| build_date
| <code style="color:green">date</code>(yyyy,mm,dd)
| Date when the station was built. Is clamped to the 1920-2099 range.
|}

The following variables are also shared with [[NML:Stations|stations]] and [[NML:Airports|airports]]. They all require a single argument: a cargo type from your [[NML:Cargotable|cargo translation table]].

{| class="wikitable sortable"
! name
! value range
! comment
|-
| cargo_amount_waiting
| 0..32767
| Units of cargo of waiting
|-
| cargo_rating
| 0..100
| Rating for this cargo type (in %)

|-
| cargo_time_since_pickup
| 0..255
| Time since the cargo was last picked up. 1 unit equals 185 ticks, or about 2.5 game days.
|-
| cargo_time_en_route
| 0..255
| Time this cargo has spent en-route. 1 unit equals 185 ticks, or about 2.5 game days.
|-
| cargo_last_vehicle_speed
| 0..255
| Speed of the last vehicle picking up this cargo type. The unit depends on the type of vehicle. For trains and road vehicles, one unit is 1 km/h; for ships, it's 0.5 km/h; for aircraft, it's 8 mph. If the max. speed is above 255 speed units, 255 is used instead. 0 if no vehicle as picked up the cargo type yet.
|-
| cargo_last_vehicle_age
| 0..255
| Age of the last vehicle picking up this cargo type, in years. 255 if no vehicle has picked up the cargo type yet.
|-
| cargo_accepted
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type is currently being accepted at the station, 0 otherwise.
|-
| cargo_accepted_ever
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type has ever been accepted at the station, 0 otherwise.
|-
| cargo_accepted_last_month
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted last month at the station, 0 otherwise.
|-
| cargo_accepted_this_month
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted this month at the station, 0 otherwise.
|-
| cargo_accepted_bigtick
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted at the station since the last periodic processing, which happens every 250 ticks. 0 otherwise.
|}

===Variables without a parameter===

{| class="wikitable sortable"
! name
! value range
! comment
|-
| view
| RST_VIEW_XXX
| The view/rotation of the road stop. See [[#List of road stop views|list of road stop views]]
|-
| stop_type
| RST_TYPE_XXX
| XXX = [BUS <nowiki>|</nowiki> TRUCK <nowiki>|</nowiki> {{ottdp|15}}WAYPOINT]
|-
| 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
|-
| has_road
| [0 <nowiki>|</nowiki> 1]
| 1 if this road stop has road
|-
| has_tram
| [0 <nowiki>|</nowiki> 1]
| 1 if this road stop has tram
|-
| road_type
| [Road type <nowiki>|</nowiki> 0xFF]
| Entry from [[NML:Railtypetable|roadtype translation table]], or 0xFF if there is no road
|-
| tram_type
| [Tram type <nowiki>|</nowiki> 0xFF]
| Entry from [[NML:Railtypetable|tramtype translation table]], or 0xFF if there is no tram
|-
| animation_frame
| 0 .. (frame_count - 1)
| Current animation frame, with the maximum defined in the <code style="color:darkgreen">animation_info</code> property.
|-
| 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.
|-
| company_num
| 0 ... 14
| company number of the vehicle owner. TTDPatch only supports up to 8 companies (0 ... 7)
|-
| company_type
| PLAYERTYPE_XX
|
;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
|
Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| company_colour2
| COLOUR_XXX
|
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.
|-
| random_bits_tile
| 0..255
| 8 random bits, specific to this road stop tile.
|-
| waiting_triggers
| 0..255
| Random triggers waiting to be matched. (see [[NML:Random switch|Random switch]])
|-
| drawn_in_gui
| [0 <nowiki>|</nowiki> 1]
| {{ottdp|15}} 1 if this road stop is being drawn in the build window
|}

===Variables that require one or more parameters===

{| class="wikitable sortable"
! name
! arguments
! value range
! comment
|-
| nearby_tile_slope
| x, y offset (-8..7)
|
| See tile_slope
|-
| 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.
|-
| nearby_tile_is_road_stop
| x, y offset (-8..7)
| 0 .. 1
| Is the given tile a road stop?
|-
| nearby_tile_road_stop_id
| x, y offset (-8..7)
|
| Is nearby_tile_same_grf is true, ID of a road stop on a nearby tile
|-
| nearby_tile_same_grf
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile defined by the same GRF?
|-
| nearby_tile_other_grf
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile defined by another GRF?
|-
| nearby_tile_original_gfx
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile using original graphics?
|-
| nearby_tile_same_station
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile the same station as this?
|-
| nearby_tile_view
| x, y offset (-8..7)
| RST_VIEW_XXX
| The view/rotation of a nearby road stop tile. See [[#List of road stop views|list of road stop views]]
|-
| nearby_tile_different_view
| x, y offset (-8..7)
| 0 .. 1
| Is the view/rotation of a road stop on a nearby tile different to that of this tile?
|-
| nearby_tile_is_drive_through
| x, y offset (-8..7)
| 0 .. 1
| Is nearby road stop tile a drive-through road stop?
|-
| nearby_tile_stop_type
| x, y offset (-8..7)
| RST_TYPE_XXX
| Road stop type of a nearby tile. See stop_type
|-
| nearby_tile_same_stop_type
| x, y offset (-8..7)
| 0 .. 1
| Is the stop type of a nearby road stop tile the same as this tile?
|-
| nearby_tile_grfid
| x, y offset (-8..7)
| [0xFFFFFFFF <nowiki>|</nowiki> 0 <nowiki>|</nowiki> GRFID]
| 0xFFFFFFFF if the nearby tile is not a road stop, 0 if the nearby tile is a non-custom road stop, or else the GRFID of the NewGRF defining the road stop on the nearby tile
|}

===List of road stop views===

{| class="wikitable sortable"
! Name
! Type
! Meaning
|-
| RST_VIEW_BAY_NE
| Bay
| Facing north-east
|-
| RST_VIEW_BAY_SE
| Bay
| Facing south-east
|-
| RST_VIEW_BAY_SW
| Bay
| Facing south-west
|-
| RST_VIEW_BAY_NW
| Bay
| Facing north-west
|-
| RST_VIEW_DRIVE_THROUGH_X
| Drive-through
| X-axis: north-east to south-west
|-
| RST_VIEW_DRIVE_THROUGH_Y
| Drive-through
| Y-axis: north-west to south-east
|}

NML:Roadstops

2024-05-03T20:38:29Z

Jgr: Add road stop parameterised variables

{{NMLNavPropVarCB}}

Road stops can only be defined in OpenTTD {{ottd|14.0}} or later.

==Road stop IDs==
OpenTTD supports 64000 road stop types per game.

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

A road stop is allocated by setting the 'class'-property, which should therefore be set first.

==Road stop properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| class
| String literal of length 4
|
'''This property ''must'' be set first, before any other properties or graphics.''' 
Road stops belonging to the same class are grouped in the GUI. 
There is one special class:
* "WAYP": {{ottdp|15.0|no}} The road stop type will be shown in the waypoint construction window, instead of the station construction window.
|-
| classname
| string
| You only need to set this for one road stop in every class.
|-
| name
| string
|
|-
| availability_type
| RST_AVAILABILITY_TYPE_XXX
| XXX = [PASSENGER <nowiki>|</nowiki> FREIGHT <nowiki>|</nowiki> ALL]
The default value is RST_AVAILABILITY_TYPE_ALL
|-
| draw_mode
| bitmask(RST_DRAW_FLAG_XXX, ...)
| See [[#List of draw mode flags|list of draw mode flags]]
The default value is bitmask(RST_DRAW_FLAG_BAY_ROAD, RST_DRAW_FLAG_DRIVE_THROUGH_ROAD_OVERLAY)
|-
| cargo_random_triggers
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Cargo types, which will [[NML:Random_switch#Stations|trigger re-randomization]] when delivered, loaded or unloaded at the station.
|-
| 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]]
|-
| general_flags
| bitmask(RST_GENERAL_FLAG_XXX, ...)
| See [[#List of general flags|list of general flags]]
|-
| cost_multipliers
| [build_cost, clear_cost]
| Build and clear cost multipliers, 16 is the same as a non-NewGRF road stop
|}

===List of draw mode flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| RST_DRAW_FLAG_BAY_ROAD
| Draw road type ground sprite for bay stops.
|-
| RST_DRAW_FLAG_DRIVE_THROUGH_ROAD_OVERLAY
| Draw road overlays for drive-through stops.
|-
| RST_DRAW_FLAG_WAYPOINT_GROUND
| {{ottdp|15.0|no}} Draw spritelayout ground sprite on top of underlying road (if unset, the spritelayout ground sprite is not drawn).
|}

===List of general flags===

{| class="wikitable sortable"
! Name
! Meaning
|-
| RST_GENERAL_FLAG_RANDOM_ANIMATION
| Animation callback requires random bits in variable extra_callback_info1.
|-
| RST_GENERAL_FLAG_NO_CATENARY
| Do not show catenary graphics.
|-
| RST_GENERAL_FLAG_DRIVE_THROUGH_ONLY
| Only allow drive-through stops (not bay stops).
|-
| RST_GENERAL_FLAG_NO_AUTO_ROAD_CONNECTION
| Do not automatically build connecting road pieces.
|-
| RST_GENERAL_FLAG_BUILD_MENU_ROAD_ONLY
| Only show in the road build menu (not tram).
|-
| RST_GENERAL_FLAG_BUILD_MENU_TRAM_ONLY
| Only show in the tram build menu (not road).
|-
| RST_GENERAL_FLAG_DRAW_MODE_REGISTER
| {{ottdp|15.0|no}} Read the road stop draw mode from variable 0x100 (set using STORE_TEMP), this overrides the draw_mode property.
|}

==Road stop variables==

===Base station variables===
The following variables are shared between road stops, [[NML:Stations|stations]] and [[NML:Airports|airports]]:

{| class="wikitable sortable"
! name
! value range
! comment
|-
| random_bits_station
| 0..65535
| 16 random bits, shared between all station sections (rail station sections, airports, ...)
|-
| had_vehicle_of_type
| bitmask(HAD_VEHICLE_OF_TYPE_XXX, ...)
| Bitmask of vehicle types that have visited the station. XXX = <nowiki>[TRAIN | BUS | TRUCK | AIRCRAFT | SHIP]</nowiki>.
|-
| is_waypoint
| [0 <nowiki>|</nowiki> 1]
| Whether the station is a waypoint
|-
| facilities
| bitmask(FACILITY_XXX, ...)
| Bitmask of facilities associated with the station. XXX = <nowiki>[TRAIN | TRUCK_STOP | BUS_STOP | AIRPORT | DOCK]</nowiki>.
|-
| airport_type
| AIRPORTTYPE_XXX
| Type of airport, contains a bogus value if the station has no airport. XXX = <nowiki>[SMALL | LARGE | HELIPORT | OILRIG]</nowiki>.
|-
| build_date
| <code style="color:green">date</code>(yyyy,mm,dd)
| Date when the station was built. Is clamped to the 1920-2099 range.
|}

The following variables are also shared with [[NML:Stations|stations]] and [[NML:Airports|airports]]. They all require a single argument: a cargo type from your [[NML:Cargotable|cargo translation table]].

{| class="wikitable sortable"
! name
! value range
! comment
|-
| cargo_amount_waiting
| 0..32767
| Units of cargo of waiting
|-
| cargo_rating
| 0..100
| Rating for this cargo type (in %)

|-
| cargo_time_since_pickup
| 0..255
| Time since the cargo was last picked up. 1 unit equals 185 ticks, or about 2.5 game days.
|-
| cargo_time_en_route
| 0..255
| Time this cargo has spent en-route. 1 unit equals 185 ticks, or about 2.5 game days.
|-
| cargo_last_vehicle_speed
| 0..255
| Speed of the last vehicle picking up this cargo type. The unit depends on the type of vehicle. For trains and road vehicles, one unit is 1 km/h; for ships, it's 0.5 km/h; for aircraft, it's 8 mph. If the max. speed is above 255 speed units, 255 is used instead. 0 if no vehicle as picked up the cargo type yet.
|-
| cargo_last_vehicle_age
| 0..255
| Age of the last vehicle picking up this cargo type, in years. 255 if no vehicle has picked up the cargo type yet.
|-
| cargo_accepted
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type is currently being accepted at the station, 0 otherwise.
|-
| cargo_accepted_ever
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type has ever been accepted at the station, 0 otherwise.
|-
| cargo_accepted_last_month
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted last month at the station, 0 otherwise.
|-
| cargo_accepted_this_month
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted this month at the station, 0 otherwise.
|-
| cargo_accepted_bigtick
| [0 <nowiki>|</nowiki> 1]
| 1 if this cargo type was accepted at the station since the last periodic processing, which happens every 250 ticks. 0 otherwise.
|}

===Variables without a parameter===

{| class="wikitable sortable"
! name
! value range
! comment
|-
| view
| RST_VIEW_XXX
| The view/rotation of the road stop. See [[#List of road stop views|list of road stop views]]
|-
| stop_type
| RST_TYPE_XXX
| XXX = [BUS <nowiki>|</nowiki> TRUCK <nowiki>|</nowiki> {{ottdp|15}}WAYPOINT]
|-
| 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
|-
| has_road
| [0 <nowiki>|</nowiki> 1]
| 1 if this road stop has road
|-
| has_tram
| [0 <nowiki>|</nowiki> 1]
| 1 if this road stop has tram
|-
| road_type
| [Road type <nowiki>|</nowiki> 0xFF]
| Entry from [[NML:Railtypetable|roadtype translation table]], or 0xFF if there is no road
|-
| tram_type
| [Tram type <nowiki>|</nowiki> 0xFF]
| Entry from [[NML:Railtypetable|tramtype translation table]], or 0xFF if there is no tram
|-
| animation_frame
| 0 .. (frame_count - 1)
| Current animation frame, with the maximum defined in the <code style="color:darkgreen">animation_info</code> property.
|-
| 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.
|-
| company_num
| 0 ... 14
| company number of the vehicle owner. TTDPatch only supports up to 8 companies (0 ... 7)
|-
| company_type
| PLAYERTYPE_XX
|
;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
|
Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| company_colour2
| COLOUR_XXX
|
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.
|-
| random_bits_tile
| 0..255
| 8 random bits, specific to this road stop tile.
|-
| waiting_triggers
| 0..255
| Random triggers waiting to be matched. (see [[NML:Random switch|Random switch]])
|}

===Variables that require one or more parameters===

{| class="wikitable sortable"
! name
! arguments
! value range
! comment
|-
| nearby_tile_slope
| x, y offset (-8..7)
|
| See tile_slope
|-
| 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.
|-
| nearby_tile_is_road_stop
| x, y offset (-8..7)
| 0 .. 1
| Is the given tile a road stop?
|-
| nearby_tile_road_stop_id
| x, y offset (-8..7)
|
| Is nearby_tile_same_grf is true, ID of a road stop on a nearby tile
|-
| nearby_tile_same_grf
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile defined by the same GRF?
|-
| nearby_tile_other_grf
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile defined by another GRF?
|-
| nearby_tile_original_gfx
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile using original graphics?
|-
| nearby_tile_same_station
| x, y offset (-8..7)
| 0 .. 1
| Is a road stop on a nearby tile the same station as this?
|-
| nearby_tile_view
| x, y offset (-8..7)
| RST_VIEW_XXX
| The view/rotation of a nearby road stop tile. See [[#List of road stop views|list of road stop views]]
|-
| nearby_tile_different_view
| x, y offset (-8..7)
| 0 .. 1
| Is the view/rotation of a road stop on a nearby tile different to that of this tile?
|-
| nearby_tile_is_drive_through
| x, y offset (-8..7)
| 0 .. 1
| Is nearby road stop tile a drive-through road stop?
|-
| nearby_tile_stop_type
| x, y offset (-8..7)
| RST_TYPE_XXX
| Road stop type of a nearby tile. See stop_type
|-
| nearby_tile_same_stop_type
| x, y offset (-8..7)
| 0 .. 1
| Is the stop type of a nearby road stop tile the same as this tile?
|-
| nearby_tile_grfid
| x, y offset (-8..7)
| [0xFFFFFFFF <nowiki>|</nowiki> 0 <nowiki>|</nowiki> GRFID]
| 0xFFFFFFFF if the nearby tile is not a road stop, 0 if the nearby tile is a non-custom road stop, or else the GRFID of the NewGRF defining the road stop on the nearby tile
|}

===List of road stop views===

{| class="wikitable sortable"
! Name
! Type
! Meaning
|-
| RST_VIEW_BAY_NE
| Bay
| Facing north-east
|-
| RST_VIEW_BAY_SE
| Bay
| Facing south-east
|-
| RST_VIEW_BAY_SW
| Bay
| Facing south-west
|-
| RST_VIEW_BAY_NW
| Bay
| Facing north-west
|-
| RST_VIEW_DRIVE_THROUGH_X
| Drive-through
| X-axis: north-east to south-west
|-
| RST_VIEW_DRIVE_THROUGH_Y
| Drive-through
| Y-axis: north-west to south-east
|}

NML:Roadstops

2024-05-03T20:20:30Z

Jgr: Partial addition of road stop variables

VariationalAction2/Road Stops

2024-05-03T19:45:39Z

Jgr: Add road waypoint value for var 41

==Introduction==

== Variables ==
{|
!Variable !![[GRFActionsDetailed|Size]] !!Version !! Description
|-
|40||B||{{ottdp|14}}||View/rotation
|-
|41||B||{{ottdp|14}}||Stop type
|-
|42||W||{{ottdp|14}}||Tile information, see below
|-
|43||D||{{ottdp|14}}||Road type
|-
|44||D||{{ottdp|14}}||Tram type
|-
|45||D||{{ottdp|14}}||Get [[TownZones|town zone]] and Manhattan distance of closest town
|-
|46||D||{{ottdp|14}}||Get square of Euclidian distance of closest town
|-
|47||B||{{ottdp|14}}||Player (company) information
|-
|48|| || ||See [[VariationalAction2/BaseStation|Base Stations]].
|-
|49||B||{{ottdp|14}}||Current animation frame
|-
|50||D||{{ottdp|15}}||Miscellaneous road stop info
|-
|60-65|| || ||See [[VariationalAction2/BaseStation|Base Stations]].
|-
|66||D||{{ottdp|14}}||Animation frame of nearby tile
|-
|67||D||{{ottdp|14}}||Land info of nearby tiles
|-
|68||D||{{ottdp|14}}||Road stop info of nearby tiles
|-
|6A||D||{{ottdp|14}}||GRFID of nearby tiles
|-
|69|| || ||See [[VariationalAction2/BaseStation|Base Stations]].
|}

== Description ==

=== View/rotation (40) ===

{|
!Value!!Type!!Description
|-
|0||Bay||Facing north-east
|-
|1||Bay||Facing south-east
|-
|2||Bay||Facing south-west
|-
|3||Bay||Facing north-west
|-
|4||Drive-through||X-axis: north-east to south-west
|-
|5||Drive-through||Y-axis: north-west to south-east
|}

=== Stop type (41) ===

{|
!Value!!Meaning
|-
|0||Passenger/bus stop
|-
|1||Freight/lorry stop
|-
|2||{{ottdp|15}} Road waypoint
|}

=== Tile information (42) ===

The return value has the same values as [[VariationalAction2/Objects#Tile information (41)|object var41]].

=== Road type (43) ===

This has the value of the (translated) roadtype the road stop is built on, or the current roadtype in the build GUI.

If the roadtype has no entry in the roadtype translation table of the GRF, this value will be FFh.

If no translation table is present, the raw value will be returned.

Note: only exact matches of roadtypes are reported. If the translation table of the GRF does not contain the exact roadtype FFh is returned.

If the tile has no road at all (tram only) FFFFFFFFh is returned.

=== Tram type (44) ===

This has the value of the (translated) tramtype the road stop is built on, or the current tramtype in the build GUI.

If the tramtype has no entry in the tramtype translation table of the GRF, this value will be FFh.

If no translation table is present, the raw value will be returned.

Note: only exact matches of tramtypes are reported. If the translation table of the GRF does not contain the exact tramtype FFh is returned.

If the tile has no tram at all (road only) FFFFFFFFh is returned.

=== Get [[TownZones|town zone]] and Manhattan distance of closest town (45) ===

Like [[VarAction2Industries#Get town zone and Manhattan distance of closest town (65)|industry var65]] but instead of an offset the current tile is used.

=== Get square of Euclidian distance of closest town (46) ===

Like [[VarAction2Industries#Get square of Euclidean distance of closest town (66)|industry var66]] but instead of an offset the current tile is used.

=== Player (company) information (47) ===

The return value has the same values as [[VariationalAction2/Vehicles#Player info (43)|vehicle var43]].
The company used is the road stop owner.

=== Animation Frame (49) ===

The return value is the animation frame of the current tile.

=== Miscellaneous road stop info (50) ===

{| |-
!Bits!!Meaning
|-
|0..3||Not implemented.
|-
|4||Bit set if the road stop is being drawn in the build window.
|-
|5..31||Undefined, reserved for future use
|}

=== Animation frame of nearby tile (66) ===

The parameter of this variable is a signed offset from the current tile.

If the selected tile is a road stop tile that belongs to the current station, its animation state is returned. Otherwise, FFFFFFFFh is returned.

=== Land info of nearby tiles (67) ===

The parameter of this variable is a signed offset from the current tile.

Returns the same values as [[VarAction2IndustryTiles#Land info of nearby tiles (60)|industry tile var60]].

=== Road stop info of nearby tiles (68) ===

The parameter of this variable is a signed offset from the current tile.

The returned value is FFFFFFFFh if the selected tile isn't a road stop tile. Otherwise, the returned value can be separated to the following parts:

{| |-
!Bits!!Meaning
|-
|0..7||If the tile is defined in the current GRF, this is the setID used in the definition. Otherwise, the content is undefined.
Note that this field is clamped to the range 0..255. Therefore if the current GRF defines road stops with a setID > 255, this field may only be used to check for road stops in the range 0..254.
|-
|8..9||0 - The tile uses original TTD graphics

1 - The tile is defined in the current GRF

2 - The tile is defined in another GRF
|-
|10||Set if the selected tile belongs to the current station, clear otherwise
|-
|11||Set if the selected tile has a different view/rotation, cleat if the same view/rotation
|-
|12..15||View/rotation of the selected tile
|-
|16..19||0 - Passenger/bus stop

1 - Freight/lorry stop
|-
|20||Set if the stop type (passenger/bus or freight/lorry) is the same as the current tile
|-
|21..31||Undefined, reserved for future use
|}

=== GRFID of nearby road stop tile (6A) ===

The parameter of this variable is a signed offset from the current tile.

The returned value is one of the following:
* '''FFFFFFFFh''' if the selected tile isn't a road stop tile
* '''00000000h''' if the selected station is a default road stop (not a NewGRF road stop)
* otherwise, the GRFID of the GRF which defined the type of the selected road stop tile

NML:Roadstops

2024-05-03T19:39:06Z

Jgr: Initial NML road stop properties

Action0/Road Stops

2024-04-24T18:57:27Z

Jgr: Road waypoint updates

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

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

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
|-
|1||2||{{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 ==

VariationalAction2/Road Stops

2024-04-23T21:24:34Z

Jgr: Add road stop variable 50

==Introduction==

== Variables ==
{|
!Variable !![[GRFActionsDetailed|Size]] !!Version !! Description
|-
|40||B||{{ottdp|14}}||View/rotation
|-
|41||B||{{ottdp|14}}||Stop type
|-
|42||W||{{ottdp|14}}||Tile information, see below
|-
|43||D||{{ottdp|14}}||Road type
|-
|44||D||{{ottdp|14}}||Tram type
|-
|45||D||{{ottdp|14}}||Get [[TownZones|town zone]] and Manhattan distance of closest town
|-
|46||D||{{ottdp|14}}||Get square of Euclidian distance of closest town
|-
|47||B||{{ottdp|14}}||Player (company) information
|-
|48|| || ||See [[VariationalAction2/BaseStation|Base Stations]].
|-
|49||B||{{ottdp|14}}||Current animation frame
|-
|50||D||{{ottdp|15}}||Miscellaneous road stop info
|-
|60-65|| || ||See [[VariationalAction2/BaseStation|Base Stations]].
|-
|66||D||{{ottdp|14}}||Animation frame of nearby tile
|-
|67||D||{{ottdp|14}}||Land info of nearby tiles
|-
|68||D||{{ottdp|14}}||Road stop info of nearby tiles
|-
|6A||D||{{ottdp|14}}||GRFID of nearby tiles
|-
|69|| || ||See [[VariationalAction2/BaseStation|Base Stations]].
|}

== Description ==

=== View/rotation (40) ===

{|
!Value!!Type!!Description
|-
|0||Bay||Facing north-east
|-
|1||Bay||Facing south-east
|-
|2||Bay||Facing south-west
|-
|3||Bay||Facing north-west
|-
|4||Drive-through||X-axis: north-east to south-west
|-
|5||Drive-through||Y-axis: north-west to south-east
|}

=== Stop type (41) ===

{|
!Value!!Meaning
|-
|0||Passenger/bus stop
|-
|1||Freight/lorry stop
|}

=== Tile information (42) ===

The return value has the same values as [[VariationalAction2/Objects#Tile information (41)|object var41]].

=== Road type (43) ===

This has the value of the (translated) roadtype the road stop is built on, or the current roadtype in the build GUI.

If the roadtype has no entry in the roadtype translation table of the GRF, this value will be FFh.

If no translation table is present, the raw value will be returned.

Note: only exact matches of roadtypes are reported. If the translation table of the GRF does not contain the exact roadtype FFh is returned.

If the tile has no road at all (tram only) FFFFFFFFh is returned.

=== Tram type (44) ===

This has the value of the (translated) tramtype the road stop is built on, or the current tramtype in the build GUI.

If the tramtype has no entry in the tramtype translation table of the GRF, this value will be FFh.

If no translation table is present, the raw value will be returned.

Note: only exact matches of tramtypes are reported. If the translation table of the GRF does not contain the exact tramtype FFh is returned.

If the tile has no tram at all (road only) FFFFFFFFh is returned.

=== Get [[TownZones|town zone]] and Manhattan distance of closest town (45) ===

Like [[VarAction2Industries#Get town zone and Manhattan distance of closest town (65)|industry var65]] but instead of an offset the current tile is used.

=== Get square of Euclidian distance of closest town (46) ===

Like [[VarAction2Industries#Get square of Euclidean distance of closest town (66)|industry var66]] but instead of an offset the current tile is used.

=== Player (company) information (47) ===

The return value has the same values as [[VariationalAction2/Vehicles#Player info (43)|vehicle var43]].
The company used is the road stop owner.

=== Animation Frame (49) ===

The return value is the animation frame of the current tile.

=== Miscellaneous road stop info (50) ===

{| |-
!Bits!!Meaning
|-
|0..3||Not implemented.
|-
|4||Bit set if the road stop is being drawn in the build window.
|-
|5..31||Undefined, reserved for future use
|}

=== Animation frame of nearby tile (66) ===

The parameter of this variable is a signed offset from the current tile.

If the selected tile is a road stop tile that belongs to the current station, its animation state is returned. Otherwise, FFFFFFFFh is returned.

=== Land info of nearby tiles (67) ===

The parameter of this variable is a signed offset from the current tile.

Returns the same values as [[VarAction2IndustryTiles#Land info of nearby tiles (60)|industry tile var60]].

=== Road stop info of nearby tiles (68) ===

The parameter of this variable is a signed offset from the current tile.

The returned value is FFFFFFFFh if the selected tile isn't a road stop tile. Otherwise, the returned value can be separated to the following parts:

{| |-
!Bits!!Meaning
|-
|0..7||If the tile is defined in the current GRF, this is the setID used in the definition. Otherwise, the content is undefined.
Note that this field is clamped to the range 0..255. Therefore if the current GRF defines road stops with a setID > 255, this field may only be used to check for road stops in the range 0..254.
|-
|8..9||0 - The tile uses original TTD graphics

1 - The tile is defined in the current GRF

2 - The tile is defined in another GRF
|-
|10||Set if the selected tile belongs to the current station, clear otherwise
|-
|11||Set if the selected tile has a different view/rotation, cleat if the same view/rotation
|-
|12..15||View/rotation of the selected tile
|-
|16..19||0 - Passenger/bus stop

1 - Freight/lorry stop
|-
|20||Set if the stop type (passenger/bus or freight/lorry) is the same as the current tile
|-
|21..31||Undefined, reserved for future use
|}

=== GRFID of nearby road stop tile (6A) ===

The parameter of this variable is a signed offset from the current tile.

The returned value is one of the following:
* '''FFFFFFFFh''' if the selected tile isn't a road stop tile
* '''00000000h''' if the selected station is a default road stop (not a NewGRF road stop)
* otherwise, the GRFID of the GRF which defined the type of the selected road stop tile

Action5

2024-04-23T19:48:19Z

Jgr: Add Action 5 type 19: road waypoints

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

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

RandomAction2

2024-01-16T19:58:22Z

Jgr: Add road stops triggers section

==Introduction==

Unlike [[VariationalAction2]], whose results are always determined by a predictable decision, RandomAction2 can use randomized results to pick one of several [[Action2]] entries.

== Format ==

The data looks as follows:

<Sprite-number> * <Length> 02 <feature> <set-id> <nowiki>[80|83]</nowiki> <random-triggers> <randbit> <nrand> <set-ids>

From TTDPatch 2.6 r1850 and OpenTTD r12452, and '''for vehicles only''':

<Sprite-number> * <Length> 02 <feature> <set-id> 84 <count> <random-triggers> <randbit> <nrand> <set-ids>

{| |-
!'''Element'''!![[GRFActionsDetailed|'''Size''']]!!'''Description'''
|-
|<Sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action.
|-
|02||B||Defines action 02
|-
|<feature>||B||For what type of vehicle/station/... should this definition be used?
|-
|<set-id>||B||The ID of this action 2 (used like a cargo ID)
|-
|80, 83, 84||B||Type of random action, see below.
|-
|<count>||B||(when present) Location of controlling vehicle.
|-
|<random-triggers>||B||When to re-randomize
|-
|<randbit>||B||What random bit to use for this action 2
|-
|<nrand>||B||Number of set-ids to choose from, must be a power of 2
|-
|<set-ids>||W||Action 2 set-ids to choose from.
|}

== 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
|-
|0D||Airports
|-
|0F||Objects
|-
|10||Railtypes
|-
|11||Airport Tiles
|-
|12||Roadtypes
|-
|13||Tramtypes
|-
|14||Road Stops
|}

=== set-ID ===

This defines the number of this action 2.  The ID can then be used as target in an action 3 or another variational/random action 2.

=== 80/83/84 ===

Use 80 to randomize the object (vehicle, station, building, industry, object) based on its own triggers and bits.

Use 83 to randomize the object based on its "related" object (s.b.).

Use 84 to randomize the vehicle based on any vehicle in the consist.

{| |-
!Feature!!Related object
|-
|Vehicles (00-03)||First vehicle of consist
|-
|Stations (04)||N/A
|-
|Houses (07)||N/A
|-
|Industry tiles (09)||Industry containing tile
|-
|Industries (0A)||N/A
|-
|Objects (0F)||N/A
|}

=== count ===

For type 84, this specifies which vehicle's random bits this vehicle will be using and/or modifying.

The low nibble (bits 0-3) specifies how far to count from the starting vehicle. If it is zero, the count will be read from GRF register 100h instead.

The high nibble (bits 6-7, actually) specifies which vehicle is the starting vehicle, and which direction to count:

{| |-
!Value!!Meaning
|-
|0||count back (away from the engine), starting at this vehicle
|-
|4||count forward (toward the engine), starting at this vehicle.
|-
|8||count back, starting at the engine
|-
|C||count back, starting at the first vehicle in this chain of vehicles with the same ID, as for vehicle variable 41
|}

Bits 4-5 are reserved and must be zero, so other values of the high nibble are not allowed.

=== random-triggers ===

This is a bit mask of triggers which cause re-randomizing. Normally, any matching trigger causes the graphics to be randomized again, but if you add 80 to the bitmask, the re-randomizing only happens if '''all''' triggers have occurred.

Trigger bits are feature-specific, see below.

Note, that rerandomisation only occurs in the graphics chain, not for callbacks. So, if you use a random action only inside a callback and want to rerandomise the bits, you have to add a "dummy" rerandomisation RA2 into the graphics chain.

Example:
-1 * -1 02 04 02
80 // random in callback
00 // no triggers
00 // first random bit to use
\b 16 // number of cases
\w 10 \w 11 \w 12 \w 13 // random cases
\w 14 \w 15 \w 16 \w 17
\w 18 \w 19 \w 20 \w 21
\w 22 \w 23 \w 24 \w 25

-1 * -1 02 04 01
85 0C 00 \wx FFFF
01
\w 2 \w 14 \w 14 // callback 14
\w 3 // graphics chain

-1 * -1 02 04 00
80 // dummy random outside callback
04 // train arrival
00 // first bit to rerandomise
\b 16 // number of cases
\w 1 \w1 \w 1 \w1 // all cases the same, only for triggering rerandomisation
\w 1 \w1 \w 1 \w1
\w 1 \w1 \w 1 \w1
\w 1 \w1 \w 1 \w1

-1 * -1 03 04 01 00 00 \w 0 // action 3

=== randbit ===

{{ottdp|no|<2.5|ttdprev=alpha30}} For versions before TTDPatch 2.0.1 alpha 30, leave this at 00. It doesn't quite work the way intended (it was supposed to allow independent random chains, but currently everything is re-randomized at the same time, thereby defeating this mechanism).

{{ottdp| |2.5|ttdprev=alpha 30}} Since TTDPatch 2.0.1 alpha 30, only those bits that actually get triggered will be re-randomized. Prior versions always re-randomized all bits. This will make it possible to have independent sets of bits for independent triggers (or untriggered bits, set only at the time of purchase). Setting randbit determines the first bit to be re-randomized, as well as basing the random graphics on. The total number of bits used is the 2-logarithm of nrand below (e.g., for nrand=16, 4 bits are used).

=== nrand ===

Number of different sets to choose from.  This must be a power of 2, i.e. 2, 4, 8, 16 etc.

=== set-ids ===

Action 2 IDs to randomly choose from

== Triggers ==

{| |-
!rowspan="2"|Feature
!colspan="2"|Random bits
!rowspan="2"|Triggers
|-
!Self!!Related
|-
|Vehicles
|8
{{ottdp|14.0|no}} 16
|8 read-only
{{ottdp|14.0|no}} 16 read-only
|yes
|-
|Stations||16 + 4 <ref name="stationshared">16 Bits shared for the whole station/airport (airport and station share the same bits). 4 bits per tile.</ref><ref>TTDPatch actually only implements 8 shared random bits (plus 4 per tile). Bits 8-15 are always zero.</ref>
|no||yes
|-
|Canals||8||no||no
|-
|Houses||8||no||yes
|-
|Industry tiles||8||16||yes
|-
|Industries||16||no||no
|-
|Airports||16 <ref name="stationshared"/>||no||no
|-
|Objects||8||no||no
|-
|Railtypes||2||no||no
|-
|Roadtypes||2||no||no
|-
|Tramtypes||2||no||no
|-
|Airport tiles||16 + 4 <ref name="stationshared"/>||no||no
|-
|Road stops||16 + 8 <ref name="stationshared"/>||no||no
|}
<references/>

=== Vehicles ===

Vehicles have 8 random bits, increased to 16 since {{ottdp|14.0|no}}, and the following triggers:

{| |-
!Bit!!Value!!Version!!Trigger
|-
|0||01||{{ottdp|0.6|2.0}}||Vehicle gets new load of cargo (only after it was empty)
|-
|1||02||{{ottdp|0.6|2.0}}||Vehicle enters a depot and is serviced
|-
|2||04||{{ottdp|0.6|2.5}}||The consist has unloaded all cargo
|-
|3||08||{{ottdp|0.6|2.5}}||Any vehicle of the consist receives cargo
|-
|4||10||{{ottdp|0.6|2.5}}||[[Callbacks#32-day callback (32) |Callback 32]] returned 1
|}

The consist trigger bits 2 and 3 allow re-randomizing whenever the consist receives cargo after fully unloading. They should be used with action 2 type 80, not 83, and the random-triggers variable should have 80 added to it, to make the re-randomizing happen only if the consist was empty and '''then''' received new cargo.

Vehicles can read the random bits of other vehicles (using random action type 83 or 84), but they can only trigger
rerandomisation of their own bits. Do not specify any triggers for rerandomisation when accessing random bits of other vehicles (via type 83 or 84), it will not do what you think.

=== Stations ===

Stations have 16+4 random bits. Bits 0 to 15 are a property of the station as a whole, and bits 16 to 19 are different for each tile.  To get tile-based randomness, therefore use randbit=10 and nrand of no more than 16 (since only 4 random bits are available per tile).

{| |-
!Bit!!Value!!Version!!Trigger
|-
|0||01||{{ottdp|1.3|2.5}}||new cargo waiting
|-
|1||02||{{ottdp|1.3|2.5}}||no more cargo
|-
|2||04||{{ottdp|1.3|2.5}}||train arrives (starts unloading/loading)
|-
|3||08||{{ottdp|1.3|2.5}}||train leaves (done unloading & loading)
|-
|4||10||{{ottdp|1.3|2.5}}||train loads or unloads cargo
|-
|5||20||{{ottdp|1.3|2.5}}||train reserves platform (using PBS)
|}

Also note that none of the above triggers will actually trigger unless prop. 12 has at least one bit set.  Triggers 01 will be triggered for any of the cargo types set in prop. 12, but trigger 02 will only be triggered if all of those cargo types have no more cargo waiting. Triggers 04, 08 and 20 are triggered no matter what cargo types the train transports, as long as prop. 12 is not zero.

Triggers 04, 08, 10 and 20 only affect the platform on which they occur, as well as the random bits of the station, but not other platforms.

Because the 'occured triggers' are only stored once per station (not distinguishing tiles or cargo types), adding 80 to
random-triggers does not make a lot of sense.

=== Town building triggers ===

Town buildings have 8 random bits.

{| |-
!Bit!!Value!!Version!!Trigger
|-
|0||01||{{ottdp|0.6|2.5}}||the building tile is processed in the periodic tile processing loop
|-
|1||02||{{ottdp|0.6|2.5}}||the top tile of the building is processed in the periodic tile processing loop
|}

The periodic tile processing loop constantly processes the tiles of the map, processing any given tile in every 256 ticks (approx. 3.5 TTD days). Since no "real" event happens to town buildings, you have only this opportunity to re-randomize the look of your building.

If every 3.5 days is too fast for you, you can multiply the time-out by setting property 16 for the given tile. The time-out is 256 ticks*(prop. 16+1), so 0 means every 3.5 days, 1 means every 7 days, 2 means every 10.5 days and so on.

If trigger 02 is activated, all parts of the building that has this trigger set will get the same random bits, allowing you to randomize a multi-tile building as one unit. On the other hand, if the tiles of a multi-tile building have trigger 1 set, all tiles will be randomized individually. Note that all tiles of a multi-tile building get the same value when building the building.

=== Industry tile triggers ===

Industry tiles have 8+16 random bits. Accessed through random action 2 type 80, you get 8 tile-specific bits, and accessed through random action 2 type 83, you get 16 industry-specific bits. The triggers are the same for both. Triggers 02 and 04 are triggered for all tiles of the industry at once. Every tile can rerandomise both its own random bits and those of the industry. That is every tile can specify some bits of the industry to rerandomize, and the union of all those bits will be rerandomsied at the end.

{| |-
!Bit!!Value!!Version!!Trigger
|-
|0||01||{{ottdp|0.6|2.5}}||the building tile is processed in the periodic tile processing loop<ref>{{ottdp|no| |}} Rerandomisation of the shared bits of the industry does not happen properly in current TTDPatch.</ref>
|-
|1||02||{{ottdp|0.6|2.5}}||triggers simultaneously for all tiles of the industry every 256 ticks. If the industry is a primary one, output cargo is generated at the same time.
|-
|2||04||{{ottdp|0.6|2.5}}||cargo is delivered to the industry. If the industry is a processing one, output cargo is generated at the same time.
|}
<references />

Trigger 1 works similarly to trigger 1 for houses except that you cannot multiply the timeout: it's always 256 ticks.

Industry tiles can rerandomise both their own random bits as well as the random bits of the industry (via random action type 83).
The remembered triggers for rerandomisation with 80 added to the triggers are in both cases the same per tile.

Industries have random bits. However, they can only be rerandomised by their tiles.

=== Canals ===

Canals / Rivers have 8 random bits.

There is currently no way to influence the random byte creation via triggers, internally the bits are feed from VarAction2Canals var 83 that is set when building a canal. Feature ids not supported by VarAction2Canals are undefined and should never be used.

=== Objects ===

Objects have 8 random bits per tile of the object.

There are no triggers for objects however.

Also note that the random bits are unique to each tile in the object, and are not shared across the whole object.

=== Railtypes ===

Rail tiles have 2 pseudo random bits, based on tile location.

There are no triggers.

=== Roadtypes ===

Road tiles have 2 pseudo random bits, based on tile location.

There are no triggers.

=== Tramtypes ===

Tram tiles have 2 pseudo random bits, based on tile location.

There are no triggers.

=== Road stops ===

Road stops have 16+4 random bits. Bits 0 to 15 are a property of the station as a whole, and bits 16 to 19 are different for each tile.  To get tile-based randomness, therefore use randbit=10 and nrand of no more than 16 (since only 4 random bits are available per tile).

{| |-
!Bit!!Value!!Version!!Trigger
|-
|0||01||{{ottdp|14}}||new cargo waiting
|-
|1||02||{{ottdp|14}}||no more cargo
|-
|2||04||{{ottdp|14}}||road vehicle arrives (starts unloading/loading)
|-
|3||08||{{ottdp|14}}||road vehicle leaves (done unloading & loading)
|-
|4||10||{{ottdp|14}}||road vehicle loads or unloads cargo
|}

Also note that none of the above triggers will actually trigger unless prop. 0D has at least one bit set.  Triggers 01 will be triggered for any of the cargo types set in prop. 0D, but trigger 02 will only be triggered if all of those cargo types have no more cargo waiting. Triggers 04 and 08 are triggered no matter what cargo types the road vehicle transports, as long as prop. 0D is not zero.

Triggers 04, 08, and 10 only affect the tile on which they occur, as well as the random bits of the station, but not other tiles.

Because the 'occured triggers' are only stored once per station (not distinguishing tiles or cargo types), adding 80 to
random-triggers does not make a lot of sense.

=== Other features ===

All features not mentioned in the list above have neither random bits nor triggers, including towns (which would be accessed using random action 2 type 83 for stations and industries).

==Example==

Action3

2023-12-24T14:17:01Z

Jgr: Add road stops to cargo IDs table

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

<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/Houses

2023-11-25T12:28:28Z

Jgr: Fix size values for properties 1F, 20 (incorrectly changed in formatting edit)

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

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.

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

=== 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/Road Stops

2023-10-23T21:52:47Z

Jgr: Add property details

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

== 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||This identifier is reserved for future/non-standard use.
|}

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

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

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

2023-10-23T21:27:13Z

Jgr: Add initial property table

VariationalAction2/Road Stops

2023-10-19T19:53:47Z

Jgr: Add non-parameterised variables

==Introduction==

== Variables ==
{|
!Variable !![[GRFActionsDetailed|Size]] !!Version !! Description
|-
|40||B||{{ottdp|14}}||View/rotation
|-
|41||B||{{ottdp|14}}||Stop type
|-
|42||W||{{ottdp|14}}||Tile information, see below
|-
|43||D||{{ottdp|14}}||Road type
|-
|44||D||{{ottdp|14}}||Tram type
|-
|45||D||{{ottdp|14}}||Get [[TownZones|town zone]] and Manhattan distance of closest town
|-
|46||D||{{ottdp|14}}||Get square of Euclidian distance of closest town
|-
|47||B||{{ottdp|14}}||Player (company) information
|-
|48|| || ||See [[VariationalAction2/BaseStation|Base Stations]].
|-
|49||B||{{ottdp|14}}||Current animation frame
|-
|60-65|| || ||See [[VariationalAction2/BaseStation|Base Stations]].
|-
|66||D||{{ottdp|14}}||Animation frame of nearby tile
|-
|67||D||{{ottdp|14}}||Land info of nearby tiles
|-
|68||D||{{ottdp|14}}||Road stop info of nearby tiles
|-
|6A||D||{{ottdp|14}}||GRFID of nearby tiles
|-
|69|| || ||See [[VariationalAction2/BaseStation|Base Stations]].
|}

== Description ==

=== View/rotation (40) ===

{|
!Value!!Type!!Description
|-
|0||Bay||Facing north-east
|-
|1||Bay||Facing south-east
|-
|2||Bay||Facing south-west
|-
|3||Bay||Facing north-west
|-
|4||Drive-through||X-axis: north-east to south-west
|-
|5||Drive-through||Y-axis: north-west to south-east
|}

=== Stop type (41) ===

{|
!Value!!Meaning
|-
|0||Passenger/bus stop
|-
|1||Freight/lorry stop
|}

=== Tile information (42) ===

The return value has the same values as [[VariationalAction2/Objects#Tile information (41)|object var41]].

=== Road type (43) ===

This has the value of the (translated) roadtype the road stop is built on, or the current roadtype in the build GUI.

If the roadtype has no entry in the roadtype translation table of the GRF, this value will be FFh.

If no translation table is present, the raw value will be returned.

Note: only exact matches of roadtypes are reported. If the translation table of the GRF does not contain the exact roadtype FFh is returned.

If the tile has no road at all (tram only) FFFFFFFFh is returned.

=== Tram type (44) ===

This has the value of the (translated) tramtype the road stop is built on, or the current tramtype in the build GUI.

If the tramtype has no entry in the tramtype translation table of the GRF, this value will be FFh.

If no translation table is present, the raw value will be returned.

Note: only exact matches of tramtypes are reported. If the translation table of the GRF does not contain the exact tramtype FFh is returned.

If the tile has no tram at all (road only) FFFFFFFFh is returned.

=== Get [[TownZones|town zone]] and Manhattan distance of closest town (45) ===

Like [[VarAction2Industries#Get town zone and Manhattan distance of closest town (65)|industry var65]] but instead of an offset the current tile is used.

=== Get square of Euclidian distance of closest town (46) ===

Like [[VarAction2Industries#Get square of Euclidean distance of closest town (66)|industry var66]] but instead of an offset the current tile is used.

=== Player (company) information (47) ===

The return value has the same values as [[VariationalAction2/Vehicles#Player info (43)|vehicle var43]].
The company used is the road stop owner.

=== Animation Frame (49) ===

The return value is the animation frame of the current tile.

=== Animation frame of nearby tile (66) ===

The parameter of this variable is a signed offset from the current tile.

If the selected tile is a road stop tile that belongs to the current station, its animation state is returned. Otherwise, FFFFFFFFh is returned.

=== Land info of nearby tiles (67) ===

The parameter of this variable is a signed offset from the current tile.

Returns the same values as [[VarAction2IndustryTiles#Land info of nearby tiles (60)|industry tile var60]].

=== Road stop info of nearby tiles (68) ===

The parameter of this variable is a signed offset from the current tile.

The returned value is FFFFFFFFh if the selected tile isn't a road stop tile. Otherwise, the returned value can be separated to the following parts:

{| |-
!Bits!!Meaning
|-
|0..7||If the tile is defined in the current GRF, this is the setID used in the definition. Otherwise, the content is undefined.
Note that this field is clamped to the range 0..255. Therefore if the current GRF defines road stops with a setID > 255, this field may only be used to check for road stops in the range 0..254.
|-
|8..9||0 - The tile uses original TTD graphics

1 - The tile is defined in the current GRF

2 - The tile is defined in another GRF
|-
|10||Set if the selected tile belongs to the current station, clear otherwise
|-
|11||Set if the selected tile has a different view/rotation, cleat if the same view/rotation
|-
|12..15||View/rotation of the selected tile
|-
|16..19||0 - Passenger/bus stop

1 - Freight/lorry stop
|-
|20||Set if the stop type (passenger/bus or freight/lorry) is the same as the current tile
|-
|21..31||Undefined, reserved for future use
|}

=== GRFID of nearby road stop tile (6A) ===

The parameter of this variable is a signed offset from the current tile.

The returned value is one of the following:
* '''FFFFFFFFh''' if the selected tile isn't a road stop tile
* '''00000000h''' if the selected station is a default road stop (not a NewGRF road stop)
* otherwise, the GRFID of the GRF which defined the type of the selected road stop tile

VariationalAction2/Road Stops

2023-10-19T19:35:32Z

Jgr: Add parameterised variables

VariationalAction2/Road Stops

2023-10-19T18:45:02Z

Jgr: Initial variable table

Action3

2023-06-11T09:56:02Z

Jgr: Add road stops to feature table

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

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

VariationalAction2

2023-06-11T09:55:16Z

Jgr: Add road stops to feature table

==Introduction==

To support changes in graphics based on other factors than just the load states, you use a VarAction2. This provides a sophisticated way of deciding what graphics to use.

A VarAction2 can be used like any other action 2, but it provides an additional step in-between: instead of defining the action 1 sets right away, it instead specifies a list of additional action 2 entry, one of which is used depending on the kind of variation that is defined. These action 2 entries that are referred can in turn be variational or random (to provide chains of decisions), or they can be the final element, that is a regular action 2 which contains definitions of action 1 sets, or a callback result.

== Format ==

The data looks as follows:

<Sprite-number> * <Length> 02 <feature> <set-id> <type> <variable> <varadjust> <nvar> (<set-id> <low-range> <high-range>){n} <default>

{| |-
!'''Element'''!![[GRFActionsDetailed|'''Size''']]!!'''Description'''
|-
|<Sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action.
|-
|02||B||Defines action 02
|-
|<feature>||B||For what type of vehicle/station should this definition be used?
|-
|<set-id>||B||The ID of this action 2 (used like a cargo ID)
|-
|<type>||B||Type of VarAction2, see below
|-
|<variable>||B||Which variable we base the decision on
|-
|<varadjust>||V||How to manipulate the value before deciding.
|-
|<nvar>||B||Number of different ranges of the value (not counting the default)
|-
|<set-id>||W||Action 2 set-id to use for the following range.
|-
|<low-range>||B/W/D||Minimum (inclusive) of the range for which to use the above set-id
|-
|<high-range>||B/W/D||Maximum (inclusive) of the range
|-
|<default>||W||Action 2 set-id to use if no range matches
|}

The size of <varadjust> depends on <type> as well as the adjustments to be performed and must always provide an AND mask. For <type> 81, a "do nothing" <varadjust> would be 00 FF.

You repeat the sequence of <set-id> <low-range> <high-range> as often as <nvar> specifies.

<low-range> and <high-range> have a size of B, W, or D, depending on <type>. See that entry for more information.

== 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||[[VariationalAction2/Vehicles | Trains]]
|-
|01||[[VariationalAction2/Vehicles | Road Vehicles]]
|-
|02||[[VariationalAction2/Vehicles | Ships]]
|-
|03||[[VariationalAction2/Vehicles | Aircraft]]
|-
|04||[[VariationalAction2/Stations | Stations]]
|-
|05||[[VariationalAction2/Canals | Canals/Rivers]]
|-
|06||[[VariationalAction2/Bridges | Bridges]]
|-
|07||[[VariationalAction2/Houses | Houses]]
|-
|09||[[VariationalAction2/Industry Tiles | Industry Tiles]]
|-
|0A||[[VariationalAction2/Industries | Industries]]
|-
|0B||Cargos (no feature specific variables)
|-
|0C||Sound Effects (no feature specific variables)
|-
|0D||[[VariationalAction2/Airports | Airports]]
|-
|0E||[[VariationalAction2/Signals | Signals]]
|-
|0F||[[VariationalAction2/Objects | Objects]]
|-
|10||[[VariationalAction2/Railtypes | Railtypes]]
|-
|11||[[VariationalAction2/Airport Tiles | Airport Tiles]]
|-
|12||[[VariationalAction2/Roadtypes | Roadtypes]]
|-
|13||[[VariationalAction2/Tramtypes | Tramtypes]]
|-
|14||[[VariationalAction2/Road Stops | Road Stops]]
|}

=== Set-ID ===

This defines the number of this action 2.  The ID can then be used as target in an action 3 or another variational/random action 2.

=== Type ===

{| |-
! !! B Access lowest byte !! {{ottdp|0.6|2.5}} W Access lowest word !! {{ottdp|0.6|2.5}} D Access lowest doubleword
|-
!align="left"| Access general variable or variable of the primary object
|align="center"| 81
|align="center"| 85
|align="center"| 89
|-
!align="left"| Access variable of "related" object
|align="center"| 82
|align="center"| 86
|align="center"| 8A
|}

The access type specifies both the size of the variable access, and selects between general variables and the object's innate variables, or variables of a specific "related" object.

{|- |
!colspan="2"|[[Features|Feature]]!!Related object
|-
|00-03||[[VariationalAction2/Vehicles | Vehicles]]||First [[VariationalAction2/Vehicles | vehicle]] of consist
|-
|04||[[VariationalAction2/Stations | Stations]]||[[VariationalAction2/Towns | Town]] to which station belongs
|-
|05||[[VariationalAction2/Canals | Canals/Rivers]]||N/A
|-
|06||[[VariationalAction2/Bridges | Bridges]]||[[VariationalAction2/Towns | Town]] of bridge
|-
|07||[[VariationalAction2/Houses | Houses]]||[[VariationalAction2/Towns | Town]] of house
|-
|09||[[VariationalAction2/Industry Tiles | Industry Tiles]]||[[VariationalAction2/Industries | Industry]] containing tile
|-
|0A||[[VariationalAction2/Industries | Industries]]||[[VariationalAction2/Towns | Town]] of industry
|-
|0B||Cargos||N/A
|-
|0C||Sound Effects||N/A
|-
|0D||[[VariationalAction2/Airports | Airports]]||N/A
|-
|0E||[[VariationalAction2/Signals | Signals]]||N/A
|-
|0F||[[VariationalAction2/Objects | Objects]]||[[VariationalAction2/Towns | Town]] of object
|-
|10||[[VariationalAction2/Railtypes | Railtypes]]||N/A
|-
|11||[[VariationalAction2/Airport Tiles | Airport Tiles]]||N/A
|-
|12||[[VariationalAction2/Roadtypes | Roadtypes]]||N/A
|-
|13||[[VariationalAction2/Tramtypes | Tramtypes]]||N/A
|}

Every variable specifies a size for it. Not every variable is a doubleword.
If the accessed variable is smaller than the size given here, the extra bits may contain junk, and should be <and-masked> out.

=== Variable ===

Variational Action 2 allows accessing these variables:

{| |-
!'''Number'''!![[GRFActionsDetailed|'''Size''']]!!Version!!'''Meaning'''
|-
|00-3F|| || ||See [[GlobalVariables| global variables page]].
|-
|40+x||D|| ||specially calculated feature-specific variable, see following feature-specific pages
|-
|5F||D||{{ottdp|0.7|2.6|ttdprev=r1928}}||Feature-specific random data: triggers in low byte, bits in other three bytes. Bits of the variable not associated with random or trigger bits are reserved.
|-
|60+x||D|| ||similar to 40+x variables, but the variable number must be followed by a byte, which will be given to the variable handler as parameter.
|-
|7B||-||{{ottdp|1.1|2.6|ottdrev=r21604|ttdprev=r2359}}||A special 60+x variable to be used in Advanced Variational Action 2. It allows to evaluate any other 60+x variable using a non-constant parameter from a register. The parameter of variable 7B specifies another 60+x variable which is evaluated. The parameter for that variable is read from the accumulator ('val1'), i.e. the result from the preceding operations of the same Advanced Variational Action 2. Hence variable 7B may not be the first variable used in the calculation. Variable 7B itself and 7E (procedure call) are not allowed to be used as parameter for variable 7B.

{{ottdp|1.2|no|ottdrev=r23138}} Since OpenTTD r23138 you can use this to pass 32 bit parameters to 60+x variables. Currently this is only useful for a few variables, e.g. vehicle variable 60. For most variables the higher bits of the parameter are considered reserved. So, make sure to mask the higher bits in the preceding calculations.
|-
|7C||D||{{ottdp|0.6|2.6|ttdprev=r1315}}||A special 60+x variable used to access values stored in the registers of [[Storages#Persistent storage|persistent storage]].
|-
|7D||D||{{ottdp|0.6|2.6|ttdprev=r1246}}||A special 60+x variable used to access values stored in the registers of [[Storages#Temporary storage|temporary storage]]. Available in the purchase list.
|-
|7E||D||{{ottdp|0.6|2.5}}||A special 60+x variable indicating a [[VarAction2Advanced#Using procedures|procedure call]]. Available in the purchase list.
|-
|7F||D||{{ottdp|0.6|2.5}}||A special 60+x variable that reads GRF parameter whose number is given by the 60+x parameter. Available in the purchase list.
|-
|80+x|| || ||Feature-specific variable, see following feature-specific pages. While most of these variables actually refer to raw memory locations of original TTD structures, you cannot rely on that. Some variables were added later, some were moved or replaced. Only the variables listed in the specs are somewhat set to not be changed in the future.
|}

For all features, the 80+x variables are offsets into the corresponding structure in TTD's game data.  The 40+x and 60+x variables are special variables that are computed on-the-fly, and aren't actually stored anywhere in memory, unless stated otherwise. Therefore they should be used as little as necessary so as not to slow down the game too much with the calculation of these variables (which can be called thousands of times per second, whenever any vehicle moves).

When displaying a vehicle (etc.) in the purchase list, the game will show those variations based on external variables (dates etc.) correctly, but variations based on vehicle variables (variables 40+x, 60+x and 80+x) will always show the first (not the default) cargo-ID unless otherwise specified for the given variable. If you do a calculation, the first cargo-ID will be selected if any of the needed variables is inaccessible.

The lists of 80+x variables on the following pages are not exhaustive; only the useful variables are listed there. For a full list check the definition of corresponding structures in TTD. Marcin Grzegorczyk has a pretty good list of the structure definitions on his [http://marcin.ttdpatch.net/sv1codec/TTD-locations.html savegame internals page].

=== varadjust ===

Adjust variable to a more useful range. It has the following format:

<pre> <shift-num> <and-mask> <nowiki>[<add-val> <divide-val>/<modulo-val>]</nowiki></pre>

{| |-
!'''Element'''!![[GRFActionsDetailed|'''Size''']]!!'''Description'''
|-
|shift-num||B||value to right-shift the variable, and some special bits. See below.
|-
|and-mask||B/W/D||value with which to AND the variable after shifting. Return this value if neither bit 6 nor bit 7 of shift-num are set.
|-
|add-val||B/W/D||value to add to the variable after ANDing. Only present if bits 6 or 7 are set in shift-num.
|-
|divide-val||B/W/D||return the sum divided by this value. Only present if bit 6 is set in shift-num.
|-
|modulo-val||B/W/D||return the sum modulo (remainder of division by) this value. Only present if bit 7 is set in shift-num.
|}

<shift-num> is a partial bit-mask; its bits have the following meanings:

{| |-
!Bit(s)!!Value!!Version!!Meaning
|-
|0..4||0..1F||{{ottdp|0.6|2.0}}||number of bits to right shift <variable>
|-
|5||20||{{ottdp|0.6|2.5}}||This is an [[VarAction2Advanced|advanced VarAction2]]
|-
|6||40||{{ottdp|0.6|2.5}}||This is a shift-and-add-divide adjustment.
|-
|7||80||{{ottdp|0.6|2.5}}||This is a shift-and-add-modulo adjustment.
|}

Bits 6 and 7 may not both be set. If neither are set, this varadjust is a shift-and adjustment.

Note that for the add and divide operations, both the variable and the divisor are taken to be signed numbers. This means that if the high bit is set, the number is taken to be negative, so you may need to mask out the most significant bit to do an unsigned division.

=== nvar ===

Here you set how many different ranges to check for. If the value of the variable, after the above manipulations, is not within one of these ranges, the default will be used.  When displayed in the purchase window, the game will always show the first range if the variable is of the 40+x or 80+x type (because the variable is undefined since the vehicle doesn't exist yet).

{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 57}} Since TTDPatch 2.0.1 alpha 57, nvar=0 is a special case. Instead of using ranges, nvar=0 means that the result of an [[VarAction2Advanced|advanced]] calculation (or, if no calculation is performed, the adjusted variable value itself) is returned as callback result, with bit 15 set.  This is useful for those callbacks where many different return values are possible and it is easier to calculate them than list them in ranges.  The default value must still be specified, and will be used in case the variable(s) used are not available.

=== sets and ranges ===

For each of the ranges to check, you give the set-id as a '''WORD''' value (i.e. with a 00 following, e.g. set-id 5 becomes 05 00, or - in case of a callback result - by setting the high bit, e.g. 05 80), followed by the low and high limits of this range.  The first range that matches will be used.

The various \b, \w, and \d escape sequences can be useful for <min-range> and <max-range>. See [[GRFActionsDetailed#Byte order|the discussion of escape sequences]] for further information.

=== default ===

The set-id to use if none of the ranges matches.

=Example=
<pre>
-1 * 15 02 05 03 81 // Action2, Feature 05 (canals), action2ID 03, 1-byte variable
81 00 04 // variable 81 (terrain type), shift 00, mask 0x04 (=bit for "on or above snowline")
01 // check one range
02 00 04 04 // snowy tile: link to action2ID 02
01 00 // default: link to action2ID 01

</pre>

RandomAction2

2023-06-11T09:53:47Z

Jgr: Add road stops to feature table

==Introduction==

Unlike [[VariationalAction2]], whose results are always determined by a predictable decision, RandomAction2 can use randomized results to pick one of several [[Action2]] entries.

== Format ==

The data looks as follows:

<Sprite-number> * <Length> 02 <feature> <set-id> <nowiki>[80|83]</nowiki> <random-triggers> <randbit> <nrand> <set-ids>

From TTDPatch 2.6 r1850 and OpenTTD r12452, and '''for vehicles only''':

<Sprite-number> * <Length> 02 <feature> <set-id> 84 <count> <random-triggers> <randbit> <nrand> <set-ids>

{| |-
!'''Element'''!![[GRFActionsDetailed|'''Size''']]!!'''Description'''
|-
|<Sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action.
|-
|02||B||Defines action 02
|-
|<feature>||B||For what type of vehicle/station/... should this definition be used?
|-
|<set-id>||B||The ID of this action 2 (used like a cargo ID)
|-
|80, 83, 84||B||Type of random action, see below.
|-
|<count>||B||(when present) Location of controlling vehicle.
|-
|<random-triggers>||B||When to re-randomize
|-
|<randbit>||B||What random bit to use for this action 2
|-
|<nrand>||B||Number of set-ids to choose from, must be a power of 2
|-
|<set-ids>||W||Action 2 set-ids to choose from.
|}

== 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
|-
|0D||Airports
|-
|0F||Objects
|-
|10||Railtypes
|-
|11||Airport Tiles
|-
|12||Roadtypes
|-
|13||Tramtypes
|-
|14||Road Stops
|}

=== set-ID ===

This defines the number of this action 2.  The ID can then be used as target in an action 3 or another variational/random action 2.

=== 80/83/84 ===

Use 80 to randomize the object (vehicle, station, building, industry, object) based on its own triggers and bits.

Use 83 to randomize the object based on its "related" object (s.b.).

Use 84 to randomize the vehicle based on any vehicle in the consist.

{| |-
!Feature!!Related object
|-
|Vehicles (00-03)||First vehicle of consist
|-
|Stations (04)||N/A
|-
|Houses (07)||N/A
|-
|Industry tiles (09)||Industry containing tile
|-
|Industries (0A)||N/A
|-
|Objects (0F)||N/A
|}

=== count ===

For type 84, this specifies which vehicle's random bits this vehicle will be using and/or modifying.

The low nibble (bits 0-3) specifies how far to count from the starting vehicle. If it is zero, the count will be read from GRF register 100h instead.

The high nibble (bits 6-7, actually) specifies which vehicle is the starting vehicle, and which direction to count:

{| |-
!Value!!Meaning
|-
|0||count back (away from the engine), starting at this vehicle
|-
|4||count forward (toward the engine), starting at this vehicle.
|-
|8||count back, starting at the engine
|-
|C||count back, starting at the first vehicle in this chain of vehicles with the same ID, as for vehicle variable 41
|}

Bits 4-5 are reserved and must be zero, so other values of the high nibble are not allowed.

=== random-triggers ===

This is a bit mask of triggers which cause re-randomizing. Normally, any matching trigger causes the graphics to be randomized again, but if you add 80 to the bitmask, the re-randomizing only happens if '''all''' triggers have occurred.

Trigger bits are feature-specific, see below.

Note, that rerandomisation only occurs in the graphics chain, not for callbacks. So, if you use a random action only inside a callback and want to rerandomise the bits, you have to add a "dummy" rerandomisation RA2 into the graphics chain.

Example:
-1 * -1 02 04 02
80 // random in callback
00 // no triggers
00 // first random bit to use
\b 16 // number of cases
\w 10 \w 11 \w 12 \w 13 // random cases
\w 14 \w 15 \w 16 \w 17
\w 18 \w 19 \w 20 \w 21
\w 22 \w 23 \w 24 \w 25

-1 * -1 02 04 01
85 0C 00 \wx FFFF
01
\w 2 \w 14 \w 14 // callback 14
\w 3 // graphics chain

-1 * -1 02 04 00
80 // dummy random outside callback
04 // train arrival
00 // first bit to rerandomise
\b 16 // number of cases
\w 1 \w1 \w 1 \w1 // all cases the same, only for triggering rerandomisation
\w 1 \w1 \w 1 \w1
\w 1 \w1 \w 1 \w1
\w 1 \w1 \w 1 \w1

-1 * -1 03 04 01 00 00 \w 0 // action 3

=== randbit ===

{{ottdp|no|<2.5|ttdprev=alpha30}} For versions before TTDPatch 2.0.1 alpha 30, leave this at 00. It doesn't quite work the way intended (it was supposed to allow independent random chains, but currently everything is re-randomized at the same time, thereby defeating this mechanism).

{{ottdp| |2.5|ttdprev=alpha 30}} Since TTDPatch 2.0.1 alpha 30, only those bits that actually get triggered will be re-randomized. Prior versions always re-randomized all bits. This will make it possible to have independent sets of bits for independent triggers (or untriggered bits, set only at the time of purchase). Setting randbit determines the first bit to be re-randomized, as well as basing the random graphics on. The total number of bits used is the 2-logarithm of nrand below (e.g., for nrand=16, 4 bits are used).

=== nrand ===

Number of different sets to choose from.  This must be a power of 2, i.e. 2, 4, 8, 16 etc.

=== set-ids ===

Action 2 IDs to randomly choose from

== Triggers ==

{| |-
!rowspan="2"|Feature
!colspan="2"|Random bits
!rowspan="2"|Triggers
|-
!Self!!Related
|-
|Vehicles
|8
{{ottdp|14.0|no}} 16
|8 read-only
{{ottdp|14.0|no}} 16 read-only
|yes
|-
|Stations||16 + 4 <ref name="stationshared">16 Bits shared for the whole station/airport (airport and station share the same bits). 4 bits per tile.</ref><ref>TTDPatch actually only implements 8 shared random bits (plus 4 per tile). Bits 8-15 are always zero.</ref>
|no||yes
|-
|Canals||8||no||no
|-
|Houses||8||no||yes
|-
|Industry tiles||8||16||yes
|-
|Industries||16||no||no
|-
|Airports||16 <ref name="stationshared"/>||no||no
|-
|Objects||8||no||no
|-
|Railtypes||2||no||no
|-
|Roadtypes||2||no||no
|-
|Tramtypes||2||no||no
|-
|Airport tiles||16 + 4 <ref name="stationshared"/>||no||no
|}
<references/>

=== Vehicles ===

Vehicles have 8 random bits, increased to 16 since {{ottdp|14.0|no}}, and the following triggers:

{| |-
!Bit!!Value!!Version!!Trigger
|-
|0||01||{{ottdp|0.6|2.0}}||Vehicle gets new load of cargo (only after it was empty)
|-
|1||02||{{ottdp|0.6|2.0}}||Vehicle enters a depot and is serviced
|-
|2||04||{{ottdp|0.6|2.5}}||The consist has unloaded all cargo
|-
|3||08||{{ottdp|0.6|2.5}}||Any vehicle of the consist receives cargo
|-
|4||10||{{ottdp|0.6|2.5}}||[[Callbacks#32-day callback (32) |Callback 32]] returned 1
|}

The consist trigger bits 2 and 3 allow re-randomizing whenever the consist receives cargo after fully unloading. They should be used with action 2 type 80, not 83, and the random-triggers variable should have 80 added to it, to make the re-randomizing happen only if the consist was empty and '''then''' received new cargo.

Vehicles can read the random bits of other vehicles (using random action type 83 or 84), but they can only trigger
rerandomisation of their own bits. Do not specify any triggers for rerandomisation when accessing random bits of other vehicles (via type 83 or 84), it will not do what you think.

=== Stations ===

Stations have 16+4 random bits. Bits 0 to 15 are a property of the station as a whole, and bits 16 to 19 are different for each tile.  To get tile-based randomness, therefore use randbit=10 and nrand of no more than 16 (since only 4 random bits are available per tile).

{| |-
!Bit!!Value!!Version!!Trigger
|-
|0||01||{{ottdp|1.3|2.5}}||new cargo waiting
|-
|1||02||{{ottdp|1.3|2.5}}||no more cargo
|-
|2||04||{{ottdp|1.3|2.5}}||train arrives (starts unloading/loading)
|-
|3||08||{{ottdp|1.3|2.5}}||train leaves (done unloading & loading)
|-
|4||10||{{ottdp|1.3|2.5}}||train loads or unloads cargo
|-
|5||20||{{ottdp|1.3|2.5}}||train reserves platform (using PBS)
|}

Also note that none of the above triggers will actually trigger unless prop. 12 has at least one bit set.  Triggers 01 will be triggered for any of the cargo types set in prop. 12, but trigger 02 will only be triggered if all of those cargo types have no more cargo waiting. Triggers 04, 08 and 20 are triggered no matter what cargo types the train transports, as long as prop. 12 is not zero.

Triggers 04, 08, 10 and 20 only affect the platform on which they occur, as well as the random bits of the station, but not other platforms.

Because the 'occured triggers' are only stored once per station (not distinguishing tiles or cargo types), adding 80 to
random-triggers does not make a lot of sense.

=== Town building triggers ===

Town buildings have 8 random bits.

{| |-
!Bit!!Value!!Version!!Trigger
|-
|0||01||{{ottdp|0.6|2.5}}||the building tile is processed in the periodic tile processing loop
|-
|1||02||{{ottdp|0.6|2.5}}||the top tile of the building is processed in the periodic tile processing loop
|}

The periodic tile processing loop constantly processes the tiles of the map, processing any given tile in every 256 ticks (approx. 3.5 TTD days). Since no "real" event happens to town buildings, you have only this opportunity to re-randomize the look of your building.

If every 3.5 days is too fast for you, you can multiply the time-out by setting property 16 for the given tile. The time-out is 256 ticks*(prop. 16+1), so 0 means every 3.5 days, 1 means every 7 days, 2 means every 10.5 days and so on.

If trigger 02 is activated, all parts of the building that has this trigger set will get the same random bits, allowing you to randomize a multi-tile building as one unit. On the other hand, if the tiles of a multi-tile building have trigger 1 set, all tiles will be randomized individually. Note that all tiles of a multi-tile building get the same value when building the building.

=== Industry tile triggers ===

Industry tiles have 8+16 random bits. Accessed through random action 2 type 80, you get 8 tile-specific bits, and accessed through random action 2 type 83, you get 16 industry-specific bits. The triggers are the same for both. Triggers 02 and 04 are triggered for all tiles of the industry at once. Every tile can rerandomise both its own random bits and those of the industry. That is every tile can specify some bits of the industry to rerandomize, and the union of all those bits will be rerandomsied at the end.

{| |-
!Bit!!Value!!Version!!Trigger
|-
|0||01||{{ottdp|0.6|2.5}}||the building tile is processed in the periodic tile processing loop<ref>{{ottdp|no| |}} Rerandomisation of the shared bits of the industry does not happen properly in current TTDPatch.</ref>
|-
|1||02||{{ottdp|0.6|2.5}}||triggers simultaneously for all tiles of the industry every 256 ticks. If the industry is a primary one, output cargo is generated at the same time.
|-
|2||04||{{ottdp|0.6|2.5}}||cargo is delivered to the industry. If the industry is a processing one, output cargo is generated at the same time.
|}
<references />

Trigger 1 works similarly to trigger 1 for houses except that you cannot multiply the timeout: it's always 256 ticks.

Industry tiles can rerandomise both their own random bits as well as the random bits of the industry (via random action type 83).
The remembered triggers for rerandomisation with 80 added to the triggers are in both cases the same per tile.

Industries have random bits. However, they can only be rerandomised by their tiles.

=== Canals ===

Canals / Rivers have 8 random bits.

There is currently no way to influence the random byte creation via triggers, internally the bits are feed from VarAction2Canals var 83 that is set when building a canal. Feature ids not supported by VarAction2Canals are undefined and should never be used.

=== Objects ===

Objects have 8 random bits per tile of the object.

There are no triggers for objects however.

Also note that the random bits are unique to each tile in the object, and are not shared across the whole object.

=== Railtypes ===

Rail tiles have 2 pseudo random bits, based on tile location.

There are no triggers.

=== Roadtypes ===

Road tiles have 2 pseudo random bits, based on tile location.

There are no triggers.

=== Tramtypes ===

Tram tiles have 2 pseudo random bits, based on tile location.

There are no triggers.

=== Other features ===

All features not mentioned in the list above have neither random bits nor triggers, including towns (which would be accessed using random action 2 type 83 for stations and industries).

==Example==

Action2

2023-06-11T09:52:40Z

Jgr: Add road stops to feature table

== Introduction ==

Defining graphics set IDs.

Action2 is used to group sets of sprites from the previous [[Action1]] together, and make them accessible by a [[VariationalAction2|variational]] or [[RandomAction2|random action 2]] (chain) or an [[Action3]].

Do not skip an Action2 using [[Action9]] (unless it skips the whole file). Action2 must not be skipped by Action9 or TTDPatch will most likely crash. Skip or modify [[Action3]] instead. Skipping an Action2 with an [[Action7]] has no effect.

== Syntax ==

In general, the data looks as follows. Some features use a different syntax though (see table below).

<Sprite-number> * <Length> 02 <feature> <set-id> <num-ent1> <num-ent2> <entries...>

{|
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<Sprite-number>||dec||A sequential sprite number
|-
|<length>||dec||The total number of bytes used in this action
|-
|02||B||Defines action 02
|-
|<feature>||B||For what type of feature should the following sprites be used?
|-
|<set-id>||B||What set-ID this action 2 defines
|-
|<num-ent1>||B||First number of entries, depends on feature
|-
|<num-ent2>||B||Second number of entries, depends on feature
|-
|<entries...>||W||Entry numbers, depends on the feature
|}

== Descriptions ==

=== 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||[[Action2/Vehicles | Trains]]
|-
|01||[[Action2/Vehicles | Road Vehicles]]
|-
|02||[[Action2/Vehicles | Ships]]
|-
|03||[[Action2/Vehicles | Aircraft]]
|-
|04||[[Action2/Stations | Stations]]
|-
|05||[[Action2/Single_Set | Canals/Rivers]]
|-
|07||[[Action2/Sprite_Layout | Houses]] (special Sprite Layout format)
|-
|09||[[Action2/Sprite_Layout | Industry Tiles]] (special Sprite Layout format)
|-
|0A||[[Action2/Industries | Industries]] (special Production Callback format)
|-
|0B||[[Action2/Single_Set | Cargos]]
|-
|0C||[[Action2/Only_Callback_Failure | Sound Effects]] (callback failure only)
|-
|0D||[[Action2/Single_Set | Airports]]
|-
|0E||[[Action2/Only_Callback_Failure | Signals]] (callback failure only)
|-
|0F||[[Action2/Sprite_Layout | Objects]] (special Sprite Layout format)
|-
|10||[[Action2/Single_Set | Railtypes]]
|-
|11||[[Action2/Sprite_Layout | Airport Tiles]] (special Sprite Layout format)
|-
|12||[[Action2/Single_Set | Roadtypes]]
|-
|13||[[Action2/Single_Set | Tramtypes]]
|-
|14||[[Action2/Sprite_Layout | Road Stops]] (special Sprite Layout format)
|}

=== set-id ===

This defines the ID of the current action 2. This ID will later be referred to by [[Action3|action 3]], or a variational/random action 2.

You can reuse action 2 IDs, and there's no restriction on the order in which they are defined.

=== num-ent1, num-ent2 ===

Each feature has two different graphics ranges, but their exact meaning differs from feature to feature. For example, for vehicles, the first set is used while moving, and the second while loading/unloading in a station.

=== entries ===

This is the list of action 1 sets to use, first num-ent1 for the first range, then num-ent2 entries for the second range.

==Example==

Action1

2023-06-11T09:51:50Z

Jgr: Add road stops to feature table

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

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

Main Page

2023-06-11T09:51:06Z

Jgr: Add road stops to feature tables

== 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]]
| ''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/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]]
| ''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]]
| ''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]]

Action0

2023-06-11T09:45:58Z

Jgr: Add road stops to feature table

==Introduction==

Action 0 allows to change the feature properties of 'features', i.e. vehicles, stations, bridges, houses and more.
Each feature has its own very specific properties. These are explained in detail in their separate pages.

You will also find the minimum version requirements for properites on the pages.
Note, that due to the nature of Action 0 unknown properties cannot be ignored. Only a whole Action 0 can be skipped.
OpenTTD and TTDPatch will disable GRFs once they encounter an unknown property. So, if you use some properties for optional features, which you want to disable for older versions of OpenTTD or TTDPatch, you have to skip the Action 0 using [[Action9|Action 9]].

== Syntax ==

The data for Action 0 looks as follows:

<Sprite-number> * <Length> 00 <Feature> <Num-props> <Num-info> <Id> (<Property <New-info>)...

Here is a short overview of what every term means:

{| |-
!Element!![[GRFActionsDetailed|Size]]!!Description
|-
|<Sprite-number> ||dec||A sequential sprite number
|-
|<Length> ||dec||The total number of bytes in the action
|-
|00 ||B||Action type. In this case, 00
|-
|<Feature> ||B||Which type of feature you would like to change
|-
|<Num-props> ||B||How many properties you would like to change per vehicle or station
|-
|<Num-info> ||B||How many vehicles/stations you would like to change
|-
|<Id> ||B*||The ID of the first vehicle/station to change
|-
|<Property> ||B||What property to change for each vehicle/station
|-
|<New-info> ||V||The new value of the property
|}
You can put an Action 0 anywhere after [[Action8|Action 8]] in the GRF file.

{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 61}} The <Id> is an extended byte since TTDPatch 2.0.1 alpha 61, to support the definition of >255 sound effects.

{{ottdp|0.7|ottdrev=r13482}} {{grf|7|<7}} In OpenTTD since r13482, extended IDs (up to 65535) can be used for vehicles as well. However there is currently a caveat that articulated parts must be below 128.
{{ottdp|1.2}} {{grf|8}} In OpenTTD 1.2, extended IDs (up to 65535) can be used for vehicles as well. The ID for articulated vehicles must be below 16384.

== Descriptions ==

=== Sprite-number ===

Action 0 can appear anywhere in the GRF file, so set it to the sprite number you are currently at.

=== Length ===

The total number of bytes in Action 0. Start counting from <Action>, the bit that sets the pseudo-sprite to act as the specified action.

=== Action ===

The type of action this pseudo-sprites defines. It should be 00 here because we want this pseudo-sprite to act as Action 0.

=== Feature ===

This sets the type of [[Features|feature]] that you wish to change. Set it to:
{|
!Value
!colspan="2"|[[Features|Feature]]
|-
|00 || [[Action0/Vehicles/Trains|Trains]]
|rowspan="4"|[[Action0/Vehicles|Common vehicle properties]]
|-
|01 || [[Action0/Vehicles/RoadVehicles|Road Vehicles]]
|-
|02 || [[Action0/Vehicles/Ships|Ships]]
|-
|03 || [[Action0/Vehicles/Planes|Aircraft]]
|-
|04
|colspan="2"| [[Action0/Stations|Stations]]
|-
|05
|colspan="2"| [[Action0/Canals|Canals]]
|-
|06
|colspan="2"| [[Action0/Bridges|Bridges]]
|-
|07
|colspan="2"| [[Action0/Houses|Houses]] (see [[DefaultHouseProps|defaults]])
|-
|08
|colspan="2"| [[Action0/Global Settings|Global Settings]]
|-
|09
|colspan="2"| [[Action0/Industry Tiles|Industry Tiles]] (see [[IndustryTileDefaultProps|defaults]])
|-
|0A
|colspan="2"| [[Action0/Industries|Industries]] (see [[IndustryDefaultProps|defaults]])
|-
|0B
|colspan="2"| [[Action0/Cargos|Cargos]] (see [[CargoDefaultProps|defaults]])
|-
|0C
|colspan="2"| [[Action0/Sound Effects|Sound Effects]]
|-
|0D
|colspan="2"| [[Action0/Airports|Airports]]
|-
|0F
|colspan="2"| [[Action0/Objects|Objects]]
|-
|10
|colspan="2"| {{ottdp|1.0|no|ottdrev=r18969}} [[Action0/Railtypes|Railtypes]]
|-
|11
|colspan="2"| {{ottdp|1.1|no|ottdrev=r19204}} [[Action0/Airport Tiles|Airport Tiles]]
|-
|12
|colspan="2"| {{ottdp|1.10|no|ottdrev=gc02ef3e456}} [[Action0/Roadtypes|Roadtypes]]
|-
|13
|colspan="2"| {{ottdp|1.10|no|ottdrev=gc02ef3e456}} [[Action0/Tramtypes|Tramtypes]]
|-
|14
|colspan="2"| {{ottdp|14|no|ottdrev=g4c1406a4b5}} [[Action0/Road Stops|Road Stops]]
|}

=== Num-props ===

This is the number of properties that you wish to change per vehicle or station. Note: even if you wish to set the same properties to the same value for different vehicles then you must still repeat the properties and their values for each vehicle.

=== Num-info ===

Simply the number of vehicles that you will change using this action 0.

=== Id ===
The [[VehicleIDs|Vehicle ID]] of the first vehicle or station to change. If num-info is greater than one, this vehicle/station and the following vehicles/stations will be changed.

=== Property ===

The number of the property that will be changed. This and the New-info section are repeated as many times as there are properties to set; in total, there are <
num-props> property bytes.

See relevant sub-section (links at the bottom) for more details.

=== New-info ===

The new information that will replace the previous information for the specified property. This is a variable size; dependent upon the property. Each property byte is followed by <num-info> new-info sections.
The appropriate \b, \w, and \d escape sequences can be quite useful for most <
new-info>s. See [[GRFActionsDetailed#Byte order|the discussion of escape sequences]] for further information.

==Example==

NML:Objects

2023-02-19T22:54:03Z

Jgr: Correct name of colour object variable from company_colour, see: https://github.com/OpenTTD/nml/pull/267

{{NMLNavPropVarCB}}

==Object IDs==
Object IDs are NewGRF-local and can therefore freely be chosen in the 0..255 range. 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.
|-
| 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.
|-
| 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.
|-
| 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.
|-
| 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)
|}

Action13

2022-01-27T23:25:01Z

Jgr: Fix <feature> incorrectly appearing in the format summary line

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

{{ottd|}}Usage of this action with OpenTTD is troublesome in multiplayer. The action does not specify a language code for the translation, but forces the translation on every player. However, GRFs with only action 13 can be loaded as [[OpenTTD static NewGRF]]. {{grfFrom|8}} GRF version 8 alleviates this problem by providing the language that is overridden.

== Format ==

The data looks as follows:

<sprite-number> * <length> 13 <GRFID> (<language-id>)? <num-ent> <offset> <text...>

{|
|-
!'''Element'''
![[GRFActionsDetailed|'''Size''']]
!'''Description'''
|-
|<sprite-number>
|dec
|A sequential sprite number
|-
|<length>
|dec
|The total number of bytes in the action
|-
|13
|B
|Action 13
|-
|<GRFID>
|4*B
|The GRFID of the file whose texts are to be translated
|-
|<language-id>
|B
|{{grfFrom|8}} Which of TTD's languages these strings are for (only for GRF version 8 an higher)
|-
|<num-ent>
|B
|Number of strings
|-
|<offset>
|W
|First text ID
|-
|<text...>
|S
|Zero-terminated strings
|}

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

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

NML:Cargos

2021-11-16T16:21:18Z

Jgr: Clarify that town_growth_multiplier has no effect in OpenTTD

{{NMLNavPropVarCB}}

==Cargo IDs==
For cargos, the item ID corresponds to the cargo type slot of the cargo. TTD default cargos occupy slots 0-11, so if you want to define a new cargo be sure to set this ID to 12 or higher. It is recommended to set the 'number'-property to the same value as the item ID.

==Cargo properties==

{| class="t"
! name
! value range
! comment
|-
| number
| 0..63
| Number of the cargo for bitmasks. Prior to {{ottd|1.9}} this was clamped to 0..31. This mostly affects old NewGRFs that don't have a cargo translation table.
|-
| type_name
| string
| String to use as cargo type name. Example: "Passengers". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_CARGO_PLURAL_XXX), which may be re-used.
|-
| unit_name
| string
| String to use for the name of one unit from the cargo type. Currently used for subsidies only (First Passenger service to..). Example string: "Passenger". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_CARGO_SINGULAR_XXX), which may be re-used.
|-
| units_of_cargo
| string
| String used to show the "short cargo" form for cargo units, e.g. "10 tonnes" or "20.000 litres". Example: "{COMMA} item{P "" s}". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_PASSENGERS and further), which may be re-used.
|-
| items_of_cargo
| string
| String used to show the "long cargo" form for cargo units, e.g. "10 tonnes of coal" or "20.000 litres of water". Example: "{COMMA} item{P "" s} of livestock". The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_QUANTITY_XXX), which may be re-used.
|-
| type_abbreviation
| string
| String used for the two-letter cargo type abbreviation. Must start with a {TINYFONT} string-code. Example: "{TINYFONT}XX". Make sure to avoid multiple cargos having the same abbreviation. The list of [[NML:Default_TTD_strings|default TTD strings]] contains the strings used by the default cargos (TTD_STR_ABBREV_XXX), which may be re-used.
|-
| sprite
| sprite
| TTD sprite number for the icon of the cargo. Alternatively, set to NEW_CARGO_SPRITE and use a graphics block to define a custom sprite.
|-
| weight
| float 0..255
| Weight of one unit of the cargo (in tons)
|-
| penalty_lowerbound
| 0..255
| Delivery time until penalty is applied. The units depend on the vehicle used (see vehicle property 'cargo_age_period'), by default 1 unit = 2.5 days.
|-
| single_penalty_length
| 0..255
| Length of the interval where a single penalty is applied
|-
| price_factor
| float
| Payment for delivering 10 units of cargo across a distance of 20 squares (in British Pounds), when delivering in less than 'penalty_lowerbound' time (no time penalty).
|-
| station_list_colour
| 0..255
|
Colour for the station list window (index from the [[NML:Graphic files|default (DOS) palette]])
|-
| cargo_payment_list_colour
| 0..255
|
Colour for the cargo payment list window (index from the [[NML:Graphic files|default (DOS) palette]])
|-
| is_freight
| 0 or 1
| Freight status (for the freighttrains switch); 0=not freight, 1=is freight
|-
| cargo_classes
|
bitmask([[#Cargo classes|cargo classes]])
| Cargo classes
|-
| cargo_label
| 4 letters
| [[CargoTypes|Cargo label]], as used in the [[NML:Cargotable|cargo table]]
|-
| town_growth_effect
| TOWNGROWTH_XXX
|
Effect for town growth, see [[#Cargo effects on town growth|Cargo effects on town growth]]
|-
| town_growth_multiplier
| float 0..255
| {{ottd|no}} Multiplier for town growth. To be used in conjuction with town_growth_effect, when that is not TOWNGROWTH_NONE. For example, a value of 4 makes your cargo have the same effect on town growth as 4 units of food/goods/etc.
|-
| callback_flags
| bitmask(flags)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| capacity_multiplier
| float 0 .. 255
| {{ottd|1.2|r22860}} This defines the capacity of vehicles carrying this cargo type, if the vehicle sets no specific capacity to this specific cargo type. Set this property to the amount of cargo a vehicle shall carry, which can carry 1 ton of coal or 1000 thousand litres of water (whatever comparison is more suitable for your cargotype). Depending on whether your cargo type is light or heavy you should set this property either comparing the weight or the volume. Default values are 4 for passengers, 2 for mail, goods and sweets and 1 for all other cargos.
|}

Cargo payment is computed from <code style="color:darkgreen">price_factor</code>, amount of cargo transported, distance, and a time delivery factor. Unit of the delivery time is 185 ticks, roughly 2.5 days. The factor is constant (with value 255) if delivery time is less than <code style="color:darkgreen">penalty_lowerbound</code>. It goes down with rate 1 between <code style="color:darkgreen">penalty_lowerbound + single_penalty_length</code>, and goes down with rate 2 if the delivery time is even longer. Time delivery factor is never less than 31.

===Cargo classes===

Available cargo classes are listed in the following table. Cargos may be in more than one class. Cargo classes are always used as a bitmask, use the built-in function <code>bitmask()</code>. For example, <code style="color:darkgreen">bitmask(CC_EXPRESS, CC_REFRIGERATED)</code> is used for food.

{| class="t"
! name
! type of cargo
|-
| CC_PASSENGERS
| passengers, also tourists (ECS)
|-
| CC_MAIL
| mail
|-
| CC_EXPRESS
| express goods, also tourists (ECS)
|-
| CC_ARMOURED
| valuables, diamonds, gold and alike
|-
| CC_BULK
| coal, ore, grain,...
|-
| CC_PIECE_GOODS
| containers, crates, livestock
|-
| CC_LIQUID
| oil, milk, water, ...
|-
| CC_REFRIGERATED
| food, milk, ...
|-
| CC_HAZARDOUS
| chemicals?, uranium, ...
|-
| CC_COVERED
| grain, cement, fruit, ...
|-
| CC_OVERSIZED
| vehicles, ...
|-
| CC_POWDERIZED
| cement, ...
|-
| CC_NON_POURABLE CC_NEO_BULK
| sugar cane, wool or straw bales, ...
|-
| CC_SPECIAL
| Special cargo, used for refit tricks. (e.g. regearing in NARS)
|-
| NO_CARGO_CLASS
| Special value that you can used to instead of 0.
|-
| ALL_NORMAL_CARGO_CLASSES
| Bitmask of all cargo classes except CC_SPECIAL. This is the same as <code style="color:darkgreen">bitmask(CC_PASSENGERS, CC_MAIL, ..., CC_OVERSIZED)</code>. Note: This is already a bitmask, don't use the <code style="color:darkgreen">bitmask(..)</code> function with this.
|-
| ALL_CARGO_CLASSES
| Bitmask of all cargo classes. Same as <code style="color:darkgreen">ALL_NORMAL_CARGO_CLASSES | bitmask(CC_SPECIAL)</code> Note: This is already a bitmask, don't use the <code style="color:darkgreen">bitmask(..)</code> function with this.
|}

===Cargo effects on town growth===

{| class="t"
! value
! effect
|-
| TOWNGROWTH_PASSENGERS
| Affect towns as passengers do
|-
| TOWNGROWTH_MAIL
| Affect towns as mail does
|-
| TOWNGROWTH_GOODS
| Affect towns as goods/candy does
|-
| TOWNGROWTH_WATER
| Affect towns as water does (second required cargo for towngrowth in the desert)
|-
| TOWNGROWTH_FOOD
| Affect towns as food/fizzy drinks do (first required cargo for towngrowth in desert/above snowline)
|-
| TOWNGROWTH_NONE
| Don't affect town growth (default)
|}

If no cargos in the game are defined as TOWNGROWTH_FOOD, towns above the snowline will not require food to grow. If no cargos in the game are defined as TOWNGROWTH_FOOD or TOWNGROWTH_WATER, towns in desert will not require food or water to grow. This can be used positively for gameplay purposes, and is otherwise worth being aware of as an unintended side effect when designing cargos.

There are some additional effects of these flags on subsidies and town cargo transport statistics. See the nfo docs for details: https://newgrf-specs.tt-wiki.net/wiki/Action0/Cargos#Substitute_type_and_multiplier_for_town_growth_.2818.2C_19.29

==Cargo variables==

Cargos have no variables (yet).

==Cargo callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite set (with 1 sprite)
| Graphics for the cargo icon (only if property <code style="color:darkgreen">sprite</code> is set to NEW_CARGO_SPRITE)
|-
| station_rating
| -16384 .. 16383
| See detailed explanation below
|-
| profit
| -12748 .. 12748
| Called whenever cargo is delivered.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 16):</code> The manhattan distance the cargo was transported.
* <code style="color:darkgreen">getbits(extra_callback_info2, 16, 8):</code> The amount of cargo delivered.
* <code style="color:darkgreen">getbits(extra_callback_info2, 24, 8):</code> The time spent en-route (1 unit = 2.5 days).
The returned value is multiplied by the amount and the <code style="color:darkgreen">price_factor</code> to determine the income the player receives. Returning negative values is possible, it makes players pay for the delivery.
|}

===Station rating callback===

The station rating callback is quite complicated and deserves some detailed explanation. The default station rating calculation works as follows:

Internally, station rating is byte with values 0 .. 255, representing respectively 0% and 100%. Every 2.5 days, the transportation 'performance' is calculated using some factors outlined below. The station rating is then set to this performance value, with the caveat that the rating change cannot exceed 2 points. Therefore, rating changes are always slow, this callback cannot change this. The initial rating is 175 points (69%). The following factors are parts of the performance, their effects are summed.

====Time since the cargo was last picked up====

{| class="t"
! Time units (days)
! Score (%, rounded)
|-
| >21 (>52.5 days)
| 0 (0%)
|-
| 13 .. 21 (32.5 days .. 52.5 days)
| 25 (10%)
|-
| 7 .. 12 (17.5 days .. 32.5 days)
| 50 (20%)
|-
| 4 .. 6 (10 days .. 17.5 days)
| 95 (37%)
|-
| 0..3 (0 days..10 days)
| 130 (51%)
|}

The time unit used equals 185 engine ticks, or 2.5 TTD days. For ships, the time units are divided by 4 before calculating this component, so ships have four times more time before the ratings start dropping.

====Amount of cargo waiting====

{| class="t"
! Amount of cargo
! Score (%, rounded)
|-
| >1500
| -90 (-35%)
|-
| 1001..1500
| -35 (-14%)
|-
| 601..1000
| 0 (0%)
|-
| 301..600
| 10 (4%)
|-
| 101..300
| 30 (12%)
|-
| 0..100
| 40 (16%)
|}

====Max. speed of the last vehicle picking up the cargo====

This calculation is somewhat complicated. The maximum speed of the vehicle is expressed in "speed units". For trains and road vehicles, the speed unit is 1 km/h; for ships, it's 0.5 km/h; for aircraft, it's 8 mph. If the max. speed is above 255 speed units, 255 is used instead. If the vehicle is slower than 85 units, no points are awarded; otherwise, you get (speed_units-85)/4 points. Therefore, the maximum you can get is 42 points, or 16%.

====Age of the last carrier picking up the cargo====

{| class="t"
! Age of vehicle (years)
! Score (%, rounded)
|-
| 2
| 10 (4%)
|-
| 1
| 20 (8%)
|-
| 0
| 33 (13%)
|}

In TTDPatch this changes when the 'newagerating' switch is enabled

====Bonus for AI companies (TTDPatch only)====

{| class="t"
! AI intelligence setting
! Score (%, rounded)
|-
| Low
| 0 (0%)
|-
| Medium
| 31 (12%)
|-
| High
| 63 (25%)
|}

====Bonus for statue in nearest town====

If your company has erected a statue in the nearest town, you get 26 points (10%) bonus to all cargo ratings.

====Callback parameters====

<ul><li>
<code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>:
{| |-
!value!!meaning
|-
|0x10||the last vehicle entering the station was a train
|-
|0x11||the last vehicle entering the station was a road vehicle
|-
|0x12||the last vehicle entering the station was a ship
|-
|0x13||the last vehicle entering the station was an aircraft
|-
|0||no vehicle entered the station yet, or (TTDPatch) the last one entering was sold
|}
Please note that there's only one "last vehicle type" field per station, so the vehicle this refers to may not have picked up any of your cargo.
</li><li>
<code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The time since the cargo was last picked up, in the time units described above (1 unit = 2.5 days independent of vehicle type)
</li><li>
<code style="color:darkgreen">getbits(extra_callback_info2, 8, 16)</code>: The amount of cargo waiting.
</li><li>
<code style="color:darkgreen">getbits(extra_callback_info2, 24, 8)</code>: The speed of the last vehicle picking the cargo up, in the speed units described above (if no vehicle entered the station yet, the value is 0xFF).
</li></ul>

====Effect of callback====

The return value of the callback replaces the first three components (time since pickup, amount of cargo, max speed) of the calculation. The bonus for statues, TTDPatch AIs and new vehicles is always in effect, you cannot (yet) change this.

Action0/Cargos

2021-11-16T15:56:54Z

Jgr: Clarify that property 19 only has an effect in TTDPatch, not in OpenTTD

== Introduction ==

The [[ttwiki:NewCargos|NewCargos]] switch of TTDPatch allows modifying the existing 12 cargos per climate, and allows adding 20 new cargos per climate as well. These cargo slots are numbered from 0 to 31, where slots 0-11 are used by default TTD cargos and slots 12-31 contain uninitialized garbage by default (so you can't trust them having meaningful information, you must set all of their properties).

{{ottdp|1.9|no|ottdrev=11ab3c4e}} OpenTTD 1.9 increases the number of cargos to 64.

== Properties ==

{| |-
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description
|-
|08||B||{{ottdp|0.6|2.5}}||Bit number for bitmasks
|-
|09||W||{{ottdp|0.6|2.5}}||TextID for the cargo type name
|-
|0A||W||{{ottdp|0.6|2.5}}||TextID for the name of one unit from the cargo type
|-
|0B||W||{{ottdp|0.6|2.5}}||TextID to be displayed for 1 unit of cargo
|-
|0C||W||{{ottdp|0.6|2.5}}||TextID to be displayed for multiple units of cargo
|-
|0D||W||{{ottdp|0.6|2.5}}||TextID for cargo type abbreviation
|-
|0E||W||{{ottdp|0.6|2.5}}||Sprite number for the icon of the cargo
|-
|0F||B||{{ottdp|0.6|2.5}}||Weight of one unit of the cargo
|-
|10,11||B||{{ottdp|0.6|2.5}}||Penalty times
|-
|12||D||{{ottdp|0.6|2.5}}||Base price
|-
|13||B||{{ottdp|0.6|2.5}}||Color for the station list window
|-
|14||B||{{ottdp|0.6|2.5}}||Color for the cargo payment list window
|-
|15||B||{{ottdp|0.6|2.5}}||Freight status (for freight-weight-multiplier setting); 0=not freight, 1=is freight
|-
|16||W||{{ottdp|0.6|2.5}}||Cargo classes
|-
|17||D||{{ottdp|0.6|2.5}}||Cargo label
|-
|18||B||{{ottdp|0.6|2.5|ttdprev=alpha 72}}||Substitute type for town growth
|-
|19||W||{{ottdp|no|2.5|ttdprev=alpha 72}}||Multiplier for town growth
|-
|1A||B||{{ottdp|0.6|2.5|ttdprev=alpha 72}}||Callback flags
|-
|1B||W||{{ottdp|1.1|no|ottdrev=r21224}}||TextID for displaying the units of a cargo
|-
|1C||W||{{ottdp|1.1|no|ottdrev=r21224}}||TextID for displaying the amount of cargo
|-
|1D||W||{{ottdp|1.2|no|ottdrev=r23860}}||Capacity mulitplier
|}

== Descriptions ==

=== Bit number for bitmasks (08) ===

This value must be used in [[Action3]] and in cargo bit mask properties such as refit masks. Values 1C-1F should be safe to use (if they aren't already taken, of course) if you intend to maintain compatibility with GRFs unaware of the newcargos switch. Further assuming that no active GRFs support the toyland climate, you can use values 11-1A as well.

Additionally, you can use the value FFh to disable the given cargo slot. This way, it won't appear in cargo type lists, but it won't be removed from things already on the map. If you disable a cargo, you'll probably want to zero out the cargo label (property 17) as well.

This property only affects GRFs which do not have a [[Action0/Global Settings#Cargo_translation_table_.2809.29 | cargo translation table]]. GRFs with such a table generally use the index of the cargo in the table instead of the value of this property to access a cargo. As such this property is more or less a default value for GRFs without cargo translation table. If you are unsure what value to assign to this property, set it to the same value as the cargo slot ID.

=== TextID for the cargo type name (09) ===

This textID should refer to the name of the cargo, capitalized, to match the TTD style (e.g. "Passengers", "Coal", "Gold Ore", "Milk")

You can reuse existing [[TextIDs]] or create custom strings using [[Action4]] with an offset in the DCxx range. Note that you need to set language-id bit 7 as well in the Action4 for a custom string. (Also applies to properties 0A to 0D)

=== TextID for one unit of the type (0A) ===

This textID should refer to the cargo type name in the singular. Currently, this ID is used only in subsidy messages ("First Passenger service..." instead of "First Passengers service...", for example)

=== TextID for 1 unit of cargo (0B) ===

This textID will be used to display the amount of the cargo if there's exactly 1 unit waiting. Although there's only one unit waiting, you'll still have to use either the special character 7C (print signed word) or 87 (print amount in litres and add suffix " litres") so TTD removes the amount from its internal reference stack. For example, if you have a new cargo named "gold ore", this should be "\7C ton of gold ore", which will expand to "1 ton of gold ore". On the other hand, a liquid cargo named "milk" should be something like "\87 of milk", which will expand to either "100 litres of milk" or "1,000 litres of milk" (The multiplier for liquid cargos depends on miscmods.dontfixlitres. If it's on, the multiplier is 100, otherwise it's 1000)

=== TextID for multiple units of cargo (0C) ===

This textID will be used to display the amount of cargo if the amount waiting isn't exactly 1. You'll need the same special characters as above, but now they will be expanded according to the actual cargo waiting. Sticking to the example above, you'll need "\7C tons of gold ore" and "\87 of milk", which can expand to "42 tons of gold ore" and "42,000 litres of milk", accordingly. You will note that liquid cargos can have the same textID for both property 0B and 0C since they always use the plural form.

=== TextID for cargo type abbreviation (0D) ===

This textID will be used in the station list window to represent the cargo waiting. It should be a two-letter abbreviation prefixed by the special character 0E to switch to the microscopic font. The microscopic font has every letter capitalized, so capitalization isn't important here. Continuing the above example, gold ore could have this as "GO" and milk as "MK" ("ML" is already taken by mail).

=== Sprite number for icon (0E) ===

This is a sprite number of an old TTD sprite to be displayed in the station window for this cargo, or FFFFh if the icon should be found by following the action 3 associated with this cargo. The icon must not be bigger than 10x10 pixels. One icon will be shown for every 10 units of the cargo waiting, up to 23 icons, which is the maximum.

=== Weight of one unit of the cargo (0F) ===

This property defines the weight of 1 unit from the cargo, which will be used to calculate the weight of the vehicles when loaded. The unit is 1/16 ton (which is 62.5 kg). With the examples above, gold ore should have this as 16 (since 1 ton of gold ore should weigh exactly 1 ton), while milk should have this slightly above 16 (milk is denser than water).

=== Penalty times and price factor (10,11,12) ===

These three values define how much is paid for the delivery of the cargo type. The price factor is subject to inflation, but GRFs needn't care about this, the programme will adjust the price for them.

The income generated from cargo delivery is calculated as:

income=((((distance/2) * timefactor * amount_moved) >> 7) * cargopricefactor) >> 13

where

; a >> b : means a is arithmetically shifted right by b bits
; distance : is the Manhattan distance between the two station signs
; amount_moved : is the number of cargo units moved
; cargopricefactor : is the value you set in property 12. Inflation will be applied automatically on it.
; timefactor : is a multiplier in the range 0..255, calculated in the following way: (T1 is the value of property 10, T2 is the value of property 11, t is the time the delivery took, the unit is 185 game ticks (roughly 2.5 game days) )

if t<=T1 then timefactor=255
else if t<=(T1+T2) then timefactor=255-(t-T1)
else timefactor=255-(t-T1)-(t-T1-T2)
if the above rules result in a timefactor less than 31, 31 is used instead.

=== Color for the station list window (13) ===

This color index will be used to draw the rectangle representing the amount waiting from the current cargo type in the station list window. The index should be given for the DOS palette. OpenTTD and TTDPatch will automatically translate the index for the Windows palette, if they use the windows base graphics.

=== Color for the cargo payment list window (14) ===

The graph of the current cargo will be drawn using this color in the cargo payment rates graph. The index should be given for the DOS palette, the Windows version of TTDPatch will automatically translate the index for the Windows palette.

=== CargoClasses (16) ===

See [[Action0Trains#Cargo classes .2828.2C_29.29|train prop. 28/29]] for a description of the utility of this property.

This is a bit mask of all cargo classes to which this cargo could belong.
The following classes are available:

{| class="wikitable
|-
!bit
!value
!class name
!wagon type<ref name=vehicle>Suggestion for vehicle types which transport this cargo</ref>
!usage<ref name=refitusage>Suggestion how to best make use of this class in the refit masks of vehicles OR to be included in the 'allowed classes' (train prop. 28), AND NOT in the 'disallowed classes' (train prop. 29)</ref>
!vehicle tips<ref name=vehicleuse>Suggestions this class should be used in the property which excludes a class of cargos from a vehicle. One specific type of cargo could appear both as liquid or as piece goods (e.g. milk), which depends on the actual representation. Thus excluding the other would disallow refit to that cargo.</ref>
!industry tips
|-
|0
|1
|Passengers
|passenger wagon
|OR
|never exclude
|do not combine with other flags
|-
|1
|2
|Mail
|closed or mail wagon
|OR
|never exclude
|do not combine with other flags
|-
|2
|4
|Express
|closed or mail wagon
|OR
|never exclude, suitable for airplane or maglev
|
|-
|3
|8
|Armored
|armored or mail wagon
|OR
|never exclude
|do not combine with other flags
|-
|4
|10
|Bulk (Uncountable)
|open or hopper wagon
|OR
|never exclude
|may be combined with Piece Goods or Liquid to simulate multiple modes of transport
|-
|5
|20
|Piece Goods (Countable)
|closed or open wagon
|OR
|never exclude
|may be combined with Bulk or Liquid to simulate multiple modes of transport
|-
|6
|40
|Liquid
|tank wagon
|OR
|never exclude
|may be combined with Piece Goods or Bulk to simulate multiple modes of transport
|-
|7
|80
|Refrigerated
|refrigerated wagon
|OR/AND NOT
|only exclude, when Piece Goods included
|also set Piece Goods
|-
|8
|100
|Hazardous
|unknown
|OR/AND NOT
|only exclude, when special wagons are provided.
|combine with Piece Goods, Liquid, Bulk or Express
|-
|9
|200
|Covered (weather protected)
|closed wagon, any other wagon with tarpaulin or weather cover
|OR/AND NOT
|do not exclude for Liquid
|combine with Piece Goods or Bulk
|-
|10
|400
|Oversized
|stake/flatbed wagon
|OR/AND NOT
|only exclude, when Piece Goods included
|combine with Piece Goods
|-
|11
|800
|Powderized (moist protected)
|powder/silo wagon
|OR/AND NOT
|only exclude, when Bulk included
|combine with Bulk
|-
|12
|1000
|Not Pourable
|open wagon, but not hopper wagon
|AND NOT
|only exclude, when Bulk included
|combine with Bulk
|-
|13
|2000
|reserved. No canonical specification
| -
| -
| -
| -
|-
|14
|4000
|reserved. No canonical specification
| -
| -
| -
| -
|-
|15
|8000
|special
|and not
|none
|special use
|do not set
|}

<references />

Only cargos which are in class 0 (passengers) will appear in bus stations. Only cargos which are ''not'' in class 0 will appear in truck stations.

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).

=== Cargo label (17) ===

Cargo labels are globally [[CargoTypes#Cargo Labels|unique identifiers]] for a cargo type. They are used to allow vehicle grfs to easily support many cargo types, whether they are active or not and no matter what slot or bit they are using.

Read about the [[Action0/Global Settings#Cargo translation table 09|cargo translation table]] for further info.

=== Substitute type and multiplier for town growth (18, 19) ===

These properties allow you to modify how a cargo type affects town growth. Property 18 can contain one of the following values:

{| |-
!Value!!Meaning!!{{ottdp|0.7|no}} Details<ref>This is the interpretation of OpenTTD. For TTDPatch see [http://www.tt-wiki.net/wiki/NewTownGrowthSwitches NewTownGrowthMechanism], which is quite different/unrelated.</ref>
|-
|00||Affect towns as passengers do||Cargo produced by houses is added to the statistics in the town GUI.
|-
|02||Affect towns as mail does||Cargo produced by houses is added to the statistics in the town GUI.
|-
|05||Affect towns as goods/candy does||See note about subsidies below.
|-
|09||Affect towns as water does||Second required cargo for towngrowth in the desert
|-
|0B||Affect towns as food/fizzy drinks do||First required cargo for towngrowth in desert/above snowline. Alse see note about subsidies below.
|-
|FF||Don't affect town growth (default)||
|}

<references />

{{ottdp|no|2.5|ttdprev=alpha 72}} The incoming cargo amount is multiplied by property 19, then divided by 256 before it is added to the town statistics. This allows you to have smaller or bigger impact than original cargoes do.

If no cargos in the game are defined as food (0B), towns above the snowline will not require food to grow. If no cargos in the game are defined as food (0B) or water (09), towns in desert will not require food or water to grow. This can be used positively for gameplay purposes, and is otherwise worth being aware of as an unintended side effect when designing cargos.

Please note that cargoes accepted by industries affect the closest town as well; for example, if you have an industry that accepts passengers, every passenger brought to the industry affects the town just like if they were transported to the town directly. Usually, it's not a good idea to have industries that process such cargoes; they should be accepted by towns only.

{{ottdp|0.6-1.1|no}} In OpenTTD up to 1.1 (not 1.2) property 18 also affects the creation of subsidies. Usually subsidies apply to cargo transportation between two industries. For cargos with substitution-type 05 or 0B the destination will be a town instead. Independent of property 18 subsidies from town to town are only created for cargo slot 0 (Passengers).

=== Callback flags (1A) ===

{| |-
!Bit!!Value!!Var. 0C!!Callback
|-
|0||1||39||Custom profit calculation
|-
|1||2||145||Custom station rating calculation
|}

=== TextID for displaying the units of a cargo (1B) ===

This textID is used by OpenTTD to show the "short cargo" form for cargo units, e.g. "10 litres" or "10 tonnes". This textID must be set after property 0B. The text this textID refers to should properly handle plurals, e.g. "\7B item\9A\15\80\9A\10\9A\11s\9A\12".

The default for this textID depends on the default for property 0B; if the default 0B string has "litre", then the default for this textID will be the unit for litres. OpenTTD maps the following textIDs so you don't need to provide translations:

{| |-
!textID!!String
|-
|004f||<num> passenger(s)
|-
|0050||<num> tonne(s)
|-
|0051||<num> bag(s)
|-
|0052||<num> litre(s)
|-
|0053||<num> item(s)
|-
|0054||<num> crate(s)
|}

The "tonne" and "litre" strings (textID 0050 and 0052) are automatically updated based on the user settings of unit display, e.g. they "tonne" might become "kg". The "(s)" is for display purposes; in reality that is a choice list.

=== TextID for displaying the amount of cargo (1C) ===

This textID is used by OpenTTD to show the "long cargo" form for cargo units, e.g. "10 litres of water" or "10 tonnes of coal". This textID must be set after property 0c. The text this textID refers to should properly handle plurals, e.g. "\7B item\9A\15\80\9A\10\9A\11s\9A\12 of livestock".

The default for this textID depends on the default for property 0C, but with support for plurals. For "X litre(s)" or "X tonne(s)" you should respectively use string codes 87 and 9A 0D.

=== Capacity multiplier (1D) ===

This defines the capacity (and indirectly loading speed) of vehicles carrying this cargo type, if the vehicle sets no specific capacity to this specific cargo type.

Set this property to the amount of cargo a vehicle shall carry, which can carry 0x100 (256) tons of coal or 0x100 (256) thousand litres of water (whatever comparison is more suitable for your cargotype). Depending on whether your cargo type is light or heavy you should set this property either comparing the weight or the volume.

The default value of this property is:
{| |-
! Cargo slot !! Default cargo in this slot !! Property 1D !! Meaning
|-
| 00 || PASS || 0x400 || A vehicle carrying 1 ton of coal, can carry 4 passengers.
|-
| 02 || MAIL || 0x200 || A vehicle carrying 1 ton of coal, can carry 2 bags of mail.
|-
| 05 || GOOD, SWET || 0x200 || A vehicle carrying 1 ton of coal, can carry 2 crates of goods/sweets.
|-
| xx || (everything else) || 0x100 || All other slots default to 0x100, i.e. 1 unit of cargo equals 1 ton of coal.
|}

== Example ==

VariationalAction2/Vehicles

2021-09-01T18:37:15Z

Jgr: Position within articulated vehicle section was labelled with incorrect variable number 4B, instead of 4D

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

==Introduction==

== Variables ==

{|
!Variable!![[GRFActionsDetailed|Size]]!!Version!!Description!!Available in purchase list
|-
|10||D||{{ottdp|1.2|no|ottdrev=r23080}}||Pick sprites for different GUI windows - See [[Action2/Vehicles]].||{{ottdp|1.2|no|ottdrev=r23080}}
|-
|40||D||{{ottdp|0.6|2.5}}||Position in consist and length of consist||no
|-
|41||D||{{ottdp|0.6|2.5}}||Position in and length of chain of consecutive vehicles with same ID||no
|-
|42||D||{{ottdp|0.6|2.5}}||Cargo types transported by consist||no
|-
|43||D||{{ottdp|0.6|2.5}}||Player info||{{ottdp|0.6|2.5|ottdrev=r4611|ttdprev=beta 2}}
|-
|44||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 48}}||Aircraft info||no
|-
|45||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 58}}||Curvature info||no
|-
|46||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 59}}||Motion counter||no
|-
|47||D||{{ottdp|0.6|2.5}}||Vehicle cargo info||{{ottdp|0.7|no|ottdrev=r15542}} <ref name="var47">Variable 47 refers to the default cargo of the vehicle, when in purchase list. This differs from the cargo used in Action 3, which is 0xFF in purchase list. The "refit cycle" (F2) is currently always zero in the purchase list.</ref>
|-
|48||D||{{ottdp|0.6|2.5}}||Vehicle type information||{{ottdp|0.6|2.5|ottdrev=r5338|ttdprev=beta 2}}
|-
|49||D||{{ottdp|0.7|2.6|ottdrev=r13376|ttdprev=r2216}}||Year of construction (long format, 0 based)||{{ottdp|0.7|no|ottdrev=r13376}} <ref name="date">This is the current date</ref>
|-
|4A||D||{{ottdp|1.1|no|ottdrev=r20165}}||Info about current railtype/roadtype/tramtype||no
|-
|4B||D||{{ottdp|1.2|no|ottdrev=r23068}}||Long date of last servicing||{{ottdp|1.2|no|ottdrev=r23068}} <ref name="date" />
|-
|4C||D||{{ottdp|1.3|no|ottdrev=r24246}}||Current max speed including e.g track or timetable speed limits. Only valid for front vehicle. Note, units differ for each vehicle type<ref name="speed">See [[Action0Trains#Speed 09|train property 09]], [[Action0RoadVehicles|road vehicle property 08]] (not 15, even when using realistic acceleration), [[Action0Ships|ship property 0B]] and [[Action0Planes|aircraft property 0C]].</ref>||no
|-
|4D||D||{{ottdp|1.4|no|ottdrev=r26157}}||Position within articulated vehicle||no
|-
|60||D||{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 57}}||Count Veh.ID occurence||no
|-
|61||-<ref>The size of the result matches the size of the queried variable.</ref>||{{ottdp|1.2|no|ottdrev=r22997}}||Query variable of n-th vehicle in chain||no
|-
|62||D||{{ottdp|1.2|no|ottdrev=r22998}}||Curvature/position difference for n-th vehicle in chain||no
|-
|63||D||{{ottdp|1.11|no|ottdrev=g868d84bbf}}||Test track-type of tile against another track-type||no
|-
|97||B||{{ottdp|0.6|2.0}}||Tick counter, increased every engine tick||no
|-
|B2||W||||Vehicle status: bit0 = vehicle invisible (in tunnel/depot), bit1 = stopped, bit7 = crashed||no
|-
|B4||W||{{ottdp|0.6|2.0}}||Current speed. Note, units differ for each vehicle type<ref name="speed" />||no
|-
|B9||B||{{ottdp|0.6|2.0}}||Cargo type (type B from the list at [[CargoTypes]]; climate dependent)||no
|-
|C0||W||{{ottdp|0.6|2.0}}||Engine age in days {{ottdp|1.2|2.5|ottdrev=r22816|ttdprev=alpha 61}} Valid for wagons and articulated parts as well.||no
|-
|C4||B||{{ottdp|0.6|2.0}}||Year built (counted from 1920), note this is modified when Cht: Year is used||{{ottdp|0.6|no|ottdrev=r4611}} <ref name="date" />
|-
|C6||W||{{ottdp|0.6|2.0}}||Vehicle type ID <ref>{{ottdp|0.7|no}} In OpenTTD 0.7 and newer this is the GRF-local ID of the vehicle. Earlier versions of OpenTTD and TTDPatch report the [[VehicleIDs|TTD ID]]. For trains this is the same; for other vehicle types they differ.</ref> (useful for [[Callbacks#Can wagon be attached (1D)|Callback 1D]])||no
|-
|C8||B||{{ottdp|0.6|2.0}}||Sprite type; FD for trains forward, FE or FF when reversed||no
|-
|C9||B||{{ottdp|0.6|2.0}}||Day counter; increased daily||no
|-
|DA||W||{{ottdp|0.6|2.0}}||Next wagon index, FFFF if last wagon (use shift-num=08 and check for FF)||no
|-
|F2||B||{{ottdp|0.6|2.5}}||Refit cycle, how many times refitted to the same cargo type||{{ottdp|0.7|no|ottdrev=r15542}} <ref name="var47" />
|-
|FE||W||{{ottdp|0.6|2.5}}||Modflags||no
|-
|FF||B||{{ottdp|0.6|2.5}}||Modflags||no
|}

<references />

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

Variables 40, 41, 42 and 43 are cached. This means that while they are in principle computationally expensive, they can be used without impacting performance. Variables 45 and 60 are also computationally expensive but cannot be cached, and should therefore be used sparingly. If possible 80+x variables are to be preferred.

Cached variables are updated when the game is loaded, when the consist enters or is rearranged in a depot, and when the train reverses.

In the purchase list only a few variables are available. Especially the front vehicle (related object) cannot be accessed, nor other articulated parts.

== Description ==
=== Position and length (40, 41) ===

'''Format:''' 00nnbbff

{| |-
!Variable!!Value
|-
|ff||position of vehicle within the consist counted from the engine (front), e.g. the engine would have ff=0, the 1st wagon or mail compartment of planes would have ff=1, the 2nd wagon or the rotor of helicopters would have ff=2, the 3rd wagon would have ff=3 etc
|-
|bb||same as ff, but counted from the end, i.e. the last wagon has bb=0, the next-to-last wagon has bb=1 etc.
|-
|nn||Total number of vehicles in the consist, including shadow and rotor for aircraft.
* In var 40 this is zero-based. That is, the value returned is one less than the actual number of vehicles. A train with engine and three wagons has nn=3.
* In var 41 this is one-based. That is, the value returned is the actual number of vehicles.
|}

For variable 40, these numbers refer to the whole consist, but for variable 41, they only refer to the chain of consecutive vehicles with the same ID as the current wagon (including itself, but possibly excluding the engine):

[[File:vehicle_var40_41.png]]

Note however, that accessing the "related" object (i.e. the locomotive) doesn´t make much sense for vars 40/41, except for var40 when in a [[Callbacks#Can wagon be attached 1D|callback 1D]] chain.

=== Consist cargo (42) ===

'''Format:''' uuiicctt

{| |-
!Variable!!Value
|-
|tt||a bit mask of all [[Action0Cargos#Cargo classes 16|cargo classes]] transported by the consist
|-
|cc||the most common [[CargoTypes|cargo type]] (from the column for type A)
|-
|ii||the most common refit cycle (var. F2) of cargo type cc
|-
|uu||the result of ORing the bits of prop. 25 from all vehicles in the train
|}

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

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

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

=== Player info (43) ===

'''Format:''' Ccttmmnn

{| |-
!Variable!!Value
|-
|nn||the number of the current player from 0 to 7 (up to E (14) in OpenTTD since r14735)
|-
|mm||the multiplayer player number with the host player (or the single player) being 0 and the client player being 1
|-
|tt||the player type, see below for possible values
|-
|c||the primary player colour
|-
|C||{{ottdp|0.6|2.5|ttdprev=r1405}} the secondary player colour, equal to c if none (since r1405)
|}

{| |-
!tt value!!Meaning
|-
|0||Player is human player (permanent company)
|-
|1||Player is AI player (not managed)
|-
|2||{{ottdp|no|2.5}} Player is a human managing an AI company
|-
|3||{{ottdp|no|2.5}} Player is human player's original company, now temporarily AI controlled
|}

{{ottdp|0.6|2.5|ttdprev=r1497}} Since r1497, when the vehicle sprite is being displayed in an exclusive offer window or new vehicle news message, or in other circumstances when no player is associated with the vehicle, nn will be FF.

=== Aircraft info (44) ===

'''Format:''' xxxxhhtt

hh is the height of the aircraft above ground, or more properly above the height of its shadow. Buildings, including the heliport, don't count as "ground", i.e. to get the height above a heliport, you have to subtract the heliport height from hh.

tt is the type of the current airport: 0=small, 1=large, 2=heliport, 3=oil rig. The current airport is the target airport for aircraft that have finished the ascent and are in flight.

=== Curvature info (45) ===

'''Format:''' xxxTxBxF

This returns the amount of curvature between the adjacent wagon pairs. It is useful for train vehicles that normally tilt in curves. The curvature is the difference in direction between the surrounding vehicles:

F = for the front pair (previous wagon to current wagon, 0 if vehicle is first)

B = for the back pair (current wagon to next wagon, 0 if wagon is last)

T = for the triplet (previous wagon to next wagon; is zero in an S-bend)

Possible values:

{| |-
!Decimal!!Hex!!Meaning
|-
| -4||C||180° curve left (T only)
|-
| -3||D||135° curve left (T only)
|-
| -2||E||90° curve left
|-
| -1||F||45° curve left
|-
|0||0||no curve
|-
|1||1||45° curve right
|-
|2||2||90° curve right
|-
|3||3||135° curve right (T only)
|-
|4||4||180° curve right (T only)
|}

=== Motion counter (46) ===

'''Format:''' 32-bit value

This variable counts the amount of motion that a vehicle has done.  It is only valid for the first vehicle in a consist (i.e. use VarAction2 type 82!).  Its value is in units of 1/4096 of a tile.  A vehicle actually moves visibly every time the motion counter increases by 256, and since a tile consists of 16 such subunits, 16*256=4096 motion units mean motion across one tile.

The most useful way to access it is probably with <shiftnum>=08 and an appropriate <andmask>.  For example, to achieve an animation with one frame per vehicle motion and 16 frames in total for motion across an entire tile, you would use <shiftnum>=08 and <andmask>=0F.  For an animation with one frame every two vehicle motions and 4 frames total, use <shiftnum>=09 and <andmask>=03.

If the vehicle is going very fast (>160 mph for trains), it may move by several 1/16ths of a tile at once, and thus some frames may be skipped, but the animation will still remain in sync with the motion.

Note that vehicle graphics are only updated every time the vehicle actually moves, so checking the lower byte is probably pointless, and only needed internally to achieve sufficient precision.

=== Vehicle cargo info (47) ===

'''Format:''' ccccwwtt

{| |-
!Variable!!Value
|-
|tt||the [[CargoTypes|cargo type]] transported by the vehicle (from the column for type A); translated if a translation table has been installed
|-
|ww||cargo unit weight in 1/16 tons, same as [[Action0Cargos#Weight of one unit of the cargo 0F|cargo prop. 0F]]
|-
|cccc||the [[Action0Cargos#Cargo classes 16|cargo class]] value of the cargo transported by the vehicle
|}

Note that if the grf has installed a [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]], the value in "tt" is the slot number in that table, irrespective of which actual slot or bit the cargo is using in the game. If a table has been installed, but the current cargo is not listed there, "tt" will be set to FF.

Unlike variable 42, this variable returns the info of the current vehicle only, not the consist.

=== Vehicle type information (48) ===

'''Format:''' xxxxxxff

The bits of ff are:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||Vehicle type is available on the market
|-
|1||2||Vehicle type is in the testing phase
|-
|2||4||Exclusive testing offer for a human player active
|}

All other bits in ff are undefined and must be masked out.

=== Information about current railtype/roadtype/tramtype (4A) ===

'''Format:''' xxxxFFrr

The lower byte (rr) contains the (translated) railtype/roadtype/tramtype the vehicle is currently driving on.
If the railtype/roadtype/tramtype has no entry in the railtype/roadtype/tramtype translation table of the GRF, this value will be 0xFF.
If no translation table is present, the raw value will be returned.
Note: only exact matches of rail-/road-/-tram-types are reported. If the translation table of the GRF does not contain the exact track-type 0xFF is returned, even if the translation table contains equivalent track-types (according to rail-/road-/tram-type property 1D). Use variable 63 to test for compatibility/poweredness/equivalency with track-types known to both the vehicle and the track-type NewGRF.

The variable only reports about the tracks the vehicle is using: on a level crossing with rail, road and tram tracks, the vehicle (train, road vehicle, tram) can only query the track type it belongs to.

The second byte (FF) contains the following flags:

{| |-
!Bit!!Value!!Meaning
|-
|0||1||The vehicle is/would be powered on the current railtype (this is independent from powered/non-powered wagon or anything)
|-
|1||2||{{ottdp|1.11|no|ottdrev=gf1bc4d840}} Set, if the track-type has catenary. This is independent of the vehicle: a NewGRF can define an engine as powered on non-electrified track (bit 0), and show a raised pantograph (bit 1) to look like a dual-powered engine. This bit is a simplified as it only checks for "some catenary". To distinguish different types of catenaries, AC and DC voltages, ... use variable 63 instead.
|}

All other bits are reserved, and must be masked.

All other bytes are reserved, and must be masked.

=== Position within articulated vehicle (4D) ===

'''Format:''' xxxxbbff

{| |-
!Variable!!Value
|-
|ff||Position of vehicle (articulated part) within the articulated vehicle, counted from the first part, starting with 0.
|-
|bb||Position of vehicle (articulated part) within the articulated vehicle, counted from the last part, starting with 0.
|-
|xx||Reserved, do not access.
|}

The total number of articulated parts of a vehicle equals ff + 1 + bb.

For road vehicles "ff" and "bb" currently equal var 40, since there are no road vehicle wagons yet.

=== Count Veh.ID occurence (60) ===

'''Format:''' xxxxxxnn

The 60+x parameter is the vehicle ID to look for, and the returned nn is the number of vehicles in the consist that have this ID. If used with VarAction2 type 81, only the current vehicle and onwards will be check, with VarAction2 type 82, all vehicles in the consist will be counted.

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

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

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

The 60+x parameter specifies the variable to access and temporary register 10E is passed as the new 60+x parameter. Passing 61 as the variable is not allowed. Currently only vehicle specific variables listed on this page plus global variable 25 and {{ottdp|1.3|no|ottdrev=r24527}} 5F are accessible through var 61.

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

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

'''Format:''' zzyyxxFD

This variable is only supported for trains and road vehicles.

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

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

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

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

=== Track-type test against another track-type (63) ===

{{ottdp|1.11|no|ottdrev=g868d84bbf}}

'''Format:''' xxxxxxFF

This variable is only supported for trains and road vehicles.

The 60+x parameter is an index into the rail-/road-/tram-type translation table.
The result value reports how vehicles of this type would behave on the current tile.
This allows vehicles to behave or look differently on various track-types independent of their own track-type.

The lower byte (FF) contains some flags:
{|
|-
!Bit!!Value!!Meaning
|-
|0||1||The track-type from the 60+x parameter is known. If unset, all other flags are unset as well, no information can be given.
|-
|1||2||Vehicles with type from the 60+x parameter are compatible with the track on the current tile.
|-
|2||4||Vehicles with type from the 60+x parameter are powered on the track of the current tile.
|-
|3||8||The track-type from the 60+x parameter is identical or equivalent (listed as alternate label in rail-/road-/tram-type property 1D) to the track-type of the current tile.
|}

The remaining bytes are reserved, and must be masked.

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

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

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

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

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

==Examples==

TextIDs

2007-07-12T11:40:51Z

Jgr:

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

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

{maketoc}

=0000 General strings=

0000 \94Cannot remove obstacles on land

0001 \94Off edge of map

0002 \94Too close to edge of map

0003 \94Not enough cash - requires \7f

0004 \94\7f

0005 \8b\7f

0006

0007 \94Flat land required

0008 \98Waiting: \94\80

0009 \94\80

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

000B \90\80)

000C \98Accepts: \94

000D \98Accepts: \8a

000E

000F Passengers

0010 Coal

0011 Mail

0012 Oil

0013 Livestock

0014 Goods

0015 Grain

0016 Wood

0017 Iron Ore

0018 Steel

0019 Valuables

001A Copper Ore

001B Maize

001C Fruit

001D Diamonds

001E Food

001F Paper

0020 Gold

0021 Water

0022 Wheat

0023 Rubber

0024 Sugar

0025 Toys

0026 Sweets

0027 Cola

0028 Candyfloss

0029 Bubbles

002A Toffee

002B Batteries

002C Plastic

002D Fizzy Drinks

002E

002F Passenger

0030 Coal

0031 Mail

0032 Oil

0033 Livestock

0034 Goods

0035 Grain

0036 Wood

0037 Iron Ore

0038 Steel

0039 Valuables

003A Copper Ore

003B Maize

003C Fruit

003D Diamond

003E Food

003F Paper

0040 Gold

0041 Water

0042 Wheat

0043 Rubber

0044 Sugar

0045 Toy

0046 Sweet

0047 Cola

0048 Candyfloss

0049 Bubble

004A Toffee

004B Battery

004C Plastic

004D Fizzy Drink

004E

004F | passenger

0050 | tonne of coal

0051 | bag of mail

0052 \87 of oil

0053 | item of livestock

0054 | crate of goods

0055 | tonne of grain

0056 | tonne of wood

0057 | tonne of iron ore

0058 | tonne of steel

0059 | bag of valuables

005A | tonne of copper ore

005B | tonne of maize

005C | tonne of fruit

005D | bag of diamonds

005E | tonne of food

005F | tonne of paper

0060 | bag of gold

0061 \87 of water

0062 | tonne of wheat

0063 \87 of rubber

0064 | tonne of sugar

0065 | toy

0066 | bag of sweets

0067 \87 of cola

0068 | tonne of candyfloss

0069 | bubble

006A | tonne of toffee

006B | battery

006C \87 of plastic

006D | fizzy drink

006E

006F | passengers

0070 | tonnes of coal

0071 | bags of mail

0072 \87 of oil

0073 | items of livestock

0074 | crates of goods

0075 | tonnes of grain

0076 | tonnes of wood

0077 | tonnes of iron ore

0078 | tonnes of steel

0079 | bags of valuables

007A | tonnes of copper ore

007B | tonnes of maize

007C | tonnes of fruit

007D | bags of diamonds

007E | tonnes of food

007F | tonnes of paper

0080 | bags of gold

0081 \87 of water

0082 | tonnes of wheat

0083 \87 of rubber

0084 | tonnes of sugar

0085 | toys

0086 | bags of sweets

0087 \87 of cola

0088 | tonnes of candyfloss

0089 | bubbles

008A | tonnes of toffee

008B | batteries

008C \87 of plastic

008D | fizzy drinks

008E

008F \0ePS

0090 \0eCL

0091 \0eML

0092 \0eOL

0093 \0eLV

0094 \0eGD

0095 \0eGR

0096 \0eWD

0097 \0eOR

0098 \0eST

0099 \0eVL

009A \0eCO

009B \0eMZ

009C \0eFT

009D \0eDM

009E \0eFD

009F \0ePR

00A0 \0eGD

00A1 \0eWR

00A2 \0eWH

00A3 \0eRB

00A4 \0eSG

00A5 \0eTY

00A6 \0eSW

00A7 \0eCL

00A8 \0eCF

00A9 \0eBU

00AA \0eTF

00AB \0eBA

00AC \0ePL

00AD \0eFZ

00AE \94\83

00AF \94\82

00B0 \94Map - \80

00B1 \94Game Options

00B2 \90Message

00B3 \90Message from \80

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

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

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

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

00B8 \98Designed & Programmed by Chris Sawyer

00B9 \98Graphics by Simon Foster

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

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

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

00BD \98Processor: 80}86

00BE \98Graphics:

00BF VESA (

00C0 ATI

00C1 Trident

00C2 Oak Technologies

00C3 Tseng Labs

00C4 Paradise

00C5 \98\ad

00C6 \89\ad

00C7 \94Quit to DOS

00C8 \98Yes

00C9 \98No

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

00CB \981

00CC \982

00CD \983

00CE \984

00CF \985

00D0 Nothing

00D1 Dark Blue

00D2 Pale Green

00D3 Pink

00D4 Yellow

00D5 Red

00D6 Light Blue

00D7 Green

00D8 Dark Green

00D9 Blue

00DA Cream

00DB Mauve

00DC Purple

00DD Orange

00DE Brown

00DF Grey

00E0 White

00E1 \94Too many vehicles in game

00E2 \98|

00E3 \8b|

00E4 \98Location

00E5 Contours

00E6 Vehicles

00E7 Industries

00E8 Routes

00E9 Vegetation

00EA Owners

00EB \98\0eRoads

00EC \98\0eRailways

00ED \98\0eStations/Airports/Docks

00EE \98\0eBuildings/Industries

00EF \98\0eVehicles

00F0 \98\0e100m

00F1 \98\0e200m

00F2 \98\0e300m

00F3 \98\0e400m

00F4 \98\0e500m

00F5 \98\0eTrains

00F6 \98\0eRoad Vehicles

00F7 \98\0eShips

00F8 \98\0eAircraft

00F9 \98\0eTransport Routes

00FA \98\0eCoal Mine

00FB \98\0ePower Station

00FC \98\0eForest

00FD \98\0eSawmill

00FE \98\0eOil Refinery

00FF \98\0eFarm

0100 \98\0eFactory

0101 \98\0ePrinting Works

0102 \98\0eOil Wells

0103 \98\0eIron Ore Mine

0104 \98\0eSteel Mill

0105 \98\0eBank

0106 \98\0ePaper Mill

0107 \98\0eGold Mine

0108 \98\0eFood Processing Plant

0109 \98\0eDiamond Mine

010A \98\0eCopper Ore Mine

010B \98\0eFruit Plantation

010C \98\0eRubber Plantation

010D \98\0eWater Supply

010E \98\0eWater Tower

010F \98\0eLumber Mill

0110 \98\0eCandyfloss Forest

0111 \98\0eSweet Factory

0112 \98\0eBattery Farm

0113 \98\0eCola Wells

0114 \98\0eToy Shop

0115 \98\0eToy Factory

0116 \98\0ePlastic Fountains

0117 \98\0eFizzy Drink Factory

0118 \98\0eBubble Generator

0119 \98\0eToffee Quarry

011A \98\0eSugar Mine

011B \98\0eRailway Station

011C \98\0eLorry Loading Bay

011D \98\0eBus Station

011E \98\0eAirport/Heliport

011F \98\0eDock

0120 \98\0eRough Land

0121 \98\0eGrass Land

0122 \98\0eBare Land

0123 \98\0eFields

0124 \98\0eTrees

0125 \98\0eRocks

0126 \98\0eWater

0127 \98\0eNo Owner

0128 \98\0eTowns

0129 \98\0eIndustries

012A \98\0eDesert

012B \98\0eSnow

012C \94Message

012D \94\80

012E \98Cancel

012F \98OK

0130 \98Rename

0131 \94Too many names defined

0132 \94Chosen name in use already

0133 Pounds (\a3)

0134 Dollars ($)

0135 Franc (FF)

0136 Deutschmark (DM)

0137 Yen (\a5)

0138 Peseta (Pt)

0139 Imperial (miles)

013A Metric (kilometres)

013B \94...owned by \80

013C \98Cargo

013D \98Information

013E \98Capacities

013F \98Capacity: \95\80

0140 \98New Game

0141 \98Load Game

0142 \98Tutorial / Demonstration

0143 \981 Player

0144 \982 Players

0145 \942 Player Link Setup

0146 \98Attempt Connection

0147 \94Unable to make connection to remote computer

0148 \98Game Options

014A

014B  XMS

014C  VCPI

014D  DPMI

014E  Windows

014F  OS/2

0150 someone\85\85

0151 Map of world

0152 Town directory

0153 Subsidies

0154 Operating profit graph

0155 Income graph

0156 Delivered cargo graph

0157 Performance history graph

0158 Company value graph

0159 Cargo payment rates

015A Company league table

015B \94Transport Tycoon (Deluxe)

015C Save game

015D Abandon game

015E

015F Quit to DOS

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

0161 \94Abandon Game

0162 Jan

0163 Feb

0164 Mar

0165 Apr

0166 May

0167 Jun

0168 Jul

0169 Aug

016A Sep

016B Oct

016C Nov

016D Dec

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

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

0170 \0e\80-

0171 \98Pause game

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

0173 \98Display list of company's stations

0174 \98Display map

0175 \98Display map,town directory

0176 \98Display town directory

0177 \98Display company finances information

0178 \98Display company general information

0179 \98Display graphs

017A \98Display company league table

017B \98Display list of company's trains

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

017D \98Display list of company's ships

017E \98Display list of company's aircraft

017F \98Zoom the view in

0180 \98Zoom the view out

0181 \98Build railway track

0182 \98Build roads

0183 \98Build ship docks

0184 \98Build airports

0185 \98Plant trees,place signs etc.

0186 \98Query land block

0187 \98Options

0188 \98\bc

0189 \98\bd

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

018B \98Close window

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

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

018E \98Lower a corner of land

018F \98Raise a corner of land

0190 \98Scroll bar - scrolls list up/down

0191 \98Show land contours on map

0192 \98Show vehicles on map

0193 \98Show industries on map

0194 \98Show transport routes on map

0195 \98Show vegetation on map

0196 \98Show land owners on map

0197 \98Toggle town names on/off on map

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

0199 | year (|)

019A | years (|)

019B \8b| years (|)

019C Road vehicle

019D Aircraft

019E Ship

019F Train

01A0 \94\80 | is getting old

01A1 \94\80 | is getting very old

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

01A3 \94Land Area Information

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

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

01A6 N/A

01A7 \98Owner: \95\80

01A8 \98Local authority: \95\80

01A9 None

01AA \98Name

01AB \98\0e\80

01AC 1st

01AD 2nd

01AE 3rd

01AF 4th

01B0 5th

01B1 6th

01B2 7th

01B3 8th

01B4 9th

01B5 10th

01B6 11th

01B7 12th

01B8 13th

01B9 14th

01BA 15th

01BB 16th

01BC 17th

01BD 18th

01BE 19th

01BF 20th

01C0 21st

01C1 22nd

01C2 23rd

01C3 24th

01C4 25th

01C5 26th

01C6 27th

01C7 28th

01C8 29th

01C9 30th

01CA 31st

01CB \0e|

01CC \98Toggle large/small map size

01CD \94Select Tutorial/Demonstration

01CE \98Cargo accepted: \95\80

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

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

01D1 (}/8 \80)

01D2 \94Jazz Jukebox

01D3 Sound/music

01D4 \98Show sound/music window

01D5 \0eAll

01D6 \0eOld Style

01D7 \0eNew Style

01D8 \0eEzy Street

01D9 \0eCustom 1

01DA \0eCustom 2

01DB \98\0eMusic Volume

01DC \98\0eEffects Volume

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

01DE \98Skip to previous track in selection

01DF \98Skip to next track in selection

01E0 \98Stop playing music

01E1 \98Start playing music

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

01E3 \91\0e--

01E4 \91\0e0}

01E5 \91\0e}

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

01E7 \91\0e"\80"

01E8 \98\0eTrack\01XTitle

01E9 \0eShuffle

01EA \0e\98Program

01EB \94Music Program Selection

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

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

01EE \0e\98Track Index

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

01F0 \0e\98Clear

01F1 \0e\98Save

01F2 \98Current program of music tracks

01F3 \98Select 'all tracks' program

01F4 \98Select 'old style music' program

01F5 \98Select 'new style music' program

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

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

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

01F9 \98Save music settings to disk

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

01FB \98Toggle program shuffle on/off

01FC \98Show music track selection window

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

01FE \98Difficulty (\80)

01FF \0e\98\82

0200 Last message/news report

0201 Message settings

0202 Send message

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

0204 \94Message Options

0205 \98Message types:-

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

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

0208 \90Accidents / disasters

0209 \90Company information

020A \90Economy changes

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

020C \90New vehicles

020D \90Changes of cargo acceptance

020E \90Subsidies

020F \90General information

0210 \94...too far from previous destination

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

0212 \0f|.

0213 Businessman

0214 Entrepreneur

0215 Industrialist

0216 Capitalist

0217 Magnate

0218 Mogul

0219 Tycoon of the Century

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

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

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

021D \98

021E \94

021F \88|

0220 \98Create Scenario

0221 \90Transport Tycoon

0222 \90Scenario Editor

0223 \94Land Generation

0224 \98\a0

0225 \98\aa

0226 \98Random Land

0227 \98Reset Land

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

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

022A \98Generate random land

022B \98Reset landscape

022C \94Reset Landscape

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

022E \98Landscape generation

022F \98Town generation

0230 \98Industry generation

0231 \98Road construction

0232 \98Vegetation and other objects

0233 \94Town Generation

0234 \98New Town

0235 \98Construct new town

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

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

0238 \94...too close to another town

0239 \94...site unsuitable

023A \94...too many towns

023B \98Increase size of town

023C \98Expand

023D \98Random Town

023E \98Build town in random location

023F \94Industry Generation

0240 \98Coal Mine

0241 \98Power Station

0242 \98Sawmill

0243 \98Forest

0244 \98Oil Refinery

0245 \98Oil Rig

0246 \98Factory

0247 \98Steel Mill

0248 \98Farm

0249 \98Iron Ore Mine

024A \98Oil Wells

024B \98Bank

024C \98Paper Mill

024D \98Food Processing Plant

024E \98Printing Works

024F \98Gold Mine

0250 \98Lumber Mill

0251 \98Fruit Plantation

0252 \98Rubber Plantation

0253 \98Water Supply

0254 \98Water Tower

0255 \98Diamond Mine

0256 \98Copper Ore Mine

0257 \98Candyfloss Forest

0258 \98Sweet Factory

0259 \98Battery Farm

025A \98Cola Wells

025B \98Toy Shop

025C \98Toy Factory

025D \98Plastic Fountains

025E \98Fizzy Drink Factory

025F \98Bubble Generator

0260 \98Toffee Quarry

0261 \98Sugar Mine

0262 \98Construct Coal Mine

0263 \98Construct Power Station

0264 \98Construct Sawmill

0265 \98Plant Forest

0266 \98Construct Oil Refinery

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

0268 \98Construct Factory

0269 \98Construct Steel Mill

026A \98Construct Farm

026B \98Construct Iron Ore Mine

026C \98Construct Oil Wells

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

026E \98Construct Paper Mill

026F \98Construct Food Processing Plant

0270 \98Construct Printing Works

0271 \98Construct Gold Mine

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

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

0274 \98Plant Fruit Plantation

0275 \98Plant Rubber Plantation

0276 \98Construct Water Supply

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

0278 \98Construct Diamond Mine

0279 \98Construct Copper Ore Mine

027A \98Plant Candyfloss Forest

027B \98Construct Sweet Factory

027C \98Construct Battery Farm

027D \98Construct Cola Wells

027E \98Construct Toy Shop

027F \98Construct Toy Factory

0280 \98Construct Plastic Fountains

0281 \98Construct Fizzy Drink Factory

0282 \98Construct Bubble Generator

0283 \98Construct Toffee Quarry

0284 \98Construct Sugar Mine

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

0286 \94...must build town first

0287 \94...only one allowed per town

0288 \98Plant trees

0289 \98Place sign

028A \98Random Trees

028B \98Plant trees randomly over landscape

028C \98Place rocky areas on landscape

028D \98Place lighthouse

028E \98Place transmitter

028F \98Define desert area

0290 \98Delete

0291 \98Delete this town completely

0292 Save scenario

0293 Load scenario

0294 Abandon editor

0295

0296 Quit to DOS

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

0298 \94Load Scenario

0299 \94Save Scenario

029A \98Play Scenario

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

029C \94Abandon Editor

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

029E \98Move the starting date backward 1 year

029F \98Move the starting date forward 1 year

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

02A1 \98Small

02A2 \98Medium

02A3 \98Large

02A4 \98Select town size

02A5 \90Town size:

02A6 \94Message to Player 2

02A7 \98Change Modem Initialisation String:

02A8 \98Change Dial Number:

02A9 \94Modem init. string:

02AA \94Dial number:

02AB \98Serial Port

02AC COM1

02AD COM2

02AE COM3

02AF COM4

02B0 \98\80

02B1 \98Baud Rate

02B2 \98\85\80 baud

02B3 9600

02B4 14400

02B5 19200

02B6 \80 - \80

02B7 \98Show last message or news report

02B8 \98Summary

02B9 \98Full

02BA \89- - \80 - -

02BB Town directory

02BC \98Vehicle design names

02BD \98\80

02BE Default

02BF Custom

02C0 \98Save custom names to disk

02C1 \98Vehicle design names selection

02C2 \98Save customized vehicle design names to disk

02C4 Game options

02C6 Difficulty settings

02C8

02C9 \ac

02CA \01\0cTown names displayed

02CB \ac

02CC \01\0cStation names displayed

02CD \ac

02CE \01\0cSigns displayed

02CF \ac

02D0 \01\0cFull animation

02D1 \ac

02D2 \01\0cFull detail

02D3 \ac

02D4 \01\0cTransparent buildings

02D5 Query land block

02D6

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

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

02D9 About 'Transport Tycoon'

02DA \98On

02DB \98Off

02DC \98Display subsidies

02DD Subsidies

02DE Map of world

02DF Town directory

02E0 \98Currency units

02E1 \98\85\80

02E2 \98Currency units selection

02E3 \98Distance units

02E4 \98\85\85\80

02E5 \98Distance units selection

02E6 \98Road vehicles

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

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

02E9 Drive on left

02EA Drive on right

02EB \98Town names

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

02ED \98Select style of town names

02EE English

02EF French

02F0 German

02F1 American

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

02F3 Silly

02F4 \98Autosave

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

02F6 \98Select interval between automatic game saves

02F7 Off

02F8 Every 3 months

02F9 Every 6 months

02FA Every 12 months

02FB \98Start a new game

02FC \98Load a saved game from disk

02FD \98View demonstrations/tutorials

02FE \98Create a customized game world/scenario

02FF \98Select single-player game

0300 \98Select two-player game

0301 \98Display game options

0302 \98Display difficulty options

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

0304 \98Quit to DOS

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

0306 \98View demonstration/tutorial

0307 \94Transport Tycoon (Deluxe)

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

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

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

030B \98Change the modem initialisation string

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

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

030E \98Select 'temperate' landscape style

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

0310 \98Select 'sub-tropical' landscape style

0311 \98Select 'toyland' landscape style

0312 \98Fund construction of new industry

0313 Fund new industry

0314 \94Fund new industry

0315 \80

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

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

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

0319 \90* * PAUSED * *

031A SCR|.PCX

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

031C \94Screenshot failed!

031D \98Link method

031E \98\85\85\80

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

0320 Serial cable (sender)

0321 Serial cable (receiver)

0322 Modem (send/dial)

0323 Modem (receive)

0324 Network - IPX protocol (sender)

0325 Network - IPX protocol (receiver)

0329 \98Purchase land for future use

032A \981: Road vehicle service

032B \982: Railway service

032C \983: Air service

032D \984: Ship service

032E \985: Railway service (advanced)

032F \8bAUTOSAVE

0330 \98Select 'Ezy Street style music' program

0331 \94...IPX driver not found

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

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

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

=0800 Basic land strings=

0800 \0e

0801 \8bCost: \7f

0802 \0e

0803 \8fIncome: \7f

0804 \0e

0805 \94Estimated Cost: \7f

0806 \0e

0807 \94Estimated Income: \7f

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

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

080A Rocks

080B Rough land

080C Bare land

080D Grass

080E Fields

080F Snow-covered land

0810 Desert

=1000 Railroad strings=

1000 \94Land sloped in wrong direction

1001 \94Impossible track combination

1002 \94Excavation would damage tunnel

1003 \94Already at sea-level

1004 \94Too high

1005 \94No suitable railway track

1006 \94Train inside depot

1007 \94...already built

1008 \94Must remove railway track first

1009 \94Too many depots

100A \94Railway Construction

100B \94Monorail Construction

100C \94MagLev Construction

100D \94Select Rail Bridge

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

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

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

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

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

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

1014 \94Train Depot Orientation

1015 Railway construction

1016 Monorail construction

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

1018 \98Build railway track

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

101A \98Build railway station

101B \98Build railway signals

101C \98Build railway bridge

101D \98Build railway tunnel

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

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

1020 \98Select rail depot orientation

1021 Railway track

1022 Railway track with signals

1023 Railway train depot

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

=1800 Road strings=

1800 \94Land sloped in wrong direction for road

1801 \94Must remove road first

1802 \94Road Construction

1803 \94Select Road Bridge

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

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

1806 \94Road Depot Orientation

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

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

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

180A Road construction

180B \98Build road section

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

180D \98Build bus station

180E \98Build lorry loading bay

180F \98Build road bridge

1810 \98Build road tunnel

1811 \98Toggle build/remove for road construction

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

1813 \98Select road vehicle depot orientation

1814 Road

1815 Road with streetlights

1816 Tree-lined road

1817 Road vehicle depot

1818 Road/rail level crossing

=2000 Town strings=

2000 \94Towns

2001 \94\80

2002 \0e\98\80

2003 \0e\94\80

2004 \94Building must be demolished first

2005 \94\80

2006 \98Population: \8e{

2007 Rename Town

2008 \94Can't rename town...

2009 \94\80 local authority refuses to allow this

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

200B \98Centre the main view on town location

200C \98Change town name

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

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

200F Tall office block

2010 Office block

2011 Small block of flats

2012 Church

2013 Large office block

2014 Town houses

2015 Hotel

2016 Statue

2017 Fountain

2018 Park

2019 Office block

201A Shops and offices

201B Modern office building

201C Warehouse

201D Office block

201E Stadium

201F Old houses

2020 \98Local authority

2021 \98Show information on local authority

2022 \94\80 local authority

2023 \98Transport company ratings:

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

2025 \94Subsidies

2026 \98Subsidies on offer for services taking:-

2027 \8e\80 from \80 to \80

2028 \90 (by \83)

2029 \80 \80

202A \8eNone

202B \98Services already subsidised:-

202C \8e\80 from \80 to \80\90 (\80

202D \90,until \83)

202E \98\0fOffer of subsidy expired:\0d\0d\80 from \80 to \80 will now not attract a subsidy.

202F \98\0fSubsidy withdrawn:\0d\0d\80 service from \80 to \80 is no longer subsidised.

2030 \98\0fService subsidy offered:\0d\0dFirst \80 service from \80 to \80 will attract a year's subsidy from the local authority!

2031 \98\0fService subsidy awarded to \80!\0d\0d\80 service from \80 to \80 will pay 50% extra for the next year!

2032 \98\0fService subsidy awarded to \80!\0d\0d\80 service from \80 to \80 will pay double rates for the next year!

2033 \98\0fService subsidy awarded to \80!\0d\0d\80 service from \80 to \80 will pay triple rates for the next year!

2034 \98\0fService subsidy awarded to \80!\0d\0d\80 service from \80 to \80 will pay quadruple rates for the next year!

2035 \94\80 local authority refuses to allow another airport to be built in this town

2036 Cottages

2037 Houses

2038 Flats

2039 Tall office block

203A Shops and offices

203B Shops and offices

203C Theatre

203D Stadium

203E Offices

203F Houses

2040 Cinema

2041 Shopping mall

2042 \98Do it

2043 \98List of things to do at this town - click on item for more details

2044 \98Carry out the highlighted action in the list above

2045 \98Actions available:

2046 Small advertising campaign

2047 Medium advertising campaign

2048 Large advertising campaign

2049 Fund local road reconstruction

204A Build statue of company owner

204B Fund new buildings

204C Buy exclusive transport rights

204D \94\80\0d\90 Initiate a small local advertising campaign,to attract more passengers and cargo to your transport services.\0d Cost: \7f

204E \94\80\0d\90 Initiate a medium local advertising campaign,to attract more passengers and cargo to your transport services.\0d Cost: \7f

204F \94\80\0d\90 Initiate a large local advertising campaign,to attract more passengers and cargo to your transport services.\0d Cost: \7f

2050 \94\80\0d\90 Fund the reconstruction of the urban road network. Causes considerable disruption to road traffic for up to 6 months.\0d Cost: \7f

2051 \94\80\0d\90 Build a statue in honour of your company.\0d Cost: \7f

2052 \94\80\0d\90 Fund the construction of new commercial buildings in the town.\0d Cost: \7f

2053 \94\80\0d\90 Buy 1 year's exclusive transport rights in town. Town authority will only allow passengers and cargo to use your company's stations.\0d Cost: \7f

2054 \94Can't do this...

2055 \0f\98Traffic chaos in \80!\0d\0dRoad rebuilding programme funded by \80 brings 6 months of misery to motorists!

2056 \0e\94\80

2057 \8e\80\98  ({)

2058 \80 (under construction)

2059 Igloo

205A Tepees

205B ))Teapot-House[[]]Teapot-House[[

205C ))Piggy-Bank[[]]Piggy-Bank[[

=2800 Tree strings=

2800 Plant trees

2801 Place sign

2802 \94Trees

2803 \94...tree already here

2804 \94...site unsuitable

2805 \94Can't plant tree here...

2806 \94\80

2807 \0e\94\80

2808 \94...too many signs

2809 \94Can't place sign here...

280A Sign

280B \94Edit sign text

280C \94Can't change sign name...

280D \98Select tree type to plant

280E Trees

280F Rainforest

2810 Cactus Plants

=3000 Station strings=

3000 \94Rail Station Selection

3001 \94Airport Selection

3002 \98Orientation

3003 \98Number of tracks

3004 \98Platform length

3005 \94Too close to another railway station

3006 \94Adjoins more than one existing station/loading area

3007 \94Too many stations/loading areas in this town

3008 \94Too many stations/loading areas

3009 \94Too close to another station/loading area

300A \94\80 \81\d10

300B \94Must demolish railway station first

300C

300D \94Too close to another airport

300E \94Must demolish airport first

300F \80

3010 \80 North

3011 \80 South

3012 \80 East

3013 \80 West

3014 \80 Central

3015 \80 Transfer

3016 \80 Halt

3017 \80 Valley

3018 \80 Heights

3019 \80 Woods

301A \80 Lakeside

301B \80 Exchange

301C \80 Airport

301D \80 Oilfield

301E \80 Mines

301F \80 Docks

3020 \80 Buoy 1

3021 \80 Buoy 2

3022 \80 Buoy 3

3023 \80 Buoy 4

3024 \80 Buoy 5

3025 \80 Buoy 6

3026 \80 Buoy 7

3027 \80 Buoy 8

3028 \80 Buoy 9

3029 \80 Annexe

302A \80 Sidings

302B \80 Branch

302C Upper \80

302D Lower \80

302E \80 Heliport

302F \80 Forest

3030 Rename station/loading area

3031 \94Can't rename station...

3032 \98Ratings

3033 \98Accepts

3034 \98Local rating of transport service:

3035 Appalling

3036 Very Poor

3037 Poor

3038 Mediocre

3039 Good

303A Very Good

303B Excellent

303C Outstanding

303D \94\80: \90\80 (}%)

303E \94\80 no longer accepts \80

303F \94\80 no longer accepts \80 or \80

3040 \94\80 now accepts \80

3041 \94\80 now accepts \80 and \80

3042 \94Bus Station Orientation

3043 \94Lorry Station Orient.

3044 \94Too close to another bus station

3045 \94Too close to another lorry station

3046 \94Must demolish bus station first

3047 \94Must demolish lorry station first

3048 \94\80 - Stations

3049 \90\80 \81\d10

304A \90- None -

304B \94...site unsuitable

304C \94Too close to another dock

304D \94Must demolish dock first

304E \98Select railway station orientation

304F \98Select number of platforms for railway station

3050 \98Select length of railway station

3051 \98Select bus station orientation

3052 \98Select lorry loading bay orientation

3053 \98Centre main view on station location

3054 \98Show station ratings

3055 \98Change name of station

3056 \98Show list of accepted cargo

3057 \98Station names - click on name to centre main view on station

3058 \98Select size/type of airport

3059 \98Small

305A \98Large

305B \98Size

305C \98\80 \81\d10

305D \0e\98\80 \81\d10

305E Railway station

305F Aircraft hangar

3060 Airport

3061 Lorry loading area

3062 Bus station

3063 Ship dock

3064 \98Highlight catchment area of proposed site

3065 \98Don't highlight catchment area of proposed site

3066 \98Catchment area highlight

3067 \94Monorail Station Select.

3068 \94Dock

3069 Buoy

306A \94...buoy in the way

306B \98Heliport

306C \94...station too spread out

=3800 Water strings=

3800 \94Ship Depot Orientation

3801 \94...must be built on water

3802 \94Can't build ship depot here...

3803 \98Select ship depot orientation

3804 Water

3805 Coast or riverbank

3806 Ship depot

3807 \94...Can't build on water

=4000 Load/save strings=

4000 \94Save Game

4001 \94Load Game

4002 \98Save

4003 \98Delete

4004 \80, \82

4005 \98{ bytes free

4006 \98Unable to read drive

4007 \94Game Save Failed

4008 \94Unable to delete file

4009 \94Game Load Failed

400A \98List of drives,directories and saved-game files

400B \98Currently selected name for saved-game

400C \98Delete the currently selected saved-game

400D \98Save the current game,using the selected name

400E \94Select New Game Type

400F \98Select scenario (green),pre-set game (blue),or random new game

4010 Generate random new game

=4800 Industry strings=

4800 \94\80 in the way

4801 \94\80 \80

4802 Coal Mine

4803 Power Station

4804 Sawmill

4805 Forest

4806 Oil Refinery

4807 Oil Rig

4808 Factory

4809 Printing Works

480A Steel Mill

480B Farm

480C Copper Ore Mine

480D Oil Wells

480E Bank

480F Food Processing Plant

4810 Paper Mill

4811 Gold Mine

4812 Bank

4813 Diamond Mine

4814 Iron Ore Mine

4815 Fruit Plantation

4816 Rubber Plantation

4817 Water Supply

4818 Water Tower

4819 Factory

481A Farm

481B Lumber Mill

481C Candyfloss Forest

481D Sweet Factory

481E Battery Farm

481F Cola Wells

4820 Toy Shop

4821 Toy Factory

4822 Plastic Fountains

4823 Fizzy Drink Factory

4824 Bubble Generator

4825 Toffee Quarry

4826 Sugar Mine

4827 \98Requires: \90\80

4828 \98Requires: \90\80,\80

4829 \98Requires: \90\80,\80,\80

482A \98Production last month:

482B \90\80\98 (|% transported)

482C \98Centre the main view on industry location

482D \98\0fNew \80 under construction near \80!

482E \98\0fNew \80 being planted near \80!

482F \98Cost: \90\7f

4830 \94Can't construct this industry type here...

4831 \94...forest can only be planted above snow-line

4832 \98\0f\80 \80 announces imminent closure!

4833 \98\0fSupply problems cause \80 \80 to announce imminent closure!

4834 \98\0fLack of nearby trees causes \80 \80 to announce imminent closure!

4835 \98\0f\80 \80 increases production!

4836 \98\0fNew coal seam found at \80 \80!\0dProduction is expected to double!

4837 \98\0fNew oil reserves found at \80 \80!\0dProduction is expected to double!

4838 \98\0fImproved farming methods at \80 \80 are expected to double production!

4839 \98\0f\80 \80 production down by 50%

483A \98\0fInsect infestation causes havoc at \80 \80!\0dProduction down by 50%

483B \94...can only be positioned near edges of map

=5000 Tunnel and bridge strings=

5000 \94Train in tunnel

5001 \94Road vehicle in tunnel

5002

5003 \94Another tunnel in the way

5004

5005 \94Unable to excavate land for other end of tunnel

5006 \94Must demolish tunnel first

5007 \94Must demolish bridge first

5008 \94Cannot start and end on same position

5009 \94Level land or water required under bridge

500A \94Start and end must be in line

500B \94Site unsuitable for tunnel entrance

500C

500D \8a\80,\0d \84   \94\7f

500E Suspension,Steel

500F Girder,Steel

5010 Cantilever,Steel

5011 Suspension,Concrete

5012 Wooden

5013 Concrete

5014 Tubular,Steel

5015 \94Can't build bridge here...

5016 \94Can't build tunnel here...

5017 Railway tunnel

5018 Road tunnel

5019

501A

501B Steel suspension rail bridge

501C Steel girder rail bridge

501D Steel cantilever rail bridge

501E Reinforced concrete suspension rail bridge

501F Wooden rail bridge

5020 Concrete rail bridge

5021 Steel suspension road bridge

5022 Steel girder road bridge

5023 Steel cantilever road bridge

5024 Reinforced concrete suspension road bridge

5025 Wooden road bridge

5026 Concrete road bridge

5027 Tubular rail bridge

5028 Tubular road bridge

5029 Steel

=5800 Object strings=

5800 \94Object in the way

5801 Transmitter

5802 Lighthouse

5803 Company Headquarters

5804 \94...company headquarters in the way

5805 Company-owned land

5806 \94Can't purchase this land area...

5807 \94...you already own it!

=6000 Debugger strings=

6000 \94Debugger

6001 \8bAnimation blocks: |/|

6002 \98+Cash

6003 \98+Towns

6004 \98{

6005 \98+

6006 \98-

6007 \8bNon-Effect Objects: |/|

6008 \8bEffect Objects: |/|

6009 \8bText Effects: |/|

600A \98Land Code: |

600B \8bOrders: |/|

600C \8bNames: |/|

600D \98AllVeh

600E \98+Cmpny

600F \98Interrupts: |

6010 \98ID: |

6011 \98Serial resends: |

6012 \8eRand.Seed: \90|

6013 \8bGr.Cache Used: {/{

6014 \98Fingerprint: --------

6015 \8bStations: |/|

6016 \98Random seed: \8e{

6017 \98NPC PZ

6018 \94GAMES OUT OF SYNC!

=6800 Difficulty strings=

6800 \94Difficulty Level

6801 \98Easy

6802 \98Medium

6803 \98Hard

6804 \98Custom

6805 \95Maximum no. competitors: \8e|

6806 \95Competitor start time: \8e\80

6807 \95No. of towns: \8e\80

6808 \95No. of industries: \8e\80

6809 \95Maximum initial loan: \8e\7f

680A \95Initial interest rate: \8e|%

680B \95Vehicle running costs: \8e\80

680C \95Construction speed of competitors: \8e\80

680D \95Intelligence of competitors: \8e\80

680E \95Vehicle breakdowns: \8e\80

680F \95Subsidy multiplier: \8e\80

6810 \95Cost of construction: \8e\80

6811 \95Terrain type: \8e\80

6812 \95Quantity of sea/lakes: \8e\80

6813 \95Economy: \8e\80

6814 \95Train reversing: \8e\80

6815 \95Disasters: \8e\80

6816 Low

6817 Normal

6818 High

6819 \98&lt;

681A \98&gt;

681B Very Slow

681C Slow

681D Medium

681E Fast

681F Very Fast

6820 Low

6821 Medium

6822 High

6823 None

6824 Reduced

6825 Normal

6826 x1.5

6827 x2

6828 x3

6829 x4

682A Very Flat

682B Flat

682C Hilly

682D Mountainous

682E Steady

682F Fluctuating

6830 Immediate

6831 3 months after player

6832 6 months after player

6833 9 months after player

6834 At end of line,and at stations

6835 At end of line only

6836 Off

6837 On

6838 \98Show hi-score chart

=7000 Company strings=

7000 Unnamed\85\85

7001 \94\80\98\80

7002  (Player 1)

7003  (Player 2)

7004 \98New Face

7005 \98Colour Scheme

7006 \8aColour Scheme:

7007 \94New Colour Scheme

7008 \98Company Name

7009 \98Manager Name

700A Company Name

700B Manager's Name

700C \94Can't change company name...

700D \94Can't change manager's name...

700E \94\80 Finances\98\80

700F \94Expenditure/Income

7010 \94~

7011 \8aConstruction

7012 \8aNew Vehicles

7013 \8aTrain Running Costs

7014 \8aRoad Veh. Running Costs

7015 \8aAircraft Running Costs

7016 \8aShip Running Costs

7017 \8aProperty Maintenance

7018 \8aTrain Income

7019 \8aRoad Vehicles Income

701A \8aAircraft Income

701B \8aShip Income

701C \8aLoan Interest

701D \8aOther

701E \98-\7f

701F \98+\7f

7020 \94Total:

7021 \80\80

7022 \94Income Graph

7023 \7f

7024 {

7025 \94Operating Profit Graph

7026 \94Bank Balance

7027 \94Loan

7028 \98\7f

7029 \98Borrow \85\85\85\85\7f

702A \98Repay \85\85\85\85\7f

702B \94...maximum permitted loan size is \7f

702C \94Can't borrow any more money...

702D \94...loan already repayed

702E \94...\7f required

702F \94Can't repay loan...

7030 \98Select new face for manager

7031 \98Change the company vehicle livery

7032 \98Change the manager's name

7033 \98Change the company name

7034 \98Click on selected new colour scheme

7035 \98Increase size of loan

7036 \98Repay part of loan

7037 \94\80\0d\8a(Manager)

7038 \8aInaugurated: \94~

7039 \8aVehicles:

703A \94| train

703B \94| trains

703C \94| road vehicle

703D \94| road vehicles

703E \94| aircraft

703F \94| aircraft

7040 \94| ship

7041 \94| ships

7042 \94None

7043 \94Face Selection

7044 \98Male

7045 \98Female

7046 \98New Face

7047 \98Cancel new face selection

7048 \98Accept new face selection

7049 \98Select male faces

704A \98Select female faces

704B \98Generate random new face

704C \98Key

704D \98Show key to graphs

704E \94Key to company graphs

704F \98Click here to toggle company's entry on graph on/off

7050 \94Units of cargo delivered

7051 \94Company performance ratings (maximum rating=1000)

7052 \94Company values

7053 \94Company League Table

7054 \94\80\01-\8e\80 \98\80   '\80'

7055 \90\80\01-\8e\80 \98\80   '\80'

7056 \98\0fTransport company in trouble!

7057 \98\0f\80 will be sold off or declared bankrupt unless performance increases soon!

7058 \98\80\0d(Manager)

7059 \98\0fTransport company merger!

705A \98\0f\80 has been sold to \80 for \7f!

705B \94We are looking for a transport company to take-over our company\0d\0dDo you want to purchase \80 for \7f?

705C \98\0fBankrupt!

705D \98\0f\80 has been closed down by creditors and all assets sold off!

705E \98\0fNew transport company launched!

705F \98\0f\80 starts construction near \80!

7060 \94Can't buy company...

7061 \94Cargo Payment Rates

7062 \98\0eDays in transit

7063 \98\0ePayment for delivering 10 units (or 1,000 litres) of cargo a distance of 20 squares

7064 \98Toggle graph for cargo type on/off

7065 \98\0e\80

7066 Engineer

7067 Traffic Manager

7068 Transport Coordinator

7069 Route Supervisor

706A Director

706B Chief Executive

706C Chairman

706D President

706E Tycoon

706F \98Build HQ

7070 \98Build company headquarters / view company headquarters

7071 \94Can't build company headquarters...

7072 \98View HQ

7073 \0f\98World Recession!\0d\0dFinancial experts fear worst as economy slumps!

7074 \0f\98Recession Over!\0d\0dUpturn in trade gives confidence to industries as economy strengthens!

7075 \98Toggle large/small window size

7076 \8aCompany value: \94\7f

7077 \98Buy 25% share in company

7078 \98Sell 25% share in company

7079 \98Buy 25% share in this company

707A \98Sell 25% share in this company

707B \94Can't buy 25% share in this company...

707C \94Can't sell 25% share in this company...

707D \94(|% owned by \80)

707E \94(|% owned by \80\0d |% owned by \80)

707F \98\0f\80 has been taken over by \80!

=7800 Custom strings=

These cannot be set directly; an entry is generated every time the player enters a custom name for example for signs, stations or vehicles.

=8000 Vehicle type names=

Note, IDs 8000..80FF will be changed by using a regular action 4 to name new vehicles, but not by using "custom vehicle names" from vehicle.dat which use custom strings instead.

8000 Kirby Paul Tank (Steam)

8001 MJS 250 (Diesel)

8002 Ploddyphut ))Choo-Choo[[]]Choo-Choo[[

8003 Powernaut ))Choo-Choo[[]]Choo-Choo[[

8004 Mightymover ))Choo-Choo[[]]Choo-Choo[[

8005 Ploddyphut Diesel

8006 Powernaut Diesel

8007 Wills 2-8-0 (Steam)

8008 Chaney 'Jubilee' (Steam)

8009 Ginzu 'A4' (Steam)

800A SH '8P' (Steam)

800B ))Manley-Morel[[]]Manley-Morel[[ DMU (Diesel)

800C 'Dash' (Diesel)

800D SH/Hendry '25' (Diesel)

800E UU '37' (Diesel)

800F Floss '47' (Diesel)

8010 CS 4000 (Diesel)

8011 CS 2400 (Diesel)

8012 Centennial (Diesel)

8013 Kelling 3100 (Diesel)

8014 Turner Turbo (Diesel)

8015 MJS 1000 (Diesel)

8016 SH '125' (Diesel)

8017 SH '30' (Electric)

8018 SH '40' (Electric)

8019 'T.I.M.' (Electric)

801A 'AsiaStar' (Electric)

801B Passenger Carriage

801C Mail Van

801D Coal Truck

801E Oil Tanker

801F Livestock Van

8020 Goods Van

8021 Grain Hopper

8022 Wood Truck

8023 Iron Ore Hopper

8024 Steel Truck

8025 Armoured Van

8026 Food Van

8027 Paper Truck

8028 Copper Ore Hopper

8029 Water Tanker

802A Fruit Truck

802B Rubber Truck

802C Sugar Truck

802D Candyfloss Hopper

802E Toffee Hopper

802F Bubble Van

8030 Cola Tanker

8031 Sweet Van

8032 Toy Van

8033 Battery Truck

8034 Fizzy Drink Truck

8035 Plastic Truck

8036 'X2001' (Electric)

8037 'Millennium Z1' (Electric)

8038 Wizzowow Z99

8039 Passenger Carriage

803A Mail Van

803B Coal Truck

803C Oil Tanker

803D Livestock Van

803E Goods Van

803F Grain Hopper

8040 Wood Truck

8041 Iron Ore Hopper

8042 Steel Truck

8043 Armoured Van

8044 Food Van

8045 Paper Truck

8046 Copper Ore Hopper

8047 Water Tanker

8048 Fruit Truck

8049 Rubber Truck

804A Sugar Truck

804B Candyfloss Hopper

804C Toffee Hopper

804D Bubble Van

804E Cola Tanker

804F Sweet Van

8050 Toy Van

8051 Battery Truck

8052 Fizzy Drink Truck

8053 Plastic Truck

8054 Lev1 'Leviathan' (Electric)

8055 Lev2 'Cyclops' (Electric)

8056 Lev3 'Pegasus' (Electric)

8057 Lev4 'Chimaera' (Electric)

8058 Wizzowow Rocketeer

8059 Passenger Carriage

805A Mail Van

805B Coal Truck

805C Oil Tanker

805D Livestock Van

805E Goods Van

805F Grain Hopper

8060 Wood Truck

8061 Iron Ore Hopper

8062 Steel Truck

8063 Armoured Van

8064 Food Van

8065 Paper Truck

8066 Copper Ore Hopper

8067 Water Tanker

8068 Fruit Truck

8069 Rubber Truck

806A Sugar Truck

806B Candyfloss Hopper

806C Toffee Hopper

806D Bubble Van

806E Cola Tanker

806F Sweet Van

8070 Toy Van

8071 Battery Truck

8072 Fizzy Drink Truck

8073 Plastic Truck

8074 MPS Regal Bus

8075 Hereford Leopard Bus

8076 Foster Bus

8077 Foster MkII Superbus

8078 Ploddyphut MkI Bus

8079 Ploddyphut MkII Bus

807A Ploddyphut MkIII Bus

807B Balogh Coal Truck

807C Uhl Coal Truck

807D DW Coal Truck

807E MPS Mail Truck

807F Reynard Mail Truck

8080 Perry Mail Truck

8081 ))MightyMover[[]]MightyMover[[ Mail Truck

8082 Powernaught Mail Truck

8083 Wizzowow Mail Truck

8084 Witcombe Oil Tanker

8085 Foster Oil Tanker

8086 Perry Oil Tanker

8087 Talbott Livestock Van

8088 Uhl Livestock Van

8089 Foster Livestock Van

808A Balogh Goods Truck

808B Craighead Goods Truck

808C Goss Goods Truck

808D Hereford Grain Truck

808E Thomas Grain Truck

808F Goss Grain Truck

8090 Witcombe Wood Truck

8091 Foster Wood Truck

8092 Moreland Wood Truck

8093 MPS Iron Ore Truck

8094 Uhl Iron Ore Truck

8095 Chippy Iron Ore Truck

8096 Balogh Steel Truck

8097 Uhl Steel Truck

8098 Kelling Steel Truck

8099 Balogh Armoured Truck

809A Uhl Armoured Truck

809B Foster Armoured Truck

809C Foster Food Van

809D Perry Food Van

809E Chippy Food Van

809F Uhl Paper Truck

80A0 Balogh Paper Truck

80A1 MPS Paper Truck

80A2 MPS Copper Ore Truck

80A3 Uhl Copper Ore Truck

80A4 Goss Copper Ore Truck

80A5 Uhl Water Tanker

80A6 Balogh Water Tanker

80A7 MPS Water Tanker

80A8 Balogh Fruit Truck

80A9 Uhl Fruit Truck

80AA Kelling Fruit Truck

80AB Balogh Rubber Truck

80AC Uhl Rubber Truck

80AD RMT Rubber Truck

80AE ))MightyMover[[]]MightyMover[[ Sugar Truck

80AF Powernaught Sugar Truck

80B0 Wizzowow Sugar Truck

80B1 ))MightyMover[[]]MightyMover[[ Cola Truck

80B2 Powernaught Cola Truck

80B3 Wizzowow Cola Truck

80B4 ))MightyMover[[]]MightyMover[[ Candyfloss Truck

80B5 Powernaught Candyfloss Truck

80B6 Wizzowow Candyfloss Truck

80B7 ))MightyMover[[]]MightyMover[[ Toffee Truck

80B8 Powernaught Toffee Truck

80B9 Wizzowow Toffee Truck

80BA ))MightyMover[[]]MightyMover[[ Toy Van

80BB Powernaught Toy Van

80BC Wizzowow Toy Van

80BD ))MightyMover[[]]MightyMover[[ Sweet Lorry

80BE Powernaught Sweet Lorry

80BF Wizzowow Sweet Lorry

80C0 ))MightyMover[[]]MightyMover[[ Battery Truck

80C1 Powernaught Battery Truck

80C2 Wizzowow Battery Truck

80C3 ))MightyMover[[]]MightyMover[[ Fizzy Drink Truck

80C4 Powernaught Fizzy Drink Truck

80C5 Wizzowow Fizzy Drink Truck

80C6 ))MightyMover[[]]MightyMover[[ Plastic Truck

80C7 Powernaught Plastic Truck

80C8 Wizzowow Plastic Truck

80C9 ))MightyMover[[]]MightyMover[[ Bubble Truck

80CA Powernaught Bubble Truck

80CB Wizzowow Bubble Truck

80CC MPS Oil Tanker

80CD CS-Inc. Oil Tanker

80CE MPS Passenger Ferry

80CF FFP Passenger Ferry

80D0 Bakewell 300 Hovercraft

80D1 ))Chugger-Chug[[]]Chugger-Chug[[ Passenger Ferry

80D2 Shivershake Passenger Ferry

80D3 Yate Cargo ship

80D4 Bakewell Cargo ship

80D5 Mightymover Cargo ship

80D6 Powernaut Cargo ship

80D7 Sampson U52

80D8 Coleman Count

80D9 FFP Dart

80DA Yate Haugan

80DB Bakewell Cotswald LB-3

80DC Bakewell Luckett LB-8

80DD Bakewell Luckett LB-9

80DE Bakewell Luckett LB80

80DF Bakewell Luckett LB-10

80E0 Bakewell Luckett LB-11

80E1 Yate Aerospace YAC 1-11

80E2 Darwin 100

80E3 Darwin 200

80E4 Darwin 300

80E5 Darwin 400

80E6 Darwin 500

80E7 Darwin 600

80E8 Guru Galaxy

80E9 Airtaxi A21

80EA Airtaxi A31

80EB Airtaxi A32

80EC Airtaxi A33

80ED Yate Aerospace YAe46

80EE Dinger 100

80EF ))AirTaxi[[]]AirTaxi[[ A34-1000

80F0 Yate ))Z-Shuttle[[]]Z-Shuttle[[

80F1 Kelling K1

80F2 Kelling K6

80F3 Kelling K7

80F4 Darwin 700

80F5 FFP Hyperdart 2

80F6 Dinger 200

80F7 Dinger 1000

80F8 Ploddyphut 100

80F9 Ploddyphut 500

80FA Flashbang X1

80FB Juggerplane M1

80FC Flashbang Wizzer

80FD Tricario Helicopter

80FE Guru X2 Helicopter

80FF Powernaut Helicopter

8100 \94Message from vehicle manufacturer

8101 \8aWe have just designed a new \80 - would you be interested in a year's exclusive use of this vehicle,so we can see how it performs before making it universally available ?

8102 railway locomotive

8103 road vehicle

8104 aircraft

8105 ship

8106 monorail locomotive

8107 maglev locomotive

=8800 Train strings=

8800 \94\80 Train Depot

8801 \98\0fCitizens celebrate . . .\0dFirst train arrives at \80!

8802 \94\80 (Details)

8803 \94Train in the way

8806 Go to \80

8807 Go to \80 (Unload)

8808 Go to \80 (Load)

8809

880A Go non-stop to \80

880B Go non-stop to \80 (Unload)

880C Go non-stop to \80 (Load)

880D

880E Go to \80 Train Depot

880F Go non-stop to \80 Train Depot

8810 \95Heading for \80

8811 \95Heading for \80 Train Depot

8812 \95Empty

8813 \95\80 from \80

8814 \94Train | is waiting in depot

8815 \98New Vehicles

8816 \98-

8817 \98Cost: \8a\7f\98 Weight: \8a|t\0d\98Speed: \8a\84\98 Power: \8a|hp\0d\98Running Cost: \8a\7f/yr\0d\98Capacity: \8a\80\0d\98Designed: \8a~\98 Life: \8a| years\0d\98Max. Reliability: \8a}%

8818 \98Information

8819 \94Train too long

881A \94Trains can only be altered when stopped inside a depot

881B \94\80 - Trains

881C \94New Rail Vehicles

881D \94New Monorail Vehicles

881E \94New Maglev Vehicles

881F \98Build Vehicle

8820 \98Rename

8821 \98Cost: \8a\7f\0d\98Weight: \8a|t (|t)\0d\98Capacity: \8a\80

8822 \95No orders

8823 \98Skip

8824 \98Delete

8825 \98Non-Stop

8826 \98Go To

8827 \98Full Load

8828 \98Unload

8829 \94\80 (Orders)

882A \01\0a- - End of Orders - -

882B \94Can't build rail vehicle...

882C \95\80\98 Built: \95~\98 Value: \95\7f

882D \95\80\98 Value: \95\7f

882E \94\80

882F \95Loading / Unloading

8830 \94Can't send train to depot...

8831 \94No more space for orders

8832 \94Too many orders

8833 \94Can't insert new order...

8834 \94Can't delete this order...

8835 \94Can't modify this order...

8836 \94Must build train depot first

8837 \94Can't move vehicle...

8838 N/A\85

8839 \94Can't sell rail vehicle...

883A \94Unable to find route to local depot

883B \94Can't stop/start train...

883C \98Servicing interval: \95|days\98 Last service: \95\82

883D \98Trains - click on train for information

883E \98Build new trains (requires train depot)

883F \98Trains - click on train for info.,drag vehicle to add/remove from train

8840 \98Build new train vehicle

8841 \98Drag train vehicle to here to sell it

8842 \98Centre main view on train depot location

8843 \98Train vehicle selection list - click on vehicle for information

8844 \98Build the highlighted train vehicle

8845 \98Rename train vehicle type

8846 \98Current train action - click here to stop/start train

8847 \98Show train's orders

8848 \98Centre main view on train's location

8849 \98Send train to depot

884A \98Force train to proceed without waiting for signal to clear

884B \98Reverse direction of train

884C \98Show train details

884D \98Increase servicing interval

884E \98Decrease servicing interval

884F \98Show details of cargo carried

8850 \98Show details of train vehicles

8851 \98Show capacities of each vehicle

8852 \98Orders list - click on order to highlight it

8853 \98Skip the current order,and start the next

8854 \98Delete the highlighted order

8855 \98Make the highlighted order non-stop

8856 \98Insert a new order before the highlighted order,or add to end of list

8857 \98Make the highlighted order force the vehicle to wait for a full load

8858 \98Make the highlighted order force the vehicle to unload

8859 \98\0fNew \80 now available!

885A \98\0f\80

885B \98Cost: \7f Weight: |t\0dSpeed: \84 Power: |hp\0dRunning Cost: \7f/yr\0dCapacity: \80

885C \8bBroken down

885D \98Age: \95\80\98 Running Cost: \95\7f/yr

885E \98Weight: \95|t \98Power: \95|hp\98 Max. speed: \95\84

885F \98Profit this year: \95\7f (last year: \7f)

8860 \98Reliability: \95}% \98Breakdowns since last service: \95|

8861 \8bStopped

8862 \94Can't make train pass signal at danger...

8863 \8bCrashed!

8864 Train |

8865 \94Name train

8866 \94Can't name train...

8867 \98Name train

8868 \98\0fTrain Crash!\0d| die in fireball after collision

8869 \94Can't reverse direction of train...

886A \94Rename train vehicle type

886B \94Can't rename train vehicle type...

=9000 Road vehicle strings=

9000 \94Road vehicle in the way

9001 \94\80 - Road Vehicles

9002 \94\80

9003 \94\80 Road Vehicle Depot

9004 \98New Vehicles

9005 \98Information

9006 \94New Road Vehicles

9007 \98Build Vehicle

9008 \98Cost: \8a\7f\98 Speed: \8a\84\0d\98Running Cost: \8a\7f/yr\0d\98Capacity: \8a\80\0d\98Designed: \8a~\98 Life: \8a| years\0d\98Max. Reliability: \8a}%

9009 \94Can't build road vehicle...

900A \94Must build road vehicle depot first

900B \94\80 (Orders)

900C \94\80 (Details)

900D \98Age: \95\80\98 Running Cost: \95\7f/yr

900E \98Max. speed: \95\84

900F \98Profit this year: \95\7f (last year: \7f)

9010 \98Reliability: \95}% \98Breakdowns since last service: \95|

9011 \95\80\98 Built: \95~\98 Value: \95\7f

9012 \98Capacity: \95\80

9013 \94...must be stopped inside a road vehicle depot

9014 \94Can't sell road vehicle...

9015 \94Can't stop/start road vehicle...

9016 \94Road Vehicle | is waiting in depot

9017 \95Heading for \80 Road Depot

9018 \94Can't send vehicle to depot...

9019 \94Unable to find local depot

901A \98Road vehicles - click on vehicle for information

901B \98Build new road vehicles (requires road vehicle depot)

901C \98Current vehicle action - click here to stop/start vehicle

901D \98Show vehicle's orders

901E \98Centre main view on vehicle's location

901F \98Send vehicle to depot

9020 \98Force vehicle to turn around

9021 \98Show road vehicle details

9022 \98Vehicles - click on vehicle for information

9023 \98Build new road vehicle

9024 \98Drag road vehicle to here to sell it

9025 \98Centre main view on road vehicle depot location

9026 \98Road vehicle selection list - click on vehicle for information

9027 \98Build the highlighted road vehicle

9028 \98\0fNew road vehicle now available!

9029 \98\0f\80

902A \98Cost: \7f\0dSpeed: \84\0dRunning Cost: \7f/yr\0dCapacity: \80

902B Road Vehicle |

902C \94Name road vehicle

902D \94Can't name road vehicle...

902E \98Name road vehicle

902F \98\0fCitizens celebrate . . .\0dFirst bus arrives at \80!

9030 \98\0fCitizens celebrate . . .\0dFirst lorry arrives at \80!

9031 \98\0fRoad Vehicle Crash!\0dDriver dies in fireball after collision with train

9032 \98\0fRoad Vehicle Crash!\0d| die in fireball after collision with train

9033 \94Can't make vehicle turn around...

9034 \98Rename

9035 \98Rename road vehicle type

9036 \94Rename road vehicle type

9037 \94Can't rename road vehicle type...

=9800 Ship strings=

9800 Dock construction

9801 \94Dock construction

9802 \94Can't build dock here...

9803 \94\80 Ship Depot

9804 \98New Ships

9805 \94\80 - Ships

9806 \94Can't build ships...

9807 \94Must build ship depot first

9808 \94New Ships

9809 \98Build Ship

980A \98Cost: \8a\7f\98 Speed: \8a\84\0d\98Capacity: \8a\80 \80\0d\98Running Cost: \8a\7f/yr\0d\98Designed: \8a~\98 Life: \8a| years\0d\98Max. Reliability: \8a}%

980B \94Ship must be stopped in depot

980C \94Can't sell ship...

980D \94Can't build ship...

980E \94Ship in the way

980F \94\80

9810 \94\80 (Orders)

9811 \94\80 (Details)

9812 \98Age: \95\80\98 Running Cost: \95\7f/yr

9813 \98Max. speed: \95\84

9814 \98Profit this year: \95\7f (last year: \7f)

9815 \98Reliability: \95}% \98Breakdowns since last service: \95|

9816 \95\80\98 Built: \95~\98 Value: \95\7f

9817 \98Capacity: \95\80

9818 \94Can't stop/start ship...

9819 \94Can't send ship to depot...

981A \94Unable to find local depot

981B \95Heading for \80 Ship Depot

981C \94Ship | is waiting in depot

981D \98Build ship dock

981E \98Build ship depot (for building and servicing ships)

981F \98Ships - click on ship for information

9820 \98Build new ship

9821 \98Drag ship to here to sell it

9822 \98Centre main view on ship depot location

9823 \98Ships - click on ship for information

9824 \98Build new ships (requires ship depot)

9825 \98Ship selection list - click on ship for information

9826 \98Build the highlighted ship

9827 \98Current ship action - click here to stop/start ship

9828 \98Show ship's orders

9829 \98Centre main view on ship's location

982A \98Send ship to depot

982B \98Show ship details

982C \98\0fNew ship now available!

982D \98\0f\80

982E \98Cost: \7f Max. Speed: \84\0dCapacity: \80\0dRunning Cost: \7f/yr

982F \98Name ship

9830 Ship |

9831 \94Name ship

9832 \94Can't name ship...

9833 \98\0fCitizens celebrate . . .\0dFirst ship arrives at \80!

9834 \98Position buoy,which can be used for additional way points

9835 \94Can't position buoy here...

9836 \98Rename

9837 \98Rename ship type

9838 \94Rename ship type

9839 \94Can't rename ship type...

983A \98Refit cargo ship to carry a different cargo type

983B \94\80 (Refit)

983C \98Refit ship

983D \98Select type of cargo for ship to carry

983E \98Refit ship to carry highlighted cargo type

983F \8aSelect cargo type to carry:-

9840 \98New capacity: \8a\80\0d\98Cost of refit: \8a\7f

9841 \94Can't refit ship...

9842 (refittable)

=A000 Aircraft strings=

A000 \94Airport Construct.

A001 \94Can't build airport here...

A002 \94\80 Aircraft Hangar

A003 \98New Aircraft

A004 \98Information

A005 \94New Aircraft

A006 \98Build Aircraft

A007 \98Cost: \8a\7f\98 Speed: \8a\84\0d\98Capacity: \8a| passengers,| bags of mail\0d\98Running Cost: \8a\7f/yr\0d\98Designed: \8a~\98 Life: \8a| years\0d\98Max. Reliability: \8a}%

A008 \94Can't build aircraft...

A009 \94\80 - Aircraft

A00A \94\80

A00B \94\80 (Orders)

A00C \94\80 (Details)

A00D \98Age: \95\80\98 Running Cost: \95\7f/yr

A00E \98Max. speed: \95\84

A00F \98Profit this year: \95\7f (last year: \7f)

A010 \98Reliability: \95}% \98Breakdowns since last service: \95|

A011 \95\80\98 Built: \95~\98 Value: \95\7f

A012 \94Can't send aircraft to hangar...

A013 \95Heading for \80 Hangar

A014 \94Aircraft | is waiting in the aircraft hangar

A015 \94Aircraft in the way

A016 \94Can't stop/start aircraft...

A017 \94Aircraft is in flight

A018 \94Must build airport first

A019 \98Capacity: \95\80,\80

A01A \98Capacity: \95\80

A01B \94Aircraft must be stopped in hangar

A01C \94Can't sell aircraft...

A01D Airport construction

A01E \98Build airport

A01F \98Aircraft - click on aircraft for information

A020 \98Build new aircraft (requires airport with hangar)

A021 \98Aircraft - click on aircraft for information

A022 \98Build new aircraft

A023 \98Drag aircraft to here to sell it

A024 \98Centre main view on hangar location

A025 \98Aircraft selection list - click on aircraft for information

A026 \98Build the highlighted aircraft

A027 \98Current aircraft action - click here to stop/start aircraft

A028 \98Show aircraft's orders

A029 \98Centre main view on aircraft's location

A02A \98Send aircraft to hangar

A02B \98Show aircraft details

A02C \98\0fNew aircraft now available!

A02D \98\0f\80

A02E \98Cost: \7f Max. Speed: \84\0dCapacity: | passengers,| bags of mail\0dRunning Cost: \7f/yr

A02F Aircraft |

A030 \94Name aircraft

A031 \94Can't name aircraft...

A032 \98Name aircraft

A033 \98\0fCitizens celebrate . . .\0dFirst aircraft arrives at \80!

A034 \98\0fPlane Crash!\0d| die in fireball at \80

A035 \0e\98Destinations:

A036 \0e\98\80

A037 \98Rename

A038 \98Rename aircraft type

A039 \94Rename aircraft type

A03A \94Can't rename aircraft type...

A03B \98Refit aircraft to carry a different cargo type

A03C \94\80 (Refit)

A03D \98Refit aircraft

A03E \98Select type of cargo for aircraft to carry

A03F \98Refit aircraft to carry highlighted cargo type

A040 \8aSelect cargo type to carry:-

A041 \98New capacity: \8a\80\0d\98Cost of refit: \8a\7f

A042 \94Can't refit aircraft...

A043 (refittable)

=A800 Pseudo-vehicle strings=

(None defined)

=B000 Disaster strings=

B000 \98\0fZeppelin disaster at \80!

B001 \98\0fRoad vehicle destroyed in 'UFO' collision!

B002 \98\0fOil refinery explosion near \80!

B003 \98\0fFactory destroyed in suspicious circumstances near \80!

B004 \98\0f'UFO' lands near \80!

B005 \98\0fCoal mine subsidence leaves trail of destruction near \80!

=B800 unused=

=C000 New station names=

This is used for TTDPatch newgrf station and class names. See action 4 for more details.

=C800 New house names=

This is used for TTDPatch newgrf town building names. See action 4 for more details.

=D000 Miscellaneous GRF texts=

This is used for TTDPatch newgrf miscellaneous texts, mostly for callbacks. See action 4 for more details.

The table has up to 1024 entries. To use entry X in an include text (code 81), use ID D400+X. Note that if you want to include ID D000/D400, the 00 byte will be considered the end of string in action 4, this will therefore break if additional texts are supposed to follow in the action 4.

=D800 Persistent GRF texts=

This is used for TTDPatch newgrf persistent texts (the ID mappings are preserved through saving and loading even if the GRF file is unavailable). See action 4 for more details.

D800 class IDs should not be used as include texts.

=E000 Hard-coded game texts=

This text class exists only in TTDPatch 2.0.1 alpha 59 and later. It contains language-dependent texts that didn't have textIDs originally. This class allows translating TTD entirely by using action 4s, since now every language-dependent text can be accessed.

This list contains interspersed comments in parentheses.

(The first 12 elements are the full month names used for dates)

E000 January

E001 February

E002 March

E003 April

E004 May

E005 June

E006 July

E007 August

E008 September

E009 October

E00A November

E00B December

(The following 13 names are used for companies that aren't manually named and can't use "xxx Transport" for some reason)

E00C Bloggs Brothers

E00D Tiny Transport Ltd.

E00E Express Travel

E00F ))Comfy-Coach[[]]Comfy-Coach[[ & Co.

E010 Crush & Bump Ltd.

E011 Broken & Late Ltd.

E012 Sam Speedy & Son

E013 Supersonic Travel

E014 Mike's Motors

E015 Lightning International

E016 Pannik & Loozit Ltd.

E017 ))Inter-City[[]]Inter-City[[ Transport

E018 Getout & Pushit Ltd.

(The following 41 texts are last names to be used for managers of AI companies)

E019 Adams

E01A Allan

E01B Baker

E01C Bigwig

E01D Black

E01E Bloggs

E01F Brown

E020 Campbell

E021 Gordon

E022 Hamilton

E023 Hawthorn

E024 Higgins

E025 Green

E026 Gribble

E027 Jones

E028 ))McAlpine[[]]McAlpine[[

E029 ))MacDonald[[]]MacDonald[[

E02A ))McIntosh[[]]McIntosh[[

E02B Muir

E02C Murphy

E02D Nelson

E02E O'Donnell

E02F Parker

E030 Phillips

E031 Pilkington

E032 Quigley

E033 Sharkey

E034 Thomson

E035 Watkins

(Names above this are used for the first three climates, the following ones are used in toyland only)

E036 Grumpy

E037 Dozy

E038 Speedy

E039 Nosey

E03A Dribble

E03B Mushroom

E03C Cabbage

E03D Sniffle

E03E Fishy

E03F Swindle

E040 Sneaky

E041 Nutkins

(The following two texts must be exactly 19 characters long, and must contain letters that are available as shortened first names of AI company managers like "C. F. Watkins".

The first ID is used for first names, the second is for middle names, but having a middle name has a small chance.)

E042 ABCDEFGHIJKLMNPRSTW

E043 ABCDEFGHIJKLMNPRSTW

(The following two are suffixes shown in the load/save dialog)

E044 .. (Parent Directory)

E045  (Directory)

(Suffix to be used after the manager name to create a company name)

E046  Transport

(Suffix to be used after an English or German town name to create a company name)

E047  Transport

(Suffix to be used after a French, Spanish or silly town name to create a company name)

E048  Transport

(The following three are used for printing liquid amounts and speeds)

E049  litres

E04A kmh-1

E04B mph

(The following suffix is used to make a company name from an AI last name. (e.g. Watkins & Co.))

E04C  & Co.

=E800 News texts=

This is used internally by TTDPatch for its additional news messages.

=F000 unused=

(Unused, but TTD's critical error messages internally have a number in this region, even though they aren't text IDs as such.)

=F800 Internal TTDPatch texts=

This is used internally by TTDPatch for its additional regular strings, i.e. those from ttdpttxt.txt. Since 2.0.1 alpha 59 you may use the following text IDs to change the respective patch strings (before alpha 59, the text IDs changed regularly). For default values, please see ttdpttxt.txt produced by mkpttxt.exe.

In case this list is outdated, you can also see their definitions (including the default strings in all 5 standard languages) by running -+mkpttxt -l <nowiki><nowiki>[langnum]</nowiki></nowiki>+-.

F800 bribetext

F801 bribedesc

F802 bribefailed

F803 headingfor

F804 headingfordepot1

F805 headingfordepot2

F806 headingfordepot3

F807 headingfordepot4

F808 withsignals

F809 wplainsignals

F80A wpresignals

F80B wpresigexits

F80C wprecombined

F80D presigautomatic

F80E presigmanual

F80F pathbasedauto

F810 pathbasedmanual

F811 vehmulttoolow

F812 rchunknotloaded

F813 loadgame

F814 gotodepot

F815 gotodepotonly

F816 gototraindepot

F817 gotoroaddepot

F818 gotoshipdepot

F819 gotoairdepot

F81A routethrough

F81B routenonstopthrough

F81C vehobsolete

F81D cannotcheat

F81E cheatinvalidparm

F81F cheatunknown

F820 cheatobsolete1

F821 cheatobsolete2

F822 nostationhere

F823 managedby1

F824 managedby2

F825 manage

F826 engineinfo1

F827 wagonpower

F828 engineinfo2

F829 wagoninfo

F82A newwagoninfo

F82B wagonspeedlimit

F82C refittableto

F82D refittabletoallbut

F82E refittabletoall

F82F railwaywagon

F830 monorailwagon

F831 maglevwagon

F832 ufodestroyed

F833 rvweightinfo

F834 rvweightpurchasewindow

F835 grfloaderror

F836 toomanysprites

F837 outofmemory

F838 wronggrfversion

F839 toomanyspritestotal

F83A filenotfound

F83B invalidsprite

F83C notttdpatchgrf

F83D grferror

F83E grfwarning

F83F grfneedspatchversion

F840 grfneedsdoswin

F841 grfwantsswitch

F842 grfinvalidparam

F843 grfconflict

F844 grfstatcaption

F845 grfstatapply

F846 grfstatreset

F847 grfinfotext

F848 grflisthint

F849 grfapplyhint

F84A grfresethint

F84B grfstatusmenu

F84C initialgrfsettings

F84D initialgrfsettingshint

F84E grfstatgeninfo1

F84F grfstatgeninfo2

F850 grfstatgeninfo3

F851 grfstatgeninfo4

F852 grfstatmax

F853 elecrailconstitle

F854 elecrailconsmenu

F855 lmilloutoftrees

F856 eurointroduced

These next thirteen text IDs, and the six at F8DD..F8E2 are difficult, if not impossible, to set correctly using action 4. Use [[Action0GeneralVariables|action 0]] instead.

F857 curr_HUF

F858 curr_PLN

F859 curr_ATS

F85A curr_BEF

F85B curr_DKK

F85C curr_FIM

F85D curr_GRD

F85E curr_CHF

F85F curr_NLG

F860 curr_ITL

F861 curr_SEK

F862 curr_RUB

F863 curr_EUR

F864 townlastmonthaccepted

F865 aircraftcleared

F866 zeppelincleared

F867 traincleared

F868 endofsharedorders

F869 resetorders

F86A toggleservice

F86B resethint

F86C servicehint

F86D nosort

F86E sortconsistnum

F86F sortprofit

F870 sortlastprofit

F871 sortage

F872 sortmaxspeed

F873 sortreliability

F874 sortcargo

F875 sortdestination

F876 sorthint

F877 performance

F878 vehiclelost

F879 wrongrailtype

F87A neterror1

F87B neterror2

F87C desynch1

F87D desynch2

F87E refitvehicle

F87F refitcargohint

F880 refitbuttonhint

F881 cantbuildcanalhere

F882 fundprospecting

F883 buildindustry

F884 fundingfailed

F885 cannotfundprospecting

The following 9 TextIDs are used if vehicle message are set to use the vehicle name, not the vehicle number (i.e. if miscmods.usevehnumbernotname is off). They behave in the following manner: If set to an empty string (a single 00 - the default value), the Patch tries to automatically generate each them from one or two original TTD TextIDs. If it is unable to match and replace the string (which is likely to happen with translated strings), it simply displays a string with format "name??".

F886 newtrainindepot - Looks for TextID 8864 in TextID 8814. Equivalent string is "\94\80 is waiting in depot".

F887 newrvindepot - Looks for TextID 902B in TextID 9016. Equivalent string is "\94\80 is waiting in depot".

F888 newshipindepot - Looks for TextID 9830 in TextID 981C. Equivalent string is "\94\80 is waiting in depot".

F889 newaircraftinhangar - Looks for TextID A02F in TextID A014. Equivalent string is "\94\80 is waiting in the aircraft hangar".

F88A newvehold - Generated from TextID 01A0. Equivalent string is "\94\80 is getting old".

F88B newvehveryold - Generated from TextID 01A1. Equivalent string is "\94\80 is getting very old".

F88C newvehveryveryold - Generated from TextID 01A2. Equivalent string is "\94\80 is getting very old and urgently needs replacing".

F88D newvehiclelost - Generated from TextID F878 (vehiclelost). Equivalent string is "\94\80 seems to be lost".

F88E newcantreverse - Generated from TextID F8AE (cantreverse). Equivalent string is "\94\80 needs to reverse but cannot do so safely.".

F88F txtetoolboxmenu

F890 txtetoolbox

F891 txtetoolbox_tsigns

F892 txtetoolbox_tsignstrans

F893 txtetoolbox_tsignsold

F894 txtetoolbox_dsize

F895 txtetoolbox_d8

F896 txtetoolbox_d10

F897 txtetoolbox_d12

F898 txtetoolbox_d14

F899 txtetoolbox_d16

F89A txtetoolbox_d18

F89B txtetoolbox_d20

F89C txtetoolbox_depotalltrash

F89D txtetoolbox_on

F89E txtetoolbox_off

F89F txtetoolbox_saveinsavegame

))F8A0[[]]F8A0[[ txtetoolbox_usedefaultinsave

))F8A1[[]]F8A1[[ txtetoolbox_saveasdefault

))F8A2[[]]F8A2[[ txtetoolbox_resetdefaultsizes

))F8A3[[]]F8A3[[ none

))F8A4[[]]F8A4[[ low

))F8A5[[]]F8A5[[ normal

))F8A6[[]]F8A6[[ high

))F8A7[[]]F8A7[[ defaultstation

))F8A8[[]]F8A8[[ stationnumdefault

))F8A9[[]]F8A9[[ stationclassdefault

F8AA unnamedtownnamestyle

F8AB newshistory

F8AC messagesettings

F8AD messages

F8AE cantreverse

F8AF grflanguage

))F8B0[[]]F8B0[[ sizertooltip

))F8B1[[]]F8B1[[ stickytooltip

))F8B2[[]]F8B2[[ rcw_railway

))F8B3[[]]F8B3[[ rcw_signaltype

))F8B4[[]]F8B4[[ rcw_semaphores

))F8B5[[]]F8B5[[ rcw_lights

))F8B6[[]]F8B6[[ rcw_automatic

))F8B7[[]]F8B7[[ rcw_normal

))F8B8[[]]F8B8[[ rcw_entry

))F8B9[[]]F8B9[[ rcw_exit

F8BA rcw_combo

F8BB rcw_nopbs

F8BC rcw_pbs

F8BD rcw_tracks

F8BE rcw_length

F8BF rcw_drag

))F8C0[[]]F8C0[[ rcw_class

))F8C1[[]]F8C1[[ rcw_type

))F8C2[[]]F8C2[[ rcw_accepts

))F8C3[[]]F8C3[[ outofdynmem

))F8C4[[]]F8C4[[ cantresize

))F8C5[[]]F8C5[[ grftextnotfound

))F8C6[[]]F8C6[[ newindubuildindustry

))F8C7[[]]F8C7[[ newindufundprospecting

))F8C8[[]]F8C8[[ newinduproduces

))F8C9[[]]F8C9[[ toomanyindustries

F8CA newindulist_tooltip

F8CB newinduinfo_tooltip

F8CC newindubuild_tooltip

F8CD newinduprospect_tooltip

F8CE newindu_cargowaiting

F8CF warning_notowns

))F8D0[[]]F8D0[[ localplayer

))F8D1[[]]F8D1[[ remoteplayer

))F8D2[[]]F8D2[[ multiplayer

))F8D3[[]]F8D3[[ multiplayer_tooltip

))F8D4[[]]F8D4[[ patchsnd_dll_notfound

))F8D5[[]]F8D5[[ statistics

))F8D6[[]]F8D6[[ statistics_white

))F8D7[[]]F8D7[[ totalcargo

))F8D8[[]]F8D8[[ landareainfoheight

))F8D9[[]]F8D9[[ txteroadmenu

F8DA txtetramwindowheader

F8DB hotkeylistdos

F8DC hotkeylistwin

These next six text IDs, and the thirteen at F857..F863 are difficult, if not impossible, to set correctly using action 4. Use [[Action0GeneralVariables|action 0]] instead.

F8DD curr_pound

F8DE curr_dollar

F8DF curr_franc

))F8E0[[]]F8E0[[ curr_deutschmark

))F8E1[[]]F8E1[[ curr_yen

))F8E2[[]]F8E2[[ curr_peseta

))F8E3[[]]F8E3[[ shortdateformat

))F8E4[[]]F8E4[[ longdateformat

))F8E5[[]]F8E5[[ txtltwocc

))F8E6[[]]F8E6[[ txtltwoccglb

))F8E7[[]]F8E7[[ txtltwoccstm

))F8E8[[]]F8E8[[ txtltwoccdsl

))F8E9[[]]F8E9[[ txtltwoccelc

F8EA txtltwoccmor

F8EB txtltwoccmgv

F8EC txtltwoccdmu

F8ED txtltwoccemu

F8EE txtltwoccpaw

F8EF txtltwoccfrw

))F8F0[[]]F8F0[[ txtltwoccbus

))F8F1[[]]F8F1[[ txtltwocctrm

))F8F2[[]]F8F2[[ txtltwocctrk

))F8F3[[]]F8F3[[ txtltwoccpsh

))F8F4[[]]F8F4[[ txtltwoccfsh

))F8F5[[]]F8F5[[ txtltwoccsap

))F8F6[[]]F8F6[[ txtltwocclap

))F8F7[[]]F8F7[[ txtltwoccfrp

))F8F8[[]]F8F8[[ txtltwocchel

))F8F9[[]]F8F9[[ txtltwocclr1

F8FA txtltwocclr2

F8FB steepslopes

F8FC landhigherbridgehead

F8FD grfhelpercaption

F8FE grfhelper_displxrelyrel

F8FF textsprite

F900 txtetramstationheader

F901 txtetramdepotheader

F902 statistics_tooltip

F903 conflict_itself

F904 conflict_preexist

F905 grfstatdebug

F906 grfdebughint

F907 grfdebugmsg

F908 firstpasstramarrives

F909 firstfreighttramarrives

The following strings/textIDs are for TTDPatch 2.5 and are different in 2.6:

F90A newgame "New game\00"

F90B newgamewindow "\90Are you sure you want to abandon this game and start a new game?\00"

The following strings/textIDs are '''only''' in TTDPatch 2.6:

F90A airporttype "\98Airport Type\00"

F90B unnamedairporttype "(Unnamed type)\00"

F90C txtclonedepotbutton "\98Clone Train\00"

F90D txtclonetooltip "\98Allows you to clone a train\00"

F90E txtcloneerrortop "\94Cannot clone train consist\00"

F90F txtclonebadcash "\00"

F910 txtcloneerror_company "\94Not a company train\00"

F911 txtcloneerror_unavail "\94Vehicle in consist is not available anymore\00"

F912 txtcloneerror_nothead "\94No engine head at the start of the consist\00"

F913 txtcloneerror_notrail "\94Not a rail vehicle\00"

F914 txtcloneerror_unknown "\94Unknown reason\00"

F915 grfbefore "\94File \"\80\" must be loaded before \80.\00"

F916 grfafter "\94File \"\80\" must be loaded after \80.\00"

F917 tr_trainlen "Number of Train Carriages\00"

F918 tr_maxspeed_kph "Maximum Speed in km/h\00"

F919 tr_curorder "Station of Current Order\00"

F91A tr_curdeporder "Depot of Current Order\00"

F91B tr_totalpower "Total Train Horsepower\00"

F91C tr_totalweight "Total Train Weight\00"

F91D tr_restricttitle "\98Routefinding Restriction\00"

F91E tr_valuebtn "Value\00"

F91F tr_andbtn "And\00"

F920 tr_orbtn "Or\00"

F921 tr_xorbtn "Xor\00"

F922 tr_error1 "\94Error: Too Many Restriction Objects.\00"

F923 tr_siggui_text "\98Routefinding\00"

F924 tr_enternumber "\94Enter Number\00"

F925 tr_copy "\98Copy\00"

F926 tr_share "\98Share\00"

F927 tr_end "-- End of routefinding restriction criteria\80 --\00"

F928 tr_endshare ", shared by \7e signals\00"

F929 tr_landinfotext "restricted\00"

F92A tr_sigval_sw "Signal Status SW\00"

F92B tr_sigval_se "Signal Status SE\00"

F92C tr_sigval_nw "Signal Status NW\00"

F92D tr_sigval_ne "Signal Status NE\00"

F92E tr_sigval_is_green "is green\00"

F92F tr_sigval_is_red "is red\00"

F930 tr_sigval_is_g "G\00"

F931 tr_sigval_is_r "R\00"

F932 tr_maxspeed_mph "Maximum Speed in mph\00"

F933 tr_nextorder "Station of Next Order\00"

F934 tr_lastvisitstation "Last Visited Station\00"

F935 tr_carriescargo "Train Cargo\00"

F936 tr_distancefromsig "Number of tiles from signals\00"

F937 tr_vartxt "Variable\00"

F938 tr_optxt "Op\00"

F939 directoryoverflow "\94Too many folders in listing\00"

F93A trdlg_eq "is\00"

F93B trdlg_neq "is not\00"

F93C tr_nextdeporder "Depot of Next Order\00"

F93D adjsttitle "\94\80 - Adjacent stations\00"

F93E adjstnumstsinrange "\98Number of stations in range found: \85\85\85\7e\00"

F93F adjstnormstmergealgtxt "\98Standard merge to connecting station\00"

F940 adjstnewsttxt "\98Create new station\00"

F941 adjstnewstbuoy "\98Create new standard buoy\00"

F942 adjstnewenhbuoy "\98Create new station buoy\00"

F943 newgame "New game\00"

F944 newgamewindow "\90Are you sure you want to abandon this game and start a new game?\00"

F945 aquaducttext "Aquaduct\00"

F946 headingfordepot1v2 "\95\80 Train Depot\80, \84\00"

F947 headingfordepot2v2 "\95\80 Road Depot\80, \84\00"

F948 headingfordepot3v2 "\95\80 Ship Depot\80, \84\00"

F949 canaltexttip "\98Build Canals and Locks\00"

F94A rivertexttip "\98Build River\00"

F94B aquaducttexttip "\98Build an Aqueduct to overpass a valley\00"

F94C waterconstrwin "\94Water construction\00"

F94D waterconstrtbtip "\98Canal, River and Aqueduct construction\00"

F94E sortname "Name\00"

F94F tr_days_since_last_service "Number of Days Since Last Service\00"

F950 tr_searching_for_depot "Train \80 Currently Searching For Depot\00"

F951 tr_ps_wintitle="\98Signal Programming\00"

F952 tr_ps_gui_text="\98Signal\00"

F953 tr_ps_sigcount_g="No. of green entrance signals\00"

F954 tr_ps_sigcount_go="No. of green one-way entrance signals\00"

F955 tr_ps_sigcount_gt="No. of green two-way entrance signals\00"

F956 tr_ps_sigcount_r="No. of red entrance signals\00"

F957 tr_ps_sigcount_ro="No. of red one-way entrance signals\00"

F958 tr_ps_sigcount_rt="No. of red two-way entrance signals\00"

F959 tr_ps_end="-- End of criteria to set signal to red\80 --\00"

F95A tr_ps_landinfotext="programmed\00"

F95B ne="NE\00"

F95C se="SE\00"

F95D sw="SW\00"

F95E nw="NW\00"

F95F tr_entertileside="Entered side of tile\00"

VariationalAction2/Signals

2007-01-18T10:53:15Z

Jgr:

'''''Variational Action 2 Variables for New Signals'''''

=Variational Action 2 Variables for New Signals=

This is available from 2.6 alpha 0 r1247 onwards.

This type of variational action 2 requires the use of advanced calculations: [[VarAction2Advanced]]

=Inputs:=

===Variable 10:===

||Bit|Meaning

0|Green

1-3|Front facing: 0=SW, 1=NE, 2=NW, 3=SE, 4=E, 5=W, 6=S, 7=N

4-5|Presignals: 0=norm, 1=entrance, 2=exit, 3=combo

6|Semaphore

7|PBS

8|Restricted||

Note: that these are the same bits as would be used to order action5 block type 4.

===Variable 18===

||Bit|Meaning

0-7|~pp~L5 of signal tile

  0: track in X

  1: track in Y

  2: track in N

  3: track in S

  4: track in W

  5: track in E~/pp~

8-15|Low half of L3 of tile, bits 4-7 bitmask of which signals present as shown below, bits 0-3: track type

16-23|~pp~Which signal is currently being drawn, bit index of L3 signal mask:

  * For track in the X direction:

      6:  signal in the SW direction

      7:  signal in the NE direction

  * For track in the Y direction:

      6:  signal in the NW direction

      7:  signal in the SE direction

  * For tracks in the W-E direction:

      4:  signal in the W direction on the track in the S corner

      5:  signal in the E direction on the track in the S corner

      6:  signal in the W direction on the track in the N corner

      7:  signal in the E direction on the track in the N corner

  * For tracks in the N-S direction:

      4:  signal in the S direction on the track in the E corner

      5:  signal in the N direction on the track in the E corner

      6:  signal in the S direction on the track in the W corner

      7:  signal in the N direction on the track in the W corner~/pp~

24-27|Land/Fence type

28-31|Terrain type: 0=normal, 1=desert, 2=rainforest, 4=snow||

===Parameterised var 60===

Parameter is two signed nybble offsets to add to coordinates of tile.

The low nybble is added to the X coordinate (top-right to bottom-left).

The high nybble is added to the Y coordinate (top-left to bottom-right).

The information is retrieved from the tile after the coordinates have been adjusted, starting from the tile which is currently being drawn.

||Bit|Meaning

0-7|L5

8-15|L3 low

16-20|Altitude of tile<<3

21-25|Slope map of tile

26|Tile has same owner

27|Semaphores

28|Tile has same track bits

29|Tile has same slope and altitude

30|Tile has signals

31|Tile is a track tile||

Return value cached in varaction2var 10

=Output=

===Callback return value:===

||Bit|Meaning

0|Use new sprites

1-4|Num sprites, varaction2vars 0x20-2F

5|Use recolour sprite specified in varaction2var 0x30

6|Use ordinary signal sprite number: varaction2var 0x20, (this overrides all other bits)||

===Varaction2var 20-2F value===

||Bit|Meaning

0-12|Sprite offset into action5 block 0E.

13|Add sprite yrel to Y correction for next sprite (sub from 3D Z), (yrel must fit in a signed byte)

14-18|Sprite Y (-3D Z) correction for next sprite, (signed), (added to total)~010~Overall change to 3D Z, (-Y correction), must be positive, else risk of TTD crashing

19-23|Sprite Y (-3D Z) correction for this sprite only, (signed), (not added to total)

24-27|Sprite X correction for next sprite << 1, (signed), (added to total)

28-31|Sprite X correction for this sprite only << 1, (signed), (not added to total)||

---

A generic action 3 feature 0E should be used to reference the action 2.

Callback 0x146 will call this action 3 when a signal is drawn.

Should the GRF not support the type of signal indicated in variable 10, an invalid callback result should be returned. Returning 0 will prevent further new signal GRF files from being queried and will cause the default signal graphics to be used. Returning 0 should only be done to explicitly prevent lower priority new signals GRFs from possibly drawing the signal.

The result to the callback should be returned as a calculation result.

Bits 1-4 of the callback result indicate how many varaction2vars starting from 0x20 will be used to specify sprites, to be drawn. Operator 0E should be used to store the appropriate values in vars 0x20-2F and 30 as appropriate.

Recolour sprites, specifed in varaction2var 0x30 and bit 5 of the callback result are applied for all of the sprites to be drawn.

---

===Example===

[http://tt-forums.net/viewtopic.php?p=529007#529007|Example GRF with NFO, PCX components.]