Update audio controller to use properites for volume and all chapters past it

Author: AristurtleDev

articles/tutorials/building_2d_games/15_audio_controller/index.md

@@ -77,12 +77,6 @@ The `AudioController` provides methods to control the state of audio playback in
 
 [!code-csharp[](./snippets/audiocontroller.cs#state)]
 
-#### AudioController Volume Control
-
-The `AudioController` also provides methods to increase and decrease the global volume of songs and sound effects.  Add the following methods:
-
-[!code-csharp[](./snippets/audiocontroller.cs#volume)]
-
 #### AudioController IDisposable Implementation
 
 Finally, the `AudioController` implements the `IDisposable` interface.  Add the following methods:
@@ -127,7 +121,7 @@ The key changes made here are:
 
 Next, update the `Game1` class to use the audio controller for audio playback.  Open *Game1.cs* and make the following updates:
 
-[!code-csharp[](./snippets/game1.cs?highlight=45-46,77-78,101-102,196-197,220-221,274-290)]
+[!code-csharp[](./snippets/game1.cs?highlight=45-46,77-78,101-102,196-197,215-216,269-287)]
 
 The key changes made here are:
 
@@ -137,8 +131,8 @@ The key changes made here are:
 4. In [**Update**](xref:Microsoft.Xna.Framework.Game.Update(Microsoft.Xna.Framework.GameTime)) the audio manager is used to play the bounce and collect sound effects.
 5. In `CheckKeyboardInput` the following checks were added
    1. If the M key on the keyboard is pressed, it will toggle mute for all audio.
-   2. If the + key is pressed, the global volume is increased by `0.1f`.
-   3. If the - key is pressed, the global volume is decreased by `0.1f`.
+   2. If the + key is pressed, the song and sound effect volumes are increased by `0.1f`.
+   3. If the - key is pressed, the song and sound effect volumes are decreased by `0.1f`.
 
 Running the game now will produce the same result as the previous chapter, only now the lifetime of sound effects and the state management of audio is done through the new audio controller.  You can also mute and unumte the audio with the M key and increase and decrease the volume using the + and - keys.
 

articles/tutorials/building_2d_games/15_audio_controller/snippets/audiocontroller.cs

@@ -27,6 +27,64 @@ public class AudioController : IDisposable
     /// </summary>
     public bool IsMuted { get; private set; }
 
+/// <summary>
+    /// Gets or Sets the global volume of songs.
+    /// </summary>
+    /// <remarks>
+    /// If IsMuted is true, the getter will always return back 0.0f and the
+    /// setter will ignore setting the volume.
+    /// </remarks>
+    public float SongVolume
+    {
+        get
+        {
+            if(IsMuted)
+            {
+                return 0.0f;
+            }
+
+            return MediaPlayer.Volume;
+        }
+        set
+        {
+            if(IsMuted)
+            {
+                return;
+            }
+
+            MediaPlayer.Volume = Math.Clamp(value, 0.0f, 1.0f);
+        }
+    }
+
+    /// <summary>
+    /// Gets or Sets the global volume of sound effects.
+    /// </summary>
+    /// <remarks>
+    /// If IsMuted is true, the getter will always return back 0.0f and the
+    /// setter will ignore setting the volume.
+    /// </remarks>
+    public float SoundEffectVolume
+    {
+        get
+        {
+            if(IsMuted)
+            {
+                return 0.0f;
+            }
+
+            return SoundEffect.MasterVolume;
+        }
+        set
+        {
+            if(IsMuted)
+            {
+                return;
+            }
+
+            SoundEffect.MasterVolume = Math.Clamp(value, 0.0f, 1.0f);
+        }
+    }    
+
     /// <summary>
     /// Gets a value that indicates if this audio controller has been disposed.
     /// </summary>
@@ -236,32 +294,4 @@ public void ToggleMute()
         }
     }
     #endregion
-
-    #region volume
-    /// <summary>
-    /// Increases volume of all audio by the specified amount.
-    /// </summary>
-    /// <param name="amount">The amount to increase the audio by.</param>
-    public void IncreaseVolume(float amount)
-    {
-        if (!IsMuted)
-        {
-            MediaPlayer.Volume = Math.Min(MediaPlayer.Volume + amount, 1.0f);
-            SoundEffect.MasterVolume = Math.Min(SoundEffect.MasterVolume + amount, 1.0f);
-        }
-    }
-
-    /// <summary>
-    /// Decreases the volume of all audio by the specified amount.
-    /// </summary>
-    /// <param name="amount">The amount to decrease the audio by.</param>
-    public void DecreaseVolume(float amount)
-    {
-        if (!IsMuted)
-        {
-            MediaPlayer.Volume = Math.Max(MediaPlayer.Volume - amount, 0.0f);
-            SoundEffect.MasterVolume = Math.Max(SoundEffect.MasterVolume - amount, 0.0f);
-        }
-    }
-    #endregion
 }

articles/tutorials/building_2d_games/15_audio_controller/snippets/game1.cs

@@ -201,14 +201,9 @@ protected override void Update(GameTime gameTime)
 
         if (slimeBounds.Intersects(batBounds))
         {
-            // Divide the width  and height of the screen into equal columns and
-            // rows based on the width and height of the bat.
-            int totalColumns = GraphicsDevice.PresentationParameters.BackBufferWidth / (int)_bat.Width;
-            int totalRows = GraphicsDevice.PresentationParameters.BackBufferHeight / (int)_bat.Height;
-
             // Choose a random row and column based on the total number of each
-            int column = Random.Shared.Next(0, totalColumns);
-            int row = Random.Shared.Next(0, totalRows);
+            int column = Random.Shared.Next(1, _tilemap.Columns - 1);
+            int row = Random.Shared.Next(1, _tilemap.Rows - 1);
 
             // Change the bat position by setting the x and y values equal to
             // the column and row multiplied by the width and height.
@@ -280,13 +275,15 @@ private void CheckKeyboardInput()
         // If the + button is pressed, increase the volume.
         if (Input.Keyboard.WasKeyJustPressed(Keys.OemPlus))
         {
-            Audio.IncreaseVolume(0.1f);
+            Audio.SongVolume += 0.1f;
+            Audio.SoundEffectVolume += 0.1f;
         }
 
         // If the - button was pressed, decrease the volume.
         if (Input.Keyboard.WasKeyJustPressed(Keys.OemMinus))
         {
-            Audio.DecreaseVolume(0.1f);
+            Audio.SongVolume += 0.1f;
+            Audio.SoundEffectVolume += 0.1f;
         }
     }
 
@@ -365,4 +362,4 @@ protected override void Draw(GameTime gameTime)
 
         base.Draw(gameTime);
     }
