summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/IAssetDataForDictionary.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/StardewModdingAPI/IAssetDataForDictionary.cs')
-rw-r--r--src/StardewModdingAPI/IAssetDataForDictionary.cs26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/StardewModdingAPI/IAssetDataForDictionary.cs b/src/StardewModdingAPI/IAssetDataForDictionary.cs
new file mode 100644
index 00000000..53c24346
--- /dev/null
+++ b/src/StardewModdingAPI/IAssetDataForDictionary.cs
@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+
+namespace StardewModdingAPI
+{
+ /// <summary>Encapsulates access and changes to dictionary content being read from a data file.</summary>
+ public interface IAssetDataForDictionary<TKey, TValue> : IAssetData<IDictionary<TKey, TValue>>
+ {
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Add or replace an entry in the dictionary.</summary>
+ /// <param name="key">The entry key.</param>
+ /// <param name="value">The entry value.</param>
+ void Set(TKey key, TValue 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>
+ void Set(TKey key, Func<TValue, TValue> value);
+
+ /// <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);
+ }
+}