NMLTutorial/Train four part refit - Revision history

Brickblock1: /* Total code so far */

2026-01-24T17:15:52Z

Total code so far

← Older revision		Revision as of 17:15, 24 January 2026
Line 424:		Line 424:
	tractive_effort_coefficient: 0.3 / 3; // changed by callback		tractive_effort_coefficient: 0.3 / 3; // changed by callback
	air_drag_coefficient: 0.06;		air_drag_coefficient: 0.06;
	~~shorten_vehicle~~: ~~SHORTEN_TO_8_8~~;		length: 8;
	// Overridden by callback to disable for non-powered wagons:		// Overridden by callback to disable for non-powered wagons:
	visual_effect_and_powered: visual_effect_and_powered(VISUAL_EFFECT_ELECTRIC, 2, DISABLE_WAGON_POWER);		visual_effect_and_powered: visual_effect_and_powered(VISUAL_EFFECT_ELECTRIC, 2, DISABLE_WAGON_POWER);

Frosch: c&p error between cargo subtypes and artic parts

2013-12-08T13:37:15Z

c&p error between cargo subtypes and artic parts

← Older revision		Revision as of 13:37, 8 December 2013
Line 28:		Line 28:
	</pre>		</pre>

	The switch itself will use the <code>cargo_subtype</code> [http://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Vehicle_variables variable]. This variable starts at 0 and will be increased by 1 until the callback returns <code>~~CB_RESULT_NO_MORE_ARTICULATED_PARTS~~</code>. Return strings to use as cargo subtype. Each returned string will be a separate cargo subtype:		The switch itself will use the <code>cargo_subtype</code> [http://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Vehicle_variables variable]. This variable starts at 0 and will be increased by 1 until the callback returns <code>CB_RESULT_NO_TEXT</code>. Return strings to use as cargo subtype. Each returned string will be a separate cargo subtype:

	<pre style="color:darkblue; white-space: pre-wrap">		<pre style="color:darkblue; white-space: pre-wrap">
Line 34:		Line 34:
	0: return string(STR_ICM_SUBTYPE_3_PART);		0: return string(STR_ICM_SUBTYPE_3_PART);
	1: return string(STR_ICM_SUBTYPE_4_PART);		1: return string(STR_ICM_SUBTYPE_4_PART);
	return ~~CB_RESULT_NO_MORE_ARTICULATED_PARTS~~;		return CB_RESULT_NO_TEXT;
	}		}
	</pre>		</pre>
Line 44:		Line 44:
	STR_ICM_SUBTYPE_4_PART : (4 parts)		STR_ICM_SUBTYPE_4_PART : (4 parts)
	</pre>		</pre>


	== Graphics ==		== Graphics ==

Supercheese: /* What's going to happen */ There is a way to charge for refits, but it has some issues

2012-09-15T19:35:12Z

What's going to happen: There is a way to charge for refits, but it has some issues

← Older revision		Revision as of 19:35, 15 September 2012
Line 11:		Line 11:
	The method used to do this is actually the other way round than the user will think from the behaviour ingame. The train will be changed to a four part EMU. For the (default) three part refit one of these four parts will be hidden. A lot of switches will be used to make the train look right, make it have the correct capacity, power, weight, running costs and tractive effort.		The method used to do this is actually the other way round than the user will think from the behaviour ingame. The train will be changed to a four part EMU. For the (default) three part refit one of these four parts will be hidden. A lot of switches will be used to make the train look right, make it have the correct capacity, power, weight, running costs and tractive effort.

	There are some drawbacks to this method. There's no way to charge the ~~user~~ for ~~puchasing~~ the extra vehicle part. Also autoreplacing will be difficult, as there's no way for the user to select which vehicle length they want. For that reason the author of this tutorial thinks making two different vehicles and having both available from the purchase menu is a better solution, but this method is a good illustration for some of the more advanced features of NML. It's up to you to decide which implementation you think is best for your vehicles.		There are some drawbacks to this method. There is a way to charge the player for the extra vehicle part, but it has some issues, and we shall not bother with it here (if you want more details, feel free to check out [http://www.tt-forums.net/viewtopic.php?f=26&t=62672#p1046538 the source code of the Fake Subways GRF]). Also autoreplacing will be difficult, as there's no way for the user to select which vehicle length they want. For that reason the author of this tutorial thinks making two different vehicles and having both available from the purchase menu is a better solution, but this method is a good illustration for some of the more advanced features of NML. It's up to you to decide which implementation you think is best for your vehicles.

	What we'll be doing:		What we'll be doing:

Supercheese: /* What's going to happen */ Fixing typo

2012-09-10T01:37:11Z

What's going to happen: Fixing typo

