Package org.polyfrost.polyui.input

Class Translator

  • All Implemented Interfaces:
    
public final class Translator

    PolyTranslator is an i18n/l10n system used by PolyUI. It finds a language file according to the following spec:

    /translationDir/lang_COUNTRY.lang

    for example /translationDir/en_GB.lang.

    This can also be set with -Dpolyui.locale="ll_CC" or using Settings.defaultLocale.

    If the file cannot be found, PolyUI will check for a file named ll_default.lang (for example en_default.lang) and use that instead if present. If that isn't found, it will use the default locale (above), and if that isn't found it will crash.

    Keys can also be added using

    The file contains a simple table of key=value, with each line meaning a new translation. It will return the key if the file is found but the key is not present. We recommend using dot notation for your keys:

    my.key=hello there!
hello.world=This works well!
something.else=I can also substitute in {0} objects using {1}!

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public final class Translator.Text

      Internal representation of a string in PolyUI.

      The string can be translated if there is an attached Translator to this instance and the key is present in the file.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Boolean dontWarn

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Constructor Detail

      • Translator

        Translator(PolyUI polyUI, String translationDir)

    • Method Detail

      • getDontWarn

         final Boolean getDontWarn()

        Set to true to disable warnings when a translation is not found.

      • setDontWarn

         final Unit setDontWarn(@ApiStatus.Internal() Boolean dontWarn)

        Set to true to disable warnings when a translation is not found.

      • setLocale

         final Unit setLocale(String locale)

        set the locale of this translator. All the keys are cleared, and PolyUI is reloaded.

      • loadKeys

         final Unit loadKeys(String resource, Boolean now)

        Add a file to the translation table, which will be used to load keys.

        Unless now is true, the file will only be loaded if the key is not found in the existing table.

      • addKeys

         final Unit addKeys(Pair<String, String> pairs)

        Add a set of keys to the translation table. You can use the Kotlin map syntax here:

        addKeys(
  "my.key" to "hello there!",
  "hello.world" to "This works well!",
)

      • translate

         final String translate(Translator.Text text)

        translate the provided key, returning the key as per the translation table.

        If the key is not present in the table, then the resourcePath file is checked for the key. The value is then returned. Warnings will be issued if the file/key does not exist.