Added HDFirearm property PreFireSound, which is used to define a sound that should play exactly once before the weapon fires.

Fixed HDFirearm DeactivationSound so it's not completely broken. It'll also play when the trigger is held til the gun runs out of ammo, so it's pretty reliable
Cleaned up a HDFirearm Activate and Deactivate a little as I passed by
Made it so all HDFirearm sounds will update their positions, not just active and deactivation sounds

Author: garethyr

Entities/HDFirearm.cpp

@@ -35,6 +35,7 @@ void HDFirearm::Clear()
     m_pMagazine = 0;
 
     m_pFlash = 0;
+    m_PreFireSound.Reset();
     m_FireSound.Reset();
     m_FireEchoSound.Reset();
     m_ActiveSound.Reset();
@@ -112,6 +113,7 @@ int HDFirearm::Create(const HDFirearm &reference)
         m_pFlash = dynamic_cast<Attachable *>(reference.m_pFlash->Clone());
         m_pFlash->Attach(this, m_pFlash->GetParentOffset());
     }
+    m_PreFireSound = reference.m_PreFireSound;
     m_FireSound = reference.m_FireSound;
     m_FireEchoSound = reference.m_FireEchoSound;
     m_ActiveSound = reference.m_ActiveSound;
@@ -174,8 +176,10 @@ int HDFirearm::ReadProperty(std::string propName, Reader &reader)
             if (m_pFlash)
                 m_pFlash->Attach(this);
         }
-    }
-    else if (propName == "FireSound")
+    } else if (propName == "PreFireSound") {
+        reader >> m_PreFireSound;
+        m_DeactivationSound.SetSoundOverlapMode(SoundContainer::SoundOverlapMode::MODE_IGNORE_PLAY);
+    } else if (propName == "FireSound")
         reader >> m_FireSound;
     else if (propName == "FireEchoSound") {
         reader >> m_FireEchoSound;
@@ -184,6 +188,7 @@ int HDFirearm::ReadProperty(std::string propName, Reader &reader)
         reader >> m_ActiveSound;
     } else if (propName == "DeactivationSound") {
         reader >> m_DeactivationSound;
+        m_DeactivationSound.SetSoundOverlapMode(SoundContainer::SoundOverlapMode::MODE_IGNORE_PLAY);
     } else if (propName == "EmptySound")
         reader >> m_EmptySound;
     else if (propName == "ReloadStartSound")
@@ -258,6 +263,8 @@ int HDFirearm::Save(Writer &writer) const
     writer << m_pMagazine;
     writer.NewProperty("Flash");
     writer << m_pFlash;
+    writer.NewProperty("PreFireSound");
+    writer << m_PreFireSound;
     writer.NewProperty("FireSound");
     writer << m_FireSound;
     writer.NewProperty("FireEchoSound");
@@ -318,6 +325,7 @@ void HDFirearm::Destroy(bool notInherited)
 {
     delete m_pMagazine;
     delete m_pFlash;
+    m_PreFireSound.Stop();
     m_FireSound.Stop();
     m_FireEchoSound.Stop();
     m_ActiveSound.Stop();
@@ -562,13 +570,14 @@ void HDFirearm::SetID(const MOID newID)
 // Description:     Activates one of this HDFirearm's features. Analogous to 'pulling
 //                  the trigger'.
 
-void HDFirearm::Activate()
-{
+void HDFirearm::Activate() {
+    bool wasActivated = m_Activated;
     HeldDevice::Activate();
 
-    // Play the pre-fire sound
-    if (!IsReloading() && !m_ActiveSound.IsBeingPlayed())
-        m_ActiveSound.Play(this->m_Pos);
+    if (!IsReloading()) {
+        if (!m_ActiveSound.IsBeingPlayed()) { m_ActiveSound.Play(this->m_Pos); }
+        if (!wasActivated && !m_PreFireSound.IsBeingPlayed()) { m_PreFireSound.Play(this->m_Pos); }
+    }
 }
 
 
@@ -578,18 +587,14 @@ void HDFirearm::Activate()
 // Description:     Deactivates one of this HDFirearm's features. Analogous to 'releasing
 //                  the trigger'.
 
-void HDFirearm::Deactivate()
-{
+void HDFirearm::Deactivate() {
+    bool wasActivated = m_Activated;
     HeldDevice::Deactivate();
     m_FiredOnce = false;
 
-    // Stop any looping fire sounds
-    if (m_FireSound.GetLoopSetting() == -1 && m_FireSound.IsBeingPlayed())
-        m_FireSound.Stop();
-
-    // Play the post-fire sound
-    if (!m_DeactivationSound.IsBeingPlayed())
-        m_DeactivationSound.Play(m_Pos);
+    m_PreFireSound.Stop();
+    if (m_FireSound.GetLoopSetting() == -1) { m_FireSound.Stop(); }
+    if (wasActivated && m_pMagazine && !m_pMagazine->IsEmpty() && !m_DeactivationSound.IsBeingPlayed()) { m_DeactivationSound.Play(m_Pos); }
 }
 
 //////////////////////////////////////////////////////////////////////////////////////////
@@ -698,6 +703,8 @@ void HDFirearm::Update()
 {
     HeldDevice::Update();
 
+    if (m_PreFireSound.IsBeingPlayed()) { m_PreFireSound.SetPosition(m_Pos); }
+    if (m_FireSound.IsBeingPlayed()) { m_FireSound.SetPosition(m_Pos); }
     if (m_ActiveSound.IsBeingPlayed()) { m_ActiveSound.SetPosition(m_Pos); }
     if (m_DeactivationSound.IsBeingPlayed()) { m_DeactivationSound.SetPosition(m_Pos); }
 
@@ -715,8 +722,7 @@ void HDFirearm::Update()
 
     if (m_pMagazine && !m_pMagazine->IsEmpty())
     {
-        if (m_Activated)
-        {
+        if (m_Activated && !m_PreFireSound.IsBeingPlayed()) {
 
             // Get the parent root of this AEmitter
 // TODO: Potentially get this once outside instead, like in attach/detach")
@@ -915,6 +921,7 @@ void HDFirearm::Update()
     {
         // Play empty pin click sound.
         m_EmptySound.Play(m_Pos);
+        m_DeactivationSound.Play(m_Pos);
         // Indicate that we have clicked once during the current activation. 
         m_AlreadyClicked = true;
 
@@ -934,6 +941,8 @@ void HDFirearm::Update()
             m_ActivationTimer.Reset();
             m_ActivationTimer.Reset();
             m_LastFireTmr.Reset();
+
+            if (m_Activated) { m_PreFireSound.Play(); }
         }
 
         m_Reloading = false;
@@ -946,6 +955,7 @@ void HDFirearm::Update()
         // Reset the click indicator.
         m_AlreadyClicked = false;
 
+        m_PreFireSound.Stop();
         // Stop any looping activation sounds
         if (m_FireSound.GetLoopSetting() == -1)// && m_FireSound.IsBeingPlayed())
             m_FireSound.Stop();

Entities/HDFirearm.h

@@ -741,6 +741,7 @@ ClassInfoGetters
     // Muzzle Flash Attachable. Owned
     Attachable *m_pFlash;
 
+    SoundContainer m_PreFireSound; //!< The sound this HDFirearm should play before it starts firing. Distinct from activation sound in that it will play exactly once per trigger pull and not pitch up.
     // The audio of this FireArm being fired.
     SoundContainer m_FireSound;
     SoundContainer m_FireEchoSound; //!< The audio that is played as the echo for the gun. Each shot will restart this sound, so it doesn't ever overlap.