Difference between revisions of "Documentation/Engine/Units/accessory transmission data"

From SCS Modding Wiki
Jump to navigation Jump to search
(Added crawls per ETS2 1.27.2.1 changes)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
The '''accessory_transmission_data''' unit class is used to define the transmission characteristics for the [[Documentation/Engine/Game_data/Player_trucks_definitions|player's vehicle]], as well as the differential ratio. Units of this type are usually defined in '''/def/vehicle/truck/<make.model>/transmission/*.sii''' and valid unit names end in <code>.transmission</code>.
+
The '''accessory_transmission_data''' unit class is used to define the transmission characteristics for the [[Documentation/Engine/Game_data/Player_trucks_definitions|player's vehicle]], as well as the differential ratio. Units of this type are usually defined in '''/def/vehicle/truck/<brand.model>/transmission/*.sii''' and valid unit names end in <code>.transmission</code>.
  
 
== Attributes ==
 
== Attributes ==
Line 11: Line 11:
 
|stall_torque_ratio
 
|stall_torque_ratio
 
|float
 
|float
−
|
+
|&#45;1.0
−
|This defines the maximum torque multiplication of the torque converter for an automatic transmission. The torque output of the transmission is clamped to a maximum of (engine torque &times; gear ratio &times; stall_torque_ratio). That is, the output torque stops increasing once the output speed drops below (engine speed &divide; gear ratio &divide; stall_torque_ratio). If unset, the transmission behaves like a conventional transmission without a torque converter.
+
|Torque ratio multiplier if torque converter/multiplier is present. Any positive value is used as multiplier on lower RPM torque.
 
|-
 
|-
 
|differential_ratio
 
|differential_ratio
 
|float
 
|float
−
|
+
|1.0
 
|This defines the differential/final drive ratio between the transmission output shaft and the wheels.
 
|This defines the differential/final drive ratio between the transmission output shaft and the wheels.
 
|-
 
|-
Line 23: Line 23:
 
|0
 
|0
 
|The number of output levels for the retarder if applicable. If zero, retarder behavior is disabled for the transmission.
 
|The number of output levels for the retarder if applicable. If zero, retarder behavior is disabled for the transmission.
 +
|-
 +
|auxiliary_brakes
 +
|array&lt;float3&gt;
 +
|
 +
|When set, this overrides the retarder control so that it controls both the retarder and engine brake. The components are (retarder strength, engine brake strength, forced downshift). The value of retarder must match the number of members in auxiliary_brakes. (''Added in 1.28'') For example:
 +
<pre> retarder: 5
 +
auxiliary_brakes[]: (0.3, 0, 0) // 30% retarder only
 +
auxiliary_brakes[]: (0.6, 0, 0) // 60% retarder only
 +
auxiliary_brakes[]: (1.0, 0, 0) // 100% retarder only
 +
auxiliary_brakes[]: (1.0, 1, 0) // 100% retarder and 100% engine brake
 +
auxiliary_brakes[]: (1.0, 1, 1) // 100% retarder, 100% engine brake and downshift</pre>
 
|-
 
|-
 
|ratios_reverse
 
|ratios_reverse
−
|float_array
+
|array&lt;float&gt;
 
|
 
|
 
|This defines the reverse gear ratios in order of decreasing gear reduction. The values should be negative. Example:
 
|This defines the reverse gear ratios in order of decreasing gear reduction. The values should be negative. Example:
Line 32: Line 43:
 
|-
 
|-
 
|ratios_forward
 
|ratios_forward
−
|float_array
+
|array&lt;float&gt;
 
|
 
|
 
|This defines the forward gear ratios in order of decreasing gear reduction. The values should be positive. Example:
 
|This defines the forward gear ratios in order of decreasing gear reduction. The values should be positive. Example:
Line 44: Line 55:
 
|
 
|
 
|Points to a unit of the type [[Documentation/Engine/Units/transmission_names|transmission_names]], usually nameless and within the same unit definition file or [[Documentation/Engine/Units#Includes|included]] from a Serialized Unit Include (.sui) type file. This is used to assign custom names to each gear in automatic and sequential modes (these are overridden by h-shifter pattern definitions).
 
|Points to a unit of the type [[Documentation/Engine/Units/transmission_names|transmission_names]], usually nameless and within the same unit definition file or [[Documentation/Engine/Units#Includes|included]] from a Serialized Unit Include (.sui) type file. This is used to assign custom names to each gear in automatic and sequential modes (these are overridden by h-shifter pattern definitions).
 +
|-
 +
|auto_mode_name
 +
|string
 +
|A
 +
|Prefix for gear number in dashboard display (element id 1310) during automatic transmission mode. ''(Added in 1.35)''
 +
|-
 +
|manual_mode_name
 +
|string
 +
|M
 +
|Prefix for gear number in dashboard display (element id 1310) during manual transmission mode. ''(Added in 1.35)''
 
|-
 
|-
 
|crawls
 
|crawls
 
|uint
 
|uint
 
|0
 
|0
−
|The number of ratios_forward to handle as crawler gears for UI display. ''(Added in ETS2 [[Games/ETS2/Modding_guides/1.27.2.1#Transmission_Data|1.27.2.1]])''
+
|The number of ratios_forward to handle as crawler gears for UI display. ''(Added in ETS2 [[Games/ETS2/Modding_guides/1.27.2#Transmission_Data|1.27.2]])''
 +
|-
 +
|shift_time
 +
|float
 +
|1.0
 +
|The time, in seconds, it takes to shift gears in automatic shifting. ''(Added in 1.31)''
 +
|-
 +
|sounds
 +
|array&lt;string&gt;
 +
|
 +
|Each item assigns an FMOD event to a function, using the "''<nowiki>sound_name|sound_path</nowiki>''" [[Games/ETS2/Modding_guides/1.39#Accessories|format]]. ''(Added in 1.39)''
 +
 
 +
Expected sound event names are: air_gear_noise, retarder, gear_grind, and gear_wrong.
 
|}
 
|}

Latest revision as of 08:53, 11 October 2020

The accessory_transmission_data unit class is used to define the transmission characteristics for the player's vehicle, as well as the differential ratio. Units of this type are usually defined in /def/vehicle/truck/<brand.model>/transmission/*.sii and valid unit names end in .transmission.

Attributes

Many common attributes are inherited from accessory_data.

Name Type Default Value Description
stall_torque_ratio float -1.0 Torque ratio multiplier if torque converter/multiplier is present. Any positive value is used as multiplier on lower RPM torque.
differential_ratio float 1.0 This defines the differential/final drive ratio between the transmission output shaft and the wheels.
retarder uint 0 The number of output levels for the retarder if applicable. If zero, retarder behavior is disabled for the transmission.
auxiliary_brakes array<float3> When set, this overrides the retarder control so that it controls both the retarder and engine brake. The components are (retarder strength, engine brake strength, forced downshift). The value of retarder must match the number of members in auxiliary_brakes. (Added in 1.28) For example: 
	retarder: 5
	auxiliary_brakes[]: (0.3, 0, 0)	// 30% retarder only
	auxiliary_brakes[]: (0.6, 0, 0)	// 60% retarder only
	auxiliary_brakes[]: (1.0, 0, 0)	// 100% retarder only
	auxiliary_brakes[]: (1.0, 1, 0)	// 100% retarder and 100% engine brake
	auxiliary_brakes[]: (1.0, 1, 1) // 100% retarder, 100% engine brake and downshift
ratios_reverse array<float> This defines the reverse gear ratios in order of decreasing gear reduction. The values should be negative. Example: 
	ratios_reverse[0]: -11.002
	ratios_reverse[1]: -8.875
ratios_forward array<float> This defines the forward gear ratios in order of decreasing gear reduction. The values should be positive. Example: 
	ratios_forward[0]: 11.32
	ratios_forward[1]: 9.132
	ratios_forward[2]: 7.207
	...etc...
transmission_names owner_ptr Points to a unit of the type transmission_names, usually nameless and within the same unit definition file or included from a Serialized Unit Include (.sui) type file. This is used to assign custom names to each gear in automatic and sequential modes (these are overridden by h-shifter pattern definitions).
auto_mode_name string A Prefix for gear number in dashboard display (element id 1310) during automatic transmission mode. (Added in 1.35)
manual_mode_name string M Prefix for gear number in dashboard display (element id 1310) during manual transmission mode. (Added in 1.35)
crawls uint 0 The number of ratios_forward to handle as crawler gears for UI display. (Added in ETS2 1.27.2)
shift_time float 1.0 The time, in seconds, it takes to shift gears in automatic shifting. (Added in 1.31)
sounds array<string> Each item assigns an FMOD event to a function, using the "sound_name|sound_path" format. (Added in 1.39)

Expected sound event names are: air_gear_noise, retarder, gear_grind, and gear_wrong.

Retrieved from "https://modding.scssoft.com/index.php?title=Documentation/Engine/Units/accessory_transmission_data&oldid=4734"