GRFSpecs - User contributions [en-gb]

NML:Switch

2015-07-05T00:17:01Z

Supercheese: Airport Tiles do not have access to a PARENT scope

{{NMLNavBlocksyntax}}

switch (<feature>, (SELF|PARENT), <ID>, <expression>) {
(<range>: <return_value>;)*
<return_value>;
}

The four parameters have the following meaning:

* <code style="color:darkgreen"><feature></code>: The feature for which this switch is used (see [[NML:Features|Features]]).
* <code style="color:darkgreen">(SELF|PARENT)</code>: Which variables to use. SELF uses the variables of the item itself, while PARENT uses the variables of a related object. This related object differs per feature, refer to the table below.
* <code style="color:darkgreen"><ID></code>: Name of this switch block. This (unique) name can be used to refer to the block from other switch- or graphics-blocks.
* <code style="color:darkgreen"><expression></code>: The expression that will be evaluated to make a decision. This expression may contain variables. Instead of a single expression this may also be an array of expressions. In that case all of the array elements are evaluated in order and the last one is used to make a decision.

{| class="t"
! Feature
! SELF
! PARENT
! permanent storage
|-
| FEAT_TRAINS
| Engine / wagon / articulated part itself
| Front engine
| no
|-
| FEAT_ROADVEHS
| Road vehicle part
| First road vehicle part
| no
|-
| FEAT_SHIPS
| Ship
| Ship
| no
|-
| FEAT_AIRCRAFT
| Aircraft (a)
| Aircraft
| no
|-
| FEAT_STATIONS
| Station tile
| Town
| no
|-
| FEAT_CANALS
| Canal tile
| N/A
| no
|-
| FEAT_BRIDGES
| Bridge
| Town
| no
|-
| FEAT_HOUSES
| House tile
| Town
| no
|-
| FEAT_GLOBALVARS
| N/A
| N/A
| no
|-
| FEAT_INDUSTRYTILES
| Industry tile
| Industry to which the tile belongs
| no
|-
| FEAT_INDUSTRIES
| Industry
| Town
| yes
|-
| FEAT_CARGOS
| Cargo type
| N/A
| no
|-
| FEAT_SOUNDEFFECTS
| N/A
| N/A
| no
|-
| FEAT_AIRPORTS
| Airport
| N/A
| yes
|-
| FEAT_SIGNALS
| N/A
| N/A
| no
|-
| FEAT_OBJECTS
| Object tile
| Town
| no
|-
| FEAT_RAILTYPES
| Rail tile
| N/A
| no
|-
| FEAT_AIRPORTTILES
| Airport tile
| N/A
| no
|}

(a) Except for mail capacity callbacks, where it refers to the mail compartment. To refer to the aircraft itself, use PARENT scope there.

<code style="color:darkgreen"><range></code> can either be a single number or two numbers separated by two dots. In the first case, the range matches if the result of the computation is equal to the supplied value. If a range (<code style="color:darkgreen">a .. b</code>) is supplied, it matches if the computed result is within that range. If several lines of the switch block match the expression being tested the first applicable result will be returned.

Possible values for <code style="color:darkgreen"><return_value></code> are the following:

* <code style="color:darkgreen"><ID>;</code> chains to the (random-)switch or spritegroup with the given ID.
* <code style="color:darkgreen">return (<expression>|<string>);</code> returns the given expression or string as a result of the callback. A returned expression may contain variables (with the same scope as the switch block itself), parameter accesses and everything else that a normal switch-expression may contain.
* <code style="color:darkgreen">return;</code> returns the computed value directly as a callback result. Note that the maximum value for callback results is 32511 (0x7EFF).
* <code style="color:darkgreen">CB_FAILED;</code> stops processing and returns an explicit failure code.

Some example code is given below. Note that the code does not have an actual meaning, it is merely meant to demonstrate all the various options available.

<pre style="color:blue">
switch (FEAT_TRAINS, PARENT, some_vehicle_switch, (position_in_consist + param[1]) % 4) {
0..2: return string(STRING_FOO_BAR); //return a text message
3: return; //return the computed value
5..300: return 42; //42 is always a good answer
400: other_switch; //chain to some other switch block
401: return num_vehs_in_consist + 1; //return a value with a variable access
CB_FAILED; //return a failure result as default
}
</pre>

You can also use temporary variables and with some features also pemanent variables to store and retrieve some values by means of <code style="color:darkgreen">STORE_TEMP(value, register)</code>, <code style="color:darkgreen">LOAD_TEMP(register)</code> and <code style="color:darkgreen">STORE_PERM(value, register)</code> and <code style="color:darkgreen">LOAD_PERM(register[, grfid])</code> respectively. Using temporary storage is useful when you want to use the result of an expensive calculation in various decisions (switches) within the chain (like for example the number of a certain wagon type within a train). Permanent storage might be useful to control the long-term behaviour of an object. Note that it is only available for industries, airports and towns. For towns, you can optionally specify a grfid to load registers belonging to a different grf. Note that accessing (both reading and writing) permanent town registers thrashes the contents of temporary register 0x100.

{{nml|0.3}} As of NML 0.3 it is possible to specify the default value using <code>default: <value>;</code> as one of the 'ranges'. Specifying multiple default values (either this way or by the classical method) is of course not possible, but omitting a default value is allowed. In that case, if none of the ranges matches, the callback fails.

NML:Industries

2015-07-04T08:15:56Z

Supercheese: /* Industry callbacks */ The function is "getbits" not "get_bits"

{{NMLNavPropVarCB}}

This page contains information on industry properties, variables and callbacks. [[NML:IndustryTiles|Industry tiles]] are closely related.

== Industry ID allocation ==
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).

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.

==Industry properties==

Industry properties. Default industry type numbers can be found at [[NML:Default industries|default industries]].

