Package io.github.thebusybiscuit.slimefun4.core.services

Class LocalizationService

java.lang.Object

io.github.thebusybiscuit.slimefun4.core.services.localization.SlimefunLocalization

io.github.thebusybiscuit.slimefun4.core.services.LocalizationService

All Implemented Interfaces:

Keyed

public class LocalizationService
extends SlimefunLocalization

As the name suggests, this Service is responsible for Localization. It is used for managing the Language of a Player and the entire Server.

Author:

TheBusyBiscuit

See Also:

• Language

Constructor Summary

Constructors

Constructor	Description
LocalizationService(Slimefun plugin, String prefix, String serverDefaultLanguage)

Method Summary

Modifier and Type	Method	Description
protected void	addLanguage(String id, String texture)	This method adds a new Language with the given id and texture.
double	calculateProgress(Language lang)	This returns the progress of translation for any given Language.
String	getChatPrefix()	This returns the chat prefix for our messages.
Language	getDefaultLanguage()	This method returns the default Language of this Server
NamespacedKey	getKey()
Language	getLanguage(String id)	This method attempts to return the Language with the given language code.
Language	getLanguage(Player p)	This method returns the currently selected Language of a Player.
Collection<Language>	getLanguages()	This method returns a full Collection of every Language that was found.
boolean	hasLanguage(String id)	This returns whether a Language with the given id exists within the project resources.
boolean	isEnabled()	This method returns whether translations are enabled on this Server.
boolean	isLanguageLoaded(String id)	This returns whether the given Language is loaded or not.

Methods inherited from class io.github.thebusybiscuit.slimefun4.core.services.localization.SlimefunLocalization

getConfig, getDefaultMessages, getItemGroupName, getKeys, getMessage, getMessage, getMessages, getMessages, getRecipeTypeItem, getResearchName, getResourceString, getTotalKeys, loadEmbeddedLanguages, save, sendActionbarMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessages, sendMessages, sendMessages

Methods inherited from class java.lang.Object

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

Constructor Details

LocalizationService

public LocalizationService(@Nonnull
 Slimefun plugin,
 @Nullable
 String prefix,
 @Nullable
 String serverDefaultLanguage)

Method Details

isEnabled

public boolean isEnabled()

This method returns whether translations are enabled on this Server.

Returns:

Whether translations are enabled

getChatPrefix

public String getChatPrefix()

Description copied from class: SlimefunLocalization

This returns the chat prefix for our messages. Every message (unless explicitly omitted) will have this prefix prepended.

Overrides:

getChatPrefix in class SlimefunLocalization

Returns:

The chat prefix

getKey

@Nonnull
public NamespacedKey getKey()

getLanguage

@Nullable
public Language getLanguage(@Nonnull
 String id)

Description copied from class: SlimefunLocalization

This method attempts to return the Language with the given language code.

Specified by:

getLanguage in class SlimefunLocalization

Parameters:

id - The language code

Returns:

A Language with the given id or null

getLanguages

@Nonnull
public Collection<Language> getLanguages()

Description copied from class: SlimefunLocalization

This method returns a full Collection of every Language that was found.

Specified by:

getLanguages in class SlimefunLocalization

Returns:

A Collection that contains every installed Language

hasLanguage

public boolean hasLanguage(@Nonnull
 String id)

Description copied from class: SlimefunLocalization

This returns whether a Language with the given id exists within the project resources.

Specified by:

hasLanguage in class SlimefunLocalization

Parameters:

id - The Language id

Returns:

Whether the project contains a Language with that id

isLanguageLoaded

public boolean isLanguageLoaded(@Nonnull
 String id)

This returns whether the given Language is loaded or not.

Parameters:

id - The id of that Language

Returns:

Whether or not this Language is loaded

getDefaultLanguage

public Language getDefaultLanguage()

Description copied from class: SlimefunLocalization

This method returns the default Language of this Server

Specified by:

getDefaultLanguage in class SlimefunLocalization

Returns:

The default Language

getLanguage

public Language getLanguage(@Nonnull
 Player p)

Description copied from class: SlimefunLocalization

This method returns the currently selected Language of a Player.

Specified by:

getLanguage in class SlimefunLocalization

Parameters:

p - The Player to query

Returns:

The Language that was selected by the given Player

addLanguage

protected void addLanguage(@Nonnull
 String id,
 @Nonnull
 String texture)

Description copied from class: SlimefunLocalization

This method adds a new Language with the given id and texture.

Specified by:

addLanguage in class SlimefunLocalization

Parameters:

id - The Language id

texture - The texture of how this Language should be displayed

calculateProgress

public double calculateProgress(@Nonnull
 Language lang)

This returns the progress of translation for any given Language. The progress is determined by the amount of translated strings divided by the amount of strings in the english Language file and multiplied by 100.0

Parameters:

lang - The Language to get the progress of

Returns:

A percentage (0.0 - 100.0) for the progress of translation of that Language