GRFSpecs - User contributions [en-gb]

NML:General

2023-06-28T13:23:50Z

Telk: Add a ref for version_openttd() who will use old nml version

{{NMLNavPropVarCB}}

==General variables==

A number of global variables are available. Some are only available in switch-blocks, while others can be used in any expression. This is indicated by the second column in the following table:

{| class="wikitable sortable"
! name
! Available outside switch blocks
! Value range
! Comment
|-
| <code style="color:green">ttd_platform</code>
| Yes
| <code style="color:green">PLATFORM_TTDPATCH</code> or <code style="color:green">PLATFORM_OPENTTD</code>
|
|-
| <code style="color:green">ttdpatch_version</code>
| Yes
|
|
|-
| <code style="color:green">openttd_version</code>
| Yes
|
| Use <code style="color:green">version_openttd</code> to test and compare for a release version.
* {{ottd|≤1.11}} <code style="color:green">version_openttd(MAJOR, MINOR, BUILD)</code>
* {{ottd|≥12}} <code style="color:green">version_openttd(MAJOR, MINOR)</code><ref name=versionopnettd>It should be <code style="color:green">version_openttd(1, MAJOR, MINOR)</code> if you are using NML with version ≤ 0.7.3</ref>
|-
| <code style="color:green">current_palette</code>
| Yes
| <code style="color:green">PALETTE_DOS</code> or <code style="color:green">PALETTE_WIN</code>
|
|-
| <code style="color:green">current_date</code>
| No
| days since year 0
| Use <code style="color:green">date(year, month, day)</code> to compare with.
|-
| <code style="color:green">current_year</code>
| No
| 0 .. 5000000
|
|-
| <code style="color:green">current_month</code>
| No
| 0 .. 11
|
|-
| <code style="color:green">current_day_of_month</code>
| No
| 0 .. 30
|
|-
| <code style="color:green">current_day_of_year</code>
| No
| 0 .. 364 (365 in leap years)
|
|-
| <code style="color:green">is_leapyear</code>
| No
| 0 or 1
|
|-
| <code style="color:green">date_loaded</code>
| Yes
| days since year 0
| Set to the time of game load, which is the current date in single player, and the date the server started in multiplayer. This to prevent desyncs.
|-
| <code style="color:green">year_loaded</code>
| Yes
| years since year 0
| See <code style="color:green">date_loaded</code>.
|-
| <code style="color:green">starting_year</code>
| Yes
| years since year 0
| Years before 1920 are clamped to 1920
|-
| <code style="color:green">animation_counter</code>
| No
| 0 .. 65535
| Increased by 1 each tick
|-
| <code style="color:green">climate</code>
| Yes <ref name=gamechange>The value of these variables can change during the game. Reading them from a switch block (which reads the current value) may result in a different value than in the rest of the code (which is evaluated when the game is loaded).</ref>
| <code style="color:green">CLIMATE_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">TEMPERATE</code> <nowiki>|</nowiki> <code style="color:green">ARCTIC</code> <nowiki>|</nowiki> <code style="color:green">TROPICAL</code> <nowiki>|</nowiki> <code style="color:green">TOYLAND</code>]
|
|-
| <code style="color:green">game_mode</code>
| Yes
| <code style="color:green">GAMEMODE_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">MENU</code> <nowiki>|</nowiki> <code style="color:green">GAME</code> <nowiki>|</nowiki> <code style="color:green">EDITOR</code>]
|
|-
| <code style="color:green">loading_stage</code>
| Yes
| <code style="color:green">LOADING_STAGE_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">INITIALIZE</code> <nowiki>|</nowiki> <code style="color:green">RESERVE</code> <nowiki>|</nowiki> <code style="color:green">ACTIVATE</code> <nowiki>|</nowiki> <code style="color:green">TEST</code>]
| 'Phase' of the GRF loading process.
|-
| <code style="color:green">difficulty_level</code>
| Yes <ref name=gamechange />
| <code style="color:green">DIFFICULTY_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">EASY</code> <nowiki>|</nowiki> <code style="color:green">MEDIUM</code> <nowiki>|</nowiki> <code style="color:green">HARD</code> <nowiki>|</nowiki> <code style="color:green">CUSTOM</code>]
|
|-
| <code style="color:green">display_options</code>
| No
| bitmask of <code style="color:green">DISPLAY_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">TOWN_NAMES</code> <nowiki>|</nowiki> <code style="color:green">STATION_NAMES</code> <nowiki>|</nowiki> <code style="color:green">SIGNS</code> <nowiki>|</nowiki> <code style="color:green">ANIMATION</code> <nowiki>|</nowiki> <code style="color:green">FULL_DETAIL</code>]
| Use <code style="color:green">hasbit(display_options, DISPLAY_XXX)</code> to test a particular bit.
|-
| <code style="color:green">desert_paved_roads</code>
| Yes <ref name=readwrite>These variables can be written as well as read. Use a normal assignment, for example:

<pre style="color:blue">
traininfo_y_offset = -2;
</pre></ref>
| 0 or 1
| If 1, desert roads have pavement and street lights.
|-
| <code style="color:green">second_rocky_tileset</code>
| Yes <ref name=readwrite />
| 0 or 1
| {{ottdp|1.5|no|ottdrev=r27200}} If 1, rocky tiles are drawn using sprites from two ranges: 4023 - 4041 (always used) and 4042 - 4060 (used if enabled)
|-
| <code style="color:green">train_width_32_px</code>
| Yes <ref name=readwrite />
| 0 or 1
| If 1, train vehicles are 32 instead of 29 pixels wide in the depot view.
|-
| <code style="color:green">traininfo_y_offset</code>
| Yes <ref name=readwrite />
| -128 .. 127
| Used to correctly position the depot view of trains.
|-
| <code style="color:green">snowline_height</code>
| No
| {{nml|0.2}} 16 .. 120 in steps of 8, or 0xFF if no snow.
{{nml|0.3}} 0..max_tile_height, or 0xFF if no snow.
| {{nml|0.2}} One tile height is equivalent to 8 units.
{{nml|0.3}} It's the height in tiles.
|-
| <code style="color:green">traffic_side</code>
| Yes <ref name=gamechange />
| <code style="color:green">TRAFFIC_SIDE_LEFT</code> or <code style="color:green">TRAFFIC_SIDE_RIGHT</code>
|
|-
| <code style="color:green">freight_trains</code>
| Yes
| 1 .. 255
| Weight multiplier for freight trains
|-
| <code style="color:green">plane_speed</code>
| Yes
| 1 .. 4
| Speed multiplier for planes. Value of 1 is equal to the original speed (1/4), while 4 means that planes move at full speed (4/4)
|-
| <code style="color:green">ttdpatch_flags</code>
| Yes
|
|
|-
| <code style="color:green">current_callback</code>
| No
|
| Set to the ID of the current callback, useful for old-style callbacks.
|-
| <code style="color:green">extra_callback_info1</code>
| No
| Varies
| Extra callback information, meaning differs per callback.
|-
| <code style="color:green">extra_callback_info2</code>
| No
| Varies
| Extra callback information, meaning differs per callback.
|-
| <code style="color:green">last_computed_result</code>
| No
|
| Result of the last (previously evaluated) switch block.
|-
| <code style="color:green">base_sprite_2cc</code>
| Yes
| 0 .. 65535
| Base sprite for 2cc (dual company colour) colour-maps
|-
| <code style="color:green">base_sprite_foundations</code>
| Yes
| 0 .. 65535
| {{ottdp|1.4|no|ottdrev=r25230}} Base sprite for foundations. This sprite block does only contain the extra foundations from [[NML:Replace_new_sprites| replacenew]] type <code style="color:green">FOUNDATIONS_SLOPES_HALFTILES</code> or <code style="color:green">FOUNDATIONS_SLOPES</code>. It does not contain the default foundations of sprites 990 to 1003 (via replace)
|-
| <code style="color:green">base_sprite_shores</code>
| Yes
| 0 .. 65535
| {{ottdp|1.4|no|ottdrev=r25230}} Base sprite for shores. All coast sprites in the order of the [[Action5#0D_Coast_tile_sprites|16 sprites version]] of [[NML:Replace_new_sprites| replacenew]] type <code style="color:green">COAST_TILES</code>. Note that, it does not matter in which way the sprites were originally defined (whether via replacenew with 10 or 16 sprites, or via replace). The sprite block returned by this variable has always all sprites in the same order.
|-
| <code style="color:green">map_type</code>
| Yes
| <code style="color:green">MAP_TYPE_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">RECTANGULAR</code> <nowiki>|</nowiki> <code style="color:green">X_BIGGER</code> <nowiki>|</nowiki> <code style="color:green">Y_BIGGER</code>]
|
|-
| <code style="color:green">map_min_edge</code>
| Yes
| 64 .. 4096
| Length of the smallest map edge (in tiles)
|-
| <code style="color:green">map_max_edge</code>
| Yes
| 64 .. 4096
| Length of the biggest map edge (in tiles)
|-
| <code style="color:green">map_x_edge</code>
| Yes
| 64 .. 4096
| Length of the x (top-left) map edge (in tiles)
|-
| <code style="color:green">map_y_edge</code>
| Yes
| 64 .. 4096
| Length of the y (top-right) map edge (in tiles)
|-
| <code style="color:green">map_size</code>
| Yes
| 64*64 .. 4096*4096
| Total number of tiles on the map
|-
| <code style="color:green">long_bridges</code>
| Yes
| 0 or 1
|
|-
| <code style="color:green">gradual_loading</code>
| Yes
| 0 or 1
|
|-
| <code style="color:green">bridge_speed_limits</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">wagon_speed_limits</code>
| Yes
| 0 or 1
| {{nml|0.4}}
|-
| <code style="color:green">signals_on_traffic_side</code>
| Yes
| 0 or 1
|
|-
| <code style="color:green">electrified_railways</code>
| Yes
| 0 or 1
|
|-
| <code style="color:green">unified_maglev</code>
| Yes
| {{ttdp|}} 0 .. 3 {{ottd|}} Always 3
|
|-
| <code style="color:green">temperate_snowline</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 0
|
|-
| <code style="color:green">dynamic_engines</code>
| Yes
| 0 or 1
|
|-
| <code style="color:green">variable_runningcosts</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newtrains</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newrvs</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newships</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newplanes</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newhouses</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newindustries</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newcargos</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">256_persistent_registers</code>
| Yes
| 0 or 1
| {{nml|0.5}}
|
|-
| <code style="color:green">inflation</code>
| Yes
| 0 or 1
| {{nml|0.7}} {{ottdp|1.11|no}}
|-
| <code style="color:green">map_seed</code>
| Yes
| 0 .. 4294967295
| {{nml|0.7}} {{ottd|12.0}}
|}

<references />

NML:General

2023-06-27T12:16:44Z

Telk: Update version_openttd() for 12.0

{{NMLNavPropVarCB}}

==General variables==

A number of global variables are available. Some are only available in switch-blocks, while others can be used in any expression. This is indicated by the second column in the following table:

{| class="wikitable sortable"
! name
! Available outside switch blocks
! Value range
! Comment
|-
| <code style="color:green">ttd_platform</code>
| Yes
| <code style="color:green">PLATFORM_TTDPATCH</code> or <code style="color:green">PLATFORM_OPENTTD</code>
|
|-
| <code style="color:green">ttdpatch_version</code>
| Yes
|
|
|-
| <code style="color:green">openttd_version</code>
| Yes
|
| Use <code style="color:green">version_openttd(MAJOR, MINOR, BUILD)</code> to test and compare for a release version and <code style="color:green">version_openttd(MAJOR, MINOR, BUILD, REVISION)</code> to test for a specific svn version of OpenTTD.<br />{{ottdp|1.9.0|no|ottdrev=r28004}}<code>REVISION</code> will always return a fixed value of 28004, as OpenTTD moved to git and svn revisions are no longer valid.<br />{{ottdp|12.0|no}} From 12.0, treat <code>MAJOR</code> as 1, such as <code>version_openttd(1, 12, 0)</code> for 12.0
|-
| <code style="color:green">current_palette</code>
| Yes
| <code style="color:green">PALETTE_DOS</code> or <code style="color:green">PALETTE_WIN</code>
|
|-
| <code style="color:green">current_date</code>
| No
| days since year 0
| Use <code style="color:green">date(year, month, day)</code> to compare with.
|-
| <code style="color:green">current_year</code>
| No
| 0 .. 5000000
|
|-
| <code style="color:green">current_month</code>
| No
| 0 .. 11
|
|-
| <code style="color:green">current_day_of_month</code>
| No
| 0 .. 30
|
|-
| <code style="color:green">current_day_of_year</code>
| No
| 0 .. 364 (365 in leap years)
|
|-
| <code style="color:green">is_leapyear</code>
| No
| 0 or 1
|
|-
| <code style="color:green">date_loaded</code>
| Yes
| days since year 0
| Set to the time of game load, which is the current date in single player, and the date the server started in multiplayer. This to prevent desyncs.
|-
| <code style="color:green">year_loaded</code>
| Yes
| years since year 0
| See <code style="color:green">date_loaded</code>.
|-
| <code style="color:green">starting_year</code>
| Yes
| years since year 0
| Years before 1920 are clamped to 1920
|-
| <code style="color:green">animation_counter</code>
| No
| 0 .. 65535
| Increased by 1 each tick
|-
| <code style="color:green">climate</code>
| Yes <ref name=gamechange>The value of these variables can change during the game. Reading them from a switch block (which reads the current value) may result in a different value than in the rest of the code (which is evaluated when the game is loaded).</ref>
| <code style="color:green">CLIMATE_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">TEMPERATE</code> <nowiki>|</nowiki> <code style="color:green">ARCTIC</code> <nowiki>|</nowiki> <code style="color:green">TROPICAL</code> <nowiki>|</nowiki> <code style="color:green">TOYLAND</code>]
|
|-
| <code style="color:green">game_mode</code>
| Yes
| <code style="color:green">GAMEMODE_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">MENU</code> <nowiki>|</nowiki> <code style="color:green">GAME</code> <nowiki>|</nowiki> <code style="color:green">EDITOR</code>]
|
|-
| <code style="color:green">loading_stage</code>
| Yes
| <code style="color:green">LOADING_STAGE_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">INITIALIZE</code> <nowiki>|</nowiki> <code style="color:green">RESERVE</code> <nowiki>|</nowiki> <code style="color:green">ACTIVATE</code> <nowiki>|</nowiki> <code style="color:green">TEST</code>]
| 'Phase' of the GRF loading process.
|-
| <code style="color:green">difficulty_level</code>
| Yes <ref name=gamechange />
| <code style="color:green">DIFFICULTY_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">EASY</code> <nowiki>|</nowiki> <code style="color:green">MEDIUM</code> <nowiki>|</nowiki> <code style="color:green">HARD</code> <nowiki>|</nowiki> <code style="color:green">CUSTOM</code>]
|
|-
| <code style="color:green">display_options</code>
| No
| bitmask of <code style="color:green">DISPLAY_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">TOWN_NAMES</code> <nowiki>|</nowiki> <code style="color:green">STATION_NAMES</code> <nowiki>|</nowiki> <code style="color:green">SIGNS</code> <nowiki>|</nowiki> <code style="color:green">ANIMATION</code> <nowiki>|</nowiki> <code style="color:green">FULL_DETAIL</code>]
| Use <code style="color:green">hasbit(display_options, DISPLAY_XXX)</code> to test a particular bit.
|-
| <code style="color:green">desert_paved_roads</code>
| Yes <ref name=readwrite>These variables can be written as well as read. Use a normal assignment, for example:

<pre style="color:blue">
traininfo_y_offset = -2;
</pre></ref>
| 0 or 1
| If 1, desert roads have pavement and street lights.
|-
| <code style="color:green">second_rocky_tileset</code>
| Yes <ref name=readwrite />
| 0 or 1
| {{ottdp|1.5|no|ottdrev=r27200}} If 1, rocky tiles are drawn using sprites from two ranges: 4023 - 4041 (always used) and 4042 - 4060 (used if enabled)
|-
| <code style="color:green">train_width_32_px</code>
| Yes <ref name=readwrite />
| 0 or 1
| If 1, train vehicles are 32 instead of 29 pixels wide in the depot view.
|-
| <code style="color:green">traininfo_y_offset</code>
| Yes <ref name=readwrite />
| -128 .. 127
| Used to correctly position the depot view of trains.
|-
| <code style="color:green">snowline_height</code>
| No
| {{nml|0.2}} 16 .. 120 in steps of 8, or 0xFF if no snow.
{{nml|0.3}} 0..max_tile_height, or 0xFF if no snow.
| {{nml|0.2}} One tile height is equivalent to 8 units.
{{nml|0.3}} It's the height in tiles.
|-
| <code style="color:green">traffic_side</code>
| Yes <ref name=gamechange />
| <code style="color:green">TRAFFIC_SIDE_LEFT</code> or <code style="color:green">TRAFFIC_SIDE_RIGHT</code>
|
|-
| <code style="color:green">freight_trains</code>
| Yes
| 1 .. 255
| Weight multiplier for freight trains
|-
| <code style="color:green">plane_speed</code>
| Yes
| 1 .. 4
| Speed multiplier for planes. Value of 1 is equal to the original speed (1/4), while 4 means that planes move at full speed (4/4)
|-
| <code style="color:green">ttdpatch_flags</code>
| Yes
|
|
|-
| <code style="color:green">current_callback</code>
| No
|
| Set to the ID of the current callback, useful for old-style callbacks.
|-
| <code style="color:green">extra_callback_info1</code>
| No
| Varies
| Extra callback information, meaning differs per callback.
|-
| <code style="color:green">extra_callback_info2</code>
| No
| Varies
| Extra callback information, meaning differs per callback.
|-
| <code style="color:green">last_computed_result</code>
| No
|
| Result of the last (previously evaluated) switch block.
|-
| <code style="color:green">base_sprite_2cc</code>
| Yes
| 0 .. 65535
| Base sprite for 2cc (dual company colour) colour-maps
|-
| <code style="color:green">base_sprite_foundations</code>
| Yes
| 0 .. 65535
| {{ottdp|1.4|no|ottdrev=r25230}} Base sprite for foundations. This sprite block does only contain the extra foundations from [[NML:Replace_new_sprites| replacenew]] type <code style="color:green">FOUNDATIONS_SLOPES_HALFTILES</code> or <code style="color:green">FOUNDATIONS_SLOPES</code>. It does not contain the default foundations of sprites 990 to 1003 (via replace)
|-
| <code style="color:green">base_sprite_shores</code>
| Yes
| 0 .. 65535
| {{ottdp|1.4|no|ottdrev=r25230}} Base sprite for shores. All coast sprites in the order of the [[Action5#0D_Coast_tile_sprites|16 sprites version]] of [[NML:Replace_new_sprites| replacenew]] type <code style="color:green">COAST_TILES</code>. Note that, it does not matter in which way the sprites were originally defined (whether via replacenew with 10 or 16 sprites, or via replace). The sprite block returned by this variable has always all sprites in the same order.
|-
| <code style="color:green">map_type</code>
| Yes
| <code style="color:green">MAP_TYPE_XXX</code> with <code style="color:green">XXX</code> = [<code style="color:green">RECTANGULAR</code> <nowiki>|</nowiki> <code style="color:green">X_BIGGER</code> <nowiki>|</nowiki> <code style="color:green">Y_BIGGER</code>]
|
|-
| <code style="color:green">map_min_edge</code>
| Yes
| 64 .. 4096
| Length of the smallest map edge (in tiles)
|-
| <code style="color:green">map_max_edge</code>
| Yes
| 64 .. 4096
| Length of the biggest map edge (in tiles)
|-
| <code style="color:green">map_x_edge</code>
| Yes
| 64 .. 4096
| Length of the x (top-left) map edge (in tiles)
|-
| <code style="color:green">map_y_edge</code>
| Yes
| 64 .. 4096
| Length of the y (top-right) map edge (in tiles)
|-
| <code style="color:green">map_size</code>
| Yes
| 64*64 .. 4096*4096
| Total number of tiles on the map
|-
| <code style="color:green">long_bridges</code>
| Yes
| 0 or 1
|
|-
| <code style="color:green">gradual_loading</code>
| Yes
| 0 or 1
|
|-
| <code style="color:green">bridge_speed_limits</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">wagon_speed_limits</code>
| Yes
| 0 or 1
| {{nml|0.4}}
|-
| <code style="color:green">signals_on_traffic_side</code>
| Yes
| 0 or 1
|
|-
| <code style="color:green">electrified_railways</code>
| Yes
| 0 or 1
|
|-
| <code style="color:green">unified_maglev</code>
| Yes
| {{ttdp|}} 0 .. 3 {{ottd|}} Always 3
|
|-
| <code style="color:green">temperate_snowline</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 0
|
|-
| <code style="color:green">dynamic_engines</code>
| Yes
| 0 or 1
|
|-
| <code style="color:green">variable_runningcosts</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newtrains</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newrvs</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newships</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newplanes</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newhouses</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newindustries</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">newcargos</code>
| Yes
| {{ttdp|}} 0 or 1 {{ottd|}} Always 1
|
|-
| <code style="color:green">256_persistent_registers</code>
| Yes
| 0 or 1
| {{nml|0.5}}
|
|-
| <code style="color:green">inflation</code>
| Yes
| 0 or 1
| {{nml|0.7}} {{ottdp|1.11|no}}
|-
| <code style="color:green">map_seed</code>
| Yes
| 0 .. 4294967295
| {{nml|0.7}} {{ottd|12.0}}
|}

<references />

NML:Replace new sprites

2021-05-08T17:39:52Z

Telk:

{{NMLNavBlocksyntax}}

Over time, several features have been added to OpenTTD that require new sprites. As these sprites are not present in the original base graphics and only found in the extra grf of each base set. They cannot be replaced using a normal <code style="color:darkgreen">replace</code> block. Instead, a <code style="color:darkgreen">replacenew</code> block has to be used. The semantics are like this:

replacenew [<block-name>](<type>, [<image-file>[, <offset>]]) {
[[NML:Realsprites|list of realsprites]]
}

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 <code style="color:darkgreen"><type></code> parameter indicates the type of sprites that will be replaced. It should be an identifier from the first column of the following table.

For information on what sprites are needed and in what order, it's generally best to look at the OpenGFX source [https://github.com/OpenTTD/OpenGFX/tree/master/sprites/extra], in the sprites/extra directory.

{| class="t"
! Type
! Number of sprites
|-
| PRE_SIGNAL
| 48
|-
| PRE_SIGNAL_SEMAPHORE
| 112
|-
| PRE_SIGNAL_SEMAPHORE_PBS
| 240
|-
| CATENARY
| 48
|-
| FOUNDATIONS_SLOPES
| 74
|-
| FOUNDATIONS_SLOPES_HALFTILES
| 90
|-

| CANALS
| 65
|-
| ONE_WAY_ROAD
| 6
|-
| COLOURMAP_2CC
| 256
|-
| TRAMWAY
| 113 {{ottdp|1.10|no}} {{nml|0.5}} 119
|-

| COAST_TILES
| 16<ref name="no_offset">This type does not support the use of an offset. Thus the exact amount of sprites must be supplied.</ref>
|-
| COAST_TILES_BASEGFX
| 10<ref name="no_offset" />
|-
| COAST_TILES_DIAGONAL
| 18<ref name="no_offset" />
|-

| SLOPED_RAILS
| 12
|-
| AIRPORTS
| 15
|-
| ROAD_STOPS
| 8
|-
| AQUEDUCTS
| 8
|-
| AUTORAIL
| 55
|-
| FLAGS
| 36
|-
| OTTD_GUI
| 191
|-
| AIRPORT_PREVIEW
| 9
|-
| RAILTYPE_TUNNELS
| 16
|-
| OTTD_RECOLOUR
| 1
|}

Parameter two <code style="color:darkgreen"><image-file></code> (optional) is a literal (quoted) string that specifies the default file where the sprites are located. This may be overridden per-sprite.

Parameter <code style="color:darkgreen"><offset></code> is optional and has a default value of 0. Setting this value sets an offset into the block of sprites, so only a subset of the sprites (starting at <code style="color:darkgreen">offset</code>) will be replaced. An offset is not allowed in the case of the sprite types marked with <ref name="no_offset" />. Don't use offsets, if you want you NewGRF compatible with TTDPatch.

<references />