{| class="t"
! property
! value range
! comment
|-
| substitute
| industry type
| 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.
|-
| override
| industry type
| 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.
|-
| layouts
| Array of tilelayouts
|
See [[NML:Tilelayout|Tilelayout]] syntax.
|-
| life_type
| One of IND_LIFE_TYPE_XXX, XXX = BLACK_HOLE <nowiki>|</nowiki> EXTRACTIVE <nowiki>|</nowiki> ORGANIC <nowiki>|</nowiki> PROCESSING
| 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.
|-
| closure_msg
| string
|
Message displayed when the industry announces closure. Use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].
|-
| prod_increase_msg
| string
|
Message displayed when industry increases production. Use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].
|-
| prod_decrease_msg
| string
|
Message displayed when industry decreases production. Use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].
|-
| fund_cost_multiplier
| 0..255
| 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.
|-
| prod_cargo_types
| array of up to 2 ints
| Types of cargo produced. Use the cargotype(<label>) built-in function to specify a label from the cargotable.
|-
| accept_cargo_types
| array of up to 3 ints
| Types of cargo accepted. Use the cargotype(<label>) built-in function to specify a label from the cargotable
|-
| prod_multiplier
| array of up to 2 ints (0..255)
| Amount of each output cargo to produce every 256 ticks (8 or 9 times a month)
|-
| min_cargo_distr
| 0..255
| Minimal amount of cargo before transporting to stations.
|-
| random_sound_effects
| array of ints
| Sound effect numbers that are played some times.
|-
| conflicting_ind_types
| array of up to 3x industry_type(IND_TYPE_OLD <nowiki>|</nowiki> IND_TYPE_NEW, id)
|
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).
|-
| prob_random
| 0..255
| Probability of occurring while generating initial industries.
|-
| prob_in_game
| 0..255
| Probability of occurring while creating industries during the game.
|-
| map_colour
| 0..255
|
Colour index from the [[NML:Graphic files|DOS palette]] to use on the minimap for this industry.
|-
| spec_flags
| bitmask(flags)
|
for flag values see [[#industry_special_flags|Industry special flags]]
|-
| new_ind_msg
| string
| Message displayed when industry gets built during game play.
|-
| input_multiplier_1
| array of up to 2 floats (0..255)
| Output cargo multiplication factors for getting a unit of the first accepted cargo.
|-
| input_multiplier_2
| array of up to 2 floats (0..255)
| Output cargo multiplication factors for getting a unit of the second accepted cargo.
|-
| input_multiplier_3
| array of up to 2 floats (0..255)
| Output cargo multiplication factors for getting a unit of the third accepted cargo.
|-
| name
| string
|
Name of the industry, use a custom string or one of the [[NML:Default TTD strings|default TTD strings]].
|-
| prospect_chance
| 0 .. 1 (float)
| Chance of successful prospecting.
|-
| callback_flags
| bitmask(flags)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| remove_cost_multiplier
| int
| Cost multiplier for removing the industry (currently only possible with magic bulldozer).
|-
| nearby_station_name
| string
| Default additional name for a nearby station
|}

===Industry special flags===

{| class="t"
! flag
! meaning
|-
| IND_FLAG_PLANT_FIELDS_PERIODICALLY
| The industry periodically plants fields around itself (temperate and arctic farms)
|-
| IND_FLAG_CUT_TREES
| The industry cuts trees around itself and produces its first output cargo from them (lumber mill)
|-
| IND_FLAG_BUILT_ON_WATER
| The industry is built on water (oil rig)
|-
| IND_FLAG_ONLY_IN_LARGE_TOWNS
| The industry can only be built in towns (i.e. it has to replace houses) with population larger than 1200 (temperate bank)
|-
| IND_FLAG_ONLY_IN_TOWNS
| The industry can only be built in towns (i.e. it has to replace houses) (arctic and tropic banks, water tower)
|-
| IND_FLAG_BUILT_NEAR_TOWN
| The industry is always built near towns (i.e. near town sign; additionally the industry is allowed to replace houses) (toy shop)
|-
| IND_FLAG_PLANT_FIELDS_WHEN_BUILT
| Fields are planted around the industry when it's built (all farms)
|-
| IND_FLAG_NO_PRODUCTION_INCREASE
| The industry cannot increase its production on the temperate climate (oil wells)
|-
| IND_FLAG_BUILT_ONLY_BEFORE_1950
| The industry is built only before 1950 (oil wells)
|-
| IND_FLAG_BUILT_ONLY_AFTER_1960
| The industry is built only after 1960 (oil rig)
|-
| IND_FLAG_AI_CREATES_AIR_AND_SHIP_ROUTES
| AI players will attempt to establish air and ship routes going to this industry (oil rig)
|-
| IND_FLAG_MILITARY_AIRPLANE_CAN_EXPLODE
| The industry can be exploded by a military airplane (oil refinery)
|-
| IND_FLAG_MILITARY_HELICOPTER_CAN_EXPLODE
| The industry can be exploded by a military helicopter (factory)
|-
| IND_FLAG_CAN_CAUSE_SUBSIDENCE
| The industry can cause a subsidence (coal mine)
|-
| IND_FLAG_AUTOMATIC_PRODUCTION_MULTIPLIER
| Automatic production multiplier handing (No industry has this bit set by default.).
|-
| IND_FLAG_RANDOM_BITS_IN_PRODUCTION_CALLBACK
| The production callback needs random bits in var. 10 (No industry has this bit set by default.)
|-
| IND_FLAG_DO_NOT_FORCE_INSTANCE_AT_MAP_GENERATION
| Do not force one instance of this type to appear during initial map generation (No industry has this bit set by default.)
|-
| IND_FLAG_ALLOW_CLOSING_LAST_INSTANCE
| Allow closing down the last instance of this type (No industry has this bit set by default.)
|}

{{NML:IndustryCommonVariables}}

==Industry variables==

{| class="t"
! name
! value range
! comment
|-
| production_level
| 0, or 4 .. 128
| Current production level of the industry. Usually in range 4 .. 128, default starting level is 16. A level of 0 indicates imminent closure.
|-
| waiting_cargo_1
| 0..65535
| If any of the production callbacks is enabled, this variable will contain the amount of the first cargo type awaiting to be processed.
|-
| waiting_cargo_2
| 0..65535
| If any of the production callbacks is enabled, this variable will contain the amount of the second cargo type awaiting to be processed.
|-
| waiting_cargo_3
| 0..65535
| If any of the production callbacks is enabled, this variable will contain the amount of the third cargo type awaiting to be processed.
|-
| produced_cargo_waiting_1
| 0..65535
| The amount of produced 'output cargo type 1' that this waiting to be transported.
|-
| produced_cargo_waiting_2
| 0..65535
| The amount of produced 'output cargo type 2' that this waiting to be transported.
|-
| produced_this_month_1
| 0..65535
| The amount of 'output cargo type 1' that was produced this month.
|-
| produced_this_month_2
| 0..65535
| The amount of 'output cargo type 2' that was produced this month.
|-
| produced_last_month_1
| 0..65535
| The amount of 'output cargo type 1' that was produced last month.
|-
| produced_last_month_2
| 0..65535
| The amount of 'output cargo type 2' that was produced last month.
|-
| transported_this_month_1
| 0..65535
| The amount of 'output cargo type 1' that was transported this month.
|-
| transported_this_month_2
| 0..65535
| The amount of 'output cargo type 2' that was transported this month.
|-
| transported_last_month_1
| 0..65535
| The amount of 'output cargo type 1' that was produced last month.
|-
| transported_last_month_2
| 0..65535
| The amount of 'output cargo type 2' that was produced last month.
|-
| transported_last_month_pct_1
| 0..100
| Percentage of produced 'output cargo type 1' that was transported last month.
|-
| transported_last_month_pct_2
| 0..100
| Percentage of produced 'output cargo type 2' that was transported last month.
|-
| production_rate_1
| 0..255
| {{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.
|-
| production_rate_2
| 0..255
| {{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.
|-
| water_distance
| Distance to the tile
| 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.
|-
| layout_num
| 1..255
| Number of the layout being used by the industry.
|-
| founder
| 0..16
| 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).
|-
| founder_type
| PLAYERTYPE_XX
| 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.
|-
| founder_colour1
| COLOUR_XXX
|
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.
|-
| founder_colour2
| COLOUR_XXX
|
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.
|-
| colour
| COLOUR_XXX
|
Random colour for this industry. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| build_date
| 0..1826212865
| Date of the industry foundation in days since year 0.
|-
| build_type
| BUILDTYPE_XX
| 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).
|-
| counter
| 0..65535
| Decremented every tick, used to time primary industry production in TTD.
|-
| last_accept_date
| date(year, month, day)
| Date when cargo was accepted for the last time. Not valid before 1920 and after 2090.
|-
| random_bits
| 0 ... 65535
| Random data that can be used to randomize certain descisions. (see [[NML:Random_switch|Random switch]]) (NML r1666)
|}

 Variables that require some parameters.

{| class="t"
! name
! arguments
! comment
|-
| industry_count
| industry_type, grfid = -1
|
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. ''Warning: using this variable trashes the contents of temporary storage register 0x100''
|-
| industry_distance
| industry_type, grfid = -1
| 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. ''Warning: using this variable trashes the contents of temporary storage register 0x100.''
|-
| industry_layout_count / industry_layout_distance
| industry_type, layout, grfid = -1.
| 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. ''Warning: using this variable trashes the contents of temporary storage registers 0x100 and 0x101.''
|-
| industry_town_count
| industry_type, grfid = -1.
| 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. ''Warning: using this variable trashes the contents of temporary storage registers 0x100 and 0x101.''
|-
| town_manhattan_dist
| x, y
| Parameters indicate a signed offset relative to the northern tile. Returns the Manhattan distance (dx + dy) from the selected tile to the closest town
|-
| town_euclidean_dist
| x, y
| 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.
|-
| town_zone
| x, y
|
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.
|-
| nearby_tile_random_bits
| x, y
| 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.
|}

==Industry callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| varies
| Any unhandled callbacks. Generally this doesn't need to be used, except for old-style callbacks.
|-
| produce_cargo_arrival
| Produce-block
| Called to produce cargo when it arrives.
|-
| produce_256_ticks
| Produce-block
| Called to produce cargo every 256 ticks.
|-
| availability
| CB_RESULT_IND_ALLOW or CB_RESULT_IND_DISALLOW
|
{{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]].
|-
| construction_probability
| CB_RESULT_IND_NO_CONSTRUCTION, CB_RESULT_IND_PROBABILITY_FROM_PROPERTY or a relative probability 0..255
|
{{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.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The [[#Industry creation types|creation type]].
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.
|-
| location_check
|
See the [[#Location check results|table]] below.
|
Called to check if a location is suitable.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The [[#Industry creation types|creation type]].
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.
|-
| monthly_prod_change
|
See [[#Production change callback results|below]]
| Called each month to (possibly) change the industry production.
* <code style="color:darkgreen">extra_callback_info2</code>: 32 random bits.
|-
| random_prod_change
|
See [[#Production change callback results|below]]
| 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.
|-
| build_prod_change
| Value in range 4-128
| 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. Requires OpenTTD > r24186 and nml > 1886.
|-
| cargo_subtype_display
| String or CB_RESULT_NO_TEXT
| This callback allows displaying some text after a cargo name. Returning CB_RESULT_NO_TEXT displays nothing.
* <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.
* <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.
|-
| extra_text_industry
| String
| Show extra text in the industry window.
|-
| extra_text_fund
| String
| Show extra text in the fund window. Since the industry isn't built, no industry variables are available.
|-
| control_special
| 0 or 1
| 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.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Queried effect.
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.
|-
| stop_accept_cargo
| 0 or 1
| 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.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code> The cargo type to accept or not.
|-
| colour
| COLOUR_XXX
| 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.
|-
| cargo_input
| Cargo type, or 0xFF
| Decide the input cargo types. Called repeatedly until 0xFF is returned, although currently not more than three times. Do not rely on this limitation, though.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>: Starts at 0 and is incremented for every iteration.
Return a cargo type (from the table) or 0xFF to stop.
|-
| cargo_output
| Cargo type, or 0xFF
| 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.
|}

{{NML:LocationCheckResults}}

===Production change callback results===

{| class="t"
! value
! meaning
|-
| CB_RESULT_IND_PROD_NO_CHANGE
| Do not change industry production
|-
| CB_RESULT_IND_PROD_HALF
| Half industry production. If production goes below a quarter of default, the industry closes.
|-
| CB_RESULT_IND_PROD_DOUBLE
| Double production if it's not 8x default yet.
|-
| CB_RESULT_IND_PROD_CLOSE
| Announce closure and remove the industry next month.
|-
| CB_RESULT_IND_PROD_RANDOM
| Do a random production change, as if the industry is a primary one.
|-
| CB_RESULT_IND_PROD_DIVIDE_BY_4
| Divide production by 4
|-
| CB_RESULT_IND_PROD_DIVIDE_BY_8
| Divide production by 8
|-
| CB_RESULT_IND_PROD_DIVIDE_BY_16
| Divide production by 16
|-
| CB_RESULT_IND_PROD_DIVIDE_BY_32
| Divide production by 32
|-
| CB_RESULT_IND_PROD_MULTIPLY_BY_4
| Multiply production by 4
|-
| CB_RESULT_IND_PROD_MULTIPLY_BY_8
| Multiply production by 8
|-
| CB_RESULT_IND_PROD_MULTIPLY_BY_16
| Multiply production by 16
|-
| CB_RESULT_IND_PROD_MULTIPLY_BY_32
| Multiply production by 32
|-
| CB_RESULT_IND_PROD_DECREMENT_BY_1
| Decrement production by 1
|-
| CB_RESULT_IND_PROD_INCREMENT_BY_1
| Increment production by 1
|-
| CB_RESULT_IND_PROD_SET_BY_0x100
| Set the production level to the value in bits 16 .. 23 of register 0x100.
|}

Setting bit 7 of the result disables the associated news message. Setting bit 8 replaces the news message with a custom message, read from register 0x100 bits 0 .. 15.

===Industry creation types===

{| class="t"
! value
! meaning
|-
| IND_CREATION_GENERATION
| Industry is created during map generation, or when building 'many random industries' in the scenario editor.
|-
| IND_CREATION_RANDOM
| Industry is randomly generated during gameplay
|-
| IND_CREATION_FUND
| Industry is funded by the player (in game or scenario editor)
|-
| IND_CREATION_PROSPECT
| Industry is prospected by the player
|}

NML:IndustryTiles

2015-07-04T08:15:16Z

Supercheese: /* Industry tile callbacks */ The function is "getbits" not "get_bits"

{{NMLNavPropVarCB}}

This page contains information on industry tile properties, variables and callbacks. [[NML:Industries|Industries]] are closely related.

== Industry tile ID allocation ==
Industry tile IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range. You should start your item definition with the 'substitute'-property, which allocates a new industry tile. The value of this property should be the ID of a [[IndustryTileDefaultProps|default industry tile]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).

Furthermore, you can set the 'override'-property, which will cause the existing industry tile 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.

==Industry tile properties==

{| class="t"
! property
! value range
! comment
|-
| substitute
|
[[NML:Default industry tiles|0..174]]
| Number of the default industry tile that replaces this one, if this industry tile is not available for some reason. '''This property ''must'' be set first, before any other properties or graphics.''' All properties of the old type are copied to your new house.
|-
| override
|
[[NML:Default industry tiles|0..174]]
| id of the default industry tile which this industry tile replaces. This will cause your industry tile to be placed instead of the default industry tile. This is ignored, if the default industry tile has already been overridden. You can define this property multiple times
|-
| accepted_cargos
| Array with up to 3 [cargo_id, amount]-pairs.
| The cargos that are accepted by this tile. CargoID is a cargo type from your cargo translation table, amount is the acceptance of the given cargo in 1/8 units. Example: to make a tile accept both COAL and IORE you could use this: <code style="color:darkgreen"><nowiki>accepted_cargos: [[COAL, 8], [IORE, 8]];</nowiki></code> Example: for a tile that doesn't any cargos at all you'd use: <code style="color:darkgreen">accepted_cargos: [];</code>
|-
| land_shape_flags
|
bitmask([[#Land shape flags|Land shape flags]])
|
|-
| callback_flags
| bitmask(INDTILE_CBF_XXX, INDTILE_CBF_YYY)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| animation_info
| Array [ANIMATION_XXX, frame-count]
| XXX = [LOOPING <nowiki>|</nowiki> NON_LOOPING], 1..253 frames
|-
| animation_speed
| 0..16
|
Speed of animation, see [[NML:Animation speed|animation speed table]] for the meaning of the values.
|-
| animation_triggers
| bitmask(ANIM_TRIGGER_INDTILE_XXX, ... )
|
Bitmask of triggers that will trigger the <code style="color:darkgreen">anim_control</code> callback, see the [[#Animation triggers|table]] below.
|-
| special_flags
| bitmask(INDTILE_FLAG_XXX)
| XXX is a special flag description. Currently there's only one flag defined: set INDTILE_FLAG_RANDOM_ANIMATION if the decision in anim_control callback needs random bits via extra_callback_info1
|}

===Land shape flags===

{| class="t"
! Flag
! Meaning
|-
| LSF_CANNOT_LOWER_NW_EDGE
| North-west edge cannot be lowered
|-
| LSF_CANNOT_LOWER_NE_EDGE
| North-east edge cannot be lowered
|-
| LSF_CANNOT_LOWER_SW_EDGE
| South-west edge cannot be lowered
|-
| LSF_CANNOT_LOWER_SE_EDGE
| South-east edge cannot be lowered
|-
| LSF_ONLY_ON_FLAT_LAND
| This tile can only be built on flat land
|-
| LSF_ALLOW_ON_WATER
| The land/water check is disabled for this tile so it can be built on water. If you need more control over this use callback "tile_check".
|}

{{NML:IndustryCommonVariables}}

==Industry tile variables==

{| class="t"
! name
! value range
! comment
|-
| construction_state
| 0..3
| Current construction state of the industry tile.
|-
| terrain_type
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| town_zone
|
[[NML:List of town zones|town zone]]
| The town zone of the current tile.
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| animation_frame
| 0..255
| Current animation frame.
|}

 

Industry tiles have access to the [[#Common variables|common variables]] described above. Additionally, they have access to the following:

{| class="t"
! name
! arguments
! comment
|-
| nearby_tile_is_same_industry
| x, y
| Parameters indicate a signed tile offset relative to the current tile. Returns 1 if the tile is part of the same industry, 0 otherwise
|}

==Industry tile callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Graphics for the industry tile
|-
| random_trigger
| N/A
|
See [[NML:Random switch|random switch]] for more information.
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if enabled in the <code style="color:darkgreen">special_flags</code> property.
Returning a sound effect in the high byte will cause that sound effect to be played.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
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.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if enabled in the <code style="color:darkgreen">special_flags</code> property.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the 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.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| cargo_type_accept
| type1 + (type2 << 5) + (type3 << 10)
| Decide the cargo types that this tile accepts. If this callback is not implemented or fails, the values from <code style="color:darkgreen">accepted_cargos</code> are used instead. Bits 0..4: First cargo type. Bits 5..9: Second cargo type. Bits 10..14: Third cargo type.
|-
| cargo_amount_accept
| amt1 + (amt2 << 4) + (amt3 << 8)
| Acceptance for each cargo amount in 1/8th. If this callback is not implemented or fails, the values from <code style="color:darkgreen">accepted_cargos</code> are used instead. Cargo types are from the <code style="color:darkgreen">cargo_type_accept</code> callback, or the <code style="color:darkgreen">accepted_cargos</code> property if that callback failed. Bits 0..3: Acceptance of first cargo type. Bits 4..7: Acceptance of second cargo type. Bits 8..11: Acceptance of third cargo type.
|-
| tile_check
|
Same as for the [[#Location check results|location_check]] industry callback
|
Called before constructing the industry, so nothing exists on the map yet. Since the industry isn't built yet, so you can't access industry variables. From the tile variables, relative x/y/position, town zone are available, as well as the class, height, slope, terrain type and water status of nearby tiles.
* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: The industry layout number.
* <code style="color:darkgreen">getbits(extra_callback_info2, 8, 8)</code>: The [[#Industry creation types|creation type]]
Note: use of this callback will deactivate the use of the landshape flags. If this callback is not implemented or fails, the <code style="color:darkgreen">land_shape_flags</code> property will be used instead to determine if the slope is suitable. This also means that without this callback, the tile may not be built on steep slopes.
|-
| foundations
| CB_RESULT[_NO]_FOUNDATIONS
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.
|-
| autoslope
| CB_RESULT[_NO]_AUTOSLOPE
| Return CB_RESULT_AUTOSLOPE to allow autoslope (altering the ground below a tile) or CB_RESULT_NO_AUTOSLOPE to disallow it.
|}

{{NML:LocationCheckResults}}

===Animation triggers===

{| class="t"
! Trigger
! Meaning
|-
| ANIM_TRIGGER_INDTILE_CONSTRUCTION_STATE
| the construction state changes
|-
| ANIM_TRIGGER_INDTILE_TILE_LOOP
| the tile is processed in the periodic processing loop
|-
| ANIM_TRIGGER_INDTILE_INDUSTRY_LOOP
| the industry of the tile is processed in the periodic processing loop (synchronized for all tiles)
|-
| ANIM_TRIGGER_INDTILE_RECEIVED_CARGO
| the industry of the tile receives input cargo from a station (synchronized for all tiles)
|-
| ANIM_TRIGGER_INDTILE_DISTRIBUTES_CARGO
| the industry distributes its output cargo to one of the stations nearby (synchronized for all tiles)
|}

NML:Railtypes

2015-07-04T08:15:01Z

Supercheese: The function is "getbits" not "get_bits"

{{NMLNavPropVarCB}}

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

==Railtype IDs==
Railtype IDs are limited to 16 in total. NewGRF-local IDs may freely be chosen, but must be in the 0..15 range. If other railtype GRFs are loaded, it may be that there are not enough railtype slots available. To prevent your entire NewGRF from being deactivated with the 'Attempt to use invalid ID'-error, you can use the following code:

if (railtype_available("LABL") || loading_stage == LOADING_STAGE_RESERVE)
... item definition ...
} else if (loading_stage == LOADING_STAGE_ACTIVATE) {
... warning / error ...
}
The warning / error is optional, but can be used to inform the user about the missing railtypes.

==Railtype properties==

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

===Sort order===

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

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

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

===Base speeds for curves===

The base speeds relevant for the curve_speed_multiplier are:

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

==Railtype variables==

{| class="t"
! name
! value range
! comment
|-
| terrain_type
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|
|-
| enhanced_tunnels
| 0
| should custom tunnel entrances be modified other values than 0 might be returned
|-
| level_crossing_status
| LEVEL_CROSSING_CLOSED, LEVEL_CROSSING_OPEN
|
|-
| build_date
| 0 .. 5000000
| for depots only: build date of the depot in days since 0
|-
| town_zone
| [[NML:List of town zones|town zone]]
| Town zone of the tile. (Only available for level crossings and depots.)
|}

==Railtype callbacks==

For rail types a number of callbacks are used to define rail type graphics. Each should refer to a sprite set containing the relevant sprites. Refer to the [[#Example sprites|example sprites]] or the example railtype grf in the NML repository, for an example on what sprites are needed in what order.

{| class="t"
! callbacks
! number of sprites
! meaning
|-
| gui
| 16
| 4 rail directions, autorail, depot, tunnel and convert rail sprites for rail menu.
|-
| track_overlay<ref name=leftout>Either all or none of these sprites should be provided.</ref>
| 10
| 6 flat and 4 slope sprites. Track without landscape. Used in junctions, and also with path signals, if the "Show reserved tracks" option is enabled in the game settings.
|-
| underlay<ref name=leftout />
| 16
| 6 flat and 4 slope, one crossing WITH track, 5 junction pieces without track. Tracks with ballast but without landscape.
|-
| tunnels<ref name=leftout />
| 4
| 1 sprite for each direction. Sprite is overlay for track in existing tunnel graphics. The original ground sprite is drawn, then the overlay, then possibly a train and the original tunnel head is drawn over the top. This keeps compatibility with different landscape types. Sprite order: SW, NW, NE, SE.
|-
| catenary_wire
| 28
|
|-
| catenary_pylons
| 8
|
|-
| bridge_surfaces<ref name=leftout />
| 6
|
|-
| level_crossings<ref name=leftout />
| 10
| For each direction: one track sprite and 4 sprites for road lights etc
|-
| depots<ref name=depotr22854>{{ottd|1.2|r22854}} In OpenTTD prior to r22854, depot sprites would not be used if the above 'all or none' sprites were not supplied.</ref>
| 6
| 2 sprites for each south-ish, 1 sprite for each north-ish depot. Like original depots.
|-
| fences
| 8
| x, y, vertical, horizontal, SW, SE, NE and NW slopes like original fences at sprite 1301.
|-
| tunnel_overlay<ref name=tunnel_overlay>Above 'all or none' sprites must be supplied, if these sprites are to be used.</ref>
| 4
| If this callback is defined, tunnels for this railtype will be drawn differently. First, a grass underlay base sprite is drawn, then the 'tunnels'-sprite. Next, train sprites if applicable and then a grass overlay and finally the sprite from this type (tunnel_overlay). The grass sprites are defined in the base set and do not contain any parts of the tracks or portal, so these have to be fully provided by the railtype sprites.
* <code style:darkgreen>getbits(extra_callback_info1, 0, 8)</code>: 0 for normal tunnels, without any extra features (like tracks above). All other values are reserved for future extensions.
|-
| signals
| 8
| {{ottd|1.3|r24367}} 1 sprite for each direction, order is SW(-facing), NE, SE, NW, E, W, S, N. For more information, see [[#signals|below]]
|}

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

===Example sprites===
==== gui ====

[[File:railtype_gui.png]]

==== track_overlay ====

[[File:railtype_overlay.png]]

==== underlay ====

[[File:railtype_underlay.png]]

==== level_crossings ====

You can define a special track piece which crosses the road and for each of two directions and each of the corners of the tile a separate sprite for a light, sign, or whatever should go there.

{| class="wikitable"
|-
!Sprite number for X
!Sprite number for Y
!Useage
|-
|0
|    1
|    Rail overlay
|-
|2
|    3
|    North light
|-
|4
|    5
|    East light
|-
|6
|    7
|    West light
|-
|8
|    9
|    South light
|}

[[File:railtype_levelcrossing.png]]

==== depots ====

{| class="wikitable
|-
!Sprite Number
!Usage
|-
|0
|    NE wall for SE-entry depot.
|-
|1
|    Depot building for SE-entry depot.
|-
|2
|    NW wall for SW-entry depot.
|-
|3
|    Depot building for SW-entry depot.
|-
|4
|    Depot building for NE-entry depot.
|-
|5
|    Depot building for NW-entry depot.
|}

==== fences ====

[[File:railtype_fences.png]]

==== tunnel_overlay ====

If this callback is defined, tunnels for this railtype will be drawn differently.

First, a grass underlay base sprite is drawn, then the 'tunnels'-sprite. Next, train sprites if applicable and then a grass overlay and finally the sprite from this callback. The grass sprites are defined in the base set and do not contain any parts of the tracks or portal, so these have to be fully provided by the railtype sprites.

Illustration: [[File:RailtypeTunnelExample.png]]

==== signals ====

This callback can be used to supply custom signal graphics.

The resulting sprite set must consist of 8 sprites, corresponding to the following signal directions: SW-facing, NE-facing, NW-facing, SE-facing, E-facing, W-facing, S-facing, N-facing. If resolving fails or results in an empty sprite group, the matching base set sprite will be used instead.
<ul><li>
<code style:darkgreen>getbits(extra_callback_info2, 0, 8)</code>:
{| |-
! SS: Signal state !! Meaning
|-
| 00 || Red signal
|-
| 01 || Green signal
|-
| all other values || Reserved
|}
</li><li>
<code style:darkgreen>getbits(extra_callback_info2, 8, 8)</code>:
{| |-
! VV: Signal variant !! Meaning
|-
| 00 || Light (electric) signal
|-
| 01 || Semaphore
|-
| all other values || Reserved
|}
</li><li>
<code style:darkgreen>getbits(extra_callback_info2, 16, 8)</code>:
{| |-
! TT: Signal type !! Meaning
|-
| 00 || Normal block signal
|-
| 01 || Entry pre-signal
|-
| 02 || Exit pre-signal
|-
| 03 || Combo pre-signal
|-
| 04 || Two-way path signal
|-
| 05 || One-way path signal
|-
| all other values || Reserved
|}
</li><li>
<code style:darkgreen>getbits(extra_callback_info1, 0, 8)</code>:
{| |-
! Drawing context !! Meaning
|-
| 0 || Signal is drawn in a viewport, i.e. on the map.
|-
| 0x10 || Signal is drawn in the signal GUI. The returned sprite set must still have 8 sprites, but OpenTTD will only use the 7th sprite, so all other sprites can be empty.
|-
| all other values || Reserved
|}
</li></ul>

===Example code===

A typical implementation for railtypes can look like:

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

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

NML:Objects

2015-07-04T08:14:45Z

Supercheese: /* Object callbacks */ The function is "getbits" not "get_bits"

{{NMLNavPropVarCB}}

==Object IDs==
Object IDs are NewGRF-local and can therefore freely be chosen in the 0..255 range. An object is allocated by setting the 'class'-property, which should therefore be set first. Overriding the default objects (e.g. transmitter, lighthouse) is not (yet) possible.

==Object properties==

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

===Default object classes===

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

===List of object flags===

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

==Object variables==

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

Variables that require one or more parameters:

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

==Object callbacks==

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

<references/>

{{NML:LocationCheckResults}}

===Animation triggers===

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

NML:Airports

2015-07-04T08:14:27Z

Supercheese: /* Airport tile callbacks */ The function is "getbits" not "get_bits"

{{NMLNavPropVarCB}}

Airports and airport tiles can only be defined in OpenTTD {{ottd|1.1|r19459}} or later.

==Airport (tile) IDs==
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).

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.

==Airport properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{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.'''
|-
| layouts
| list of layouts
|
{{ottd|1.1|r20377}}
|-
| name
| string
|
{{ottd|1.1|r19459}} Name of the airport
|-
| years_available
| [start year, last year]
|
{{ottd|1.1|r19459}} List of the availablility years: first and last year it can be built
|-
| ttd_airport-type
| 0 ... 3
|
{{ottd|1.1|r19459}} Substitute TTDPatch airport type
|-
| catchment_area
|
|
{{ottd|1.1|r19459}} Catchment area of the airport in tiles around its perimeter
|-
| noise_level
|
|
{{ottd|1.1|r19459}} Noise generation of this airport
|-
| maintenance_cost
|
|
{{ottd|1.2|r23415}} Maintenance cost factor for this airport
|}

==Airport tile properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{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.'''
|-
| substitute
|
|
{{ottd|1.1|r19204}} The id of airport tile to replace
|-
| callback_flags
| bitmask
|
{{ottd|1.1|r19204}} Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| animation_info
| Array [ANIMATION_XXX, frame-count]
|{{ottd|1.1|r19204}} XXX = [LOOPING <nowiki>|</nowiki> NON_LOOPING], 1..253 frames
|-
| animation_speed
|
|
{{ottd|1.1|r19204}} See [[NML:Animation speed|speed settings]]
|-
| animation_triggers
| bitmask(ANIM_TRIGGER_APT_XXX, ... )
|
{{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.
|}

==Airport variables==

A number of variables are shared between airports and stations. These are listed on the [[NML:Stations#Base station variables|stations]] page.

{| class="t"
! name
! value range
! comment
|-
| layout
| 0 .. (number of layouts - 1)
|
{{ottd|1.1|r20364}} Layout number of the airport (index in the layouts array)
|}

==Airport tile variables==

{| class="t"
! name
! value range
! comment
|-
| terrain_type
|
|
|-
| town_radius_group
|
|
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| animation_frame
|
|
|}

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.

{| class="t"
! name
! value range
! comment
|-
| nearby_tile_slope
| SLOPE_XXX
|
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| nearby_tile_is_same_airport
| 1 if the tile is part of the same airport, 0 otherwise
|
|-
| nearby_tile_is_water
| 1 if the tile is water, 0 otherwise
|
|-
| nearby_tile_terrain_type
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| nearby_tile_water_class
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| 0..120
| The height of the lowest corner of the given tile.
|-
| nearby_tile_class
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| 0..255
| Animation frame of the given tile
|-
| nearby_tile_airporttile_id
| 0x00aa, 0xFFbb, 0xFFFE or 0xFFFF
| 0x00aa: The tile is an airport tile that is part of this GRF, the tile id is aa. 0xFFbb: The tile is an original airport tile with id bb. 0xFFFE: The tile is an airport tile defined in another GRF. 0xFFFF: The tile is not an airport tile or it belongs to another GRF.
|}

==Airport callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite set (with 1 sprite)
| 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.
|-
| additional_text
| String
| Additional text to show in the buy menu. String may differ per layout, use the <code style="color:darkgreen">layout</code> variable for this.
|-
| layout_name
| String
| Name of the airport layout in the variable <code style="color:darkgreen">layout</code>
|}

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.

==Airport tile callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Graphics for an airport tile
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
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.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits.
* <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.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| foundations
| CB_RESULT[_NO]_FOUNDATIONS
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.
|}

===Animation triggers===

{| class="t"
! Animation trigger
! Description
|-
| ANIM_TRIGGER_APT_BUILT
| Airport is built (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_TILELOOP
| Airport tile is processed in the tileloop (at different times for different tiles)
|-
| ANIM_TRIGGER_APT_NEW_CARGO
| New cargo arrives at the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_CARGO_TAKEN
| All cargo of a cargo type is removed from the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_250_TICKS
| Every 250 ticks (all tiles at the same time)
|}

NML:Cargos

2015-07-04T08:14:11Z

Supercheese: The function is "getbits" not "get_bits"

{{NMLNavPropVarCB}}

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

==Cargo properties==

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

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

===Cargo classes===

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

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

===Cargo effects on town growth===

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

==Cargo variables==

Cargos have no variables (yet).

==Cargo callbacks==

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

===Station rating callback===

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

====Callback parameters====

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

====Effect of callback====

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

NML:Houses

2015-07-04T08:13:51Z

Supercheese: /* House callbacks */ The function is "getbits" not "get_bits"

{{NMLNavPropVarCB}}
==House IDs==
House IDs are local to the NewGRF, you are free to choose any ID in the 0..255-range. You should start your item definition with the 'substitute'-property, which allocates a new house. The value of this property should be the ID of a [[NML:List_of_default_house_properties|default house type]], which will be used instead of your item if it is not available for whatever reason (for example, missing NewGRF).

Although the majority of all original houses occupy a single tile, it is possible to define a larger house of up to 2x2 tiles. For this, you should set the fourth 'size' parameter in the item-block. Valid values are HOUSE_SIZE_XXX, XXX = <nowiki>[1X1 | 1X2 | 2X1 | 2X2]</nowiki>. This size should match the size of the substitute house type.

Note, setting the 4th parameter requires to also set the 3rd parameter. If you want automatic id assignment (mind the notes on the [[NML:Item|Item page]]), you need to set the 3rd parameter to -1. Example:
<pre style="color:blue">
item(FEAT_HOUSES, item_brewery, -1, HOUSE_SIZE_2X2) {
}
</pre>

===Multi-tile houses===
Internally, due to the way NewGRF houses work, a multi-tile house will occupy more than one item ID. If you assign item ID X to a house, item IDs X+1 (for a 2-tile house) and (X+1) .. (X+3) (for a 4-tile house) will also be used. Normally you don't have to care about this, but there are two exceptions:
* If you manually assign numeric ids to your houses. You are recommended to just set all ids to -1 and let NML figure it out for you.
* When working with several variables that work with house type IDs. Keep in mind that tiles of a multi-tile house may have IDs X .. X + N - 1, with X being the assigned id and N the number of house tiles.

==House properties==

{| class="t"
! property
! value range
! comment
|-
| substitute
| 0 ... 109
| Number of the default house that replaces this one, if this house is not available for some reason. '''This property ''must'' be set first, before any other properties or graphics.''' All properties of the old type are copied to your new house, except for the church / stadium flags (see below). The old house must have the same size as the new house, see the list of [[NML:List_of_default_house_properties|default house types]] for a list of possible substitute IDs.
|-
| name
| string
| for example string(STR_NAME_EIFFEL_TOWER)
|-
| override
| 0 ... 109
| id of the default house which this house replaces (and thus disabling the default). This is ignored, if the default house has already been overridden (disabling it another time is pointless). You can define this property multiple times. Your house and the overridden house must have the same size, see the list of [[NML:List_of_default_house_properties|default house types]].
|-
| building_flags.
| bitmask(HOUSE_FLAG_XXX,...)
|
;HOUSE_FLAG_NOT_SLOPED
:Can only be built on flat terrain. Note that 2x2 buildings will always only be built on flat land, even if this bit isn't set.
;HOUSE_FLAG_ANIMATE
:Enable animation unconditionally on (the beginning of) construction. If not set, animation can still be started (conditionally) via the callbacks <code style="color:darkgreen">anim_control</code>, <code style="color:darkgreen">construction_anim</code> or <code style="color:darkgreen">watched_cargo_accepted</code>.
;HOUSE_FLAG_CHURCH
:House is a church (only 1 will be built per town)
;HOUSE_FLAG_STADIUM
:House is a stadium (only 1 will be built per town)
;HOUSE_FLAG_ONLY_SE
:Can only be built in the scenario editor
;HOUSE_FLAG_PROTECTED
:Will not be removed by the game
;HOUSE_FLAG_SYNC_CALLBACK
:Animation callback <code style="color:darkgreen">anim_control</code> is called at the same time for all tiles.
;HOUSE_FLAG_RANDOM_ANIMATION
:Enable random bits in the <code style="color:darkgreen">anim_next_frame</code>-callback.
|-
| population
| 0 ... 255
| number of inhabitants the building adds to the town, if present
|-
| mail_multiplier
| 0 ... 255
|
|-
| accepted_cargos
| Array with up to 3 [cargo_id, amount]-pairs.
| The cargos that are accepted by each tile of the house. CargoID is a cargo type from your cargo translation table, amount is the acceptance of the given cargo in 1/8 units. Example: to make a tile fully accept both PASS and MAIL you could use this: <code style="color:darkgreen"><nowiki>accepted_cargos: [[PASS, 8], [MAIL, 8]];</nowiki></code> Example: for a house tile that doesn't accept any cargos at all you'd use: <code style="color:darkgreen">accepted_cargos: [];</code>
|-
| local_authority_impact
| 0 ... 65525
| amount of happiness decrease of the city council, if the building is destroyed. Town ratings can vary between -1000 (appalling) and +1000 (outstanding).
|-
| removal_cost_multiplier
| 0 ... 255
|
|-
| probability
| 0 ... 15 (float)
| Probability with respect to the default houses (=1). Mind that these are relative probabilities with respect to all houses defined. If all probabilities are defined as 16, they'll all have the same probability as if they had all a probability of 1.
|-
| years_available
| array of two int
| [xx, yy] where xx and yy indicate the introduction year and the last year the building can be built
|-
| minimum_lifetime
| 0 ... 255
| number of years the building will remain at least
|-
| availability_mask
|
[bitmask([[NML:List of town zones|town zones]]), bitmask(CLIMATE_XXX, ...)]
|
An array with two bitmasks, the first bitmask is a mask of town zones where this house is available. The second bitmask is a mask of climates combined with the special value ABOVE_SNOWLINE which you need to set for houses available in the arctic climate above the snowline. Examples:

* Available in the centre town zone in toyland only: <code>[bitmask(TOWNZONE_CENTRE), bitmask(CLIMATE_TOYLAND)]</code>
* Available in all town zones in the arctic climate both above and below the snowline: <code>[ALL_TOWNZONES, bitmask(CLIMATE_ARCTIC, ABOVE_SNOWLINE)]</code>
* Available everywhere except on the town edge: <code>[ALL_TOWNZONES & ~bitmask(TOWNZONE_EDGE), ALL_CLIMATES | bitmask(ABOVE_SNOWLINE)</code>
|-
| callback_flags
| bitmask(HOUSE_CBF_XX)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| random_colours
| array of 4, each COLOUR_XXX
|
colour values in an array, refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for a list of possible values.
|-
| refresh_multiplier
| 0 ... 63
| Defines the frequency with which the tile will be re-randomized which has an impact for random animation. The tile will be processed by the periodic tile processing loop every (X + 1)*256 ticks, with X being the value of this property.
|-
| animation_info
| Array [ANIMATION_XXX, frame-count]
|
Type of animation and its length (1...128 frames):

;ANIMATION_LOOPING
;ANIMATION_NON_LOOPING
|-
| animation_speed
| 2 ... 16
|
Speed of animation, see [[NML:Animation speed|animation speed table]] for the meaning of the values.
|-
| building_class
| 0 .. 254
| An arbitrary number. You can check for the presence of buildings of the same class when building new buildings or using animation. Only the north tile of a multi-tile building is assigned a class.
|
|-
| watched_cargo_types
| array of values from your [[NML:Cargotable|cargo table]]
| {{ottdp|1.2|2.6|ottdrev=r23072|ttdprev=r1677}}List of cargo types to watch, to be used with the <code style:darkgreen>watched_cargo_accepted</code> callback.
|}

==House variables==

{| class="t"
! name
! value range
! comment
|-
| construction_state
| 0..3
| Current construction state of the house tile. 0..2 = under construction, 3 = finished.
|-
| pseudo_random_bits
| 0..3
| Some pseudo-random bits, based on the tile position. TTD houses use this to randomize their appearance.
|-
| random_bits
| 0..255
| 8 random bits, also used for [[NML:Random_switch|random switch]]-blocks. Initially these are the same for all tiles of a multi-tile house.
|-
| age
| 0..255
| Age of the house in years, limited to 255
|-
| town_zone
| [[NML:List of town zones|town zone]]
| The town zone of the current tile
|-
| terrain_type
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| same_house_count_town
| 0..255
| Number of the houses with the same ID in the same town as this house
|-
| same_house_count_map
| 0..255
| Number of the houses with the same ID on the entire map
|-
| same_class_count_town
| 0..255
| Number of the houses with the same <code style="color:darkgreen">building_class</code> in the same town as this house. The class of the north tile of the use is used for this purpose, as other tiles don't normally have a class.
|-
| same_class_count_map
| 0..255
| Number of the houses with the same <code style="color:darkgreen">building_class</code> on the entire map. The class of the north tile of the use is used for this purpose, as other tiles don't normally have a class.
|-
| generating_town
| [0 <nowiki>|</nowiki> 1]
| 1 a random town is currently being created, 0 otherwise. Note that while generating a random town, [[NML:Towns#Town variables|town variables]] <code style="color:darkgreen">population</code> and <code style="color:darkgreen">building_count</code> are incorrect. The population variable contains the population of buildings generated ''yet'', the final value may be larger. The building_count is surely higher than the final value will be.
|-
| animation_frame
| 0..255
| Current animation frame
|-
| x_coordinate
| 0..2047
| X-coordinate (top right -> bottom left) of the tile on the map
|-
| y_coordinate
| 0..2047
| Y-coordinate (top left -> bottom right) of the tile on the map
|-
| relative_x
| 0..1
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..1
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| house_tile
| HOUSE_TILE_XXX, XXX = <nowiki>[NORTH | EAST | WEST | SOUTH]</nowiki>
| What tile of a multi-tile house this is.
|-
| house_type_id
| 0..255
| Item ID of this house type, that was assigned to the item. See the note above about [[#Multi-tile houses|multi-tile houses]].
|}

The following variables require one or more arguments
{| class="t"
! name
! arguments
! value range
! comment
|-
| old_house_count_town
| ID of old house type (0..109)
| 0..255
| Number of old houses with a given ID in the same town as the current house
|-
| old_house_count_map
| ID of old house type (0..109)
| 0..255
| Number of old houses with a given ID on the whole map
|-
| other_house_count_town
| ID of house defined in this NewGRF (0..255)
| 0..255
| Number of houses with a given ID in the same town as the current house.
|-
| other_house_count_map
| ID of house defined in this NewGRF (0..255)
| 0..255
| Number of houses with a given ID on the whole map
|-
| other_class_count_town
| ID of house defined in this NewGRF (0..255)
| 0..255
| Number of houses, with the same class as the house with the given ID, in the same town as the current house
|-
| other_class_count_map
| ID of house defined in this NewGRF (0..255)
| 0..255
| Number of houses, with the same class as the house with the given ID, on the whole map
|-
| nearby_tile_slope
| x- and y-offset (both signed, range -8..7)
| SLOPE_XXX
| See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| nearby_tile_is_water
| x- and y-offset (both signed, range -8..7)
| [0 <nowiki>|</nowiki> 1]
| 1 if the tile is water, 0 otherwise
|-
| nearby_tile_terrain_type
| x- and y-offset (both signed, range -8..7)
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| nearby_tile_water_class
| x- and y-offset (both signed, range -8..7)
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| x- and y-offset (both signed, range -8..7)
| 0..255 (currently limited to 0..15)
| Height of the lowest corner of the tile. 1 unit is one height level of 8 pixels.
|-
| nearby_tile_class
| x- and y-offset (both signed, range -8..7)
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| x- and y-offset (both signed, range -8..7)
| 0..255
| Animation frame of the given tile
|-
| cargo_accepted_nearby_ever
| cargo type, x- and y-offset <ref name="cargo_accepted_nearby">Cargo type should be from your cargo translation table. X- and y-offset are optional, if provided both must be in range -128..127. A station is considered nearby if the tile is in the station's acceptance area. This is the purpose of the x- and y-offset, as other tiles may have other stations nearby.</ref>
| [0 <nowiki>|</nowiki> 1]
| 1 if the given cargo type was ever accepted at a nearby station, 0 otherwise
|-
| cargo_accepted_nearby_last_month
| cargo type, x- and y-offset <ref name="cargo_accepted_nearby" />
| [0 <nowiki>|</nowiki> 1]
| 1 if the given cargo type was accepted at a nearby station in the last month, 0 otherwise
|-
| cargo_accepted_nearby_this_month
| cargo type, x- and y-offset <ref name="cargo_accepted_nearby" />
| [0 <nowiki>|</nowiki> 1]
| 1 if the given cargo type was ever accepted at a nearby station in this month, 0 otherwise
|-
| cargo_accepted_nearby_last_bigtick
| cargo type, x- and y-offset <ref name="cargo_accepted_nearby" />
| [0 <nowiki>|</nowiki> 1]
| 1 if the given cargo type was ever accepted at a nearby station since the last periodic processing, which happens every 250 ticks. 0 otherwise
|-
| cargo_accepted_nearby_watched
| cargo type, x- and y-offset <ref name="cargo_accepted_nearby" />
| [0 <nowiki>|</nowiki> 1]
| 1 if the given cargo type was one of the cargo types that triggered the <code style="color:darkgreen">watched_cargo_accepted</code>-callback (only during this callback), 0 otherwise
|-
| nearest_house_matching_criterion
| radius (1..63) and criterion (SEARCH_HOUSE_BY_XXX, XXX = [<nowiki>TYPE | CLASS | GRFID</nowiki>])
| 1..63, or 0 if not found
| Perform a circular search for a house matching either the id, <code style="color:darkgreen">building_class</code> or GRFID of this house, depending on the second parameter. The first parameter specifies the maximum search radius. Return value is the Manhattan distance of the closest matching house tile, or 0 if no match was found. Note that tiles of the originating house never match. See also the note above about [[#Multi-tile houses|multi-tile houses]].
|-
| nearby_tile_house_id
| x- and y-offset (both signed, range -8..7)
| -1, or 0 .. 767
| Return value is -1 if the tile is not a house tile, X (0..255) if the tile contains old house type X, 256+X if the tile contains a house from this NewGRF with ID X, 512+X if the tile contains a house from a different NewGRF with ID X. See the note above about [[#Multi-tile houses|multi-tile houses]].
|-
| nearby_tile_house_class
| x- and y-offset (both signed, range -8..7)
| -1, 0, or 256 .. 767
| Return value is -1 if the tile is not a house tile, 0 if the house tile does not have a class (this includes all old house types), 256+X (X = 0..255) if the house has been defined by this NewGRF with <code style="color:darkgreen">building_class</code> X or 512+X if the house has been defined by a different NewGRF with <code style="color:darkgreen">building_class</code> X. Note that for a multi-tile house, generally only the north tile has a sensible class value.
|-
| nearby_tile_house_grfid
| x- and y-offset (both signed, range -8..7)
| -1, 0 or a GRFID
| Return value is -1 if the tile is not a house tile, 0 if the house tile contains an old house type, or else the GRFID of the NewGRF defining the house.
|}
<references/>

==House callbacks==
Unless noted otherwise, callbacks may be called for any of the tiles of a multi-tile house.

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Graphics for the house tile
|-
| graphics_xxx, xxx = <nowiki>[north | east | south | west]</nowiki>
| Sprite layout
| Tile-specific graphics for one of the tiles of a multi-tile house. Of course, this is callback is called for that tile only.
|-
| random_trigger
| N/A
|
See [[NML:Random switch|random switch]] for more information.
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played.
* <code>extra_callback_info1</code>: 32 random bits, if enabled in the <code>building_flags</code> property.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
| Called every 256 ticks. Return the animation frame to show, or CB_RESULT_XXX with XXX = <nowiki>[CB_RESULT_START_ANIMATION | STOP_ANIMATION | DO_NOTHING]</nowiki> to respectively start the animation in its current frame, stop the animation or do nothing. Returning a sound effect in the high byte will cause that sound effect to be played.
* <code>extra_callback_info1</code>: 32 random bits. The low 16 bits are always different for each house tile, but the high 16 bits are the same for each tile if synchronized animation is enabled in the <code>building_flags</code>-property.
|-
| construction_anim
| Same as <code>anim_control</code>
| Works the same as the <code>anim_control</code> callback, except that it's called when the construction state changes.
|-
| watched_cargo_accepted
| Same as <code>anim_control</code>
| Works the same as the <code>anim_control</code> callback, except that it's called when one of the watched cargo types is accepted.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| cargo_type_accept
| type1 + (type2 << 5) + (type3 << 10)
| Decide the cargo types that this tile accepts. If this callback is not implemented or fails, the values from <code>accepted_cargo</code> are used instead. Bits 0..4: First cargo type. Bits 5..9: Second cargo type. Bits 10..14: Third cargo type.
|-
| cargo_amount_accept
| amt1 + (amt2 << 4) + (amt3 << 8)
| Acceptance for each cargo amount in 1/8th. If this callback is not implemented or fails, the values from the acceptance properties are used instead. Cargo types are from the <code>cargo_type_accept</code> callback, or the <code>accepted_cargo</code> property if that callback failed. Bits 0..3: Acceptance of first cargo type. Bits 4..7: Acceptance of second cargo type. Bits 8..11: Acceptance of third cargo type.
|-
| cargo_production
| (cargo_type * 256) + amount, or <code>CB_RESULT_HOUSE_NO_MORE_PRODUCTION</code>
| Called every 256 ticks. The return value specifies what cargo and what amount is produced. The callback is called multiple times until <code>CB_RESULT_HOUSE_NO_MORE_PRODUCTION</code> is returned.
* <code>getbits(extra_callback_info1, 0, 8)</code>: The number of iterations so far.
* <code>extra_callback_info2</code>: 32 random bits.
|-
| foundations
| CB_RESULT[_NO]_FOUNDATIONS
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.
|-
| autoslope
| CB_RESULT[_NO]_AUTOSLOPE
| Return CB_RESULT_AUTOSLOPE to allow autoslope (altering the ground below a tile) or CB_RESULT_NO_AUTOSLOPE to disallow it.
|-
| name
| String
| Name of the building (when using tile query tool)
|-
| colour
| Palette number
|
Used to recolour the building. See here [[NML:List of default colour translation palettes|here]] for an overview of default palettes.
|-
| construction_check
| 0 or 1
| Return 1 to allow building the house or 0 to disallow. Called only for the north tile.
|-
| destruction
| 0 or 1
| Called periodically. Return 0 to keep the building or 1 to destroy it. Called only for the north tile.
|-
| protection
| 0 or 1
| Return 0 to allow destruction, or 1 to disallow
|}

NML:Vehicles

2015-07-04T08:12:20Z

Supercheese: The function is "getbits" not "get_bits"

{{NMLNavPropVarCB}}
==Properties common to all vehicle types==

{| class="t"
! property
! value range
! available for articulated vehicle
! comment
|-
| <code style="color:green">name</code>
| (string)
| yes
| for example <code style="color:darkgreen">string(STR_NAME_HEREFORD_TRAM)</code>
|-
| <code style="color:green">climates_available</code>
| bitmask(CLIMATE_XXX, CLIMATE_YYY, ...)
| set to <code style="color:green">NO_CLIMATE</code>
|
;CLIMATE_TEMPERATE
;CLIMATE_ARCTIC
;CLIMATE_TROPICAL
;CLIMATE_TOYLAND
;NO_CLIMATE
:Vehicle is availble in no climate (e.g. for articulated parts)
;ALL_CLIMATES
:Vehicle is available irrespective of climate

To make a vehicle available in all climates except toyland you could use: <code style="color:green">ALL_CLIMATES & ~bitmask(CLIMATE_TOYLAND)</code>.
|-
| <code style="color:green">introduction_date</code>
| <code style="color:green">date</code>(yyyy,mm,dd)
| no
| Valid range for yyyy is 0 ... 5000000. In TTDPatch, dates after 2044 will be limited to 2044. Unless the engine is introduced within two years after game-start (always 1920 in TTDPatch), a random number of days between 0 and 511 will be added to this.
|-
| <code style="color:green">model_life</code>
| 0 ... 254 (years) or <code style="color:green">VEHICLE_NEVER_EXPIRES</code>
| no
|
Number of years a model is "supported" by the manufacturer, see [[#Engine life cycle|below]].
|-
| <code style="color:green">retire_early</code>
| -128 ... 127 (years)
| no
|
Retire the vehicle (make it unavailable in the purchase menu) this many years before reliability starts dropping, see [[#Engine life cycle|below]]. May be negative.
|-
| <code style="color:green">vehicle_life</code>
| 0 ... 255 (years)
| no
| Life length of an individual vehicle, before it is considered too old and in need of replacement.
|-
| <code style="color:green">reliability_decay</code>
| 0 ... 255
| no
| Default vehicles use 20. The higher the value the faster reliability decays, the more frequent service is needed. 0 means reliability never decreases if the vehicle is not too old
|-
| <code style="color:green">refittable_cargo_classes</code>
|
bit set of [[NML:Cargos#Cargo classes|cargo classes]]
| yes
| for example: <code style="color:darkgreen">bitmask(CC_BULK, CC_COVERED)</code>
|-
| <code style="color:green">non_refittable_cargo_classes</code>
|
bit set of [[NML:Cargos#Cargo classes|cargo classes]]
| yes
| for example: <code style="color:darkgreen">bitmask(CC_OVERSIZED, CC_SPECIAL)</code>
|-
| <code style="color:green">refittable_cargo_types</code>
| bit mask of entries into the cargo translation table
| yes
| As of NML 0.3, do not use this. Use cargo_[dis]allow_refit (see below) instead.
|-
| <code style="color:green">cargo_allow_refit</code>
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Yes
| {{ottdp|1.2|no|ottdrev=r23291}} A list of cargo types to allow refitting to, irrespective of cargo classes. Example: <code style="color:darkgreen">[COAL, IORE]</code>
|-
| <code style="color:green">cargo_disallow_refit</code>
| Array of cargo labels from the [[NML:Cargotable|cargotable]]
| Yes
| {{ottdp|1.2|no|ottdrev=r23291}} A list of cargo types to disallow refitting to, irrespective of cargo classes. Example: <code style="color:darkgreen">[MAIL]</code>
|-
| <code style="color:green">loading_speed</code>
| 0 ... 255 (cargo units)
| yes
| Units of cargo loaded per time unit. Default vehicles use 5 for trains and road vehicles, 10 for ships and 20 for aircraft. This amount of cargo is loaded to or unloaded from the vehicle every 40 ticks for trains, every 20 ticks for road vehicles and aircraft and every 10 ticks for ships.
|-
| <code style="color:green">cost_factor</code>
| 0 ... 255
| Set to 0
| multiplier to the base purchase cost
|-
| <code style="color:green">running_cost_factor</code>
| 0 ... 255
| Set to 0
| multiplier to the base running costs
|-
| <code style="color:green">cargo_age_period</code>
| 0 ... 65535
| yes
|
{{ottd|1.2|r22713}} This property specifies after how many ticks cargo is aged. Default value is 185. 74 ticks is equal to 1 day.
|}

===Refittability===

To determine whether your vehicle can be refitted to a certain cargo, OpenTTD uses the following table

{| class="t"
! Cargo matches refittable_cargo_classes
! Cargo matches non_refittable_cargo_classes
! Cargo in cargo_allow_refit
! Cargo in cargo_disallow_refit
! Result
|-
| Yes
| No
| Doesn't matter
| No
| Refittable
|-
| No
| Doesn't matter
| No
| Doesn't matter
| Not refittable
|-
| Doesn't matter
| Doesn't matter
| Yes
| No
| Refittable
|-
| Doesn't matter
| Doesn't matter
| Doesn't matter
| Yes
| Not refittable
|}

For those that prefer boolean logic, the formula is as follows:

refittable = ((cargo classes in refittable_cargo_classes AND NOT cargo classes in non_refittable_cargo_classes) OR cargo in cargo_allow_refit) AND NOT (cargo in cargo_disallow_refit)

In general, you should use refittable_cargo_classes and non_refittable_cargo_classes to decide to which cargos your vehicle is refittable, and only then use cargo_allow_refit and cargo_disallow_refit to allow/disallow specific cargos.

===Engine life cycle===

The life cycle of a vehicle model consists of three phases, as outlined in the following table. When starting a new game, a random amount between 31 months and 17 years is added to the model life as well.

{| class="t"
! phase
! duration
! reliability
|-
| 1
| 7 to 38 months
| increases from 48-73% to 75-100%
|-
| 2
| <code style="color:darkgreen">model_life</code> - 8 years
| stays constant at peak, 75-100%
|-
| 3
| 10 to 20.5 years
| decreases from peak to 25-50%
|}

If <code style="color:darkgreen">model_life</code> is set to <code style="color:darkgreen">VEHICLE_NEVER_EXPIRES</code>, the engine remains in phase 2 forever.

Normally, the vehicle is removed from the purchase menu at the and of phase 3. However if you set the <code style="color:darkgreen">retire_early</code> property, it will be retired this many years before (or after, if the value is negative) the end of phase 2.

==Train properties==

{| class="t"
! property
! value range
! available for articulated vehicle
! comment
|-
| <code style="color:green">sprite_id</code>
| <code style="color:green">SPRITE_ID_NEW_TRAIN</code>
| yes
| Set this property to enable new graphics
|-
| <code style="color:green">speed</code>
| 0 ... 65000 (float, speed units)
| no
| Max speed for engines, speed limit for wagons
|-
| <code style="color:green">misc_flags</code>
| bitmask(TRAIN_FLAG_XXX, ...)
| FLIP should not be set, TILT and MU TO the same value as the 1st part
|
;TRAIN_FLAG_TILT
: enable the tilt bonus (20% speed in curves, if all vehicles in consist have it set)
;TRAIN_FLAG_2CC
:Enable use of the 2nd company colour
;TRAIN_FLAG_MU
:act as multiple unit (used for livery selection only)
;TRAIN_FLAG_FLIP
:Allow vehicle to be flipped (reversed) in depot
;TRAIN_FLAG_AUTOREFIT
:Allow autoreffitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;TRAIN_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
|-
| <code style="color:green">refit_cost</code>
| 0 ... 255
| yes
| in 50% units of the purchase price cost base
|-
| <code style="color:green">callback_flags</code>
| bitmask(VEH_CBF_XXX, ...)
| yes
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| <code style="color:green">track_type</code>
| item from railtypetable
| must be the same as front
| Default railtype table: RAIL, MONO, MGLV. If you install a railtypetable yourself you'll always get the railtype you specified. If you want a vehicle to run on electric rail and you don't have a railtypetable, set <code style="color:green">track_type</code> to RAIL and make sure that you set <code style="color:green">engine_class</code> to <code style="color:green">ENGINE_CLASS_ELECTRIC</code>.
|-
| <code style="color:green">ai_special_flag</code>
| [<code style="color:green">AI_FLAG_PASSENGER</code> <nowiki>|</nowiki> <code style="color:green">AI_FLAG_CARGO</code>]
| no
|
;<code style="color:green">AI_FLAG_PASSENGER</code>
:Tell computer players that it's an engine that should only be used for passenger service.
|-
| <code style="color:green">power</code>
| 0 ... 65000 hp (float, power units)
| Set to 0
|
|-
| <code style="color:green">running_cost_base</code>
| RUNNING_COST_XXX
| Set to RUNNING_COST_NONE
|
;RUNNING_COST_STEAM
;RUNNING_COST_DIESEL
;RUNNING_COST_ELECTRIC
;RUNNING_COST_ROADVEH
;RUNNING_COST_NONE
:no running costs
|-
| <code style="color:green">dual_headed</code>
| [0 <nowiki>|</nowiki> 1]
| Set to 0 for all parts of an articulated vehicle
| 1 = dual_headed, otherwise normal engine
|-
| <code style="color:green">default_cargo_type</code>
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE
| Yes
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).
|-
| <code style="color:green">cargo_capacity</code>
| 0 .. 255
| yes
| By default, passenger capacity is 4x, and mail/goods capacity 2x larger than capacity for other cargoes. The capacity set here is used for the default (i.e. first refittable) cargo. Use the <code style="color:green">cargo_capacity</code> callback to avoid this effect.
|-
| <code style="color:green">weight</code>
| 0 .. 1279 ton (float, mass units)
| Set to 0
|
|-
| <code style="color:green">ai_engine_rank</code>
| 0 ... 255
| no
| TTDPatch only: Higher values make the engine for the TTDPatch AI more attractive
|-
| <code style="color:green">engine_class</code>
| ENGINE_CLASS_XXX
| no
|
Defines which livery colour settings apply to the vehicle. It also sets the corresponding sound effect of the engine, and if visual_effect_and_powered is not set, the visual effect as well.
;ENGINE_CLASS_STEAM
;ENGINE_CLASS_DIESEL
;ENGINE_CLASS_ELECTRIC
;ENGINE_CLASS_MONORAIL
;ENGINE_CLASS_MAGLEV
|-
| <code style="color:green">extra_power_per_wagon</code>
| 0 ... 65000 hp (float, power units)
| Set to 0
| Only wagons with a livery override for this engine will add power
|-
| <code style="color:green">tractive_effort_coefficient</code>
| 0 ... 1 (float)
| Set to 0
| Fraction of the vehicle weight that is available as tractive effort. Tractive effort (in kN) is calculated as (TE coefficient) * 10 * weight (in tons), with 10 being an approximation of the acceleration of gravity (9.81 m/s). A good value for rail tracks is 0.3.
|-
| <code style="color:green">air_drag_coefficient</code>
| 0 ... 1 (float)
| Set to 0
| Coefficient of the relative air drag, in arbitrary units. The default value is approximately (8 / max_speed), with max_speed in km/h, clamped to the range 0.004 .. 0.75.
|-
| <code style="color:green">length</code>
| 1 ... 8
| yes
| Length of the vehicle in arbitrary units. Use a value of 8 (equal to the predefined constant VEHICLE_LENGTH) for a full-length vehicle.
|-
| <code style="color:green">visual_effect_and_powered</code>
| <code style="color:green">visual_effect_and_powered</code> (VISUAL_EFFECT_XXX, offset, <code style="color:green">ENABLE_WAGON_POWER</code> or <code style="color:green">DISABLE_WAGON_POWER</code>)
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect_and_powered</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model_and_powered</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

Set the type of visual effect for the vehicle and its positional offset with respect to the vehicle. An offset of 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.

;VISUAL_EFFECT_DEFAULT
:No effect, unless for the default vehicles
;VISUAL_EFFECT_STEAM
:Steam like from steam engine
;VISUAL_EFFECT_DIESEL
:Steam from internal combustion engine
;VISUAL_EFFECT_ELECTRIC
:Electric sparks
;VISUAL_EFFECT_DISABLE
:No effect
|-
| <code style="color:green">effect_spawn_model_and_powered</code>
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code> or <code style="color:green">EFFECT_SPAWN_MODEL_XXX <nowiki>|</nowiki> ENABLE_WAGON_POWER</code>
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect_and_powered</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model_and_powered</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.
The visual appearance itself is defined by the callback 'create_effect'.

;EFFECT_SPAWN_MODEL_NONE
: Do not spawn any effects.
;EFFECT_SPAWN_MODEL_STEAM
: Gradually less effects when approaching max speed.
;EFFECT_SPAWN_MODEL_DIESEL
: Effect proportional to acceleration, no effect when idling at top speed.
;EFFECT_SPAWN_MODEL_ELECTRIC
: Random effect, gradually less likely when approaching max speed.
|-
| <code style="color:green">extra_weight_per_wagon</code>
| 0 ... 255 ton (float, mass units)
| Set to 0
| Adds extra weight for powered wagons, see <code style="color:green">extra_power_per_wagon</code>
|-
| <code style="color:green">bitmask_vehicle_info</code>
| 8-bit bitmask
| yes
|
Used for obtaining [[#bitmask consist info|<code style="color:green">bitmask_consist_info</code>]]
|}

==Road vehicle properties==

{| class="t"
! property
! value range
! available for articulated vehicle
! comment
|-
| sprite_id
| SPRITE_ID_NEW_ROADVEH
| yes
| Set this property to enable new graphics
|-
| speed
| 0 ... 514km/h (float, speed units)
| no
|
|-
| misc_flags
| bitmask(ROADVEH_FLAG_XXX, ...)
| partly; tram flag must the same
|
;ROADVEH_FLAG_TRAM
:The vehicle requires tram tracks to run on
;ROADVEH_FLAG_2CC
:Enable 2nd company colour
;ROADVEH_FLAG_AUTOREFIT
:Allow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;ROADVEH_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
|-
| refit_cost
| 0 ... 255
| yes
| in 25% units of the purchase price cost base
|-
| callback_flags
| bitmask(VEH_CBF_XXX, ...)
| yes
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| running_cost_base
| RUNNING_COST_XXX
| set to RUNNING_COST_NONE
|
;RUNNING_COST_STEAM
;RUNNING_COST_DIESEL
;RUNNING_COST_ELECTRIC
;RUNNING_COST_ROADVEH
;RUNNING_COST_NONE
:no running costs
|-
| power
| 0 ... 2550hp (float, power units)
| Set to 0
|
|-
| weight
| 0 ... 63.75ton (float, mass units)
| Set to 0
|
|-
| tractive_effort_coefficient
| 0 ... 1 (float)
| Set to 0
| Fraction of the vehicle weight that is available as tractive effort. Tractive effort (in kN) is calculated as (TE coefficient) * 10 * weight (in tons), with 10 being an approximation of the acceleration of gravity (9.81 m/s). Default value is 0.3.
|-
| air_drag_coefficient
| 0 ... 1 (float)
| Set to 0
| Coefficient of the relative air drag, in arbitrary units. The default value is approximately (8 / max_speed), with max_speed in km/h, clamped to the range 0.004 .. 0.75.
|-
| <code style="color:green">default_cargo_type</code>
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE
| Yes
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).
|-
| cargo_capacity
| 0 ... 255
| yes
| By default, passenger capacity is 4x, and mail/goods capacity 2x larger than capacity for other cargoes. The capacity set here is used for the default (i.e. first refittable) cargo. Use the <code style="color:green">cargo_capacity</code> callback to avoid this effect.
|-
| sound_effect
| SOUND_XXX
| no
|
See available [[NML:List of sound effects|sound effects]].
|-
| visual_effect
| visual_effect( VISUAL_EFFECT_XXX, offset)
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

Set the type of visual effect for the vehicle and its positional offset with respect to the vehicle. An offset of 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.

;VISUAL_EFFECT_DEFAULT
:No effect, unless for the default vehicles
;VISUAL_EFFECT_STEAM
:Steam like from steam engine
;VISUAL_EFFECT_DIESEL
:Steam from internal combustion engine
;VISUAL_EFFECT_ELECTRIC
:Electric sparks
;VISUAL_EFFECT_DISABLE
:No effect
|-
| <code style="color:green">effect_spawn_model</code>
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code>
| yes
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.
The visual appearance itself is defined by the callback 'create_effect'.

;EFFECT_SPAWN_MODEL_NONE
: Do not spawn any effects.
;EFFECT_SPAWN_MODEL_STEAM
: Gradually less effects when approaching max speed.
;EFFECT_SPAWN_MODEL_DIESEL
: Effect proportional to acceleration, no effect when idling at top speed.
;EFFECT_SPAWN_MODEL_ELECTRIC
: Random effect, gradually less likely when approaching max speed.
|-
| length
| 1 ... 8
| yes
| Length of the vehicle in arbitrary units. Use a value of 8 (equal to the predefined constant VEHICLE_LENGTH) for a full-length vehicle.
|}

==Ship properties==

{| class="t"
! property
! value range
! comment
|-
| sprite_id
| SPRITE_ID_NEW_SHIP
| Set this property to enable new graphics
|-
| speed
| 0 ... 127 km/h (float, speed units)
|
|-
| misc_flags
| bitmask(SHIP_FLAG_XXX)
| Bitmask with to possible flags, set to 0 to disable all.

;SHIP_FLAG_2CC
:Enable use of the 2nd company colour
;SHIP_FLAG_AUTOREFIT
:llow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;SHIP_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
|-
| refit_cost
| 0 ... 255
| in 1/32 of the default refit cost base
|-
| callback_flags
| bitmask(VEH_CBF_XXX, ...)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| is_refittable
| [0 <nowiki>|</nowiki> 1]
| 0=false, 1=true. Note: if you do not set this property to 1, then refittable_cargo_classes / non_refittable_cargo_classes have no effect.
|-
| <code style="color:green">default_cargo_type</code>
| An identifier from the [[NML:Cargotable|cargo table]], or DEFAULT_CARGO_FIRST_REFITTABLE
| If the vehicle is refittable to at least one cargo, but the chosen default cargo is not available or is set to DEFAULT_CARGO_FIRST_REFITTABLE, then the first refittable cargo is used. The first refittable is chosen according to the order in your [[NML:Cargotable|cargo table]]. If this property is set to a valid cargo but the vehicle cannot refit to any cargo type, then the vehicle will be able to carry only this cargo, but it cannot be refitted (like e.g. the default train wagons).
|-
| cargo_capacity
| 0 ... 255
| For ships (unlike other vehicle types) the capacity set here is not affected by the cargo type.
|-
| sound_effect
| SOUND_XXX
|
See available [[NML:List of sound effects|sound effects]].
|-
| ocean_speed_fraction
| 0 ... 1 (float)
|
{{ottd|1.2|r22639}} fraction of base speed on ocean tiles (default: 1)
|-
| canal_speed_fraction
| 0 ... 1 (float)
|
{{ottd|1.2|r22639}} fraction of base speed on canal tiles (default: 1)
|-
| visual_effect
| visual_effect(VISUAL_EFFECT_XXX, offset)
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

XXX=[DEFAULT <nowiki>|</nowiki> STEAM <nowiki>|</nowiki> DIESEL <nowiki>|</nowiki> ELECTRIC <nowiki>|</nowiki> DISABLE], it is the type of the visual effect you want for this ship. Default means no effect. Offset is the position of the effect. 0 is default, negative values mean more to the front and positive values are backwards. Minimum offset is -8, maximum is 7.
|-
| <code style="color:green">effect_spawn_model</code>
| <code style="color:green">EFFECT_SPAWN_MODEL_XXX</code>
|
There are two methods to set the visual effect of a vehicle:
* <code style="color:green">visual_effect</code>: Easy method for simple effects.
* <code style="color:green">effect_spawn_model</code> + callback <code style="color:green">create_effect</code>: {{ottdp|1.5|no|ottdrev=r26747}} Harder to use, but also more powerful.
For each vehicle you have to decide for the method. You cannot use them both for the same vehicle 'item'.

{{ottdp|1.5|no|ottdrev=r26747}} Set the spawning model of visual effects for the vehicle, that is when the vehicle emits visual effects.
The visual appearance itself is defined by the callback 'create_effect'.

;EFFECT_SPAWN_MODEL_NONE
: Do not spawn any effects.
;EFFECT_SPAWN_MODEL_STEAM
: Gradually less effects when approaching max speed.
;EFFECT_SPAWN_MODEL_DIESEL
: Effect proportional to acceleration, no effect when idling at top speed.
;EFFECT_SPAWN_MODEL_ELECTRIC
: Random effect, gradually less likely when approaching max speed.
|}

==Aircraft properties==

{| class="t"
! property
! value range
! comment
|-
| sprite_id
| SPRITE_ID_NEW_AIRCRAFT
| Set this property to enable new graphics
|-
| speed
| 0 .. 3280 km/h (float, speed units)
|
|-
| range
| 0 .. 2894
| {{nml|0.3}} {{ottdp|1.2|no|ottdrev=r23504}} Maximum (euclidean) distance the aircraft can cover between two airports. Set to 0 for unlimited range.
|-
| misc_flags
| bitmask(AIRCRAFT_FLAG_2CC, AIRCRAFT_FLAG_AUTOREFIT)
| Bitmask with to possible flags, set to 0 to disable all.

;AIRCRAFT_FLAG_2CC
:Enable 2nd company colour
;AIRCRAFT_FLAG_AUTOREFIT
:Allow autorefitting. To enable autorefit, furthermore the [[#Vehicle callbacks|refit_cost]]-callback has to allow it, or else (if this callback is not implemented or fails) the <code style="color:green">refit_cost</code>-property (see below) must be set to 0.
;AIRCRAFT_FLAG_NO_BREAKDOWN_SMOKE
:{{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24124}} Disable breakdown smoke effect
|-
| refit_cost
| 0 ... 255
| in 1/32 of default refit cost base
|-
| callback_flags
| bitmask(VEH_CBF_XXX, ...)
|
Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| aircraft_type
| AIRCRAFT_TYPE_XXX
|
;AIRCRAFT_TYPE_HELICOPTER
:Can land on helipad
;AIRCRAFT_TYPE_SMALL
:Can land on all airports with runway
;AIRCRAFT_TYPE_LARGE
:Can land on all airports with runway. But have a high crash chance on small airports
|-
| acceleration
| {{ottd|1.3.1}} 0 ... 255 {{ottd|<1.3.1}} 0 ... 19
| {{ottd|1.3.1}} Default aircraft use values in the range 18 to 50 (= 6.75 to 18.75 mph/tick = 499.5 to 1387.5 mph/day), which is generally considered quite fast. 
{{ottd|<1.3.1}} In older OpenTTD, aircraft provided by NewGRF accelerate 166% faster than intended.
|-
| passenger_capacity
| 0 ... 65536
| Capacity for the passenger compartment. See also the notes at <code style="color:darkgreen">mail_capacity</code> below.
|-
| mail_capacity
| 0 ... 255
| Capacity for the mail compartment, if refitted to a cargo in the CC_PASSENGERS class. When refitted to other cargoes, this capacity is added to the passenger capacity to determine the base capacity. The actual capacity is set to this base capacity divided by 1 for mail, 2 for goods and 4 for all other cargoes. To override this effect, use the <code style="color:darkgreen">passenger_capacity</code> and <code style="color:darkgreen">mail_capacity</code> callbacks.
|-
| sound_effect
| SOUND_XXX
|
See available [[NML:List of sound effects|sound effects]].
|}

==Vehicle variables==

Below an overview of all vehicle-specific variables. Note that in the purchase list, the vehicle is not built yet and as such many variables are not available. All general variables are available, refer to the table for info on vehicle-specific variables. Trying to access a non-available variable invokes undefined behaviour. Please note that while all variables are available for all vehicles types, some of them only make sense for one or more vehicle types. For example checking current_railtype for a non-rail vehicle doesn't make sense at all.

===Variables without parameter===

{| class="t"
! name
! value range
! available in purchase list?
! comment
|-
| position_in_consist
| 0 ... 255
| No
| The position of the current vehicle-part from the start of the vehicle. The engine will get value 0, the first wagon (or second engine) gets value 1, etc.
|-
| position_in_consist_from_end
| 0 ... 255
| No
| Same as position_in_consist but counted from the end. The last wagon will get value 0.
|-
| num_vehs_in_consist
| 1 ... 256
| No
| The total number of vehicles-parts in this vehicle. For aircraft this will include the shadow and the rotor.
|-
| position_in_vehid_chain
| 0 ... 255
| No
| See position_in_consist, but not of the complete vehicle but only all consecutive parts with the same id.
|-
| position_in_vehid_chain_from_end
| 0 ... 255
| No
| See position_in_consist_from_end, but not of the complete vehicle but only all consecutive parts with the same id.
|-
| num_vehs_in_vehid_chain
| 1 ... 256
| No
| See num_vehs_in_consist, but not of the complete vehicle but only all consecutive parts with the same id.
|-
| position_in_articulated_veh
| 0 ... 255
| No
| {{nml|0.3}} {{ottdp|1.4|no|ottdrev=r26157}} The position of the current articulated vehicle from the start of the vehicle. The first will get value 0, the second one gets value 1, etc.
|-
| position_in_articulated_veh_from_end
| 0 ... 255
| No
| {{nml|0.3}} {{ottdp|1.4|no|ottdrev=r26157}} The position of the current articulated vehicle from the end of the vehicle. The last will get value 0, the second last one gets value 1, etc.
|-
| cargo_classes_in_consist
| Bitmask of CC_XXX
| No
|
[[NML:Cargos#Cargo classes|cargo classes]]
|-
| most_common_refit
|
[[NML:Cargos#Cargo properties|cargo class]]
| No
| cargo class most often refit to
|-
| bitmask_consist_info
| Bitmask 8 bit
| No
|
Binary OR of the values of [[#bitmask vehicle info|bitmask_vehicle_info]] of all vehicles (engines, wagons) in the consist. Only available for rail vehicles.
|-
| company_num
| 0 ... 14
| Yes
| company number of the vehicle owner. TTDPatch only supports up to 8 companies (0 ... 7)
|-
| company_type
| PLAYERTYPE_XX
| Yes
|
;PLAYERTYPE_HUMAN
:human player
;PLAYERTYPE_AI
:AI player
;PLAYERTYPE_HUMAN_IN_AI
:human managing AI company
;PLAYERTYPE_AI_IN_HUMAN
:AI managing human company

OpenTTD only uses PLAYERTYPE_HUMAN and PLAYERTYPE_AI. If you cheat yourself to be part of an AI company OpenTTD will still report PLAYERTYPE_AI for the company with yourself and the AI and it'll report PLAYERTYPE_HUMAN for the now uncontrolled company.
|-
| company_colour1
| COLOUR_XXX
| Yes
|
Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| company_colour2
| COLOUR_XXX
| Yes
|
Same as company_colour1, if no 2nd company colour is chosen. Refer to the table [[NML:List of default colour translation palettes#Company colour helper functions|here]] for possible values.
|-
| aircraft_height
| 0 ... 255
| No
| Height difference between the aircraft and its shadow. 8 Units are equivalent to one height level on the map.
|-
| airport_type
| AIRPORTTYPE_XX
| No
|
;AIRPORTTYPE_SMALL
;AIRPORTTYPE_LARGE
;AIRPORTTYPE_HELIPORT
;AIRPORTTYPE_OILRIG
|-
| curv_info_prev_cur
| -2 ... 2
| No
| Difference in direction between the previous (towards engine) vehicle and this vehicle. Curvature to the right is positive. 1 unit is 45 degrees.
|-
| curv_info_cur_next
| -2 ... 2
| No
| Difference in direction between this vehicle and the next (towards rear end) vehicle. Curvature to the right is positive. 1 unit is 45 degrees.
|-
| curv_info_prev_next
| -4 ... 4
| No
| Difference in direction between the previous (towards engine) and next (towards rear end) vehicle. Curvature to the right is positive. 1 unit is 45 degrees. Equal to <code style="color:darkgreen">curve_invo_prev_cur + curv_info_cur_next</code>.
|-
| curv_info
| vehicle_curv_info(''prev_cur'', ''cur_next'')''''
| No
|
Returns a magic number that represents the curvature state of the prev-cur-next vehicle triplet. Do not try to make sense of this magic number, use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">vehicle_curv_info()</code> instead to make comparisons. <code style="color:darkgreen">curv_info == vehicle_curv_info(a, b)</code> is equivalent to <code style="color:darkgreen">(curv_info_prev_cur == a) && (curv_info_cur_next == b)</code>, however the former can easily be used in a switch-block.
|-
| motion_counter
| 0 ... 15
| Yes, always 0
| Is increased every time the vehicle moves a single step on the map. Useful for animations.
|-
| cargo_type_in_veh
| entry in cargo translation table
| Yes, for the default cargo
| 0xFF if not present in the table
|-
| cargo_unit_weight
| weight per unit in 1/16t
| Yes, for the default cargo
|
|-
| cargo_classes
| Bitmask of [[NML:Cargos#Cargo properties|cargo class]]
| Yes, for the default cargo
| class of the currently transported cargo
|-
| vehicle_is_available
| [0 <nowiki>|</nowiki> 1]
| Yes
| Value is 1 if the vehicle is available on the open market
|-
| vehicle_is_testing
| [0 <nowiki>|</nowiki> 1]
| Yes
| Value is 1 if the vehicle is currently being tested
|-
| vehicle_is_offered
| [0 <nowiki>|</nowiki> 1]
| Yes
| Value is 1 if the vehicle is currently being offered for exclusive preview
|-
| build_year
| 0 ... 5000000
| Yes
| 0-based year when the vehicle was built, current year if the vehicle is not built yet
|-
| direction
| DIRECTION_XX
| No
|
See [[NML:List of direction constants|here]] for an overview of possible values and their meaning.
|-
| cargo_capacity
| 0 ... 65535
| No
| Cargo capacity (number of units) of the vehicle
|-
| cargo_count
| 0 ... 65535
| No
| Number of cargo units of cargo in the vehicle
|-
| cargo_subtype
| 0 ... 255
| Yes, always 0
| Cargo subtype, used to provide more than one refit option for the same cargo type. See also the <code style="color:darkgreen">cargo_subtype_text</code> callback.
|-
| vehicle_is_powered
| [0 <nowiki>|</nowiki> 1]
| No
| Vehicle provides power and is on the correct track type
|-
| vehicle_is_not_powered
| [0 <nowiki>|</nowiki> 1]
| No
| Vehicle is either on a wrong track type or it doesn't provide power at all
|-
| vehicle_is_potentially_powered
| [0 <nowiki>|</nowiki> 1]
| No
| Vehicle provides power, if it is on a suitable track type
|-
| vehicle_is_reversed
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle has reversed an odd number of times
|-
| built_during_preview
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle was built during the exclusive preview stage
|-
| current_railtype
| No
| Entry from railtype translation table or 0xFF
| Don't use this variable 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. Available since OpenTTD r20164.
|-
| waiting_triggers
|
| No
|
Random triggers waiting to be matched. (see [[NML:Random switch|Random switch]])
|-
| random_bits
| 0 ... 255
| No
|
Random data that can be used to randomize certain descisions. (see [[NML:Random switch|Random switch]])
|-
| grfid
| 0 ... 0xFFFFFFFF
| No
|
GRFID that defined the [[NML:Graphics|graphics]]-block for this vehicle. To compare this with other grfids, use the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">str2number()</code> to convert the other GRFID to a number as well.
|-
| vehicle_type_id
| 0 ... 65535 or a name defined in item block
| No
| GRF-local ID of the vehicle, equal to the item ID. Note that vehicles from other NewGRFs may have the same ID, so you'll generally have to check the <code style="color:darkgreen">grfid</code> as well.
|-
| vehicle_is_hidden
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is hidden in a depot or tunnel.
|-
| vehicle_is_stopped
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is stopped, or if it is braking for a stop (trains only).
|-
| vehicle_is_crashed
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle has crashed.
|-
| vehicle_is_broken
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is broken down.
|-
| date_of_last_service
| date(year, month, day)
| No
|
|-
| breakdowns_since_last_service
| 0 ... 255
| No
| Number of breakdowns since the last service
|-
| reliability
| 0 ... 100
| No
| Reliability (percentage)
|-
| age_in_days
| 0 ... 65535
| No
| Vehicle age in days.
|-
| max_age_in_days
| 0 ... 65535
| No
| Maximum vehicle age in days.
|-
| current_speed
| (speed units)
| No
| The current speed of the vehicle in m/s
|-
| max_speed
| (speed units)
| No
| The maximum speed of the vehicle in m/s
|-
| current_max_speed
| (speed units)
| No
| {{nml|0.3}} {{ottdp|1.3|no|ottdrev=r24246}} Current maximum speed of the vehicle in m/s. This includes e.g. track or timetable limits. Only valid for front vehicle.
|-
| vehicle_is_in_depot
| [0 <nowiki>|</nowiki> 1]
| No
| Value is 1 if the vehicle is inside a depot
|-
| vehicle_is_unloading
| [0 <nowiki>|</nowiki> 1]
| No
| {{ottdp|1.5|2.5|ottdrev=r26430}} Value is 1 if the vehicle is unloading at a station and has not yet started loading new cargo.
|}

===Variables that require an argument===

{| class="t"
! name
! Argument
! value range
! available in purchase list?
! comment
|-
| count_veh_id
| The vehicle ID to look for.
| 0..255
| No
| The number of vehicles in the current consist that have the given ID.
|-
| other_veh_curv_info
| Offset in the chain from the current vehicle.<ref name="offset">Argument range is -128..127. Positive values are interpreted as towards the end, negative values as towards the front. If the offset is outside the vehicle chain, the result value will be 0.</ref>
| -4..4
| No
| Difference in direction between the other vehicle and this vehicle. Curvature to the right is positive. 1 unit is 45 degrees.
|-
| other_veh_is_hidden
| Offset in the chain from the current vehicle.<ref name="offset"/>
| [0 <nowiki>|</nowiki> 1]
| No
| 1 the other vehicle is hidden in a depot or tunnel, 0 otherwise
|-
| other_veh_x_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in X-position (top-right to bottom-left) between the other vehicle and this vehicle.
|-
| other_veh_y_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in Y-position (top-left to bottom-right) between the other vehicle and this vehicle.
|-
| other_veh_z_offset
| Offset in the chain from the current vehicle.<ref name="offset"/>
| -128..127
| No
| Signed difference in Z-position (upwards) between the other vehicle and this vehicle.
|}
<references/>

==Vehicle callbacks==
The following table contains a list of available vehicle callbacks. Additionally, it's possible to provide cargo-specific graphics, using the identifier from the [[NML:Cargotable|cargo table]] as callback name. These callbacks will be used if the vehicle is refitted to the corresponding cargo type. If no cargo-specific graphics match the cargo that the vehicle is carrying, the <code style="color:darkgreen">default</code> callback is used instead. Cargo-specific graphics callbacks are never called from the purchase menu, refer to the <code style="color:darkgreen">purchase</code> callback below instead.

Note that the above affects '''graphics only''', other callbacks are unaffected.

{| class="t"
! Name
! Available for
! In purchase menu?
! value range
! comment
|-
| default
| All
| Yes, unless <code style="color:darkgreen">purchase</code> is set separately
| Sprite group
| 'Normal' vehicle graphics, if no cargo-specific graphics apply. See also the section on [[#Sprites in GUI|GUI sprites]].
|-
| purchase
| All
| Yes, only
| Sprite group
| Graphics to show in the buy menu (only the horizontal view is needed, except for dual-headed trains. With the <code>dual_headed</code> property set, special rules for the purchase menu sprite apply: two sprites are drawn (for front and back) as if the vehicle is normally constructed. If you supply one purchase menu sprite, it will be used for both vehicle parts in the purchase menu. Provide a set of 8 sprites, and the 7th resp. 3rd sprite will be drawn; provide a set of 8 blank sprites except the 7th if you want to fully control a single purchase menu sprite for a dual-headed engine. ) See also the section on [[#Sprites in GUI|GUI sprites]].
|-
| rotor
| Aircraft (helicopters)
| No
| Sprite group
| Graphics for the helicopter rotor (4 sprites; 1 stopped and 3 moving)
|-
| random_trigger
| All
| No
| N/A
| See [[NML:Random switch|random switch]] for more information.
|-
| cargo_subtype_text
| All
| No
| String, or CB_RESULT_NO_TEXT
| 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 later for other things. In the HEQS grf for example, this mechanism is used to let the user choose between different capacities of the same vehicle.
|-
| additional_text
| All
| Yes, only
| String
| Additional text to show in the purchase list.
|-
| colour_mapping
| All
| Yes, unless <code style="color:darkgreen">purchase_colour_mapping</code> is set separately
| Recolour sprite number
|
With this callback, you can use a different recolour sprite instead of the standard 1cc / 2cc company colour remappings. See [[NML:List of default colour translation palettes|here]] for a list of default palettes. See the [[NML:Builtin functions|builtin function]] <code style="color:darkgreen">reserve_sprites()</code> for info on how to allocate your own sprite. For performance, the result is cached and only updated if the <code style="color:darkgreen"> every_32_days</code> callback requires so. Add CB_RESULT_COLOUR_MAPPING_ADD_CC to the result to add the company colour to the sprites, this requires 16 (1cc) or 256 (2cc) sprites in total.
|-
| start_stop
| All
| No
| String or CB_RESULT_NO_TEXT
| Called when starting or stopping a vehicle. Mainly useful to prevent vehicles from leaving the depot unless a certain condition is met. Return CB_RESULT_NO_TEXT to allow or a string (containing an error message) to disallow starting/stopping.
|-
| every_32_days
| All
| No
| bitmask(CB_RESULT_32_DAYS_XXX, ...)
| Called every 32 days. Set CB_RESULT_32_DAYS_TRIGGER in the bitmask to trigger TRIGGER_VEHICLE_32_CALLBACK. Set CB_RESULT_32_DAYS_COLOUR_MAPPING in the bitmask to update the colour mapping by re-running the <code style="color:darkgreen">colour_mapping</code> callback.
|-
| sound_effect
| All
| No
| SOUND_XXX, sound("sound.wav"), import_sound(grfid, number) or CB_RESULT_NO_SOUND
|
Called to play various vehicle sounds.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> The sound event, see the [[#Sound events|table]] below.
Return SOUND_XXX (see [[NML:List_of_sound_effects|here]]) to return a default sound. <code style="color:darkgreen">sound("soundfile")</code> imports a sound from a .wav file. <code style="color:darkgreen">import_sound(grfid, number)</code> imports a sound from another grf. A failed (or not implemented) callback will cause the default sound to be played. Return CB_RESULT_NO_SOUND to play no sound at all.
|-
| articulated_part
| Trains, Road Vehicles
| Yes (no separate callback)
| Vehicle ID, or CB_RESULT_NO_MORE_ARTICULATED_PARTS
| With this callback, you can add articulated parts (e.g. tenders) to your vehicle. Called repeatedly, until CB_RESULT_NO_MORE_ARTICULATED_PARTS is returned. After each call, the returned vehicleID is added to your vehicle.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> contains 1 during the first call, 2 during the second, etc.
Note that callback may be called from the purchase list, using vehicle variables is not possible. Or CB_RESULT_REVERSED_VEHICLE to the returned vehicle ID to display the vehicle backwards.

For NML 0.2 and lower the vehicle ID of the articulated part must be in the range 0 .. 127.
|-
| can_attach_wagon
| Trains
| No
| String or CB_RESULT_ATTACH_XXX
| Called when a wagon is being attached, to allow or disallow attaching. If a wagon is inserted in the middle, all wagons are removed and attached one-by-one in the new order. This callback has to be defined at the engine. The scopes behave different than usual though:
* <code style="color:darkgreen">SELF</code> refers to the wagon being attached. (despite the callback being defined at the engine)
* <code style="color:darkgreen">PARENT</code> refers to the consist of the engine up to the wagon before <code style="color:darkgreen">SELF</code>, i.e. not (yet) including the wagon being attached.
Return a string to disallow with the string as error message. Return CB_RESULT_ATTACH_DISALLOW to disallow with standard message ("incompatible railtypes"), CB_RESULT_ATTACH_ALLOW to allow or CB_RESULT_ATTACH_ALLOW_IF_RAILTYPES to allow if the railtypes match (default).
|-
| refit_cost
| {{ottdp|1.2|no|ottdrev=r23089}} All
| Yes
| -8192 .. 8191 as refit cost. Add <code style="color:darkgreen">CB_RESULT_AUTOREFIT</code> if you want to allow autorefit.
| When returning a negative value, encode the cost as (cost & <code style="color:darkgreen">CB_RESULT_REFIT_COST_MASK</code>) before (possibly) adding <code style="color:darkgreen">CB_RESULT_AUTOREFIT</code>. To allow autorefitting, the corresponding bit in the <code style="color:darkgreen">misc_flags</code> must be set as well.
* <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code>: The new cargo type.
* <code style="color:darkgreen">getbits(extra_callback_info1, 8, 8)</code>: The new cargo subtype (see <code style="color:darkgreen">cargo_subtype_text</code>-callback).
* <code style="color:darkgreen">getbits(extra_callback_info1, 16, 16)</code>: A bitmask of the [[NML:Cargos#Cargo_classes|cargo classes]] of the target cargo type.
Note that this callback may also be called when the vehicle does not exist yet, so the available variables are limited.
|-
| create_effect
| {{ottdp|1.5|no|ottdrev=r26747}} Trains, Road Vehicles, Ships
| No
| 0 .. 3 for number of effects. Optionally add <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_CENTER</code> and/or <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>
| Called when a effect spawning model is defined via <code style="color:darkgreen">effect_spawn_model</code> resp. <code style="color:darkgreen">effect_spawn_model_and_powered</code>.

The result specifies how many effects shall be created.
The position and appearance of the individual effects is returned via registers 0x100 to 0x103:
<pre style="color:blue">
switch (FEAT_XXX, SELF, switch_name, [
STORE_TEMP(create_effect(EFFECT_SPRITE_XXX, 8, -3, 10), 0x100), // first effect,
STORE_TEMP(create_effect(EFFECT_SPRITE_YYY, 8, 3, 10), 0x101) // second effect, ...
]) {
return 2; // number of effects
}
</pre>
The register values are created using the <code style="color:darkgreen">create_effect(''effect_sprite'', ''l_x_offset'', ''t_y_offset'', ''z_offset'')</code> function:
* ''effect_sprite'': Sprite for the effect. One of <code style="color:darkgreen">EFFECT_SPRITE_</code>[<code style="color:darkgreen">NONE</code>|<code style="color:darkgreen">STEAM</code>|<code style="color:darkgreen">DIESEL</code>|<code style="color:darkgreen">ELECTRIC</code>|<code style="color:darkgreen">AIRCRAFT_BREAKDOWN_SMOKE</code>].
* ''l_x_offset'': Longitudinal or X position of the effect, depending on callback result <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>.
* ''t_y_offset'': Transversal or Y position of the effect, depending on callback result <code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>.
* ''z_offset'': Z position of the effect.

Additional to the number of effects, the callback result may specify these flags:
;<code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_CENTER</code>
:(Train and road vehicle only) If set, position effect relative to vehicle center instead of relative to vehicle sprite. (behaves the same for vehicles with length 8/8)
;<code style="color:darkgreen">CB_RESULT_CREATE_EFFECT_NO_ROTATION</code>
*If not set, the parameters to <code style="color:darkgreen">effect_sprite</code> describe longitudinal/transversal positions, which are rotate wrt. vehicle orientation.
*If set, the parameters to <code style="color:darkgreen">effect_sprite</code> describe X and Y positions, which are not automatically rotated.
|}

The following callbacks all have an equivalent property. The property description applies here also, except where otherwise noted.

{| class="t"
! Name
! Available for
! In purchase menu?
! comment
|-
| loading_speed
| All
| No
|
|-
| speed
| All
| Yes, unless <code style="color:darkgreen">purchase_speed</code> is set separately
| Units are not (yet) available
|-
| cost_factor
| All
| Yes, only
|
|-
| running_cost_factor
| All
| Yes, unless <code style="color:darkgreen">purchase_running_cost_factor</code> is set separately
|
|-
| cargo_age_period
| All
| No
|
|-
| cargo_capacity
| All except aircraft
| Yes, unless <code style="color:darkgreen">purchase_cargo_capacity</code> is set separately
|
|-
| passenger_capacity
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_passenger_capacity</code> is set separately
|
|-
| mail_capacity
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_mail_capacity</code> is set separately
|
|-
| range
| Aircraft
| Yes, unless <code style="color:darkgreen">purchase_range</code> is set separately
|
|-
| visual_effect_and_powered
| Trains
| No
|
|-
| visual_effect
| Road Vehicles, Ships
| No
|
|-
| effect_spawn_model_and_powered
| Trains
| No
|
|-
| effect_spawn_model
| Road Vehicles, Ships
| No
|
|-
| power
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_power</code> is set separately
| Units are not (yet) available
|-
| weight
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_weight</code> is set separately
| Units are not (yet) available
|-
| length
| Trains, Road vehicles
| No
|
|-
| tractive_effort_coefficient
| Trains, Road Vehicles
| Yes, unless <code style="color:darkgreen">purchase_tractive_effort_coefficient</code> is set separately
| Value range is 0 .. 255 instead of 0 .. 1.
|-
| bitmask_vehicle_info
| Trains
| No
|
|}

===Sprites in GUI===
{{ottdp|1.2|no|ottdrev=r23080}} Since OpenTTD r23080 you can use variable <code style="color:darkgreen">getbits(extra_callback_info1, 0, 8)</code> to display different sprites in the GUI and on the map. Currently these cases are available:
{| |-
! getbits(extra_callback_info1, 0, 8) !! Meaning
|-
| 0x00 || Vehicle is drawn in a viewport, i.e. on the map.
|-
| 0x01..0x0F || reserved
|-
| 0x10 || Vehicle is drawn in the depot GUI. <ref>OpenTTD also uses this value with the purchase-list chain (cargotype FF) to determine the gridsize in ship and aircraft depots.</ref>
|-
| 0x11 || Vehicle is drawn in the vehicle details GUI. (This includes the refit GUI.)
|-
| 0x12 || Vehicle is drawn in the vehicle list.
|-
| 0x13..0x1F || reserved for other future GUIs.
|-
| 0x20 || Vehicle is drawn in the purchase list. (This includes the autoreplace GUI.)
|-
| 0x21 || Vehicle is drawn in the exclusive preview GUI or in the advertisement news.
|-
| 0x22..0x2F || reserved for other future GUIs with non-purchased vehicles.
|-
| 0x30..0xFF || reserved
|}
<references/>
The cases 0x20..0x2F are called using the <code style="color:darkgreen">purchase</code>-callback, the other cases are called for the <code style="color:darkgreen">default</code>- or cargo-specific callbacks. Exception is the the special depot-gridsize call, which uses the <code style="color:darkgreen">purchase</code>-callback.

===Sound events===

{| class="t"
! Event
! Description
|-
| SOUND_EVENT_START
| Vehicle leaves station or depot, plane takes off
|-
| SOUND_EVENT_TUNNEL
| Vehicle enters tunnel
|-
| SOUND_EVENT_BREAKDOWN
| Vehicle breaks down (not for planes)
|-
| SOUND_EVENT_RUNNING
| Once per engine tick, but no more than once per vehicle motion
|-
| SOUND_EVENT_TOUCHDOWN
| Aircraft touches down
|-
| SOUND_EVENT_VISUAL_EFFECT
| Visual effect is generated (steam plume, diesel smoke, electric spark)
|-
| SOUND_EVENT_RUNNING_16
| Every 16 engine ticks if in motion
|-
| SOUND_EVENT_STOPPED
| Every 16 engine ticks if stopped
|-
| SOUND_EVENT_LOAD_UNLOAD
| Consist loads or unloads cargo
|}

== Vehicle IDs ==
Picking an item ID requires keeping two cases in mind: OpenTTD with the engine pool enabled and OpenTTD with engine pool disabled / TTDPatch. The status of the engine pool may be checked with the global variable [[NML:General#General_variables|dynamic_engines]].

=== Engine pool enabled ===
With the engine pool enabled, each NewGRF has its own ID range, NewGRFs don't influence each other. IDs may freely be chosen between 0 and 65535. If the chosen ID belongs to an existing vehicle, this vehicle is overridden by your vehicle. If another NewGRF is already overriding that vehicle, a new vehicle will be allocated, but all the properties will be copied from the old vehicle. If you define an ID for which no original vehicle exists, a new (blank) vehicle is allocated.

This behaviour can be modified using an [[NML:Overriding_vehicles_in_other_NewGRFs|engine_override]], this allows changing the properties of vehicles defined in other NewGRFs instead of allocating a new vehicle.

=== TTDPatch / Engine pool disabled ===
Each new vehicle has to replace an existing vehicle. If multiple NewGRFs try to replace the same vehicle, the last NewGRF loaded 'wins'. [[VehicleIDs|This page]] contains a list of valid vehicle IDs for each vehicle type, look in the 'NML ID' column. Note that IDs are not bound to a specific sort of vehicle (e.g. monorail wagons) but to a feature (e.g. trains, road vehicles).

In general, you should take the following steps:
* If your NewGRF is intended as a complete replacement for the default vehicles, disable the relevant default vehicles using [[NML:Disable_items|disable_item]].
* Re-use IDs of existing vehicles as much as possible.
* If your NewGRF uses IDs outside of the normal range (for example, because you there are more vehicles than slots available), let your code check if dynamic_engies is enabled. If not, skip the vehicles outside the normal range (using an if-statement) and make sure that the remaining vehicles allow for reasonable gameplay. It is recommended to issue a warning to the user about this. Alternatively, it is also possible to disable your entire NewGRF. If you don't do this check and dynamic_engines is off, OpenTTD may disable your NewGRF with the somewhat cryptic message 'Attempt to use invalid ID', which will likely lead to bug reports about your NewGRF and/or your OpenTTD.

NML:Airports

2015-07-03T22:43:53Z

Supercheese: Add animation_info documentation (copied from IndustryTiles)

{{NMLNavPropVarCB}}

Airports and airport tiles can only be defined in OpenTTD {{ottd|1.1|r19459}} or later.

==Airport (tile) IDs==
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).

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.

==Airport properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{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.'''
|-
| layouts
| list of layouts
|
{{ottd|1.1|r20377}}
|-
| name
| string
|
{{ottd|1.1|r19459}} Name of the airport
|-
| years_available
| [start year, last year]
|
{{ottd|1.1|r19459}} List of the availablility years: first and last year it can be built
|-
| ttd_airport-type
| 0 ... 3
|
{{ottd|1.1|r19459}} Substitute TTDPatch airport type
|-
| catchment_area
|
|
{{ottd|1.1|r19459}} Catchment area of the airport in tiles around its perimeter
|-
| noise_level
|
|
{{ottd|1.1|r19459}} Noise generation of this airport
|-
| maintenance_cost
|
|
{{ottd|1.2|r23415}} Maintenance cost factor for this airport
|}

==Airport tile properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{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.'''
|-
| substitute
|
|
{{ottd|1.1|r19204}} The id of airport tile to replace
|-
| callback_flags
| bitmask
|
{{ottd|1.1|r19204}} Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| animation_info
| Array [ANIMATION_XXX, frame-count]
|{{ottd|1.1|r19204}} XXX = [LOOPING <nowiki>|</nowiki> NON_LOOPING], 1..253 frames
|-
| animation_speed
|
|
{{ottd|1.1|r19204}} See [[NML:Animation speed|speed settings]]
|-
| animation_triggers
| bitmask(ANIM_TRIGGER_APT_XXX, ... )
|
{{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.
|}

==Airport variables==

A number of variables are shared between airports and stations. These are listed on the [[NML:Stations#Base station variables|stations]] page.

{| class="t"
! name
! value range
! comment
|-
| layout
| 0 .. (number of layouts - 1)
|
{{ottd|1.1|r20364}} Layout number of the airport (index in the layouts array)
|}

==Airport tile variables==

{| class="t"
! name
! value range
! comment
|-
| terrain_type
|
|
|-
| town_radius_group
|
|
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| animation_frame
|
|
|}

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.

{| class="t"
! name
! value range
! comment
|-
| nearby_tile_slope
| SLOPE_XXX
|
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| nearby_tile_is_same_airport
| 1 if the tile is part of the same airport, 0 otherwise
|
|-
| nearby_tile_is_water
| 1 if the tile is water, 0 otherwise
|
|-
| nearby_tile_terrain_type
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| nearby_tile_water_class
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| 0..120
| The height of the lowest corner of the given tile.
|-
| nearby_tile_class
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| 0..255
| Animation frame of the given tile
|-
| nearby_tile_airporttile_id
| 0x00aa, 0xFFbb, 0xFFFE or 0xFFFF
| 0x00aa: The tile is an airport tile that is part of this GRF, the tile id is aa. 0xFFbb: The tile is an original airport tile with id bb. 0xFFFE: The tile is an airport tile defined in another GRF. 0xFFFF: The tile is not an airport tile or it belongs to another GRF.
|}

==Airport callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite set (with 1 sprite)
| 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.
|-
| additional_text
| String
| Additional text to show in the buy menu. String may differ per layout, use the <code style="color:darkgreen">layout</code> variable for this.
|-
| layout_name
| String
| Name of the airport layout in the variable <code style="color:darkgreen">layout</code>
|}

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.

==Airport tile callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Graphics for an airport tile
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
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.
* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits.
* <code style="color:darkgreen">get_bits(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.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| foundations
| CB_RESULT[_NO]_FOUNDATIONS
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.
|}

===Animation triggers===

{| class="t"
! Animation trigger
! Description
|-
| ANIM_TRIGGER_APT_BUILT
| Airport is built (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_TILELOOP
| Airport tile is processed in the tileloop (at different times for different tiles)
|-
| ANIM_TRIGGER_APT_NEW_CARGO
| New cargo arrives at the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_CARGO_TAKEN
| All cargo of a cargo type is removed from the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_250_TICKS
| Every 250 ticks (all tiles at the same time)
|}

NML:Airports

2015-04-09T22:03:57Z

Supercheese: Forgot italics

{{NMLNavPropVarCB}}

Airports and airport tiles can only be defined in OpenTTD {{ottd|1.1|r19459}} or later.

==Airport (tile) IDs==
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).

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.

==Airport properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{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.
|-
| layouts
| list of layouts
|
{{ottd|1.1|r20377}}
|-
| name
| string
|
{{ottd|1.1|r19459}} Name of the airport
|-
| years_available
| [start year, last year]
|
{{ottd|1.1|r19459}} List of the availablility years: first and last year it can be built
|-
| ttd_airport-type
| 0 ... 3
|
{{ottd|1.1|r19459}} Substitute TTDPatch airport type
|-
| catchment_area
|
|
{{ottd|1.1|r19459}} Catchment area of the airport in tiles around its perimeter
|-
| noise_level
|
|
{{ottd|1.1|r19459}} Noise generation of this airport
|-
| maintenance_cost
|
|
{{ottd|1.2|r23415}} Maintenance cost factor for this airport
|}

==Airport tile properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{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.
|-
| substitute
|
|
{{ottd|1.1|r19204}} The id of airport tile to replace
|-
| callback_flags
| bitmask
|
{{ottd|1.1|r19204}} Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| animation_info
|
|
{{ottd|1.1|r19204}}
|-
| animation_speed
|
|
{{ottd|1.1|r19204}} See [[NML:Animation speed|speed settings]]
|-
| animation_triggers
| bitmask(ANIM_TRIGGER_APT_XXX, ... )
|
{{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.
|}

==Airport variables==

A number of variables are shared between airports and stations. These are listed on the [[NML:Stations#Base station variables|stations]] page.

{| class="t"
! name
! value range
! comment
|-
| layout
| 0 .. (number of layouts - 1)
|
{{ottd|1.1|r20364}} Layout number of the airport (index in the layouts array)
|}

==Airport tile variables==

{| class="t"
! name
! value range
! comment
|-
| terrain_type
|
|
|-
| town_radius_group
|
|
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| animation_frame
|
|
|}

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.

{| class="t"
! name
! value range
! comment
|-
| nearby_tile_slope
| SLOPE_XXX
|
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| nearby_tile_is_same_airport
| 1 if the tile is part of the same airport, 0 otherwise
|
|-
| nearby_tile_is_water
| 1 if the tile is water, 0 otherwise
|
|-
| nearby_tile_terrain_type
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| nearby_tile_water_class
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| 0..120
| The height of the lowest corner of the given tile.
|-
| nearby_tile_class
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| 0..255
| Animation frame of the given tile
|-
| nearby_tile_airporttile_id
| 0x00aa, 0xFFbb, 0xFFFE or 0xFFFF
| 0x00aa: The tile is an airport tile that is part of this GRF, the tile id is aa. 0xFFbb: The tile is an original airport tile with id bb. 0xFFFE: The tile is an airport tile defined in another GRF. 0xFFFF: The tile is not an airport tile or it belongs to another GRF.
|}

==Airport callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite set (with 1 sprite)
| 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.
|-
| additional_text
| String
| Additional text to show in the buy menu. String may differ per layout, use the <code style="color:darkgreen">layout</code> variable for this.
|-
| layout_name
| String
| Name of the airport layout in the variable <code style="color:darkgreen">layout</code>
|}

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.

==Airport tile callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Graphics for an airport tile
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. <code style="color:darkgreen">extra_callback_info1</code> contains random bits. Returning a sound effect in the high byte will cause that sound effect to be played.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
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. <code style="color:darkgreen">extra_callback_info1</code> contains random bits. Returning a sound effect in the high byte will cause that sound effect to be played. <code style="color:darkgreen">extra_callback_info2</code> contains the reason to trigger the animation, 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.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| foundations
| CB_RESULT[_NO]_FOUNDATIONS
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.
|}

===Animation triggers===

{| class="t"
! Animation trigger
! Description
|-
| ANIM_TRIGGER_APT_BUILT
| Airport is built (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_TILELOOP
| Airport tile is processed in the tileloop (at different times for different tiles)
|-
| ANIM_TRIGGER_APT_NEW_CARGO
| New cargo arrives at the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_CARGO_TAKEN
| All cargo of a cargo type is removed from the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_250_TICKS
| Every 250 ticks (all tiles at the same time)
|}

NML:Airports

2015-04-09T22:03:33Z

Supercheese: ...and also for airport tile overrides.

{{NMLNavPropVarCB}}

Airports and airport tiles can only be defined in OpenTTD {{ottd|1.1|r19459}} or later.

==Airport (tile) IDs==
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).

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.

==Airport properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{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.
|-
| layouts
| list of layouts
|
{{ottd|1.1|r20377}}
|-
| name
| string
|
{{ottd|1.1|r19459}} Name of the airport
|-
| years_available
| [start year, last year]
|
{{ottd|1.1|r19459}} List of the availablility years: first and last year it can be built
|-
| ttd_airport-type
| 0 ... 3
|
{{ottd|1.1|r19459}} Substitute TTDPatch airport type
|-
| catchment_area
|
|
{{ottd|1.1|r19459}} Catchment area of the airport in tiles around its perimeter
|-
| noise_level
|
|
{{ottd|1.1|r19459}} Noise generation of this airport
|-
| maintenance_cost
|
|
{{ottd|1.2|r23415}} Maintenance cost factor for this airport
|}

==Airport tile properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{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.
|-
| substitute
|
|
{{ottd|1.1|r19204}} The id of airport tile to replace
|-
| callback_flags
| bitmask
|
{{ottd|1.1|r19204}} Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| animation_info
|
|
{{ottd|1.1|r19204}}
|-
| animation_speed
|
|
{{ottd|1.1|r19204}} See [[NML:Animation speed|speed settings]]
|-
| animation_triggers
| bitmask(ANIM_TRIGGER_APT_XXX, ... )
|
{{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.
|}

==Airport variables==

A number of variables are shared between airports and stations. These are listed on the [[NML:Stations#Base station variables|stations]] page.

{| class="t"
! name
! value range
! comment
|-
| layout
| 0 .. (number of layouts - 1)
|
{{ottd|1.1|r20364}} Layout number of the airport (index in the layouts array)
|}

==Airport tile variables==

{| class="t"
! name
! value range
! comment
|-
| terrain_type
|
|
|-
| town_radius_group
|
|
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| animation_frame
|
|
|}

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.

{| class="t"
! name
! value range
! comment
|-
| nearby_tile_slope
| SLOPE_XXX
|
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| nearby_tile_is_same_airport
| 1 if the tile is part of the same airport, 0 otherwise
|
|-
| nearby_tile_is_water
| 1 if the tile is water, 0 otherwise
|
|-
| nearby_tile_terrain_type
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| nearby_tile_water_class
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| 0..120
| The height of the lowest corner of the given tile.
|-
| nearby_tile_class
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| 0..255
| Animation frame of the given tile
|-
| nearby_tile_airporttile_id
| 0x00aa, 0xFFbb, 0xFFFE or 0xFFFF
| 0x00aa: The tile is an airport tile that is part of this GRF, the tile id is aa. 0xFFbb: The tile is an original airport tile with id bb. 0xFFFE: The tile is an airport tile defined in another GRF. 0xFFFF: The tile is not an airport tile or it belongs to another GRF.
|}

==Airport callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite set (with 1 sprite)
| 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.
|-
| additional_text
| String
| Additional text to show in the buy menu. String may differ per layout, use the <code style="color:darkgreen">layout</code> variable for this.
|-
| layout_name
| String
| Name of the airport layout in the variable <code style="color:darkgreen">layout</code>
|}

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.

==Airport tile callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Graphics for an airport tile
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. <code style="color:darkgreen">extra_callback_info1</code> contains random bits. Returning a sound effect in the high byte will cause that sound effect to be played.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
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. <code style="color:darkgreen">extra_callback_info1</code> contains random bits. Returning a sound effect in the high byte will cause that sound effect to be played. <code style="color:darkgreen">extra_callback_info2</code> contains the reason to trigger the animation, 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.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| foundations
| CB_RESULT[_NO]_FOUNDATIONS
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.
|}

===Animation triggers===

{| class="t"
! Animation trigger
! Description
|-
| ANIM_TRIGGER_APT_BUILT
| Airport is built (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_TILELOOP
| Airport tile is processed in the tileloop (at different times for different tiles)
|-
| ANIM_TRIGGER_APT_NEW_CARGO
| New cargo arrives at the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_CARGO_TAKEN
| All cargo of a cargo type is removed from the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_250_TICKS
| Every 250 ticks (all tiles at the same time)
|}

NML:Airports

2015-04-09T22:02:59Z

Supercheese: Add same info about the override property as industries/houses/etc.

{{NMLNavPropVarCB}}

Airports and airport tiles can only be defined in OpenTTD {{ottd|1.1|r19459}} or later.

==Airport (tile) IDs==
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).

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.

==Airport properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{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.
|-
| layouts
| list of layouts
|
{{ottd|1.1|r20377}}
|-
| name
| string
|
{{ottd|1.1|r19459}} Name of the airport
|-
| years_available
| [start year, last year]
|
{{ottd|1.1|r19459}} List of the availablility years: first and last year it can be built
|-
| ttd_airport-type
| 0 ... 3
|
{{ottd|1.1|r19459}} Substitute TTDPatch airport type
|-
| catchment_area
|
|
{{ottd|1.1|r19459}} Catchment area of the airport in tiles around its perimeter
|-
| noise_level
|
|
{{ottd|1.1|r19459}} Noise generation of this airport
|-
| maintenance_cost
|
|
{{ottd|1.2|r23415}} Maintenance cost factor for this airport
|}

==Airport tile properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{ottd|1.1|r19204}} The id of airport tile to override, see [[AirportTypes]].
|-
| substitute
|
|
{{ottd|1.1|r19204}} The id of airport tile to replace
|-
| callback_flags
| bitmask
|
{{ottd|1.1|r19204}} Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| animation_info
|
|
{{ottd|1.1|r19204}}
|-
| animation_speed
|
|
{{ottd|1.1|r19204}} See [[NML:Animation speed|speed settings]]
|-
| animation_triggers
| bitmask(ANIM_TRIGGER_APT_XXX, ... )
|
{{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.
|}

==Airport variables==

A number of variables are shared between airports and stations. These are listed on the [[NML:Stations#Base station variables|stations]] page.

{| class="t"
! name
! value range
! comment
|-
| layout
| 0 .. (number of layouts - 1)
|
{{ottd|1.1|r20364}} Layout number of the airport (index in the layouts array)
|}

==Airport tile variables==

{| class="t"
! name
! value range
! comment
|-
| terrain_type
|
|
|-
| town_radius_group
|
|
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| animation_frame
|
|
|}

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.

{| class="t"
! name
! value range
! comment
|-
| nearby_tile_slope
| SLOPE_XXX
|
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| nearby_tile_is_same_airport
| 1 if the tile is part of the same airport, 0 otherwise
|
|-
| nearby_tile_is_water
| 1 if the tile is water, 0 otherwise
|
|-
| nearby_tile_terrain_type
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| nearby_tile_water_class
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| 0..120
| The height of the lowest corner of the given tile.
|-
| nearby_tile_class
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| 0..255
| Animation frame of the given tile
|-
| nearby_tile_airporttile_id
| 0x00aa, 0xFFbb, 0xFFFE or 0xFFFF
| 0x00aa: The tile is an airport tile that is part of this GRF, the tile id is aa. 0xFFbb: The tile is an original airport tile with id bb. 0xFFFE: The tile is an airport tile defined in another GRF. 0xFFFF: The tile is not an airport tile or it belongs to another GRF.
|}

==Airport callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite set (with 1 sprite)
| 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.
|-
| additional_text
| String
| Additional text to show in the buy menu. String may differ per layout, use the <code style="color:darkgreen">layout</code> variable for this.
|-
| layout_name
| String
| Name of the airport layout in the variable <code style="color:darkgreen">layout</code>
|}

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.

==Airport tile callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Graphics for an airport tile
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. <code style="color:darkgreen">extra_callback_info1</code> contains random bits. Returning a sound effect in the high byte will cause that sound effect to be played.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
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. <code style="color:darkgreen">extra_callback_info1</code> contains random bits. Returning a sound effect in the high byte will cause that sound effect to be played. <code style="color:darkgreen">extra_callback_info2</code> contains the reason to trigger the animation, 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.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| foundations
| CB_RESULT[_NO]_FOUNDATIONS
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.
|}

===Animation triggers===

{| class="t"
! Animation trigger
! Description
|-
| ANIM_TRIGGER_APT_BUILT
| Airport is built (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_TILELOOP
| Airport tile is processed in the tileloop (at different times for different tiles)
|-
| ANIM_TRIGGER_APT_NEW_CARGO
| New cargo arrives at the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_CARGO_TAKEN
| All cargo of a cargo type is removed from the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_250_TICKS
| Every 250 ticks (all tiles at the same time)
|}

NML:Airports

2015-04-09T21:58:11Z

Supercheese: Move override to the top of the table, since it is what should be set first

{{NMLNavPropVarCB}}

Airports and airport tiles can only be defined in OpenTTD {{ottd|1.1|r19459}} or later.

==Airport (tile) IDs==
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).

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.

==Airport properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{ottd|1.1|r19459}} The id of airport to replace / override, see [[AirportTypes]].
|-
| layouts
| list of layouts
|
{{ottd|1.1|r20377}}
|-
| name
| string
|
{{ottd|1.1|r19459}} Name of the airport
|-
| years_available
| [start year, last year]
|
{{ottd|1.1|r19459}} List of the availablility years: first and last year it can be built
|-
| ttd_airport-type
| 0 ... 3
|
{{ottd|1.1|r19459}} Substitute TTDPatch airport type
|-
| catchment_area
|
|
{{ottd|1.1|r19459}} Catchment area of the airport in tiles around its perimeter
|-
| noise_level
|
|
{{ottd|1.1|r19459}} Noise generation of this airport
|-
| maintenance_cost
|
|
{{ottd|1.2|r23415}} Maintenance cost factor for this airport
|}

==Airport tile properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{ottd|1.1|r19204}} The id of airport tile to override, see [[AirportTypes]].
|-
| substitute
|
|
{{ottd|1.1|r19204}} The id of airport tile to replace
|-
| callback_flags
| bitmask
|
{{ottd|1.1|r19204}} Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| animation_info
|
|
{{ottd|1.1|r19204}}
|-
| animation_speed
|
|
{{ottd|1.1|r19204}} See [[NML:Animation speed|speed settings]]
|-
| animation_triggers
| bitmask(ANIM_TRIGGER_APT_XXX, ... )
|
{{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.
|}

==Airport variables==

A number of variables are shared between airports and stations. These are listed on the [[NML:Stations#Base station variables|stations]] page.

{| class="t"
! name
! value range
! comment
|-
| layout
| 0 .. (number of layouts - 1)
|
{{ottd|1.1|r20364}} Layout number of the airport (index in the layouts array)
|}

==Airport tile variables==

{| class="t"
! name
! value range
! comment
|-
| terrain_type
|
|
|-
| town_radius_group
|
|
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| animation_frame
|
|
|}

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.

{| class="t"
! name
! value range
! comment
|-
| nearby_tile_slope
| SLOPE_XXX
|
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| nearby_tile_is_same_airport
| 1 if the tile is part of the same airport, 0 otherwise
|
|-
| nearby_tile_is_water
| 1 if the tile is water, 0 otherwise
|
|-
| nearby_tile_terrain_type
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| nearby_tile_water_class
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| 0..120
| The height of the lowest corner of the given tile.
|-
| nearby_tile_class
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| 0..255
| Animation frame of the given tile
|-
| nearby_tile_airporttile_id
| 0x00aa, 0xFFbb, 0xFFFE or 0xFFFF
| 0x00aa: The tile is an airport tile that is part of this GRF, the tile id is aa. 0xFFbb: The tile is an original airport tile with id bb. 0xFFFE: The tile is an airport tile defined in another GRF. 0xFFFF: The tile is not an airport tile or it belongs to another GRF.
|}

==Airport callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite set (with 1 sprite)
| 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.
|-
| additional_text
| String
| Additional text to show in the buy menu. String may differ per layout, use the <code style="color:darkgreen">layout</code> variable for this.
|-
| layout_name
| String
| Name of the airport layout in the variable <code style="color:darkgreen">layout</code>
|}

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.

==Airport tile callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Graphics for an airport tile
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. <code style="color:darkgreen">extra_callback_info1</code> contains random bits. Returning a sound effect in the high byte will cause that sound effect to be played.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
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. <code style="color:darkgreen">extra_callback_info1</code> contains random bits. Returning a sound effect in the high byte will cause that sound effect to be played. <code style="color:darkgreen">extra_callback_info2</code> contains the reason to trigger the animation, 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.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| foundations
| CB_RESULT[_NO]_FOUNDATIONS
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.
|}

===Animation triggers===

{| class="t"
! Animation trigger
! Description
|-
| ANIM_TRIGGER_APT_BUILT
| Airport is built (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_TILELOOP
| Airport tile is processed in the tileloop (at different times for different tiles)
|-
| ANIM_TRIGGER_APT_NEW_CARGO
| New cargo arrives at the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_CARGO_TAKEN
| All cargo of a cargo type is removed from the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_250_TICKS
| Every 250 ticks (all tiles at the same time)
|}

NML:Objects

2015-04-06T01:56:08Z

Supercheese: Add notice about flooding and objects that can be built on both land and water; standardize punctuation.

{{NMLNavPropVarCB}}

==Object IDs==
Object IDs are NewGRF-local and can therefore freely be chosen in the 0..255 range. An object is allocated by setting the 'class'-property, which should therefore be set first. Overriding the default objects (e.g. transmitter, lighthouse) is not (yet) possible.

==Object properties==

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

===Default object classes===

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

===List of object flags===

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

==Object variables==

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

Variables that require one or more parameters:

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

==Object callbacks==

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

<references/>

{{NML:LocationCheckResults}}

===Animation triggers===

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

NML:Language files

2014-10-12T00:00:19Z

Supercheese: /* LanguageIDs */ Add Latin

{{NMLNavNoSubpages}}
== Introduction ==
Language files are usually found in the <code style="color:darkgreen">lang</code> sub-folder of the project, but the place NML looks for the language files can be changed via command line parameter to any directory desired:

nmlc -l path/to/lang-dir path/to/nml-source-file.nml
nmlc --lang-dir=path/to/lang-dir path/to/nml-source-file.nml

Language files MUST have the extension <code style="color:darkgreen">.lng</code> The language files themselves follow a certain structure:

##grflangid <number>
<string-name> :<text>
<string-name> :<text>
...

where the first line must give the language code for the language this file describes (see below). The following lines each describe a string. The translated string follows immediately the colon. An NML project has exactly one fallback language, by default this is english.lng. You can change this with the command line parameter --default-lang. Example for a valid language file:

<pre class=example>
##grflangid 0x01
STR_GRF_NAME :{TITLE} 0.1.0 - {VERSION}
STR_GRF_DESCRIPTION :{TITLE} contains pimped ground tiles.
STR_NAME_MYVEHICLE :General Robotics Anti-Grav UFO Mark X
</pre>

== String codes ==

Strings may contain a number of special string codes which control how the string is being printed or which values to insert into the string. Custom replacements can be stored in the plain text file <code>custom_tags.txt</code> (for example a newgrf version which is written by your build script). In the case above the <code>custom_tags.txt</code> could, for example read

<pre class=example>
VERSION :alpha-r88
TITLE :Example NewGRF
</pre>

Additionally to custom-defined tags, NML comes with a number of default tags:
{|
!width="150pt"|Tag
!width="600pt"|Meaning
!Example
|-
| ||empty tag, written as {} is used to create a newline
|-
|NBSP || non-breaking space
|-
|{ || Display a left curly bracket. You write this as {{}. If you'd include it without surrounding it by { and } it'd be seen as the start of a tag and the rest of the string would be read as name of the tag.
|-
|COPYRIGHT || copyright symbol || ©
|-
|TRAIN || display train symbol
|-
|LORRY || display lorry symbol
|-
|BUS || display bus symbol
|-
|PLANE || display plane symbol
|-
|SHIP || display ship symbol
|-
|TINYFONT || switch to small font
|-
|BIGFONT || switch to big font
|-
|BLUE || switch to blue text
|-
|SILVER || switch to silver text
|-
|GOLD || switch to golden text
|-
|RED || switch to red text
|-
|PURPLE || switch to purple text
|-
|LTBROWN || switch to light brown text
|-
|ORANGE || switch to orange text
|-
|GREEN || switch to green text
|-
|YELLOW || switch to yellow text
|-
|DKGREEN || switch to dark green text
|-
|CREAM || switch to cream-coloured text
|-
|BROWN || switch to brown text
|-
|WHITE || switch to white text
|-
|LTBLUE || switch to light blue text
|-
|GRAY || switch to gray text
|-
|DKBLUE || switch to dark blue text
|-
|BLACK || switch to black text
|}
== String parameters ==
The above tags can be used in almost all strings. There are also a number of tags that need an argument they'll read from the textstack. The textstack is only available for certain callbacks an properties.
{|
!width="150pt"|Tag
!width="600pt"|Meaning
!Size (number of bytes read from stack)
!Example
|-
|COMMA || signed number with decimal separator between 1000's. || 4
|-
|SIGNED_WORD || signed number with decimal separator between 1000's. || 2
|-
|UNSIGNED_WORD || unsigned number with decimal separator between 1000's. || 2
|-
|CURRENCY || money in proper currency units || 4 || 24,492 €
|-
|VELOCITY || velocity in proper units || 2 || 35 km/h
|-
|VOLUME || volume in proper units || 2 || 29,000 litres
|-
|VOLUME_SHORT || volume in proper units in short form || 2 || 29,000l
|-
|POWER || power in proper units || 2 || 2,030 kW
|-
|WEIGHT || weight in proper units || 2 || 5 tonnes
|-
|WEIGHT_SHORT || weight in proper units in short form || 2 || 5t
|-
|CARGO_LONG || {{ottdp|1.4|no|ottdrev=r26244}} cargo amount in proper units || 4 (2 + 2)<ref name="cargoamount">First (lower) 2 bytes for cargo type, second (higher) 2 bytes for cargo amount.</ref> || 10 bags of mail
|-
|CARGO_SHORT || {{ottdp|1.4|no|ottdrev=r26244}} cargo amount in proper units in short form || 4 (2 + 2)<ref name="cargoamount"/> || 10 bags
|-
|CARGO_TINY || {{ottdp|1.4|no|ottdrev=r26244}} cargo amount in proper units in tiny form (only unit conversion) || 4 (2 + 2)<ref name="cargoamount"/> || 10
|-
|HEX || hexadecimal presentation || 4 || F0 3D D4 33
|-
|STRING || include other string || 2
|-
|DATE1920_LONG || days since 1920 as long date || 2 || 12 August 1935
|-
|DATE1920_SHORT|| days since 1920 as short date || 2 || 12 Aug 1935
|-
|DATE_LONG || days since 0 as long date || 4 || 12 August 1610
|-
|DATE_SHORT || days since 0 as short date || 4 || 12 Aug 3049
|-
|POP_WORD || Remove 2 bytes from the top of the stack || 2
|-
|STATION || Station name of station with given ID || 2
|}
<references/>

In case you don't want to use the first 2 (or 4) bytes from the stack but rather another variable, you can prefix the tag name with the number, like {1:COMMA} to use the second (indexing starts at 0) argument from the stack. You can also use this in translations that require a different order, for example (in english.lng):

STR_SOME_STRING :{COMMA} items cost {CURRENCY}

And the same string in dutch.lng:

STR_SOME_STRING :{1:CURRENCY} is de prijs van {0:COMMA} items.

The string parameters itself are assigned in units of dwords (4 bytes), starting with temporary storage 256, up to 259 or 261. Thus if you use parameters which are not of dword size (e.g. strings or word-sized numbers), you have to construct the text stack via bit arithmetic:
<pre class=example>
switch(FEAT_INDUSTRIES, SELF, extra_text_switch, [
STORE_TEMP(
( (LOAD_PERM(var_supply_efficiency_factor) == 1) * string(STR_EXTRA_PRIMARY_EFFICIENT1) ) +
( (LOAD_PERM(var_supply_efficiency_factor) == 2) * string(STR_EXTRA_PRIMARY_EFFICIENT2) ) +
( (LOAD_PERM(var_supply_efficiency_factor) == 3) * string(STR_EXTRA_PRIMARY_EFFICIENT3) ) +
( (LOAD_PERM(var_supply_efficiency_factor) == 4) * string(STR_EXTRA_PRIMARY_EFFICIENT4) ) |
LOAD_PERM(var_supply_requirement) << 16,
256
),
return string(STR_EXTRA_PRIMARY);
}
</pre>

for a language file which reads
<pre class=example>
STR_EXTRA_PRIMARY_EFFICIENT1 :{YELLOW}very efficient{BLACK}ly
STR_EXTRA_PRIMARY_EFFICIENT2 :{YELLOW}efficient{BLACK}ly
STR_EXTRA_PRIMARY_EFFICIENT3 :in a {YELLOW}normal{BLACK} way
STR_EXTRA_PRIMARY_EFFICIENT4 :{YELLOW}wasteful{BLACK}ly
STR_EXTRA_PRIMARY :{BLACK}This industry needs {YELLOW}supplies{BLACK}.{}They use them {STRING}{}{}Monthly demand: {YELLOW}{UNSIGNED_WORD} crate{P "" s} of engineering supplies{BLACK}.
</pre>

== Defining cases ==
Similar to OpenTTD's language files, NML can also make use of cases, genders and plural forms. In order to utilize them, they have to be defined in the language file's header and have to match the definition as used in OpenTTD's language files:
<pre>
##case pragma

STR_NAME :Utas
STR_NAME.pragma :utast
</pre>

e.g. for Hungarian you'd have
<pre class=example>
##case t ba

STR_CARGO_PLURAL_PASSENGERS :Utas
STR_CARGO_PLURAL_PASSENGERS.t :utast
</pre>

In case the name of a case changes in the OpenTTD language file, your language file will have to follow that change. To keep compatible with older OpenTTD versions you can use the ##map_case pragma, like this:
<pre class=example>##map_case t t_old</pre>

== Defining genders ==
Genders just like cases are defined in the header of the language file and have to match the definition as found within OpenTTD's language files. The gender of a word or expression is declared within the string's text itself by a tag of the form <code>{G=gendername}</code>:
<pre>
##gender pragma

STR_NAME :{G=gendername}String which requires gender 'gendername'
</pre>
where the string with the defined gender then will trigger the correct usage in a string which includes it and which has to take provisions to show the proper gender:
<pre>
STR_OTHER :Some text {G gender1 gender2 ...} {STRING}
</pre>

for example in German
<pre class=example>
##gender m w n p

STR_CARGO_NAME_BAUXITE :{G=n}Bauxit
</pre>
which then will be used with the correct gender by a string which includes it:
<pre class=example>
STR_NEWS_STATION_NO_LONGER_ACCEPTS_CARGO :{WHITE}{STATION} akzeptiert kein{G "en" "e" "" "e"} {STRING} mehr.
</pre>

In case the name of a gender changes in the OpenTTD language file, your language file will have to follow that change. To keep compatible with older OpenTTD versions you can use the ##map_gender pragma, like this:
<pre class=example>##gender m f
##map_gender m male
##map_gender f female</pre>

== LanguageIDs ==

Valid language IDs are listed in the table below. The cases, genders and the type of plural form is only given as reference. Authorative are the definitions in OpenTTD's language file for each language.

{| class="t"
! ID
! language
! cases
! genders
! plurals
|-
| 00
| English (US)
|
|
|
|-
| 01
| English (GB)
|
|
|
|-
| 02
| German
|
| m w n p
|
|-
| 03
| French
|
| m m2 f
| 2
|-
| 04
| Spanish
|
| m f
|
|-
| 05
| Esperanto
|
| n
|
|-
| 06
| Ido
|
|
|
|-
| 07
| Russian
| m f n p nom gen dat acc abl pre
| m f n p
| 6
|-
| 08
| Irish
|
|
| 4
|-
| 09
| Maltese
|
|
| 12
|-
| 0A
| Tamil
|
|
|
|-
| 0B
| Chuvash
|
|
|
|-
| 0C
| Chinese (Traditional)
|
|
| 1
|-
| 0D
| Serbian
| nom big gen dat aku vok lok ins
| muški ženski srednji
| 6
|-
| 0E
| Norwegian (Nynorsk)
| small
| masculine feminine neuter
|
|-
| 0F
| Welsh
|
|
|
|-
| 10
| Belarusian
| m f n p nom gen dat acc abl pre
| m f n p
| 6
|-
| 11
| Marathi
|
|
|
|-
| 12
| Faroese
|
| m f n
|
|-
| 14
| Arabic (Egypt)
|
|
| 1
|-
| 15
| Czech
| nom gen dat acc voc loc ins big small
| m f n map mnp fp np
| 10
|-
| 16
| Slovak
| g
| m z s
| 10
|-
| 18
| Bulgarian
| m f n p
| m f n p
|
|-
| 1B
| Afrikaans
|
| male
|
|-
| 1E
| Greek
| subs date geniki
| m f n
| 2
|-
| 1F
| Dutch
|
|
|
|-
| 21
| Basque
|
|
|
|-
| 22
| Catalan
|
| Masculin Femenin
|
|-
| 23
| Luxembourgish
|
|
|
|-
| 24
| Hungarian
| t ba
|
| 2
|-
| 26
| Macedonian
|
|
|
|-
| 27
| Italian
| ms mp fs fp
| m ma f
|
|-
| 28
| Romanian
|
|
|
|-
| 29
| Icelandic
|
| karlkyn kvenkyn hvorugkyn
|
|-
| 2A
| Latvian
| kas
| m f
| 3
|-
| 2B
| Lithuanian
| kas ko kam ka kuo kur kreip
| vyr mot
| 5
|-
| 2C
| Slovenian
| r d t
|
| 8
|-
| 2D
| Danish
|
|
|
|-
| 2E
| Swedish
|
|
|
|-
| 2F
| Norwegian (Bokmal)
| small
| masculine feminine neuter
|
|-
| 30
| Polish
| d c b n m w
| m f n
| 7
|-
| 31
| Galician
|
| m f n
|
|-
| 32
| Frisian
|
|
|
|-
| 33
| Ukrainian
| r d z
| m f s mn
| 6
|-
| 34
| Estonian
| g in sü
|
|
|-
| 35
| Finnish
|
|
|
|-
| 36
| Portuguese
|
| n m f mp fp
|
|-
| 37
| Brazilian Portuguese
|
| m f
| 2
|-
| 38
| Croatian
| nom gen dat aku vok lok ins
| male female middle
| 6
|-
| 39
| Japanese
|
|
| 1
|-
| 3A
| Korean
|
| m f
| 11
|-
| 3C
| Malay
|
|
|
|-
| 3D
| English (AU)
|
|
|
|-
| 3E
| Turkish
| tamlanan
|
| 1
|-
| 42
| Thai
|
|
| 1
|-
| 54
| Vietnamese
|
|
| 1
|-
| 56
| Chinese (Simplified)
|
|
| 1
|-
| 5A
| Indonesian
|
|
| 1
|-
| 5C
| Urdu
|
| m f
|
|-
| 61
| Hebrew
| singular plural gen
| m f
|
|-
| 62
| Persian
|
|
|
|-
| 66
| Latin
| gen acc abl dat
| m f n mp fp np
|
|-}

In case a language is not in this list, check the [[Action4#language IDs|master language list]] (for GRFv7) in the NewGRF Specs. This master list is always leading. NFO language ID 7F has no meaning in NML (set --default-lang instead) and setting bit 8 will break your language file.

NML:Replace TTD sprites

2013-02-28T06:35:56Z

Supercheese: Clarify meaning by better comma placement

{{NMLNavBlocksyntax}}

Using a <code style="color:darkgreen">replace</code> block, it is possible to replace TTD's built-in sprites or for base grfs to define sprites via the <code style="color:darkgreen">base_graphics</code> block. Unlike many other features, this is the only way to change the terrain (see [[NML:List_of_tiles|the tile list]] for a list of terrain sprites). The syntax is as follows:

replace [<block_name>](<sprite-id>[, <image-file>]) {
[[#real sprites|list of realsprites]]
}

and

base_graphics [<block_name>](<sprite-id>[, <image-file>]) {
[[#real sprites|list of realsprites]]
}

respectively.

Note: this only applies for the sprites in the five base grfs (thus up to sprite #4984 when looking at sprite numbers in OpenTTD), but not to the sprites defined in a base set's extra grf - they require the <code style="color:darkgreen">[[NML:Replace new sprites|replacenew]]</code> command.

A <code style="color:darkgreen"><block_name></code> is optional, but required if you want to define [[NML:Alternative sprites|alternative sprites]] for the sprite block so that it can be referenced there.

The first parameter <code style="color:darkgreen"><sprite-id></code> indicates the sprite number of the first sprite to replace. Sprite numbers are equal to the sprite numbers in the base graphics file. The [http://mz.openttdcoop.org/opengfx/authors/script.php?feature=spritesbyfile&q= OpenGFX author overview] can be used as a reference to look up these sprite numbers.

The second parameter <code style="color:darkgreen"><image-file></code> (optional) specifies the default image file to use for the new sprites.

A series of real (or recolour) sprites has to be specified between the curly braces (<code style="color:darkgreen">{</code> and <code style="color:darkgreen">}</code>). The first sprite in this list replaces the sprite with id <code style="color:darkgreen">sprite-id</code>, the second replaces <code style="color:darkgreen">sprite-id + 1</code> and so on. Sprite templates can be used as well. For example:

<pre style="color:blue">
// Rail overlays for crossings
replace rail_overlays(1005, "src/gfx/rails_overlays.png") {
[ 20,198, 40,21, -20, 5]
[ 71,198, 40,21, -20, 5]
[117,198, 40, 7, -20, 5]
[165,198, 40, 7, -20, 21]
[216,198, 12,19, 10, 5]
[248,198, 12,19, -24, 11]
}
</pre>

NML:Main

2013-01-21T20:47:44Z

Supercheese: Fix broken anchor link

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

;[[NML:Preface |Preface]]
;[[NML:changes 0.3|Changes between NML 0.2 and head / 0.3]]
;[[NML:Getting started|Getting started]]
;[[NML:Graphic files|Graphics files]]

;[[NML:Block syntax|Language structure and block syntax]]
*[[NML:GRF|GRF]] and its parameters
*[[NML:Item|Item]] (Properties, graphics, livery overrides)

*;Defining sprites:
**[[NML:Realsprites|Realsprites]]
**[[NML:Template|Template]]
**[[NML:Base Graphics|Base Graphics]]
**[[NML:Spriteset|Spriteset]]
**;Replacing sprites:
***[[NML:Replace TTD sprites|Replace TTD sprites]]
***[[NML:Replace new sprites|Replace new sprites]]
***[[NML:Add font glyphs|Add font glyphs]]
***[[NML:Alternative sprites|Alternative sprites]] (32bpp, zoom levels)
**;Aranging and grouping sprites:
***[[NML:Spritegroup|Spritegroup]] (Vehicles)
***[[NML:Spritelayout|Spritelayout]] (Houses, industries, stations, airports, objects)
***[[NML:Recolour sprites|Recolour sprites]]

*;Flow control
**[[NML:Tilelayout|Tilelayout]]
**[[NML:Switch|Switch]]
**[[NML:Produce|Produce]]
**[[NML:Random switch|Random switch]]

*;Global scope
**[[NML:Cargotable|Cargotable]]
**[[NML:Railtypetable|Railtypetable]]
**[[NML:Snow line|Snow line]]
**[[NML:Setting base costs|Setting base costs]]
**[[NML:Parameter assignment|Parameter assignment]]
**[[NML:If|If/else]]
**[[NML:While|While]]

*;Interaction with other grfs
**[[NML:Error|Error]]
**[[NML:Disable items|Disable items]]
**[[NML:Deactivate other NewGRFs|Deactivate other NewGRFs]]
**[[NML:Testing for other NewGRFs|Testing for other NewGRFs]]
**[[NML:Overriding vehicles in other NewGRFs|Overriding vehicles in other NewGRFs]]

*;Misc
**[[NML:Town names|Town names]]
**[[NML:Town names parts|Town names parts]]

;[[NML:Units|Units]]
;[[NML:Expressions|Expressions]]
*[[NML:Elementary values|Elementary values]]
*[[NML:Builtin functions|Builtin functions]]
;[[NML:Language files|Language files]]
;[[NML:Properties and variables and callbacks|Lists of properties, variables and callbacks]]
{|
|[[NML:General|General]] || || [[NML:General#General variables|variables]] ||
|-
|[[NML:Vehicles|Vehicles]] || [[NML:Vehicles#Properties common to all vehicle types|common properties]] || [[NML:Vehicles#Vehicle variables|variables]] || [[NML:Vehicles#Vehicle callbacks|callbacks]]
|-
| || [[NML:Vehicles#Train properties|train properties]] || ||
|-
| || [[NML:Vehicles#Road vehicle properties|road vehicle properties]] || ||
|-
| || [[NML:Vehicles#Ship properties|ship properties]] || ||
|-
| || [[NML:Vehicles#Aircraft properties|aircraft properties]] || ||
|-
|[[NML:Stations|Stations]] || [[NML:Stations#Station properties|properties]] || [[NML:Stations#Station variables|variables]] || [[NML:Stations#Station callbacks|callbacks]]
|-
|[[NML:Canals|Canals]] || [[NML:Canals#Canal properties|properties]] || [[NML:Canals#Canal variables|variables]] || [[NML:Canals#Canal callbacks|callbacks]]
|-
|[[NML:Bridges|Bridges]] || [[NML:Bridges#Bridge properties|properties]] || [[NML:Bridges#Bridge variables|variables]] || [[NML:Bridges#Bridge callbacks|callbacks]]
|-
|[[NML:Towns|Towns]] || || ||
|-
|[[NML:Houses|Houses]] || [[NML:Houses#House properties|properties]] || [[NML:Houses#House variables|variables]] || [[NML:Houses#House callbacks|callbacks]]
|-
|[[NML:Industries|Industries]]|| || [[NML:Industries#Common variables|common variables]] ||
|-
| || [[NML:Industries#Industry properties|industry properties]] || [[NML:Industries#Industry variables|industry variables]] || [[NML:Industries#Industry callbacks|industry callbacks]]
|-
| || [[NML:Industries#Industry tile properties|tile properties]] || [[NML:Industries#Industry tile variables|tile variables]] || [[NML:Industries#Industry tile callbacks|tile callbacks]]
|-
|[[NML:Cargos|Cargos]] || [[NML:Cargos#Cargo properties|properties]] || [[NML:Cargos#Cargo variables|variables]] || [[NML:Cargos#Cargo callbacks|callbacks]]
|-
|[[NML:Airports|Airports]] || [[NML:Airports#Airport properties|properties]] || [[NML:Airports#Airport variables|variables]] || [[NML:Airports#Airport callbacks|callbacks]]
|-
| || [[NML:Airports#Airport tile properties|tile properties]] || [[NML:Airports#Airport tile variables|tile variables]] || [[NML:Airports#Airport tile callbacks|tile callbacks]]
|-
|[[NML:Objects|Objects]] || [[NML:Objects#Object properties|properties]] || [[NML:Objects#Object variables|variables]] || [[NML:Objects#Object callbacks|callbacks]]
|-
|[[NML:Railtypes|Railtypes]] || [[NML:Railtypes#Railtype properties|properties]] || [[NML:Railtypes#Railtype variables|variables]] || [[NML:Railtypes#Railtype callbacks|callbacks]]
|}
;[[NML:Warnings|Compiler Warnings]]
;[[NML:Additional references|Additional references]]
*[[NML:Animation speed|Animation speed]]
*[[NML:Default industries|Default industries]]
*[[NML:Default industry tiles|Default industry tiles]]
*[[NML:Base cost table|Base cost table]]
*[[NML:List of sound effects|List of sound effects]]
*[[NML:List of default vehicle IDs|List of default vehicle IDs]]
*[[NML:List of default house properties|List of default house properties]]
*[[NML:List of town zones|List of town zones]]
*[[NML:List of tile classes|List of tile classes]]
*[[NML:List of default colour translation palettes|List of default colour translation palettes]]
*[[NML:List of direction constants|List of direction constants]]
*[[NML:List of tile slopes|List of tile slopes]]
*[[NML:List of tiles|List of tiles]]
*[[NML:Default TTD strings|Default TTD strings]]
*[[NML:Deprecated syntax|Deprecated syntax]]
;[[NML:NewGRF compatibility|NewGRF compatibility]]
;[[NML:Old style callbacks|Old-style callbacks]]

[[NML:Manual of style|Manual of style]]

NML:Objects

2013-01-12T02:54:04Z

Supercheese: /* Object variables */ apply green code-style format to animation_info; misc fixes

{{NMLNavPropVarCB}}

==Object IDs==
Object IDs are NewGRF-local and can therefore freely be chosen in the 0..255 range. An object is allocated by setting the 'class'-property, which should therefore be set first. Overriding the default objects (e.g. transmitter, lighthouse) is not (yet) possible.

==Object properties==

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

===Default object classes===

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

===List of object flags===

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

==Object variables==

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

Variables that require one or more parameters:

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

==Object callbacks==

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

<nowiki>* These callbacks are called when the object is not yet built, so object- specific variables cannot be accessed. Trying to do so will result in undefined behaviour.</nowiki>

===Animation triggers===

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

NML:Objects

2013-01-11T08:31:54Z

Supercheese: /* Object variables */ Clarify max value for animation_frame

{{NMLNavPropVarCB}}

==Object IDs==
Object IDs are NewGRF-local and can therefore freely be chosen in the 0..255 range. An object is allocated by setting the 'class'-property, which should therefore be set first. Overriding the default objects (e.g. transmitter, lighthouse) is not (yet) possible.

==Object properties==

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

===Default object classes===

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

===List of object flags===

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

==Object variables==

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

Variables that require one or more parameters:

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

==Object callbacks==

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

<nowiki>* These callbacks are called when the object is not yet built, so object- specific variables cannot be accessed. Trying to do so will result in undefined behaviour.</nowiki>

===Animation triggers===

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

CargoTypes

2013-01-06T20:48:20Z

Supercheese: Fix cargo classes anchor link

'''Cargo labels in OpenTTD'''

{{grfFrom|8}} In GRF version 8 the value to be used in all vehicle and industry properties, and in [[Action3|action 3]], is the position of the cargo label in the [[Action0/Global_Settings#Cargo_translation_table_.2809.29|cargo translation table]] included in the GRF.

{{grfTill|7}} GRF version 7 and below used different cargo properties for different properties (called "Type A" or "translated" and "Type B" or "untranslated" cargo slots), for historical reasons. This method is deprecated as it meant relying blindly on cargos always using the same slots. You can see the table of Type A and Type B slots [http://newgrf-specs.tt-wiki.net/index.php?title=CargoTypes&oldid=2861 here] if you really want to.

== Cargo Labels ==

The following cargo labels have been defined so far:

{| class="wikitable
|-
! Label
! Cargo Description
! [[Action0Cargos#CargoClasses_.2816.29|Cargo classes]]
! colspan="3" | Notes
|-
| align="center" colspan="2" | '''TTD Default Cargos'''
| align="center" colspan="4" | These cargos are present when no NewGRF is used
|-
| PASS
| Passengers
| 0001 Passengers
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| COAL
| Coal
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| MAIL
| Mail
| 0002 Mail
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
|OIL_
| Oil
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| LVST
| Livestock
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GOOD
| Goods
| 0004 Express
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GRAI
| Grain
| 0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| Temperate; see also WHEA, MAIZ, CERE
|-
| WOOD
| Wood
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| IORE
| Iron Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| STEL
| Steel
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| Renamed "Metal" in FIRS.
|-
| VALU
| Valuables
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| Temperate; see also GOLD, DIAM
|-
| PAPR
| Paper
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| WHEA
| Wheat
| 0010 Bulk
|
|
| Arctic; see also GRAI, MAIZ, CERE
|-
| FOOD
| Food
| 0084 Express, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GOLD
| Gold
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| Arctic; see also VALU, DIAM
|-
| RUBR
|Rubber
|0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| FRUT
| Fruit
| 0090 Bulk, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| MAIZ
| Maize
| 0010 Bulk
|
|
| Tropic; see also GRAI, WHEA, CERE
|-
| CORE
| Copper Ore
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| WATR
| Water
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| DIAM
| Diamonds
| 0008 Armoured
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
| Tropic; see also VALU, GOLD
|-
| SUGR
| Sugar
| 0010 Bulk
|
|
| Toyland
|-
| TOYS
| Toys
| 0020 Piece goods
|
|
| Toyland
|-
| BATT
| Batteries
| 0020 Piece goods
|
|
| Toyland
|-
| SWET
|Sweets (Candy)
|0004 Express
|
|
| Toyland
|-
| TOFF
|Toffee
|0010 Bulk
|
|
| Toyland
|-
| COLA
|Cola
|0040 Liquid
|
|
| Toyland
|-
| CTCD
|Cotton Candy (Candyfloss)
|0010 Bulk
|
|
| Toyland
|-
| BUBL
|Bubbles
|0020 Piece goods
|
|
| Toyland
|-
| PLST
|Plastic
|0040 Liquid
|
|
| Toyland; see also PLAS
|-
| FZDR
|Fizzy Drinks
|0020 Piece goods
|
|
| Toyland
|-
| align="center" colspan="2" | '''New Cargos'''
| align="center" colspan="4" | these cargos are only present when NewGRF industry sets are used
|-
| AORE
|Bauxite (Aluminium ore)
|0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| BEER
|Alcohol
|0064 Express, piece goods, liquids
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| BDMT
|Building Materials
|0220 Piece goods, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| In FIRS: 0030 Bulk, piece goods
|-
| BRCK
|Bricks
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| CERA
|Ceramics
| 0020 Piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| CERE
|Cereals
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| CLAY
|Clay
|0210 Bulk covered/sheltered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| In FIRS: 0010 Bulk
|-
| CMNT
|Cement
| 0210 Bulk covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| COPR
|Copper
|0020 Piece goods
|
|
|
|-
| DYES
|Dyes
| 0060 Piece goods, liquids
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| ENSP
|Engineering Supplies
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FERT
|Fertiliser
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| FICR
|Fibre crops
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FISH
|Fish
| 0084 Express, refrigerated
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FMSP
|Farm Supplies
|0024 Express, piece goods
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| FRVG
|Fruit (and optionally Vegetables)
|00A4 Express, piece goods, refrigerated
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| GLAS
|Glass
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| GRVL
|Gravel / Ballast
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| LIME
|Lime stone
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| MILK
|Milk
|00C4 Express, liquid, refrigerated
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| MNSP
|Manufacturing Supplies
|0024 Piece Goods, express
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| OLSD
|Oil seed
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| PETR
|Petrol / Fuel Oil
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| PLAS
|Plastic
| 0060 Piece goods, liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| POTA
|Potash
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change" />
|-
| RCYC
|Recyclables
|0220 Piece Goods, covered
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| RFPR
|Refined products
| 0040 Liquid
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| SAND
|Sand
| 0010 Bulk
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| SCMT
|Scrap Metal
|1010 Bulk, non-pourable
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| SGBT
|Sugar beet
|0010 Bulk
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| not in tropical
|-
| SGCN
|Sugarcane
|1010 Bulk, non-pourable
|
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
| only tropical
|-
| SULP
|Sulphur
| 0210 Bulk, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|<ref name="ecs_cargo_change">ECS cargo classes changed as of Dec 31, 2010</ref>
|-
| TOUR
|Tourists
| 0005 Passengers, express
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| VEHI
|Vehicles
| 0420 Piece goods, oversized
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
|
|
|-
| WDPR
|Wood Products
| 0030 Bulk, piece goods
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|
|-
| WOOL
|Wool
| 0220 Piece goods, covered/sheltered
| style="background: #FFCC00; color: black" | [[ttwiki:ECS|ECS]]
| style="background: #1AD74C; color: white" | [[ttwiki:FIRS|FIRS]]
|<ref name="ecs_cargo_change" />
|-
| align="center" colspan="2" |'''Special Cargos'''
| align="center" colspan="4" | these cargos are for use outside industry sets and do not represent transporting anything
|-
| DFLT
|'Default'
| ---- None
|
|
| Used by andythenorth to identify default cargo graphics in newgrfs that use code/graphics generation.

Not intended to be used as an actual cargo in translation tables.
|-
| GEAR
|Locomotive regearing
|8000 Special
|
|
| Using this cargo may make your vehicle set incompatible with some industry sets

use CB36 instead to set capacity to 0
|-
| align="center" colspan="2" |'''Deprecated Cargos'''
| align="center" colspan="4" | these cargos are not used by any current industry set, and are listed here for backwards compatibility
|-
| FUEL
|Fuel
|0040 Liquid
|
|
|Use PETR for refined-oil fuel
|-
| RSGR
|Raw Sugar
|0010 Bulk
|
|
| Deprecated in FIRS. See SGBT and SGCN
|-
| SCRP
|Scrap Metal
|0010 Piece Goods
|
|
| Deprecated in FIRS, use SCMT instead
|-
| TWOD
|Tropic Wood
|0020 Piece goods
|
|
| formerly intended as a default cargo
|-
| WSTE
|Waste
|0010 Bulk
|
|
| Deprecated in FIRS.
|}

<references />

If you write or publish a NewGRF which introduces a new cargo label, please also add a comment where the new label is used.

NML:Main

2012-12-28T09:21:26Z

Supercheese: Add "objects" to Spritelayout comment

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

;[[NML:Preface |Preface]]
;[[NML:changes 0.3|Changes between NML 0.2 and head / 0.3]]
;[[NML:Getting started|Getting started]]
;[[NML:Graphic files|Graphics files]]

;[[NML:Block syntax|Language structure and block syntax]]
*[[NML:GRF|GRF]] and its parameters
*[[NML:Item|Item]] (Properties, graphics, livery overrides)

*;Defining sprites:
**[[NML:Realsprites|Realsprites]]
**[[NML:Template|Template]]
**[[NML:Base Graphics|Base Graphics]]
**[[NML:Spriteset|Spriteset]]
**;Replacing sprites:
***[[NML:Replace TTD sprites|Replace TTD sprites]]
***[[NML:Replace new sprites|Replace new sprites]]
***[[NML:Add font glyphs|Add font glyphs]]
***[[NML:Alternative sprites|Alternative sprites]] (32bpp, zoom levels)
**;Aranging and grouping sprites:
***[[NML:Spritegroup|Spritegroup]] (Vehicles)
***[[NML:Spritelayout|Spritelayout]] (Houses, industries, stations, airports, objects)
***[[NML:Recolour sprites|Recolour sprites]]

*;Flow control
**[[NML:Tilelayout|Tilelayout]]
**[[NML:Switch|Switch]]
**[[NML:Produce|Produce]]
**[[NML:Random switch|Random switch]]

*;Global scope
**[[NML:Cargotable|Cargotable]]
**[[NML:Railtypetable|Railtypetable]]
**[[NML:Snow line|Snow line]]
**[[NML:Setting base costs|Setting base costs]]
**[[NML:Parameter assignment|Parameter assignment]]
**[[NML:If|If/else]]
**[[NML:While|While]]

*;Interaction with other grfs
**[[NML:Error|Error]]
**[[NML:Disable items|Disable items]]
**[[NML:Deactivate other NewGRFs|Deactivate other NewGRFs]]
**[[NML:Testing for other NewGRFs|Testing for other NewGRFs]]
**[[NML:Overriding vehicles in other NewGRFs|Overriding vehicles in other NewGRFs]]

*;Misc
**[[NML:Town names|Town names]]
**[[NML:Town names parts|Town names parts]]

;[[NML:Units|Units]]
;[[NML:Expressions|Expressions]]
*[[NML:Elementary values|Elementary values]]
*[[NML:Builtin functions|Builtin functions]]
;[[NML:Language files|Language files]]
;[[NML:Properties and variables and callbacks|Lists of properties, variables and callbacks]]
{|
|[[NML:General|General]] || || [[NML:General#General variables|variables]] ||
|-
|[[NML:Vehicles|Vehicles]] || [[NML:Vehicles#Properties common to all vehicle types|common properties]] || [[NML:Vehicles#Vehicle variables|variables]] || [[NML:Vehicles#Vehicle callbacks|callbacks]]
|-
| || [[NML:Vehicles#Train properties|train properties]] || ||
|-
| || [[NML:Vehicles#Road vehicle properties|road vehicle properties]] || ||
|-
| || [[NML:Vehicles#Ship properties|ship properties]] || ||
|-
| || [[NML:Vehicles#Plane properties|aircraft properties]] || ||
|-
|[[NML:Stations|Stations]] || [[NML:Stations#Station properties|properties]] || [[NML:Stations#Station variables|variables]] || [[NML:Stations#Station callbacks|callbacks]]
|-
|[[NML:Canals|Canals]] || [[NML:Canals#Canal properties|properties]] || [[NML:Canals#Canal variables|variables]] || [[NML:Canals#Canal callbacks|callbacks]]
|-
|[[NML:Bridges|Bridges]] || [[NML:Bridges#Bridge properties|properties]] || [[NML:Bridges#Bridge variables|variables]] || [[NML:Bridges#Bridge callbacks|callbacks]]
|-
|[[NML:Towns|Towns]] || || ||
|-
|[[NML:Houses|Houses]] || [[NML:Houses#House properties|properties]] || [[NML:Houses#House variables|variables]] || [[NML:Houses#House callbacks|callbacks]]
|-
|[[NML:Industries|Industries]]|| || [[NML:Industries#Common variables|common variables]] ||
|-
| || [[NML:Industries#Industry properties|industry properties]] || [[NML:Industries#Industry variables|industry variables]] || [[NML:Industries#Industry callbacks|industry callbacks]]
|-
| || [[NML:Industries#Industry tile properties|tile properties]] || [[NML:Industries#Industry tile variables|tile variables]] || [[NML:Industries#Industry tile callbacks|tile callbacks]]
|-
|[[NML:Cargos|Cargos]] || [[NML:Cargos#Cargo properties|properties]] || [[NML:Cargos#Cargo variables|variables]] || [[NML:Cargos#Cargo callbacks|callbacks]]
|-
|[[NML:Airports|Airports]] || [[NML:Airports#Airport properties|properties]] || [[NML:Airports#Airport variables|variables]] || [[NML:Airports#Airport callbacks|callbacks]]
|-
| || [[NML:Airports#Airport tile properties|tile properties]] || [[NML:Airports#Airport tile variables|tile variables]] || [[NML:Airports#Airport tile callbacks|tile callbacks]]
|-
|[[NML:Objects|Objects]] || [[NML:Objects#Object properties|properties]] || [[NML:Objects#Object variables|variables]] || [[NML:Objects#Object callbacks|callbacks]]
|-
|[[NML:Railtypes|Railtypes]] || [[NML:Railtypes#Railtype properties|properties]] || [[NML:Railtypes#Railtype variables|variables]] || [[NML:Railtypes#Railtype callbacks|callbacks]]
|}
;[[NML:Warnings|Compiler Warnings]]
;[[NML:Additional references|Additional references]]
*[[NML:Animation speed|Animation speed]]
*[[NML:Default industries|Default industries]]
*[[NML:Default industry tiles|Default industry tiles]]
*[[NML:Base cost table|Base cost table]]
*[[NML:List of sound effects|List of sound effects]]
*[[NML:List of default vehicle IDs|List of default vehicle IDs]]
*[[NML:List of default house properties|List of default house properties]]
*[[NML:List of town zones|List of town zones]]
*[[NML:List of tile classes|List of tile classes]]
*[[NML:List of default colour translation palettes|List of default colour translation palettes]]
*[[NML:List of direction constants|List of direction constants]]
*[[NML:List of tile slopes|List of tile slopes]]
*[[NML:List of tiles|List of tiles]]
*[[NML:Default TTD strings|Default TTD strings]]
*[[NML:Deprecated syntax|Deprecated syntax]]
;[[NML:NewGRF compatibility|NewGRF compatibility]]
;[[NML:Old style callbacks|Old-style callbacks]]

[[NML:Manual of style|Manual of style]]

NML:Item

2012-08-01T20:47:36Z

Supercheese: add info about cargo type slots and IDs

{{NMLNavBlocksyntax}}

== General ==

item (<expression> [, <ID> [, <expression>]]) {
(<property-block>|<graphics-block>|<livery_override-block>)+
}

The first argument is the feature of the item, the second (optional) argument is the name used to identify the object throughout the NML file and the third (optional) argument is the numerical id you want to use for this item. Note that for cargos, this numerical ID corresponds to the [[CargoDefaultProps|cargo type slot]] of the cargo. TTD default cargos occupy slots 1-12, so if you want to define a new cargo be sure to set this ID to 13 or higher.
Example:

<pre style="color:blue">
item (FEAT_ROADVEHS, hereford_tram) {
property {
name: string(STR_NAME_HEREFORD_TRAM);
climates_available: ALL_CLIMATES;
introduction_date: date(1940,1,1);
speed: 60 km/h;
}
}
</pre>

== Property block ==

property {
(<ID>: (<string>|(<expression> [<unit>]));)+
}

This one looks a lot more complicated than it actually is. A property-block contains one or more assignments. Each assignment starts with the name of the property that is changed followed by a colon. After the colon follows the value and you end the line with a semicolon. The type of the value depends on the property, some properties require a string as value and some an expression. For some properties you can optionally specify a unit that is used to convert the value to the unit that is written to the output file. You can only use a unit if the expression is constant. [[NML:Units|List of valid units]]

== Graphics block ==

A graphics block must be placed in an item-block. It allows to define the graphics for a particular item, as well as various callbacks. Callbacks are used to define various things at run time, based on information (variables) of the item itself. This provides a much greater degree of flexibility than setting properties. An example (using fictional callback names):

<pre style="color:blue">
graphics {
callback_a: switch_a;
callback_b: return 42 + some_var;
default: some_spritegroup;
}
</pre>

The callbacks that are available differ per feature, refer to the feature-specific pages for more information. The 'default'-callback is usually used to resolve the graphics. For each callback a return value may be specified, in the same way as for [[NML:Switch| switch-blocks]]. Note that all callbacks have to be defined in a '''single''' graphics-block.

For vehicles and stations, a cargo type (identifier from the [[NML:Cargotable|cargo table]]) may be used as callback name, to provide cargo-specific graphics.

== Livery override ==

[[Image:NML liveryoverride.png|frame|left|Same cars, different engine, different car sprites]]

A livery override block offers the option to change the look and behaviour of a wagon depending on the engine it is attached to. It is basically the same as a graphics-block and its syntax is the same. The difference is that it only applies to a particular combination of an engine and a wagon. E.g. passenger wagons could adapt their livery to match the engine, to make the consist look like a multiple-unit train. The spritegroup needs to be defined before it can be used in a livery override. A livery override block is always part of the '''engine''' definition and looks like

livery_override (vehicleID) {
callback_name: switch_name;
callback_name2: return value;
default: spritegroup_name;
}

For an example see the [[NML:Spritegroup|spritegroup]]

NML:Changes 0.3

2012-07-19T22:01:47Z

Supercheese: Capitalization consistency, etc.

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

== Introduction ==
Between NML 0.2.x and NML 0.3.x (and their corresponding nightlies) the generated NewGRF version by NML changed from v7 to v8. This brings lot of advantages, but requires a few changes to existing NML files. NewGRFs thus will require a minimum OpenTTD version of 1.2.0 (r23166).

== Callbacks ==
NML 0.3 only supports the new style callbacks. Thus all callback_flag properties have been removed as have the callback flag constants *CBF*. For a complete list of affected constants see the [http://dev.openttdcoop.org/projects/nml/repository/revisions/28c88515e5e7/diff/nml/global_constants.py related commit]

== New named constants ==
A few constants have recently been introduced in both NML 0.2 and 0.3 that make the transition easier. Make sure to use them. For callback "articulated_part" use CB_RESULT_NO_MORE_ARTICULATED_PARTS and/or CB_RESULT_REVERSED_VEHICLE instead of hard-coded 0xFF / 0x80.
For callbacks "cargo_subtype_text", "cargo_subtype_display" and "start_stop" use CB_RESULT_NO_TEXT instead of hard-coded 0xFF.

== Industry availability ==
The callback "availability" is no longer available. Use the callback "construction_probability" instead.

== Changed variables ==

=== snowline_height ===
The "snowline_height" variable returns the height in tiles instead of pixels (=tiles*8).

=== nearby_tile_height ===
The "nearby_tile_height" variable returns the height in tiles instead of pixels (=tiles*8).

=== date_of_last_service ===
This variable is no longer limited to the range of 1920 ... 2050. It returns now the year 0-based date.

== Base costs ==
Base costs are treated in NewGRF v8 (NML 0.3.x) differently than in NewGRF v7 (NML 0.2.x and earlier). Base costs do '''NOT''' influence eachother anymore. You'll need to set all base costs directly and cannot rely anymore that any are set indirectly. See the [[NML:Base_cost_table| base costs table]] which will be influenced.

== New properties ==
=== Railtypes: alternative_railtype_list ===
This property allows to define a list of rail types which this rail type will also define - unless the rail type is defined separately.

=== Trains / Road vehicles: Length ===
Trains and road vehicles now have a property 'length', this replaces the old property 'shorten_vehicle'.

=== Cargos: Capacity multiplier ===
This new property allows answering the question: How much units of cargo X are equivalent to 1 ton of coal, resp. 1000 litres of water?

=== Houses: watched_cargo_types ===
With the implementation of this property, the watched_cargo_accepted callback becomes usable.

== Vehicle refitting ==
The 'xor'-property 'refittable_cargo_types' is no longer available; use 'cargo_allow_refit' resp. 'cargo_disallow_refit' instead. For trains, road vehicles and ships you can now specify a default cargo type.

== Alternative_sprites ==
The way OpenTTD supports 32bpp has been changed and enhanced. <code style="color:darkgreen">alternative_sprites</code> now takes more and different zoom level arguments and a type argument has been added as 8bpp sprites are now also permissible. See the description of the [[Alternative_Sprites| <code style="color:darkgreen">alternative_sprites</code>]] for details.

== Sounds ==
It is now possible to specify a relative volume for sound effects. Additionally, the 64kB size limit has been removed.

NML:Airports

2011-10-14T21:50:00Z

Supercheese: Add Airport ID references; Capitalization

{{NMLNavPropVarCB}}

Airports and airport tiles can only be defined in OpenTTD {{ottd|1.1|r19459}} or later.

==Airport properties==

{| class="t"
! name
! value range
! comment
|-
| name
| string
|
{{ottd|1.1|r19459}} Name of the airport
|-
| override
|
|
{{ottd|1.1|r19459}} The id of airport to replace / override, see [[AirportTypes]].
|-
| layouts
| list of layouts
|
{{ottd|1.1|r20377}}
|-
| years_available
| [start year, last year]
|
{{ottd|1.1|r19459}} List of the availablility years: first and last year it can be built
|-
| ttd_airport-type
| 0 ... 3
|
{{ottd|1.1|r19459}} Substitute TTDPatch airport type
|-
| catchment_area
|
|
{{ottd|1.1|r19459}} Catchment area of the airport in tiles around its perimeter
|-
| noise_level
|
|
{{ottd|1.1|r19459}} Noise generation of this airport
|}

==Airport tile properties==

{| class="t"
! name
! value range
! comment
|-
| override
|
|
{{ottd|1.1|r19204}} The id of airport tile to override, see [[AirportTypes]].
|-
| substitute
|
|
{{ottd|1.1|r19204}} The id of airport tile to replace
|-
| callback_flags
| bitmask
|
{{ottd|1.1|r19204}} Do not set this, unless you use [[NML:Old style callbacks|old-style callbacks]].
|-
| animation_info
|
|
{{ottd|1.1|r19204}}
|-
| animation_speed
|
|
{{ottd|1.1|r19204}} See [[NML:Animation speed|speed settings]]
|-
| animation_triggers
| bitmask(ANIM_TRIGGER_APT_XXX, ... )
|
{{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.
|}

==Airport variables==

{| class="t"
! name
! value range
! comment
|-
| layout
| 0 .. (number of layouts - 1)
|
{{ottd|1.1|r20364}} Layout number of the airport (index in the layouts array)
|}

==Airport tile variables==

{| class="t"
! name
! value range
! comment
|-
| terrain_type
|
|
|-
| town_radius_group
|
|
|-
| relative_x
| 0..255
| X-coordinate (top right -> bottom left) of the tile relative to the northernmost tile.
|-
| relative_y
| 0..255
| Y-coordinate (top left -> bottom right) of the tile relative to the northernmost tile.
|-
| relative_pos
| 0xYYXX
|
A combination of relative_x and relative_y in the format 0xYYXX. Useful if you want to check for a single position. The [[NML:Builtin functions|builtin function]] relative_coord(x, y) may be useful when making comparisons.
|-
| animation_frame
|
|
|}

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.

{| class="t"
! name
! value range
! comment
|-
| nearby_tile_slope
| SLOPE_XXX
|
See [[NML:List of tile slopes|tile slopes]] for an overview of possible values
|-
| nearby_tile_is_same_airport
| 1 if the tile is part of the same airport, 0 otherwise
|
|-
| nearby_tile_is_water
| 1 if the tile is water, 0 otherwise
|
|-
| nearby_tile_terrain_type
| TILETYPE_XX
| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
|-
| nearby_tile_water_class
| WATER_CLASS_XXX
| XXX = [NONE <nowiki>|</nowiki> SEA <nowiki>|</nowiki> CANAL <nowiki>|</nowiki> RIVER] Note that tiles for which <code style="color:darkgreen">nearby_tile_is_water</code> is 0 may still have a water class, e.g. industry tiles with water beneath them.
|-
| nearby_tile_height
| 0..120
| The height of the lowest corner of the given tile.
|-
| nearby_tile_class
|
[[NML:List of tile classes|Tile class]]
|
|-
| nearby_tile_animation_frame
| 0..255
| Animation frame of the given tile
|-
| nearby_tile_airporttile_id
| 0x00aa, 0xFFbb, 0xFFFE or 0xFFFF
| 0x00aa: The tile is an airport tile that is part of this GRF, the tile id is aa. 0xFFbb: The tile is an original airport tile with id bb. 0xFFFE: The tile is an airport tile defined in another GRF. 0xFFFF: The tile is not an airport tile or it belongs to another GRF.
|}

==Airport callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite set (with 1 sprite)
| 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.
|-
| additional_text
| String
| Additional text to show in the buy menu. String may differ per layout, use the <code style="color:darkgreen">layout</code> variable for this.
|-
| layout_name
| String
| Name of the airport layout in the variable <code style="color:darkgreen">layout</code>
|}

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.

==Airport tile callbacks==

{| class="t"
! callback
! return value
! comment
|-
| default
| Sprite layout
| Graphics for an airport tile
|-
| anim_next_frame
| Next animation frame or CB_RESULT_XXX
| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. <code style="color:darkgreen">extra_callback_info1</code> contains random bits. Returning a sound effect in the high byte will cause that sound effect to be played.
|-
| anim_control
| Next animation frame or CB_RESULT_XXX
|
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. <code style="color:darkgreen">extra_callback_info1</code> contains random bits. Returning a sound effect in the high byte will cause that sound effect to be played. <code style="color:darkgreen">extra_callback_info2</code> contains the reason to trigger the animation, 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.
|-
| anim_speed
| 0 .. 16
| Decide the time an animation frame should last. Return value is interpreted as (num_ticks = 2^anim_speed), which each tick lasting 30 ms. Avoid using this callback if possible, since it has to be called each tick for every animated tile. This can be used to create animation frames that last between 30 ms and 33 minutes.
|-
| foundations
| CB_RESULT[_NO]_FOUNDATIONS
| Return CB_RESULT_FOUNDATIONS to draw standard foundations (default) or CB_RESULT_NO_FOUNDATIONS to not draw them.
|}

===Animation triggers===

{| class="t"
! Animation trigger
! Description
|-
| ANIM_TRIGGER_APT_BUILT
| Airport is built (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_TILELOOP
| Airport tile is processed in the tileloop (at different times for different tiles)
|-
| ANIM_TRIGGER_APT_NEW_CARGO
| New cargo arrives at the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_CARGO_TAKEN
| All cargo of a cargo type is removed from the airport (all tiles at the same time)
|-
| ANIM_TRIGGER_APT_250_TICKS
| Every 250 ticks (all tiles at the same time)
|}

Action5

2011-10-04T18:50:45Z

Supercheese: /* 15 / 95 OpenTTD GUI sprites */ Spelling fix

== Introduction ==

Define base graphics specific sets

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

== Syntax ==

The data looks as follows:

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

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

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

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

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

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

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

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

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

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

== Description ==

=== Sprite-number ===

This is just the number you are at.

=== Length ===

Count the number of bytes in this action.

=== type ===

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

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

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

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

|-
|04||{{ottdp| |2.5|ttdprev=alpha 41}}||Pre-signal, semaphore, and [[PathBasedSignalling|PBS]] graphics||240

|-
|05||{{ottdp|0.6|2.0}}||Overhead wires and pylon graphics||48

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

|-
|06||{{ottdp|0.6|no|ottdrev=r11321}}||Foundations for BuildOnSlopes and half tiles (NS and EW foundations) ||90

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

|-
|08||{{ottdp|0.6|2.5|ttdprev=alpha 17}}||Canals||65

|-
|09||{{ottdp|0.6|2.5|ttdprev=alpha 58}}||One-way road arrows||6

|-
|0A||{{ottdp|0.6|2.5|ttdprev=alpha 67}}||Two company color translation maps||256

|-
|0B||{{ottdp|0.6|2.5|ttdprev=alpha 68}}||Tram tracks||113

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

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

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

|-
|0F||{{ottdp|0.7|2.6|ottdrev=r13469|ttdprev=r1487}}||Sprites for marking tracks on slopes (for track reservation systems like PBS or YAPP)||12

|-
|10||{{ottdp|0.6|no|ottdrev=r9645}}||Additional airport graphics||15

|-
|11||{{ottdp|0.6|2.6|ottdrev=r9645|ttdprev=r1589}}||Road stop graphics||8

|-
|12||{{ottdp|0.7|2.6|ottdrev=r13464|ttdprev=r1498}}||Aqueduct graphics||8

|-
|13||{{ottdp|0.6|no|ottdrev=r11433}}||Autorail sprites||55

|-
|14,94||{{ottdp|0.6|no|ottdrev=11433}}||Flag sprites||Up to 36

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

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

<references/>

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

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

{|
!Group(s)!!Contents

|-
|0||lighted entrance signals

|-
|1||lighted exit signals

|-
|2||lighted combo signals

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

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

|-
|7||standard lighted PBS signals

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

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

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

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

If diagonal flooding is enabled then due to new corner coasts, you can use this to give a complete set of replacement coast tile sprites. There are 16 in total, 8 original Transport Tycoon Deluxe sprites and 8 for the corner slopes. Order of the sprites (1) is as follows:

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

(1) Sprite numbers from trg1(r).pcx.

[[File:Action5Coast16Sprites.png]]

''The 16 sprites for feature 0D''

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

[[File:Action5Coast10Sprites.png]]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<pre>\d1313

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

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

80</pre>

and

<pre>\d1314

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

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

80</pre>

where 1313 and 1314 are town road sprites.

[[File:roadstops.png]]

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

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

==== 12 Aqueducts ====

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

[[File:aqueduct.png]]

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

OpenTTD defines 162 GUI sprites. Additional sprites not needed by an OpenTTD are simply ignored, so that new(er) base sets can be used by old OpenTTD versions. One can (re-)define a subset of the GUI sprites by giving an offset into the GUI sprites. The sprites are:
{|
!Offset !! Meaning
|-
|0 .. 11|| Halftile selections
|-
|12 .. 13 || Title screen letters E and D
|-
|14 .. 37 || Bridge piers colours 1 .. 4
|-
|38 || square indicating NewGRF compatibility
|-
|39 || blob indicating server compatibility
|-
|40 || lock icon
|-
|41 || empty check box
|-
|42 || checked check box
|-
|43 || warning sign
|-
|44 || window resize right
|-
|45 .. 48|| arrows
|-
|49 || house
|-
|50 || shared orders
|-
|51 .. 52 || pin / pinned
|-
|53 .. 62 || rail build icons and cursors
|-
|63 .. 68 || monorail build icons and cursors
|-
|69 .. 74 || maglev build icons and cursors
|-
|75 || ??
|-
|76 .. 77 || waypoint toolbar and cursor icon
|-
|78 .. 81 || waypoint buildings
|-
|82 .. 85 || autoroad toobar and cursor for road and trams
|-
|86 || helipad
|-
|87 || build ship lift cursor
|-
|88 .. 89 || build canal toolbar and cursor
|-
|90 || fast forward
|-
|91 .. 92 || level land toolbar and cursor
|-
|93 .. 96 || sell vehicle
|-
|97 .. 100 || sell all vehicles
|-
|101 .. 104 || replace vehicle
|-
|105 || sell chain of rail vehicles
|-
|106 .. 113 || clone vehicles button and cursors
|-
|114 .. 117 || create vehicle group button
|-
|118 .. 121 || delete vehicle group button
|-
|122 .. 125 || rename vehicle group button
|-
|126 .. 133 || group replace on / off button
|-
|134 || road toolbar: build one-way roads
|-
|135 || signal toolbar: convert signals
|-
|136 .. 137|| build rivers toolbar and cursor
|-
|138 .. 143 || OSK
|-
|144 || switch toolbar
|-
|145 .. 146 || build aqueduct toolbar and cursor
|-
|147 .. 148 || (+) and (-) icon
|-
|149 || window resize left
|-
|150 || play music right-to-left languages
|-
|151 .. 152 || shade / unshade
|-
|153 || debug
|-
|154 .. 157 || vehicle profit icons
|-
|158 || unread news
|-
|159 || exclusive transport rights
|-
|160 || autoreplace protection
|-
|161 || autoreplace defined
|}

=== num-sprites ===

The number of sprites that follow.

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

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

=== offset ===

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

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

== Example ==

Something to go here