Package net.kyori.adventure.text.minimessage.translation

Interface MiniMessageTranslationStore

All Superinterfaces:

TranslationStore<String>, TranslationStore.StringBased<String>, Translator

@NonExtendable
public interface MiniMessageTranslationStore
extends TranslationStore.StringBased<String>

A MiniMessage translation store.

For documentation on how to use the MiniMessage translation system, see the Javadocs for MiniMessageTranslator.

Since:

4.20.0

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.translation.TranslationStore

TranslationStore.StringBased<T extends Object>

Method Summary

Static Methods

Modifier and Type	Method	Description
static @NotNull MiniMessageTranslationStore	create(@NotNull Key name)	Creates a MiniMessage translation store, backed by the default MiniMessage instance.
static @NotNull MiniMessageTranslationStore	create(@NotNull Key name, @NotNull MiniMessage miniMessage)	Creates a MiniMessage translation store.

Methods inherited from interface net.kyori.adventure.translation.TranslationStore

canTranslate, contains, contains, defaultLocale, register, registerAll, registerAll, unregister

Methods inherited from interface net.kyori.adventure.translation.TranslationStore.StringBased

registerAll, registerAll

Methods inherited from interface net.kyori.adventure.translation.Translator

hasAnyTranslations, name, translate, translate

Method Details

create

@NotNull
static @NotNull MiniMessageTranslationStore create(@NotNull
 @NotNull Key name)

Creates a MiniMessage translation store, backed by the default MiniMessage instance.

Parameters:

name - the name of the translation store

Returns:

the translation store

Since:

4.20.0

create

@NotNull
static @NotNull MiniMessageTranslationStore create(@NotNull
 @NotNull Key name,
 @NotNull
 @NotNull MiniMessage miniMessage)

Creates a MiniMessage translation store.

Parameters:

name - the name of the translation store

miniMessage - the MiniMessage instance to use for deserialization

Returns:

the translation store

Since:

4.20.0