NML:Railtypes - Revision history

Rito12: /* Railtype variables */ has_badge

2026-01-04T15:04:55Z

Railtype variables: has_badge

@@ Line 269: / Line 269: @@
 | Entry from tramtype translation table or TRAMTYPE_OTHER_GRF or TRAMTYPE_NO_ROAD
 | tramtype present on the tile
 |}

Rito12: /* Railtype variables */

2026-01-04T13:17:16Z

Railtype variables

← Older revision		Revision as of 13:17, 4 January 2026
Line 269:		Line 269:
	\| Entry from tramtype translation table or TRAMTYPE_OTHER_GRF or TRAMTYPE_NO_ROAD		\| Entry from tramtype translation table or TRAMTYPE_OTHER_GRF or TRAMTYPE_NO_ROAD
	\| tramtype present on the tile		\| tramtype present on the tile
	\|-
	\|}		\|}

Rito12: /* Railtype properties */ badges property

2026-01-03T21:49:16Z

Railtype properties: badges property

← Older revision		Revision as of 21:49, 3 January 2026
Line 147:		Line 147:
	\|		\|
	{{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		{{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
			\|-
			\| badges
			\| Array of badge labels from the [[NML:Badgetable\|badgetable]].
			\| {{ottd\|15.0}}
	\|}		\|}

Andythenorth: /* Railtype variables */ document railtype, roadtype, tramtype

2026-01-03T17:56:36Z

Railtype variables: document railtype, roadtype, tramtype

@@ Line 253: / Line 253: @@
+|
 | 2 pseudo-random bits, based on tile location
 |}

Andythenorth at 15:20, 9 December 2023

2023-12-09T15:20:23Z

← Older revision		Revision as of 15:20, 9 December 2023
Line 29:		Line 29:
	railtype property <code style="color:green">compatible_railtype_list</code> is checked for all defined railtypes, whether the vehicle can be reassigned to some other railtype.		railtype property <code style="color:green">compatible_railtype_list</code> is checked for all defined railtypes, whether the vehicle can be reassigned to some other railtype.
	Otherwise the vehicle is disabled. However note also that <code style="color:green">alternative_railtype_list</code> provides an alternative/complementary approach to handling undefined railtypes.		Otherwise the vehicle is disabled. However note also that <code style="color:green">alternative_railtype_list</code> provides an alternative/complementary approach to handling undefined railtypes.

			Note that when routing trains onto railtypes, the compatibility is only evaluated for the lead engine of a consist. This means that trains will run on incompatible rail types if they are in a consist where the lead engine is compatible with the rail type. This applies to both engines and wagons.


	==Railtype properties==		==Railtype properties==
Line 72:		Line 75:
	\| compatible_railtype_list		\| compatible_railtype_list
	\| list of railtype labels		\| list of railtype labels
	\| Provide a list of rail types that trains of this type can also run on. e.g. ["RAIL", "ELRL", "MONO"]		\| Provide a list of rail types that trains of this type can also run on. e.g. ["RAIL", "ELRL", "MONO"]. Note that when routing trains, the compatibility is only evaluated for the lead engine of a consist. This means that trains will run on incompatible rail types if they are in a consist where the lead engine is compatible with the rail type. This applies to both engines and wagons.
	\|-		\|-
	\| powered_railtype_list		\| powered_railtype_list

Heresy: Changed the appropriate tables from t to sortable.

2022-08-30T21:36:02Z

Changed the appropriate tables from t to sortable.

← Older revision		Revision as of 21:36, 30 August 2022
Line 32:		Line 32:
	==Railtype properties==		==Railtype properties==

	{\| class="t"		{\| class="wikitable sortable"
	! property		! property
	! value range		! value range
Line 222:		Line 222:
	==Railtype variables==		==Railtype variables==

	{\| class="t"		{\| class="wikitable sortable"
	! name		! name
	! value range		! value range
Line 256:		Line 256:
	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.		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"		{\| class="wikitable sortable"
	! callbacks		! callbacks
	! number of sprites		! number of sprites

Andythenorth at 18:17, 7 May 2022

2022-05-07T18:17:15Z

← Older revision		Revision as of 18:17, 7 May 2022
Line 28:		Line 28:
	This affects the interpretation of train property <code style="color:green">track_type</code>. If train property <code style="color:green">track_type</code> references an undefined railtype, then		This affects the interpretation of train property <code style="color:green">track_type</code>. If train property <code style="color:green">track_type</code> references an undefined railtype, then
	railtype property <code style="color:green">compatible_railtype_list</code> is checked for all defined railtypes, whether the vehicle can be reassigned to some other railtype.		railtype property <code style="color:green">compatible_railtype_list</code> is checked for all defined railtypes, whether the vehicle can be reassigned to some other railtype.
			Otherwise the vehicle is disabled. However note also that <code style="color:green">alternative_railtype_list</code> provides an alternative/complementary approach to handling undefined railtypes.
	Otherwise the vehicle is disabled.

	==Railtype properties==		==Railtype properties==

Andrew350: /* Railtype variables */ added random_bits and clarified description of enhanced_tunnels

2019-12-28T06:21:17Z

Railtype variables: added random_bits and clarified description of enhanced_tunnels

← Older revision		Revision as of 06:21, 28 December 2019
Line 233:		Line 233:
	\| enhanced_tunnels		\| enhanced_tunnels
	\| 0		\| 0
	\| ~~should~~ custom tunnel entrances be ~~modified~~ other values than 0 might be returned		\| Reserved for future use, always returns 0 in OpenTTD. Should custom tunnel entrances be implemented, other values than 0 might be returned
	\|-		\|-
	\| level_crossing_status		\| level_crossing_status
Line 245:		Line 245:
	\| town_zone		\| town_zone
	\| [[NML:List of town zones\|town zone]]		\| [[NML:List of town zones\|town zone]]
	\| Town zone of the tile. (Only available for level crossings and depots.)		\| Town zone of the tile. (Only available for level crossings and depots.)
			\|-
			\| random_bits
			\|
			\| 2 pseudo-random bits, based on tile location
	\|}		\|}

Andrew350: added new flags and callbacks for 1.9 / 1.10

2019-12-22T14:57:46Z

added new flags and callbacks for 1.9 / 1.10

@@ Line 80: / Line 80: @@
 | railtype_flags
 | bitmask(RAILTYPE_FLAG_XXX, ...)
 |-
 | curve_speed_multiplier
@@ Line 293: / Line 305: @@
 | 8
 | {{ottd|1.3|r24367}} 1 sprite for each direction, order is SW(-facing), NE, NW, SE, E, W, S, N. For more information, see [[#signals|below]]
 |}
@@ Line 483: / Line 499: @@
 |}
 </li></ul>
 ===Example code===

Andrew350: updated for 64 railtypes and fixed a few typos

2019-12-22T12:40:48Z

updated for 64 railtypes and fixed a few typos

← Older revision		Revision as of 12:40, 22 December 2019
Line 5:		Line 5:

	==Railtype IDs==		==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:		Railtype IDs are limited to 64 in total. NewGRF-local IDs may freely be chosen, but must be in the 0..63 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)		if (railtype_available("LABL") \|\| loading_stage == LOADING_STAGE_RESERVE)
Line 124:		Line 124:
	\|-		\|-
	\| maintenance_cost		\| maintenance_cost
			\| 0 ... 255
	\|
	\|		\|
	{{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.		{{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.
Line 498:		Line 498:
	new_engine_text: string(STR_NEW_ENGINE);		new_engine_text: string(STR_NEW_ENGINE);
	compatile_railtype_list: ["SHIN","RAIL","ELRL"]; // Tracks of rail and electrified rail are compatible		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		powered_railtype_list: ["ELRL","SHIN"]; // But we only have power when we have electricity
	railtype_flags: bitmask(RAILTYPE_FLAG_NO_LEVEL_CROSSING); // High speed tracks should not have level crossings		railtype_flags: bitmask(RAILTYPE_FLAG_NO_LEVEL_CROSSING); // High speed tracks should not have level crossings
	curve_speed_multiplier: 1;		curve_speed_multiplier: 1;
Line 510:		Line 510:
	underlay: ground_switch_underlay; // defines the usual tracks and the underlay for junctions		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		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		tunnels: tunnel_switch; // defines the tracks drawn on a tunnel tile
	depots: depot_switch_electric; // defines the depot sprites		depots: depot_switch_electric; // defines the depot sprites
	bridge_surfaces: bridge_terrain_switch; // defines the overlay drawn over bridges		bridge_surfaces: bridge_terrain_switch; // defines the overlay drawn over bridges
	fences: fences_set; // defines the look of fences		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.		// we don't define catenary wire and pylons, thus we use the default which comes with the base graphics.
	}		}
	}		}