net.kyori.text

Interface TranslatableComponent

All Superinterfaces:

BuildableComponent<TranslatableComponent,TranslatableComponent.Builder>, Component, ScopedComponent<TranslatableComponent>

public interface TranslatableComponent
extends BuildableComponent<TranslatableComponent,TranslatableComponent.Builder>, ScopedComponent<TranslatableComponent>

A translatable text component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TranslatableComponent.Builder A text component builder.

Method Summary

Modifier and Type	Method and Description
@NonNull java.util.List<Component>	args() Gets the unmodifiable list of translation arguments.
@NonNull TranslatableComponent	args(@NonNull java.util.List<? extends Component> args) Sets the translation arguments for this component.
static @NonNull TranslatableComponent.Builder	builder() Creates a translatable component builder.
static @NonNull TranslatableComponent.Builder	builder(@NonNull java.lang.String key) Creates a translatable component builder with a translation key.
@NonNull java.lang.String	key() Gets the translation key.
@NonNull TranslatableComponent	key(@NonNull java.lang.String key) Sets the translation key.
static @NonNull TranslatableComponent	make(@NonNull java.util.function.Consumer<? super TranslatableComponent.Builder> consumer) Creates a translatable component by applying configuration from consumer.
static @NonNull TranslatableComponent	make(@NonNull java.lang.String key, @NonNull java.util.function.Consumer<? super TranslatableComponent.Builder> consumer) Creates a translatable component by applying configuration from consumer.
static @NonNull TranslatableComponent	make(@NonNull java.lang.String key, @NonNull java.util.List<? extends Component> args, @NonNull java.util.function.Consumer<? super TranslatableComponent.Builder> consumer) Creates a translatable component by applying configuration from consumer.
static @NonNull TranslatableComponent	of(@NonNull java.lang.String key) Creates a translatable component with a translation key.
static @NonNull TranslatableComponent	of(@NonNull java.lang.String key, Component... args) Creates a translatable component with a translation key and arguments.
static @NonNull TranslatableComponent	of(@NonNull java.lang.String key, @NonNull java.util.List<? extends Component> args) Creates a translatable component with a translation key and arguments.
static @NonNull TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color) Creates a translatable component with a translation key, and optional color.
static @NonNull TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, Component... args) Creates a translatable component with a translation key, arguments, and optional color.
static TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, @NonNull java.util.List<? extends Component> args) Creates a translatable component with a translation key, arguments, and optional color.
static @NonNull TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, @NonNull java.util.Set<TextDecoration> decorations) Creates a translatable component with a translation key, and optional color and decorations.
static @NonNull TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, @NonNull java.util.Set<TextDecoration> decorations, Component... args) Creates a translatable component with a translation key, arguments, and optional color and decorations.
static @NonNull TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, @NonNull java.util.Set<TextDecoration> decorations, @NonNull java.util.List<? extends Component> args) Creates a translatable component with a translation key, arguments, and optional color and decorations.
static @NonNull TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, TextDecoration... decorations) Creates a translatable component with a translation key, and optional color and decorations.

Methods inherited from interface net.kyori.text.BuildableComponent

toBuilder

Methods inherited from interface net.kyori.text.ScopedComponent

append, append, children, clickEvent, color, decoration, decoration, hoverEvent, insertion, mergeColor, mergeDecorations, mergeEvents

Methods inherited from interface net.kyori.text.Component

children, clickEvent, color, contains, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, insertion, style, style

Method Detail

builder

static @NonNull TranslatableComponent.Builder builder()

Creates a translatable component builder.

Returns:

a builder

builder

static @NonNull TranslatableComponent.Builder builder(@NonNull java.lang.String key)

Creates a translatable component builder with a translation key.

Parameters:

key - the translation key

Returns:

a builder

of

static @NonNull TranslatableComponent of(@NonNull java.lang.String key)

Creates a translatable component with a translation key.

Parameters:

key - the translation key

Returns:

the translatable component

of

static @NonNull TranslatableComponent of(@NonNull java.lang.String key,
                                         @Nullable TextColor color)

Creates a translatable component with a translation key, and optional color.

Parameters:

key - the translation key

color - the color

Returns:

