Interface EnchantmentLevelLangPatch

All Known Subinterfaces:

EnchantmentLevelLangPatch.WithFallback

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@API(status=STABLE)
@FunctionalInterface
@NullMarked
public interface EnchantmentLevelLangPatch

An API to patch the language file of Minecraft, resource packs and mods.

See Also:

• apply(Map, String)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EnchantmentLevelLangPatch.WithFallback	An EnchantmentLevelLangPatch that receives a fallback string.

Method Summary

Modifier and Type	Method	Description
@Nullable String	apply(@Unmodifiable Map<String,String> translationStorage, String key)	The entrypoint for EnchantmentLevelLangPatch.
default @Nullable String	apply(@Unmodifiable Map<String,String> translationStorage, String key, String fallback)	The entrypoint for EnchantmentLevelLangPatch, with fallback string given.
static String	intToRoman(@Range(from=1L,to=3998L) int num)	Provides an algorithm for int-to-roman translation.
static void	registerEnchantmentPatch(String id, EnchantmentLevelLangPatch edition)	Register an extra rendering syntax for enchantment levels.
static void	registerPatch(Predicate<String> keyPredicate, EnchantmentLevelLangPatch edition)	Register language patch for any language item you want.
static void	registerPotionPatch(String id, EnchantmentLevelLangPatch edition)	Register an extra rendering syntax for potion potency.
static EnchantmentLevelLangPatch	withFallback(EnchantmentLevelLangPatch.WithFallback patch)	Creates an EnchantmentLevelLangPatch that receives a fallback string.

Method Details

registerPatch

static void registerPatch(Predicate<String> keyPredicate,
 EnchantmentLevelLangPatch edition)

Register language patch for any language item you want.

Parameters:

keyPredicate - Predicate for the language key. If true, edition will be applied to the corresponding language item.

edition - The patch for the corresponding language item

See Also:

• registerEnchantmentPatch(String, EnchantmentLevelLangPatch)
• registerPotionPatch(String, EnchantmentLevelLangPatch)

intToRoman

@NullUnmarked
static String intToRoman(@Range(from=1L,to=3998L) int num)

Provides an algorithm for int-to-roman translation. Since there are only 3,998 roman number entries, this implementation enumerates them from a precalculated table.

Parameters:

num - the integer

Returns:

The number in roman format, or null if num is out of range (1..3998).

registerEnchantmentPatch

static void registerEnchantmentPatch(@Pattern("^([0-9a-z_\\-]+:)?[0-9a-z_\\-/]+$")
 String id,
 EnchantmentLevelLangPatch edition)

Register an extra rendering syntax for enchantment levels.

Won't be applied without invoking EnchantmentLevelLangPatchConfig.setCurrentEnchantmentHooks(EnchantmentLevelLangPatch), which switches the enchantment level patch to whichever you want.

Parameters:

id - Namespaced key for your patch. Please follow the naming rule of namespaced keys.

edition - Your patch for enchantment levels.

See Also:

• EnchantmentLevelLangPatchConfig.setCurrentEnchantmentHooks(EnchantmentLevelLangPatch)
• registerPatch(Predicate, EnchantmentLevelLangPatch)
• registerPotionPatch(String, EnchantmentLevelLangPatch)

registerPotionPatch

static void registerPotionPatch(@Pattern("^([0-9a-z_\\-]+:)?[0-9a-z_\\-/]+$")
 String id,
 EnchantmentLevelLangPatch edition)

Register an extra rendering syntax for potion potency.

Won't be applied without invoking EnchantmentLevelLangPatchConfig.setCurrentPotionHooks(EnchantmentLevelLangPatch), which switches the potion potency patch to whichever you want.

Parameters:

id - Namespaced key for your patch. Please follow the naming rule of namespaced keys.

edition - Your patch for potion potencies.

See Also:

• EnchantmentLevelLangPatchConfig.setCurrentPotionHooks(EnchantmentLevelLangPatch)
• registerPatch(Predicate, EnchantmentLevelLangPatch)
• registerEnchantmentPatch(String, EnchantmentLevelLangPatch)

apply

@Nullable String apply(@Unmodifiable Map<String,String> translationStorage,
 String key)

The entrypoint for EnchantmentLevelLangPatch.

Parameters:

translationStorage - an unmodifiable wrapping of the current key-translation map

key - the provided translation key when this patch is applied.

Returns:

the translation (value) you modify. Returning null indicates remaining unchanged.

See Also:

• apply(Map, String, String)

apply

default @Nullable String apply(@Unmodifiable Map<String,String> translationStorage,
 String key,
 String fallback)

The entrypoint for EnchantmentLevelLangPatch, with fallback string given.

Parameters:

translationStorage - an unmodifiable wrapping of the current key-translation map

key - the provided translation key when this patch is applied.

fallback - the fallback translation provided.

Returns:

the translation (value) you modify. Returning null indicates remaining unchanged.

See Also:

• apply(Map, String)

Implementation Note

This method is invoked by Minecraft 1.19.4 or above, which always gives a fallback that is defaulted to key. So if you want to override this method, please check whether key is equal to fallback.

In addition, apply(Map, String) should be implemented as well even if your mod is not designed for 1.19.3 or older versions.

withFallback

@Contract(pure=true,
          value="_ -> param1")
static EnchantmentLevelLangPatch withFallback(EnchantmentLevelLangPatch.WithFallback patch)

Creates an EnchantmentLevelLangPatch that receives a fallback string.

This should be used when your patch is only applied in Minecraft 1.19.4+, as the patch will be ignored when the fallback string is absent.

Example:

    EnchantmentLevelLangPatch.registerPatch(
        key -> key.startsWith("example.prefix."),
        EnchantmentLevelLangPatch.withFallback((storage, key, fallback) -> Example.hook(key, fallback))
    )

Parameters:

patch - the patch, recommended to be a lambda

Returns:

the patch itself