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

From SCS Modding Wiki
Jump to navigation Jump to search
(New page for accessory_addon_data unit type.)
 
m (Slight rewording and added relevant wikilink to player truck definitions)
Line 1: Line 1:
The '''accessory_addon_data''' unit is used for vehicle accessories that add a visible component to the 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/<make.model>/accessory/<type>/*.sii''', but some special 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/<make.model>/<special_type>/*.sii'''.
+
The '''accessory_addon_data''' unit is used for vehicle accessories that 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/<make.model>/accessory/<type>/*.sii''', but some special 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/<make.model>/<special_type>/*.sii'''.
  
 
== Attributes ==
 
== Attributes ==

Revision as of 17:46, 18 September 2016

The accessory_addon_data unit is used for vehicle accessories that add a visible component to a vehicle. This is most commonly used for customization of the 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/<make.model>/accessory/<type>/*.sii, but some special 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/<make.model>/<special_type>/*.sii.

Attributes

Many common attributes are inherited from accessory_data.

Name Type Required/Optional Description
exterior_model string optional Path to the descriptor (.pmd) for the model to be displayed in the exterior view (if applicable).
exterior_model_uk string optional Path to the 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 descriptor (.pmd) for the model to be displayed in the interior view (if applicable).
interior_model_uk string optional Path to the 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 (.pmc) for the accessory (if applicable).
look token optional Selects the look to be used on all models. If unset, defaults to default.

Note: All models for an accessory must have the same set of looks.

variant token optional Selects the variant to be used on all models. If unset, defaults to default.

Note: All models for an accessory must have the same set of variants.

hide_in u32 optional Flag for “hiding“ accessory from being drawn in specific views. Valid values can be calculated here.

Note: Accessories whose model references textures containing the mirror reflection (e.g. the mirrors itself) MUST be marked as not visible in the mirrors. Previously there was special mechanism to handle this however the now game exclusively relies on hide_in attribute to handle that.

Subclasses

Raw Unit Definition

  "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"
    }
   }
  },