add IsCurrentLocation event arg to World events

docs/release-notes.md

@@ -1,4 +1,4 @@
-# Release notes
+# Release notes
 ## Upcoming release
 * For players:
   * Added `world_clear` console command to remove spawned or placed entities.
@@ -9,6 +9,7 @@
   * Added new [events](https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Events):
     * `GameLoop.OneSecondUpdateTicking` and `OneSecondUpdateTicked`;
     * `Specialised.LoadStageChanged`.
+  * Added `e.IsCurrentLocation` event arg to `World` events.
   * You can now use `helper.Data.Read/WriteSaveData` as soon as the save is loaded (instead of once the world is initialised).
 
 * For the web UI:

src/SMAPI/Events/BuildingListChangedEventArgs.cs

@@ -21,6 +21,9 @@ namespace StardewModdingAPI.Events
         /// <summary>The buildings removed from the location.</summary>
         public IEnumerable<Building> Removed { get; }
 
+        /// <summary>Whether this is the location containing the local player.</summary>
+        public bool IsCurrentLocation => object.ReferenceEquals(this.Location, Game1.player?.currentLocation);
+
 
         /*********
         ** Public methods

src/SMAPI/Events/DebrisListChangedEventArgs.cs

@@ -20,6 +20,9 @@ namespace StardewModdingAPI.Events
         /// <summary>The debris removed from the location.</summary>
         public IEnumerable<Debris> Removed { get; }
 
+        /// <summary>Whether this is the location containing the local player.</summary>
+        public bool IsCurrentLocation => object.ReferenceEquals(this.Location, Game1.player?.currentLocation);
+
 
         /*********
         ** Public methods

src/SMAPI/Events/LargeTerrainFeatureListChangedEventArgs.cs

@@ -21,6 +21,9 @@ namespace StardewModdingAPI.Events
         /// <summary>The large terrain features removed from the location.</summary>
         public IEnumerable<LargeTerrainFeature> Removed { get; }
 
+        /// <summary>Whether this is the location containing the local player.</summary>
+        public bool IsCurrentLocation => object.ReferenceEquals(this.Location, Game1.player?.currentLocation);
+
 
         /*********
         ** Public methods

src/SMAPI/Events/NpcListChangedEventArgs.cs

@@ -20,6 +20,9 @@ namespace StardewModdingAPI.Events
         /// <summary>The NPCs removed from the location.</summary>
         public IEnumerable<NPC> Removed { get; }
 
+        /// <summary>Whether this is the location containing the local player.</summary>
+        public bool IsCurrentLocation => object.ReferenceEquals(this.Location, Game1.player?.currentLocation);
+
 
         /*********
         ** Public methods

src/SMAPI/Events/ObjectListChangedEventArgs.cs

@@ -22,6 +22,9 @@ namespace StardewModdingAPI.Events
         /// <summary>The objects removed from the location.</summary>
         public IEnumerable<KeyValuePair<Vector2, Object>> Removed { get; }
 
+        /// <summary>Whether this is the location containing the local player.</summary>
+        public bool IsCurrentLocation => object.ReferenceEquals(this.Location, Game1.player?.currentLocation);
+
 
         /*********
         ** Public methods

src/SMAPI/Events/TerrainFeatureListChangedEventArgs.cs

@@ -22,6 +22,9 @@ namespace StardewModdingAPI.Events
         /// <summary>The terrain features removed from the location.</summary>
         public IEnumerable<KeyValuePair<Vector2, TerrainFeature>> Removed { get; }
 
+        /// <summary>Whether this is the location containing the local player.</summary>
+        public bool IsCurrentLocation => object.ReferenceEquals(this.Location, Game1.player?.currentLocation);
+
 
         /*********
         ** Public methods