Review/simon (#2)

* Ch 2 fixes

* Clean usings

* Ch 3 code review

Author: SimonDarksideJ

articles/tutorials/advanced/2d_shaders/02_hot_reload/index.md

@@ -1,9 +1,6 @@
-using System;  
-using System.Diagnostics;  
-using System.IO;  
-using Microsoft.Xna.Framework.Content;  
-using Microsoft.Xna.Framework.Graphics;  
-using MonoGameLibrary.Graphics;  
+using System;
+using System.IO;
+using Microsoft.Xna.Framework.Content;
 
 namespace MonoGameLibrary.Content;  
 

articles/tutorials/advanced/2d_shaders/02_hot_reload/snippets/snippet-2-17.cs

@@ -0,0 +1,11 @@
+using System;
+using DungeonSlime.GameObjects;
+using DungeonSlime.UI;
+using Microsoft.Xna.Framework;
+using Microsoft.Xna.Framework.Audio;
+using Microsoft.Xna.Framework.Graphics;
+using MonoGameGum;
+using MonoGameLibrary;
+using MonoGameLibrary.Content;
+using MonoGameLibrary.Graphics;
+using MonoGameLibrary.Scenes;

articles/tutorials/advanced/2d_shaders/02_hot_reload/snippets/snippet-2-19-usings.cs

@@ -0,0 +1,21 @@
+    public override void Draw(GameTime gameTime)
+    {
+        // Clear the back buffer.
+        Core.GraphicsDevice.Clear(Color.CornflowerBlue);
+
+        if (_state != GameState.Playing)
+        {
+            // We are in a game over state, so apply the saturation parameter.
+            _grayscaleEffect.Asset.Parameters["Saturation"].SetValue(_saturation);
+
+            // And begin the sprite batch using the grayscale effect.
+            Core.SpriteBatch.Begin(samplerState: SamplerState.PointClamp, effect: _grayscaleEffect.Asset);
+        }
+        else
+        {
+            // Otherwise, just begin the sprite batch as normal.
+            Core.SpriteBatch.Begin(samplerState: SamplerState.PointClamp);
+        }
+
+        
+        // Rest of the Draw method...

articles/tutorials/advanced/2d_shaders/02_hot_reload/snippets/snippet-2-22-draw.cs

@@ -1,7 +1,5 @@
 public static bool TryRefresh<T>(this ContentManager manager, WatchedAsset<T> watchedAsset)
 {
-    oldAsset = default;
-
     // get the same path that the ContentManager would use to load the asset
     var path = Path.Combine(manager.RootDirectory, watchedAsset.AssetName) + ".xnb";
 

articles/tutorials/advanced/2d_shaders/02_hot_reload/snippets/snippet-2-23.cs

@@ -1,20 +1,27 @@
 public static bool TryRefresh<T>(this ContentManager manager, WatchedAsset<T> watchedAsset)
 {
-    oldAsset = default;
-    
+    // get the same path that the ContentManager would use to load the asset
     var path = Path.Combine(manager.RootDirectory, watchedAsset.AssetName) + ".xnb";
+
+    // ask the operating system when the file was last written.
     var lastWriteTime = File.GetLastWriteTime(path);
-    
+
+    //  when the file's write time is less recent than the asset's latest read time, 
+    //  then the asset does not need to be reloaded.
     if (lastWriteTime <= watchedAsset.UpdatedAt)
     {
         return false;
     }
 
-    if (IsFileLocked(path)) return false; // wait for the file to not be locked.
-    
+    // wait for the file to not be locked.
+    if (IsFileLocked(path)) return false;
+
+    // clear the old asset to avoid leaking
     manager.UnloadAsset(watchedAsset.AssetName);
+
+    // load the new asset and update the latest read time
     watchedAsset.Asset = manager.Load<T>(watchedAsset.AssetName);
     watchedAsset.UpdatedAt = lastWriteTime;
-    
+
     return true;
 }

articles/tutorials/advanced/2d_shaders/02_hot_reload/snippets/snippet-2-27.cs

@@ -1,21 +1,32 @@
 public static bool TryRefresh<T>(this ContentManager manager, WatchedAsset<T> watchedAsset, out T oldAsset)
 {
     oldAsset = default;
-    
+
+    // get the same path that the ContentManager would use to load the asset
     var path = Path.Combine(manager.RootDirectory, watchedAsset.AssetName) + ".xnb";
+
+    // ask the operating system when the file was last written.
     var lastWriteTime = File.GetLastWriteTime(path);
-    
+
+    //  when the file's write time is less recent than the asset's latest read time, 
+    //  then the asset does not need to be reloaded.
     if (lastWriteTime <= watchedAsset.UpdatedAt)
     {
         return false;
     }
 
-    if (IsFileLocked(path)) return false; // wait for the file to not be locked.
-    
+    // wait for the file to not be locked.
+    if (IsFileLocked(path)) return false;
+
+    // clear the old asset to avoid leaking
     manager.UnloadAsset(watchedAsset.AssetName);
+
+    // return the old asset
     oldAsset = watchedAsset.Asset;
+
+    // load the new asset and update the latest read time
     watchedAsset.Asset = manager.Load<T>(watchedAsset.AssetName);
     watchedAsset.UpdatedAt = lastWriteTime;
-    
+
     return true;
 }

articles/tutorials/advanced/2d_shaders/02_hot_reload/snippets/snippet-2-29.cs

@@ -1,25 +1,38 @@
-
 public static bool TryRefresh<T>(this ContentManager manager, WatchedAsset<T> watchedAsset, out T oldAsset)
 {
     oldAsset = default;
-    
-    if (manager != watchedAsset.Owner)  
+
+    // ensure the ContentManager is the same one that loaded the asset
+    if (manager != watchedAsset.Owner)
+    {
         throw new ArgumentException($"Used the wrong ContentManager to refresh {watchedAsset.AssetName}");
+    }
+
+    // get the same path that the ContentManager would use to load the asset
+        var path = Path.Combine(manager.RootDirectory, watchedAsset.AssetName) + ".xnb";
 
-    var path = Path.Combine(manager.RootDirectory, watchedAsset.AssetName) + ".xnb";
+    // ask the operating system when the file was last written.
     var lastWriteTime = File.GetLastWriteTime(path);
-    
+
+    //  when the file's write time is less recent than the asset's latest read time, 
+    //  then the asset does not need to be reloaded.
     if (lastWriteTime <= watchedAsset.UpdatedAt)
     {
         return false;
     }
 
-    if (IsFileLocked(path)) return false; // wait for the file to not be locked.
-    
+    // wait for the file to not be locked.
+    if (IsFileLocked(path)) return false;
+
+    // clear the old asset to avoid leaking
     manager.UnloadAsset(watchedAsset.AssetName);
+
+    // return the old asset
     oldAsset = watchedAsset.Asset;
+
+    // load the new asset and update the latest read time
     watchedAsset.Asset = manager.Load<T>(watchedAsset.AssetName);
     watchedAsset.UpdatedAt = lastWriteTime;
-    
+
     return true;
 }

articles/tutorials/advanced/2d_shaders/02_hot_reload/snippets/snippet-2-33.cs

@@ -1,4 +1,7 @@
-public bool TryRefresh(out T oldAsset)  
-{  
-    return Owner.TryRefresh(this, out oldAsset);  
+/// <summary>  
+/// Attempts to refresh the asset if it has changed on disk using the registered owner <see cref="ContentManager"/>.  
+/// </summary>
+public bool TryRefresh(out T oldAsset)
+{
+    return Owner.TryRefresh(this, out oldAsset);
 }