Difference between revisions of "Documentation/Engine/Units/cargo model match"

From SCS Modding Wiki
Jump to navigation Jump to search
(Created page with "The '''cargo_model_match''' unit class is used to match cargo models with appropriate trailers. Units of this type are f...")
 
(Update for new cargo system - Version 1.54 // TeamDeer)
Line 1: Line 1:
−
The '''cargo_model_match''' unit class is used to match cargo models with appropriate [[Documentation/Engine/Game_data#Trailer_definitions|trailers]]. Units of this type are found in '''/def/cargo/<cargo_name>/model_*.sii'''
+
Starting with ETS2/ATS game version 1.54, cargoes will now use the new cargo system. The '''cargo_model_match''' unit class is used to define the location of the cargo model [[Documentation/Engine/Units/accessory_cargo_data|definition file]] as well as several new types of cargo related information as well as cargo (model) dimensions, if applicable. Units of this type are found in '''/def/vehicle/cargo/<cargo_name>/*.sii'''  
  
 
== Attributes ==
 
== Attributes ==
Line 6: Line 6:
 
![[Documentation/Engine/Units#Attribute_types|Type]]
 
![[Documentation/Engine/Units#Attribute_types|Type]]
 
!Default Value
 
!Default Value
 +
!Necessity
 
!Description
 
!Description
 
|-
 
|-
−
|compatible_body
+
|data_path
 
|array<string>
 
|array<string>
 
|
 
|
−
|Paths to definitions of compatible bodies and/or chassis. The expected unit type is either [[Documentation/Engine/Units/accessory_chassis_data|'''accessory_chassis_data''']] or [[Documentation/Engine/Units/accessory_trailer_body_data|'''accessory_trailer_body_data''']].
+
|''required''
 +
|Paths to definitions of compatible cargo accessories, one of which will be chosen pseudo-randomly during job generation. The expected unit type is [[Documentation/Engine/Units/accessory_cargo_data|'''accessory_cargo_data''']]. Typically, this will point to a SII file located in the same cargo folder IE. '''/def/vehicle/cargo/<cargo_name>/*.sii'''
 +
|-
 +
|dimensions
 +
|float3
 +
|
 +
|''required if using 'area' method''
 +
|Dimensions of the cargo model in meters using the format of L x H x W Ex. ''(2.30, 2.63, 3.22)''
 +
|-
 +
|unit_volume_factor
 +
|float
 +
|
 +
|''opitional''
 +
|The factor at which a cargo's volume unit is impacted by the total weight of trailer's 'body'; typically used by container style cargo
 +
|-
 +
|loading_method
 +
|token
 +
|
 +
|''required''
 +
|The method the cargo will be loaded onto the trailer '''->''' ''custom, dynamic, area, area_cont_20ft, area_cont_40ft, area_cont_45ft, area_cont_53ft, cont_2x20ft, none, area_cylinder, area_logger, auxiliary_only''
 +
|-
 +
|lashing_method
 +
|token
 +
|
 +
|''required''
 +
|The method at how the cargo lashings (straps) will connect and strap cargo down '''->''' ''direct, direct_diagonal, top_over, none''
 
|-
 
|-
−
|data_path
+
|lashing_gear_type
−
|array<string>
+
|token
 
|
 
|
−
|Paths to definitions of compatible cargo accessories, one of which will be chosen pseudo-randomly during job generation. The expected unit type is [[Documentation/Engine/Units/accessory_cargo_data|'''accessory_cargo_data''']].
+
|''required''
 +
|The 'hardware' and strap 'type' that is used to lash cargo down '''->''' ''chain, strap''  
 
|}
 
|}
 +
 +
== Example SII File ==
 +
 +
This is an example of the unit class being used found at '''/def/vehicle/cargo/bricks/model_area.sii'''
 +
 +
<syntaxhighlight lang="text">
 +
SiiNunit
 +
{
 +
cargo_model_match : .area
 +
{
 +
data_path[]: "/def/vehicle/cargo/bricks/accessory_bricks.sii"
 +
 +
dimensions: (1.19, 0.97, 0.80)
 +
 +
loading_method: area
 +
lashing_method: top_over
 +
lashing_gear_type: strap
 +
}
 +
}
 +
‎</syntaxhighlight>

Revision as of 06:19, 2 April 2025

Starting with ETS2/ATS game version 1.54, cargoes will now use the new cargo system. The cargo_model_match unit class is used to define the location of the cargo model definition file as well as several new types of cargo related information as well as cargo (model) dimensions, if applicable. Units of this type are found in /def/vehicle/cargo/<cargo_name>/*.sii

Attributes

Name Type Default Value Necessity Description
data_path array<string> required Paths to definitions of compatible cargo accessories, one of which will be chosen pseudo-randomly during job generation. The expected unit type is accessory_cargo_data. Typically, this will point to a SII file located in the same cargo folder IE. /def/vehicle/cargo/<cargo_name>/*.sii
dimensions float3 required if using 'area' method Dimensions of the cargo model in meters using the format of L x H x W Ex. (2.30, 2.63, 3.22)
unit_volume_factor float opitional The factor at which a cargo's volume unit is impacted by the total weight of trailer's 'body'; typically used by container style cargo
loading_method token required The method the cargo will be loaded onto the trailer -> custom, dynamic, area, area_cont_20ft, area_cont_40ft, area_cont_45ft, area_cont_53ft, cont_2x20ft, none, area_cylinder, area_logger, auxiliary_only
lashing_method token required The method at how the cargo lashings (straps) will connect and strap cargo down -> direct, direct_diagonal, top_over, none
lashing_gear_type token required The 'hardware' and strap 'type' that is used to lash cargo down -> chain, strap

Example SII File

This is an example of the unit class being used found at /def/vehicle/cargo/bricks/model_area.sii 

SiiNunit
{
cargo_model_match : .area
{
	data_path[]: "/def/vehicle/cargo/bricks/accessory_bricks.sii"

	dimensions: (1.19, 0.97, 0.80)

	loading_method: area
	lashing_method: top_over
	lashing_gear_type: strap
}
}
‎
Retrieved from "https://modding.scssoft.com/index.php?title=Documentation/Engine/Units/cargo_model_match&oldid=5671"