StartShipWeaponConfig

StartShipWeaponConfig(, , , )

Description

StartShipWeaponConfig is called within a .ship file, called once per weapon mounted on the ship, although turrets with two barrels must only call this function once despite the turret effectively having two weapons. A ship may have more than one weapon fire from the same hardpoint and use the same or different animation. However, a ship should not have more than one weapon mounted in the same turret, as each weapon will attempt to control the rotation and elevation of the turret separately, often preventing all weapons from firing in that turret. Only weapons of the type Gimble or Fixed can safely fire from the same hardpoint (see the StartWeaponConfig function). Example

StartShipWeaponConfig(NewShipType, "Hgn_KineticAutoGun", "Weapon_FrontGun", "Fire")

Arguments 1. and : Reference to the ship or subsystem. Generally, this will be NewShipType or NewSubSystemType, respectively. 2.: The weapon to be mounted in the indicated sHardpoint. The value corresponds to the base name of the .wepn file. 3.: The node on the model from where the weapon will fire, as coded in the ship's .hod file. 4.: The name given to one of the animations defined in the ship's .events file. The animation provides the muzzle flash, sound of firing, and other special effects related to firing.