Language/Translations Functions

Functions that allow your Mod to be translatable easily.

---

getTranslationPhrase

getTranslationPhrase(key:String, ?defaultPhrase:String, ?args:Array<Dynamic> = null):String

Returns the translation key for phrases.

• key - Translation key name.
• defaultPhrase (Optional) - String for a default text used when missing translation, if missing, it will use the "key" as the text.
• args (Optional) - Table with data for the translations.

Examples:

• getTranslationPhrase('This is a Test') - This will load translation phrase "this_is_a_test".
• getTranslationPhrase('test_phrase', 'This is a Test') - This will load translation phrase "test_phrase", if missing, it will use "This is a Test".
• getTranslationPhrase('test_phrase', 'Test: {1}', {someVariableHere}) - This will load translation phrase "this_is_a_test", and replace "{1}", "{2}"... with the values inside the table in its order.

---

getFileTranslation

getFileTranslation(key:String):String

Returns the translation key for assets path.

• key - Original asset path for English (Default) language.

Examples:

• getFileTranslation('images/mainmenu/menu_story_mode') - If your game is in Portuguese, it should return "images/pt-BR/mainmenu/menu_story_mode".