Merge branch 'develop' into feature/npc-schedules

Pathoschild · Oct 30, 2024 · e77755f · e77755f
2 parents 30928fd + 8f39cce
commit e77755f
Show file tree

Hide file tree

Showing 156 changed files with 799 additions and 1,272 deletions.
diff --git a/Automate/Framework/GameLocationNameComparer.cs b/Automate/Framework/GameLocationNameComparer.cs
@@ -9,10 +9,7 @@ internal class GameLocationNameComparer : IEqualityComparer<GameLocation>
         /*********
         ** Public methods
         *********/
-        /// <summary>Determines whether the specified objects are equal.</summary>
-        /// <returns>true if the specified objects are equal; otherwise, false.</returns>
-        /// <param name="left">The first object to compare.</param>
-        /// <param name="right">The second object to compare.</param>
+        /// <inheritdoc />
         public bool Equals(GameLocation? left, GameLocation? right)
         {
             string? leftName = left?.NameOrUniqueName;
@@ -27,8 +24,7 @@ public bool Equals(GameLocation? left, GameLocation? right)
             return leftName == rightName;
         }
 
-        /// <summary>Get a hash code for the specified object.</summary>
-        /// <param name="obj">The value.</param>
+        /// <inheritdoc />
         public int GetHashCode(GameLocation obj)
         {
             return (obj.NameOrUniqueName ?? string.Empty).GetHashCode();

diff --git a/Automate/Framework/GenericObjectMachine.cs b/Automate/Framework/GenericObjectMachine.cs
@@ -28,13 +28,13 @@ internal abstract class GenericObjectMachine<TMachine> : BaseMachine<TMachine> w
         /*********
         ** Public methods
         *********/
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             return this.GetGenericState();
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         public override ITrackedStack? GetOutput()
         {
             return this.GetTracked(this.Machine.heldObject.Value, onEmpty: this.GenericReset);

diff --git a/Automate/Framework/Machines/Buildings/FishPondMachine.cs b/Automate/Framework/Machines/Buildings/FishPondMachine.cs
@@ -17,7 +17,7 @@ internal class FishPondMachine : BaseMachineForBuilding<FishPond>
         public FishPondMachine(FishPond pond, GameLocation location)
             : base(pond, location, BaseMachine.GetTileAreaFor(pond)) { }
 
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             if (this.Machine.isUnderConstruction())
@@ -28,15 +28,13 @@ public override MachineState GetState()
                 : MachineState.Processing;
         }
 
-        /// <summary>Get the machine output.</summary>
+        /// <inheritdoc />
         public override ITrackedStack? GetOutput()
         {
             return this.GetTracked(this.Machine.output.Value, onEmpty: this.OnOutputTaken);
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             return false; // no input

diff --git a/Automate/Framework/Machines/Buildings/JunimoHutMachine.cs b/Automate/Framework/Machines/Buildings/JunimoHutMachine.cs
@@ -57,7 +57,7 @@ gemBehavior is not JunimoHutBehavior.MoveIntoChests
                 || seedBehavior is not JunimoHutBehavior.MoveIntoChests;
         }
 
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             if (this.Machine.isUnderConstruction())
@@ -71,15 +71,13 @@ public override MachineState GetState()
                 : MachineState.Processing;
         }
 
