Skip to content

Latest commit

 

History

History
210 lines (140 loc) · 6.95 KB

caliber-asset.rst

File metadata and controls

210 lines (140 loc) · 6.95 KB
Raw

Caliber Assets

The ItemCaliberAsset class is a base class that other classes are derived from. It is unusable on its own.

Game Data File

The ItemCaliberAsset class inherits properties from the ItemAsset <doc_item_asset_intro> class.

Properties

Property Name Type Default Value
Aiming_Movement_Speed_Multiplier <doc_item_asset_caliber:aiming_movement_speed_multiplier> float32 <doc_data_builtin_types> 1
Aiming_Recoil_Multiplier <doc_item_asset_caliber:aiming_recoil_multiplier> float32 <doc_data_builtin_types> 1
Aim_Duration_Multiplier <doc_item_asset_caliber:aim_duration_multiplier> float32 <doc_data_builtin_types> 1
Ballistic_Damage_Multiplier <doc_item_asset_caliber:ballistic_damage_multiplier> float32 <doc_data_builtin_types> See description
Calibers <doc_item_asset_caliber:calibers> uint8 <doc_data_builtin_types> 0
Caliber_# <doc_item_asset_caliber:caliber_#> uint16 <doc_data_builtin_types> 0
Damage <doc_item_asset_caliber:damage> float32 <doc_data_builtin_types> deprecated
Destroy_Attachment_Colliders <doc_item_asset_caliber:destroy_attachment_colliders> bool <doc_data_builtin_types> true
Firerate <doc_item_asset_caliber:firerate> uint8 <doc_data_builtin_types> 0
Paintable <doc_item_asset_caliber:paintable> flag <doc_data_flag>
Recoil_X <doc_item_asset_caliber:recoil_x> float32 <doc_data_builtin_types> 1
Recoil_Y <doc_item_asset_caliber:recoil_y> float32 <doc_data_builtin_types> 1
Shake <doc_item_asset_caliber:shake> float32 <doc_data_builtin_types> 1
Spread <doc_item_asset_caliber:spread> float32 <doc_data_builtin_types> 1
Sway <doc_item_asset_caliber:sway> float32 <doc_data_builtin_types> 1

Property Descriptions

Aiming_Movement_Speed_Multiplier float32 <doc_data_builtin_types> 1

Multiplier on character movement speed while aiming down sights.

Aiming_Recoil_Multiplier float32 <doc_data_builtin_types> 1

Multiplier on recoil magnitude while aiming down sights.

Aim_Duration_Multiplier float32 <doc_data_builtin_types> 1

Multiplier on the value of Aim_In_Duration <doc_item_asset_gun:aim_in_duration> property available to the ItemGunAsset <doc_item_asset_gun> class.

Ballistic_Damage_Multiplier float32 <doc_data_builtin_types>

Multiplier on damage. Defaults to the value of the Damage property, or 1 if both properties are unset.

Caliber# uint16 <doc_data_builtin_types> 0

Legacy ID of a caliber to check for attachment compatibility. This property is used in conjunction with Calibers, which determines how many instances of this property should be read by the game.

When this property is unset, it will default to 0. When the Magazine_Calibers property is not greater than 0, this property will default to the value of Caliber.

Calibers uint8 <doc_data_builtin_types> 0

Set the length of the array containing the calibers for attachment compatibility. This property is used in conjunction with the Caliber_# property, and the value of Calibers should be equal to the number of instances of Caliber_#.

Damage float32 <doc_data_builtin_types>

3.27.0.0 Use Ballistic_Damage_Multiplier instead.

Maintained for backwards compatibility. If both this property and Ballistic_Damage_Multiplier have been set, the latter's value is used.

Destroy_Attachment_Colliders bool <doc_data_builtin_types> true

When false, colliders are not destroyed when the attached ranged weapon's colliders are destroyed. This property exists for backwards compatibility with mods that may have relied on attachments having colliders, but using this property is not recommended.

Caution

Mods with complex colliders on their custom attachments are frequently reported as causing low performance issues for players. It is recommended that your custom attachments do not rely on having colliders.

Firerate uint8 <doc_data_builtin_types> 0

The value of the attached ranged weapon's Firerate <doc_item_asset_gun:firerate> property is reduced by the value of this property. A larger decrease will allow for the ranged weapon to fire more often.

Paintable flag <doc_data_flag>

When this flag is included, the attachment should be affected by Steam Economy skins that include support for skinning attachments.

Recoil_X float32 <doc_data_builtin_types> 1

Multiplier on horizontal recoil.

Recoil_Y float32 <doc_data_builtin_types> 1

Multiplier on vertical recoil.

Shake float32 <doc_data_builtin_types> 1

Multiplier on shake.

Spread float32 <doc_data_builtin_types> 1

Multiplier on bullet spread.

Sway float32 <doc_data_builtin_types> 1

Multiplier on scope sway.