team.unnamed.creative.lang

Interface Language

All Superinterfaces:

net.kyori.examination.Examinable, net.kyori.adventure.key.Keyed, ResourcePackPart

@ApiStatus.NonExtendable
public interface Language
extends ResourcePackPart, net.kyori.adventure.key.Keyed, net.kyori.examination.Examinable

Represents a set of translations for a specific language.

Custom language additions require a LanguageEntry being added to the LanguageMeta instance of the resource pack.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Language.Builder A builder for Language instances.

Method Summary

Modifier and Type	Method and Description
default void	addTo(@NotNull ResourceContainer resourceContainer) Adds this language to the given resource container.
static @NotNull Language.Builder	builder() Deprecated. Use language() instead, it is better for static imports
@NotNull net.kyori.adventure.key.Key	key() Returns the language key.
static @NotNull Language.Builder	language() Creates a new Language instance builder.
static @NotNull Language	language(@NotNull net.kyori.adventure.key.Key key, @NotNull java.util.Map<java.lang.String,java.lang.String> translations) Creates a new Language object which holds the given translations in a Map.
static @NotNull Language	of(@NotNull net.kyori.adventure.key.Key key, @NotNull java.util.Map<java.lang.String,java.lang.String> translations) Deprecated. Use language(Key, Map) instead, it is better for static imports
default @Nullable java.lang.String	translation(@NotNull java.lang.String key) Returns the translation for the given key, or null if there is no translation.
default @Nullable java.lang.String	translation(@NotNull net.kyori.adventure.translation.Translatable translatable) Returns the translation for the given Translatable object, or null if there is no translation.
@NotNull java.util.Map<java.lang.String,java.lang.String>	translations() Returns a map containing all the translations for this language, where the key is the translation key (yeah) and the value is the actual translation, in example, there could be a translation for the Stone block

Methods inherited from interface team.unnamed.creative.part.ResourcePackPart

compound, compound

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

language

@NotNull
static @NotNull Language language(@NotNull
                                            @NotNull net.kyori.adventure.key.Key key,
                                            @NotNull
                                            @NotNull java.util.Map<java.lang.String,java.lang.String> translations)

Creates a new Language object which holds the given translations in a Map.

Parameters:

key - The language key

translations - The translations

Returns:

The language

Since:

1.1.0

language

@NotNull
static @NotNull Language.Builder language()

Creates a new Language instance builder.

Returns:

The created builder

Since:

1.0.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull Language of(@NotNull
                                                                                                        @NotNull net.kyori.adventure.key.Key key,
                                                                                                        @NotNull
                                                                                                        @NotNull java.util.Map<java.lang.String,java.lang.String> translations)

Deprecated. Use language(Key, Map) instead, it is better for static imports

Creates a new Language object which holds the given translations in a Map

Parameters:

translations - The language translations

Returns:

The language

Since:

1.0.0

builder

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull Language.Builder builder()

Deprecated. Use language() instead, it is better for static imports

Creates a new Language instance builder.

Returns:

The created builder

Since:

1.0.0

key

@NotNull
@NotNull net.kyori.adventure.key.Key key()

Returns the language key.

For example, the English language key is "minecraft:en_us"

Specified by:

key in interface net.kyori.adventure.key.Keyed

Returns:

The language key

Since:

1.0.0

translations

@NotNull
@NotNull java.util.Map<java.lang.String,java.lang.String> translations()

Returns a map containing all the translations for this language, where the key is the translation key (yeah) and the value is the actual translation, in example, there could be a translation for the Stone block

"block.minecraft.stone" -> "Stone"

Returns:

The language translations

Since:

1.0.0

translation

@Nullable
default @Nullable java.lang.String translation(@NotNull
                                                          @NotNull java.lang.String key)

Returns the translation for the given key, or null if there is no translation.

Parameters:

key - The translation key

Returns:

The translation

Since:

1.1.0

translation

@Nullable
default @Nullable java.lang.String translation(@NotNull
                                                          @NotNull net.kyori.adventure.translation.Translatable translatable)

Returns the translation for the given Translatable object, or null if there is no translation.

Parameters:

translatable - The translatable object

Returns:

The translation

Since:

1.1.0

addTo

default void addTo(@NotNull
                   @NotNull ResourceContainer resourceContainer)

Adds this language to the given resource container.

Specified by:

addTo in interface ResourcePackPart

Parameters:

resourceContainer - The resource container

Since:

1.1.0