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

From SCS Modding Wiki
Jump to navigation Jump to search
(→‎Attributes: Added/tweaked attributes for 1.27/1.6)
(→‎Attributes)
 
(22 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
The '''accessory_chassis_data''' unit class is used to define the chassis characteristics for the [[Documentation/Engine/Game_data/Player_trucks_definitions|player's vehicle]] including axle weights, extended shadow parameters, and fluid capacities. It is also used to define chassis characteristics of trailers and AI vehicles. Units of this type are usually defined in '''/def/vehicle/truck/<make.model>/chassis/*.sii''', '''/def/vehicle/trailer/<trailer_name>/*.sii''', and '''/def/vehicle/ai/<vehicle_name>/chassis.sii.  
+
The '''accessory_chassis_data''' unit class is used to define the chassis characteristics for the [[Documentation/Engine/Game_data/Player_trucks_definitions|player's vehicle]] including axle weights, extended shadow parameters, and fluid capacities. It is also used to define chassis characteristics of trailers and AI vehicles. Units of this type are usually defined in '''/def/vehicle/truck/<brand.model>/chassis/*.sii''', '''/def/vehicle/trailer/<trailer_name>/*.sii''', and '''/def/vehicle/ai/<vehicle_name>/chassis.sii.  
  
 
== Attributes ==
 
== Attributes ==
Line 12: Line 12:
 
|string
 
|string
 
|
 
|
−
|Path to the high level-of-detail mesh. This is generally unused, but can be used for fine detail or &lsquo;expensive&rsquo; shader effects that are only visible very close to the vehicle.
+
|Path to the detailed mesh model descriptor (.pmd). This is used only for vehicles used by player. Additionally they are used in vehicle previews & browser windows.
 
|-
 
|-
 
|model
 
|model
 
|string
 
|string
 
|
 
|
−
|Path to the standard level-of-detail mesh. If only a single LOD is used, it should be set up as '''model''', and the other attributes (detail_model, lods) should not be defined.
+
|Path to the model descriptor (.pmd). If only a single LOD is used, it should be set up as '''model''', and the other attributes (detail_model, lods) should not be defined.
 
|-
 
|-
 
|lods
 
|lods
−
|string array
+
|array&lt;string&gt;
 
|
 
|
−
|Paths to the reduced level-of-detail meshes, in order of increasing viewing distance (decreasing model complexity).
+
|Paths to the reduced level-of-detail model descriptors (.pmd), in order of increasing viewing distance (decreasing model complexity).
 
|-
 
|-
 
|collision
 
|collision
 
|string
 
|string
 
|
 
|
−
|Path to the appropriate collision (.pmc) model.
+
|Path to the collision descriptor (.pmc).
 
|-
 
|-
 
|trailer_brace_model
 
|trailer_brace_model
Line 42: Line 42:
 
|string
 
|string
 
|
 
|
−
|''For trailer usage only.'' Path to the sound to be played when retracting landing gear.
+
|''For trailer usage only.'' Path to the sound to be played when retracting landing gear. ''Default value changed to blank (no sound) in 1.35.''
 
|-
 
|-
 
|trailer_brace_down_sound
 
|trailer_brace_down_sound
 
|string
 
|string
 
|
 
|
−
|''For trailer usage only.'' Path to the sound to be played when extending landing gear.
+
|''For trailer usage only.'' Path to the sound to be played when extending landing gear. ''Default value changed to blank (no sound) in 1.35.''
 
|-
 
|-
 
|variant
 
|variant
 
|token
 
|token
−
|default
+
|
 
|Variant to be used from '''detail_model''', '''model''', and '''lods'''.
 
|Variant to be used from '''detail_model''', '''model''', and '''lods'''.
 
|-
 
|-
Line 61: Line 61:
 
|look
 
|look
 
|token
 
|token
−
|default
+
|
 
|Look to be used from '''detail_model''', '''model''', and '''lods'''.
 
|Look to be used from '''detail_model''', '''model''', and '''lods'''.
 
|-
 
|-
Line 86: Line 86:
 
|extended_shadow_fadeout_start
 
|extended_shadow_fadeout_start
 
|float
 
|float
−
|
+
|0.0
 
|Sets the distance in meters from the fakeshadow surface to begin fading the extended shadow.
 
|Sets the distance in meters from the fakeshadow surface to begin fading the extended shadow.
 
|-
 
|-
 
|extended_shadow_fadeout_length
 
|extended_shadow_fadeout_length
 
|float
 
|float
−
|
+
|1.0
 
|Sets the length in meters over which to fade out the extended shadow.
 
|Sets the length in meters over which to fade out the extended shadow.
 
|-
 
|-
Line 97: Line 97:
 
|token
 
|token
 
|
 
|
−
|
+
|If provided, specified variant of model will be used to draw the shared shadows.
 
|-
 
|-
 
|ui_shadow
 
|ui_shadow
Line 106: Line 106:
 
|tank_size
 
|tank_size
 
|float
 
|float
−
|
+
|0.0
 
|Fuel tank size in liters.
 
|Fuel tank size in liters.
 
|-
 
|-
 
|adblue_tank_size
 
|adblue_tank_size
 
|float
 
|float
−
|50
+
|80.0
 
|AdBlue/DEF tank size in liters.
 
|AdBlue/DEF tank size in liters.
 
|-
 
|-
Line 118: Line 118:
 
|10.0
 
|10.0
 
|Nominal air brake reservoir pressure in bar. ''Added in ETS2 1.27/ATS 1.6.''
 
|Nominal air brake reservoir pressure in bar. ''Added in ETS2 1.27/ATS 1.6.''
 +
|-
 +
|nominal_voltage
 +
|float
 +
|24.0
 +
|Nominal battery voltage. ''Added in 1.36''
 
|-
 
|-
 
|residual_travel
 
|residual_travel
−
|float_array
+
|array&lt;float&gt;
 
|
 
|
−
|''For trucks and trailers.'' The limit of upwards and downwards travel in meters for each axle. Each array member corresponds to an axle, from front to back (or from back to front in the case of trailers).
+
|''For trucks and trailers.'' The limit of upwards and downwards travel in meters for each axle. Each array member corresponds to an axle, from front to back.
 
|-
 
|-
 
|trailer_mass
 
|trailer_mass
 
|float
 
|float
−
|
+
|7000.0
 
|''For trailer usage only.'' Sets the unladen mass of the trailer.
 
|''For trailer usage only.'' Sets the unladen mass of the trailer.
 
|-
 
|-
 
|powered_axle
 
|powered_axle
−
|bool_array
+
|array&lt;bool&gt;
 
|
 
|
 
|''For truck usage only.'' When true, motive torque will be applied on the axle. Each array member corresponds to an axle, from front to back.
 
|''For truck usage only.'' When true, motive torque will be applied on the axle. Each array member corresponds to an axle, from front to back.
 
|-
 
|-
 
|kerb_weight
 
|kerb_weight
−
|float_array
+
|array&lt;float&gt;
−
|
+
|false
 
|''For truck usage only.'' Assigns the static weight on each axle. Each array member corresponds to an axle, from front to back.
 
|''For truck usage only.'' Assigns the static weight on each axle. Each array member corresponds to an axle, from front to back.
 
|-
 
|-
 
|liftable_axle
 
|liftable_axle
−
|bool_array
+
|array&lt;bool&gt;
 
|false
 
|false
−
|''For truck and trailers.'' When true, the axle can be lifted. Each array member corresponds to an axle, from front to back (or from back to front in the case of trailers). ''Trailer functionality is added in ETS2 1.27/ATS 1.6.''
+
|''For truck and trailers.'' When true, the axle can be lifted. Each array member corresponds to an axle, from front to back. ''Trailer functionality is added in ETS2 1.27/ATS 1.6.''
 +
|-
 +
|steerable_axle
 +
|array&lt;token&gt;
 +
|see description
 +
|''For truck and trailers.'' Each array member corresponds to an axle, from front to back. By default, first axles on trucks are ''true'', while all others are ''false''. Possible values are:
 +
*false (non-steerable axle)
 +
*true (steerable wheels on given axle)
 +
*axle (whole axle is rotated when steering, ''axle_model'' must be correctly defined, valid only for trailers).
 +
''Added in 1.31. Value "axle" was added in 1.50''
 +
|-
 +
|steerable_lifted_axle
 +
|bool
 +
|false
 +
|''For truck and trailers.'' When true, lifted steerable axles will react to steering. Otherwise they line themselves with chassis once lifted. ''Added in 1.44.''
 +
|-
 +
|weight_distribution
 +
|enum
 +
|semitrailer
 +
|''For trailer usage only.'' Determines how forces are transferred between the trailer and its connected vehicle(s). Possible values are:
 +
*semitrailer (fifth wheel, part of trailer weight transferred)
 +
*trailer (hook, no weight transfer)
 +
*spreader (removes the pitch degree of freedom, typical of a spreader/booster/stinger on a lowboy configuration)
 +
''Added in ATS 1.6.2.''
 +
|-
 +
|axle_model
 +
|array<string>
 +
|
 +
|''For trailer usage only.'' Path to the axle model descriptors (.pmd). ''Added in 1.50.''
 +
|-
 +
|axle_model_collision
 +
|array<string>
 +
|
 +
|''For trailer usage only.'' Path to the axle model collision descriptors (.pmc). ''Added in 1.50.''
 +
|-
 +
|axle_model_extended_shadow_texture
 +
|array<string>
 +
|
 +
|''For trailer usage only.'' Texture to be used for the extended (volumetric) shadow underneath each axle. ''Added in 1.50.''
 +
|-
 +
|axle_model_steer_angle
 +
|unsigned int
 +
|
 +
|''For trailer usage only.'' Overwrites the maximum steering angle of the last steerable axle model. ''Added in 1.50.''
 +
|-
 +
|cog_cargo_mass_min
 +
|float
 +
|0
 +
|Lowest cargo mass at which to offset the center of gravity. ''Added in 1.35.''
 +
|-
 +
|cog_cargo_mass_max
 +
|float
 +
|20000
 +
|Highest cargo mass at which to offset the center of gravity. ''Added in 1.35.''
 
|-
 
|-
−
|<del>powered_wheel</del>
+
|cog_cargo_offset_min
−
|bool_array
+
|float3
 +
|(0,0,0)
 +
|Distance to offset the center of gravity at '''cog_cargo_mass_min'''. ''Added in 1.35.''
 +
|-
 +
|cog_cargo_offset_max
 +
|float3
 +
|(0,1,0)
 +
|Distance to offset the center of gravity at '''cog_cargo_mass_max'''. ''Added in 1.35.''
 +
|-
 +
|sounds
 +
|array&lt;string&gt;
 
|
 
|
−
|Deprecated – use powered_axle instead.
+
|Each item assigns an FMOD event to a chassis 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_brake, air_cutoff, reverse, lift_axle, hook_attach, hook_detach, and trailer_cables.
 +
|
 +
|-
 +
|lamp_setup
 +
|string
 +
|
 +
|Paths to the special headlight setup if default is not good enough. ''Added in 1.40''
 +
'''Content of vehicle_lamp_setup unit is an experimental feature and will most probably change in the future!'''
 
|}
 
|}
−
 
−
{{UnitDef|def=<nowiki>  "accessory_chassis_data":{
 
−
  "superclass":"accessory_data",
 
−
  "attrs":{
 
−
    "name":{
 
−
    "type": "string"
 
−
    },
 
−
    "short_name":{
 
−
    "type": "string"
 
−
    },
 
−
    "icon":{
 
−
    "type": "string"
 
−
    },
 
−
    "info":{
 
−
    "type": "string_array"
 
−
    },
 
−
    "price":{
 
−
    "type": "s64"
 
−
    },
 
−
    "unlock":{
 
−
    "type": "uint"
 
−
    },
 
−
    "suitable_for":{
 
−
    "type": "string_array"
 
−
    },
 
−
    "conflict_with":{
 
−
    "type": "string_array"
 
−
    },
 
−
    "defaults":{
 
−
    "type": "string_array"
 
−
    },
 
−
    "require":{
 
−
    "type": "token_array"
 
−
    },
 
−
    "detail_model":{
 
−
    "type": "string"
 
−
    },
 
−
    "model":{
 
−
    "type": "string"
 
−
    },
 
−
    "lods":{
 
−
    "type": "string_array"
 
−
    },
 
−
    "collision":{
 
−
    "type": "string"
 
−
    },
 
−
    "trailer_brace_model":{
 
−
    "type": "string"
 
−
    },
 
−
    "trailer_brace_anim":{
 
−
    "type": "string"
 
−
    },
 
−
    "trailer_brace_up_sound":{
 
−
    "type": "string"
 
−
    },
 
−
    "trailer_brace_down_sound":{
 
−
    "type": "string"
 
−
    },
 
−
    "variant":{
 
−
    "type": "token"
 
−
    },
 
−
    "variant_uk":{
 
−
    "type": "token"
 
−
    },
 
−
    "look":{
 
−
    "type": "token"
 
−
    },
 
−
    "shadow_texture":{
 
−
    "type": "string"
 
−
    },
 
−
    "shadow_intensity":{
 
−
    "type": "float"
 
−
    },
 
−
    "extended_shadow_texture":{
 
−
    "type": "string"
 
−
    },
 
−
    "extended_shadow_intensity":{
 
−
    "type": "float"
 
−
    },
 
−
    "extended_shadow_fadeout_start":{
 
−
    "type": "float"
 
−
    },
 
−
    "extended_shadow_fadeout_length":{
 
−
    "type": "float"
 
−
    },
 
−
    "extended_shadow_shared_model_variant":{
 
−
    "type": "token"
 
−
    },
 
−
    "ui_shadow":{
 
−
    "type": "string"
 
−
    },
 
−
    "tank_size":{
 
−
    "type": "float"
 
−
    },
 
−
    "adblue_tank_size":{
 
−
    "type": "float"
 
−
    },
 
−
    "residual_travel":{
 
−
    "type": "float_array"
 
−
    },
 
−
    "trailer_mass":{
 
−
    "type": "float"
 
−
    },
 
−
    "powered_axle":{
 
−
    "type": "bool_array"
 
−
    },
 
−
    "kerb_weight":{
 
−
    "type": "float_array"
 
−
    },
 
−
    "liftable_axle":{
 
−
    "type": "bool_array"
 
−
    },
 
−
    "powered_wheel":{
 
−
    "type": "bool_array"
 
−
    }
 
−
  }
 
−
  },</nowiki>}}
 

Latest revision as of 13:24, 7 May 2024

The accessory_chassis_data unit class is used to define the chassis characteristics for the player's vehicle including axle weights, extended shadow parameters, and fluid capacities. It is also used to define chassis characteristics of trailers and AI vehicles. Units of this type are usually defined in /def/vehicle/truck/<brand.model>/chassis/*.sii, /def/vehicle/trailer/<trailer_name>/*.sii, and /def/vehicle/ai/<vehicle_name>/chassis.sii.

Attributes

Many common attributes are inherited from accessory_data.

Name Type Default Value Description
detail_model string Path to the detailed mesh model descriptor (.pmd). This is used only for vehicles used by player. Additionally they are used in vehicle previews & browser windows.
model string Path to the model descriptor (.pmd). If only a single LOD is used, it should be set up as model, and the other attributes (detail_model, lods) should not be defined.
lods array<string> Paths to the reduced level-of-detail model descriptors (.pmd), in order of increasing viewing distance (decreasing model complexity).
collision string Path to the collision descriptor (.pmc).
trailer_brace_model string For trailer usage only. Path to the animated landing gear model.
trailer_brace_anim string For trailer usage only. Path to the landing gear animation.
trailer_brace_up_sound string For trailer usage only. Path to the sound to be played when retracting landing gear. Default value changed to blank (no sound) in 1.35.
trailer_brace_down_sound string For trailer usage only. Path to the sound to be played when extending landing gear. Default value changed to blank (no sound) in 1.35.
variant token Variant to be used from detail_model, model, and lods.
variant_uk token Variant to be used in countries which drive on the left. If unspecified, defaults to the value of variant.
look token Look to be used from detail_model, model, and lods.
shadow_texture string Texture to be used for basic shadow.
shadow_intensity float 1.0 Relative intensity of basic shadow.
extended_shadow_texture string Texture to be used for the extended (volumetric) shadow.
extended_shadow_intensity float 1.0 Relative intensity of the extended (volumetric) shadow.
extended_shadow_fadeout_start float 0.0 Sets the distance in meters from the fakeshadow surface to begin fading the extended shadow.
extended_shadow_fadeout_length float 1.0 Sets the length in meters over which to fade out the extended shadow.
extended_shadow_shared_model_variant token If provided, specified variant of model will be used to draw the shared shadows.
ui_shadow string Path to the model descriptor (.pmd) for the UI shadow (used for the truck/trailer browser, thumbnail generation, etc).
tank_size float 0.0 Fuel tank size in liters.
adblue_tank_size float 80.0 AdBlue/DEF tank size in liters.
air_tank_pressure float 10.0 Nominal air brake reservoir pressure in bar. Added in ETS2 1.27/ATS 1.6.
nominal_voltage float 24.0 Nominal battery voltage. Added in 1.36
residual_travel array<float> For trucks and trailers. The limit of upwards and downwards travel in meters for each axle. Each array member corresponds to an axle, from front to back.
trailer_mass float 7000.0 For trailer usage only. Sets the unladen mass of the trailer.
powered_axle array<bool> For truck usage only. When true, motive torque will be applied on the axle. Each array member corresponds to an axle, from front to back.
kerb_weight array<float> false For truck usage only. Assigns the static weight on each axle. Each array member corresponds to an axle, from front to back.
liftable_axle array<bool> false For truck and trailers. When true, the axle can be lifted. Each array member corresponds to an axle, from front to back. Trailer functionality is added in ETS2 1.27/ATS 1.6.
steerable_axle array<token> see description For truck and trailers. Each array member corresponds to an axle, from front to back. By default, first axles on trucks are true, while all others are false. Possible values are:
  • false (non-steerable axle)
  • true (steerable wheels on given axle)
  • axle (whole axle is rotated when steering, axle_model must be correctly defined, valid only for trailers).

Added in 1.31. Value "axle" was added in 1.50

steerable_lifted_axle bool false For truck and trailers. When true, lifted steerable axles will react to steering. Otherwise they line themselves with chassis once lifted. Added in 1.44.
weight_distribution enum semitrailer For trailer usage only. Determines how forces are transferred between the trailer and its connected vehicle(s). Possible values are:
  • semitrailer (fifth wheel, part of trailer weight transferred)
  • trailer (hook, no weight transfer)
  • spreader (removes the pitch degree of freedom, typical of a spreader/booster/stinger on a lowboy configuration)

Added in ATS 1.6.2.

axle_model array<string> For trailer usage only. Path to the axle model descriptors (.pmd). Added in 1.50.
axle_model_collision array<string> For trailer usage only. Path to the axle model collision descriptors (.pmc). Added in 1.50.
axle_model_extended_shadow_texture array<string> For trailer usage only. Texture to be used for the extended (volumetric) shadow underneath each axle. Added in 1.50.
axle_model_steer_angle unsigned int For trailer usage only. Overwrites the maximum steering angle of the last steerable axle model. Added in 1.50.
cog_cargo_mass_min float 0 Lowest cargo mass at which to offset the center of gravity. Added in 1.35.
cog_cargo_mass_max float 20000 Highest cargo mass at which to offset the center of gravity. Added in 1.35.
cog_cargo_offset_min float3 (0,0,0) Distance to offset the center of gravity at cog_cargo_mass_min. Added in 1.35.
cog_cargo_offset_max float3 (0,1,0) Distance to offset the center of gravity at cog_cargo_mass_max. Added in 1.35.
sounds array<string> Each item assigns an FMOD event to a chassis function, using the "sound_name|sound_path" format. Added in 1.39

Expected sound event names are: air_brake, air_cutoff, reverse, lift_axle, hook_attach, hook_detach, and trailer_cables.

lamp_setup string Paths to the special headlight setup if default is not good enough. Added in 1.40

Content of vehicle_lamp_setup unit is an experimental feature and will most probably change in the future!

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