← Older revision		Revision as of 01:37, 10 September 2012
Line 11:		Line 11:
	The method used to do this is actually the other way round than the user will think from the behaviour ingame. The train will be changed to a four part EMU. For the (default) three part refit one of these four parts will be hidden. A lot of switches will be used to make the train look right, make it have the correct capacity, power, weight, running costs and tractive effort.		The method used to do this is actually the other way round than the user will think from the behaviour ingame. The train will be changed to a four part EMU. For the (default) three part refit one of these four parts will be hidden. A lot of switches will be used to make the train look right, make it have the correct capacity, power, weight, running costs and tractive effort.

	There are some drawbacks to this method. There's no way to charge the user for puchasing the extra vehicle part. Also autoreplacing will be difficult, as there's ~~now~~ way for the user to select which vehicle length they want. For that reason the author of this tutorial thinks making two different vehicles and having both available from the purchase menu is a better solution, but this method is a good illustration for some of the more advanced features of NML. It's up to you to decide which implementation you think is best for your vehicles.		There are some drawbacks to this method. There's no way to charge the user for puchasing the extra vehicle part. Also autoreplacing will be difficult, as there's no way for the user to select which vehicle length they want. For that reason the author of this tutorial thinks making two different vehicles and having both available from the purchase menu is a better solution, but this method is a good illustration for some of the more advanced features of NML. It's up to you to decide which implementation you think is best for your vehicles.

	What we'll be doing:		What we'll be doing:
Line 18:		Line 18:
	* Add callbacks to supply the correct vehicle properties;		* Add callbacks to supply the correct vehicle properties;
	* Make the purchase menu display the correct values.		* Make the purchase menu display the correct values.


	== Refit option ==		== Refit option ==

FooBar: use length instead of shorten_vehicle

2012-05-03T16:53:45Z

use length instead of shorten_vehicle

← Older revision		Revision as of 16:53, 3 May 2012
Line 103:		Line 103:
	If you were to encode the result so far as a NewGRF, you end up with a three part train that has a big gap between the second and last part. This is because it's essentially still a four part vehicle, just with no graphics for the third part. This can be solved by changing the length of the two middle parts. If we make the second part (7/8) long and the third part (1/8), both together are a full wagon length, completely hiding the invisible third part.		If you were to encode the result so far as a NewGRF, you end up with a three part train that has a big gap between the second and last part. This is because it's essentially still a four part vehicle, just with no graphics for the third part. This can be solved by changing the length of the two middle parts. If we make the second part (7/8) long and the third part (1/8), both together are a full wagon length, completely hiding the invisible third part.

	This is done by means of the <code>~~shorten_vehicle~~</code> [http://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Vehicle_callbacks callback], referencing a switch block as we first need to differentiate between the two cargo subtypes and then by the position in consist. Reference the switch block from the graphics block:		This is done by means of the <code>length</code> [http://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Vehicle_callbacks callback], referencing a switch block as we first need to differentiate between the two cargo subtypes and then by the position in consist. Reference the switch block from the graphics block:

	<pre style="color:darkblue; white-space: pre-wrap">		<pre style="color:darkblue; white-space: pre-wrap">
	~~shorten_vehicle~~: sw_icm_shorten_vehicle;		length: sw_icm_shorten_vehicle;
	</pre>		</pre>

Line 116:		Line 116:
	/* In the three part version, shorten the 2nd vehicle to 7/8 and the 3rd to 1/8		/* In the three part version, shorten the 2nd vehicle to 7/8 and the 3rd to 1/8
	* The rear (1/8) part is then made invisisble */		* The rear (1/8) part is then made invisisble */
	1: return ~~SHORTEN_TO_7_8~~;		1: return 7;
	2: return ~~SHORTEN_TO_1_8~~;		2: return 1;
	return ~~SHORTEN_TO_8_8~~;		return 8;
	}		}

	switch(FEAT_TRAINS, SELF, sw_icm_shorten_vehicle, cargo_subtype) {		switch(FEAT_TRAINS, SELF, sw_icm_shorten_vehicle, cargo_subtype) {
	0: sw_icm_shorten_3_part_vehicle;		0: sw_icm_shorten_3_part_vehicle;
	return ~~SHORTEN_TO_8_8~~; // 4-part vehicle needs no shortening		return 8; // 4-part vehicle needs no shortening
	}		}
	</pre>		</pre>
