Changes

Jump to navigation Jump to search

Documentation/Engine/Units/accessory addon data

1,130 bytes removed, 14:34, 15 October 2020
Undo revision 4756 by Smarty (talk) We don't want to keep subclasss realtions, because it's impossible to keep all links well documented.
The '''accessory_addon_data''' unit class is used for vehicle accessories that which add a visible component to a vehicle. This is most commonly used for customization of the [[Documentation/Engine/Game_data/Player_trucks_definitions|player's vehicle]]. It defines the paths to the visible models and their configuration (variant, look, excluded views), and the path to the collision mesh if applicable. Units of this type are typically found in '''/def/vehicle/truck/<makebrand.model>/accessory/<type>/*.sii''', but some special .{{Note|Some legacy accessories which don't directly interact with the player (eg . badges which are dependent on the engine/chassis configuration) may also be found in '''def/vehicle/truck/<makebrand.model>/<special_typetype>/*.sii'''because of legacy. So when creating new types always create them inside '''accessory''' subfolder.}}
== Attributes ==
!Name
![[Documentation/Engine/Units#Attribute_types|Type]]
!Required/OptionalDefault Value
!Description
|-
|exterior_model
|string
|optional|Path to the model descriptor (.pmd) for the model to be displayed in the exterior view (if applicable).
|-
|exterior_model_uk
|string
|optional|Path to the model descriptor (.pmd) for the model to be displayed in the exterior view for left-hand drive vehicles (if applicable). If unset, defaults to '''exterior_model'''.
|-
|interior_model
|string
|optional|Path to the model descriptor (.pmd) for the model to be displayed in the interior view (if applicable).
|-
|interior_model_uk
|string
|optional|Path to the model descriptor (.pmd) for the model to be displayed in the interior view for left-hand drive vehicles (if applicable). If unset, defaults to '''interior_model'''.
|-
|coll
|string
|optional|Path to the collision mesh descriptor (.pmc) for the accessory (if applicable).
|-
|look
|token
|optionaldefault|Selects Name of the look to be used on all models. If unset, defaults to ''default''descriptors of this accessory.
{{Note|All models for an accessory must have the same set of looks.}}
|-
|variant
|token
|optionaldefault|Selects Name of the variant to be used on all models. If unset, defaults to ''default''descriptors of this accessory.
{{Note|All models for an accessory must have the same set of variants.}}
|-
|hide_in
|u32
|optional0
|Flag for &ldquo;hiding&ldquo; accessory from being drawn in specific views. Valid values can be calculated [http://eurotrucksimulator2.com/modding_changes_114.php#Hide%20following%20views here].
{{Note|Accessories whose model references textures containing the mirror reflection (e.g. the mirrors mirror itself) '''MUST''' be marked as not visible in the mirrors. Previously there was a special mechanism to handle this however the now game exclusively relies on hide_in attribute to handle that. }}
|}
 
== Subclasses ==
*[[Documentation/Engine/Units/accessory_addon_int_data|accessory_addon_int_data]] (adds toy physics)
*[[Documentation/Engine/Units/accessory_addon_patch_data|accessory_addon_patch_data]] (adds cloth/flag physics)
 
== Raw Unit Definition ==
<pre style="max-height:300px;overflow:auto"> "accessory_addon_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"
},
"exterior_model":{
"type": "string"
},
"interior_model":{
"type": "string"
},
"exterior_model_uk":{
"type": "string"
},
"interior_model_uk":{
"type": "string"
},
"coll":{
"type": "string"
},
"look":{
"type": "token"
},
"variant":{
"type": "token"
},
"hide_in":{
"type": "u32"
}
}
},</pre>

Navigation menu