Difference between revisions of "Documentation/Engine/Units/trailer def"
< Documentation | Engine | Units
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | |||
| − | |||
The '''trailer_def''' unit class acts as an intermediary between [[Documentation/Engine/Units/cargo_data|cargo_data]] and [[Documentation/Engine/Units/trailer|trailer]] units. Units of this type are usually defined in '''/def/cargo/<cargo_name>/<trailer_name>.sii''', corresponding to '''def/cargo/<cargo_name>.sii'''. They define which trailer configuration to enable for the cargo, the cargo's mass for that trailer configuration, how that mass is distributed/placed on the trailer and its slave units, and where the configuration is permitted. | The '''trailer_def''' unit class acts as an intermediary between [[Documentation/Engine/Units/cargo_data|cargo_data]] and [[Documentation/Engine/Units/trailer|trailer]] units. Units of this type are usually defined in '''/def/cargo/<cargo_name>/<trailer_name>.sii''', corresponding to '''def/cargo/<cargo_name>.sii'''. They define which trailer configuration to enable for the cargo, the cargo's mass for that trailer configuration, how that mass is distributed/placed on the trailer and its slave units, and where the configuration is permitted. | ||
| Line 18: | Line 16: | ||
|float | |float | ||
| | | | ||
| − | |The mass of the cargo for this trailer configuration in kilograms (kg). | + | |The total mass of the cargo for this trailer configuration in kilograms (kg). |
|- | |- | ||
|volume_factor | |volume_factor | ||
| Line 34: | Line 32: | ||
|array<token> | |array<token> | ||
| | | | ||
| − | |Each member is a <!--[[Documentation/Engine/Units/country_data|country]]-->country (state in ATS) where this trailer_def will be suitable for generated jobs. Both the origin and destination of a job must be in the ''country'' array for the trailer_def to be suitable for it. If unset, then the trailer_def is suitable in all countries. ''Added in 1.28.'' | + | |Each member is a <!--[[Documentation/Engine/Units/country_data|country]]-->country (or a state in ATS) where this trailer_def will be suitable for generated jobs. Both the origin and destination of a job must be in the ''country'' array for the trailer_def to be suitable for it. If unset, then the trailer_def is suitable in all countries. ''Added in 1.28.'' |
| + | |||
| + | For example, the following would be limited to only Nevada and Arizona: | ||
| + | <pre>country[]: az | ||
| + | country[]: nv</pre> | ||
|- | |- | ||
|cog_offset | |cog_offset | ||
| Line 45: | Line 47: | ||
|<pre>cargo_mass_ratio: 1 | |<pre>cargo_mass_ratio: 1 | ||
cargo_mass_ratio[0]: 1</pre> | cargo_mass_ratio[0]: 1</pre> | ||
| − | |Each member defines how much of the cargo mass and forces are borne by each trailer in the trailer configuration, starting with the ''master'' trailer and iterating through the ''slave'' trailers. | + | |Each member defines how much of the cargo mass and forces are borne by each trailer in the trailer configuration, starting with the ''master'' trailer and iterating through the ''slave'' trailers. These must add up to 1. |
|} | |} | ||
| + | |||
| + | == World of Trucks Compatibility == | ||
| + | World of Trucks jobs will make use of mod trailers if the following conditions are satisfied: | ||
| + | *The '''mass''' is equal to, or greater than the job's cargo mass. | ||
| + | *The '''length''' is compatible with the source and destination prefabs. | ||
| + | *The configuration is valid for the source and destination '''country'''. | ||
| + | *The trailer count is equal to the trailer count of the job (i.e. A multipivot trailer configuration won't be selected for a single-trailer job). | ||
== Related Units == | == Related Units == | ||
*[[Documentation/Engine/Units/cargo_data|cargo_data]] | *[[Documentation/Engine/Units/cargo_data|cargo_data]] | ||
*[[Documentation/Engine/Units/trailer|trailer]] | *[[Documentation/Engine/Units/trailer|trailer]] | ||
Revision as of 16:47, 21 January 2018
The trailer_def unit class acts as an intermediary between cargo_data and trailer units. Units of this type are usually defined in /def/cargo/<cargo_name>/<trailer_name>.sii, corresponding to def/cargo/<cargo_name>.sii. They define which trailer configuration to enable for the cargo, the cargo's mass for that trailer configuration, how that mass is distributed/placed on the trailer and its slave units, and where the configuration is permitted.
Attributes
| Name | Type | Default Value | Description |
|---|---|---|---|
| trailer | string | The unit name of the trailer unit to be enabled for the cargo. This attribute can safely refer to units which aren't present. | |
| mass | float | The total mass of the cargo for this trailer configuration in kilograms (kg). | |
| volume_factor | float | 1.0 | The amount of cargo relative to what the cargo definition is nominally based on. This allows the game economy to scale the pay per distance for trailers of different sizes hauling the same cargo. Added in 1.28.
Note: For example, if the cargo definition is nominally based on a 53ft trailer, the volume_factor for a 40ft trailer might be approximately 0.75 (40÷53). |
| length | uint | 0 | The approximate length of the trailer combination in meters. When generating a job this is compared against the allowed_trailer_length of the source and destination depot prefabs to determine whether this trailer_def is suitable for the job. The valid range is [0, 255]. If set to 0, no restrictions are applied. Added in 1.28. |
| country | array<token> | Each member is a country (or a state in ATS) where this trailer_def will be suitable for generated jobs. Both the origin and destination of a job must be in the country array for the trailer_def to be suitable for it. If unset, then the trailer_def is suitable in all countries. Added in 1.28.
For example, the following would be limited to only Nevada and Arizona: country[]: az country[]: nv | |
| cog_offset | array<float3> | Each member defines the offset of the cargo center of gravity from the calculated value for each trailer in the trailer configuration, starting with the master trailer and iterating through the slave trailers. (X, Y, Z) corresponds to lateral, vertical, and longitudinal offsets respectively. | |
| cargo_mass_ratio | array<float> | cargo_mass_ratio: 1 cargo_mass_ratio[0]: 1 |
Each member defines how much of the cargo mass and forces are borne by each trailer in the trailer configuration, starting with the master trailer and iterating through the slave trailers. These must add up to 1. |
World of Trucks Compatibility
World of Trucks jobs will make use of mod trailers if the following conditions are satisfied:
- The mass is equal to, or greater than the job's cargo mass.
- The length is compatible with the source and destination prefabs.
- The configuration is valid for the source and destination country.
- The trailer count is equal to the trailer count of the job (i.e. A multipivot trailer configuration won't be selected for a single-trailer job).
