Documentation/Engine/Units/accessory horn addon data

From SCS Modding Wiki
< Documentation‎ | Engine‎ | Units
Revision as of 17:01, 9 July 2020 by Smarty (talk | contribs) (Shiny new page for shiny new unit.)

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

The accessory_horn_addon_data unit class is an extension of accessory_addon_data, used specifically for air horn accessories. If functions the same as accessory_addon_data, with the addition of the sound_path attribute used to bind a horn sound event to the accessory. This is most commonly used for customization of the player's vehicle. This unit type was added in 1.38.

Attributes

Many common attributes are inherited from accessory_data.

Name Type Default Value Description
exterior_model string Path to the model descriptor (.pmd) for the model to be displayed in the exterior view (if applicable).
exterior_model_uk string 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 Path to the model descriptor (.pmd) for the model to be displayed in the interior view (if applicable).
interior_model_uk string 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 Path to the collision descriptor (.pmc) for the accessory (if applicable).
look token default Name of the look to be used on all descriptors of this accessory.

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

variant token default Name of the variant to be used on all descriptors of this accessory.

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

hide_in u32 0 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 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.

sound_path string Path to the sound bank/event or soundref to be used for the horn accessory.