"Throttle-power" container - Revision history

Pware at 04:36, 27 August 2026

2026-08-27T04:36:51Z

← Older revision		Revision as of 04:36, 27 August 2026
Line 9:		Line 9:
	Note that a maximum of 8 such containers is supported, to match the common use-case of 8 throttle notches. Any extra containers will be unused. For engine assets with more than 8 throttle notches, the maximum throttle notch will map to the notch 8 data in the config file, the middle throttle notch will map to notch 4, etc. The game code will use linear interpolation to determine the power output for the other (in between) throttle notches, as required.		Note that a maximum of 8 such containers is supported, to match the common use-case of 8 throttle notches. Any extra containers will be unused. For engine assets with more than 8 throttle notches, the maximum throttle notch will map to the notch 8 data in the config file, the middle throttle notch will map to notch 4, etc. The game code will use linear interpolation to determine the power output for the other (in between) throttle notches, as required.

	The throttle-power container tags '''~~MUST~~''' be integer values (e.g. 1, 2, 3, etc)		The throttle-power container tags '''SHOULD''' be integer values (e.g. 1, 2, 3, etc). A bug in Trainz Plus SP7 that would not accept decimal values (e.g. 1.0, etc) has been fixed in Trainz Plus SP8.

	==Example throttle-power container==		==Example throttle-power container==

Pware at 22:20, 7 August 2026

2026-08-07T22:20:57Z

← Older revision		Revision as of 22:20, 7 August 2026
Line 9:		Line 9:
	Note that a maximum of 8 such containers is supported, to match the common use-case of 8 throttle notches. Any extra containers will be unused. For engine assets with more than 8 throttle notches, the maximum throttle notch will map to the notch 8 data in the config file, the middle throttle notch will map to notch 4, etc. The game code will use linear interpolation to determine the power output for the other (in between) throttle notches, as required.		Note that a maximum of 8 such containers is supported, to match the common use-case of 8 throttle notches. Any extra containers will be unused. For engine assets with more than 8 throttle notches, the maximum throttle notch will map to the notch 8 data in the config file, the middle throttle notch will map to notch 4, etc. The game code will use linear interpolation to determine the power output for the other (in between) throttle notches, as required.

	The throttle-power tags '''MUST''' be integer values (e.g. 1, 2, 3, etc)		The throttle-power container tags '''MUST''' be integer values (e.g. 1, 2, 3, etc)

	==Example throttle-power container==		==Example throttle-power container==

Pware: added that the throttle-power tags must be integer values

2026-08-05T00:45:05Z

added that the throttle-power tags must be integer values

← Older revision		Revision as of 00:45, 5 August 2026
Line 8:		Line 8:

	Note that a maximum of 8 such containers is supported, to match the common use-case of 8 throttle notches. Any extra containers will be unused. For engine assets with more than 8 throttle notches, the maximum throttle notch will map to the notch 8 data in the config file, the middle throttle notch will map to notch 4, etc. The game code will use linear interpolation to determine the power output for the other (in between) throttle notches, as required.		Note that a maximum of 8 such containers is supported, to match the common use-case of 8 throttle notches. Any extra containers will be unused. For engine assets with more than 8 throttle notches, the maximum throttle notch will map to the notch 8 data in the config file, the middle throttle notch will map to notch 4, etc. The game code will use linear interpolation to determine the power output for the other (in between) throttle notches, as required.

			The throttle-power tags '''MUST''' be integer values (e.g. 1, 2, 3, etc)

	==Example throttle-power container==		==Example throttle-power container==

Pw3r: Expand on how Trainz code determines power output for engines with more than 8 throttle notches

2025-09-08T04:00:29Z

Expand on how Trainz code determines power output for engines with more than 8 throttle notches

← Older revision		Revision as of 04:00, 8 September 2025
Line 6:		Line 6:

	Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a tractive effort (kN) value. Together, these points define a tractive effort graph for a specific throttle notch.		Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a tractive effort (kN) value. Together, these points define a tractive effort graph for a specific throttle notch.

			Note that a maximum of 8 such containers is supported, to match the common use-case of 8 throttle notches. Any extra containers will be unused. For engine assets with more than 8 throttle notches, the maximum throttle notch will map to the notch 8 data in the config file, the middle throttle notch will map to notch 4, etc. The game code will use linear interpolation to determine the power output for the other (in between) throttle notches, as required.

	==Example throttle-power container==		==Example throttle-power container==

Pw3r: Roll back incorrect edits

2025-09-08T03:49:00Z

Roll back incorrect edits

