diff options
Diffstat (limited to 'src/StardewModdingAPI/IContentEventHelperForDictionary.cs')
-rw-r--r-- | src/StardewModdingAPI/IContentEventHelperForDictionary.cs | 24 |
1 files changed, 1 insertions, 23 deletions
diff --git a/src/StardewModdingAPI/IContentEventHelperForDictionary.cs b/src/StardewModdingAPI/IContentEventHelperForDictionary.cs index 34e69d42..2f9d5a65 100644 --- a/src/StardewModdingAPI/IContentEventHelperForDictionary.cs +++ b/src/StardewModdingAPI/IContentEventHelperForDictionary.cs @@ -4,28 +4,11 @@ using System.Collections.Generic; namespace StardewModdingAPI { /// <summary>Encapsulates access and changes to dictionary content being read from a data file.</summary> - public interface IContentEventHelperForDictionary<TKey, TValue> + public interface IContentEventHelperForDictionary<TKey, TValue> : IContentEventData<IDictionary<TKey, TValue>> { /********* - ** Accessors - *********/ - /// <summary>The content's locale code, if the content is localised.</summary> - string Locale { get; } - - /// <summary>The normalised asset name being read. The format may change between platforms; see <see cref="IsAssetName"/> to compare with a known path.</summary> - string AssetName { get; } - - /// <summary>The content data being read.</summary> - IDictionary<TKey, TValue> Data { get; } - - - /********* ** Public methods *********/ - /// <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> - bool IsAssetName(string path); - /// <summary>Add or replace an entry in the dictionary.</summary> /// <param name="key">The entry key.</param> /// <param name="value">The entry value.</param> @@ -39,10 +22,5 @@ namespace StardewModdingAPI /// <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> void Set(Func<TKey, TValue, TValue> replacer); - - /// <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> - void ReplaceWith(IDictionary<TKey, TValue> value); } } |