NML:General
From GRFSpecs
Revision as of 09:45, 28 May 2022 by Andythenorth (talk | contribs) (0xFFFFFFFF might be better written as 4294967295 here)
Vehicles, Stations, Canals, Bridges, Towns, Houses, Industries (Tiles), Cargos, Airports+Tiles, Objects, Railtypes, Roadtypes, Tramtypes, Terrain
- common props | vars | CBs
- train | roadveh | ship | aircr props
- common variables
- industry props | vars | CBs
- tile props | vars | CBs
- airport props | vars | CBs
- tile props | vars | CBs
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:
| name | Available outside switch blocks | Value range | Comment | |
|---|---|---|---|---|
ttd_platform
|
Yes | PLATFORM_TTDPATCH or PLATFORM_OPENTTD
|
||
ttdpatch_version
|
Yes | |||
openttd_version
|
Yes | Use version_openttd(MAJOR, MINOR, BUILD) to test and compare for a release version and version_openttd(MAJOR, MINOR, BUILD, REVISION) to test for a specific svn version of OpenTTD.  1.9.0  REVISION will always return a fixed value of 28004, as OpenTTD moved to git and svn revisions are no longer valid.
| ||
current_palette
|
Yes | PALETTE_DOS or PALETTE_WIN
|
||
current_date
|
No | days since year 0 | Use date(year, month, day) to compare with.
| |
current_year
|
No | 0 .. 5000000 | ||
current_month
|
No | 0 .. 11 | ||
current_day_of_month
|
No | 0 .. 30 | ||
current_day_of_year
|
No | 0 .. 364 (365 in leap years) | ||
is_leapyear
|
No | 0 or 1 | ||
date_loaded
|
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. | |
year_loaded
|
Yes | years since year 0 | See date_loaded.
| |
starting_year
|
Yes | years since year 0 | Years before 1920 are clamped to 1920 | |
animation_counter
|
No | 0 .. 65535 | Increased by 1 each tick | |
climate
|
Yes [1] | CLIMATE_XXX with XXX = [TEMPERATE | ARCTIC | TROPICAL | TOYLAND]
|
||
game_mode
|
Yes | GAMEMODE_XXX with XXX = [MENU | GAME | EDITOR]
|
||
loading_stage
|
Yes | LOADING_STAGE_XXX with XXX = [INITIALIZE | RESERVE | ACTIVATE | TEST]
|
'Phase' of the GRF loading process. | |
difficulty_level
|
Yes [1] | DIFFICULTY_XXX with XXX = [EASY | MEDIUM | HARD | CUSTOM]
|
||
display_options
|
No | bitmask of DISPLAY_XXX with XXX = [TOWN_NAMES | STATION_NAMES | SIGNS | ANIMATION | FULL_DETAIL]
|
Use hasbit(display_options, DISPLAY_XXX) to test a particular bit.
| |
desert_paved_roads
|
Yes [2] | 0 or 1 | If 1, desert roads have pavement and street lights. | |
second_rocky_tileset
|
Yes [2] | 0 or 1 | 1.5 If 1, rocky tiles are drawn using sprites from two ranges: 4023 - 4041 (always used) and 4042 - 4060 (used if enabled)
| |
train_width_32_px
|
Yes [2] | 0 or 1 | If 1, train vehicles are 32 instead of 29 pixels wide in the depot view. | |
traininfo_y_offset
|
Yes [2] | -128 .. 127 | Used to correctly position the depot view of trains. | |
snowline_height
|
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. | |
traffic_side
|
Yes [1] | TRAFFIC_SIDE_LEFT or TRAFFIC_SIDE_RIGHT
|
||
freight_trains
|
Yes | 1 .. 255 | Weight multiplier for freight trains | |
plane_speed
|
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) | |
ttdpatch_flags
|
Yes | |||
current_callback
|
No | Set to the ID of the current callback, useful for old-style callbacks. | ||
extra_callback_info1
|
No | Varies | Extra callback information, meaning differs per callback. | |
extra_callback_info2
|
No | Varies | Extra callback information, meaning differs per callback. | |
last_computed_result
|
No | Result of the last (previously evaluated) switch block. | ||
base_sprite_2cc
|
Yes | 0 .. 65535 | Base sprite for 2cc (dual company colour) colour-maps | |
base_sprite_foundations
|
Yes | 0 .. 65535 | 1.4 Base sprite for foundations. This sprite block does only contain the extra foundations from replacenew type FOUNDATIONS_SLOPES_HALFTILES or FOUNDATIONS_SLOPES. It does not contain the default foundations of sprites 990 to 1003 (via replace)
| |
base_sprite_shores
|
Yes | 0 .. 65535 | 1.4 Base sprite for shores. All coast sprites in the order of the 16 sprites version of replacenew type COAST_TILES. 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.
| |
map_type
|
Yes | MAP_TYPE_XXX with XXX = [RECTANGULAR | X_BIGGER | Y_BIGGER]
|
||
map_min_edge
|
Yes | 64 .. 4096 | Length of the smallest map edge (in tiles) | |
map_max_edge
|
Yes | 64 .. 4096 | Length of the biggest map edge (in tiles) | |
map_x_edge
|
Yes | 64 .. 4096 | Length of the x (top-left) map edge (in tiles) | |
map_y_edge
|
Yes | 64 .. 4096 | Length of the y (top-right) map edge (in tiles) | |
map_size
|
Yes | 64*64 .. 4096*4096 | Total number of tiles on the map | |
long_bridges
|
Yes | 0 or 1 | ||
gradual_loading
|
Yes | 0 or 1 | ||
bridge_speed_limits
|
Yes |  0 or 1 Always 1
|
||
wagon_speed_limits
|
Yes | 0 or 1 | NML 0.4 | |
signals_on_traffic_side
|
Yes | 0 or 1 | ||
electrified_railways
|
Yes | 0 or 1 | ||
unified_maglev
|
Yes | 0 .. 3 Always 3
|
||
temperate_snowline
|
Yes | 0 or 1 Always 0
|
||
dynamic_engines
|
Yes | 0 or 1 | ||
variable_runningcosts
|
Yes | 0 or 1 Always 1
|
||
newtrains
|
Yes | 0 or 1 Always 1
|
||
newrvs
|
Yes | 0 or 1 Always 1
|
||
newships
|
Yes | 0 or 1 Always 1
|
||
newplanes
|
Yes | 0 or 1 Always 1
|
||
newhouses
|
Yes | 0 or 1 Always 1
|
||
newindustries
|
Yes | 0 or 1 Always 1
|
||
newcargos
|
Yes | 0 or 1 Always 1
|
||
256_persistent_registers
|
Yes | 0 or 1 | NML 0.5 | |
inflation
|
Yes | 0 or 1 | NML 0.7 1.11
| |
map_seed
|
Yes | 0 .. 4294967295 | NML 0.7 12.0
|
- ↑ 1.0 1.1 1.2 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).
- ↑ 2.0 2.1 2.2 2.3 These variables can be written as well as read. Use a normal assignment, for example:
traininfo_y_offset = -2;
