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

Interface ComponentCaptionFormatter<C>

Type Parameters:

C - command sender type

All Superinterfaces:

CaptionFormatter<C,Component>

@API(status=STABLE,
     since="2.0.0")
public interface ComponentCaptionFormatter<C>
extends CaptionFormatter<C,Component>

Extension of CaptionFormatter to make it easier to convert from captions to adventure components.

Since:

2.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.incendo.cloud.caption.CaptionFormatter

CaptionFormatter.PatternReplacingCaptionFormatter<C>

Method Summary

Static Methods

Modifier and Type	Method	Description
static <C> @NonNull ComponentCaptionFormatter<C>	miniMessage()	Create a MiniMessage formatter with the default MiniMessage instance and no extra TagResolvers.
static <C> @NonNull ComponentCaptionFormatter<C>	miniMessage(@NonNull MiniMessage miniMessage)	Create a MiniMessage formatter with the provided MiniMessage instance and no extra TagResolvers.
static <C> @NonNull ComponentCaptionFormatter<C>	miniMessage(@NonNull MiniMessage miniMessage, @NonNull TagResolver @NonNull ... resolvers)	Create a MiniMessage formatter with the provided MiniMessage instance and no extra TagResolvers.
static <C> @NonNull ComponentCaptionFormatter<C>	patternReplacing(@NonNull Pattern pattern)	Returns a caption formatter that replaces the results from the given pattern with the values from the caption variables.
static <C> @NonNull ComponentCaptionFormatter<C>	placeholderReplacing()	Returns a caption formatter that replaces placeholders in the form of <placeholder> with the caption variables.
static <C> @NonNull ComponentCaptionFormatter<C>	translatable()	Caption formatter for translatable components.

Methods inherited from interface org.incendo.cloud.caption.CaptionFormatter

formatCaption, formatCaption

Method Details

miniMessage

static <C> @NonNull ComponentCaptionFormatter<C> miniMessage()

Create a MiniMessage formatter with the default MiniMessage instance and no extra TagResolvers.

Type Parameters:

C - command sender type

Returns:

MiniMessage formatter

miniMessage

static <C> @NonNull ComponentCaptionFormatter<C> miniMessage(@NonNull MiniMessage miniMessage)

Create a MiniMessage formatter with the provided MiniMessage instance and no extra TagResolvers.

Type Parameters:

C - command sender type

Parameters:

miniMessage - MiniMessage instance

Returns:

MiniMessage formatter

miniMessage

static <C> @NonNull ComponentCaptionFormatter<C> miniMessage(@NonNull MiniMessage miniMessage,
 @NonNull TagResolver @NonNull ... resolvers)

Create a MiniMessage formatter with the provided MiniMessage instance and no extra TagResolvers.

Type Parameters:

C - command sender type

Parameters:

miniMessage - MiniMessage instance

resolvers - extra resolvers

Returns:

MiniMessage formatter

translatable

@API(status=EXPERIMENTAL)
static <C> @NonNull ComponentCaptionFormatter<C> translatable()

Caption formatter for translatable components.

Type Parameters:

C - command sender type

Returns:

caption formatter

patternReplacing

static <C> @NonNull ComponentCaptionFormatter<C> patternReplacing(@NonNull Pattern pattern)

Returns a caption formatter that replaces the results from the given pattern with the values from the caption variables.

The 1st capturing group will be used to determine the name of the variable to use for the replacement.

Type Parameters:

C - the command sender type

Parameters:

pattern - the pattern

Returns:

the formatter

placeholderReplacing

static <C> @NonNull ComponentCaptionFormatter<C> placeholderReplacing()

Returns a caption formatter that replaces placeholders in the form of <placeholder> with the caption variables.

Type Parameters:

C - the command sender type

Returns:

the formatter