Colosseum/me.spartacus04.colosseum.i18n

Package-level declarations

Types

A class that manages a plugin's i18n. This handles static and dynamic languages. Static languages are languages that never change and are usually loaded from the plugin jar. Dynamic languages are languages that can change at runtime and are usually loaded from a database or file. The plugin will cache dynamic languages to prevent unnecessary loading, and will reload them when invalidated. When a message is requested, the plugin will first check the cached dynamic languages, then the dynamic languages, and finally the static languages. If the get method is called with a CommandSender, the plugin will use the forced language if it is set, otherwise it will use the player's locale. If the player's locale is not found, the default language will be used. If the command sender is not a player, the default language will be used.

ColosseumI18nManagerBuilder

class ColosseumI18nManagerBuilder(plugin: ColosseumPlugin)

A builder class for the i18n manager. This class is used to build the i18n manager with the specified settings. The i18n manager is used to manage the languages for the plugin.

Functions

sendI18nConfirm

fun CommandSender.sendI18nConfirm(plugin: ColosseumPlugin, key: String, vararg placeholders: Pair<String, String>)

Sends an internationalized confirmation message to the command sender.

sendI18nCustom

fun CommandSender.sendI18nCustom(plugin: ColosseumPlugin, prefixColor: ChatColor, messageColor: ChatColor, key: String, vararg placeholders: Pair<String, String>)

Sends an internationalized custom colored message to the command sender.

sendI18nError

fun CommandSender.sendI18nError(plugin: ColosseumPlugin, key: String, vararg placeholders: Pair<String, String>)

Sends an internationalized error message to the command sender.

sendI18nInfo

fun CommandSender.sendI18nInfo(plugin: ColosseumPlugin, key: String, vararg placeholders: Pair<String, String>)

Sends an internationalized info message to the command sender.

sendI18nWarn

fun CommandSender.sendI18nWarn(plugin: ColosseumPlugin, key: String, vararg placeholders: Pair<String, String>)

Sends an internationalized warning message to the command sender.

trySendI18nConfirm

fun CommandSender.trySendI18nConfirm(plugin: ColosseumPlugin, key: String, alt: String, vararg placeholders: Pair<String, String>)

Tries to send an internationalized confirmation message to the command sender. If the translation is missing, sends the alternative message instead.

trySendI18nCustom

fun CommandSender.trySendI18nCustom(plugin: ColosseumPlugin, prefixColor: ChatColor, messageColor: ChatColor, key: String, alt: String, vararg placeholders: Pair<String, String>)

Tries to send an internationalized custom colored message to the command sender. If the translation is missing, sends the alternative message instead.

trySendI18nError

fun CommandSender.trySendI18nError(plugin: ColosseumPlugin, key: String, alt: String, vararg placeholders: Pair<String, String>)

Tries to send an internationalized error message to the command sender. If the translation is missing, sends the alternative message instead.

trySendI18nInfo

fun CommandSender.trySendI18nInfo(plugin: ColosseumPlugin, key: String, alt: String, vararg placeholders: Pair<String, String>)

Tries to send an internationalized info message to the command sender. If the translation is missing, sends the alternative message instead.

trySendI18nWarn

fun CommandSender.trySendI18nWarn(plugin: ColosseumPlugin, key: String, alt: String, vararg placeholders: Pair<String, String>)

Tries to send an internationalized warning message to the command sender. If the translation is missing, sends the alternative message instead.