Package org.incendo.cloud.minecraft.extras

Interface MinecraftHelp.DescriptionDecorator<C>

Enclosing class:

MinecraftHelp<C>

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,
     since="2.0.0")
@FunctionalInterface
public static interface MinecraftHelp.DescriptionDecorator<C>

Method Summary

Modifier and Type	Method	Description
@NonNull Component	decorate(@NonNull C sender, @NonNull String description)	Turns the given description into an adventure Component.
static <C> @NonNull MinecraftHelp.DescriptionDecorator<C>	text()	Returns a description decorator that turns the description into a text component without any style.
static <C> @NonNull MinecraftHelp.DescriptionDecorator<C>	wrap(@NonNull Function<String,Component> function)	Return a description decorator that wraps the given function.

Method Details

wrap

static <C>
@NonNull MinecraftHelp.DescriptionDecorator<C> wrap(@NonNull Function<String,Component> function)

Return a description decorator that wraps the given function.

Type Parameters:

C - the command sender type

Parameters:

function - the function

Returns:

the decorator

text

static <C>
@NonNull MinecraftHelp.DescriptionDecorator<C> text()

Returns a description decorator that turns the description into a text component without any style.

Type Parameters:

C - the command sender type

Returns:

the decorator

decorate

@NonNull Component decorate(@NonNull C sender,
 @NonNull String description)

Turns the given description into an adventure Component.

Parameters:

sender - command sender

description - description

Returns:

component