Documentation/Engine/Units/accessory cabin data

From SCS Modding Wiki
< Documentation‎ | Engine‎ | Units
Revision as of 20:19, 18 September 2016 by Smarty (talk | contribs) (New documentation for accessory_cabin_data. SCS guys please double-check LOD explanation and toll_tag.)

(diff) ← Older revision | Approved revision (diff) | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The accessory_cabin_data unit configures the models for the cabin of the player's vehicle. Units of this type are found in /def/vehicle/truck/<make.model>/cabin/.

Attributes

Many common attributes are inherited from accessory_data.

Name Type Required/Optional Description
detail_model string optional Path to the high level-of-detail mesh. This is generally unused, but can be used for fine detail or ‘expensive’ shader effects that are only visible very close to the vehicle.
model string required 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.
lods string array optional Paths to the reduced level-of-detail meshes, in order of increasing viewing distance (decreasing model complexity).
collision string optional Path to the collision mesh (.pmc).
variant token optional* Selects the variant to be used for all models/collisions defined. This is required if the cabin and chassis share a model as is currently the standard practice in ETS2 and ATS. Default value is default.

Note: All models defined for this accessory_cabin_data must have this variant name.

variant_uk token optional Selects the variant to be used for all models/collisions for right-hand-drive (RHD) vehicles. If unset, defaults to the same value as variant.

Note: All models defined for this accessory_cabin_data must have this variant name.

look token optional Selects the look to be used for all models defined. Default value is default.

Note: All models defined for this accessory_cabin_data must have this look name.

wiper_model string optional Path to the animated wiper model (.pmg)
wiper_anim resource_tie optional Path to the wiper animation (.pma)
wiper_model_uk string optional Path to the animated wiper model (.pmg) for RHD vehicles. If unset, defaults to the value of wiper_model.
wiper_anim_uk resource_tie optional Path to the wiper animation (.pma) for RHD vehicles. If unset, defaults to the value of wiper_anim.
drl_with_headlights float optional Sets the relative strength of the daytime running lights when the headlights are on. For the DRL to be off when the headlights are on, a value of 0 is used. If the DRL should stay on and not dim when the headlights are on, a value of 1 is used. An intermediate value will dim the DRL when the headlights are on, and a value greater than 1 will intensify the DRL when the headlights are on. The typical value in ETS2 is 0.4.
toll_tag string optional Currently unused.
suspension bool required When true, physical simulation of cabin air suspension is enabled.

Raw Unit Definition

  "accessory_cabin_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"
    },
    "variant":{
     "type": "token"
    },
    "variant_uk":{
     "type": "token"
    },
    "look":{
     "type": "token"
    },
    "wiper_model":{
     "type": "string"
    },
    "wiper_anim":{
     "type": "resource_tie"
    },
    "wiper_model_uk":{
     "type": "string"
    },
    "wiper_anim_uk":{
     "type": "resource_tie"
    },
    "drl_with_headlights":{
     "type": "float"
    },
    "toll_tag":{
     "type": "string"
    },
    "suspension":{
     "type": "bool"
    }
   }
  },