Package org.incendo.cloud.minecraft.extras.caption

Interface RichVariable

All Superinterfaces:

CaptionVariable, ComponentLike

@Immutable
@API(status=STABLE)
public interface RichVariable
extends CaptionVariable, ComponentLike

A CaptionVariable implementation that uses Adventure components.

Method Summary

Modifier and Type	Method	Description
default @NotNull Component	asComponent()
@NonNull Component	component()	Returns the variable value as a component.
@NonNull String	key()
static @NonNull RichVariable	of(@NonNull String key, @NonNull Component component)	Creates a new rich variable.
default @NonNull String	value()

Method Details

of

static @NonNull RichVariable of(@NonNull String key,
 @NonNull Component component)

Creates a new rich variable.

Parameters:

key - variable key

component - variable value

Returns:

the variable

key

@NonNull String key()

Specified by:

key in interface CaptionVariable

component

@NonNull Component component()

Returns the variable value as a component.

Returns:

the component

asComponent

@NotNull
default @NotNull Component asComponent()

Specified by:

asComponent in interface ComponentLike

value

default @NonNull String value()

Specified by:

value in interface CaptionVariable