the translatable component

of

static @NonNull TranslatableComponent of(@NonNull java.lang.String key,
                                         @Nullable TextColor color,
                                         TextDecoration... decorations)

Creates a translatable component with a translation key, and optional color and decorations.

Parameters:

key - the translation key

color - the color

decorations - the decorations

Returns:

the text component

of

static @NonNull TranslatableComponent of(@NonNull java.lang.String key,
                                         @Nullable TextColor color,
                                         @NonNull java.util.Set<TextDecoration> decorations)

Creates a translatable component with a translation key, and optional color and decorations.

Parameters:

key - the translation key

color - the color

decorations - the decorations

Returns:

the translatable component

of

static @NonNull TranslatableComponent of(@NonNull java.lang.String key,
                                         Component... args)

Creates a translatable component with a translation key and arguments.

Parameters:

key - the translation key

args - the translation arguments

Returns:

the translatable component

of

static @NonNull TranslatableComponent of(@NonNull java.lang.String key,
                                         @Nullable TextColor color,
                                         Component... args)

Creates a translatable component with a translation key, arguments, and optional color.

Parameters:

key - the translation key

color - the color

args - the translation arguments

Returns:

the translatable component

of

static @NonNull TranslatableComponent of(@NonNull java.lang.String key,
                                         @Nullable TextColor color,
                                         @NonNull java.util.Set<TextDecoration> decorations,
                                         Component... args)

Creates a translatable component with a translation key, arguments, and optional color and decorations.

Parameters:

key - the translation key

color - the color

decorations - the decorations

args - the translation arguments

Returns:

the translatable component

of

static @NonNull TranslatableComponent of(@NonNull java.lang.String key,
                                         @NonNull java.util.List<? extends Component> args)

Creates a translatable component with a translation key and arguments.

Parameters:

key - the translation key

args - the translation arguments

Returns:

the translatable component

of

static TranslatableComponent of(@NonNull java.lang.String key,
                                @Nullable TextColor color,
                                @NonNull java.util.List<? extends Component> args)

Creates a translatable component with a translation key, arguments, and optional color.

Parameters:

key - the translation key

color - the color

args - the translation arguments

Returns:

the translatable component

of

static @NonNull TranslatableComponent of(@NonNull java.lang.String key,
                                         @Nullable TextColor color,
                                         @NonNull java.util.Set<TextDecoration> decorations,
                                         @NonNull java.util.List<? extends Component> args)

Creates a translatable component with a translation key, arguments, and optional color and decorations.

Parameters:

key - the translation key

color - the color

decorations - the decorations

args - the translation arguments

Returns:

the translatable component

make

static @NonNull TranslatableComponent make(@NonNull java.util.function.Consumer<? super TranslatableComponent.Builder> consumer)

Creates a translatable component by applying configuration from consumer.

Parameters:

consumer - the builder configurator

Returns:

the translatable component

make

static @NonNull TranslatableComponent make(@NonNull java.lang.String key,
                                           @NonNull java.util.function.Consumer<? super TranslatableComponent.Builder> consumer)

Creates a translatable component by applying configuration from consumer.

Parameters:

key - the translation key

consumer - the builder configurator

Returns:

the translatable component

make

static @NonNull TranslatableComponent make(@NonNull java.lang.String key,
                                           @NonNull java.util.List<? extends Component> args,
                                           @NonNull java.util.function.Consumer<? super TranslatableComponent.Builder> consumer)

Creates a translatable component by applying configuration from consumer.

Parameters:

key - the translation key

args - the translation arguments

consumer - the builder configurator

Returns:

the translatable component

key

@NonNull java.lang.String key()

Gets the translation key.

Returns:

the translation key

key

@NonNull TranslatableComponent key(@NonNull java.lang.String key)

Sets the translation key.

Parameters:

key - the translation key

Returns:

a copy of this component

args

@NonNull java.util.List<Component> args()

Gets the unmodifiable list of translation arguments.

Returns:

the unmodifiable list of translation arguments

args

@NonNull TranslatableComponent args(@NonNull java.util.List<? extends Component> args)

Sets the translation arguments for this component.

Parameters:

args - the translation arguments

Returns:

this component