Interface LanguageAPI<P>

Type Parameters:
P - platform player type

public interface LanguageAPI<P>
Locale-aware translation API for core and module messages.
Since:
3.4
  • Method Details

    • getEffectiveLocale

      String getEffectiveLocale(P player)
      Resolve the locale that should be used for a player right now. Implementations may combine a manual player override, client auto-detection, server default locale, and fallback locale.
      Parameters:
      player - platform player, or null to use the server default locale
      Returns:
      effective locale code
    • getManualLocale

      default String getManualLocale(P player)
      Return the manually stored player locale override, if one exists. This does not include client auto-detection or server defaults.
      Parameters:
      player - platform player
      Returns:
      manual locale code, or null when the player uses automatic/default resolution
    • setManualLocale

      void setManualLocale(P player, String locale)
      Store a manual locale override for a player.
      Parameters:
      player - platform player
      locale - locale code
    • clearManualLocale

      default void clearManualLocale(P player)
      Clear a player's manual locale override so automatic/default resolution is used again.
      Parameters:
      player - platform player
    • getPlayerLocale

      @Deprecated default String getPlayerLocale(P player)
      Deprecated.
      use getEffectiveLocale(Object) for the active locale or getManualLocale(Object) for the stored manual override.
    • setPlayerLocale

      @Deprecated default void setPlayerLocale(P player, String locale)
    • clearPlayerLocale

      @Deprecated default void clearPlayerLocale(P player)
      Deprecated.
    • getDefaultLocale

      String getDefaultLocale()
    • getFallbackLocale

      default String getFallbackLocale()
      Final fallback locale used when the player and server default locales do not contain a translation. en is recommended because the Core defaults are authored in English.
    • registerModuleTranslation

      void registerModuleTranslation(String moduleId, String locale, String resourcePath)
      Register a module translation file with the runtime.

      Normal modules should not call this. Core runtimes auto-discover files/language/<locale>.yml resources and register them internally. This method remains public only for custom runtime adapters.

    • translate

      String translate(P player, String moduleId, String key)
    • translate

      String translate(P player, String moduleId, String key, String... placeholders)
    • translate

      default String translate(P player, String moduleId, String key, Map<String,String> placeholders)
    • translateOrDefault

      default String translateOrDefault(P player, String moduleId, String key, String defaultValue)
    • translateOrDefault

      default String translateOrDefault(P player, String moduleId, String key, String defaultValue, String... placeholders)
    • translateOrDefault

      default String translateOrDefault(P player, String moduleId, String key, String defaultValue, Map<String,String> placeholders)
    • translateList

      default List<String> translateList(P player, String moduleId, String key)
      Look up a translated string list for module UI such as scoreboards, lore, and result messages.
      Since:
      3.4
    • translateList

      default List<String> translateList(P player, String moduleId, String key, String... placeholders)
      Look up a translated string list and replace MiniMessage placeholder tokens. Placeholders are passed as pairs: "{name}", "value".
      Since:
      3.4
    • translateList

      default List<String> translateList(P player, String moduleId, String key, Map<String,String> placeholders)
    • translateListOrDefault

      default List<String> translateListOrDefault(P player, String moduleId, String key, List<String> defaultValue)
    • translateListOrDefault

      default List<String> translateListOrDefault(P player, String moduleId, String key, List<String> defaultValue, String... placeholders)
    • translateListOrDefault

      default List<String> translateListOrDefault(P player, String moduleId, String key, List<String> defaultValue, Map<String,String> placeholders)
    • hasTranslation

      boolean hasTranslation(String moduleId, String locale, String key)
    • getModuleLocales

      List<String> getModuleLocales(String moduleId)
    • getAvailableLocales

      default List<String> getAvailableLocales()
      Return locale codes currently available from Core and loaded modules. This is intended for validation and command suggestions.
      Returns:
      available locale codes
      Since:
      3.4
    • isLocaleAvailable

      default boolean isLocaleAvailable(String locale)
      Check whether a locale can be selected. Implementations may normalize Minecraft locale tags such as es_es or es-ES to es.
      Parameters:
      locale - requested locale code
      Returns:
      true if the locale is available
      Since:
      3.4