-        /// <summary>Get the machine output.</summary>
+        /// <inheritdoc />
         public override ITrackedStack? GetOutput()
         {
             return this.GetTracked(this.GetNextOutput(), onEmpty: this.OnOutputTaken);
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             if (!this.HasInput)

diff --git a/Automate/Framework/Machines/Buildings/ShippingBinMachine.cs b/Automate/Framework/Machines/Buildings/ShippingBinMachine.cs
@@ -47,7 +47,7 @@ public ShippingBinMachine(ShippingBin bin, GameLocation location)
             this.Bin = bin;
         }
 
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             if (this.Bin?.isUnderConstruction() == true)
@@ -56,15 +56,13 @@ public override MachineState GetState()
             return MachineState.Empty; // always accepts items
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         public override ITrackedStack? GetOutput()
         {
             return null; // no output
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             // get next item

diff --git a/Automate/Framework/Machines/DataBasedObjectMachine.cs b/Automate/Framework/Machines/DataBasedObjectMachine.cs
@@ -70,7 +70,7 @@ public override bool SetInput(IStorage input)
             return addedInput;
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         /// <remarks>This implementation is based on <see cref="SObject.CheckForActionOnMachine"/>.</remarks>
         public override ITrackedStack? GetOutput()
         {

diff --git a/Automate/Framework/Machines/Objects/AutoGrabberMachine.cs b/Automate/Framework/Machines/Objects/AutoGrabberMachine.cs
@@ -20,23 +20,21 @@ internal class AutoGrabberMachine : GenericObjectMachine<SObject>
         public AutoGrabberMachine(SObject machine, GameLocation location, Vector2 tile)
             : base(machine, location, tile) { }
 
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             return this.GetNextOutput() != null
                 ? MachineState.Done
                 : MachineState.Processing;
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         public override ITrackedStack? GetOutput()
         {
             return this.GetTracked(this.GetNextOutput(), onEmpty: this.OnOutputTaken);
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             return false;

diff --git a/Automate/Framework/Machines/Objects/FeedHopperMachine.cs b/Automate/Framework/Machines/Objects/FeedHopperMachine.cs
@@ -26,23 +26,21 @@ public FeedHopperMachine(GameLocation location, Vector2 tile)
         public FeedHopperMachine(Building silo, GameLocation location)
             : base(location, BaseMachine.GetTileAreaFor(silo)) { }
 
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             return this.CanStoreHay(out _, out _)
                 ? MachineState.Empty // 'empty' insofar as it will accept more input, not necessarily empty
                 : MachineState.Disabled;
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         public override ITrackedStack? GetOutput()
         {
             return null;
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             if (!this.CanStoreHay(out GameLocation location, out int freeSpace))

diff --git a/Automate/Framework/Machines/Objects/MiniShippingBinMachine.cs b/Automate/Framework/Machines/Objects/MiniShippingBinMachine.cs
@@ -29,21 +29,19 @@ public MiniShippingBinMachine(Chest miniBin, GameLocation location)
             this.MiniBin = new ChestContainer(miniBin, location, miniBin.TileLocation, migrateLegacyOptions: false);
         }
 
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             return MachineState.Empty; // always accepts items
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         public override ITrackedStack? GetOutput()
         {
             return null; // no output
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             foreach (ITrackedStack tracker in input.GetItems().Where(p => p.Sample.canBeShipped()))

diff --git a/Automate/Framework/Machines/Objects/TapperMachine.cs b/Automate/Framework/Machines/Objects/TapperMachine.cs
@@ -30,15 +30,13 @@ public TapperMachine(SObject machine, GameLocation location, Vector2 tile, Tree
             this.Tree = tree;
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         public override ITrackedStack? GetOutput()
         {
             return this.GetTracked(this.Machine.heldObject.Value, onEmpty: this.Reset);
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             return false; // no input

diff --git a/Automate/Framework/Machines/TerrainFeatures/BushMachine.cs b/Automate/Framework/Machines/TerrainFeatures/BushMachine.cs
@@ -50,7 +50,7 @@ public BushMachine(Bush bush, GameLocation location, Rectangle tileArea)
             );
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         public override ITrackedStack GetOutput()
         {
             string itemId = this.Machine.GetShakeOffItem();
@@ -65,7 +65,7 @@ public override ITrackedStack GetOutput()
             return new TrackedItem(ItemRegistry.Create(itemId, count, quality), onReduced: this.OnOutputReduced);
         }
 
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             if (!this.IsInSeason.Value)
@@ -76,9 +76,7 @@ public override MachineState GetState()
                 : MachineState.Processing;
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             return false; // no input required

diff --git a/Automate/Framework/Machines/TerrainFeatures/FruitTreeMachine.cs b/Automate/Framework/Machines/TerrainFeatures/FruitTreeMachine.cs
@@ -19,7 +19,7 @@ internal class FruitTreeMachine : BaseMachine<FruitTree>
         public FruitTreeMachine(FruitTree tree, GameLocation location, Vector2 tile)
             : base(tree, location, BaseMachine.GetTileAreaFor(tile)) { }
 
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             if (this.Machine.growthStage.Value < FruitTree.treeStage)
@@ -30,7 +30,7 @@ public override MachineState GetState()
                 : MachineState.Processing;
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         public override ITrackedStack GetOutput()
         {
             FruitTree tree = this.Machine;
@@ -43,9 +43,7 @@ public override ITrackedStack GetOutput()
             return new TrackedItem(tree.fruit[^1], onReduced: item => tree.fruit.Remove(item));
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             return false; // no input

diff --git a/Automate/Framework/Machines/TerrainFeatures/TreeMachine.cs b/Automate/Framework/Machines/TerrainFeatures/TreeMachine.cs
@@ -58,7 +58,7 @@ public TreeMachine(Tree tree, GameLocation location, Vector2 tile, bool collectM
             );
         }
 
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             if (this.Machine.growthStage.Value < Tree.treeStage || this.Machine.stump.Value)
@@ -69,7 +69,7 @@ public override MachineState GetState()
                 : MachineState.Processing;
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         public override ITrackedStack? GetOutput()
         {
             Tree tree = this.Machine;
@@ -102,9 +102,7 @@ public override MachineState GetState()
             return null;
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             return false; // no input

diff --git a/Automate/Framework/Machines/Tiles/TrashCanMachine.cs b/Automate/Framework/Machines/Tiles/TrashCanMachine.cs
@@ -28,7 +28,7 @@ public TrashCanMachine(GameLocation location, Vector2 tile, string trashCanId)
             this.TrashCanId = this.GetActualTrashCanId(trashCanId);
         }
 
-        /// <summary>Get the machine's processing state.</summary>
+        /// <inheritdoc />
         public override MachineState GetState()
         {
             if (Game1.netWorldState.Value.CheckedGarbage.Contains(this.TrashCanId))
@@ -37,7 +37,7 @@ public override MachineState GetState()
             return MachineState.Done;
         }
 
-        /// <summary>Get the output item.</summary>
+        /// <inheritdoc />
         public override ITrackedStack? GetOutput()
         {
             // get item
@@ -50,9 +50,7 @@ public override MachineState GetState()
             return null;
         }
 
-        /// <summary>Provide input to the machine.</summary>
-        /// <param name="input">The available items.</param>
-        /// <returns>Returns whether the machine started processing an item.</returns>
+        /// <inheritdoc />
         public override bool SetInput(IStorage input)
         {
             return false; // no input

diff --git a/Automate/Framework/OverlayMenu.cs b/Automate/Framework/OverlayMenu.cs
@@ -51,8 +51,7 @@ public OverlayMenu(IModEvents events, IInputHelper inputHelper, IReflectionHelpe
         /*********
         ** Protected
         *********/
-        /// <summary>Draw the overlay to the screen under the UI.</summary>
-        /// <param name="spriteBatch">The sprite batch being drawn.</param>
+        /// <inheritdoc />
         [SuppressMessage("ReSharper", "PossibleLossOfFraction", Justification = "Deliberate discarded for conversion to tile coordinates.")]
         protected override void DrawWorld(SpriteBatch spriteBatch)
         {