[API] Locale-API - Speedgot

[API] Locale-API -----

Easily translate Minecraft objects like Materials

Locale-API

With this API you can easily translate

Biomes
Materials
Effects
Enchantments
Entities
Potions
Tropical fish pattern
Profession of a Villager

For more translations use ' Translate.getCustomValue(...)' and lookup for keys here

Setup
Make sure to add ' depend: [Locale-API]' to your ' plugin.yml' file and the ' Locale-API.jar' to the
plugins folder of your server.

Maven

Code (Text):

<dependency>
<groupId>de.unpixelt</groupId>
<artifactId>locale-api</artifactId>
<version>1.0</version>
</dependency>

Caution
Some ' Locale's' like ' got_de, gv_im, kab_kab, mi_nz, moh_ca, nuk, oj_ca, qya_aa, tzl_tzl' have a high
amount of untranslated Strings (over 100) and should not be used.
If used and the key is not found, it will use the translation of ' Locale.en_us'.

Events
On the below shown events prefer using the giving locale instead of the player object when
translating. Doing so is better for performance.

Code (Text):

+ Good
+ Translate.getMaterial(e.getLocale(), Material.GRASS_BLOCK);
+ Translate.getMaterial(e.getOldLocale(), Material.GRASS_BLOCK);

- Bad
- Translate.getMaterial(p, Material.GRASS_BLOCK);

PlayerJoinEvent >> LocalePlayerJoinEvent
When you want to translate something when a player joins the server use the ' LocalePlayerJoinEvent'.
DO ONLY use this event if you translate something or need the player's
locale for any reason. It does NOT include the joinMessage.

Code (Java):

@EventHandler
private void onPlayerJoinEvent (LocalePlayerJoinEvent e ) {
Material mat = Material. GOLD_BLOCK ;
ItemStack item = new ItemStack (mat ) ;
String translation = Translate. getMaterial (e. getLocale ( ), mat ) ;
ItemMeta meta = item. getItemMeta ( ) ;

meta. setDisplayName (translation ) ;
item. setItemMeta (meta ) ;
e. getPlayer ( ). getInventory ( ). addItem (item ) ;
...
}

PlayerLocaleChangeEvent >> LocalePlayerLocaleChangeEvent
Use ' LocalePlayerLocaleChangeEvent' instead of PlayerLocaleChangeEvent.
This event also give you the ability to get the locale the player used before.

Code (Java):

@EventHandler
private void onPlayerLocaleChange (LocalePlayerLocaleChangeEvent e ) {
Locale oldLocale = e. getOldLocale ( ) ; // change from
Locale newLocale = e. getLocale ( ) ; // to
...
}

Example
In this example we create a special chest item with a lore which shows the
Material requirements to open it in the player's language used.
First we create the lore, but we save it in the ' LocalizedName'.
We separate each line with a ',' but you can use any character you like to use.

Code (Java):

public ItemStack getSpecialChest ( ) {
ItemStack item = new ItemStack (Material. ENDER_CHEST ) ;
ItemMeta meta = item. getItemMeta ( ) ;

List <String > lore = new ArrayList <> ( ) ;
lore. add ( "Required to open: " ) ;
lore. add ( "- §4{0}" ) ;
lore. add ( "- §a{1}" ) ;

meta. setLocalizedName ( String. join ( ",", lore ) ) ;
item. setItemMeta (meta ) ;
return item ;
}

You can also instantly write it formatted.

Code (Java):

String lore = "Required to open: ,- $4{0},- §a{1}" ;
meta. setLocalizedName (lore ) ;

After that we create a method that replaces '{0}' and '{1}' with the
required Materials to open the special chest in the locale the player is using.

Code (Java):

public void updateLore ( Locale locale, ItemStack item ) {
ItemMeta meta = item. getItemMeta ( ) ;

// Replace {0} and {1} with the Materials that are required
String format = MessageFormat. format (meta. getLocalizedName ( ),
Translate. getMaterial (locale, Material. REDSTONE_BLOCK ), // {0}
Translate. getMaterial (locale, Material. EMERALD ) ) ; // {1}

meta. setLore ( Arrays. asList (format. split ( "," ) ) ) ;
item. setItemMeta (meta ) ;
}

public void updateLore (Player p, ItemStack item ) {
updateLore (Translate. getLocale (p ), item ) ;
}

Last but not least events.

Code (Java):

// Give every player that joins a special chest.
@EventHandler
private void onPlayerJoinEvent (LocalePlayerJoinEvent e ) {
Player p = e. getPlayer ( ) ;
ItemStack specialChest = getSpecialChest ( ) ;
updateLore (e. getLocale ( ), specialChest ) ;
p. getInventory ( ). addItem (specialChest ) ;
}

// When a special chest is picked up it will update the requirements in the lore to
// the player's locale.
@EventHandler
private void onPlayerPickup (EntityPickupItemEvent e ) {
if (e. getEntity ( ) instanceof Player ) {
Player p = (Player ) e. getEntity ( ) ;
ItemStack item = e. getItem ( ). getItemStack ( ) ;

if (item. getType ( ) == Material. ENDER_CHEST ) {
updateLore (p, item ) ;
}
}
}

// When the player change his locale it will also update the requirements in the
// lore to the new selected locale.
@EventHandler
private void onPlayerLocaleChange (LocalePlayerLocaleChangeEvent e ) {
for (ItemStack item : e. getPlayer ( ). getInventory ( ) ) {
if (item == null ) continue ;

if (item. getType ( ) == Material. ENDER_CHEST ) {
updateLore (e. getLocale ( ), item ) ;
}
}
}

It's not the best for performance but this example is used to show what you can
do with this API.

Have fun coding

View on SpigotMC

Resource Information

Author:

----------

Total Downloads: 263

First Release: Sep 3, 2022

Last Update: Sep 3, 2022

Category: ---------------

All-Time Rating:

0 ratings

Version -----

Released: --------------------

Downloads: ------

Version Rating:

----------------------

-- ratings