Documentation/Engine/Units/accessory chassis data

From SCS Modding Wiki
< Documentation‎ | Engine‎ | Units
Revision as of 20:11, 17 February 2017 by Smarty (talk | contribs) (Using new 'UnitDef' template. Other minor improvements to attribute descriptions.)

Jump to navigation Jump to search

The accessory_chassis_data unit class is used to define the chassis characteristics for the player's vehicle including axle weights, extended shadow parameters, and fluid capacities. It is also used to define chassis characteristics of trailers and AI vehicles. Units of this type are usually defined in /def/vehicle/truck/<make.model>/chassis/*.sii, /def/vehicle/trailer/<trailer_name>/*.sii, and /def/vehicle/ai/<vehicle_name>/chassis.sii.

Attributes

Many common attributes are inherited from accessory_data.

Name Type Default Value Description
detail_model string 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 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 Paths to the reduced level-of-detail meshes, in order of increasing viewing distance (decreasing model complexity).
collision string Path to the appropriate collision (.pmc) model.
trailer_brace_model string For trailer usage only. Path to the animated landing gear model.
trailer_brace_anim string For trailer usage only. Path to the landing gear animation.
trailer_brace_up_sound string For trailer usage only. Path to the sound to be played when retracting landing gear.
trailer_brace_down_sound string For trailer usage only. Path to the sound to be played when extending landing gear.
variant token default Variant to be used from detail_model, model, and lods.
variant_uk token Variant to be used in countries which drive on the left. If unspecified, defaults to the value of variant.
look token default Look to be used from detail_model, model, and lods.
shadow_texture string Texture to be used for basic shadow.
shadow_intensity float 1.0 Relative intensity of basic shadow.
extended_shadow_texture string Texture to be used for the extended (volumetric) shadow.
extended_shadow_intensity float 1.0 Relative intensity of the extended (volumetric) shadow.
extended_shadow_fadeout_start float Sets the distance in meters from the fakeshadow surface to begin fading the extended shadow.
extended_shadow_fadeout_length float Sets the length in meters over which to fade out the extended shadow.
extended_shadow_shared_model_variant token
ui_shadow string Path to the model descriptor (.pmd) for the UI shadow (used for the truck/trailer browser, thumbnail generation, etc).
tank_size float Fuel tank size in liters.
adblue_tank_size float 50 AdBlue/DEF tank size in liters.
residual_travel float_array For trucks and trailers. The limit of upwards and downwards travel in meters for each axle. Each array member corresponds to an axle, from front to back.
trailer_mass float For trailer usage only. Sets the unladen mass of the trailer.
powered_axle bool_array For truck usage only. When true, motive torque will be applied on the axle. Each array member corresponds to an axle, from front to back.
kerb_weight float_array For truck usage only. Assigns the static weight on each axle. Each array member corresponds to an axle, from front to back.
liftable_axle bool_array false For truck usage only. When true, the axle can be lifted. Each array member corresponds to an axle, from front to back.
powered_wheel bool_array Deprecated – use powered_axle instead.


Raw Unit Definition

  "accessory_chassis_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"
    },
    "trailer_brace_model":{
     "type": "string"
    },
    "trailer_brace_anim":{
     "type": "string"
    },
    "trailer_brace_up_sound":{
     "type": "string"
    },
    "trailer_brace_down_sound":{
     "type": "string"
    },
    "variant":{
     "type": "token"
    },
    "variant_uk":{
     "type": "token"
    },
    "look":{
     "type": "token"
    },
    "shadow_texture":{
     "type": "string"
    },
    "shadow_intensity":{
     "type": "float"
    },
    "extended_shadow_texture":{
     "type": "string"
    },
    "extended_shadow_intensity":{
     "type": "float"
    },
    "extended_shadow_fadeout_start":{
     "type": "float"
    },
    "extended_shadow_fadeout_length":{
     "type": "float"
    },
    "extended_shadow_shared_model_variant":{
     "type": "token"
    },
    "ui_shadow":{
     "type": "string"
    },
    "tank_size":{
     "type": "float"
    },
    "adblue_tank_size":{
     "type": "float"
    },
    "residual_travel":{
     "type": "float_array"
    },
    "trailer_mass":{
     "type": "float"
    },
    "powered_axle":{
     "type": "bool_array"
    },
    "kerb_weight":{
     "type": "float_array"
    },
    "liftable_axle":{
     "type": "bool_array"
    },
    "powered_wheel":{
     "type": "bool_array"
    }
   }
  },