NML:Tramtypes - Revision history

Rito12: /* Tramtype variables */ {{ottd|15.0}}

2026-01-04T14:28:46Z

Tramtype variables: {{ottd|15.0}}

← Older revision		Revision as of 14:28, 4 January 2026
Line 195:		Line 195:
	\| Label from the [[NML:Badgetable\|badgetable]].		\| Label from the [[NML:Badgetable\|badgetable]].
	\| [0 <nowiki>\|</nowiki> 1]		\| [0 <nowiki>\|</nowiki> 1]
	\| Check if the tram type has that specific badge attached.		\| {{ottd\|15.0}} Check if the tram type has that specific badge attached.
	\|}		\|}

Rito12: /* Example code */ badges

2026-01-04T13:39:27Z

Example code: badges

← Older revision		Revision as of 13:39, 4 January 2026
Line 332:		Line 332:
	construction_cost: 24; // Electric tramways are pricey		construction_cost: 24; // Electric tramways are pricey
	speed_limit: 50 km/h;		speed_limit: 50 km/h;
			badges: ["power/electric"];
	}		}
	graphics {		graphics {

Rito12: /* Tramtype variables */ has_badge

2026-01-04T13:37:36Z

Tramtype variables: has_badge

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

Rito12: /* Tramtype properties */ badges property

2026-01-03T21:50:26Z

Tramtype properties: badges property

← Older revision		Revision as of 21:50, 3 January 2026
Line 117:		Line 117:
	\| list of tramtype labels		\| list of tramtype labels
	\| List of tram types which this tram type will act as fallback for, if the corresponding tram type is not defined separately		\| List of tram types which this tram type will act as fallback for, if the corresponding tram type is not defined separately
			\|-
			\| badges
			\| Array of badge labels from the [[NML:Badgetable\|badgetable]].
			\| Since {{ottd\|15.0}}
	\|}		\|}

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

2026-01-03T17:58:54Z

Tramtype variables: document railtype, roadtype, tramtype variables

@@ Line 169: / Line 169: @@
+|
 | 2 pseudo random bits
 |}

Heresy: Changed the appropriate tables from t to sortable.

2022-08-30T21:43:36Z

Changed the appropriate tables from t to sortable.