Line 361:		Line 361:
	/* In the three part version, shorten the 2nd vehicle to 7/8 and the 3rd to 1/8		/* In the three part version, shorten the 2nd vehicle to 7/8 and the 3rd to 1/8
	* The rear (1/8) part is then made invisisble */		* The rear (1/8) part is then made invisisble */
	1: return ~~SHORTEN_TO_7_8~~;		1: return 7;
	2: return ~~SHORTEN_TO_1_8~~;		2: return 1;
	return ~~SHORTEN_TO_8_8~~;		return 8;
	}		}

	switch(FEAT_TRAINS, SELF, sw_icm_shorten_vehicle, cargo_subtype) {		switch(FEAT_TRAINS, SELF, sw_icm_shorten_vehicle, cargo_subtype) {
	0: sw_icm_shorten_3_part_vehicle;		0: sw_icm_shorten_3_part_vehicle;
	return ~~SHORTEN_TO_8_8~~; // 4-part vehicle needs no shortening		return 8; // 4-part vehicle needs no shortening
	}		}

Line 448:		Line 448:
	* i.e. divide the capacity of three cars across four */		* i.e. divide the capacity of three cars across four */
	purchase_cargo_capacity: return 36 * 3 / 4;		purchase_cargo_capacity: return 36 * 3 / 4;
		⚫	length: sw_icm_shorten_vehicle;
	/* Only the front vehicle has a visual effect */
⚫	~~shorten_vehicle~~: sw_icm_shorten_vehicle;
	/* Only the front vehicle has power */		/* Only the front vehicle has power */
	power: sw_icm_power;		power: sw_icm_power;

FooBar: remove refittable_cargo_types

2012-05-03T16:38:36Z

remove refittable_cargo_types

← Older revision		Revision as of 16:38, 3 May 2012
Line 403:		Line 403:
	refittable_cargo_classes: bitmask(CC_PASSENGERS);		refittable_cargo_classes: bitmask(CC_PASSENGERS);
	non_refittable_cargo_classes: bitmask();		non_refittable_cargo_classes: bitmask();
	// refitting is done via cargo classes only, no ~~cargoes~~ need explicit enabling/disabling:		// refitting is done via cargo classes only, no cargo types need explicit enabling/disabling
	refittable_cargo_types: bitmask();
	// It's an intercity train, loading is relatively slow:		// It's an intercity train, loading is relatively slow:
	loading_speed: 6;		loading_speed: 6;

Yexo at 22:32, 13 December 2011

2011-12-13T22:32:42Z

← Older revision		Revision as of 22:32, 13 December 2011
Line 29:		Line 29:
	</pre>		</pre>

	The switch itself will use the <code>cargo_subtype</code> [http://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Vehicle_variables variable]. This variable starts at 0 and will be increased by 1 until the callback returns <code>~~0xFF~~</code>. Return strings to use as cargo subtype. Each returned string will be a separate cargo subtype:		The switch itself will use the <code>cargo_subtype</code> [http://newgrf-specs.tt-wiki.net/wiki/NML:Vehicles#Vehicle_variables variable]. This variable starts at 0 and will be increased by 1 until the callback returns <code>CB_RESULT_NO_MORE_ARTICULATED_PARTS</code>. Return strings to use as cargo subtype. Each returned string will be a separate cargo subtype:

	<pre style="color:darkblue; white-space: pre-wrap">		<pre style="color:darkblue; white-space: pre-wrap">
Line 35:		Line 35:
	0: return string(STR_ICM_SUBTYPE_3_PART);		0: return string(STR_ICM_SUBTYPE_3_PART);
	1: return string(STR_ICM_SUBTYPE_4_PART);		1: return string(STR_ICM_SUBTYPE_4_PART);
	return ~~0xFF~~;		return CB_RESULT_NO_MORE_ARTICULATED_PARTS;
	}		}
	</pre>		</pre>
Line 57:		Line 57:
	/* Add three articulated parts, for a total of four */		/* Add three articulated parts, for a total of four */
	1 .. 3: return item_icm;		1 .. 3: return item_icm;
	return ~~0xFF~~;		return CB_RESULT_NO_MORE_ARTICULATED_PARTS;
	}		}
	</pre>		</pre>
Line 69:		Line 69:
	switch(FEAT_TRAINS, SELF, sw_icm_start_stop, num_vehs_in_consist) {		switch(FEAT_TRAINS, SELF, sw_icm_start_stop, num_vehs_in_consist) {
	/* Vehicles may be coupled to a maximum of 4 units (12-16 cars) */		/* Vehicles may be coupled to a maximum of 4 units (12-16 cars) */
	1 .. 16: return ~~0xFF~~;		1 .. 16: return CB_RESULT_NO_TEXT;
	return string(STR_ICM_CANNOT_START);		return string(STR_ICM_CANNOT_START);
	}		}
