Package net.kyori.adventure.translation

Interface Translator

All Known Subinterfaces:
GlobalTranslator, TranslationRegistry
public interface Translator
A message format translator.

To see how to create a Translator with a ResourceBundle see TranslationRegistry.registerAll(Locale, ResourceBundle, boolean)

After creating a Translator you can add it to the GlobalTranslator to enable automatic translations by the platforms.

Since:
4.0.0
See Also:
TranslationRegistry

  • Method Summary

    Modifier and Type Method Description
    @NonNull net.kyori.adventure.key.Key name()
    A key identifying this translation source.
    static @Nullable Locale parseLocale​(@NonNull String string)
    Parses a Locale from a String.
    @Nullable MessageFormat translate​(@NonNull String key, @NonNull Locale locale)
    Gets a message format from a key and locale.

  • Method Details

    • parseLocale

      static @Nullable Locale parseLocale​(@NonNull String string)
      Parses a Locale from a String.
      Parameters:
      string - the string
      Returns:
      a locale
      Since:
      4.0.0

    • name

      @NonNull net.kyori.adventure.key.Key name()
      A key identifying this translation source.

      Intended to be used for display to users.

      Returns:
      an identifier for this translation source
      Since:
      4.0.0

    • translate

      @Nullable MessageFormat translate​(@NonNull String key, @NonNull Locale locale)
      Gets a message format from a key and locale.
      Parameters:
      locale - a locale
      key - a translation key
      Returns:
      a message format or null to skip translation
      Since:
      4.0.0