← Older revision		Revision as of 21:43, 30 August 2022
Line 31:		Line 31:
	==Tramtype properties==		==Tramtype properties==

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

	{\| class="t"		{\| class="wikitable sortable"
	! name		! name
	! value range		! value range
Line 175:		Line 175:
	For tram types a number of callbacks are used to define tram type graphics. Each should refer to a sprite set containing the relevant sprites. Refer to the [[#Example sprites\|example sprites]] or the example tramtype grf in the NML repository, for an example on what sprites are needed in what order.		For tram types a number of callbacks are used to define tram type graphics. Each should refer to a sprite set containing the relevant sprites. Refer to the [[#Example sprites\|example sprites]] or the example tramtype 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

Frosch: maximum is 63 types

2020-04-27T18:35:48Z

maximum is 63 types

← Older revision		Revision as of 18:35, 27 April 2020
Line 5:		Line 5:

	==Tramtype IDs==		==Tramtype IDs==
	Tramtypes and Roadtypes share a pool of 64 IDs. Either feature can use as many IDs as needed (i.e. it is not limited to 32 per type), but both features combined are limited to 64 in total. NewGRF-local IDs may freely be chosen, but must be in the 0..63 range. If other tramtype/roadtype GRFs are loaded, it may be that there are not enough slots available. To prevent your entire NewGRF from being deactivated with the 'Attempt to use invalid ID'-error, you can use the following code:		Tramtypes and Roadtypes share a pool of 63 IDs. Either feature can use as many IDs as needed (i.e. it is not limited to 32 per type), but both features combined are limited to 63 in total. NewGRF-local IDs may freely be chosen, but must be in the 0..62 range. If other tramtype/roadtype GRFs are loaded, it may be that there are not enough 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 (tramtype_available("LABL") \|\| loading_stage == LOADING_STAGE_RESERVE)		if (tramtype_available("LABL") \|\| loading_stage == LOADING_STAGE_RESERVE)

Andrew350: /* Tramtype IDs */ typo

2019-12-28T08:39:25Z

Tramtype IDs: typo

← Older revision		Revision as of 08:39, 28 December 2019
Line 5:		Line 5:

	==Tramtype IDs==		==Tramtype IDs==
	Tramtypes and Roadtypes share a pool of 64 IDs. Either feature can use as many IDs as needed (i.e. it is not limited to 32 per type), but both features combined are limited to 64 in total. NewGRF-local IDs may freely be chosen, but must be in the 0..63 range. If other tramtype/~~tramtype~~ GRFs are loaded, it may be that there are not enough slots available. To prevent your entire NewGRF from being deactivated with the 'Attempt to use invalid ID'-error, you can use the following code:		Tramtypes and Roadtypes share a pool of 64 IDs. Either feature can use as many IDs as needed (i.e. it is not limited to 32 per type), but both features combined are limited to 64 in total. NewGRF-local IDs may freely be chosen, but must be in the 0..63 range. If other tramtype/roadtype GRFs are loaded, it may be that there are not enough 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 (tramtype_available("LABL") \|\| loading_stage == LOADING_STAGE_RESERVE)		if (tramtype_available("LABL") \|\| loading_stage == LOADING_STAGE_RESERVE)

Andrew350: various fixes and clean up

2019-12-28T08:37:56Z

various fixes and clean up

← Older revision		Revision as of 08:37, 28 December 2019
Line 1:		Line 1:
	{{NMLNavPropVarCB}}		{{NMLNavPropVarCB}}

	Tramtypes can only be defined in OpenTTD {{ottd\|1.10}} or later.		Tramtypes can only be defined in OpenTTD {{ottd\|1.10}} and {{nml\|0.5}} or later.


Line 19:		Line 19:
	Generally, the vehicle defines which tramtype it is, and the tramtypes define the compatibility between each other.		Generally, the vehicle defines which tramtype it is, and the tramtypes define the compatibility between each other.
	* Remember that the road vehicle flag 'ROADVEH_FLAG_TRAM' must be set in order for a road vehicle to be considered a tram.		* Remember that the road vehicle flag 'ROADVEH_FLAG_TRAM' must be set in order for a road vehicle to be considered a tram.
	* A vehicle exists, if its tramtype (~~tram~~ vehicle property <code style="color:green">~~track_type~~</code>) is defined. Otherwise the vehicle is disabled.		* A vehicle exists, if its tramtype (road vehicle property <code style="color:green">tram_type</code>) is defined. Otherwise the vehicle is disabled.
	* When a vehicle is introduced, it always introduces its tramtype (~~tram~~ vehicle property <code style="color:green">~~track_type~~</code>).		* When a vehicle is introduced, it always introduces its tramtype (road vehicle property <code style="color:green">tram_type</code>).
	* A tramtype is introduced, if at least one of the following conditions is met:		* A tramtype is introduced, if at least one of the following conditions is met:
	** A vehicle is introduced, that references the tramtype (~~tram~~ vehicle property <code style="color:green">~~track_type~~</code>).		** A vehicle is introduced, that references the tramtype (road vehicle property <code style="color:green">tram_type</code>).
	** Another tramtype is introduced, that references the tramtype via the introduced tramtype list (tramtype property <code style="color:green">introduces_tramtype_list</code>).		** Another tramtype is introduced, that references the tramtype via the introduced tramtype list (tramtype property <code style="color:green">introduces_tramtype_list</code>).
	** The introduction date (tramtype property <code style="color:green">introduction_date</code>) is passed and all required tramtypes (tramtype property <code style="color:green">requires_tramtype_list </code>) are available.		** The introduction date (tramtype property <code style="color:green">introduction_date</code>) is passed and all required tramtypes (tramtype property <code style="color:green">requires_tramtype_list </code>) are available.

	Via tramtype property <code style="color:green">powered_tramtype_list</code> multiple tramtypes can be defined, which shall be considered equivalent to a tramtype.		Via tramtype property <code style="color:green">powered_tramtype_list</code> multiple tramtypes can be defined, which shall be considered equivalent to a tramtype.
	This affects the interpretation of ~~tram~~ vehicle property <code style="color:green">~~track_type~~</code>. If ~~tram~~ vehicle property <code style="color:green">~~track_type~~</code> references an undefined tramtype, then		This affects the interpretation of road vehicle property <code style="color:green">tram_type</code>. If road vehicle property <code style="color:green">tram_type</code> references an undefined tramtype, then tramtype property <code style="color:green">powered_tramtype_list</code> is checked for all defined tramtypes, whether the vehicle can be reassigned to some other tramtype. Otherwise the vehicle is disabled.
	tramtype property <code style="color:green">powered_tramtype_list</code> is checked for all defined tramtypes, whether the vehicle can be reassigned to some other tramtype.
	Otherwise the vehicle is disabled.

	==Tramtype properties==		==Tramtype properties==
Line 72:		Line 70:
	\| powered_tramtype_list		\| powered_tramtype_list
	\| list of tramtype labels		\| list of tramtype labels
	\| Provide a list of tram types that tram vehicles of this type are powered on, e.g. ["RAIL", "ELRL"]. Note that there is no difference between "powered" and "compatible" for tramtypes		\| Provide a list of tram types that tram vehicles of this type are powered on, e.g. ["RAIL", "ELRL"]. Note that there is no "compatible_tramtype_list" since there is no difference between "powered" and "compatible" for tramtypes
	\|-		\|-
	\| tramtype_flags		\| tramtype_flags
Line 84:		Line 82:
	:Disallows house construction		:Disallows house construction
	;HIDDEN		;HIDDEN
	:Hides the tramtype from players, but remains available to towns		:Hides the tramtype from players, but remains available to towns...which can't use them
	;TOWN_BUILD		;TOWN_BUILD
	:Towns don't build tramtracks...so what ~~does~~ this ~~do???~~		:Towns don't build tramtracks...so not sure what the purpose of this is
	\|-		\|-
	\| construction_cost		\| construction_cost
Line 151:		Line 149:
	\| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW		\| TILETYPE_NORMAL, TILETYPE_DESERT, TILETYPE_RAIN_FOREST, TILETYPE_SNOW
	\|		\|
			\|-
			\| enhanced_tunnels
			\| 0
			\| 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 189:		Line 191:
	\| 19		\| 19
	\| 11 track combinations, 4 slopes, and 4 dead ends. These sprites are required		\| 11 track combinations, 4 slopes, and 4 dead ends. These sprites are required
			<!--
	\|-		\|-
	\| tunnels<ref name=leftout />		\| tunnels<ref name=leftout />
	\| 4		\| 4
	\| 1 sprite for each direction. Sprite is overlay for tram in existing tunnel graphics. The original ground sprite is drawn, then the overlay, then possibly a tram vehicle and the original tunnel head is drawn over the top. This keeps compatibility with different landscape types. Sprite order: SW, NW, NE, SE.		\| 1 sprite for each direction. Sprite is overlay for tram in existing tunnel graphics. The original ground sprite is drawn, then the overlay, then possibly a tram vehicle and the original tunnel head is drawn over the top. This keeps compatibility with different landscape types. Sprite order: SW, NW, NE, SE.
			-->
	\|-		\|-
	\| catenary_front		\| catenary_front
Line 220:		Line 224:

	<references />		<references />
	Note that there is no "default graphics" callback.		Note that there is no "default" graphics callback.

	===Example sprites===		===Example sprites===

Andrew350: added two tramtype_flags

2019-12-22T12:25:03Z

added two tramtype_flags

← Older revision		Revision as of 12:25, 22 December 2019
Line 83:		Line 83:
	;NO_HOUSES		;NO_HOUSES
	:Disallows house construction		:Disallows house construction
			;HIDDEN
			:Hides the tramtype from players, but remains available to towns
			;TOWN_BUILD
			:Towns don't build tramtracks...so what does this do???
	\|-		\|-
	\| construction_cost		\| construction_cost