Line 333:		Line 333:
	0: return string(STR_ICM_SUBTYPE_3_PART);		0: return string(STR_ICM_SUBTYPE_3_PART);
	1: return string(STR_ICM_SUBTYPE_4_PART);		1: return string(STR_ICM_SUBTYPE_4_PART);
	return ~~0xFF~~;		return CB_RESULT_NO_TEXT;
	}		}

Line 340:		Line 340:
	/* Add three articulated parts, for a total of four */		/* Add three articulated parts, for a total of four */
	1 .. 3: return item_icm;		1 .. 3: return item_icm;
	return ~~0xFF~~;		return CB_RESULT_NO_MORE_ARTICULATED_PARTS;
	}		}

Line 346:		Line 346:
	switch(FEAT_TRAINS, SELF, sw_icm_start_stop, num_vehs_in_consist) {		switch(FEAT_TRAINS, SELF, sw_icm_start_stop, num_vehs_in_consist) {
	/* Vehicles may be coupled to a maximum of 4 units (12-16 cars) */		/* Vehicles may be coupled to a maximum of 4 units (12-16 cars) */
	1 .. 16: return ~~0xFF~~;		1 .. 16: return CB_RESULT_NO_TEXT;
	return string(STR_ICM_CANNOT_START);		return string(STR_ICM_CANNOT_START);
	}		}

Hirundo: Some more icm->item_icm fixes

2011-09-04T14:31:06Z

Some more icm->item_icm fixes

← Older revision		Revision as of 14:31, 4 September 2011
Line 56:		Line 56:
	switch(FEAT_TRAINS, SELF, sw_icm_articulated_part, extra_callback_info1) {		switch(FEAT_TRAINS, SELF, sw_icm_articulated_part, extra_callback_info1) {
	/* Add three articulated parts, for a total of four */		/* Add three articulated parts, for a total of four */
	1 .. 3: return ~~icm~~;		1 .. 3: return item_icm;
	return 0xFF;		return 0xFF;
	}		}
Line 353:		Line 353:
	switch(FEAT_TRAINS, SELF, sw_icm_can_attach_wagon, vehicle_type_id) {		switch(FEAT_TRAINS, SELF, sw_icm_can_attach_wagon, vehicle_type_id) {
	/* SELF refers to the wagon here, check that it's an ICM */		/* SELF refers to the wagon here, check that it's an ICM */
	~~icm~~: return CB_RESULT_ATTACH_ALLOW;		item_icm: return CB_RESULT_ATTACH_ALLOW;
	return string(STR_ICM_CANNOT_ATTACH_OTHER);		return string(STR_ICM_CANNOT_ATTACH_OTHER);
	}		}

Hirundo: /* Total code so far */ Some fixes to the code; needs more review.

2011-09-04T14:13:58Z

Total code so far: Some fixes to the code; needs more review.

← Older revision		Revision as of 14:13, 4 September 2011
Line 323:		Line 323:

	/* Choose between front, middle and back parts */		/* Choose between front, middle and back parts */
	switch(FEAT_TRAINS, SELF, sw_icm_graphics, position_in_consist % 3) {		switch(FEAT_TRAINS, SELF, sw_icm_graphics, position_in_consist % 4) {
	0: set_icm_front_lighted;		0: set_icm_front_lighted;
	2: set_icm_rear_lighted;		3: set_icm_rear_lighted;
	set_icm_middle;		set_icm_middle;
	}		}
Line 339:		Line 339:
	switch(FEAT_TRAINS, SELF, sw_icm_articulated_part, extra_callback_info1) {		switch(FEAT_TRAINS, SELF, sw_icm_articulated_part, extra_callback_info1) {
	/* Add three articulated parts, for a total of four */		/* Add three articulated parts, for a total of four */
	1 .. 3: return ~~icm~~;		1 .. 3: return item_icm;
	return 0xFF;		return 0xFF;
	}		}

FooBar at 21:05, 30 August 2011

2011-08-30T21:05:20Z

← Older revision		Revision as of 21:05, 30 August 2011
Line 1:		Line 1:
	{{NMLTutorial}}		{{NMLTutorial}}
	''The example used here is from the [http://dev.openttdcoop.org/projects/nml/repository/show/examples NML source]. The code for this was originally written in NFO by DJNekkid for the 2cc Trainset and rewritten in NML by ~~Hirundu~~. The graphics used in the example are by Purno. Code and graphics are both licensed according to the GPL v2 or later. The code has been modified for the purpose of this tutorial''		''The example used here is from the [http://dev.openttdcoop.org/projects/nml/repository/show/examples NML source]. The code for this was originally written in NFO by DJNekkid for the 2cc Trainset and rewritten in NML by Hirundo. The graphics used in the example are by Purno. Code and graphics are both licensed according to the GPL v2 or later. The code has been modified for the purpose of this tutorial''