feature: ability to play sounds within the animation editor (AscensionGameDev#2180)

Adds the ability to play sounds within the animation editor and the ability to play sounds on frame 1 during layer animation preview

Author: Arufonsu

Intersect.Editor/Forms/Editors/frmAnimation.Designer.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Drawing;
 using System.Linq;
+using System.Media;
 using System.Windows.Forms;
 
 using DarkUI.Controls;
@@ -43,6 +44,10 @@ public partial class FrmAnimation : EditorForm
 
         private bool mPlayUpper;
 
+        private SoundPlayer soundPlayer = new();
+
+        private bool loopSoundOnPreview;
+
         private RenderTarget2D mUpperDarkness;
 
         private int mUpperFrame;
@@ -161,6 +166,7 @@ private void InitLocalization()
             lblName.Text = Strings.AnimationEditor.name;
             lblSound.Text = Strings.AnimationEditor.sound;
             chkCompleteSoundPlayback.Text = Strings.AnimationEditor.soundcomplete;
+            chkLoopSoundDuringPreview.Text = Strings.AnimationEditor.LoopSoundDuringPreview;
             labelDarkness.Text = Strings.AnimationEditor.simulatedarkness.ToString(scrlDarkness.Value);
             btnSwap.Text = Strings.AnimationEditor.swap;
 
@@ -284,6 +290,11 @@ private void chkCompleteSoundPlayback_CheckedChanged(object sender, EventArgs e)
             mEditorItem.CompleteSound = chkCompleteSoundPlayback.Checked;
         }
 
+        private void chkLoopSoundDuringPreview_CheckedChanged(object sender, EventArgs e)
+        {
+            loopSoundOnPreview = chkLoopSoundDuringPreview.Checked;
+        }
+
         private void cmbLowerGraphic_SelectedIndexChanged(object sender, EventArgs e)
         {
             mEditorItem.Lower.Sprite = TextUtils.SanitizeNone(cmbLowerGraphic?.Text);
@@ -294,6 +305,23 @@ private void cmbUpperGraphic_SelectedIndexChanged(object sender, EventArgs e)
             mEditorItem.Upper.Sprite = TextUtils.SanitizeNone(cmbUpperGraphic?.Text);
         }
 
+        private void btnPlaySound_Click(object sender, EventArgs e)
+        {
+            PlayAnimationSound();
+        }
+
+        private void PlayAnimationSound()
+        {
+            if (cmbSound.SelectedIndex <= 0)
+            {
+                return;
+            }
+
+            soundPlayer.SoundLocation = "resources/sounds/" + mEditorItem.Sound;
+
+            soundPlayer.Play();
+        }
+
         private void tmrLowerAnimation_Tick(object sender, EventArgs e)
         {
             if (mPlayLower)
@@ -303,6 +331,11 @@ private void tmrLowerAnimation_Tick(object sender, EventArgs e)
                 {
                     mLowerFrame = 0;
                 }
+
+                if (mLowerFrame == 1 && loopSoundOnPreview && !mPlayUpper)
+                {
+                    PlayAnimationSound();
+                }
             }
         }
 
@@ -489,6 +522,11 @@ private void tmrUpperAnimation_Tick(object sender, EventArgs e)
                 {
                     mUpperFrame = 0;
                 }
+
+                if (mUpperFrame == 1 && loopSoundOnPreview && (!mPlayLower || (mPlayLower && mPlayUpper)))
+                {
+                    PlayAnimationSound();
+                }
             }
         }
 
@@ -535,6 +573,7 @@ private void btnPlayLower_Click(object sender, EventArgs e)
             {
                 _tooltip.SetToolTip(btnPlayLower, Strings.AnimationEditor.Play);
                 btnPlayLower.ImageKey = "sharp_play_arrow_white_48dp.png";
+                soundPlayer.Stop();
             }
         }
 
@@ -562,6 +601,7 @@ private void btnPlayUpper_Click(object sender, EventArgs e)
             {
                 _tooltip.SetToolTip(btnPlayUpper, Strings.AnimationEditor.Play);
                 btnPlayUpper.ImageKey = "sharp_play_arrow_white_48dp.png";
+                soundPlayer.Stop();
             }
         }
 

Intersect.Editor/Forms/Editors/frmAnimation.cs

@@ -829,6 +829,9 @@ public partial struct AnimationEditor
             public static LocalizedString sound = @"Sound:";
 
             public static LocalizedString soundcomplete = @"Complete Sound Playback After Anim Dies";
+            
+            [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
+            public static LocalizedString LoopSoundDuringPreview = @"Loop sound during preview";
 
             public static LocalizedString swap = @"Swap Upper/Lower";