Package me.remigio07.chatplugin.api.server.language

Class Language

java.lang.Object

me.remigio07.chatplugin.api.server.language.Language

public abstract class Language
extends Object

Represents a language handled by the LanguageManager.

See Also:

• ChatPlugin wiki/Modules/Languages

Method Summary

Modifier and Type	Method	Description
Configuration	getConfiguration()	Gets the messages configuration associated with this language.
List<String>	getCountryCodes()	Gets this language's list of ISO 3166-2 country codes.
String	getDisplayName()	Gets this language's display name.
String	getID()	Gets this language's ID.
static Language	getMainLanguage()	Gets the plugin's main and default language.
String	getMessage(String path, Object... args)	Gets a message from this language's getConfiguration() and translates its placeholders using Utils.numericPlaceholders(String, Object...).
List<ChatPluginServerPlayer>	getOnlinePlayers()	Gets a list containing all online players with this language set as their current language.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getID

public String getID()

Gets this language's ID.

Returns:

Language's ID

getDisplayName

public String getDisplayName()

Gets this language's display name. May include format codes ("§x").

Returns:

Language's display name

getCountryCodes

public List<String> getCountryCodes()

Gets this language's list of ISO 3166-2 country codes.

A player's language may be determined using LanguageDetectionMethod.GEOLOCALIZATION if this list contains their IPLookup.getCountryCode().

Returns:

Language's country codes

getConfiguration

public Configuration getConfiguration()

Gets the messages configuration associated with this language.

Returns:

Associated configuration

getMessage

public String getMessage(String path,
 Object... args)

Gets a message from this language's getConfiguration() and translates its placeholders using Utils.numericPlaceholders(String, Object...).

The "{pfx}" placeholder will be translated with the message found at "misc.prefix". Returned text will also be translated using ChatColor.translate(String).

Parameters:

path - Message's path

args - Optional arguments (translated using Utils.numericPlaceholders(String, Object...))

Returns:

Translated message

getOnlinePlayers

public List<ChatPluginServerPlayer> getOnlinePlayers()

Gets a list containing all online players with this language set as their current language.

Returns:

Language's online players

getMainLanguage

public static Language getMainLanguage()

Gets the plugin's main and default language.

This method calls LanguageManager.getMainLanguage().

Returns:

Main language