add translation API (#296)

1 files changed, 29 insertions, 0 deletions

diff --git a/src/StardewModdingAPI/ITranslationHelper.cs b/src/StardewModdingAPI/ITranslationHelper.cs
new file mode 100644
index 00000000..84571d0e
--- /dev/null
+++ b/src/StardewModdingAPI/ITranslationHelper.cs
@@ -0,0 +1,29 @@
+using System.Collections.Generic;
+using StardewValley;
+
+namespace StardewModdingAPI
+{
+    /// <summary>Provides translations stored in the mod's <c>i18n</c> folder, with one file per locale (like <c>en.json</c>) containing a flat key => value structure. Translations are fetched with locale fallback, so missing translations are filled in from broader locales (like <c>pt-BR.json</c> &lt; <c>pt.json</c> &lt; <c>default.json</c>).</summary>
+    public interface ITranslationHelper
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The current locale.</summary>
+        string Locale { get; }
+
+        /// <summary>The game's current language code.</summary>
+        LocalizedContentManager.LanguageCode LocaleEnum { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Get all translations for the current locale.</summary>
+        IDictionary<string, string> GetTranslations();
+
+        /// <summary>Get a translation for the current locale.</summary>
+        /// <param name="key">The translation key.</param>
+        Translation Translate(string key);
+    }
+}