Merge branch 'develop' into stable

5 files changed, 0 insertions, 295 deletions

diff --git a/src/StardewModdingAPI/Framework/Content/AssetData.cs b/src/StardewModdingAPI/Framework/Content/AssetData.cs
deleted file mode 100644
index 1ab9eebd..00000000
--- a/src/StardewModdingAPI/Framework/Content/AssetData.cs
+++ /dev/null
@@ -1,44 +0,0 @@
-using System;
-
-namespace StardewModdingAPI.Framework.Content
-{
-    /// <summary>Base implementation for a content helper which encapsulates access and changes to content being read from a data file.</summary>
-    /// <typeparam name="TValue">The interface value type.</typeparam>
-    internal class AssetData<TValue> : AssetInfo, IAssetData<TValue>
-    {
-        /*********
-        ** Accessors
-        *********/
-        /// <summary>The content data being read.</summary>
-        public TValue Data { get; protected set; }
-
-
-        /*********
-        ** Public methods
-        *********/
-        /// <summary>Construct an instance.</summary>
-        /// <param name="locale">The content's locale code, if the content is localised.</param>
-        /// <param name="assetName">The normalised asset name being read.</param>
-        /// <param name="data">The content data being read.</param>
-        /// <param name="getNormalisedPath">Normalises an asset key to match the cache key.</param>
-        public AssetData(string locale, string assetName, TValue data, Func<string, string> getNormalisedPath)
-            : base(locale, assetName, data.GetType(), getNormalisedPath)
-        {
-            this.Data = data;
-        }
-
-        /// <summary>Replace the entire content value with the given value. This is generally not recommended, since it may break compatibility with other mods or different versions of the game.</summary>
-        /// <param name="value">The new content value.</param>
-        /// <exception cref="ArgumentNullException">The <paramref name="value"/> is null.</exception>
-        /// <exception cref="InvalidCastException">The <paramref name="value"/>'s type is not compatible with the loaded asset's type.</exception>
-        public void ReplaceWith(TValue value)
-        {
-            if (value == null)
-                throw new ArgumentNullException(nameof(value), "Can't set a loaded asset to a null value.");
-            if (!this.DataType.IsInstanceOfType(value))
-                throw new InvalidCastException($"Can't replace loaded asset of type {this.GetFriendlyTypeName(this.DataType)} with value of type {this.GetFriendlyTypeName(value.GetType())}. The new type must be compatible to prevent game errors.");
-
-            this.Data = value;
-        }
-    }
-}
diff --git a/src/StardewModdingAPI/Framework/Content/AssetDataForDictionary.cs b/src/StardewModdingAPI/Framework/Content/AssetDataForDictionary.cs
deleted file mode 100644
index e9b29b12..00000000
--- a/src/StardewModdingAPI/Framework/Content/AssetDataForDictionary.cs
+++ /dev/null
@@ -1,45 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-
-namespace StardewModdingAPI.Framework.Content
-{
-    /// <summary>Encapsulates access and changes to dictionary content being read from a data file.</summary>
-    internal class AssetDataForDictionary<TKey, TValue> : AssetData<IDictionary<TKey, TValue>>, IAssetDataForDictionary<TKey, TValue>
-    {
-        /*********
-        ** Public methods
-        *********/
-        /// <summary>Construct an instance.</summary>
-        /// <param name="locale">The content's locale code, if the content is localised.</param>
-        /// <param name="assetName">The normalised asset name being read.</param>
-        /// <param name="data">The content data being read.</param>
-        /// <param name="getNormalisedPath">Normalises an asset key to match the cache key.</param>
-        public AssetDataForDictionary(string locale, string assetName, IDictionary<TKey, TValue> data, Func<string, string> getNormalisedPath)
-            : base(locale, assetName, data, getNormalisedPath) { }
-
-        /// <summary>Add or replace an entry in the dictionary.</summary>
-        /// <param name="key">The entry key.</param>
-        /// <param name="value">The entry value.</param>
-        public void Set(TKey key, TValue value)
-        {
-            this.Data[key] = value;
-        }
-
-        /// <summary>Add or replace an entry in the dictionary.</summary>
-        /// <param name="key">The entry key.</param>
-        /// <param name="value">A callback which accepts the current value and returns the new value.</param>
-        public void Set(TKey key, Func<TValue, TValue> value)
-        {
-            this.Data[key] = value(this.Data[key]);
-        }
-
-        /// <summary>Dynamically replace values in the dictionary.</summary>
-        /// <param name="replacer">A lambda which takes the current key and value for an entry, and returns the new value.</param>
-        public void Set(Func<TKey, TValue, TValue> replacer)
-        {
-            foreach (var pair in this.Data.ToArray())
-                this.Data[pair.Key] = replacer(pair.Key, pair.Value);
-        }
-    }
-}
diff --git a/src/StardewModdingAPI/Framework/Content/AssetDataForImage.cs b/src/StardewModdingAPI/Framework/Content/AssetDataForImage.cs
deleted file mode 100644
index 45c5588b..00000000
--- a/src/StardewModdingAPI/Framework/Content/AssetDataForImage.cs
+++ /dev/null
@@ -1,70 +0,0 @@
-using System;
-using Microsoft.Xna.Framework;
-using Microsoft.Xna.Framework.Graphics;
-
-namespace StardewModdingAPI.Framework.Content
-{
-    /// <summary>Encapsulates access and changes to dictionary content being read from a data file.</summary>
-    internal class AssetDataForImage : AssetData<Texture2D>, IAssetDataForImage
-    {
-        /*********
-        ** Public methods
-        *********/
-        /// <summary>Construct an instance.</summary>
-        /// <param name="locale">The content's locale code, if the content is localised.</param>
-        /// <param name="assetName">The normalised asset name being read.</param>
-        /// <param name="data">The content data being read.</param>
-        /// <param name="getNormalisedPath">Normalises an asset key to match the cache key.</param>
-        public AssetDataForImage(string locale, string assetName, Texture2D data, Func<string, string> getNormalisedPath)
-            : base(locale, assetName, data, getNormalisedPath) { }
-
-        /// <summary>Overwrite part of the image.</summary>
-        /// <param name="source">The image to patch into the content.</param>
-        /// <param name="sourceArea">The part of the <paramref name="source"/> to copy (or <c>null</c> to take the whole texture). This must be within the bounds of the <paramref name="source"/> texture.</param>
-        /// <param name="targetArea">The part of the content to patch (or <c>null</c> to patch the whole texture). The original content within this area will be erased. This must be within the bounds of the existing spritesheet.</param>
-        /// <param name="patchMode">Indicates how an image should be patched.</param>
-        /// <exception cref="ArgumentNullException">One of the arguments is null.</exception>
-        /// <exception cref="ArgumentOutOfRangeException">The <paramref name="targetArea"/> is outside the bounds of the spritesheet.</exception>
-        public void PatchImage(Texture2D source, Rectangle? sourceArea = null, Rectangle? targetArea = null, PatchMode patchMode = PatchMode.Replace)
-        {
-            // get texture
-            Texture2D target = this.Data;
-
-            // get areas
-            sourceArea = sourceArea ?? new Rectangle(0, 0, source.Width, source.Height);
-            targetArea = targetArea ?? new Rectangle(0, 0, Math.Min(sourceArea.Value.Width, target.Width), Math.Min(sourceArea.Value.Height, target.Height));
-
-            // validate
-            if (source == null)
-                throw new ArgumentNullException(nameof(source), "Can't patch from a null source texture.");
-            if (sourceArea.Value.X < 0 || sourceArea.Value.Y < 0 || sourceArea.Value.Right > source.Width || sourceArea.Value.Bottom > source.Height)
-                throw new ArgumentOutOfRangeException(nameof(sourceArea), "The source area is outside the bounds of the source texture.");
-            if (targetArea.Value.X < 0 || targetArea.Value.Y < 0 || targetArea.Value.Right > target.Width || targetArea.Value.Bottom > target.Height)
-                throw new ArgumentOutOfRangeException(nameof(targetArea), "The target area is outside the bounds of the target texture.");
-            if (sourceArea.Value.Width != targetArea.Value.Width || sourceArea.Value.Height != targetArea.Value.Height)
-                throw new InvalidOperationException("The source and target areas must be the same size.");
-
-            // get source data
-            int pixelCount = sourceArea.Value.Width * sourceArea.Value.Height;
-            Color[] sourceData = new Color[pixelCount];
-            source.GetData(0, sourceArea, sourceData, 0, pixelCount);
-
-            // merge data in overlay mode
-            if (patchMode == PatchMode.Overlay)
-            {
-                Color[] newData = new Color[targetArea.Value.Width * targetArea.Value.Height];
-                target.GetData(0, targetArea, newData, 0, newData.Length);
-                for (int i = 0; i < sourceData.Length; i++)
-                {
-                    Color pixel = sourceData[i];
-                    if (pixel.A != 0) // not transparent
-                        newData[i] = pixel;
-                }
-                sourceData = newData;
-            }
-
-            // patch target texture
-            target.SetData(0, targetArea, sourceData, 0, pixelCount);
-        }
-    }
-}
diff --git a/src/StardewModdingAPI/Framework/Content/AssetDataForObject.cs b/src/StardewModdingAPI/Framework/Content/AssetDataForObject.cs
deleted file mode 100644
index f30003e4..00000000
--- a/src/StardewModdingAPI/Framework/Content/AssetDataForObject.cs
+++ /dev/null
@@ -1,54 +0,0 @@
-using System;
-using System.Collections.Generic;
-using Microsoft.Xna.Framework.Graphics;
-
-namespace StardewModdingAPI.Framework.Content
-{
-    /// <summary>Encapsulates access and changes to content being read from a data file.</summary>
-    internal class AssetDataForObject : AssetData<object>, IAssetData
-    {
-        /*********
-        ** Public methods
-        *********/
-        /// <summary>Construct an instance.</summary>
-        /// <param name="locale">The content's locale code, if the content is localised.</param>
-        /// <param name="assetName">The normalised asset name being read.</param>
-        /// <param name="data">The content data being read.</param>
-        /// <param name="getNormalisedPath">Normalises an asset key to match the cache key.</param>
-        public AssetDataForObject(string locale, string assetName, object data, Func<string, string> getNormalisedPath)
-            : base(locale, assetName, data, getNormalisedPath) { }
-
-        /// <summary>Construct an instance.</summary>
-        /// <param name="info">The asset metadata.</param>
-        /// <param name="data">The content data being read.</param>
-        /// <param name="getNormalisedPath">Normalises an asset key to match the cache key.</param>
-        public AssetDataForObject(IAssetInfo info, object data, Func<string, string> getNormalisedPath)
-            : this(info.Locale, info.AssetName, data, getNormalisedPath) { }
-
-        /// <summary>Get a helper to manipulate the data as a dictionary.</summary>
-        /// <typeparam name="TKey">The expected dictionary key.</typeparam>
-        /// <typeparam name="TValue">The expected dictionary balue.</typeparam>
-        /// <exception cref="InvalidOperationException">The content being read isn't a dictionary.</exception>
-        public IAssetDataForDictionary<TKey, TValue> AsDictionary<TKey, TValue>()
-        {
-            return new AssetDataForDictionary<TKey, TValue>(this.Locale, this.AssetName, this.GetData<IDictionary<TKey, TValue>>(), this.GetNormalisedPath);
-        }
-
-        /// <summary>Get a helper to manipulate the data as an image.</summary>
-        /// <exception cref="InvalidOperationException">The content being read isn't an image.</exception>
-        public IAssetDataForImage AsImage()
-        {
-            return new AssetDataForImage(this.Locale, this.AssetName, this.GetData<Texture2D>(), this.GetNormalisedPath);
-        }
-
-        /// <summary>Get the data as a given type.</summary>
-        /// <typeparam name="TData">The expected data type.</typeparam>
-        /// <exception cref="InvalidCastException">The data can't be converted to <typeparamref name="TData"/>.</exception>
-        public TData GetData<TData>()
-        {
-            if (!(this.Data is TData))
-                throw new InvalidCastException($"The content data of type {this.Data.GetType().FullName} can't be converted to the requested {typeof(TData).FullName}.");
-            return (TData)this.Data;
-        }
-    }
-}
diff --git a/src/StardewModdingAPI/Framework/Content/AssetInfo.cs b/src/StardewModdingAPI/Framework/Content/AssetInfo.cs
deleted file mode 100644
index d580dc06..00000000
--- a/src/StardewModdingAPI/Framework/Content/AssetInfo.cs
+++ /dev/null
@@ -1,82 +0,0 @@
-using System;
-using System.Collections.Generic;
-using Microsoft.Xna.Framework.Graphics;
-
-namespace StardewModdingAPI.Framework.Content
-{
-    internal class AssetInfo : IAssetInfo
-    {
-        /*********
-        ** Properties
-        *********/
-        /// <summary>Normalises an asset key to match the cache key.</summary>
-        protected readonly Func<string, string> GetNormalisedPath;
-
-
-        /*********
-        ** Accessors
-        *********/
-        /// <summary>The content's locale code, if the content is localised.</summary>
-        public string Locale { get; }
-
-        /// <summary>The normalised asset name being read. The format may change between platforms; see <see cref="AssetNameEquals"/> to compare with a known path.</summary>
-        public string AssetName { get; }
-
-        /// <summary>The content data type.</summary>
-        public Type DataType { get; }
-
-
-        /*********
-        ** Public methods
-        *********/
-        /// <summary>Construct an instance.</summary>
-        /// <param name="locale">The content's locale code, if the content is localised.</param>
-        /// <param name="assetName">The normalised asset name being read.</param>
-        /// <param name="type">The content type being read.</param>
-        /// <param name="getNormalisedPath">Normalises an asset key to match the cache key.</param>
-        public AssetInfo(string locale, string assetName, Type type, Func<string, string> getNormalisedPath)
-        {
-            this.Locale = locale;
-            this.AssetName = assetName;
-            this.DataType = type;
-            this.GetNormalisedPath = getNormalisedPath;
-        }
-
-        /// <summary>Get whether the asset name being loaded matches a given name after normalisation.</summary>
-        /// <param name="path">The expected asset path, relative to the game's content folder and without the .xnb extension or locale suffix (like 'Data\ObjectInformation').</param>
-        public bool AssetNameEquals(string path)
-        {
-            path = this.GetNormalisedPath(path);
-            return this.AssetName.Equals(path, StringComparison.InvariantCultureIgnoreCase);
-        }
-
-
-        /*********
-        ** Protected methods
-        *********/
-        /// <summary>Get a human-readable type name.</summary>
-        /// <param name="type">The type to name.</param>
-        protected string GetFriendlyTypeName(Type type)
-        {
-            // dictionary
-            if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Dictionary<,>))
-            {
-                Type[] genericArgs = type.GetGenericArguments();
-                return $"Dictionary<{this.GetFriendlyTypeName(genericArgs[0])}, {this.GetFriendlyTypeName(genericArgs[1])}>";
-            }
-
-            // texture
-            if (type == typeof(Texture2D))
-                return type.Name;
-
-            // native type
-            if (type == typeof(int))
-                return "int";
-            if (type == typeof(string))
-                return "string";
-
-            // default
-            return type.FullName;
-        }
-    }
-}