Package net.godlycow.org.essc.api.language

Interface LanguageManager

public interface LanguageManager
The language system. Get it from EssentialsCAPI.getLanguageManager(). Messages are sent in each players own language. Add your own keys with registerMessages(Plugin, String...) and prefix them with your addon name, like "myverycoolplugin.somemessage".

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    broadcast(String permission, String key, Map<String,String> placeholders)
    Sends a message to all players with the permission and to the console.
    net.kyori.adventure.text.Component
    get(org.bukkit.command.CommandSender sender, String key)
    Gets a message in the sender's language.
    net.kyori.adventure.text.Component
    get(org.bukkit.command.CommandSender sender, String key, Map<String,String> placeholders)
    Gets a message in the sender's language.
    Set<String>
    getAvailableLanguages()
    Gets all loaded languages.
    String
    getDefaultLanguage()
    Gets the default language from the config.
    String
    getLanguage(org.bukkit.command.CommandSender sender)
    Gets the language a sender sees messages in.
    String
    getPlayerLanguage(UUID playerId)
    Gets the language a player picked with /language.
    String
    getRaw(org.bukkit.command.CommandSender sender, String key, Map<String,String> placeholders)
    Gets a message as a raw MiniMessage string.
    boolean
    hasKey(String key)
    Checks if a key exists.
    void
    registerMessages(org.bukkit.plugin.Plugin plugin, String... languageCodes)
    Registers your addon's messages.
    void
    send(org.bukkit.command.CommandSender sender, String key)
    Sends a message to the sender.
    void
    send(org.bukkit.command.CommandSender sender, String key, Map<String,String> placeholders)
    Sends a message to the sender.

  • Method Details

    • get

      net.kyori.adventure.text.Component get(org.bukkit.command.CommandSender sender, String key, Map<String,String> placeholders)
      Gets a message in the sender's language.
      Parameters:
      sender - the sender, or null for the default language
      key - the message key
      placeholders - placeholder values, may be null
      Returns:
      the message, never null

    • get

      net.kyori.adventure.text.Component get(org.bukkit.command.CommandSender sender, String key)
      Gets a message in the sender's language.
      Parameters:
      sender - the sender, or null for the default language
      key - the message key
      Returns:
      the message, never null

    • getRaw

      String getRaw(org.bukkit.command.CommandSender sender, String key, Map<String,String> placeholders)
      Gets a message as a raw MiniMessage string.
      Parameters:
      sender - the sender, or null for the default language
      key - the message key
      placeholders - placeholder values, may be null
      Returns:
      the raw message, never null

    • send

      void send(org.bukkit.command.CommandSender sender, String key, Map<String,String> placeholders)
      Sends a message to the sender.
      Parameters:
      sender - the sender
      key - the message key
      placeholders - placeholder values, may be null

    • send

      void send(org.bukkit.command.CommandSender sender, String key)
      Sends a message to the sender.
      Parameters:
      sender - the sender
      key - the message key

    • broadcast

      void broadcast(String permission, String key, Map<String,String> placeholders)
      Sends a message to all players with the permission and to the console.
      Parameters:
      permission - the permission
      key - the message key
      placeholders - placeholder values, may be null

    • hasKey

      boolean hasKey(String key)
      Checks if a key exists.
      Parameters:
      key - the message key
      Returns:
      true if found

    • registerMessages

      void registerMessages(org.bukkit.plugin.Plugin plugin, String... languageCodes)
      Registers your addon's messages. Copies lang/<code>.json from your jar to your plugin folder and adds any new keys. Call it in onEnable.
      Parameters:
      plugin - your plugin
      languageCodes - the language files in your jar, for example "en_US"

    • getLanguage

      String getLanguage(org.bukkit.command.CommandSender sender)
      Gets the language a sender sees messages in.
      Parameters:
      sender - the sender, or null for the default language
      Returns:
      the language code, for example "en_US"

    • getPlayerLanguage

      String getPlayerLanguage(UUID playerId)
      Gets the language a player picked with /language.
      Parameters:
      playerId - the player UUID
      Returns:
      the language code, or null if not set

    • getDefaultLanguage

      String getDefaultLanguage()
      Gets the default language from the config.
      Returns:
      the language code, never null

    • getAvailableLanguages

      Set<String> getAvailableLanguages()
      Gets all loaded languages.
      Returns:
      language codes, never null