https://newgrf-specs.tt-wiki.net/api.php?action=feedcontributions&feedformat=atom&user=PikkabirdGRFSpecs - User contributions [en-gb]2026-05-14T09:25:21ZUser contributionsMediaWiki 1.43.8https://newgrf-specs.tt-wiki.net/index.php?title=Action0/Industry_Tiles&diff=5073Action0/Industry Tiles2025-07-19T13:11:58Z<p>Pikkabird: /* Callback flags (0E) */ Added a note for a hidden feature, because I always forget what it's attached to...</p>
<hr />
<div>==Introduction==<br />
<br />
Industry tiles work similarly to town buildings, except that they are not stand-alone; they are always part of an industry.<br />
<br />
Defining industry tiles follows the same schema as houses do: to start using an ID, you first need to define it by setting property 8 for it. If you try to reference an ID (either via action0 or via action3) that isn't defined, your request is ignored, but not reported as an error, either. This means that if you want to conditionally define an ID, all you need to do is skipping the action0 that sets property8, and everything else gets skipped automatically.<br />
<br />
Industry tile IDs are unique within each grf file. The per-GRF ID is specified as a byte, which means no GRF can define more than 256 tile IDs. You should use your industry tile IDs sparingly. [[VariationalAction2/Industry_Tiles#Relative_position_.2843.29| Variational action 2 variable 43]] for industry tiles can help you limiting tile consumption to 2 or 3 per industry. Avoid using tile FFh, so the tileID can be turned into an extended byte (in Action 3) in the distant future without breaking your NewGRF.<br />
<br />
{{ttdp|}} In total, TTDPatch can have up to a total of 256 new industry tile IDs (i.e. old tile types don't count).<br />
<br />
{{ottd|}} OpenTTD can have 512 IDs for all active grf files, but that includes non-overridden original tiles.<br />
<br />
== Properties ==<br />
<br />
{| |-<br />
!Property !![[GRFActionsDetailed|Size]] !!Version !! Description<br />
|-<br />
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 43}}||Substitute building type<br />
|-<br />
|09||B||{{ottdp|0.6|2.5|ttdprev=alpha 43}}||Industry tile override<br />
|-<br />
|0A,0B,0C||W||{{ottdp|0.6|2.5}}||Tile acceptance<br />
|-<br />
|0D||B||{{ottdp|0.6|2.5|ttdprev=alpha 49}}||Land shape flags<br />
|-<br />
|0E||B||{{ottdp|0.6|2.5|ttdprev=alpha 54}}||Callback flags<br />
|-<br />
|0F||W||{{ottdp|0.6|2.5|ttdprev=alpha 54}}||Animation information<br />
|-<br />
|10||B||{{ottdp|0.6|2.5|ttdprev=alpha 54}}||Animation speed.<br />
|-<br />
|11||B||{{ottdp|0.6|2.5|ttdprev=alpha 54}}||Triggers for callback 25<br />
|-<br />
|12||B||{{ottdp|0.6|2.5|ttdprev=beta 2}}||Special flags<br />
|-<br />
|13||V||{{ottdp|1.9|no|ottdrev=e66cec8f}}||Tile acceptance list<br />
|-<br />
|14||W n*W||{{ottdp|15}}||List of badges<br />
|}<br />
<br />
== Description ==<br />
<br />
=== Substitute tile type (08) ===<br />
<br />
This tile type will be used instead of your new one if your definition isn't available for any reason. Valid values are [http://marcin.ttdpatch.net/sv1codec/TTD-locations.html#Class8 00h-AEh]. Assigning this property copies the properties of the old type just like it does with houses.<br />
<br />
If this tile's action 3 appears before this property is set, the action 3 will have no effect.<br />
<br />
=== Industry tile override (09) ===<br />
<br />
Works like the house override property for houses.<br />
<br />
=== Tile acceptance (0A, 0B, 0C) ===<br />
<br />
These three words define what cargoes the tile accepts, and how much of them. The low byte defines the type of the cargo according to the current climate, while the high byte defines the degree of acceptance in 1/8 units. If you don't need all three cargo types, just zero out the high byte of the extra properties.<br />
<br />
{{grfFrom|7}} From GRF version 7 and above, the meaning of the low byte changes: instead of a climate-dependent cargo slot number, you have to give a climate-independent cargo ID. If your GRF has a cargo translation table, then this ID is the index in that table; otherwise, it's the cargo bit. Acceptance of cargoes not currently present will automatically be disabled.<br />
<br />
{{ottdp|1.9|no|ottdrev=e66cec8f}} These properties only support three cargos. Use property 13 instead to list more cargo types. <br />
<br />
=== Land shape flags (0D) ===<br />
<br />
This property defines which slopes the tile can be built on.<br />
<br />
{| |-<br />
!Bit!!Value!!Version!!Meaning<br />
|-<br />
|0||1||{{ottdp|0.6|2.5}}||NW edge cannot be lowered<br />
|-<br />
|1||2||{{ottdp|0.6|2.5}}||NE edge cannot be lowered<br />
|-<br />
|2||4||{{ottdp|0.6|2.5}}||SW edge cannot be lowered<br />
|-<br />
|3||8||{{ottdp|0.6|2.5}}||SE edge cannot be lowered<br />
|-<br />
|4||10||{{ottdp|0.6|2.5}}||Can only be built on flat land<br />
|-<br />
|5||20||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||The tile is allowed on both land and water<br />
|}<br />
<br />
Industry tiles are never built on steep slopes unless [[Callbacks#Custom shape check (2F) |callback 2F]] is enabled, but bits 0..4 are ignored in that case.<br />
<br />
Bit 5 can be used to allow tiles of land industries built on water or vice versa. It effectively disables the land/water check code for the tile. If you need to customize the behavior further, you can use [[Callbacks#Custom shape check (2F) |callback 2F]] to decide what kind of water/land is allowed.<br />
<br />
;'''PLEASE NOTE''': Be careful when setting this property. If you fail to set it correctly, your industry may end up building on a hillside, which is probably not what you want. The easiest way is to set bit 4 for middle tiles, bit 0 for the tiles along the SE edge, bit 1 for those along the SW edge and so on.<br />
<br />
=== Callback flags (0E) ===<br />
<br />
{| |-<br />
!Bit!!value!!version!!meaning<br />
|-<br />
|0||1||{{ottdp| | }}||use [[Callbacks#Next animation frame (1A/26/141/153/158) |callback 26]] to decide the next animation frame<br />
|-<br />
|1||2||{{ottdp| | }}||use [[Callbacks#Length of animation frame (20/27/142/154/15A) |callback 27]] to decide animation speed<br />
|-<br />
|2||4||{{ottdp| |2.5|ttdprev=alpha 55 vcs 3}}||use [[Callbacks#Decide cargo acceptance (2B) |callback 2B]] to decide amount of acceptance<br />
|-<br />
|3||8||{{ottdp| |2.5|ttdprev=alpha 55 vcs 3}}||use [[Callbacks#Get accepted cargo types (2A/2C) |callback 2C]] to decide accepted types<br />
|-<br />
|4||10||{{ottdp| | }}||use [[Callbacks#Custom shape check (2F) |callback 2F]] to check if a slope is suitable<br />
|-<br />
|5||20||{{ottdp| | }}||use [[Callbacks#Decide drawing default foundations (30/14E/150) |callback 30]] to decide if default foundations need to be drawn<br />
|-<br />
|6||40||{{ottdp| |2.5|ttdprev=beta 3}}||use [[Callbacks#Disable autosloping (3C/14F/15D) |callback 3C]] to allow or deny autosloping below the tile<br />
|}<br />
<br />
Please note that [[Callbacks#Animation control (1B/25/140/152/159) |callback 25]] doesn't have a bit here. To use [[Callbacks#Animation control (1B/25/140/152/159) |callback 25]], simply set the wanted bits in property 11 and it will work as intended.<br />
<br />
If bit 4 is set to activate callback 2F, the game will not automatically attempt to level the land around this tile when building a new industry.<br />
<br />
=== Animation information (0F) ===<br />
<br />
The low byte specifies the number of animation frames minus one, so 00 means 1 frame, 01 means 2 frames etc. The maximum number of frames is 256, although you can have some problems if your animation exceeds FD (253) frames. The high byte must be 0 for non-looping animations and 01 for looping animations. Every other value is reserved for future use. In addition, if the whole word contains FFFF, animation is turned off for this tile (this is the default value).<br />
<br />
=== Animation speed (10) ===<br />
<br />
The meaning is the same as for house property 1B, but the lower limit is 0 instead of 2, so the fastest possible animation changes frames every game tick (27ms). The default value is 2.<br />
<br />
=== Triggers for [[Callbacks#Animation control (1B/25/140/152/159) |callback 25]] (11) ===<br />
<br />
Call [[Callbacks#Animation control (1B/25/140/152/159) |callback 25]] when:<br />
<br />
{| |-<br />
!Property bit, var 18 byte 0!!Property value!!Version!!Meaning||Happens on||Var 18 byte 1<br />
|-<br />
|0||1||{{ottdp|0.6|2.5}}||the construction state changes <ref>During normal gameplay called 4 times per tile. During map generation called 1 time.<br>{{ttdp|}} For the first call to happen, you also have to set [[Action0/Industry_Tiles#Animation_information_.280F.29|property 0F]] to some other value than 0xFFFF.</ref>||single tile||{{ottdp|15|no}} First call <ref>Var 18 bit 8 is set, if the callback is called the first time for a new industry. In-game the construction stage will be zero, at map generation and in scenario editor, it will be 3.<br>Other bits of var 18 are reserved, and must be masked.</ref><br />
|-<br />
|1||2||{{ottdp|0.6|2.5}}||the tile is processed in the periodic processing loop||single tile||<br />
|-<br />
|2||4||{{ottdp|0.6|2.5}}||the industry of the tile is processed in the periodic processing loop (synchronized animation)||all tiles||<br />
|-<br />
|3||8||{{ottdp|0.6|2.5}}||the industry of the tile receives input cargo from a station||all tiles||<br />
|-<br />
|4||10||{{ottdp|0.6|2.5|ttdprev=beta 2}}||the industry distributes its output cargo to one of the stations nearby||all tiles||<br />
|}<br />
<references /><br />
<br />
Currently no trigger provides additional information in var 18 bytes 1 to 3.<br />
<br />
=== Special flags (12) ===<br />
<br />
{| |-<br />
!Bit!!Value!!Meaning<br />
|-<br />
|0||1||[[Callbacks#Next animation frame (1A/26/141/153/158) |Callback 26]] needs random bits<br />
|-<br />
|1||2||{{ottdp|1.9|no|ottdrev=e66cec8f}} In addition to the cargotypes set by property 0A..0C and 13, the tile accepts all cargotypes which the industry accepts.<br />
* This considers industry properties 11 and 26 and callback 14B.<br />
* This does not consider industry callback 3D.<br />
* This property adds 8/8 acceptance for the matching cargotypes. You can list negative acceptances (-8/8) in property 13 to exclude specific cargos.<br />
* Tile callback 2C overrides all acceptances including those added by this flag.<br />
|}<br />
<br />
=== Tile acceptance list (13) ===<br />
{{ottdp|1.9|no|ottdrev=e66cec8f}} <br />
<br />
Format:<br />
<numinput> (<cargotype> <acceptance>)*<br />
<br />
{| |-<br />
!Size!!Variable!!Meaning<br />
|-<br />
|B||numinput||Number of (<cargotype> <acceptance>) pairs to follow,<br />
|-<br />
|B||cargotype||Cargotype (from CTT) to accept.<br />
|-<br />
|B||acceptance||Acceptance in 1/8 units. May be negative to negate property 12 bit 1.<br />
|}<br />
<br />
This property defines up to 16 cargotypes, which are accepted by the industry tile.<br />
Use this property instead of property 0A..0C.<br />
<br />
==Example==</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=NML:Vehicles&diff=4842NML:Vehicles2024-08-21T22:28:36Z<p>Pikkabird: /* Train properties */ fixed TE calculation wrt https://github.com/OpenTTD/OpenTTD/pull/6785</p>
<hr />
<div>{{NMLNavPropVarCB}}<br />
==Properties common to all vehicle types==<br />
<br />
{| class="wikitable sortable"<br />
! property<br />
! value range<br />
! available for<br />articulated<br />vehicle<br />
! comment<br />
|-<br />
| <code style="color:green">name</code><br />
| (string)<br />
| yes<br />
| for example <code style="color:darkgreen">string(STR_NAME_HEREFORD_TRAM)</code><br />
|-<br />
| <code style="color:green">climates_available</code><br />
| bitmask(CLIMATE_XXX, CLIMATE_YYY, ...)<br />
| set to <code style="color:green">NO_CLIMATE</code><br />
| <br />
;CLIMATE_TEMPERATE<br />
;CLIMATE_ARCTIC<br />
;CLIMATE_TROPICAL<br />
;CLIMATE_TOYLAND<br />
;NO_CLIMATE<br />
:Vehicle is availble in no climate (e.g. for articulated parts)<br />
;ALL_CLIMATES<br />
:Vehicle is available irrespective of climate<br />
<br />
To make a vehicle available in all climates except toyland you could use: <code style="color:green">ALL_CLIMATES &amp; ~bitmask(CLIMATE_TOYLAND)</code>.<br />
|-<br />
| <code style="color:green">introduction_date</code><br />
| <code style="color:green">date</code>(yyyy,mm,dd)<br />
| no<br />
| Valid range for yyyy is 0 ... 5000000. In TTDPatch, dates after 2044 will be limited to 2044. Unless the engine is introduced within two years after game-start (always 1920 in TTDPatch), a random number of days between 0 and 511 will be added to this.<br />
|-<br />
| <code style="color:green">model_life</code><br />
| 0 ... 254 (years) or <code style="color:green">VEHICLE_NEVER_EXPIRES</code><br />
| no<br />
|<br />
Number of years a model is "supported" by the manufacturer, see [[#Engine life cycle|below]].<br />
|-<br />
| <code style="color:green">retire_early</code><br />
| -128 ... 127 (years)<br />
| no<br />
|<br />
Retire the vehicle (make it unavailable in the purchase menu) this many years before reliability starts dropping, see [[#Engine life cycle|below]]. May be negative.<br />
|-<br />
| <code style="color:green">vehicle_life</code><br />
| 0 ... 255 (years)<br />
| no<br />
| Life length of an individual vehicle, before it is considered too old and in need of replacement.<br />
|-<br />
| <code style="color:green">reliability_decay</code><br />
| 0 ... 255<br />
| no<br />
| Default vehicles use 20. The higher the value the faster reliability decays, the more frequent service is needed. 0 means reliability never decreases if the vehicle is not too old<br />
|-<br />
| <code style="color:green">refittable_cargo_classes</code><br />
|<br />
bit set of [[NML:Cargos#Cargo classes|cargo classes]]<br />
| yes<br />
| for example: <code style="color:darkgreen">bitmask(CC_BULK, CC_COVERED)</code><br />
|-<br />
| <code style="color:green">non_refittable_cargo_classes</code><br />
|<br />
bit set of [[NML:Cargos#Cargo classes|cargo classes]]<br />
| yes<br />
| for example: <code style="color:darkgreen">bitmask(CC_OVERSIZED, CC_SPECIAL)</code><br />
|-<br />
| <code style="color:green">refittable_cargo_types</code><br />
| bit mask of entries into the cargo translation table<br />
| yes<br />
| As of NML 0.3, do not use this. Use cargo_[dis]allow_refit (see below) instead.<br />
|-<br />
| <code style="color:green">cargo_allow_refit</code><br />
| Array of cargo labels from the [[NML:Cargotable|cargotable]]<br />
| Yes<br />
| {{ottdp|1.2|no|ottdrev=r23291}} A list of cargo types to allow refitting to, irrespective of cargo classes. Example: <code style="color:darkgreen">[COAL, IORE]</code><br />
|-<br />
| <code style="color:green">cargo_disallow_refit</code><br />
| Array of cargo labels from the [[NML:Cargotable|cargotable]]<br />
| Yes<br />
| {{ottdp|1.2|no|ottdrev=r23291}} A list of cargo types to disallow refitting to, irrespective of cargo classes. Example: <code style="color:darkgreen">[MAIL]</code><br />
|-<br />
| <code style="color:green">loading_speed</code><br />
| 0 ... 255 (cargo units)<br />
| yes<br />
| Units of cargo loaded per time unit. Default vehicles use 5 for trains and road vehicles, 10 for ships and 20 for aircraft. This amount of cargo is loaded to or unloaded from the vehicle every 40 ticks for trains, every 20 ticks for road vehicles and aircraft and every 10 ticks for ships.<br />
|-<br />
| <code style="color:green">cost_factor</code><br />
| 0 ... 255<br />
| Set to 0<br />
| multiplier to the base purchase cost<br />
|-<br />
| <code style="color:green">running_cost_factor</code><br />
| 0 ... 255<br />
| Set to 0<br />
| multiplier to the base running costs<br />
|-<br />
| <code style="color:green">cargo_age_period</code><br />
| 0 ... 65535<br />
| yes<br />
|<br />
{{ottd|1.2|r22713}} This property specifies after how many ticks cargo is aged. Default value is 185. 74 ticks is equal to 1 day. If set to 0, cargo does not age. Repeated tests have shown that the gameplay effects of this property often do not match the expectations of grf authors. Explaining why requires a detailed understanding of the OpenTTD cargo aging algorithm, and how that works with e.g. different map sizes, vehicle speeds, multi-leg feeder systems, etc. TL;DR avoid using this property unless you absolutely understand the effect it will have.<br />
|-<br />
| <code style="color:green">variant_group</code><br />
| Vehicle ID or alternatively the vehicle numeric ID (0 ... 65535)<br />
| no<br />
|<br />
{{ottd|13}} This property supports grouping vehicles in the purchase menu (also the autoreplace menu). The property value is the ID of another vehicle in the same GRF which will act as the parent for vehicles in the group.<br />
<br />
Groups can also be nested (this is experimental as of December 2022 and may change with testing).<br />
<br />
See also vehicle extra_flags which can influence the behaviour of vehicles in variant groups.<br />
<br />
See also https://github.com/OpenTTD/OpenTTD/pull/10220<br />
|-<br />
| <code style="color:green">extra_flags</code><br />
| bitmask(VEHICLE_FLAG_XXX, ...)<br />
| no<br />
| {{ottd|13}} <br />
;VEHICLE_FLAG_DISABLE_NEW_VEHICLE_MESSAGE<br />
: Disable "New Vehicle" news message for this engine<br />
;VEHICLE_FLAG_DISABLE_EXCLUSIVE_PREVIEW<br />
: Disable "Exclusive Preview" for this engine<br />
;VEHICLE_FLAG_SYNC_VARIANT_EXCLUSIVE_PREVIEW<br />
: Variants - Include this variant when primary engine has "Exclusive Preview"<br />
;VEHICLE_FLAG_SYNC_VARIANT_RELIABILITY<br />
: Variants - (Attempt to) Synchronize reliability the primary engine.<br />
|}<br />
<br />
===Refittability===<br />
<br />
To determine whether your vehicle can be refitted to a certain cargo, OpenTTD uses the following table<br />
<br />
{| class="t"<br />
! Cargo matches refittable_cargo_classes<br />
! Cargo matches non_refittable_cargo_classes<br />
! Cargo in cargo_allow_refit<br />
! Cargo in cargo_disallow_refit<br />
! Result<br />
|-<br />
| Yes<br />
| No<br />
| Doesn't matter<br />
| No<br />
| Refittable<br />
|-<br />
| No<br />
| Doesn't matter<br />
| No<br />
| Doesn't matter<br />
| Not refittable<br />
|-<br />
| Doesn't matter<br />
| Doesn't matter<br />
| Yes<br />
| No<br />
| Refittable<br />
|-<br />
| Doesn't matter<br />
| Doesn't matter<br />
| Doesn't matter<br />
| Yes<br />
| Not refittable<br />
|}<br />
<br />
For those that prefer boolean logic, the formula is as follows:<br />
<br />
refittable = ((cargo classes in refittable_cargo_classes AND NOT cargo classes in non_refittable_cargo_classes) OR cargo in cargo_allow_refit) AND NOT (cargo in cargo_disallow_refit)<br />
<br />
In general, you should use refittable_cargo_classes and non_refittable_cargo_classes to decide to which cargos your vehicle is refittable, and only then use cargo_allow_refit and cargo_disallow_refit to allow/disallow specific cargos.<br />
<br />
===Engine life cycle===<br />
<br />
The life cycle of a vehicle model consists of three phases, as outlined in the following table. The length of each phase and the starting, peak, and final reliabilities are randomized for each engine when starting a new game. Also note that phase 2 (the vehicle's peak performance) is actually about 8 years shorter than the <code style="color:darkgreen">model_life</code> parameter.<br />
<br />
{| class="t"<br />
! phase<br />
! duration<br />
! reliability<br />
|-<br />
| 1<br />
| 7 to 38 months<br />
| increases from 48-73% to 75-100%<br />
|-<br />
| 2<br />
| <code style="color:darkgreen">model_life</code> - 8 years + (0 to 15 months)<br />
| stays constant at peak, 75-100%<br />
|-<br />
| 3<br />
| 10 to 20.6 years<br />
| decreases from peak to 25-50%<br />
|}<br />
<br />
If <code style="color:darkgreen">model_life</code> is set to <code style="color:darkgreen">VEHICLE_NEVER_EXPIRES</code>, the engine remains in phase 2 forever.<br />
<br />
Normally, the vehicle is removed from the purchase menu at the and of phase 3. However if you set the <code style="color:darkgreen">retire_early</code> property, it will be retired this many years before (or after, if the value is negative) the end of phase 2.<br />
<br />
==Train properties==<br />
<br />
{| class="wikitable sortable"<br />
! property<br />
! value range<br />
! available for<br />articulated<br />vehicle<br />
! comment<br />
|-<br />
| <code style="color:green">sprite_id</code><br />
| <code style="color:green">SPRITE_ID_NEW_TRAIN</code><br />
| yes<br />
| Set this property to enable new graphics<br />
|-<br />
| <code style="color:green">speed</code><br />
| 0 ... 65000 (float, speed units)<br />
| no<br />
| Max speed for engines, speed limit for wagons<br />
|-<br />
| <code style="color:green">misc_flags</code><br />
| bitmask(TRAIN_FLAG_XXX, ...)<br />
| FLIP should not be set, TILT and MU TO the same value as the 1st part<br />
| <br />
;TRAIN_FLAG_TILT<br />
: enable the tilt bonus (20% speed in curves, if all vehicles in consist have it set). See also curve_speed_mod property.<br />
;TRAIN_FLAG_2CC<br />
:Enable use of the 2nd company colour<br />
;TRAIN_FLAG_MU<br />
:act as multiple unit (used for livery selection only)<br />
;TRAIN_FLAG_FLIP<br />
:Allow vehicle to be flipped (reversed) in depot. {{ottdp|13|no|no}} this flag is no longer required, flip is always allowed, except for multi-header or articulated vehicles which cannot be flipped. For vehicles shorter than 8/8, see [[Action0/Vehicles/Trains#cite_note-6|this note about sprite offsets]]<br />
;TRAIN_FLAG_AUTOREFIT<br />
:Allow autoreffitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.<br />
;TRAIN_FLAG_NO_BREAKDOWN_SMOKE<br />
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect<br />
;TRAIN_FLAG_SPRITE_STACK<br />
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]].<br />
|-<br />
| <code style="color:green">refit_cost</code><br />
| 0 ... 255<br />
| yes<br />
| in 50% units of the purchase price cost base<br />
|-<br />
| <code style="color:green">callback_flags</code><br />
| bitmask(VEH_CBF_XXX, ...)<br />
| yes<br />
|<br />
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].<br />
|-<br />
| <code style="color:green">track_type</code><br />
| item from railtypetable<br />
| must be the same as front<br />
| Default railtype table: RAIL, MONO, MGLV. If you install a railtypetable yourself you'll always get the railtype you specified. If you want a vehicle to run on electric rail and you don't have a railtypetable, set <code style="color:green">track_type</code> to RAIL and make sure that you set <code style="color:green">engine_class</code> to <code style="color:green">ENGINE_CLASS_ELECTRIC</code>.<br />
|-<br />
| <code style="color:green">ai_special_flag</code><br />
| [<code style="color:green">AI_FLAG_PASSENGER</code> <nowiki>|</nowiki> <code style="color:green">AI_FLAG_CARGO</code>]<br />
| no<br />
| <br />
;<code style="color:green">AI_FLAG_PASSENGER</code><br />
:Tell computer players that it's an engine that should only be used for passenger service.<br />
|-<br />
| <code style="color:green">power</code><br />
| 0 ... 65000 hp (float, power units)<br />
| Set to 0<br />
|<br />
|-<br />
| <code style="color:green">running_cost_base</code><br />
| RUNNING_COST_XXX<br />
| Set to RUNNING_COST_NONE<br />
| <br />
;RUNNING_COST_STEAM<br />
;RUNNING_COST_DIESEL<br />
;RUNNING_COST_ELECTRIC<br />
;RUNNING_COST_ROADVEH<br />
;RUNNING_COST_NONE<br />
:no running costs<br />
|-<br />
| <code style="color:green">dual_headed</code><br />
| [0 <nowiki>|</nowiki> 1]<br />
| Set to 0 for all parts of an articulated vehicle<br />
| 1 = dual_headed, otherwise normal engine<br />
|-<br />
| <code style="color:green">default_cargo_type</code><br />
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE<br />
| Yes<br />
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).<br />
|-<br />
| <code style="color:green">cargo_capacity</code><br />
| 0 .. 255<br />
| yes<br />
| By default, passenger capacity is 4x, and mail/goods capacity 2x larger than capacity for other cargoes. The capacity set here is used for the default (i.e. first refittable) cargo. Use the <code style="color:green">cargo_capacity</code> callback to avoid this effect.<br />
|-<br />
| <code style="color:green">weight</code><br />
| 0 .. 1279 ton (float, mass units)<br />
| Set to 0<br />
|<br />
|-<br />
| <code style="color:green">ai_engine_rank</code><br />
| 0 ... 255<br />
| no<br />
| TTDPatch only: Higher values make the engine for the TTDPatch AI more attractive<br />
|-<br />
| <code style="color:green">engine_class</code><br />
| ENGINE_CLASS_XXX<br />
| no<br />
| <br />
Defines which livery colour settings apply to the vehicle. It also sets the corresponding sound effect of the engine, and if visual_effect_and_powered is not set, the visual effect as well.<br />
;ENGINE_CLASS_STEAM<br />
;ENGINE_CLASS_DIESEL<br />
;ENGINE_CLASS_ELECTRIC<br />
;ENGINE_CLASS_MONORAIL<br />
;ENGINE_CLASS_MAGLEV<br />
|-<br />
| <code style="color:green">extra_power_per_wagon</code><br />
| 0 ... 65000 hp (float, power units)<br />
| Set to 0<br />
| Only wagons with a livery override for this engine will add power<br />
|-<br />
| <code style="color:green">tractive_effort_coefficient</code><br />
| 0 ... 1 (float)<br />
| Set to 0<br />
| Fraction of the vehicle weight that is available as tractive effort. Tractive effort (in kN) is calculated as (TE coefficient) * 9.8 * weight (in tons), with 9.8 being an approximation of the acceleration of gravity (9.81 m/s).<br />
|-<br />
| <code style="color:green">air_drag_coefficient</code><br />
| 0 ... 1 (float)<br />
| Set to 0<br />
| Coefficient of the relative air drag, in arbitrary units. The default value is approximately (8 / max_speed), with max_speed in km/h, clamped to the range 0.004 .. 0.75.<br />
|-<br />
| <code style="color:green">length</code><br />
| 1 ... 8<br />
| yes<br />
| Length of the vehicle in arbitrary units. Use a value of 8 (equal to the predefined constant VEHICLE_LENGTH) for a full-length vehicle.<br />
|-<br />
| <code style="color:green">visual_effect_and_powered</code><br />
| <code style="color:green">visual_effect_and_powered</code> (VISUAL_EFFECT_XXX, offset, <code style="color:green">ENABLE_WAGON_POWER</code> or <code style="color:green">DISABLE_WAGON_POWER</code>)<br />
| yes<br />
|<br />
There are two methods to set the visual effect of a vehicle:<br />
* <code style="color:green">visual_effect_and_powered</code>: Easy method for simple effects.<br />
* <code style="color:green">effect_spawn_model_and_powered</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.<br />
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.<br />
<br />
Set the type of visual effect for the vehicle and its positional offset with respect to the vehicle. An offset of 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.<br />
<br />
;VISUAL_EFFECT_DEFAULT<br />
:No effect, unless for the default vehicles<br />
;VISUAL_EFFECT_STEAM<br />
:Steam like from steam engine<br />
;VISUAL_EFFECT_DIESEL<br />
:Steam from internal combustion engine<br />
;VISUAL_EFFECT_ELECTRIC<br />
:Electric sparks<br />
;VISUAL_EFFECT_DISABLE<br />
:No effect<br />
|-<br />
| <code style="color:green">effect_spawn_model_and_powered</code><br />
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code> or <code style="color:green">EFFECT_SPAWN_MODEL_XXX <nowiki>|</nowiki> ENABLE_WAGON_POWER</code><br />
| yes<br />
|<br />
There are two methods to set the visual effect of a vehicle:<br />
* <code style="color:green">visual_effect_and_powered</code>: Easy method for simple effects.<br />
* <code style="color:green">effect_spawn_model_and_powered</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.<br />
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.<br />
<br />
{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.<br />
The visual appearance itself is defined by the callback 'create_effect'.<br />
<br />
;EFFECT_SPAWN_MODEL_NONE<br />
: Do not spawn any effects.<br />
;EFFECT_SPAWN_MODEL_STEAM<br />
: Gradually less effects when approaching max speed.<br />
;EFFECT_SPAWN_MODEL_DIESEL<br />
: Effect proportional to acceleration, no effect when idling at top speed.<br />
;EFFECT_SPAWN_MODEL_ELECTRIC<br />
: Random effect, gradually less likely when approaching max speed.<br />
|-<br />
| <code style="color:green">extra_weight_per_wagon</code><br />
| 0 ... 255 ton (float, mass units)<br />
| Set to 0<br />
| Adds extra weight for powered wagons, see <code style="color:green">extra_power_per_wagon</code><br />
|-<br />
| <span #id="bitmask_vehicle_info"></span><code style="color:green">bitmask_vehicle_info</code><br />
| 8-bit bitmask<br />
| yes<br />
|<br />
Used for obtaining [[#bitmask consist info|<code style="color:green">bitmask_consist_info</code>]]<br />
|-<br />
| <code style="color:green">curve_speed_mod</code><br />
| -128 ... 127.996 (float)<br />
| yes<br />
| {{nml|0.7}} {{ottd|12.0}} Maximum curve speed modifier.<br />
<br />
The modifier is applied after the normal curve speed calculation is done using the formula max_curve_speed * (1 + curve_speed_mod). This means that the default property value of 0 is equivalent to no change. Negative values are supported, but the resulting vehicle curve speed is clamped at 2 mph-ish to make sure vehicles don't become permanently stuck.<br />
<br />
If different vehicles in a train have different curve speed modifiers, the lowest value wins.<br />
<br />
See also TRAIN_FLAG_TILT, which is an older and less flexible way of managing vehicle curve speed.<br />
|}<br />
<br />
==Road vehicle properties==<br />
<br />
{| class="wikitable sortable"<br />
! property<br />
! value range<br />
! available for<br />articulated<br />vehicle<br />
! comment<br />
|-<br />
| sprite_id<br />
| SPRITE_ID_NEW_ROADVEH<br />
| yes<br />
| Set this property to enable new graphics<br />
|-<br />
| speed<br />
| 0 ... 511km/h (float, speed units)<br />
| no<br />
|<br />
|-<br />
| road_type ''or'' tram_type <br />
| item from [[NML:Railtypetable-Roadtypetable-Tramtypetable|roadtypetable]] or [[NML:Railtypetable-Roadtypetable-Tramtypetable|tramtypetable]]<br />
| must be the same as front<br />
| Only ''one'' of these properties may be set. <br />
If <code style="color:green">tram_type</code> is set, <code style="color:green">ROADVEH_FLAG_TRAM</code> must also be set for the vehicle in <code style="color:green">misc_flags</code>.<br />
<br />
If not set, road vehicles will default to ROAD and tram vehicles will default to RAIL (this does not overlap with railtype RAIL).<br />
|-<br />
| misc_flags<br />
| bitmask(ROADVEH_FLAG_XXX, ...)<br />
| partly; tram flag must the same<br />
| <br />
;ROADVEH_FLAG_TRAM<br />
:The vehicle requires tram tracks to run on<br />
;ROADVEH_FLAG_2CC<br />
:Enable 2nd company colour<br />
;ROADVEH_FLAG_AUTOREFIT<br />
:Allow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.<br />
;ROADVEH_FLAG_NO_BREAKDOWN_SMOKE<br />
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect<br />
;ROADVEH_FLAG_SPRITE_STACK<br />
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]].<br />
|-<br />
| refit_cost<br />
| 0 ... 255<br />
| yes<br />
| in 25% units of the purchase price cost base<br />
|-<br />
| callback_flags<br />
| bitmask(VEH_CBF_XXX, ...)<br />
| yes<br />
|<br />
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].<br />
|-<br />
| running_cost_base<br />
| RUNNING_COST_XXX<br />
| set to RUNNING_COST_NONE<br />
| <br />
;RUNNING_COST_STEAM<br />
;RUNNING_COST_DIESEL<br />
;RUNNING_COST_ELECTRIC<br />
;RUNNING_COST_ROADVEH<br />
;RUNNING_COST_NONE<br />
:no running costs<br />
|-<br />
| power<br />
| 0 ... 2550hp (float, power units)<br />
| Set to 0<br />
|<br />
|-<br />
| weight<br />
| 0 ... 63.75ton (float, mass units)<br />
| Set to 0<br />
|<br />
|-<br />
| tractive_effort_coefficient<br />
| 0 ... 1 (float)<br />
| Set to 0<br />
| Fraction of the vehicle weight that is available as tractive effort. Tractive effort (in kN) is calculated as (TE coefficient) * 10 * weight (in tons), with 10 being an approximation of the acceleration of gravity (9.81 m/s). Default value is 0.3.<br />
|-<br />
| air_drag_coefficient<br />
| 0 ... 1 (float)<br />
| Set to 0<br />
| Coefficient of the relative air drag, in arbitrary units. The default value is approximately (8 / max_speed), with max_speed in km/h, clamped to the range 0.004 .. 0.75.<br />
|-<br />
| <code style="color:green">default_cargo_type</code><br />
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE<br />
| Yes<br />
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).<br />
|-<br />
| cargo_capacity<br />
| 0 ... 255<br />
| yes<br />
| By default, passenger capacity is 4x, and mail/goods capacity 2x larger than capacity for other cargoes. The capacity set here is used for the default (i.e. first refittable) cargo. Use the <code style="color:green">cargo_capacity</code> callback to avoid this effect.<br />
|-<br />
| sound_effect<br />
| SOUND_XXX<br />
| no<br />
|<br />
See available [[NML:List of sound effects|sound effects]].<br />
<br/>{{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also <code style="color:green">sound("sound.wav")</code> and <code style="color:green">import_sound(grfid, number)</code> are valid here.<br />
|-<br />
| visual_effect<br />
| visual_effect( VISUAL_EFFECT_XXX, offset)<br />
| yes<br />
| <br />
There are two methods to set the visual effect of a vehicle:<br />
* <code style="color:green">visual_effect</code>: Easy method for simple effects.<br />
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.<br />
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.<br />
<br />
Set the type of visual effect for the vehicle and its positional offset with respect to the vehicle. An offset of 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.<br />
<br />
;VISUAL_EFFECT_DEFAULT<br />
:No effect, unless for the default vehicles<br />
;VISUAL_EFFECT_STEAM<br />
:Steam like from steam engine<br />
;VISUAL_EFFECT_DIESEL<br />
:Steam from internal combustion engine<br />
;VISUAL_EFFECT_ELECTRIC<br />
:Electric sparks<br />
;VISUAL_EFFECT_DISABLE<br />
:No effect<br />
|-<br />
| <code style="color:green">effect_spawn_model</code><br />
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code><br />
| yes<br />
|<br />
There are two methods to set the visual effect of a vehicle:<br />
* <code style="color:green">visual_effect</code>: Easy method for simple effects.<br />
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.<br />
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.<br />
<br />
{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.<br />
The visual appearance itself is defined by the callback 'create_effect'.<br />
<br />
;EFFECT_SPAWN_MODEL_NONE<br />
: Do not spawn any effects.<br />
;EFFECT_SPAWN_MODEL_STEAM<br />
: Gradually less effects when approaching max speed.<br />
;EFFECT_SPAWN_MODEL_DIESEL<br />
: Effect proportional to acceleration, no effect when idling at top speed.<br />
;EFFECT_SPAWN_MODEL_ELECTRIC<br />
: Random effect, gradually less likely when approaching max speed.<br />
|-<br />
| length<br />
| 1 ... 8<br />
| yes<br />
| Length of the vehicle in arbitrary units. Use a value of 8 (equal to the predefined constant VEHICLE_LENGTH) for a full-length vehicle.<br />
|}<br />
<br />
==Ship properties==<br />
<br />
{| class="wikitable sortable"<br />
! property<br />
! value range<br />
! comment<br />
|-<br />
| sprite_id<br />
| SPRITE_ID_NEW_SHIP<br />
| Set this property to enable new graphics<br />
|-<br />
| speed<br />
| 0 ... 127 km/h (float, speed units)<br />
| {{ottd|14}}{{nml|7.5}} 0 .. 32767 km/h (float, speed units)<br />
|-<br />
| misc_flags<br />
| bitmask(SHIP_FLAG_XXX)<br />
| Bitmask with to possible flags, set to 0 to disable all. <br />
<br />
;SHIP_FLAG_2CC<br />
:Enable use of the 2nd company colour<br />
;SHIP_FLAG_AUTOREFIT<br />
:llow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.<br />
;SHIP_FLAG_NO_BREAKDOWN_SMOKE<br />
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect<br />
;SHIP_FLAG_SPRITE_STACK<br />
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]].<br />
|-<br />
| refit_cost<br />
| 0 ... 255<br />
| in 1/32 of the default refit cost base<br />
|-<br />
| callback_flags<br />
| bitmask(VEH_CBF_XXX, ...)<br />
|<br />
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].<br />
|-<br />
| is_refittable<br />
| [0 <nowiki>|</nowiki> 1]<br />
| 0=false, 1=true. Note: if you do not set this property to 1, then refittable_cargo_classes / non_refittable_cargo_classes have no effect.<br />
|-<br />
| <code style="color:green">default_cargo_type</code><br />
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE<br />
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).<br />
|-<br />
| cargo_capacity<br />
| 0 ... 255<br />
| For ships (unlike other vehicle types) the capacity set here is not affected by the cargo type.<br />
|-<br />
| sound_effect<br />
| SOUND_XXX<br />
|<br />
See available [[NML:List of sound effects|sound effects]].<br />
<br/>{{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also <code style="color:green">sound("sound.wav")</code> and <code style="color:green">import_sound(grfid, number)</code> are valid here.<br />
|-<br />
| ocean_speed_fraction<br />
| 0 ... 1 (float)<br />
|<br />
{{ottd|1.2|r22639}} fraction of base speed on ocean tiles (default: 1)<br />
|-<br />
| canal_speed_fraction<br />
| 0 ... 1 (float)<br />
|<br />
{{ottd|1.2|r22639}} fraction of base speed on canal tiles (default: 1)<br />
|-<br />
| visual_effect<br />
| visual_effect(VISUAL_EFFECT_XXX, offset)<br />
|<br />
There are two methods to set the visual effect of a vehicle:<br />
* <code style="color:green">visual_effect</code>: Easy method for simple effects.<br />
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.<br />
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.<br />
<br />
XXX=[DEFAULT <nowiki>|</nowiki> STEAM <nowiki>|</nowiki> DIESEL <nowiki>|</nowiki> ELECTRIC <nowiki>|</nowiki> DISABLE], it is the type of the visual effect you want for this ship. Default means no effect. Offset is the position of the effect. 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.<br />
|-<br />
| <code style="color:green">effect_spawn_model</code><br />
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code><br />
|<br />
There are two methods to set the visual effect of a vehicle:<br />
* <code style="color:green">visual_effect</code>: Easy method for simple effects.<br />
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.<br />
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.<br />
<br />
{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.<br />
The visual appearance itself is defined by the callback 'create_effect'.<br />
<br />
;EFFECT_SPAWN_MODEL_NONE<br />
: Do not spawn any effects.<br />
;EFFECT_SPAWN_MODEL_STEAM<br />
: Gradually less effects when approaching max speed.<br />
;EFFECT_SPAWN_MODEL_DIESEL<br />
: Effect proportional to acceleration, no effect when idling at top speed.<br />
;EFFECT_SPAWN_MODEL_ELECTRIC<br />
: Random effect, gradually less likely when approaching max speed.<br />
|-<br />
| acceleration<br />
| 1 ... 255<br />
| {{ottd|14}} Acceleration in units of ~0.5 km/h per tick. 1 is the default and is the acceleration of default ships.<br />
|}<br />
<br />
==Aircraft properties==<br />
<br />
{| class="wikitable sortable"<br />
! property<br />
! value range<br />
! comment<br />
|-<br />
| sprite_id<br />
| SPRITE_ID_NEW_AIRCRAFT<br />
| Set this property to enable new graphics<br />
|-<br />
| speed<br />
| 0 .. 3280 km/h (float, speed units)<br />
|<br />
|-<br />
| range<br />
| 0 .. 2894<br />
| {{nml|0.3}} {{ottdp|1.2|no|ottdrev=r23504}} Maximum (euclidean) distance the aircraft can cover between two airports. Set to 0 for unlimited range.<br />
|-<br />
| misc_flags<br />
| bitmask(AIRCRAFT_FLAG_2CC, AIRCRAFT_FLAG_AUTOREFIT)<br />
| Bitmask with to possible flags, set to 0 to disable all. <br />
<br />
;AIRCRAFT_FLAG_2CC<br />
:Enable 2nd company colour<br />
;AIRCRAFT_FLAG_AUTOREFIT<br />
:Allow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.<br />
;AIRCRAFT_FLAG_NO_BREAKDOWN_SMOKE<br />
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect<br />
;AIRCRAFT_FLAG_SPRITE_STACK<br />
:{{ottdp|1.7|no|ottdrev=r27668}} Enable [[NML:Vehicles#Composing_vehicles_from_multiple_sprites|composition from multiple sprites]]. This also affects custom rotor sprites.<br />
|-<br />
| refit_cost<br />
| 0 ... 255<br />
| in 1/32 of default refit cost base<br />
|-<br />
| callback_flags<br />
| bitmask(VEH_CBF_XXX, ...)<br />
|<br />
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].<br />
|-<br />
| aircraft_type<br />
| AIRCRAFT_TYPE_XXX<br />
| <br />
;AIRCRAFT_TYPE_HELICOPTER<br />
:Can land on helipad<br />
;AIRCRAFT_TYPE_SMALL<br />
:Can land on all airports with runway<br />
;AIRCRAFT_TYPE_LARGE<br />
:Can land on all airports with runway. But have a high crash chance on small airports<br />
|-<br />
| acceleration<br />
| {{ottd|1.3.1}} 0 ... 255 <br/> {{ottd|&lt;1.3.1}} 0 ... 19<br />
| {{ottd|1.3.1}} Default aircraft use values in the range 18 to 50 (= 6.75 to 18.75 mph/tick = 499.5 to 1387.5 mph/day), which is generally considered quite fast.<br/><br />
{{ottd|&lt;1.3.1}} In older OpenTTD, aircraft provided by NewGRF accelerate 166% faster than intended.<br />
|-<br />
| passenger_capacity<br />
| 0 ... 65536<br />
| Capacity for the passenger compartment. See also the notes at <code style="color:darkgreen">mail_capacity</code> below.<br />
|-<br />
| mail_capacity<br />
| 0 ... 255<br />
| Capacity for the mail compartment, if refitted to a cargo in the CC_PASSENGERS class. When refitted to other cargoes, this capacity is added to the passenger capacity to determine the base capacity. The actual capacity is set to this base capacity divided by 1 for mail, 2 for goods and 4 for all other cargoes. To override this effect, use the <code style="color:darkgreen">passenger_capacity</code> and <code style="color:darkgreen">mail_capacity</code> callbacks.<br />
|-<br />
| sound_effect<br />
| SOUND_XXX<br />
|<br />
See available [[NML:List of sound effects|sound effects]].<br />
<br/>{{ottdp|1.6|no|ottdrev=r27507}} Since OpenTTD r27507 also <code style="color:green">sound("sound.wav")</code> and <code style="color:green">import_sound(grfid, number)</code> are valid here.<br />
|}<br />
<br />
==Vehicle variables==<br />
<br />
Below an overview of all vehicle-specific variables. Note that in the purchase list, the vehicle is not built yet and as such many variables are not available. All general variables are available, refer to the table for info on vehicle-specific variables. Trying to access a non-available variable invokes undefined behaviour. Please note that while all variables are available for all vehicles types, some of them only make sense for one or more vehicle types. For example checking current_railtype for a non-rail vehicle doesn't make sense at all, similarly checking current_roadtype for a tram won't return a useful result.<br />
<br />
===Variables without parameter===<br />
<br />
{| class="wikitable sortable"<br />
! name<br />
! value range<br />
! available in<br />purchase list?<br />
! comment<br />
|-<br />
| position_in_consist<br />
| 0 ... 255<br />
| No<br />
| The position of the current vehicle-part from the start of the vehicle. The engine will get value 0, the first wagon (or second engine) gets value 1, etc.<br />
|-<br />
| position_in_consist_from_end<br />
| 0 ... 255<br />
| No<br />
| Same as position_in_consist but counted from the end. The last wagon will get value 0.<br />
|-<br />
| num_vehs_in_consist<br />
| 1 ... 256<br />
| No<br />
| The total number of vehicles-parts in this vehicle. For aircraft this will include the shadow and the rotor.<br />
|-<br />
| position_in_vehid_chain<br />
| 0 ... 255<br />
| No<br />
| See position_in_consist, but not of the complete vehicle but only all consecutive parts with the same id.<br />
|-<br />
| position_in_vehid_chain_from_end<br />
| 0 ... 255<br />
| No<br />
| See position_in_consist_from_end, but not of the complete vehicle but only all consecutive parts with the same id.<br />
|-<br />
| num_vehs_in_vehid_chain<br />
| 1 ... 256<br />
| No<br />
| See num_vehs_in_consist, but not of the complete vehicle but only all consecutive parts with the same id.<br />
|-<br />
| position_in_articulated_veh<br />
| 0 ... 255<br />
| No<br />
| {{nml|0.3}} {{ottdp|1.4|no|ottdrev=r26157}} The position of the current articulated vehicle from the start of the vehicle. The first will get value 0, the second one gets value 1, etc.<br />
|-<br />
| position_in_articulated_veh_from_end<br />
| 0 ... 255<br />
| No<br />
| {{nml|0.3}} {{ottdp|1.4|no|ottdrev=r26157}} The position of the current articulated vehicle from the end of the vehicle. The last will get value 0, the second last one gets value 1, etc.<br />
|-<br />
| cargo_classes_in_consist<br />
| Bitmask of CC_XXX<br />
| No<br />
|<br />
[[NML:Cargos#Cargo classes|cargo classes]]<br />
|-<br />
| most_common_cargo_type<br />
|<br />
[[NML:Cargos#Cargo properties|Cargo label]]<br />
| No<br />
| The most common cargo type in the consist. Prior to nml r2320 this was known as most_common_refit, and didn't work, and was also incorrectly documented :)<br />
|-<br />
| most_common_cargo_subtype<br />
| 0 ... 255<br />
| No<br />
| The most common cargo subtype for most_common_cargo_type<br />
|-<br />
| bitmask_consist_info<br />
| Bitmask 8 bit<br />
| No<br />
|<br />
Binary OR of the values of [[#bitmask vehicle info|bitmask_vehicle_info]] of all vehicles (engines, wagons) in the consist. Only available for rail vehicles.<br />
|-<br />
| company_num<br />
| 0 ... 14<br />
| Yes<br />
| company number of the vehicle owner. TTDPatch only supports up to 8 companies (0 ... 7)<br />
|-<br />
| company_type<br />
| PLAYERTYPE_XX<br />
| Yes<br />
| <br />
;PLAYERTYPE_HUMAN<br />
:human player<br />
;PLAYERTYPE_AI<br />
:AI player<br />
;PLAYERTYPE_HUMAN_IN_AI<br />
:human managing AI company<br />
;PLAYERTYPE_AI_IN_HUMAN<br />
:AI managing human company<br />
<br />
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.<br />
|-<br />
| company_colour1<br />
| COLOUR_XXX<br />
| Yes<br />
|<br />
Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.<br />
|-<br />
| company_colour2<br />
| COLOUR_XXX<br />
| Yes<br />
|<br />
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.<br />
|-<br />
| aircraft_height<br />
| 0 ... 255<br />
| No<br />
| Height difference between the aircraft and its shadow. 8 Units are equivalent to one height level on the map.<br />
|-<br />
| airport_type<br />
| AIRPORTTYPE_XX<br />
| No<br />
| <br />
;AIRPORTTYPE_SMALL<br />
;AIRPORTTYPE_LARGE<br />
;AIRPORTTYPE_HELIPORT<br />
;AIRPORTTYPE_OILRIG<br />
|-<br />
| curv_info_prev_cur<br />
| -2 ... 2<br />
| No<br />
| Difference in direction between the previous (towards engine) vehicle and this vehicle. Curvature to the right is positive. 1 unit is 45 degrees.<br />
|-<br />
| curv_info_cur_next<br />
| -2 ... 2<br />
| No<br />
| Difference in direction between this vehicle and the next (towards rear end) vehicle. Curvature to the right is positive. 1 unit is 45 degrees.<br />
|-<br />
| curv_info_prev_next<br />
| -4 ... 4<br />
| No<br />
| Difference in direction between the previous (towards engine) and next (towards rear end) vehicle. Curvature to the right is positive. 1 unit is 45 degrees. Equal to <code style="color:darkgreen">curve_invo_prev_cur + curv_info_cur_next</code>.<br />
|-<br />
| curv_info<br />
| vehicle_curv_info(''prev_cur'', ''cur_next'')''''<br />
| No<br />
|<br />
Returns a magic number that represents the curvature state of the prev-cur-next vehicle triplet. Do not try to make sense of this magic number, use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">vehicle_curv_info()</code> instead to make comparisons. <code style="color:darkgreen">curv_info == vehicle_curv_info(a, b)</code> is equivalent to <code style="color:darkgreen">(curv_info_prev_cur == a) &amp;&amp; (curv_info_cur_next == b)</code>, however the former can easily be used in a switch-block.<br />
|-<br />
| motion_counter<br />
| 0 ... 0xFFFFFF<br />
| Yes, always 0<br />
| Is increased every time the vehicle moves a single step on the map. Useful for driving animations.<br />
For that, make the animation use a number of frames, which is a power of two, i.e. 2, 4, 8, 16, 32, ... frames, and then use the lower n bits of motion_counter.<br />
|-<br />
| cargo_type_in_veh<br />
| entry in cargo translation table<br />
| Yes, for the default cargo<br />
| 0xFF if not present in the table<br />
|-<br />
| cargo_unit_weight<br />
| weight per unit in 1/16t<br />
| Yes, for the default cargo<br />
|<br />
|-<br />
| cargo_classes<br />
| Bitmask of [[NML:Cargos#Cargo properties|cargo class]]<br />
| Yes, for the default cargo<br />
| class of the currently transported cargo<br />
|-<br />
| vehicle_is_available<br />
| [0 <nowiki>|</nowiki> 1]<br />
| Yes<br />
| Value is 1 if the vehicle is available on the open market<br />
|-<br />
| vehicle_is_testing<br />
| [0 <nowiki>|</nowiki> 1]<br />
| Yes<br />
| Value is 1 if the vehicle is currently being tested<br />
|-<br />
| vehicle_is_offered<br />
| [0 <nowiki>|</nowiki> 1]<br />
| Yes<br />
| Value is 1 if the vehicle is currently being offered for exclusive preview<br />
|-<br />
| build_year<br />
| 0 ... 5000000<br />
| Yes<br />
| 0-based year when the vehicle was built, current year if the vehicle is not built yet<br />
|-<br />
| direction<br />
| DIRECTION_XX<br />
| No<br />
|<br />
See [[NML:List of direction constants|here]] for an overview of possible values and their meaning.<br />
|-<br />
| cargo_capacity<br />
| 0 ... 65535<br />
| No<br />
| Cargo capacity (number of units) of the vehicle<br />
|-<br />
| cargo_count<br />
| 0 ... 65535<br />
| No<br />
| Number of cargo units of cargo in the vehicle<br />
|-<br />
| cargo_subtype<br />
| 0 ... 255<br />
| Yes, always 0<br />
| Cargo subtype, used to provide more than one refit option for the same cargo type. See also the <code style="color:darkgreen">cargo_subtype_text</code> callback.<br />
|-<br />
| vehicle_is_powered<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Vehicle provides power and is on the correct track type<br />
|-<br />
| vehicle_is_not_powered<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Vehicle is either on a wrong track type or it doesn't provide power at all<br />
|-<br />
| vehicle_is_potentially_powered<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Vehicle provides power, if it is on a suitable track type<br />
|-<br />
| vehicle_is_flipped<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Value is 1 if the sprite is reversed via flip-vehicle-in-depot (trains only)<br />
|-<br />
| vehicle_is_reversed<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Value is 1 if the vehicle has reversed an odd number of times<br />
|-<br />
| built_during_preview<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Value is 1 if the vehicle was built during the exclusive preview stage<br />
|-<br />
| current_railtype<br />
| Entry from railtype translation table or 0xFF<br />
| No<br />
| This variable is useless due to equivalent railtypes, use tile_xxx_railtype instead. If you do use this variable, it will not work as expected unless you've defined a railtype translation table. If the train is running on a railtype that is not listed in your railtype translation table this variable will contain 0xFF.<br />
|-<br />
| current_roadtype<br />
| Entry from current_roadtype translation table or 0xFF<br />
| No<br />
| {{nml|0.5}} {{ottdp|1.10|no}} This variable is useless due to equivalent roadtypes, use tile_xxx_roadtype instead. Don't use this variable unless you've defined a roadtype translation table. If the road vehicle is running on a roadtype that is not listed in your roadtype translation table this variable will contain 0xFF. Checking this for a tram is not supported and will not return a useful result.<br />
|-<br />
| current_tramtype<br />
| Entry from tramtype translation table or 0xFF<br />
| No<br />
| {{nml|0.5}} {{ottdp|1.10|no}} This variable is useless due to equivalent tramtypes, use tile_xxx_tramtype instead. Don't use this variable unless you've defined a tramtype translation table. If the road vehicle is running on a tramtype that is not listed in your tramtype translation table this variable will contain 0xFF. Checking this for a road vehicle that is not a tram is not supported and will not return a useful result.<br />
|-<br />
| tile_has_catenary<br />
| No<br />
| [0 <nowiki>|</nowiki> 1]<br />
| {{ottdp|1.11|no}} True if the track_type on the tile has catenary. This is a little simplified as it is intended for sprite changes (e.g. raise/lower pantograph) and only checks for "some catenary". To distinguish different types of electric track, AC and DC voltages etc, ... use tile_xxx_railtype/tile_xxx_roadtype/tile_xxx_tramtype instead.<br />
|-<br />
| waiting_triggers<br />
|<br />
| No<br />
|<br />
Random triggers waiting to be matched. (see [[NML:Random switch|Random switch]])<br />
|-<br />
| random_bits<br />
| 0 ... 255<br />
| No<br />
|<br />
Random data that can be used to randomize certain descisions. (see [[NML:Random switch|Random switch]])<br />
|-<br />
| grfid<br />
| 0 ... 0xFFFFFFFF<br />
| No<br />
|<br />
GRFID that defined the [[NML:Graphics|graphics]]-block for this vehicle. To compare this with other grfids, use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert the other GRFID to a number as well.<br />
|-<br />
| vehicle_type_id<br />
| 0 ... 65535 or a name defined in item block<br />
| No<br />
| GRF-local ID of the vehicle, equal to the item ID. Note that vehicles from other NewGRFs may have the same ID, so you'll generally have to check the <code style="color:darkgreen">grfid</code> as well.<br />
|-<br />
| vehicle_is_hidden<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Value is 1 if the vehicle is hidden in a depot or tunnel.<br />
|-<br />
| vehicle_is_stopped<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Value is 1 if the vehicle is stopped, or if it is braking for a stop (trains only).<br />
|-<br />
| vehicle_is_crashed<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Value is 1 if the vehicle has crashed.<br />
|-<br />
| vehicle_is_broken<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Value is 1 if the vehicle is broken down.<br />
|-<br />
| date_of_last_service<br />
| date(year, month, day)<br />
| No<br />
|<br />
|-<br />
| breakdowns_since_last_service<br />
| 0 ... 255<br />
| No<br />
| Number of breakdowns since the last service<br />
|-<br />
| reliability<br />
| 0 ... 100<br />
| No<br />
| Reliability (percentage)<br />
|-<br />
| age_in_days<br />
| 0 ... 65535<br />
| No<br />
| Vehicle age in days.<br />
|-<br />
| max_age_in_days<br />
| 0 ... 65535<br />
| No<br />
| Maximum vehicle age in days.<br />
|-<br />
| current_speed<br />
| (speed units)<br />
| No<br />
| The current speed of the vehicle in m/s<br />
|-<br />
| max_speed<br />
| (speed units)<br />
| No<br />
| The maximum speed of the vehicle in m/s<br />
|-<br />
| current_max_speed<br />
| (speed units)<br />
| No<br />
| {{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24246}} Current maximum speed of the vehicle in m/s. This includes e.g. track or timetable limits. Only valid for front vehicle.<br />
|-<br />
| vehicle_is_in_depot<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| Value is 1 if the vehicle is inside a depot<br />
|-<br />
| vehicle_is_unloading<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| {{ottdp|1.5|2.5|ottdrev=r26430}} Value is 1 if the vehicle is unloading at a station and has not yet started loading new cargo.<br />
|}<br />
<br />
===Variables that require an argument===<br />
<br />
{| class="wikitable sortable"<br />
! name<br />
! Argument<br />
! value range<br />
! available in<br />purchase list?<br />
! comment<br />
|-<br />
| count_veh_id<br />
| The vehicle ID to look for.<br />
| 0..255<br />
| No<br />
| The number of vehicles in the current consist that have the given ID.<br />
|-<br />
| other_veh_curv_info<br />
| Offset in the chain from the current vehicle.<ref name="offset">Argument range is -128..127. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.</ref><br />
| -4..4<br />
| No<br />
| Difference in direction between the other vehicle and this vehicle. Curvature to the right is positive. 1 unit is 45 degrees.<br />
|-<br />
| other_veh_is_hidden<br />
| Offset in the chain from the current vehicle.<ref name="offset"/><br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| 1 the other vehicle is hidden in a depot or tunnel, 0 otherwise<br />
|-<br />
| other_veh_x_offset<br />
| Offset in the chain from the current vehicle.<ref name="offset"/><br />
| -128..127<br />
| No<br />
| Signed difference in X-position (top-right to bottom-left) between the other vehicle and this vehicle.<br />
|-<br />
| other_veh_y_offset<br />
| Offset in the chain from the current vehicle.<ref name="offset"/><br />
| -128..127<br />
| No<br />
| Signed difference in Y-position (top-left to bottom-right) between the other vehicle and this vehicle.<br />
|-<br />
| other_veh_z_offset<br />
| Offset in the chain from the current vehicle.<ref name="offset"/><br />
| -128..127<br />
| No<br />
| Signed difference in Z-position (upwards) between the other vehicle and this vehicle.<br />
|-<br />
| tile_supports_railtype <br /> tile_supports_roadtype <br /> tile_supports_tramtype<br />
| Entry from rail/road/tram translation table<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| {{ottdp|1.11|no}} Vehicles of the track_type label used as parameter are compatible with the rail/road/tram track_type on the current tile. Example: <code style="color:darkgreen">tile_supports_railtype(ELRL)</code><br />
|-<br />
| tile_powers_railtype <br /> tile_powers_roadtype <br />tile_powers_tramtype<br />
| Entry from rail/road/tram translation table<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| {{ottdp|1.11|no}} Vehicles of the track_type label used as parameter are powered on the rail/road/tram track_type on the current tile. Example: <code style="color:darkgreen">tile_powers_railtype(ELRL)</code><br />
|-<br />
| tile_is_railtype <br /> tile_is_roadtype <br /> tile_is_tramtype<br />
| Entry from rail/road/tram translation table<br />
| [0 <nowiki>|</nowiki> 1]<br />
| No<br />
| {{ottdp|1.11|no}} The track_type label used as parameter is identical or equivalent (listed as alternate label in rail-/road-/tram-type property 1D) to the rail/road/tram track_type on the current tile. Example: <code style="color:darkgreen">tile_is_railtype(ELRL)</code><br />
<br />
|}<br />
<references/><br />
<br />
==Vehicle callbacks==<br />
The following table contains a list of available vehicle callbacks. Additionally, it's possible to provide cargo-specific graphics, using the identifier from the [[NML:Cargotable|cargo table]] as callback name. These callbacks will be used if the vehicle is refitted to the corresponding cargo type. If no cargo-specific graphics match the cargo that the vehicle is carrying, the <code style="color:darkgreen">default</code> callback is used instead. Cargo-specific graphics callbacks are never called from the purchase menu, refer to the <code style="color:darkgreen">purchase</code> callback below instead.<br />
<br />
Note that the above affects '''graphics only''', other callbacks are unaffected.<br />
<br />
{| class="wikitable sortable"<br />
! Name<br />
! Available for<br />
! In purchase menu?<br />
! value range<br />
! comment<br />
|-<br />
| default<br />
| All<br />
| Yes, unless <code style="color:darkgreen">purchase</code> is set separately<br />
| Sprite group<br />
| 'Normal' vehicle graphics, if no cargo-specific graphics apply. See also the section on [[#Sprites in GUI|GUI sprites]].<br />
|-<br />
| purchase<br />
| All<br />
| Yes, only<br />
| Sprite group<br />
| Graphics to show in the buy menu (only the horizontal view is needed, except for dual-headed trains. With the <code>dual_headed</code> property set, special rules for the purchase menu sprite apply: two sprites are drawn (for front and back) as if the vehicle is normally constructed. If you supply one purchase menu sprite, it will be used for both vehicle parts in the purchase menu. Provide a set of 8 sprites, and the 7th resp. 3rd sprite will be drawn; provide a set of 8 blank sprites except the 7th if you want to fully control a single purchase menu sprite for a dual-headed engine. ) See also the section on [[#Sprites in GUI|GUI sprites]].<br />
|-<br />
| rotor<br />
| Aircraft (helicopters)<br />
| No<br />
| Sprite group<br />
| Graphics for the helicopter rotor (4 sprites; 1 stopped and 3 moving)<br />
|-<br />
| random_trigger<br />
| All<br />
| No<br />
| N/A<br />
| See [[NML:Random switch|random switch]] for more information.<br />
|-<br />
| cargo_subtype_text<br />
| All<br />
| No<br />
| String, or CB_RESULT_NO_TEXT<br />
| <b>NOTE: As of OpenTTD 13, this feature is considered deprecated for most uses. Use variants instead.</b> With this callback, you can display extra text after the cargo in the vehicle information window. This callback is called during refitting, with succesively increased values of the <code style="color:darkgreen">cargo_subtype</code> variable, until the callback returns CB_RESULT_NO_TEXT. All returned strings are then displayed as refit options. The chosen refit option is saved in the <code style="color:darkgreen">cargo_subtype</code> variable, so it can be used to select specific sprites for the vehicle's current cargo subtype.<br />
|-<br />
| additional_text<br />
| All<br />
| Yes, only<br />
| String<br />
| Additional text to show in the purchase list.<br />
|-<br />
| colour_mapping<br />
| All<br />
| Yes, unless <code style="color:darkgreen">purchase_colour_mapping</code> is set separately<br />
| Recolour sprite number<br />
|<br />
With this callback, you can use a different recolour sprite instead of the standard 1cc / 2cc company colour remappings. See [[NML:List of default colour translation palettes|here]] for a list of default palettes. See the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">reserve_sprites()</code> for info on how to allocate your own sprite. For performance, the result is cached and only updated if the <code style="color:darkgreen"> every_32_days</code> callback requires so. Add CB_RESULT_COLOUR_MAPPING_ADD_CC to the result to add the company colour to the sprites, this requires 16 (1cc) or 256 (2cc) sprites in total.<br />
|-<br />
| start_stop<br />
| All<br />
| No<br />
| String or CB_RESULT_NO_TEXT<br />
| Called when starting or stopping a vehicle. Mainly useful to prevent vehicles from leaving the depot unless a certain condition is met. Return CB_RESULT_NO_TEXT to allow or a string (containing an error message) to disallow starting/stopping.<br />
|-<br />
| every_32_days<br />
| All<br />
| No<br />
| bitmask(CB_RESULT_32_DAYS_XXX, ...)<br />
| Called every 32 days. Set CB_RESULT_32_DAYS_TRIGGER in the bitmask to trigger TRIGGER_VEHICLE_32_CALLBACK. Set CB_RESULT_32_DAYS_COLOUR_MAPPING in the bitmask to update the colour mapping by re-running the <code style="color:darkgreen">colour_mapping</code> callback.<br />
|-<br />
| sound_effect<br />
| All<br />
| No<br />
| SOUND_XXX, sound("sound.wav"), import_sound(grfid, number) or CB_RESULT_NO_SOUND<br />
|<br />
Called to play various vehicle sounds.<br />
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> The sound event, see the [[#Sound events|table]] below.<br />
Return SOUND_XXX (see [[NML:List_of_sound_effects|here]]) to return a default sound. <code style="color:darkgreen">sound("soundfile")</code> imports a sound from a .wav file. <code style="color:darkgreen">import_sound(grfid, number)</code> imports a sound from another grf. A failed (or not implemented) callback will cause the default sound to be played. Return CB_RESULT_NO_SOUND to play no sound at all.<br />
|-<br />
| articulated_part<br />
| Trains, Road Vehicles<br />
| Yes (no separate callback)<br />
| Vehicle ID, or CB_RESULT_NO_MORE_ARTICULATED_PARTS<br />
| With this callback, you can add articulated parts (e.g. tenders) to your vehicle. Called repeatedly, until CB_RESULT_NO_MORE_ARTICULATED_PARTS is returned. After each call, the returned vehicleID is added to your vehicle.<br />
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> contains 1 during the first call, 2 during the second, etc.<br />
Note that callback may be called from the purchase list, using vehicle variables is not possible. Or CB_RESULT_REVERSED_VEHICLE to the returned vehicle ID to display the vehicle backwards. <br />
<br />
For NML 0.2 and lower the vehicle ID of the articulated part must be in the range 0 .. 127.<br />
|-<br />
| can_attach_wagon<br />
| Trains<br />
| No<br />
| String or CB_RESULT_ATTACH_XXX<br />
| Called when a wagon is being attached, to allow or disallow attaching. If a wagon is inserted in the middle, all wagons are removed and attached one-by-one in the new order. This callback has to be defined at the engine. The scopes behave different than usual though:<br />
* <code style="color:darkgreen">SELF</code> refers to the wagon being attached. (despite the callback being defined at the engine)<br />
* <code style="color:darkgreen">PARENT</code> refers to the consist of the engine up to the wagon before <code style="color:darkgreen">SELF</code>, i.e. not (yet) including the wagon being attached.<br />
Return a string to disallow with the string as error message. Return CB_RESULT_ATTACH_DISALLOW to disallow with standard message ("incompatible railtypes"), CB_RESULT_ATTACH_ALLOW to allow or CB_RESULT_ATTACH_ALLOW_IF_RAILTYPES to allow if the railtypes match (default).<br />
|-<br />
| refit_cost<br />
| {{ottdp|1.2|no|ottdrev=r23089}} All<br />
| Yes<br />
| -8192 .. 8191 as refit cost. Add <code style="color:darkgreen">CB_RESULT_AUTOREFIT</code> if you want to allow autorefit.<br />
| When returning a negative value, encode the cost as (cost & <code style="color:darkgreen">CB_RESULT_REFIT_COST_MASK</code>) before (possibly) adding <code style="color:darkgreen">CB_RESULT_AUTOREFIT</code>. To allow autorefitting, the corresponding bit in the <code style="color:darkgreen">misc_flags</code> must be set as well.<br />
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>: The new cargo type.<br />
* <code style="color:darkgreen">getbits(extra_callback_info1, 8, 8)</code>: The new cargo subtype (see <code style="color:darkgreen">cargo_subtype_text</code>-callback).<br />
* <code style="color:darkgreen">getbits(extra_callback_info1, 16, 16)</code>: A bitmask of the [[NML:Cargos#Cargo_classes|cargo classes]] of the target cargo type. <br />
Note that this callback may also be called when the vehicle does not exist yet, so the available variables are limited.<br />
|-<br />
| create_effect<br />
| {{ottdp|1.5|no|ottdrev=r26747}} Trains, Road Vehicles, Ships<br />
| No<br />
| 0 .. 3 for number of effects. Optionally add <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_CENTER</code> and/or <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code><br />
| Called when a effect spawning model is defined via <code style="color:darkgreen">effect_spawn_model</code> resp. <code style="color:darkgreen">effect_spawn_model_and_powered</code>.<br />
<br />
The result specifies how many effects shall be created.<br />
The position and appearance of the individual effects is returned via registers 0x100 to 0x103:<br />
<pre style="color:blue"><br />
switch (FEAT_XXX, SELF, switch_name, [<br />
STORE_TEMP(create_effect(EFFECT_SPRITE_XXX, 8, -3, 10), 0x100), // first effect,<br />
STORE_TEMP(create_effect(EFFECT_SPRITE_YYY, 8, 3, 10), 0x101) // second effect, ...<br />
]) {<br />
return 2; // number of effects<br />
}<br />
</pre><br />
The register values are created using the <code style="color:darkgreen">create_effect(''effect_sprite'', ''l_x_offset'', ''t_y_offset'', ''z_offset'')</code> function:<br />
* ''effect_sprite'': Sprite for the effect. One of <code style="color:darkgreen">EFFECT_SPRITE_</code>[<code style="color:darkgreen">NONE</code>|<code style="color:darkgreen">STEAM</code>|<code style="color:darkgreen">DIESEL</code>|<code style="color:darkgreen">ELECTRIC</code>|<code style="color:darkgreen">AIRCRAFT_BREAKDOWN_SMOKE</code>].<br />
* ''l_x_offset'': Longitudinal or X position of the effect, depending on callback result <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>.<br />
* ''t_y_offset'': Transversal or Y position of the effect, depending on callback result <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>.<br />
* ''z_offset'': Z position of the effect.<br />
<br />
Additional to the number of effects, the callback result may specify these flags:<br />
;<code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_CENTER</code><br />
:(Train and road vehicle only) If set, position effect relative to vehicle center instead of relative to vehicle sprite. (behaves the same for vehicles with length 8/8) <br />
;<code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code><br />
*If not set, the parameters to <code style="color:darkgreen">effect_sprite</code> describe longitudinal/transversal positions, which are rotate wrt. vehicle orientation.<br />
*If set, the parameters to <code style="color:darkgreen">effect_sprite</code> describe X and Y positions, which are not automatically rotated.<br />
|}<br />
<br />
The following callbacks all have an equivalent property. The property description applies here also, except where otherwise noted.<br />
<br />
{| class="wikitable sortable"<br />
! Name<br />
! Available for<br />
! In purchase menu?<br />
! comment<br />
|-<br />
| loading_speed<br />
| All<br />
| No<br />
|<br />
|-<br />
| speed<br />
| All<br />
| Yes, unless <code style="color:darkgreen">purchase_speed</code> is set separately<br />
| Units are not (yet) available<br />
|-<br />
| cost_factor<br />
| All<br />
| Yes, only<br />
|<br />
|-<br />
| running_cost_factor<br />
| All<br />
| Yes, unless <code style="color:darkgreen">purchase_running_cost_factor</code> is set separately<br />
|<br />
|-<br />
| cargo_age_period<br />
| All<br />
| No<br />
|<br />
|-<br />
| cargo_capacity<br />
| All except aircraft<br />
| Yes, unless <code style="color:darkgreen">purchase_cargo_capacity</code> is set separately<br />
|<br />
|-<br />
| passenger_capacity<br />
| Aircraft<br />
| Yes, unless <code style="color:darkgreen">purchase_passenger_capacity</code> is set separately<br />
|<br />
|-<br />
| mail_capacity<br />
| Aircraft<br />
| Yes, unless <code style="color:darkgreen">purchase_mail_capacity</code> is set separately<br />
|<br />
|-<br />
| range<br />
| Aircraft<br />
| Yes, unless <code style="color:darkgreen">purchase_range</code> is set separately<br />
|<br />
|-<br />
| visual_effect_and_powered<br />
| Trains<br />
| No<br />
|<br />
|-<br />
| visual_effect<br />
| Road Vehicles, Ships<br />
| No<br />
|<br />
|-<br />
| effect_spawn_model_and_powered<br />
| Trains<br />
| No<br />
|<br />
|-<br />
| effect_spawn_model<br />
| Road Vehicles, Ships<br />
| No<br />
|<br />
|-<br />
| power<br />
| Trains, Road Vehicles<br />
| Yes, unless <code style="color:darkgreen">purchase_power</code> is set separately<br />
| Units are not (yet) available<br />
|-<br />
| weight<br />
| Trains, Road Vehicles<br />
| Yes, unless <code style="color:darkgreen">purchase_weight</code> is set separately<br />
| Units are not (yet) available<br />
|-<br />
| length<br />
| Trains, Road vehicles<br />
| No<br />
|<br />
|-<br />
| tractive_effort_coefficient<br />
| Trains, Road Vehicles<br />
| Yes, unless <code style="color:darkgreen">purchase_tractive_effort_coefficient</code> is set separately<br />
| Value range is 0 .. 255 instead of 0 .. 1.<br />
|-<br />
| bitmask_vehicle_info<br />
| Trains<br />
| No<br />
|<br />
|-<br />
| curve_speed_mod<br />
| {{nml|0.7}} {{ottd|12.0}} Trains<br />
| No<br />
|<br />
|-<br />
| name<br />
| {{nml|0.7.2}} {{ottd|14.0}} All<br />
| Yes<br />
| Can be used to display vehicle name differently depending on context (purchase menu, depot, nested variant depth etc). <code style="color:darkgreen">extra_callback_info1</code> contains detailed information about context - please see https://newgrf-specs.tt-wiki.net/wiki/Callbacks#Engine_name_.28161.29<br />
|}<br />
<br />
<br />
<br />
<br />
===Sprites in GUI===<br />
{{ottdp|1.2|no|ottdrev=r23080}} Since OpenTTD r23080 you can use variable <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> to display different sprites in the GUI and on the map. Currently these cases are available:<br />
{| |-<br />
! getbits(extra_callback_info1, 0, 8) !! Meaning<br />
|-<br />
| 0x00 || Vehicle is drawn in a viewport, i.e. on the map.<br />
|-<br />
| 0x01..0x0F || reserved<br />
|-<br />
| 0x10 || Vehicle is drawn in the depot GUI. <ref>OpenTTD also uses this value with the purchase-list chain (cargotype FF) to determine the gridsize in ship and aircraft depots.</ref><br />
|-<br />
| 0x11 || Vehicle is drawn in the vehicle details GUI. (This includes the refit GUI.)<br />
|-<br />
| 0x12 || Vehicle is drawn in the vehicle list.<br />
|-<br />
| 0x13..0x1F || reserved for other future GUIs.<br />
|-<br />
| 0x20 || Vehicle is drawn in the purchase list. (This includes the autoreplace GUI.)<br />
|-<br />
| 0x21 || Vehicle is drawn in the exclusive preview GUI or in the advertisement news.<br />
|-<br />
| 0x22..0x2F || reserved for other future GUIs with non-purchased vehicles.<br />
|-<br />
| 0x30..0xFF || reserved<br />
|}<br />
<references/><br />
The cases 0x20..0x2F are called using the <code style="color:darkgreen">purchase</code>-callback, the other cases are called for the <code style="color:darkgreen">default</code>- or cargo-specific callbacks. Exception is the the special depot-gridsize call, which uses the <code style="color:darkgreen">purchase</code>-callback.<br />
<br />
===Composing vehicles from multiple sprites===<br />
{{ottdp|1.7|no|ottdrev=r27668}} Since OpenTTD r27668 you can draw vehicles by drawing multiple sprites on top of each other.<br />
* The sprites can use different recolouring.<br />
* When using 32bpp sprites, the sprites can use the alpha channel to blend with the other sprites. In particular you can use this to alpha-blend company colours over other sprites.<br />
<br />
To enable this, you need to set <code style="color:darkgreen">XXX_FLAG_SPRITE_STACK</code> in the <code style="color:darkgreen">misc_flags</code> property.<br />
<br />
When enabled, sprites are resolved multiple times while incrementing an iteration number, that can be read via<br />
<code style="color:darkgreen">getbits(extra_callback_info1, 8, 8)</code><br />
<br />
For OpenTTD 1.7 to 12.0, this is limited to at most 4 sprites per articulated part.<br />
<br />
Increased to 8 sprites per articulated part for OpenTTD 13.0 {{ottdp|13.0|no}}<br />
<br />
In addition you need to set register 100 as additional result:<br />
* <code style="color:darkgreen">STORE_TEMP(CB_FLAG_MORE_SPRITES | recolouring, 0x100)</code> if there are more sprites to draw.<br />
* <code style="color:darkgreen">STORE_TEMP(recolouring, 0x100)</code> if there are no more sprites to draw.<br />
"recolouring" can be:<br />
* <code>PALETTE_USE_DEFAULT</code> to use the default vehicle recolouring.<br />
* <code>PALETTE_IDENTITY</code> to use no recolouring<br />
* Any other default or custom recolouring sprite.<br />
<br />
===Sound events===<br />
<br />
{| class="wikitable sortable"<br />
! Event<br />
! Description<br />
|-<br />
| SOUND_EVENT_START<br />
| Vehicle leaves station or depot, plane takes off<br />
|-<br />
| SOUND_EVENT_TUNNEL<br />
| Vehicle enters tunnel<br />
|-<br />
| SOUND_EVENT_BREAKDOWN<br />
| Vehicle breaks down (not for planes)<br />
|-<br />
| SOUND_EVENT_RUNNING<br />
| Once per engine tick, but no more than once per vehicle motion<br />
|-<br />
| SOUND_EVENT_TOUCHDOWN<br />
| Aircraft touches down<br />
|-<br />
| SOUND_EVENT_VISUAL_EFFECT<br />
| Visual effect is generated (steam plume, diesel smoke, electric spark)<br />
|-<br />
| SOUND_EVENT_RUNNING_16<br />
| Every 16 engine ticks if in motion<br />
|-<br />
| SOUND_EVENT_STOPPED<br />
| Every 16 engine ticks if stopped<br />
|-<br />
| SOUND_EVENT_LOAD_UNLOAD<br />
| Consist loads or unloads cargo<br />
|}<br />
<br />
== Vehicle IDs ==<br />
Picking an item ID requires keeping two cases in mind: OpenTTD with the engine pool enabled and OpenTTD with engine pool disabled / TTDPatch. The status of the engine pool may be checked with the global variable [[NML:General#General_variables|dynamic_engines]].<br />
<br />
Note that while vehicle ID affects the order in which vehicles appear in the purchase menu, this can be overridden using the [[NML:Sorting vehicles in the purchase list|sort block]].<br />
<br />
=== Engine pool enabled ===<br />
With the engine pool enabled, each NewGRF has its own ID range, NewGRFs don't influence each other. IDs may freely be chosen between 0 and 65535. If the chosen ID belongs to an existing vehicle, this vehicle is overridden by your vehicle. If another NewGRF is already overriding that vehicle, a new vehicle will be allocated, but all the properties will be copied from the old vehicle. If you define an ID for which no original vehicle exists, a new (blank) vehicle is allocated.<br />
<br />
This behaviour can be modified using an [[NML:Overriding_vehicles_in_other_NewGRFs|engine_override]], this allows changing the properties of vehicles defined in other NewGRFs instead of allocating a new vehicle.<br />
<br />
=== TTDPatch / Engine pool disabled ===<br />
Each new vehicle has to replace an existing vehicle. If multiple NewGRFs try to replace the same vehicle, the last NewGRF loaded 'wins'. [[VehicleIDs|This page]] contains a list of valid vehicle IDs for each vehicle type, look in the 'NML ID' column. Note that IDs are not bound to a specific sort of vehicle (e.g. monorail wagons) but to a feature (e.g. trains, road vehicles).<br />
<br />
<br />
In general, you should take the following steps:<br />
* If your NewGRF is intended as a complete replacement for the default vehicles, disable the relevant default vehicles using [[NML:Disable_items|disable_item]].<br />
* Re-use IDs of existing vehicles as much as possible.<br />
* If your NewGRF uses IDs outside of the normal range (for example, because you there are more vehicles than slots available), let your code check if dynamic_engies is enabled. If not, skip the vehicles outside the normal range (using an if-statement) and make sure that the remaining vehicles allow for reasonable gameplay. It is recommended to issue a warning to the user about this. Alternatively, it is also possible to disable your entire NewGRF. If you don't do this check and dynamic_engines is off, OpenTTD may disable your NewGRF with the somewhat cryptic message 'Attempt to use invalid ID', which will likely lead to bug reports about your NewGRF and/or your OpenTTD.</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=RandomAction2&diff=4661RandomAction22023-11-30T20:28:46Z<p>Pikkabird: /* Triggers */</p>
<hr />
<div>==Introduction==<br />
<br />
Unlike [[VariationalAction2]], whose results are always determined by a predictable decision, RandomAction2 can use randomized results to pick one of several [[Action2]] entries.<br />
<br />
== Format ==<br />
<br />
The data looks as follows:<br />
<br />
<Sprite-number> * <Length> 02 <feature> <set-id> <nowiki>[80|83]</nowiki> <random-triggers> <randbit> <nrand> <set-ids><br />
<br />
From TTDPatch 2.6 r1850 and OpenTTD r12452, and '''for vehicles only''':<br />
<br />
<Sprite-number> * <Length> 02 <feature> <set-id> 84 <count> <random-triggers> <randbit> <nrand> <set-ids><br />
<br />
{| |-<br />
!'''Element'''!![[GRFActionsDetailed|'''Size''']]!!'''Description'''<br />
|-<br />
|<Sprite-number>||dec||A sequential sprite number<br />
|-<br />
|<length>||dec||The total number of bytes used in this action.<br />
|-<br />
|02||B||Defines action 02<br />
|-<br />
|<feature>||B||For what type of vehicle/station/... should this definition be used?<br />
|-<br />
|<set-id>||B||The ID of this action 2 (used like a cargo ID)<br />
|-<br />
|80, 83, 84||B||Type of random action, see below.<br />
|-<br />
|<count>||B||(when present) Location of controlling vehicle.<br />
|-<br />
|<random-triggers>||B||When to re-randomize<br />
|-<br />
|<randbit>||B||What random bit to use for this action 2<br />
|-<br />
|<nrand>||B||Number of set-ids to choose from, must be a power of 2<br />
|-<br />
|<set-ids>||W||Action 2 set-ids to choose from.<br />
|}<br />
<br />
== Description ==<br />
<br />
=== Sprite-number ===<br />
<br />
This is just the number you are at.<br />
<br />
=== Length ===<br />
<br />
Count the number of bytes in this action.<br />
<br />
===Feature===<br />
<br />
This sets the type of [[Features|feature]] that you wish to change. Set it to:<br />
<br />
{|- |<br />
!Value!![[Features|Feature]]<br />
|-<br />
|00||Trains<br />
|-<br />
|01||Road Vehicles<br />
|-<br />
|02||Ships<br />
|-<br />
|03||Aircraft<br />
|-<br />
|04||Stations<br />
|-<br />
|05||Canals/Rivers<br />
|-<br />
|07||Houses<br />
|-<br />
|09||Industry Tiles<br />
|-<br />
|0A||Industries<br />
|-<br />
|0D||Airports<br />
|-<br />
|0F||Objects<br />
|-<br />
|10||Railtypes<br />
|-<br />
|11||Airport Tiles<br />
|-<br />
|12||Roadtypes<br />
|-<br />
|13||Tramtypes<br />
|-<br />
|14||Road Stops<br />
|}<br />
<br />
=== set-ID ===<br />
<br />
This defines the number of this action 2. &nbsp;The ID can then be used as target in an action 3 or another variational/random action 2.<br />
<br />
=== 80/83/84 ===<br />
<br />
Use 80 to randomize the object (vehicle, station, building, industry, object) based on its own triggers and bits.<br />
<br />
Use 83 to randomize the object based on its "related" object (s.b.).<br />
<br />
Use 84 to randomize the vehicle based on any vehicle in the consist.<br />
<br />
{| |-<br />
!Feature!!Related object<br />
|-<br />
|Vehicles (00-03)||First vehicle of consist<br />
|-<br />
|Stations (04)||N/A<br />
|-<br />
|Houses (07)||N/A<br />
|-<br />
|Industry tiles (09)||Industry containing tile<br />
|-<br />
|Industries (0A)||N/A<br />
|-<br />
|Objects (0F)||N/A<br />
|}<br />
<br />
=== count ===<br />
<br />
For type 84, this specifies which vehicle's random bits this vehicle will be using and/or modifying.<br />
<br />
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.<br />
<br />
The high nibble (bits 6-7, actually) specifies which vehicle is the starting vehicle, and which direction to count:<br />
<br />
{| |-<br />
!Value!!Meaning<br />
|-<br />
|0||count back (away from the engine), starting at this vehicle<br />
|-<br />
|4||count forward (toward the engine), starting at this vehicle.<br />
|-<br />
|8||count back, starting at the engine<br />
|-<br />
|C||count back, starting at the first vehicle in this chain of vehicles with the same ID, as for vehicle variable 41<br />
|}<br />
<br />
Bits 4-5 are reserved and must be zero, so other values of the high nibble are not allowed.<br />
<br />
=== random-triggers ===<br />
<br />
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.<br />
<br />
Trigger bits are feature-specific, see below.<br />
<br />
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.<br />
<br />
Example:<br />
-1 * -1 02 04 02<br />
80 // random in callback<br />
00 // no triggers<br />
00 // first random bit to use<br />
\b 16 // number of cases<br />
\w 10 \w 11 \w 12 \w 13 // random cases<br />
\w 14 \w 15 \w 16 \w 17<br />
\w 18 \w 19 \w 20 \w 21<br />
\w 22 \w 23 \w 24 \w 25<br />
<br />
-1 * -1 02 04 01<br />
85 0C 00 \wx FFFF<br />
01<br />
\w 2 \w 14 \w 14 // callback 14<br />
\w 3 // graphics chain<br />
<br />
-1 * -1 02 04 00<br />
80 // dummy random outside callback<br />
04 // train arrival<br />
00 // first bit to rerandomise<br />
\b 16 // number of cases<br />
\w 1 \w1 \w 1 \w1 // all cases the same, only for triggering rerandomisation<br />
\w 1 \w1 \w 1 \w1<br />
\w 1 \w1 \w 1 \w1<br />
\w 1 \w1 \w 1 \w1<br />
<br />
-1 * -1 03 04 01 00 00 \w 0 // action 3<br />
<br />
=== randbit ===<br />
<br />
{{ottdp|no|&lt;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).<br />
<br />
{{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).<br />
<br />
=== nrand ===<br />
<br />
Number of different sets to choose from. &nbsp;This must be a power of 2, i.e. 2, 4, 8, 16 etc.<br />
<br />
=== set-ids ===<br />
<br />
Action 2 IDs to randomly choose from<br />
<br />
== Triggers ==<br />
<br />
{| |-<br />
!rowspan="2"|Feature<br />
!colspan="2"|Random bits<br />
!rowspan="2"|Triggers<br />
|-<br />
!Self!!Related<br />
|-<br />
|Vehicles<br />
|8<br />
{{ottdp|14.0|no}} 16<br />
|8 read-only<br />
{{ottdp|14.0|no}} 16 read-only<br />
|yes<br />
|-<br />
|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><br />
|no||yes<br />
|-<br />
|Canals||8||no||no<br />
|-<br />
|Houses||8||no||yes<br />
|-<br />
|Industry tiles||8||16||yes<br />
|-<br />
|Industries||16||no||no<br />
|-<br />
|Airports||16 <ref name="stationshared"/>||no||no<br />
|-<br />
|Objects||8||no||no<br />
|-<br />
|Railtypes||2||no||no<br />
|-<br />
|Roadtypes||2||no||no<br />
|-<br />
|Tramtypes||2||no||no<br />
|-<br />
|Airport tiles||16 + 4 <ref name="stationshared"/>||no||no<br />
|-<br />
|Road stops||16 + 8 <ref name="stationshared"/>||no||no<br />
|}<br />
<references/><br />
<br />
=== Vehicles ===<br />
<br />
Vehicles have 8 random bits, increased to 16 since {{ottdp|14.0|no}}, and the following triggers:<br />
<br />
{| |-<br />
!Bit!!Value!!Version!!Trigger<br />
|-<br />
|0||01||{{ottdp|0.6|2.0}}||Vehicle gets new load of cargo (only after it was empty)<br />
|-<br />
|1||02||{{ottdp|0.6|2.0}}||Vehicle enters a depot and is serviced<br />
|-<br />
|2||04||{{ottdp|0.6|2.5}}||The consist has unloaded all cargo<br />
|-<br />
|3||08||{{ottdp|0.6|2.5}}||Any vehicle of the consist receives cargo<br />
|-<br />
|4||10||{{ottdp|0.6|2.5}}||[[Callbacks#32-day callback (32) |Callback 32]] returned 1<br />
|}<br />
<br />
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.<br />
<br />
Vehicles can read the random bits of other vehicles (using random action type 83 or 84), but they can only trigger<br />
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.<br />
<br />
=== Stations ===<br />
<br />
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. &nbsp;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).<br />
<br />
{| |-<br />
!Bit!!Value!!Version!!Trigger<br />
|-<br />
|0||01||{{ottdp|1.3|2.5}}||new cargo waiting<br />
|-<br />
|1||02||{{ottdp|1.3|2.5}}||no more cargo<br />
|-<br />
|2||04||{{ottdp|1.3|2.5}}||train arrives (starts unloading/loading)<br />
|-<br />
|3||08||{{ottdp|1.3|2.5}}||train leaves (done unloading & loading)<br />
|-<br />
|4||10||{{ottdp|1.3|2.5}}||train loads or unloads cargo<br />
|-<br />
|5||20||{{ottdp|1.3|2.5}}||train reserves platform (using PBS)<br />
|}<br />
<br />
Also note that none of the above triggers will actually trigger unless prop. 12 has at least one bit set. &nbsp;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.<br />
<br />
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.<br />
<br />
Because the 'occured triggers' are only stored once per station (not distinguishing tiles or cargo types), adding 80 to <br />
random-triggers does not make a lot of sense.<br />
<br />
=== Town building triggers ===<br />
<br />
Town buildings have 8 random bits.<br />
<br />
{| |-<br />
!Bit!!Value!!Version!!Trigger<br />
|-<br />
|0||01||{{ottdp|0.6|2.5}}||the building tile is processed in the periodic tile processing loop<br />
|-<br />
|1||02||{{ottdp|0.6|2.5}}||the top tile of the building is processed in the periodic tile processing loop<br />
|}<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
=== Industry tile triggers ===<br />
<br />
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.<br />
<br />
{| |-<br />
!Bit!!Value!!Version!!Trigger<br />
|-<br />
|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><br />
|-<br />
|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.<br />
|-<br />
|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.<br />
|}<br />
<references /><br />
<br />
Trigger 1 works similarly to trigger 1 for houses except that you cannot multiply the timeout: it's always 256 ticks.<br />
<br />
Industry tiles can rerandomise both their own random bits as well as the random bits of the industry (via random action type 83).<br />
The remembered triggers for rerandomisation with 80 added to the triggers are in both cases the same per tile.<br />
<br />
Industries have random bits. However, they can only be rerandomised by their tiles.<br />
<br />
=== Canals ===<br />
<br />
Canals / Rivers have 8 random bits.<br />
<br />
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.<br />
<br />
=== Objects ===<br />
<br />
Objects have 8 random bits per tile of the object.<br />
<br />
There are no triggers for objects however.<br />
<br />
Also note that the random bits are unique to each tile in the object, and are not shared across the whole object.<br />
<br />
=== Railtypes ===<br />
<br />
Rail tiles have 2 pseudo random bits, based on tile location.<br />
<br />
There are no triggers.<br />
<br />
=== Roadtypes ===<br />
<br />
Road tiles have 2 pseudo random bits, based on tile location.<br />
<br />
There are no triggers.<br />
<br />
=== Tramtypes ===<br />
<br />
Tram tiles have 2 pseudo random bits, based on tile location.<br />
<br />
There are no triggers.<br />
<br />
=== Other features ===<br />
<br />
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).<br />
<br />
==Example==</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=Action2/Advanced_Sprite_Layout&diff=4660Action2/Advanced Sprite Layout2023-11-30T20:24:44Z<p>Pikkabird: /* Advanced sprite layout using register offsets */</p>
<hr />
<div>== Advanced sprite layout using register offsets ==<br />
<br />
<Sprite-number> * <Length> 02 07/09/0F/11 <set-id> <0x40 + num-sprites><br />
<groundsprite> <flags> [<register/value>]...<br />
[ <buildingsprite> <flags><br />
( <xoffset> <yoffset> <zoffset> <xextent> <yextent> <zextent> <br />
| <xpixeloffset> <ypixeloffset> 80)<br />
[<register/value>]...<br />
]...<br />
<br />
{{ottdp|1.2|no|ottdrev=r22518}}<br />
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. <br />
<br />
{|<br />
!Element!![[GRFActionsDetailed|Size]]!!Description<br />
|-<br />
|&lt;[[#Sprite-number|Sprite-number]]&gt;||dec||A sequential sprite number<br />
|-<br />
|&lt;[[#Length|length]]&gt;||dec||The total number of bytes used in this action<br />
|-<br />
|02||B||Defines action 02<br />
|-<br />
|04/07/09/0F/11/14||B||feature: 07 town buildings, 09 industry tiles, 0F objects, 11 airport tiles, or 14 road stops<br />
|-<br />
|&lt;[[#Set-id|set-id]]&gt;||B||ID for this definition<br />
|-<br />
|40 + &lt;num-sprites&gt;||B||Number of following building sprites (the primary groundsprite mustn't be counted). Allowed range: 0x40+0 to 0x40+63 (0x40 to 0x7F).<br />
|-<br />
|&lt;[[#Sprite definition for ground and building sprites|groundsprite]]&gt;||D||Primary ground sprite for the building (see format below)<br />
|-<br />
|&lt;[[#Flags in advanced sprite layouts|flags]]&gt;||W||Flags for the primary ground sprite (see format below)<br />
|-<br />
|&lt;[[#Register or value in advances sprite layouts|register/value]]&gt;||V||Registers / values to be used. Depending on &lt;flags&gt; (see format below)<br />
|-<br />
|&lt;[[#Sprite definition for ground and building sprites|buildingsprite]]&gt;||D||The sprite to be drawn. Unlike the basic format, zero isn't allowed here.<br />
|-<br />
|&lt;[[#Flags in advanced sprite layouts|flags]]&gt;||W||Flags for the building sprite (see format below)<br />
|-<br />
!colspan="3"| -- for sprites defining a new bounding box --<br />
|-<br />
|&lt;xofs&gt;||B||x-offset from northern tile corner (as a signed byte)<br />
|-<br />
|&lt;yofs&gt;||B||y-offset from northern tile corner (as a signed byte)<br />
|-<br />
|&lt;zofs&gt;||B||z-offset from the ground<br />
|-<br />
|&lt;xextent&gt;||B||size of sprite in x direction<br />
|-<br />
|&lt;yextent&gt;||B||size of sprite in y direction<br />
|-<br />
|&lt;zextent&gt;||B||size of sprite in z direction<br />
|-<br />
!colspan="3"| -- for sprites sharing their bounding box with the previous sprite --<br />
|-<br />
|&lt;xpixeloffset&gt;||B||x offset from the top left corner of the previous sprite<br />
|-<br />
|&lt;ypixeloffset&gt;||B||y offset from the top left corner of the previous sprite<br />
|-<br />
|80||B||a literal 80h byte to distinguish from new-bounding-box definitions<br />
|-<br />
!colspan="3"| &nbsp;<br />
|-<br />
|&lt;[[#Register or value in advances sprite layouts|register/value]]&gt;||V||Registers / values to be used. Depending on &lt;flags&gt; (see format below)<br />
|}<br />
<br />
== Descriptions of elements ==<br />
<br />
=== Sprite-number ===<br />
<br />
This is just the number you are at.<br />
<br />
=== Length ===<br />
<br />
Count the number of bytes in this action.<br />
<br />
=== Set-id ===<br />
<br />
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).<br />
<br />
=== Sprite definition for ground and building sprites ===<br />
<br />
The ground and building sprite fields have the following format:<br />
<br />
{|<br />
!Bits!!Version!!Content<br />
|-<br />
|0-13||{{ottdp|0.6|2.5}}||Sprite number, exact meaning specified by bit 31<br />
|-<br />
|14-15||{{ottdp|0.6|2.5}}||0: draw sprite normally, 1: draw sprite in transparent mode, 2: recolor sprite<br />
|-<br />
|16-29||{{ottdp|0.6|2.5}}||Color translation special sprite number, see below<br />
|-<br />
|30||{{ottdp|0.6|2.5|ttdprev=alpha 57}}||If set, sprite is drawn normally even in transparent buildings mode (for building sprites only)<br />
|-<br />
|31||{{ottdp|0.6|2.5}}||Sprite type, see below<br />
|}<br />
<br />
{{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 "&lt;xpixeloffset&gt; &lt;ypixeloffset&gt; 80"-syntax (see above); for these bit 30 has the same meaning as for building sprites.<br />
<br />
==== Colour translation special sprite number ====<br />
<br />
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.<br />
<br />
For houses, if no recolour sprite is given but recolouring is turned on in bits 14-15, there are two possibilities:<br />
* If you have [[Callbacks#Building colour (1E) |callback 1E]] enabled, it is called to determine the colour mapping.<br />
* If [[Callbacks#Building colour (1E) |callback 1E]] is disabled or fails, one of the colours specified in property 17 will be chosen randomly.<br />
<br />
See [[RecolorSprites]] for a list of available colour translations.<br />
<br />
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.<br />
<br />
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.<br />
<br />
Useful values for ground sprites:<br />
<br />
{|<br />
!Sprite number (decimal)!!Contents<br />
|-<br />
|3924||bare land<br />
|-<br />
|3981||grass<br />
|-<br />
|4061||water<br />
|-<br />
|4550||snow or desert (depending on climate)<br />
|-<br />
|1420||concrete<br />
|}<br />
<br />
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.<br />
<br />
==== Sprite type ====<br />
<br />
If bit 31 is clear, the bottom 14 bits contain a regular TTD sprite number.<br />
<br />
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:<br />
* if there's only one sprite, it's used always<br />
* 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)<br />
* 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)<br />
* 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.<br />
<br />
<br />
=== Flags in advanced sprite layouts ===<br />
<flags> is a bitset of word size with these meanings:<br />
{| border="1"<br />
|-<br />
! Bit !! Hex !! Parentsprite !! Groundsprite/Childsprite<br />
|-<br />
|| 0 || 0001 || Skip bounding box including child sprites || Skip sprite<br />
|-<br />
|| 1 || 0002 <br />
| colspan="2" | Add offset to sprite, disable default usage of construction stage or railtype-offset<br />
|-<br />
|| 2 || 0004 <br />
| colspan="2" | Add offset to recoloursprite<br />
|-<br />
|| 3 || 0008 <br />
| 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)<br />
|-<br />
|| 4 || 0010 || Add offset for <xoffset> and <yoffset> || Add offset for <xpixeloffset><br />
|-<br />
|| 5 || 0020 || Add offset for <zoffset> || Add offset for <ypixeloffset><br />
|-<br />
|| 6 || 0040<br />
| colspan="2" | Resolve sprite with Variable 10 set to a specific value<ref name="action123"><br />
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.<br />
<br><ul><br />
<li>only allowed values currently 0-7</li><br />
<li>the value '2' is used when resolving custom foundations, (so, do not conflict with that)</li><br />
<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><br />
<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><br />
<li>The other registers are defined by the Action 1/2/3 chain with Variable 10 as defined for the sprite.</li><br />
<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><br />
</ul><br />
</ref><br />
|-<br />
|| 7 || 0080<br />
| colspan="2" | Resolve recoloursprite with Variable 10 set to a specific value<ref name="action123"/><br />
|-<br />
|| 8..15 || <br />
| colspan="2" | Reserved, should be zero. If the GRF sets unknown bits, it will be disabled.<br />
|-<br />
|}<br />
<br />
<references /><br />
<br />
=== Register or value in advanced sprite layouts ===<br />
These are the temporary storage registers to add to the individual parts. The register values are considered signed.<br />
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.<br />
Most bits require one register.<br />
*<xoffset> and <yoffset> can only be enabled together, using two registers,<br />
*the "skip bounding box"-register uses value 1 to draw the sprite, and 0 to skip it,<br />
*the "recolorsprite from Action 1" uses no register at all,<br />
*the Variable 10 values are not set via a register, but via a byte-constant.</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=Action2/Sprite_Layout&diff=4659Action2/Sprite Layout2023-11-30T20:24:10Z<p>Pikkabird: add road stops</p>
<hr />
<div>= Action2 Sprite Layout =<br />
{| |-<br />
!Feature !! Version<br />
|-<br />
|Houses || {{ottdp|0.6|2.5}}<br />
|-<br />
|Industry Tiles || {{ottdp|0.6|2.5}}<br />
|-<br />
|Objects || {{ottdp|1.1|2.6|ttdprev=alpha r2023}}<br />
|-<br />
|Airport Tiles || {{ottdp|1.1|no}}<br />
|-<br />
|Road Stops || {{ottdp|14|no}}<br />
|}<br />
<br />
This Action2 defines a spritelayout for a tile. There are three formats available:<br />
* Basic format for a single groundsprite and a single building sprite.<br />
* Extended format for combining multiple sprites.<br />
* Advanced format with register offsets<br />
<br />
== Basic format for tiles with a single building sprite ==<br />
<br />
<pre> &lt;Sprite-number&gt; * &lt;Length&gt; 02 07/09/0F/11/14 &lt;set-id&gt; 00 &lt;groundsprite&gt; &lt;buildingsprite&gt; &lt;xoffset&gt; &lt;yoffset&gt; &lt;xextent&gt; &lt;yextent&gt; &lt;zextent&gt;</pre><br />
<br />
{|<br />
!Element!![[GRFActionsDetailed|Size]]!!Description<br />
|-<br />
|&lt;[[#Sprite-number|Sprite-number]]&gt;||dec||A sequential sprite number<br />
|-<br />
|&lt;[[#Length|length]]&gt;||dec||The total number of bytes used in this action<br />
|-<br />
|02||B||Defines action 02<br />
|-<br />
|07/09/0F/11/14||B||feature: 07 town buildings, 09 industry tiles, 0F objects, 11 airport tiles, or 14 road stops<br />
|-<br />
|&lt;[[#Set-id|set-id]]&gt;||B||ID for this definition<br />
|-<br />
|00||B||Literal 0 (to distinguish this definition from random/variational lists)<br />
|-<br />
|&lt;[[#Sprite definition for ground and building sprites|groundsprite]]&gt;||D||Ground sprite for the building (see format below)<br />
|-<br />
|&lt;[[#Sprite definition for ground and building sprites|buildingsprite]]&gt;||D||The sprite of the building (see format below), can be zero to indicate that no building sprite should be displayed (useful for early building stages)<br />
|-<br />
|&lt;xofs&gt;||B||x-offset from northern tile corner (as a signed byte)<br />
|-<br />
|&lt;yofs&gt;||B||y-offset from northern tile corner (as a signed byte)<br />
|-<br />
|&lt;xextent&gt;||B||size of sprite in x direction<br />
|-<br />
|&lt;yextent&gt;||B||size of sprite in y direction<br />
|-<br />
|&lt;zextent&gt;||B||size of sprite in z direction<br />
|}<br />
<br />
In the above, xofs, yofs, xextent, yextent and zextent define the 3D bounding box of the building sprite not including the ground sprite. The z-offset is always zero for buildings (TTD doesn't support floating buildings). Please note that xofs/xextent and yofs/yextent pairs that place the bounding box off the tile are not recommended.<br />
<br />
== Extended format using multiple combined sprites ==<br />
<br />
{{ottdp|0.6|2.5|ttdprev=2.0.1 alpha 55 vcs 3}} Since TTDPatch 2.0.1 alpha 55 vcs 3, houses, industry (and object) tiles support an extended syntax as well, which looks as follows:<br />
<br />
<pre><nowiki>&lt;Sprite-number&gt; * &lt;Length&gt; 02 07/09/0F/11 &lt;set-id&gt; &lt;num-sprites&gt; &lt;groundsprite&gt; [&lt;buildingsprite&gt; (&lt;xoffset&gt; &lt;yoffset&gt; &lt;zoffset&gt; &lt;xextent&gt; &lt;yextent&gt; &lt;zextent&gt;) | (&lt;xpixeloffset&gt; &lt;ypixeloffset&gt; 80)] ...</nowiki></pre><br />
<br />
{|<br />
!Element!![[GRFActionsDetailed|Size]]!!Description<br />
|-<br />
|&lt;[[#Sprite-number|Sprite-number]]&gt;||dec||A sequential sprite number<br />
|-<br />
|&lt;[[#Length|length]]&gt;||dec||The total number of bytes used in this action<br />
|-<br />
|02||B||Defines action 02<br />
|-<br />
|07/09/0F/11/14||B||feature: 07 town buildings, 09 industry tiles, 0F objects, 11 airport tiles, or 14 road stops<br />
|-<br />
|&lt;[[#Set-id|set-id]]&gt;||B||ID for this definition<br />
|-<br />
|&lt;num-sprites&gt;||B||Number of following building sprites (the groundsprite mustn't be counted). Allowed range: 1 to 63 (0x01 to 0x3F). {{ottdp|1.2|no|ottdrev=r22518}} Adding 0x40 makes the layout an Advanced Spritelayout with register modifiers ([[Action2/Advanced Sprite Layout| see below]]).<br />
|-<br />
|&lt;[[#Sprite definition for ground and building sprites|groundsprite]]&gt;||D||Ground sprite for the building (see format below)<br />
|-<br />
|&lt;[[#Sprite definition for ground and building sprites|buildingsprite]]&gt;||D||The sprite to be drawn. Unlike the basic format, zero isn't allowed here.<br />
|-<br />
!colspan="3"| -- for sprites defining a new bounding box --<br />
|-<br />
|&lt;xofs&gt;||B||x-offset from northern tile corner (as a signed byte)<br />
|-<br />
|&lt;yofs&gt;||B||y-offset from northern tile corner (as a signed byte)<br />
|-<br />
|&lt;zofs&gt;||B||z-offset from the ground<br />
|-<br />
|&lt;xextent&gt;||B||size of sprite in x direction<br />
|-<br />
|&lt;yextent&gt;||B||size of sprite in y direction<br />
|-<br />
|&lt;zextent&gt;||B||size of sprite in z direction<br />
|-<br />
!colspan="3"| -- for sprites sharing their bounding box with the previous sprite --<br />
|-<br />
|&lt;xpixeloffset&gt;||B||x offset from the top left corner of the previous sprite<br />
|-<br />
|&lt;ypixeloffset&gt;||B||y offset from the top left corner of the previous sprite<br />
|-<br />
|80||B||a literal 80h byte to distinguish from new-bounding-box definitions<br />
|}<br />
<br />
Note: restrictions for sprites sharing their bounding box are the same as explained for [[Action0Stations#Sprite layout (09)|station tiles.]]<br />
<br />
{{ottd|0.7|r18959}} Since OpenTTD r18959 you can draw multiple ground sprites for a tile, which is useful if you want to use the usual grass/water/concrete groundtile, but still need to add features to it without using a new bounding box. To do so use the syntax of sprites sharing the previous bounding box, but use it before the first bounding box definition. xpixeloffset and ypixeloffset refer to the usual spot of groundtiles.<br />
<br />
{{ttdp|2.6|r2313}} The same feature is also partially supported in TTDPatch since TTDPatch 2.6 r2313: TTDPatch ignores the xpixeloffset and ypixeloffset fields and always uses (0,0) for the offset. If you are developing a GRF that needs to be compatible with both OpenTTD and TTDPatch, you should always keep xpixeloffset and ypixeloffset zero to get the same effect in both games.<br />
<br />
{{:Action2/Advanced Sprite Layout}}</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=User:Pikkabird&diff=4559User:Pikkabird2023-09-25T05:59:13Z<p>Pikkabird: </p>
<hr />
<div>=Sunshine standard cost calculations=<br />
<br />
For ease of balancing, vehicles use the same number for purchase and running cost, but with different base multipliers.<br />
<br />
==Running cost base multipliers in NFO / NML==<br />
<br />
* 07 / -1 locomotive purchase cost<br />
* 0b / 3 locomotive running cost (steam locomotive basecost used for all locomotives, regardless of type)<br />
* 0b / 3 wagon purchase cost<br />
* 05 / -3 wagon running cost (diesel locomotive basecost used)<br />
<br />
* 0a / 2 road vehicle purchase cost<br />
* 0a / 2 road vehicle running cost<br />
<br />
* 08 / 0 aircraft purchase cost<br />
* 0d / 5 aircraft running cost<br />
<br />
I usually include a GRF parameter to halve all purchase and running costs (by decreasing the bases by 1).<br />
<br />
==Variable running cost==<br />
<br />
You should reduce the running costs of vehicles to 25% when the vehicle is stationary (current_speed == 0) for rail locomotives (ie not wagons), road vehicles and ships, or when an aircraft is on the ground (variable e6 != 12). This balancing feature improves profitability of shorter connections, vs the meta of building the longest possible routes from one side of the map to the other. <br />
<br />
==Cost formulas==<br />
<br />
"p" may be either metric or imperial horsepower; these units are similar enough that the results will be comparable. For those using SI units, the conversion factor is 1 kW = 1.35 hp.<br />
<br />
* Locomotives: (p * 0.025) + (s * 0.1) + (c * 0.1) + ((2000 - y) * 0.1) <br />
** Where p = power in hp, s = speed in km/h, y = year of introduction, c = passenger capacity.<br />
<br />
* Wagons: (s * 0.5) + (c * l)<br />
** Where s = speed in km/h, c = capacity, l = "luxury" value (1 for passengers, 0.5 for freight).<br />
<br />
* Road Vehicles: (p * 0.1) + (c * l) + ((2000 - y) * 0.1)<br />
** Where p = power in hp, c = capacity, l = "luxury" value (1 for passengers, 0.5 for freight), y = year of introduction.<br />
<br />
* Aircraft: (s * s / 25000) + (c * 0.2) + ((2000 - y) * 0.1)<br />
** Where s = speed in km/h, c = passenger capacity, y = year of introduction.<br />
<br />
* Ships: TBD<br />
<br />
If you have very overpowered vehicles in your set, the calculated numbers may exceed 255; in that case, you'll have to increase the relevant bases by 1, and divide costs by 2.</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=User:Pikkabird&diff=4558User:Pikkabird2023-09-25T05:58:06Z<p>Pikkabird: </p>
<hr />
<div>=Sunshine standard cost calculations=<br />
<br />
For ease of balancing, vehicles use the same number for purchase and running cost, but with different base multipliers. The standard base multipliers for Sunshine are:<br />
<br />
==Running cost bases in NFO / NML==<br />
<br />
* 07 / -1 locomotive purchase cost<br />
* 0b / 3 locomotive running cost (steam locomotive basecost used for all locomotives, regardless of type)<br />
* 0b / 3 wagon purchase cost<br />
* 05 / -3 wagon running cost (diesel locomotive basecost used)<br />
<br />
* 0a / 2 road vehicle purchase cost<br />
* 0a / 2 road vehicle running cost<br />
<br />
* 08 / 0 aircraft purchase cost<br />
* 0d / 5 aircraft running cost<br />
<br />
I usually include a GRF parameter to halve all purchase and running costs (by decreasing the bases by 1).<br />
<br />
==Variable running cost==<br />
<br />
You should reduce the running costs of vehicles to 25% when the vehicle is stationary (current_speed == 0) for rail locomotives (ie not wagons), road vehicles and ships, or when an aircraft is on the ground (variable e6 != 12). This balancing feature improves profitability of shorter connections, vs the meta of building the longest possible routes from one side of the map to the other. <br />
<br />
==Cost formulas==<br />
<br />
"p" may be either metric or imperial horsepower; these units are similar enough that the results will be comparable. For those using SI units, the conversion factor is 1 kW = 1.35 hp.<br />
<br />
* Locomotives: (p * 0.025) + (s * 0.1) + (c * 0.1) + ((2000 - y) * 0.1) <br />
** Where p = power in hp, s = speed in km/h, y = year of introduction, c = passenger capacity.<br />
<br />
* Wagons: (s * 0.5) + (c * l)<br />
** Where s = speed in km/h, c = capacity, l = "luxury" value (1 for passengers, 0.5 for freight).<br />
<br />
* Road Vehicles: (p * 0.1) + (c * l) + ((2000 - y) * 0.1)<br />
** Where p = power in hp, c = capacity, l = "luxury" value (1 for passengers, 0.5 for freight), y = year of introduction.<br />
<br />
* Aircraft: (s * s / 25000) + (c * 0.2) + ((2000 - y) * 0.1)<br />
** Where s = speed in km/h, c = passenger capacity, y = year of introduction.<br />
<br />
* Ships: TBD<br />
<br />
If you have very overpowered vehicles in your set, the calculated numbers may exceed 255; in that case, you'll have to increase the relevant bases by 1, and divide costs by 2.</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=User:Pikkabird&diff=4557User:Pikkabird2023-09-25T05:57:52Z<p>Pikkabird: </p>
<hr />
<div>=Cost calculations=<br />
<br />
For ease of balancing, vehicles use the same number for purchase and running cost, but with different base multipliers. The standard base multipliers for Sunshine are:<br />
<br />
==Running cost bases in NFO / NML==<br />
<br />
* 07 / -1 locomotive purchase cost<br />
* 0b / 3 locomotive running cost (steam locomotive basecost used for all locomotives, regardless of type)<br />
* 0b / 3 wagon purchase cost<br />
* 05 / -3 wagon running cost (diesel locomotive basecost used)<br />
<br />
* 0a / 2 road vehicle purchase cost<br />
* 0a / 2 road vehicle running cost<br />
<br />
* 08 / 0 aircraft purchase cost<br />
* 0d / 5 aircraft running cost<br />
<br />
I usually include a GRF parameter to halve all purchase and running costs (by decreasing the bases by 1).<br />
<br />
==Variable running cost==<br />
<br />
You should reduce the running costs of vehicles to 25% when the vehicle is stationary (current_speed == 0) for rail locomotives (ie not wagons), road vehicles and ships, or when an aircraft is on the ground (variable e6 != 12). This balancing feature improves profitability of shorter connections, vs the meta of building the longest possible routes from one side of the map to the other. <br />
<br />
==Cost formulas==<br />
<br />
"p" may be either metric or imperial horsepower; these units are similar enough that the results will be comparable. For those using SI units, the conversion factor is 1 kW = 1.35 hp.<br />
<br />
* Locomotives: (p * 0.025) + (s * 0.1) + (c * 0.1) + ((2000 - y) * 0.1) <br />
** Where p = power in hp, s = speed in km/h, y = year of introduction, c = passenger capacity.<br />
<br />
* Wagons: (s * 0.5) + (c * l)<br />
** Where s = speed in km/h, c = capacity, l = "luxury" value (1 for passengers, 0.5 for freight).<br />
<br />
* Road Vehicles: (p * 0.1) + (c * l) + ((2000 - y) * 0.1)<br />
** Where p = power in hp, c = capacity, l = "luxury" value (1 for passengers, 0.5 for freight), y = year of introduction.<br />
<br />
* Aircraft: (s * s / 25000) + (c * 0.2) + ((2000 - y) * 0.1)<br />
** Where s = speed in km/h, c = passenger capacity, y = year of introduction.<br />
<br />
* Ships: TBD<br />
<br />
If you have very overpowered vehicles in your set, the calculated numbers may exceed 255; in that case, you'll have to increase the relevant bases by 1, and divide costs by 2.</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=User:Pikkabird&diff=4556User:Pikkabird2023-09-25T05:51:40Z<p>Pikkabird: </p>
<hr />
<div>=Cost calculations=<br />
<br />
For ease of balancing, vehicles use the same number for purchase and running cost, but with different base multipliers. The standard base multipliers are:<br />
<br />
==Running cost bases in NFO / NML==<br />
<br />
* 07 / -1 locomotive purchase cost<br />
* 0b / 3 locomotive running cost (steam locomotive basecost used for all locomotives, regardless of type)<br />
* 0b / 3 wagon purchase cost<br />
* 05 / -3 wagon running cost (diesel locomotive basecost used)<br />
<br />
* 0a / 2 road vehicle purchase cost<br />
* 0a / 2 road vehicle running cost<br />
<br />
* 08 / 0 aircraft purchase cost<br />
* 0d / 5 aircraft running cost<br />
<br />
I usually include a GRF parameter to halve all purchase and running costs (by decreasing the bases by 1).<br />
<br />
==Variable running cost==<br />
<br />
You should reduce the running costs of vehicles to 25% when the vehicle is stationary (current_speed == 0) for rail locomotives (ie not wagons), road vehicles and ships, or when an aircraft is on the ground (variable e6 != 12). This balancing feature improves profitability of shorter connections, vs the meta of building the longest possible routes from one side of the map to the other. <br />
<br />
==Cost formulas==<br />
<br />
"p" may be either metric or imperial horsepower; these units are similar enough that the results will be comparable. For those using SI units, the conversion factor is 1 kW = 1.35 hp.<br />
<br />
* Locomotives: (p * 0.025) + (s * 0.1) + (c * 0.1) + ((2000 - y) * 0.1) <br />
** Where p = power in hp, s = speed in km/h, y = year of introduction, c = passenger capacity.<br />
<br />
* Wagons: (s * 0.5) + (c * l)<br />
** Where s = speed in km/h, c = capacity, l = "luxury" value (1 for passengers, 0.5 for freight).<br />
<br />
* Road Vehicles: (p * 0.1) + (c * l) + ((2000 - y) * 0.1)<br />
** Where p = power in hp, c = capacity, l = "luxury" value (1 for passengers, 0.5 for freight), y = year of introduction.<br />
<br />
* Aircraft: (s * s / 25000) + (c * 0.2) + ((2000 - y) * 0.1)<br />
** Where s = speed in km/h, c = passenger capacity, y = year of introduction.<br />
<br />
* Ships: TBD<br />
<br />
If you have very overpowered vehicles in your set, the calculated numbers may exceed 255; in that case, you'll have to increase the relevant bases by 1, and divide costs by 2.</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=User:Pikkabird&diff=4555User:Pikkabird2023-09-25T05:48:48Z<p>Pikkabird: Created page with "Cost calculations: For ease of balancing, vehicles use the same number for purchase and running cost, but with different base multipliers. The standard base multipliers are:..."</p>
<hr />
<div>Cost calculations:<br />
For ease of balancing, vehicles use the same number for purchase and running cost, but with different base multipliers. The standard base multipliers are:<br />
<br />
Running cost bases in NFO / NML:<br />
07 / -1 locomotive purchase cost<br />
0b / 3 locomotive running cost (steam locomotive basecost used for all locomotives, regardless of type)<br />
0b / 3 wagon purchase cost<br />
05 / -3 wagon running cost (diesel locomotive basecost used)<br />
<br />
0a / 2 road vehicle purchase cost<br />
0a / 2 road vehicle running cost<br />
<br />
08 / 0 aircraft purchase cost<br />
0d / 5 aircraft running cost<br />
<br />
I usually include a GRF parameter to halve all purchase and running costs (by decreasing the bases by 1).<br />
<br />
<br />
Variable running cost:<br />
<br />
You should reduce the running costs of vehicles to 25% when the vehicle is stationary (current_speed == 0) for rail locomotives (ie not wagons), road vehicles and ships, or when an aircraft is on the ground (variable e6 != 12). This balancing feature improves profitability of shorter connections, vs the meta of building the longest possible routes from one side of the map to the other. <br />
<br />
Cost formulas:<br />
<br />
"p" may be either metric or imperial horsepower; these units are similar enough that the results will be comparable. For those using SI units, the conversion factor is 1 kW = 1.35 hp.<br />
<br />
Locomotives: (p * 0.025) + (s * 0.1) + (c * 0.1) + ((2000 - y) * 0.1) <br />
Where p = power in hp, s = speed in km/h, y = year of introduction, c = passenger capacity.<br />
<br />
Wagons: (s * 0.5) + (c * l)<br />
Where s = speed in km/h, c = capacity, l = "luxury" value (1 for passengers, 0.5 for freight).<br />
<br />
Road Vehicles: (p * 0.1) + (c * l) + ((2000 - y) * 0.1)<br />
Where p = power in hp, c = capacity, l = "luxury" value (1 for passengers, 0.5 for freight), y = year of introduction.<br />
<br />
Aircraft: (s * s / 25000) + (c * 0.2) + ((2000 - y) * 0.1)<br />
Where s = speed in km/h, c = passenger capacity, y = year of introduction.<br />
<br />
Ships: TBD<br />
<br />
If you have very overpowered vehicles in your set, the calculated numbers may exceed 255; in that case, you'll have to increase the relevant bases by 1, and divide costs by 2.</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=NML:Airports&diff=4554NML:Airports2023-09-24T01:34:53Z<p>Pikkabird: grf -> airport in tile check</p>
<hr />
<div>{{NMLNavPropVarCB}}<br />
<br />
Airports and airport tiles can only be defined in OpenTTD {{ottd|1.1|r19459}} or later.<br />
<br />
==Airport (tile) IDs==<br />
Airport and airport tile IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range. For airport tiles, you should start your item definition with the 'substitute'-property, which allocates a new airport tile. The value of this property should be the ID of a [[AirportTileDefaultProps|default airport tile]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).<br />
<br />
Furthermore, you can set the 'override'-property, which will cause the existing airport tile to be replaced with your item. For airports, there only is an 'override'-property, which acts as a combined substitute and override.<br />
<br />
==Airport properties==<br />
<br />
{| class="wikitable sortable"<br />
! name<br />
! value range<br />
! comment<br />
|-<br />
| override<br />
|<br />
|<br />
{{ottd|1.1|r19459}} The id of airport to replace / override, see [[AirportTypes]]. '''This property ''must'' be set first, before any other properties or graphics.'''<br />
|-<br />
| layouts<br />
| list of layouts<br />
|<br />
{{ottd|1.1|r20377}}<br />
|-<br />
| name<br />
| string<br />
|<br />
{{ottd|1.1|r19459}} Name of the airport<br />
|-<br />
| years_available<br />
| [start year, last year]<br />
|<br />
{{ottd|1.1|r19459}} List of the availablility years: first and last year it can be built<br />
|-<br />
| ttd_airport-type<br />
| 0 ... 3<br />
|<br />
{{ottd|1.1|r19459}} Substitute TTDPatch airport type<br />
|-<br />
| catchment_area<br />
|<br />
|<br />
{{ottd|1.1|r19459}} Catchment area of the airport in tiles around its perimeter<br />
|-<br />
| noise_level<br />
|<br />
|<br />
{{ottd|1.1|r19459}} Noise generation of this airport<br />
|-<br />
| maintenance_cost<br />
|<br />
|<br />
{{ottd|1.2|r23415}} Maintenance cost factor for this airport<br />
|}<br />
<br />
==Airport tile properties==<br />
<br />
{| class="wikitable sortable"<br />
! name<br />
! value range<br />
! comment<br />
|-<br />
| override<br />
|<br />
|<br />
{{ottd|1.1|r19204}} The id of airport tile to override, see [[AirportTypes]]. '''This property ''must'' be set first, before any other properties or graphics.'''<br />
|-<br />
| substitute<br />
|<br />
|<br />
{{ottd|1.1|r19204}} The id of airport tile to replace<br />
|-<br />
| callback_flags<br />
| bitmask<br />
|<br />
{{ottd|1.1|r19204}} Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].<br />
|-<br />
| animation_info<br />
| Array [ANIMATION_XXX, frame-count]<br />
|{{ottd|1.1|r19204}} XXX = [LOOPING <nowiki>|</nowiki> NON_LOOPING], 1..253 frames<br />
|-<br />
| animation_speed<br />
|<br />
|<br />
{{ottd|1.1|r19204}} See [[NML:Animation speed|speed settings]]<br />
|-<br />
| animation_triggers<br />
| bitmask(ANIM_TRIGGER_APT_XXX, ... )<br />
|<br />
{{ottd|1.1|r19204}} Bitmask of triggers that will trigger the <code style="color:darkgreen">anim_control</code> callback, see the [[#Animation triggers|table]] below.<br />
|}<br />
<br />
==Airport variables==<br />
<br />
A number of variables are shared between airports and stations. These are listed on the [[NML:Stations#Base station variables|stations]] page.<br />
<br />
{| class="t"<br />
! name<br />
! value range<br />
! comment<br />
|-<br />
| layout<br />
| 0 .. (number of layouts - 1)<br />
|<br />
{{ottd|1.1|r20364}} Layout number of the airport (index in the layouts array)<br />
|}<br />
<br />
==Airport tile variables==<br />
<br />
{| class="wikitable sortable"<br />
! name<br />
! value range<br />
! comment<br />
|-<br />
| terrain_type<br />
|<br />
|<br />
|-<br />
| town_radius_group<br />
|<br />
|<br />
|-<br />
| relative_x<br />
| 0..255<br />
| X-coordinate (top right -&gt; bottom left) of the tile relative to the northernmost tile.<br />
|-<br />
| relative_y<br />
| 0..255<br />
| Y-coordinate (top left -&gt; bottom right) of the tile relative to the northernmost tile.<br />
|-<br />
| relative_pos<br />
| 0xYYXX<br />
|<br />
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.<br />
|-<br />
| animation_frame<br />
|<br />
|<br />
|-<br />
| random_bits_station<br />
| 0..65535<br />
| 16 random bits, shared between all station parts (rail station parts, airports tiles, ...)<br />
|-<br />
| random_bits_tile<br />
| 0..15<br />
| 4 random bits, specific to this station tile.<br />
|}<br />
<br />
<br />
The following variables require a signed x,y offset as parameters. The offset is relative to the current tile. Offset 0,0 means the current tile.<br />
<br />
{| class="wikitable sortable"<br />
! name<br />
! value range<br />
! comment<br />
|-<br />
| nearby_tile_slope<br />
| SLOPE_XXX<br />
|<br />
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values<br />
|-<br />
| nearby_tile_is_same_airport<br />
| 1 if the tile is part of the same airport, 0 otherwise<br />
|<br />
|-<br />
| nearby_tile_is_water<br />
| 1 if the tile is water, 0 otherwise<br />
|<br />
|-<br />
| nearby_tile_terrain_type<br />
| TILETYPE_XX<br />
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW<br />
|-<br />
| nearby_tile_water_class<br />
| WATER_CLASS_XXX<br />
| 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.<br />
|-<br />
| nearby_tile_height<br />
| 0..120<br />
| The height of the lowest corner of the given tile.<br />
|-<br />
| nearby_tile_class<br />
|<br />
[[NML:List of tile classes|Tile class]]<br />
|<br />
|-<br />
| nearby_tile_animation_frame<br />
| 0..255<br />
| Animation frame of the given tile<br />
|-<br />
| nearby_tile_airporttile_id<br />
| 0x00aa, 0xFFbb, 0xFFFE or 0xFFFF<br />
| 0x00aa: The tile is an airport tile that is part of this GRF, the tile id is aa.<br /> 0xFFbb: The tile is an original airport tile with id bb.<br /> 0xFFFE: The tile is an airport tile defined in another GRF.<br /> 0xFFFF: The tile is not an airport tile or it belongs to another airport.<br />
|}<br />
<br />
==Airport callbacks==<br />
<br />
{| class="wikitable sortable"<br />
! callback<br />
! return value<br />
! comment<br />
|-<br />
| default<br />
| Sprite set (with 1 sprite)<br />
| Preview graphics to use in the build menu. One sprite per layout may be given, use the <code style="color:darkgreen">layout</code> to distinguish between layouts.<br />
|-<br />
| additional_text<br />
| String<br />
| Additional text to show in the buy menu. String may differ per layout, use the <code style="color:darkgreen">layout</code> variable for this.<br />
|-<br />
| layout_name<br />
| String<br />
| Name of the airport layout in the variable <code style="color:darkgreen">layout</code><br />
|}<br />
<br />
Note that, although the airport isn't built yet, the <code style="color:darkgreen">layout</code> variable is always available and set to the layout the user has selected in the GUI.<br />
<br />
<br />
==Airport tile callbacks==<br />
<br />
{| class="wikitable sortable"<br />
! callback<br />
! return value<br />
! comment<br />
|-<br />
| default<br />
| Sprite layout<br />
| Graphics for an airport tile<br />
|-<br />
| anim_next_frame<br />
| Next animation frame or CB_RESULT_XXX<br />
| 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.<br />
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits.<br />
|-<br />
| anim_control<br />
| Next animation frame or CB_RESULT_XXX<br />
|<br />
Called whenever an 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.<br />
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits.<br />
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for callback trigger, see the [[#Animation triggers|table]] below. Note that you need to enable the wanted triggers in the <code style="color:darkgreen">animation_triggers</code> property.<br />
|-<br />
| anim_speed<br />
| 0 .. 16<br />
| 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.<br />
|-<br />
| foundations<br />
| CB_RESULT[_NO]_FOUNDATIONS<br />
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.<br />
|}<br />
<br />
<br />
===Animation triggers===<br />
<br />
{| class="wikitable sortable"<br />
! Animation trigger<br />
! Description<br />
|-<br />
| ANIM_TRIGGER_APT_BUILT<br />
| Airport is built (all tiles at the same time)<br />
|-<br />
| ANIM_TRIGGER_APT_TILELOOP<br />
| Airport tile is processed in the tileloop (at different times for different tiles)<br />
|-<br />
| ANIM_TRIGGER_APT_NEW_CARGO<br />
| New cargo arrives at the airport (all tiles at the same time)<br />
|-<br />
| ANIM_TRIGGER_APT_CARGO_TAKEN<br />
| All cargo of a cargo type is removed from the airport (all tiles at the same time)<br />
|-<br />
| ANIM_TRIGGER_APT_250_TICKS<br />
| Every 250 ticks (all tiles at the same time)<br />
|-<br />
| ANIM_TRIGGER_APT_AIRPLANE_LANDS<br />
| {{ottd|1.9}} Triggered when an airplane (not a helicopter!) lands at airport (single tile only)<br />
|}</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=NML:IndustryCommonVariables&diff=4553NML:IndustryCommonVariables2023-09-24T01:31:31Z<p>Pikkabird: /* Common variables */ returns -1 if belongs to another *industry*, not "another grf"</p>
<hr />
<div>==Common variables==<br />
<br />
The following variables are available to both industries and industry tiles. All of them require an x, y offset. For industries, this offset is unsigned and relative to the northernmost tile. For industry tiles, it is signed and relative to the current tile.<br />
<br />
{| class="wikitable sortable"<br />
! name<br />
! value range<br />
! comment<br />
|-<br />
| nearby_tile_slope<br />
| SLOPE_XXX<br />
|<br />
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values<br />
|-<br />
| nearby_tile_is_water<br />
| 1 if the tile is water, 0 otherwise<br />
|<br />
|-<br />
| nearby_tile_terrain_type<br />
| TILETYPE_XX<br />
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW<br />
|-<br />
| nearby_tile_water_class<br />
| WATER_CLASS_XXX<br />
| 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.<br />
|-<br />
| nearby_tile_height<br />
| 0..120<br />
| The height of the lowest corner of the given tile.<br />
|-<br />
| nearby_tile_class<br />
|<br />
[[NML:List of tile classes|Tile class]]<br />
|<br />
|-<br />
| nearby_tile_animation_frame<br />
| 0..255<br />
| Animation frame of the given tile<br />
|-<br />
| nearby_tile_industrytile_id<br />
| 0x00aa, 0xFFbb, 0xFFFE or 0xFFFF<br />
| 0x00aa: The tile is an industry tile defined in this GRF with tile id aa.<br /> 0xFFbb: The tile is an original industry tile with id bb.<br /> 0xFFFE: The tile is an industry tile defined in another GRF.<br /> 0xFFFF: The tile is not an industry tile or it belongs to another industry.<br />
|}</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=NML:Industries&diff=4167NML:Industries2022-02-04T05:43:49Z<p>Pikkabird: /* Industry callbacks */</p>
<hr />
<div>{{NMLNavPropVarCB}}<br />
<br />
This page contains information on industry properties, variables and callbacks. [[NML:IndustryTiles|Industry tiles]] are closely related.<br />
<br />
== Industry ID allocation ==<br />
Industry IDs are local to the NewGRF, you are free to choose any ID in the 0..127-range. You should start your item definition with the 'substitute'-property, which allocates a new industry. The value of this property should be the ID of a [[IndustryDefaultProps|default industry]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF). <br />
<br />
Furthermore, you can set the 'override'-property, which will cause the existing industry to be replaced with your item. You should use this if you are for example defining a coal mine which changes production more dynamically. If your type is not a direct replacement of an existing item, don't set this property.<br />
<br />
==Industry properties==<br />
<br />
Industry properties. Default industry type numbers can be found at [[NML:Default industries|default industries]].<br />
<br />
{| class="t"<br />
! property<br />
! value range<br />
! comment<br />
|-<br />
| substitute<br />
| industry type<br />
| Number of the original industry type that replaces this one, should it not be available for some reason (e.g. missing NewGRF). '''This property ''must'' be set first, before any other properties or graphics.''' All properties of the old type are copied to your new industry.<br />
|-<br />
| override<br />
| industry type<br />
| Number of the original industry type overridden. This will cause other grfs / industries to consider your industry type the same as the old type. Only set this property if your type is (more or less) the same as the old type.<br />
|-<br />
| layouts<br />
| Array of tilelayouts<br />
|<br />
See [[NML:Tilelayout|Tilelayout]] syntax.<br />
|-<br />
| life_type<br />
| One of IND_LIFE_TYPE_XXX, XXX = BLACK_HOLE <nowiki>|</nowiki> EXTRACTIVE <nowiki>|</nowiki> ORGANIC <nowiki>|</nowiki> PROCESSING<br />
| The generic type of industry. This determines the production changes that occur by default (when not using the callback). Examples are respectively power plants, coal mines, forests en steel mills.<br />
|-<br />
| closure_msg<br />
| string<br />
|<br />
Message displayed when the industry announces closure. Use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].<br />
|-<br />
| prod_increase_msg<br />
| string<br />
|<br />
Message displayed when industry increases production. Use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].<br />
|-<br />
| prod_decrease_msg<br />
| string<br />
|<br />
Message displayed when industry decreases production. Use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].<br />
|-<br />
| fund_cost_multiplier<br />
| 0..255<br />
| Fund cost multiplier. Note that in OpenTTD the unmodified base cost is 8x higher for building (not prospecting) raw (=extractive / organic, see life_type) industries.<br />
|-<br />
| cargo_types<br />
| array of accept_cargo(input, outputs...) and produce_cargo(output, level) expressions<br />
| {{nml|0.5}} {{ottd|1.9}} Types of cargo accepted and produced by the industry, and their production levels and production multipliers. See [[#Cargo_types_array|cargo types array]] below.<br />
|-<br />
| prod_cargo_types<br />
| array of up to 2 ints<br />
| {{nml|0.4}} Types of cargo produced. Use the cargotype(&lt;label&gt;) built-in function to specify a label from the cargotable. {{nml|0.5}} Removed, use cargo_types instead.<br />
|-<br />
| accept_cargo_types<br />
| array of up to 3 ints<br />
| {{nml|0.4}} Types of cargo accepted. Use the cargotype(&lt;label&gt;) built-in function to specify a label from the cargotable. {{nml|0.5}} Removed, use cargo_types instead.<br />
|-<br />
| prod_multiplier<br />
| array of up to 2 ints (0..255)<br />
| {{nml|0.4}} Amount of each output cargo to produce every 256 ticks (8 or 9 times a month) {{nml|0.5}} Removed, use cargo_types instead.<br />
|-<br />
| min_cargo_distr<br />
| 0..255<br />
| Minimal amount of cargo before transporting to stations.<br />
|-<br />
| random_sound_effects<br />
| array of ints<br />
| Sound effect numbers that are played some times.<br />
|-<br />
| conflicting_ind_types<br />
| array of up to 3x industry_type(IND_TYPE_OLD <nowiki>|</nowiki> IND_TYPE_NEW, id)<br />
|<br />
Three industry types that should not be nearby. Use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">industry_type(..)</code> to define either an old industry (using the global ID) or a new industry from your grf (using the grf-local ID).<br />
|-<br />
| prob_random<br />
| 0..255<br />
| (up to NML v5796-418, use prob_map_gen otherwise) Probability of occurring while generating initial industries. If the random game probability value is nonzero and IND_FLAG_DO_NOT_FORCE_INSTANCE_AT_MAP_GENERATION is not set, at least one instance of this type is guaranteed to appear on the map.<br />
|-<br />
| prob_map_gen<br />
| 0..255<br />
| (NML v5796-418 or newer) Probability of occurring while generating initial industries. If the random game probability value is nonzero and IND_FLAG_DO_NOT_FORCE_INSTANCE_AT_MAP_GENERATION is not set, at least one instance of this type is guaranteed to appear on the map.<br />
|-<br />
| prob_in_game<br />
| 0..255<br />
| Probability of occurring while creating industries during the game.<br />
|-<br />
| map_colour<br />
| 0..255<br />
|<br />
Colour index from the [[NML:Graphic files|DOS palette]] to use on the minimap for this industry.<br />
|-<br />
| spec_flags<br />
| bitmask(flags)<br />
|<br />
for flag values see [[#industry_special_flags|Industry special flags]]<br />
|-<br />
| new_ind_msg<br />
| string<br />
| Message displayed when industry gets built during game play.<br />
|-<br />
| input_multiplier_1<br />
| array of up to 2 floats (0..255)<br />
| {{nml|0.4}} Output cargo multiplication factors for getting a unit of the first accepted cargo. {{nml|0.5}} Removed, use cargo_types instead.<br />
|-<br />
| input_multiplier_2<br />
| array of up to 2 floats (0..255)<br />
| {{nml|0.4}} Output cargo multiplication factors for getting a unit of the second accepted cargo. {{nml|0.5}} Removed, use cargo_types instead.<br />
|-<br />
| input_multiplier_3<br />
| array of up to 2 floats (0..255)<br />
| {{nml|0.4}} Output cargo multiplication factors for getting a unit of the third accepted cargo. {{nml|0.5}} Removed, use cargo_types instead.<br />
|-<br />
| name<br />
| string<br />
|<br />
Name of the industry, use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].<br />
|-<br />
| prospect_chance<br />
| 0 .. 1 (float)<br />
| Chance of successful prospecting.<br />
|-<br />
| callback_flags<br />
| bitmask(flags)<br />
|<br />
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].<br />
|-<br />
| remove_cost_multiplier<br />
| int<br />
| Cost multiplier for removing the industry (currently only possible with magic bulldozer).<br />
|-<br />
| nearby_station_name<br />
| string<br />
| Default additional name for a nearby station<br />
|}<br />
<br />
===Cargo types array===<br />
The ''cargo_types'' property takes an array of accept_cargo and produce_cargo expressions. This array is used to define which cargo types the industry accepts, which it produces, and how much cargo is produced on production ticks and on delivery. All cargo types the industry handles must be mentioned in its ''cargo_types'' property even when they are handled by production callbacks.<br />
<br />
The following is an example of a ''cargo_types'' property:<br />
<br />
cargo_types: [<br />
produce_cargo("GOOD", 4),<br />
accept_cargo("PASS"),<br />
produce_cargo("PASS", 0),<br />
accept_cargo("IORE", produce_cargo("STEL", 1), produce_cargo("SLAG", 0.25))<br />
]<br />
<br />
The above example has four items in its ''cargo_types'' array, two produce_cargo expressions and two accept_cargo expressions.<br />
<br />
# <code>produce_cargo("GOOD", 4)</code> specifies the industry produces GOOD at a rate of 4 every production tick (256 game ticks), this production rate is scaled by the industry's production level.<br />
# <code>accept_cargo("PASS")</code> specifies the industry accepts PASS as a "black hole", that is no cargo is produced when PASS is delivered. If you have a production callback that consumes a cargo you will also need to specify that cargo in this way.<br />
# <code>produce_cargo("PASS", 0)</code> specifies the industry produces PASS but not on the production ticks as usual. Specifying a production rate of zero is only useful for cargo types you produce via a production callback.<br />
# <code>accept_cargo("IORE", produce_cargo(...), ...)</code> specifies the industry produces the listed cargo types every time IORE is delivered. In the example above, delivering one IORE will result in one STEL produced and no SLAG produced (because 1*0.25 is zero after rounding down), and delivering 4 IORE will result in 4 STEL and 1 SLAG produced.<br />
<br />
At most 16 different cargo labels may appear in accept_cargo and at most 16 different cargo labels in produce_cargo, for a single industry. The same cargo label can be used in as many accept_cargo or produce_cargo as necessary.<br />
<br />
More complex production rules can be set up via the production callbacks, see [[#Industry_callbacks|callbacks]] below.<br />
<br />
===Industry special flags===<br />
<br />
{| class="t"<br />
! flag<br />
! meaning<br />
|-<br />
| IND_FLAG_PLANT_FIELDS_PERIODICALLY<br />
| The industry periodically plants fields around itself (temperate and arctic farms)<br />
|-<br />
| IND_FLAG_CUT_TREES<br />
| The industry cuts trees around itself and produces its first output cargo from them (lumber mill)<br />
|-<br />
| IND_FLAG_BUILT_ON_WATER<br />
| The industry is built on water (oil rig)<br />
|-<br />
| IND_FLAG_ONLY_IN_LARGE_TOWNS<br />
| The industry can only be built in towns (i.e. it has to replace houses) with population larger than 1200 (temperate bank)<br />
|-<br />
| IND_FLAG_ONLY_IN_TOWNS<br />
| The industry can only be built in towns (i.e. it has to replace houses) (arctic and tropic banks, water tower)<br />
|-<br />
| IND_FLAG_BUILT_NEAR_TOWN<br />
| The industry is always built near towns (i.e. near town sign; additionally the industry is allowed to replace houses) (toy shop)<br />
|-<br />
| IND_FLAG_PLANT_FIELDS_WHEN_BUILT<br />
| Fields are planted around the industry when it's built (all farms)<br />
|-<br />
| IND_FLAG_NO_PRODUCTION_INCREASE<br />
| The industry cannot increase its production on the temperate climate (oil wells)<br />
|-<br />
| IND_FLAG_BUILT_ONLY_BEFORE_1950<br />
| The industry is built only before 1950 (oil wells)<br />
|-<br />
| IND_FLAG_BUILT_ONLY_AFTER_1960<br />
| The industry is built only after 1960 (oil rig)<br />
|-<br />
| IND_FLAG_AI_CREATES_AIR_AND_SHIP_ROUTES<br />
| AI players will attempt to establish air and ship routes going to this industry (oil rig)<br />
|-<br />
| IND_FLAG_MILITARY_AIRPLANE_CAN_EXPLODE<br />
| The industry can be exploded by a military airplane (oil refinery)<br />
|-<br />
| IND_FLAG_MILITARY_HELICOPTER_CAN_EXPLODE<br />
| The industry can be exploded by a military helicopter (factory)<br />
|-<br />
| IND_FLAG_CAN_CAUSE_SUBSIDENCE<br />
| The industry can cause a subsidence (coal mine)<br />
|-<br />
| IND_FLAG_AUTOMATIC_PRODUCTION_MULTIPLIER<br />
| Automatic production multiplier handing (No industry has this bit set by default.).<br />
|-<br />
| IND_FLAG_RANDOM_BITS_IN_PRODUCTION_CALLBACK<br />
| The production callback needs random bits in var. 10 (No industry has this bit set by default.)<br />
|-<br />
| IND_FLAG_DO_NOT_FORCE_INSTANCE_AT_MAP_GENERATION<br />
| Do not force one instance of this type to appear during initial map generation (No industry has this bit set by default.)<br />
|-<br />
| IND_FLAG_ALLOW_CLOSING_LAST_INSTANCE<br />
| Allow closing down the last instance of this type (No industry has this bit set by default.)<br />
|-<br />
| IND_FLAG_LONG_CARGO_TYPE_LISTS<br />
| New format for callbacks <code>callbacks cargo_subtype_display</code>, <code>cargo_input</code>, <code> cargo_output</code> to support more input/output cargos. See the callbacks for details.<br />
|}<br />
<br />
{{NML:IndustryCommonVariables}}<br />
<br />
==Industry variables==<br />
<br />
{| class="t"<br />
! name<br />
! value range<br />
! comment<br />
|-<br />
| production_level<br />
| 0, or 4 .. 128<br />
| Current production level of the industry. Usually in range 4 .. 128, default starting level is 16. A level of 0 indicates imminent closure.<br />
|-<br />
| waiting_cargo_1<br />
| 0..65535<br />
| If any of the production callbacks is enabled, this variable will contain the amount of the first cargo type awaiting to be processed. {{nml|0.5}} Removed. Use <code>incoming_cargo_waiting</code> instead.<br />
|-<br />
| waiting_cargo_2<br />
| 0..65535<br />
| If any of the production callbacks is enabled, this variable will contain the amount of the second cargo type awaiting to be processed. {{nml|0.5}} Removed. Use <code>incoming_cargo_waiting</code> instead.<br />
|-<br />
| waiting_cargo_3<br />
| 0..65535<br />
| If any of the production callbacks is enabled, this variable will contain the amount of the third cargo type awaiting to be processed. {{nml|0.5}} Removed. Use <code>incoming_cargo_waiting</code> instead.<br />
|-<br />
| produced_cargo_waiting_1 <br />
| 0..65535<br />
| The amount of produced 'output cargo type 1' that this waiting to be transported. {{nml|0.5}} Removed. Use <code>produced_cargo_waiting</code> instead.<br />
|-<br />
| produced_cargo_waiting_2<br />
| 0..65535<br />
| The amount of produced 'output cargo type 2' that this waiting to be transported. {{nml|0.5}} Removed. Use <code>produced_cargo_waiting</code> instead.<br />
|-<br />
| produced_this_month_1<br />
| 0..65535<br />
| The amount of 'output cargo type 1' that was produced this month. {{nml|0.5}} Removed. Use <code>this_month_production</code> instead.<br />
|-<br />
| produced_this_month_2<br />
| 0..65535<br />
| The amount of 'output cargo type 2' that was produced this month. {{nml|0.5}} Removed. Use <code>this_month_production</code> instead.<br />
|-<br />
| produced_last_month_1<br />
| 0..65535<br />
| The amount of 'output cargo type 1' that was produced last month. {{nml|0.5}} Removed. Use <code>last_month_production</code> instead.<br />
|-<br />
| produced_last_month_2<br />
| 0..65535<br />
| The amount of 'output cargo type 2' that was produced last month. {{nml|0.5}} Removed. Use <code>last_month_production</code> instead.<br />
|-<br />
| transported_this_month_1<br />
| 0..65535<br />
| The amount of 'output cargo type 1' that was transported this month. {{nml|0.5}} Removed. Use <code>this_month_transported</code> instead.<br />
|-<br />
| transported_this_month_2<br />
| 0..65535<br />
| The amount of 'output cargo type 2' that was transported this month. {{nml|0.5}} Removed. Use <code>this_month_transported</code> instead.<br />
|-<br />
| transported_last_month_1<br />
| 0..65535<br />
| The amount of 'output cargo type 1' that was produced last month. {{nml|0.5}} Removed. Use <code>last_month_transported</code> instead.<br />
|-<br />
| transported_last_month_2<br />
| 0..65535<br />
| The amount of 'output cargo type 2' that was produced last month. {{nml|0.5}} Removed. Use <code>last_month_transported</code> instead.<br />
|-<br />
| transported_last_month_pct_1<br />
| 0..100<br />
| Percentage of produced 'output cargo type 1' that was transported last month. {{nml|0.5}} Removed. Use <code>transported_last_month_pct</code> instead.<br />
|-<br />
| transported_last_month_pct_2<br />
| 0..100<br />
| Percentage of produced 'output cargo type 2' that was transported last month. {{nml|0.5}} Removed. Use <code>transported_last_month_pct</code> instead.<br />
|-<br />
| production_rate_1<br />
| 0..255<br />
| {{nml|0.3}} Amount of 'output cargo type 1' that is produced every 256 ticks. Initial value from the <code>prod_multiplier</code>-property, but it will change accordingly when the production level changes. {{nml|0.5}} Removed. Use <code>production_rate</code> instead.<br />
|-<br />
| production_rate_2<br />
| 0..255<br />
| {{nml|0.3}} Amount of 'output cargo type 2' that is produced every 256 ticks. Initial value from the <code>prod_multiplier</code>-property, but it will change accordingly when the production level changes. {{nml|0.5}} Removed. Use <code>production_rate</code> instead.<br />
|-<br />
| water_distance<br />
| Distance to the tile<br />
| If the industry is built on water, this variable gives the distance of the closest dry land tile, otherwise it gives the distance of the closest water tile.<br />
|-<br />
| layout_num<br />
| 1..255<br />
| Number of the layout being used by the industry.<br />
|-<br />
| founder<br />
| 0..16<br />
| Company number of the industry founder. It will be FOUNDER_GAME (=16) if the industry was generated randomly. TTDPatch only supports up to 8 companies (0..7).<br />
|-<br />
| founder_type<br />
| PLAYERTYPE_XX<br />
| PLAYERTYPE_HUMAN, PLAYERTYPE_AI, PLAYERTYPE_HUMAN_IN_AI (human managing AI company) or 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.<br />
|-<br />
| founder_colour1<br />
| COLOUR_XXX<br />
|<br />
Index of founding company's first colour. 0 if not founded by a company. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.<br />
|-<br />
| founder_colour2<br />
| COLOUR_XXX<br />
|<br />
Index of founding company's second colour. It's the same as company_colour1, if no second company colour is chosen. 0 if not founded by a company. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.<br />
|-<br />
| colour<br />
| COLOUR_XXX<br />
|<br />
Random colour for this industry. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.<br />
|-<br />
| build_date<br />
| 0..1826212865<br />
| Date of the industry foundation in days since year 0.<br />
|-<br />
| build_type<br />
| BUILDTYPE_XX<br />
| BUILDTYPE_UNKNOWN (if created in an old version or with newindustries disabled), BUILDTYPE_GAMEPLAY (if founded or created by the in-game random industry generator), BUILDTYPE_GENERATION (if created during random map generation) or BUILDTYPE_EDITOR (if created with the scenario editor).<br />
|-<br />
| counter<br />
| 0..65535<br />
| Decremented every tick, used to time primary industry production in TTD.<br />
|-<br />
| last_accept_date<br />
| date(year, month, day)<br />
| Date when cargo was accepted for the last time. Not valid before 1920 and after 2090.<br />
|-<br />
| random_bits<br />
| 0 ... 65535<br />
| Random data that can be used to randomize certain descisions. (see [[NML:Random_switch|Random switch]]) (NML r1666)<br />
|}<br />
<br />
<br /> Variables that require some parameters.<br />
<br />
{| class="t"<br />
! name<br />
! arguments<br />
! comment<br />
|-<br />
| industry_count<br />
| industry_type, grfid = -1<br />
|<br />
The value of this variable is the number of industries of a given type that are currently on the map. industry_type is either the ID of an industry. GRFid is the grf in which the industry was defined. The default value is -1, which means current newgrf. A grfid of 0 lets you check the number of default industries of a given type. Use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert a grfid to its numeric representation.<br />''Warning: using this variable trashes the contents of temporary storage register 0x100''<br />
|-<br />
| industry_distance<br />
| industry_type, grfid = -1<br />
| The value of this variable is the manhattan distance the closest instance of the given industry or 0xFFFF if not applicable. See industry_count for a description of the parameters.<br />''Warning: using this variable trashes the contents of temporary storage register 0x100.''<br />
|-<br />
| industry_layout_count / industry_layout_distance<br />
| industry_type, layout, grfid = -1.<br />
| See industry_count / industry_distance for description of industry_type, grfid and return value. The results are filtered to industries that have the given layout number.<br />''Warning: using this variable trashes the contents of temporary storage registers 0x100 and 0x101.''<br />
|-<br />
| industry_town_count<br />
| industry_type, grfid = -1.<br />
| See industry_count / industry_distance for description of industry_type, grfid and return value. The results are filtered to industries that have the same town than the current industry.<br />''Warning: using this variable trashes the contents of temporary storage registers 0x100 and 0x101.''<br />
|-<br />
| town_manhattan_dist<br />
| x, y<br />
| Parameters indicate a signed offset relative to the northern tile. Returns the Manhattan distance (dx + dy) from the selected tile to the closest town<br />
|-<br />
| town_euclidean_dist<br />
| x, y<br />
| Parameters indicate a signed offset relative to the northern tile. Returns the squared Eucleidean distance (dx^2 + dy^2) from the selected tile to the closest town.<br />
|-<br />
| town_zone<br />
| x, y<br />
|<br />
Parameters indicate a signed offset relative to the northern tile. Returns the [[NML:List of town zones|town zone]] that the selected tile is in.<br />
|-<br />
| nearby_tile_random_bits<br />
| x, y<br />
| Parameters indicate an unsigned offset relative to the northern tile. Returns the random bits of the selected industry tile, or 0 if it is not an industry tile that's part of this industry.<br />
|-<br />
| incoming_cargo_waiting<br />
| cargo label from the cargotable<br />
| {{nml|0.5}} If any of the production callbacks is enabled, this variable will contain the amount of the cargo type waiting to be processed. Returns 0..65535. Example: <code>incoming_cargo_waiting("FOOD")</code>.<br />
|-<br />
| produced_cargo_waiting<br />
| cargo label from the cargotable<br />
| {{nml|0.5}} For the given cargo label, the amount of produced cargo that this waiting to be transported. Returns 0..65535. Example: <code>produced_cargo_waiting("GOOD")</code>.<br />
|-<br />
| this_month_production<br />
| cargo label from the cargotable<br />
| {{nml|0.5}} For the given cargo label, amount of cargo that was produced this month. Returns 0..65535. Example: <code>this_month_production("COAL")</code>.<br />
|-<br />
| last_month_production<br />
| cargo label from the cargotable<br />
| {{nml|0.5}} For the given cargo label, amount of cargo that was produced last month. Returns 0..65535. Example: <code>last_month_production("WOOD")</code>.<br />
|-<br />
| this_month_transported<br />
| cargo label from the cargotable<br />
| {{nml|0.5}} For the given cargo label, amount of produced cargo that was transported this month. Returns 0..65535. Example: <code>this_month_transported("IORE")</code>.<br />
|-<br />
| last_month_transported<br />
| cargo label from the cargotable<br />
| {{nml|0.5}} For the given cargo label, amount of produced cargo that was transported last month. Returns 0..65535. Example: <code>last_month_transported("PAPR")</code>. <br />
|-<br />
| transported_last_month_pct<br />
| cargo label from the cargotable<br />
| {{nml|0.5}} For the given cargo label, percentage of produced cargo that was transported last month. Returns 0..100. Example: <code>transported_last_month_pct("BATT")</code>. <br />
|-<br />
| production_rate<br />
| cargo label from the cargotable<br />
| {{nml|0.5}} For the given cargo label, amount of output cargo that is produced every 256 ticks. Initial value from the <code>cargo_types</code> property, but it will change accordingly when the production level changes. Returns 0..255. Example: <code>production_rate("SUGR")</code>. <br />
|}<br />
<br />
==Industry callbacks==<br />
<br />
{| class="t"<br />
! callback<br />
! return value<br />
! comment<br />
|-<br />
| default<br />
| varies<br />
| Any unhandled callbacks. Generally this doesn't need to be used, except for old-style callbacks.<br />
|-<br />
| produce_cargo_arrival<br />
| [[NML:Produce|Produce-block]]<br />
| Called to produce cargo when it arrives.<br />
|-<br />
| produce_256_ticks<br />
| [[NML:Produce|Produce-block]]<br />
| Called to produce cargo every 256 ticks.<br />
|-<br />
| availability<br />
| CB_RESULT_IND_ALLOW or CB_RESULT_IND_DISALLOW<br />
|<br />
{{nml|0.2}} Only available in NML 0.2 or earlier. Called when the game needs to know if the industry type is available. It is limited to the type as a whole, so you can't access industry-specific variables. <code style="color:darkgreen">extra_callback_info2</code> contains the [[#Industry creation types|creation type]].<br />
|-<br />
| construction_probability<br />
| CB_RESULT_IND_NO_CONSTRUCTION, CB_RESULT_IND_PROBABILITY_FROM_PROPERTY or a relative probability 0..255<br />
|<br />
{{nml|0.3}}. Called when the game needs to know if the industry type is available. It is limited to the type as a whole, so you can't access industry-specific variables.<br />
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The [[#Industry creation types|creation type]].<br />
If you return CB_RESULT_IND_NO_CONSTRUCTION or 0 the industry won't be build. If you return CB_RESULT_IND_PROBABILITY_FROM_PROPERTY it'll be build according to the relative probability as defined in the <code style="color:darkgreen">prob_random</code> or <code style="color:darkgreen">prob_in_game</code> properties, otherwise it'll use the value as returned as relative probability.<br />
|-<br />
| location_check<br />
|<br />
See the [[#Location check results|table]] below.<br />
|<br />
Called to check if a location is suitable.<br />
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The [[#Industry creation types|creation type]].<br />
Since the industry isn't built yet, industry variables aren't available. If this callback is not implemented or fails, constructing the industry will be allowed. Construction might also be prevented via the <code style="color:darkgreen">tile_check</code> industry tile callback, though.<br />
|-<br />
| monthly_prod_change<br />
|<br />
See [[#Production change callback results|below]]<br />
| Called each month to (possibly) change the industry production.<br />
* <code style="color:darkgreen">extra_callback_info2</code>: 32 random bits.<br />
|-<br />
| random_prod_change<br />
|<br />
See [[#Production change callback results|below]]<br />
| Works exactly the same as <code style="color:darkgreen">monthly_prod_change</code>, except that it's only called when TTD selects this industry for a random production change.<br />
|-<br />
| build_prod_change<br />
| Value in range 4-128<br />
| {{ottd|1.3|r24186}} Called when an industry is constructed. Return value is production level (default 16). Can also be used to initialise permanent storage when an industry is constructed.<br />
|-<br />
| cargo_subtype_display<br />
| String, CB_RESULT_NO_TEXT or CB_RESULT_IND_NO_TEXT_NO_AMOUNT<br />
| This callback allows displaying some text after a cargo name. Returning<br />
* CB_RESULT_NO_TEXT displays only waiting amount of cargo,<br />
* CB_RESULT_IND_NO_TEXT_NO_AMOUNT displays only the cargotype.<br />
<br />
Note: To remove cargo waiting text, return <code style="color:darkgreen">0x3800 + string(STR_EMPTY)</code> where STR_EMPTY is an empty string in your lang file.<br />
<br />
If IND_FLAG_LONG_CARGO_TYPE_LISTS is not set:<br />
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: 0 .. 2 to get texts for the first .. third accepted cargo type, and 3 .. 4 for the first ... second produced cargo type.<br />
* <code style="color:darkgreen">getbits(extra_callback_info2, 8, 8)</code>: 0 when getting a string for the buy menu (no industry variables available!), 1 when for the industry window and 2 for the industry directory window.<br />
<br />
If IND_FLAG_LONG_CARGO_TYPE_LISTS is set:<br />
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: 0 for output cargos, 1 for input cargos.<br />
* <code style="color:darkgreen">getbits(extra_callback_info2, 8, 8)</code>: 0 when getting a string for the buy menu (no industry variables available!), 1 when for the industry window and 2 for the industry directory window.<br />
* <code style="color:darkgreen">getbits(extra_callback_info2, 16, 8)</code>: Cargo type.<br />
<br />
|-<br />
| extra_text_industry<br />
| String<br />
| Show extra text in the industry window.<br />
|-<br />
| extra_text_fund<br />
| String<br />
| Show extra text in the fund window. Since the industry isn't built, no industry variables are available.<br />
|-<br />
| control_special<br />
| 0 or 1<br />
| Called to control various effects from the <code style="color:darkgreen">spec_flags</code> property. Currently only works for the first two (plant fields / cut trees). Return 1 to execute the action or 0 to not do so.<br />
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits.<br />
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Queried effect.<br />
The default (if the flag is enabled, of course) is to plant fields with 1/8th chance every 256 ticks, and to cut trees every 512 ticks.<br />
|-<br />
| stop_accept_cargo<br />
| 0 or 1<br />
| With this callback, you can temporarily refuse accepting a certain cargo, for example because the stockpile is full. Return 1 to accept or 0 to refuse. Make sure to synchronize this callback with the <code style="color:darkgreen">cargo_amount_accept</code> callback for industry tiles.<br />
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code> The cargo type to accept or not.<br />
|-<br />
| colour<br />
| COLOUR_XXX<br />
| Called after constructing the industry. The <code style="color:darkgreen">colour</code> variable is set to a random value at this point, you can use this callback to change this.<br />
|-<br />
| cargo_input<br />
| Cargo type, or 0xFF<br />
| Decide the input cargo types, called when the industry is built. Called repeatedly until 0xFF is returned, although currently not more than three times. Do not rely on this limitation, though.<br />
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>: Starts at 0 and is incremented for every iteration.<br />
Return a cargo type (from the table) or 0xFF to stop.<br />
|-<br />
| cargo_output<br />
| Cargo type, or 0xFF<br />
| Same as <code style="color:darkgreen">cargo_input</code> above, except that it is applied to the output cargo types and currently not called more than twice.<br />
|}<br />
<br />
{{NML:LocationCheckResults}}<br />
<br />
===Production change callback results===<br />
<br />
{| class="t"<br />
! value<br />
! meaning<br />
|-<br />
| CB_RESULT_IND_PROD_NO_CHANGE<br />
| Do not change industry production<br />
|-<br />
| CB_RESULT_IND_PROD_HALF<br />
| Half industry production. If production goes below a quarter of default, the industry closes.<br />
|-<br />
| CB_RESULT_IND_PROD_DOUBLE<br />
| Double production if it's not 8x default yet.<br />
|-<br />
| CB_RESULT_IND_PROD_CLOSE<br />
| Announce closure and remove the industry next month.<br />
|-<br />
| CB_RESULT_IND_PROD_RANDOM<br />
| Do a random production change, as if the industry is a primary one.<br />
|-<br />
| CB_RESULT_IND_PROD_DIVIDE_BY_4<br />
| Divide production by 4<br />
|-<br />
| CB_RESULT_IND_PROD_DIVIDE_BY_8<br />
| Divide production by 8<br />
|-<br />
| CB_RESULT_IND_PROD_DIVIDE_BY_16<br />
| Divide production by 16<br />
|-<br />
| CB_RESULT_IND_PROD_DIVIDE_BY_32<br />
| Divide production by 32<br />
|-<br />
| CB_RESULT_IND_PROD_MULTIPLY_BY_4<br />
| Multiply production by 4<br />
|-<br />
| CB_RESULT_IND_PROD_MULTIPLY_BY_8<br />
| Multiply production by 8<br />
|-<br />
| CB_RESULT_IND_PROD_MULTIPLY_BY_16<br />
| Multiply production by 16<br />
|-<br />
| CB_RESULT_IND_PROD_MULTIPLY_BY_32<br />
| Multiply production by 32<br />
|-<br />
| CB_RESULT_IND_PROD_DECREMENT_BY_1<br />
| Decrement production by 1<br />
|-<br />
| CB_RESULT_IND_PROD_INCREMENT_BY_1<br />
| Increment production by 1<br />
|-<br />
| CB_RESULT_IND_PROD_SET_BY_0x100<br />
| Set the production level to the value in bits 16 .. 23 of register 0x100.<br />
|}<br />
<br />
Setting bit 7 of the result disables the associated news message.<br /> Setting bit 8 replaces the news message with a custom message, read from register 0x100 bits 0 .. 15.<br />
<br />
===Industry creation types===<br />
<br />
{| class="t"<br />
! value<br />
! meaning<br />
|-<br />
| IND_CREATION_GENERATION<br />
| Industry is created during map generation, or when building 'many random industries' in the scenario editor.<br />
|-<br />
| IND_CREATION_RANDOM<br />
| Industry is randomly generated during gameplay<br />
|-<br />
| IND_CREATION_FUND<br />
| Industry is funded by the player (in game or scenario editor)<br />
|-<br />
| IND_CREATION_PROSPECT<br />
| Industry is prospected by the player<br />
|}</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=Action0/Houses&diff=4166Action0/Houses2022-02-01T02:13:29Z<p>Pikkabird: rem bad and outdated advice. Modern town sets can be as complex as industry sets, generally don't work well when more than one is loaded at once, and should not be expected to "leave space".</p>
<hr />
<div>== Introduction ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
== Properties ==<br />
<br />
{| |-<br />
!Number!![[GRFActionsDetailed|Size]]!!Version!!Description<br />
|-<br />
|08||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Substitute building type<br />
|-<br />
|09||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building flags<br />
|-<br />
|0A||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Availability years<br />
|-<br />
|0B||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Population<br />
|-<br />
|0C||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Mail generation multiplier<br />
|-<br />
|0D||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Passenger acceptance<br />
|-<br />
|0E||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Mail acceptance<br />
|-<br />
|0F||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Goods, food or fizzy drinks acceptance<br />
|-<br />
|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)<br />
|-<br />
|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)<br />
|-<br />
|12||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building name ID<br />
|-<br />
|13||W||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Building availability mask<br />
|-<br />
|14||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||House callback flags<br />
|-<br />
|15||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||House override byte<br />
|-<br />
|16||B||{{ottdp|0.6|2.5|ttdprev=alpha 34}}||Periodic refresh multiplier<br />
|-<br />
|17||4*B||{{ottdp|0.6|2.5|ttdprev=alpha 35}}||Four random colours to use<br />
|-<br />
|18||B||{{ottdp|0.6|2.5|ttdprev=alpha 35}}||Relative probability of appearing<br />
|-<br />
|19||B||{{ottdp|0.6|2.5|ttdprev=alpha 38}}||Extra flags<br />
|-<br />
|1A||B||{{ottdp|0.6|2.5|ttdprev=alpha 39}}||Animation frames<br />
|-<br />
|1B||B||{{ottdp|0.6|2.5|ttdprev=alpha 39}}||Animation speed<br />
|-<br />
|1C||B||{{ottdp|0.6|2.5|ttdprev=alpha 43}}||Class of the building type<br />
|-<br />
|1D||B||{{ottdp|0.6|2.5|ttdprev=alpha 55 vcs 2}}||Callback flags 2<br />
|-<br />
|1E||D||{{ottdp|0.6|2.5|ttdprev=alpha 55 vcs 2}}||Accepted cargo types<br />
|-<br />
|1F||W||{{ottdp|0.6|2.6|ttdprev=r1554}}||Minimum life span in years<br />
|-<br />
|20||W||{{ottdp|1.2|2.6|ottdrev=r23072|ttdprev=r1677}}||Cargo acceptance watch list<br />
|-<br />
|21||W||{{ottdp|0.7|no|ottdrev=r13437}}||Long year (zero based) of minimum appearance<br />
|-<br />
|22||W||{{ottdp|0.7|no|ottdrev=r13437}}||Long year (zero based) of maximum appearance<br />
|-<br />
|23||V||{{ottdp|1.9|no|ottdrev=48b334cf}}||Tile acceptance list <br />
|}<br />
<br />
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.<br />
<br />
== Descriptions ==<br />
<br />
=== Substitute building type (08) ===<br />
<br />
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).<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
If this house's action 3 appears before this property is set, the action 3 will have no effect.<br />
<br />
=== Building flags (09) ===<br />
<br />
{| |-<br />
!Bit!!Value!!Meaning<br />
|-<br />
|0||1||This is a 1x1 building<br />
|-<br />
|1||2||This building can be built only on flat land (if clear, foundations are automatically displayed on sloped land)<br />
|-<br />
|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><br />
|-<br />
|3||8||This is a 1x2 building<ref name="large" /><br />
|-<br />
|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><br />
|-<br />
|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><br />
|-<br />
|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><br />
|-<br />
|7||80||This building is a stadium<ref name="only1" /><br />
|}<br />
<br />
<references /><br />
<br />
=== Availability years (0A) ===<br />
<br />
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.<br />
<br />
{{ottdp|no| }}<br />
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).<br />
<br />
'''WARNING:''' Don't set the start year below 1930 (0Ah) unless you know what you're doing!<br />
<br />
{{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.<br />
<br />
{{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]].<br />
<br />
=== Population (0B) and Mail generation multiplier (0C) ===<br />
[[Image:House_production.png|frame|right|Actual house production roughly depends on squared value of the population / mail generation multiplier.]]<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
You can further customize how the cargo is generated with the [[Callbacks#Custom_cargo_production_.282E.29 |callback 2E]].<br style="clear:both" /><br />
<br />
=== Passenger (0D), Mail (0E) and Good/Food/Fizzy drinks (0F) acceptance ===<br />
<br />
The acceptance is given in units of 1/8th and must not be larger than 8 eighths.<br />
<br />
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.<br />
<br />
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.<br />
<br />
The type of accepted cargo can be modified using [[Action0Houses#Accepted_cargo_types|property 1E]].<br />
<br />
{{ottdp|no| }} Note that in TTDPatch the officefood switch may modify acceptance in the sub-arctic and subtropical climates.<br />
<br />
=== Building name ID (12) ===<br />
<br />
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.<br />
<br />
=== Building availability mask (13) ===<br />
<br />
{| |-<br />
!Bit!!Value!!Meaning<br />
|-<br />
|0..4||1,2,4,8,10||which [[VariationalAction2/Houses#Town zone (42)|town zone(s)]] the building can be built in<br />
|-<br />
|11||800||can appear in sub-arctic climate above the snow line<br />
|-<br />
|12||1000||can appear in temperate climate<br />
|-<br />
|13||2000||can appear in sub-arctic climate below the snow line<br />
|-<br />
|14||4000||can appear in subtropical climate<br />
|-<br />
|15||8000||can appear in toyland climate<br />
|}<br />
<br />
This property should be set to zero for additional building tiles.<br />
<br />
=== House callback flags (14,1D) ===<br />
<br />
For houses, the following [[callbacks]] can be defined by setting the corresponding bit in property 14:<br />
<br />
{| |-<br />
!Bit!!Value!!Variable 0C value!!Version!!Callback<br />
|-<br />
|0||1||17||{{ottdp| | }}||decide whether the house can be built on a given tile<br />
|-<br />
|1||2||1A||{{ottdp| | }}||decide the following frame of the animations<br />
|-<br />
|2||4||1B||{{ottdp| | }}||periodically start/stop the animation<br />
|-<br />
|3||8||1C||{{ottdp| | }}||change animation when construction state changes<br />
|-<br />
|4||10||1E||{{ottdp| | }}||decide the color of the building<br />
|-<br />
|5||20||1F||{{ottdp| | }}||decide the cargos amounts accepted<br />
|-<br />
|6||40||20||{{ottdp| | }}||decide the length of the current animation frame<br />
|-<br />
|7||80||21||{{ottdp| | }}||trigger destruction of building<br />
|}<br />
<br />
Property 1D was introduced after all bits of property 14 were filled. Its usage is the same, only the meaning of bits is different:<br />
<br />
{| |-<br />
!Bit!!Value!!Variable 0C value!!Version!!Callback<br />
|-<br />
|0||1||2A||{{ottdp| | }}||decide the cargo types accepted<br />
|-<br />
|1||2||2E||{{ottdp| | }}||custom cargo production<br />
|-<br />
|2||4||143||{{ottdp| | }}||conditional protection<br />
|-<br />
|3||8||14E||{{ottdp|1.0|2.6|ottdrev=r17558|ttdprev=2249}}||decide if default foundations need to be drawn<br />
|-<br />
|4||10||14F||{{ottdp|1.0|2.6|ottdrev=r17558|ttdprev=2249}}||allow or deny autosloping below the tile<br />
|}<br />
<br />
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.<br />
<br />
Callback flags are ignored for additional building tiles.<br />
<br />
=== House override byte (15) ===<br />
<br />
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.<br />
<br />
No new house of the overridden types will be built in towns.<br />
<br />
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.<br />
<br />
=== Periodic refresh multiplier (16) ===<br />
<br />
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.<br />
<br />
If callback 1B is enabled in property 14, it is also called after re-randomizing random bits.<br />
<br />
{{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.<br />
<br />
=== Random colours (17) ===<br />
<br />
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.<br />
<br />
=== Probability (18) ===<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
=== Extra Flags (19) ===<br />
<br />
{| |-<br />
!Bit!!Value!!Version!!Meaning<br />
|-<br />
|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.<br />
|-<br />
|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.<br />
|-<br />
|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><br />
|-<br />
|3||8||{{ottdp|0.6|2.5|ttdprev=beta 2}}||[[Callbacks#Next animation frame (1A/26/141/153/158) |Callback 1A]] needs random bits<br />
|}<br />
<br />
<references /><br />
<br />
=== Animation Frames (1A) ===<br />
<br />
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).<br />
<br />
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.<br />
<br />
{{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.<br />
<br />
=== Animation Speed (1B) ===<br />
<br />
This is the amount of time between switching frames.<br />
<br />
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.<br />
<br />
=== Building Class (1C) ===<br />
<br />
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.<br />
<br />
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.<br />
<br />
=== Accepted cargo types (1E) ===<br />
<br />
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.<br />
<br />
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.<br />
<br />
=== Minimum life span in years (1F) ===<br />
<br />
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.<br />
<br />
For this to operate consequently on multi-tile buildings, you must set the same minimum lifespan for all tiles of the building.<br />
<br />
=== Cargo acceptance watch list (20) ===<br />
<br />
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.<br />
<br />
{{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:<br />
* Generalfixes is on, and miscmods.noextendstationrange is off<br />
* Any of fifoloading, newcargos or irregularstations is on<br />
<br />
=== Availability years (long format) - Minimum (21) - Maximum (22) ===<br />
<br />
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.<br />
<br />
=== Tile acceptance list (23) ===<br />
{{ottdp|1.9|no|ottdrev=48b334cf}} <br />
<br />
Format:<br />
<numinput> (<cargotype> <acceptance>)*<br />
<br />
{| |-<br />
!Size!!Variable!!Meaning<br />
|-<br />
|B||numinput||Number of (<cargotype> <acceptance>) pairs to follow,<br />
|-<br />
|B||cargotype||Cargotype (from CTT) to accept.<br />
|-<br />
|B||acceptance||Acceptance in 1/8 units.<br />
|}<br />
<br />
This property defines up to 16 cargotypes, which are accepted by the house.<br />
Use this property instead of property 0D..0F.</div>Pikkabirdhttps://newgrf-specs.tt-wiki.net/index.php?title=DefaultHouseProps&diff=923DefaultHouseProps2005-12-12T02:38:37Z<p>Pikkabird: </p>
<hr />
<div><br />
'''''Default property values for TTD's houses'''''<br />
<br />
=Default House Properties=<br />
<br />
Default property values for TTD's houses<br />
<br />
This page is largely a copy of housedata.html, from <nowiki>http://users.tt-forums.net/csaboka/ttdpatch/housetut.zip<br />
<br />
</nowiki> <br />
<br />
This list contains all properties of default TTD house types, allowing you to know what will be copied to your new house ID when you set its property 8, and can also be used for reference when deciding what properties your new house should have. House names are taken from Marcin Grzegorczyk's &quot;Transport Tycoon Deluxe savegame internals&quot; file, which has more descriptive names than the original TTD ones. Unfortunately, even these names aren't unique, either. The &quot;Flags&quot; column lists what will be set to your new building's property 9 (that's why their church and stadium flags aren't set). Negative goods acceptance means that the building accepts food/candy instead of goods/fizzy drinks. &quot;None&quot; in the max. year column means that the building type never becomes obsolete. The rest of the columns is pretty self-explanatory.<br />
<br />
|| ID| Name| Climates | Town zones| Flags| Min. build year| Max. build year| Population| Mail generation| Passenger acceptance (in 1/8 units)| Mail acceptance (in 1/8 units)| Goods/food acceptance (in 1/8 units)| Remove ratings decrease| Remove cost multiplier<br />
<br />
00h| tall office block| temperate| 4| 01h| 1963 | none| 187| 70| 8| 3| 4| 140| 150<br />
<br />
01h| office block| temperate| 3, 4| 01h| 1957| none| 85| 55 | 8| 3| 4| 130| 140<br />
<br />
02h| small block of flats| temperate | 1, 2, 3| 01h| 1968| none| 40| 20| 8| 3| 1 | 90| 100<br />
<br />
03h| church| temperate| 0, 1, 2, 3| 01h| 1930 | none| 5| 2| 2| 0| 0| 230| 90<br />
<br />
04h| large office block| temperate, sub-arctic, subtropical| 4| 21h| 1975| none| 220| 85| 10| 4| 6| 160| 160<br />
<br />
05h| large office block| snow | 4| 21h| 1975| none| 220| 85| 10| 4| 6 | 160| 160<br />
<br />
06h| town houses| temperate| 0, 1, 2, 3| 01h| 1930| none| 30| 12| 4| 1| 0| 80| 80<br />
<br />
07h| hotel (N part)| temperate| 2, 4| 08h| 1959| none| 140| 22 | 6| 1| 2| 150| 180<br />
<br />
08h| hotel (E part)| | | 00h| 1959| none| 0| 22| 6| 1| 2| 150 | 180<br />
<br />
09h| statue| temperate, sub-arctic, subtropical| 3, 4| 01h| 1945| none | 0| 0| 2| 0| 0| 40| 65<br />
<br />
0Ah | fountain | temperate, sub-arctic, subtropical| 4| 01h| 1945| none| 0| 0| 2 | 0| 0| 40| 65<br />
<br />
0Bh| park (with a pond)| temperate| 2 | 01h| 1930| none| 0| 0| 2| 0| 0| 75 | 60<br />
<br />
0Ch| park (with an alley)| temperate| 3| 01h| 1935| none| 0| 0| 2| 0| 0| 75| 60<br />
<br />
0Dh | office block | temperate| 3, 4| 01h| 1951| none| 150| 65| 8 | 2| 4| 110| 130<br />
<br />
0Eh| shops and offices 1| temperate| 2, 3, 4 | 01h| 1930| 1960| 95| 48| 6| 2| 3| 100 | 110<br />
<br />
0Fh| shops and offices 2| temperate| 2, 3, 4| 01h| 1930| 1960 | 95| 48| 6| 2| 3| 100| 105<br />
<br />
10h | shops and offices 3 | temperate| 2, 3, 4| 01h| 1930| 1960| 95| 48| 6 | 2| 3| 100| 107<br />
<br />
11h| modern office building| temperate, sub-arctic, subtropical| 4 | 01h| 1977| none| 130| 50| 10| 3| 6| 150 | 200<br />
<br />
12h| warehouse| temperate| 4| 01h| 1983| none | 6| 10| 6| 3| 8| 110| 145<br />
<br />
13h | office block (with spiral stairway) | temperate| 4| 01h| 1985| none| 110| 55| 6| 2| 6| 110| 155<br />
<br />
14h| stadium (N part)| temperate| 0, 1, 2, 3| 10h| 1930| none| 65| 5| 4| 0| 0| 300 | 250<br />
<br />
15h| stadium (E part)| | | 00h| 1930| none| 0 | 5| 4| 0| 0| 300| 250<br />
<br />
16h| stadium (W part) | | | 00h| 1930| none| 0| 5| 4| 0| 0 | 300| 250<br />
<br />
17h| stadium (S part)| | | 00h| 1930| none | 0| 5| 4| 0| 0| 300| 250<br />
<br />
18h | old houses | temperate| 0, 1| 01h| 1930| 1951| 15| 6| 3 | 1| 0| 75| 70<br />
<br />
19h| cottages| temperate| 0| 01h| 1930| 1952| 12| 7| 3| 1| 0| 75 &nbsp; | 75<br />
<br />
1Ah| houses| temperate| 0, 1, 2, 3| 01h| 1931| none | 13| 8| 3| 1| 0| 75| 71<br />
<br />
1Bh &nbsp;| flats | temperate| 2, 3, 4| 01h| 1935| none| 100| 35| 7 &nbsp;| 2| 2| 100| 135<br />
<br />
1Ch| tall office block| temperate| 2, 3, 4 | 01h| 1963| none| 170| 50| 8| 3| 3| 170 | 145<br />
<br />
1Dh| shops and offices| temperate| 2, 3, 4| 01h| 1930| 1955 | 100| 40| 6| 2| 3| 135| 132<br />
<br />
1Eh | shops and offices | temperate, subtropical| 2, 4| 01h| 1973| none| 180| 64| 8 &nbsp;| 3| 3| 180| 155<br />
<br />
1Fh| theatre| temperate| 3, 4 | 01h| 1930| none| 35| 23| 8| 2| 2| 230 | 220<br />
<br />
20h| stadium (modern style, N part)| temperate, sub-arctic, subtropical| 0, 1, 2, 3| 10h| 1958| none | 65| 5| 4| 0| 0| 300| 250<br />
<br />
21h | stadium (modern style, E part) | | | 00h| 1958| none| 0| 5| 4| 0 | 0| 300| 250<br />
<br />
22h| stadium (modern style, W part)| | | 00h| 1958 | none| 0| 5| 4| 0| 0| 300| 250<br />
<br />
23h| stadium (modern style, S part)| | | 00h| 1958| none| 0| 5| 4 | 0| 0| 300| 250<br />
<br />
24h| offices ('vertical tube' style)| temperate, sub-arctic, subtropical| 3, 4 | 01h| 2000| none| 140| 65| 8| 3| 2| 250 | 170<br />
<br />
25h| houses| sub-arctic| 0, 1| 01h| 1930| 1960 | 15| 6| 3| 1| -1| 75| 70<br />
<br />
26h | houses | snow| 0, 1| 01h| 1930| 1960| 15| 6| 3 | 1| -1| 75| 70<br />
<br />
27h| cinema| temperate| 2, 3, 4 | 01h| 1945| none| 35| 23| 8| 2| 2| 230 | 210<br />
<br />
28h| shopping mall (N part)| temperate| 1, 2, 3, 4| 10h| 1983| none | 180| 5| 8| 2| 3| 300| 250<br />
<br />
29h &nbsp;| shopping mall (E part) | | | 00h| 1983| none| 0| 5| 8| 2 | 3| 300| 250<br />
<br />
2Ah| shopping mall (W part)| | | 00h| 1983| none| 0| 5| 8| 2| 3| 300| 250<br />
<br />
2Bh| shopping mall (S part)| | | 00h| 1983| none| 0| 5| 8 | 2| 3| 300| 250<br />
<br />
2Ch| flats| sub-arctic| 2, 3, 4| 01h| 1930| none| 80| 20| 5| 2| -2| 90| 100<br />
<br />
2Dh| flats| snow| 2, 3, 4| 01h| 1930| none | 80| 20| 5| 2| -2| 90| 100<br />
<br />
2Eh | houses | sub-arctic| 0, 1, 2, 3| 01h| 1930| none| 16| 6| 3| 1| -2| 70| 70<br />
<br />
2Fh| houses| snow| 0, 1, 2, 3 | 01h| 1930| none| 16| 6| 3| 1| -2| 70 | 70<br />
<br />
30h| houses| sub-arctic| 0, 1, 2| 01h| 1930| 1963 | 14| 6| 3| 1| -2| 70| 80<br />
<br />
31h | houses | snow| 0, 1, 2| 01h| 1930| 1963| 14| 6| 3 | 1| -2| 70| 80<br />
<br />
32h| tall office block| sub-arctic, subtropical| 3, 4 | 01h| 1966| none| 135| 60| 8| 3| 4| 120| 150<br />
<br />
33h| tall office block| snow| 3, 4| 01h| 1966| none | 135| 60| 8| 3| 4| 120| 150<br />
<br />
34h | tall office block | sub-arctic| 3, 4| 01h| 1970| none| 170| 70| 9 | 3| 4| 130| 170<br />
<br />
35h| tall office block| snow| 3, 4 | 01h| 1970| none| 170| 70| 9| 3| 4| 130 | 170<br />
<br />
36h| tall office block| sub-arctic, subtropical| 3, 4| 01h| 1974| none | 210| 80| 10| 3| 5| 140| 200<br />
<br />
37h | tall office block | snow| 3, 4| 01h| 1974| none| 210| 80| 10 | 3| 5| 140| 200<br />
<br />
38h| houses| sub-arctic| 0 | 01h| 1930| none| 10| 5| 2| 1| -1| 60| 60<br />
<br />
39h| houses| snow| 0| 01h| 1930| none | 10| 5| 2| 1| -1| 60| 60<br />
<br />
3Ah | shops and offices | sub-arctic| 1, 2, 3, 4| 01h| 1930| none| 25| 20| 3 | 1| -1| 80| 100<br />
<br />
3Bh| shops and offices| snow| 1, 2, 3, 4 | 01h| 1930| none| 25| 20| 3| 1| -1| 80 | 100<br />
<br />
3Ch| church| sub-arctic| 0, 1, 2, 3| 01h| 1930| none | 6| 2| 2| 0| 0| 230| 85<br />
<br />
3Dh &nbsp;| church | snow| 0, 1, 2, 3| 01h| 1930| none| 6| 2| 2| 0| 0| 230| 85<br />
<br />
3Eh| houses| sub-arctic| 0, 1, 2 | 01h| 1930| none| 17| 7| 3| 1| -1| 80| 80<br />
<br />
3Fh| houses| snow| 0, 1, 2| 01h| 1930| none | 17| 7| 3| 1| -1| 80| 80<br />
<br />
40h | shops and offices | sub-arctic| 2, 3, 4| 01h| 1930| 1960| 90| 45| 6 | 2| 3| 110| 140<br />
<br />
41h| shops and offices| snow| 2, 3, 4 | 01h| 1930| 1960| 90| 45| 6| 2| 3| 110 | 140<br />
<br />
42h| hotel (N part)| sub-arctic| 2, 3, 4| 08h| 1972| none | 140| 25| 6| 1| -3| 160| 160<br />
<br />
43h | hotel (E part) | | | 00h| 1972| none| 0| 25| 6| 1 | 2| 160| 160<br />
<br />
44h| hotel (N part)| snow| 2, 3, 4| 08h | 1972| none| 140| 25| 6| 1| -3| 160| 160<br />
<br />
45h| hotel (E part)| | | 00h| 1972| none| 0| 25| 6| 1| 2| 160| 160<br />
<br />
46h| shops and offices| sub-arctic, subtropical | 2, 3, 4| 01h| 1963| none| 105| 50| 7| 2| 3 | 105| 130<br />
<br />
47h| shops and offices| snow| 2, 3, 4| 01h| 1963 | none| 105| 50| 7| 2| 3| 105| 130<br />
<br />
48h| tall office block| sub-arctic| 3, 4| 01h| 1978| none| 190| 75 | 9| 3| 4| 135| 190<br />
<br />
49h| tall office block| snow| 3, 4| 01h| 1978| none| 190| 75| 9| 3| 4| 135| 190<br />
<br />
4Ah| tall office block (N part)| sub-arctic| 2, 3, 4| 04h| 1967| none| 250| 60| 7| 2| 2| 200| 140<br />
<br />
4Bh| tall office block (W part)| | | 00h| 1967| none| 0| 60| 7 | 2| 2| 200| 140<br />
<br />
4Ch| tall office block (N part)| snow| 2, 3, 4| 04h| 1967| none| 250| 60| 7| 2| 2| 200 | 140<br />
<br />
4Dh| tall office block (W part)| | | 00h| 1967| none| 0 | 60| 7| 2| 2| 200| 140<br />
<br />
4Eh| houses (with a tree in a corner)| subtropical| 1, 2, 3, 4| 01h| 1930| none| 16| 6| 3| 1| -2| 80| 80<br />
<br />
4Fh| houses| subtropical| 1, 2, 3, 4| 01h | 1930| none| 16| 6| 3| 1| -2| 80| 80<br />
<br />
50h| houses| subtropical| 1, 2, 3, 4| 01h| 1930| none| 16| 5| 3| 1| -2| 80| 80<br />
<br />
51h| houses (suburb-type) | subtropical| 0| 01h| 1930| none| 7| 4| 3| 1| -1| 30| 30<br />
<br />
52h| flats| subtropical| 2, 3, 4| 01h| 1930| none| 45| 15| 6| 2| 1| 95| 130<br />
<br />
53h| church| subtropical| 1, 2, 3| 01h| 1930| none| 8 | 3| 2| 0| 0| 200| 90<br />
<br />
54h| houses (with two trees in front)| subtropical| 1, 2, 3, 4| 01h| 1930| none| 18| 7| 3| 1 | -2| 80| 80<br />
<br />
55h| flats| subtropical| 2, 3, 4| 01h | 1973| none| 90| 24| 6| 2| 1| 95| 110<br />
<br />
56h| flats| subtropical| 2, 3, 4| 01h| 1962| none| 120| 25| 6| 2| 1| 95| 120<br />
<br />
57h| tall office block (N part) | subtropical| 3, 4| 04h| 1984| none| 250| 80| 8| 3| 4| 140| 190<br />
<br />
58h| tall office block (W part)| subtropical| | 00h| 1984 | none| 0| 80| 8| 3| 4| 140| 190<br />
<br />
59h| flats| subtropical| 2, 3, 4| 01h| 1930| none| 80| 23| 6| 2| 1| 95| 110<br />
<br />
5Ah| tall office block| subtropical| 3, 4| 01h| 1993| none| 180| 90| 8| 3| 4| 150| 180<br />
<br />
5Bh| church| toyland| 0, 1, 2, 3, 4| 01h| 1930| none| 8| 3| 2| 0| 0| 200| 90<br />
<br />
5Ch| toyland houses| toyland| 0, 1, 2, 3, 4| 01h| 1930| none| 18| 5 | 6| 2| 2| 90| 90<br />
<br />
5Dh| toyland houses| toyland | 0, 1| 01h| 1930| none| 7| 3| 3| 1| 1| 50| 70<br />
<br />
5Eh| toyland houses| toyland| 0, 1, 2, 3| 01h| 1930| none| 15| 6| 3| 1| 2| 75| 80<br />
<br />
5Fh| toyland houses| toyland| 0, 1, 2, 3| 01h| 1930| none| 17| 6 | 3| 1| 2| 75| 80<br />
<br />
60h| toyland houses| toyland | 0, 1, 2, 3| 01h| 1930| none| 19| 6| 3| 1| 2 | 75| 80<br />
<br />
61h| toyland houses| toyland| 0, 1, 2, 3| 01h| 1930| none| 21| 6| 3| 1| 2| 75| 80<br />
<br />
62h| tall office block| toyland| 2, 3, 4| 01h| 1930| none| 75| 20 | 8| 4| 2| 130| 160<br />
<br />
63h| shoe house (N part)| toyland | 0, 1, 2, 3, 4| 08h| 1930| none| 35| 9| 4| 1| 2 | 80| 90<br />
<br />
64h| shoe house (E part)| | | 00h| 1930| none | 0| 0| 4| 1| 2| 80| 90<br />
<br />
65h | tall office block | toyland| 2, 3, 4| 01h| 1930| none| 85| 18| 8 | 4| 2| 130| 150<br />
<br />
66h| igloo| toyland| 0 | 01h| 1930| none| 11| 3| 3| 1| 1| 45 &nbsp;| 60<br />
<br />
67h| tepees| toyland| 0| 01h| 1930| none | 10| 3| 3| 1| 1| 45| 60<br />
<br />
68h| shops and offices | toyland| 2, 3, 4| 01h| 1930| none| 67| 22| 8 | 4| -4| 130| 140<br />
<br />
69h| shops and offices| toyland| 2, 3, 4 | 01h| 1930| none| 86| 23| 8| 4| -4| 130 | 145<br />
<br />
6Ah| tall office block| toyland| 2, 3, 4| 01h| 1930| none| 95| 28| 8| 4| 2| 130| 165<br />
<br />
6Bh | statue | toyland| 2, 3, 4| 01h| 1930| none| 30| 10| 4 | 1| 2| 70| 90<br />
<br />
6Ch| teapot-house| toyland| 0, 1, 2, 3, 4| 01h| 1930| none| 25| 8| 3| 1| 2| 65| 75<br />
<br />
6Dh| piggy-bank| toyland| 0, 1, 2, 3, 4| 01h| 1930| none| 18| 7| 3| 2| -4| 95| 85<br />
<br />
||</div>Pikkabird