Skip to content

🔫 Weapon

API Documentation

py_ballisticcalc.munition.Weapon

The way to define weapon properties in py-ballisticcalc is via Weapon dataclass. Weapon instances are simply and reusable.

Weapon initialization

Import the necessary types to create a Weapon instance 

from py_ballisticcalc import Weapon, Unit, Sight

Then create a weapon 

weapon = Weapon(
    sight_height=Unit.Inch(2.),
    twist=Unit.Inch(10.),
    zero_elevation=Unit.Mil(0),
    sight=Sight(
        'FFP', 2,
        h_click_size=Unit.Mil(0.2),
        v_click_size=Unit.Mil(0.2)
    )
)
In this example, we use calls to Unit to initialize Weapon fields with specific unit types. We also can do it using float's then fields will be initialized with unit types defined in PreferredUnit class, or we can directly specify the dimension with referencing to dimension type class

Fields of a Weapon can be accessed as normal attributes of weapon instance

Weapon instance is mutable object and field values can be changed through attribute assignment

Weapon methods and properties

Weapon possess the following methods and attributes:

  • sight_height: Sight height, given distance from barrel axis and sight lense axis
  • twist: Given barrel twist, accepted as ratio 1 / given value
  • zero_elevation: Barrel elevation - the angle that displays how barrel should be elevated to hit target on zeroing distance
  • sight: Sight type and properties

Note

See the API documentation of Weapon for the class definition including a full list of methods and attributes.