← Older revision		Revision as of 03:49, 8 September 2025
Line 1:		Line 1:
	~~{{ORP-top}}~~		The Throttle-power container is a top-level [[config.txt file]] entry used by [[KIND Engine\|Enginespec]] assets.
	~~==Parent Class==~~
	The Throttle-power container is a top-level ~~Enginespec~~ [[config.txt file]] entry used by [[KIND Engine]] assets.

	==Supported Tags==		==Supported Tags==

	The Throttle-power container has a sequence of numeric subcontainers. Each one refers to a specific throttle notch.		The Throttle-power container has a sequence of numeric subcontainers. Each one refers to a specific throttle notch.

	~~:'''{the set:0,1,2,{{...}}, 6, 7} for diesels and {0, 1, {{...}}, 30, 31} for electric powered locos.''' (note the base-zero numbered sequences)~~		Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a tractive effort (kN) value. Together, these points define a tractive effort graph for a specific throttle notch.

	Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a ~~{{wp\|Tractive force\|~~tractive effort~~}} ({{wp\|Newton (unit)\|kiloNewtons~~ (kN~~)}}~~) value. Together, these points define a tractive effort graph for a specific throttle notch.

	==Example throttle-power container==		==Example throttle-power container==

	Here is an example throttle-power container. (Several notches have been omitted for brevity - the format is identical throughout).		Here is an example throttle-power container. (Several notches have been omitted for brevity - the format is identical throughout).
	~~[[File:Three-loco-styles.jpg\|thumb\|right\|450px\|Three loco styles shown together in Victoria, Australia.]]~~
	throttle-power		throttle-power
	{		{
Line 30:		Line 27:
	13.0 0		13.0 0
	}		}
	~~...~~
	...		....
	~~...~~
	8		8
	{		{
Line 48:		Line 45:
	}		}
	}		}
	[[file:Inclined Normal Force.png\|thumb\|right\|550px\|Weight is a force which depends on the part of the mass bearing straight down in a gravitational field. When the surface is inclined, that part of the weight at right angles to the track/surface, called the normal component or force diminishes as some of it now acts downhill which we sometimes call ''dead-weight'', and ''that component'' now has to be lifted while friction, declines as the normal force declines.]]
	*Note that ~~''in the example's figures''~~ the high notch ~~thrust~~ values are way beyond what the loco can actually ~~thrust against~~ the track at low ~~speeds~~ - ~~in other words,~~ this loco cannot be opened up to full throttle at very low speeds, otherwise it's wheels will slip.		Note that the high notch values are way beyond what the loco can actually put into the track at low speed - this loco cannot be opened up to full throttle at very low speeds, otherwise it's wheels will slip. The max tractive effort it can put into the rails before slipping is configured in the loco config file - the reason for this is that the weight of the loco (also set in the loco config file) will affect this value.
	* The ~~maximum~~ tractive effort ~~a {{wp\|locomotive engine}}~~ can put ~~onto~~ the rails before slipping is configured in the loco config file~~—~~the reason for this is that the weight of the loco (''also set in the loco config file'') will affect this value ~~since {{wp\|Friction\|frictional force}} opposes slippage and friction is directly dependent upon the '{{wp\|Normal Force}}' exerted by a mass on a surface.~~
	* As the slope of a grade increases it affects (diminishes) the component of the normal force producing friction against the rails. With a diminished frictional coefficient the tendency to slip increases proportionally to the {{wp\|sine}} of the angle of pitch of the grade.
	* It is a well known factor of pragmatic rail operations that traincars have less braking ability or can only apply reduced tractive effort on grades. The decline in the Normal Force with an increase in grade is why friction is commensurately reduced, and wheel slippage commensurately is more likely. Similarly, lubrication of the rails reduces frictional forces in a foul weather situation, again reducing braking ability and allowable pre-slip traction.
	* See also: {{wp\|Tractive_force#Defining_tractive_effort\|Defining Tractive Effort}} on Wikipedia.

	[[Category:Config Container]]		[[Category:Config Container]]
	~~{{Cont-Engine}}~~
	~~{{ORP-bot}}~~

Pw3r: Reverted edits by Fabartus (talk) to last revision by Mjolnir

2025-09-08T03:46:52Z

Reverted edits by Fabartus (talk) to last revision by Mjolnir

← Older revision		Revision as of 03:46, 8 September 2025
Line 4:		Line 4:

	==Supported Tags==		==Supported Tags==
	~~{{Related value\|"Motor" container\|sect=#throttle-notches\|throttle-notches}}~~		The Throttle-power container has a sequence of numeric subcontainers. Each one refers to a specific throttle notch.
	The Throttle-power container has ~~'nn elements' defining~~ a sequence of ~~paired~~ numeric ~~data sets grouped into~~ subcontainers ~~({{wp\|Array data structure\|data array}}s) that depend on the type of motive power at each throttle setting~~. Each ~~subcontainer or array~~ refers to a specific throttle notch ~~of a particular engine's performance curves, points on a graph to incorporate into the simulation dynamic models~~.
	~~# The first (index of zero) value(s) correspond to zero power or neutral and have neither thrust nor speed values (both are zero factors).~~		:'''{the set:0,1,2,{{...}}, 6, 7} for diesels and {0, 1, {{...}}, 30, 31} for electric powered locos.''' (note the base-zero numbered sequences)
	# The majority of the Throttle-power container then has a sequence of numeric subcontainers matching in numbers the integer count define in the [["Motor"_container#throttle-notches\|"Motor" container]]'s 'throttle-notches' tag value.
	# The Throttle-power containers last listed index of subcontainers must match the number of the integer defined by the value given the '''[["Motor"_container#throttle-notches\|"Motor" container's 'throttle-notches' tag]]'''. This value will generally be 8, or 32.
	:*'''{the set: 0, 1, 2, {{...}}, 6, 7~~, 8~~} for diesels ~~'''~~ and ~~{{...}}~~
	~~:*'''~~{~~the set:~~ 0, 1, {{...}}, 30, 31~~, 32~~} for ~~electric or diesel-~~electric powered locos.'''
	~~# A unit with dynamic brakes will have a double array of 8 or 32 values, corresponding to dynamic braking engaged~~ (~~deceleration or braking mode) or not engaged (acceleration~~).

	Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a {{wp\|Tractive force\|tractive effort}} ({{wp\|Newton (unit)\|kiloNewtons (kN)}}) value. Together, these points define a tractive effort graph for a specific throttle notch.		Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a {{wp\|Tractive force\|tractive effort}} ({{wp\|Newton (unit)\|kiloNewtons (kN)}}) value. Together, these points define a tractive effort graph for a specific throttle notch.
Line 18:		Line 13:

	Here is an example throttle-power container. (Several notches have been omitted for brevity - the format is identical throughout).		Here is an example throttle-power container. (Several notches have been omitted for brevity - the format is identical throughout).
	[[File:Three-loco-styles.jpg\|thumb\|right\|~~400px~~\|Three loco styles shown together in Victoria, Australia.]]		[[File:Three-loco-styles.jpg\|thumb\|right\|450px\|Three loco styles shown together in Victoria, Australia.]]
	throttle-power		throttle-power
	{		{
Line 53:		Line 48:
	}		}
	}		}
	[[file:Inclined Normal Force.png\|thumb\|right\|~~350px~~\|Weight is a force which depends on the part of the mass bearing straight down in a gravitational field. When the surface is inclined, that part of the weight at right angles to the track/surface, called the normal component or force diminishes as some of it now acts downhill which we sometimes call ''dead-weight'', and ''that component'' now has to be lifted while friction, declines as the normal force declines.]]		[[file:Inclined Normal Force.png\|thumb\|right\|550px\|Weight is a force which depends on the part of the mass bearing straight down in a gravitational field. When the surface is inclined, that part of the weight at right angles to the track/surface, called the normal component or force diminishes as some of it now acts downhill which we sometimes call ''dead-weight'', and ''that component'' now has to be lifted while friction, declines as the normal force declines.]]
	*Note that ''in the example's figures'' the high notch thrust values are way beyond what the loco can actually thrust against the track at low speeds - in other words, this loco cannot be opened up to full throttle at very low speeds, otherwise it's wheels will slip.		*Note that ''in the example's figures'' the high notch thrust values are way beyond what the loco can actually thrust against the track at low speeds - in other words, this loco cannot be opened up to full throttle at very low speeds, otherwise it's wheels will slip.
	* The maximum tractive effort a {{wp\|locomotive engine}} can put onto the rails before slipping is configured in the loco config file—the reason for this is that the weight of the loco (''also set in the loco config file'') will affect this value since {{wp\|Friction\|frictional force}} opposes slippage and friction is directly dependent upon the '{{wp\|Normal Force}}' exerted by a mass on a surface.		* The maximum tractive effort a {{wp\|locomotive engine}} can put onto the rails before slipping is configured in the loco config file—the reason for this is that the weight of the loco (''also set in the loco config file'') will affect this value since {{wp\|Friction\|frictional force}} opposes slippage and friction is directly dependent upon the '{{wp\|Normal Force}}' exerted by a mass on a surface.
Line 60:		Line 55:
	* See also: {{wp\|Tractive_force#Defining_tractive_effort\|Defining Tractive Effort}} on Wikipedia.		* See also: {{wp\|Tractive_force#Defining_tractive_effort\|Defining Tractive Effort}} on Wikipedia.

	[[Category:Config Container~~\|throttle-power~~]]		[[Category:Config Container]]
	{{Cont-Engine~~\|throttle-power~~}}		{{Cont-Engine}}
	{{ORP-bot~~\|throttle-power~~}}		{{ORP-bot}}

Fabartus: /* Example throttle-power container */ resize pic off right data column

2013-10-12T15:12:59Z

Example throttle-power container: resize pic off right data column

← Older revision		Revision as of 15:12, 12 October 2013
Line 18:		Line 18:

	Here is an example throttle-power container. (Several notches have been omitted for brevity - the format is identical throughout).		Here is an example throttle-power container. (Several notches have been omitted for brevity - the format is identical throughout).
	[[File:Three-loco-styles.jpg\|thumb\|right\|~~450px~~\|Three loco styles shown together in Victoria, Australia.]]		[[File:Three-loco-styles.jpg\|thumb\|right\|400px\|Three loco styles shown together in Victoria, Australia.]]
	throttle-power		throttle-power
	{		{

Fabartus: pipetrick

2013-09-23T17:50:54Z

pipetrick

← Older revision		Revision as of 17:50, 23 September 2013
Line 53:		Line 53:
	}		}
	}		}
	[[file:Inclined Normal Force.png\|thumb\|right\|~~550px~~\|Weight is a force which depends on the part of the mass bearing straight down in a gravitational field. When the surface is inclined, that part of the weight at right angles to the track/surface, called the normal component or force diminishes as some of it now acts downhill which we sometimes call ''dead-weight'', and ''that component'' now has to be lifted while friction, declines as the normal force declines.]]		[[file:Inclined Normal Force.png\|thumb\|right\|350px\|Weight is a force which depends on the part of the mass bearing straight down in a gravitational field. When the surface is inclined, that part of the weight at right angles to the track/surface, called the normal component or force diminishes as some of it now acts downhill which we sometimes call ''dead-weight'', and ''that component'' now has to be lifted while friction, declines as the normal force declines.]]
	*Note that ''in the example's figures'' the high notch thrust values are way beyond what the loco can actually thrust against the track at low speeds - in other words, this loco cannot be opened up to full throttle at very low speeds, otherwise it's wheels will slip.		*Note that ''in the example's figures'' the high notch thrust values are way beyond what the loco can actually thrust against the track at low speeds - in other words, this loco cannot be opened up to full throttle at very low speeds, otherwise it's wheels will slip.
	* The maximum tractive effort a {{wp\|locomotive engine}} can put onto the rails before slipping is configured in the loco config file—the reason for this is that the weight of the loco (''also set in the loco config file'') will affect this value since {{wp\|Friction\|frictional force}} opposes slippage and friction is directly dependent upon the '{{wp\|Normal Force}}' exerted by a mass on a surface.		* The maximum tractive effort a {{wp\|locomotive engine}} can put onto the rails before slipping is configured in the loco config file—the reason for this is that the weight of the loco (''also set in the loco config file'') will affect this value since {{wp\|Friction\|frictional force}} opposes slippage and friction is directly dependent upon the '{{wp\|Normal Force}}' exerted by a mass on a surface.
Line 60:		Line 60:
	* See also: {{wp\|Tractive_force#Defining_tractive_effort\|Defining Tractive Effort}} on Wikipedia.		* See also: {{wp\|Tractive_force#Defining_tractive_effort\|Defining Tractive Effort}} on Wikipedia.

	[[Category:Config Container]]		[[Category:Config Container\|throttle-power]]
	{{Cont-Engine}}		{{Cont-Engine\|throttle-power}}
	{{ORP-bot}}		{{ORP-bot\|throttle-power}}

Fabartus: /* Supported Tags */ revise and correct

2013-09-21T19:39:45Z

Supported Tags: revise and correct

← Older revision		Revision as of 19:39, 21 September 2013
Line 4:		Line 4:

	==Supported Tags==		==Supported Tags==
	{{~~Sister Class tag~~\|"Motor"~~_container~~#throttle-notches\|throttle-notches}}		{{Related value\|"Motor" container\|sect=#throttle-notches\|throttle-notches}}
	The Throttle-power container has a sequence of numeric subcontainers that ~~depends~~ on the type of motive power. Each ~~one~~ refers to a specific throttle notch of a particular ~~motor design~~'s simulation models. The Throttle-power container has a sequence of numeric subcontainers matching in numbers the integer count define in the [["Motor"_container#throttle-notches\|"Motor" container]]'s 'throttle-notches' tag value.		The Throttle-power container has 'nn elements' defining a sequence of paired numeric data sets grouped into subcontainers ({{wp\|Array data structure\|data array}}s) that depend on the type of motive power at each throttle setting. Each subcontainer or array refers to a specific throttle notch of a particular engine's performance curves, points on a graph to incorporate into the simulation dynamic models.
			# The first (index of zero) value(s) correspond to zero power or neutral and have neither thrust nor speed values (both are zero factors).
	:The Throttle-power containers ~~list~~ of subcontainers must match ~~in numbers~~ the integer ~~count~~ defined in the [["Motor"_container#throttle-notches\|"Motor" container]]'s 'throttle-notches' tag value~~. (note the base-zero numbered sequences~~, ~~indexes of~~ 32 ~~table elements start with 0 and end with 31 as an index~~.)		# The majority of the Throttle-power container then has a sequence of numeric subcontainers matching in numbers the integer count define in the [["Motor"_container#throttle-notches\|"Motor" container]]'s 'throttle-notches' tag value.
	:*'''{the set: 0, 1, 2, {{...}}, 6, 7} for diesels ''' and {{...}}		# The Throttle-power containers last listed index of subcontainers must match the number of the integer defined by the value given the '''[["Motor"_container#throttle-notches\|"Motor" container's 'throttle-notches' tag]]'''. This value will generally be 8, or 32.
	:*'''{the set: 0, 1, {{...}}, 30, 31} for electric or diesel-electric powered locos.'''		:*'''{the set: 0, 1, 2, {{...}}, 6, 7, 8} for diesels ''' and {{...}}
			:*'''{the set: 0, 1, {{...}}, 30, 31, 32} for electric or diesel-electric powered locos.'''
			# A unit with dynamic brakes will have a double array of 8 or 32 values, corresponding to dynamic braking engaged (deceleration or braking mode) or not engaged (acceleration).

	Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a {{wp\|Tractive force\|tractive effort}} ({{wp\|Newton (unit)\|kiloNewtons (kN)}}) value. Together, these points define a tractive effort graph for a specific throttle notch.		Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a {{wp\|Tractive force\|tractive effort}} ({{wp\|Newton (unit)\|kiloNewtons (kN)}}) value. Together, these points define a tractive effort graph for a specific throttle notch.

Fabartus: /* Supported Tags */ try clarifying w/links and references

2013-09-21T16:22:27Z

Supported Tags: try clarifying w/links and references

← Older revision		Revision as of 16:22, 21 September 2013
Line 4:		Line 4:

	==Supported Tags==		==Supported Tags==
	The Throttle-power container has a sequence of numeric subcontainers. Each one refers to a specific throttle notch.		{{Sister Class tag\|"Motor"_container#throttle-notches\|throttle-notches}}
			The Throttle-power container has a sequence of numeric subcontainers that depends on the type of motive power. Each one refers to a specific throttle notch of a particular motor design's simulation models. The Throttle-power container has a sequence of numeric subcontainers matching in numbers the integer count define in the [["Motor"_container#throttle-notches\|"Motor" container]]'s 'throttle-notches' tag value.

	:'''{the set:0,1,2,{{...}}, 6, 7} for diesels and {0, 1, {{...}}, 30, 31} for electric powered locos.''' ~~(note the base-zero numbered sequences)~~		:The Throttle-power containers list of subcontainers must match in numbers the integer count defined in the [["Motor"_container#throttle-notches\|"Motor" container]]'s 'throttle-notches' tag value. (note the base-zero numbered sequences, indexes of 32 table elements start with 0 and end with 31 as an index.)
			:*'''{the set: 0, 1, 2, {{...}}, 6, 7} for diesels ''' and {{...}}
			:*'''{the set: 0, 1, {{...}}, 30, 31} for electric or diesel-electric powered locos.'''

	Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a {{wp\|Tractive force\|tractive effort}} ({{wp\|Newton (unit)\|kiloNewtons (kN)}}) value. Together, these points define a tractive effort graph for a specific throttle notch.		Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a {{wp\|Tractive force\|tractive effort}} ({{wp\|Newton (unit)\|kiloNewtons (kN)}}) value. Together, these points define a tractive effort graph for a specific throttle notch.