-}
+}

articles/tutorials/building_2d_games/16_working_with_spritefonts/index.md

@@ -207,7 +207,7 @@ The key changes here are:
 
 Finally, open the *Game1.cs* file and make the following changes:
 
-[!code-csharp[](./snippets/game1.cs?highlight=48-58,93-99,126-127,248-249,391-402)]
+[!code-csharp[](./snippets/game1.cs?highlight=48-58,93-99,126-127,243-244,388-399)]
 
 The key changes made are:
 

articles/tutorials/building_2d_games/16_working_with_spritefonts/snippets/game1.cs

@@ -226,14 +226,9 @@ protected override void Update(GameTime gameTime)
 
         if (slimeBounds.Intersects(batBounds))
         {
-            // Divide the width  and height of the screen into equal columns and
-            // rows based on the width and height of the bat.
-            int totalColumns = GraphicsDevice.PresentationParameters.BackBufferWidth / (int)_bat.Width;
-            int totalRows = GraphicsDevice.PresentationParameters.BackBufferHeight / (int)_bat.Height;
-
             // Choose a random row and column based on the total number of each
-            int column = Random.Shared.Next(0, totalColumns);
-            int row = Random.Shared.Next(0, totalRows);
+            int column = Random.Shared.Next(1, _tilemap.Columns - 1);
+            int row = Random.Shared.Next(1, _tilemap.Rows - 1);
 
             // Change the bat position by setting the x and y values equal to
             // the column and row multiplied by the width and height.
@@ -308,13 +303,15 @@ private void CheckKeyboardInput()
         // If the + button is pressed, increase the volume.
         if (Input.Keyboard.WasKeyJustPressed(Keys.OemPlus))
         {
-            Audio.IncreaseVolume(0.1f);
+            Audio.SongVolume += 0.1f;
+            Audio.SoundEffectVolume += 0.1f;
         }
 
         // If the - button was pressed, decrease the volume.
         if (Input.Keyboard.WasKeyJustPressed(Keys.OemMinus))
         {
-            Audio.DecreaseVolume(0.1f);
+            Audio.SongVolume -= 0.1f;
+            Audio.SoundEffectVolume -= 0.1f;
         }
     }
 
@@ -406,4 +403,4 @@ protected override void Draw(GameTime gameTime)
 
         base.Draw(gameTime);
     }
-}
+}

articles/tutorials/building_2d_games/17_scenes/snippets/gamescene.cs

@@ -309,13 +309,15 @@ private void CheckKeyboardInput()
         // If the + button is pressed, increase the volume.
         if (keyboard.WasKeyJustPressed(Keys.OemPlus))
         {
-            Core.Audio.IncreaseVolume(0.1f);
+            Core.Audio.SongVolume += 0.1f;
+            Core.Audio.SoundEffectVolume += 0.1f;
         }
 
         // If the - button was pressed, decrease the volume.
         if (keyboard.WasKeyJustPressed(Keys.OemMinus))
         {
-            Core.Audio.DecreaseVolume(0.1f);
+            Core.Audio.SongVolume -= 0.1f;
+            Core.Audio.SoundEffectVolume -= 0.1f;
         }
     }