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

Class TranslatableCaption

java.lang.Object

org.incendo.cloud.minecraft.extras.caption.TranslatableCaption

All Implemented Interfaces:

Caption

public final class TranslatableCaption
extends Object
implements Caption

Method Summary

Modifier and Type	Method	Description
@NonNull String	key()
static Caption	translatableCaption(String key)	Creates a new TranslatableCaption.
static <C> CaptionProvider<C>	translatableCaptionProvider()	Caption provider mapping TranslatableCaption directly to it's key, for use with ComponentCaptionFormatter.translatable() or similar.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

translatableCaption

public static Caption translatableCaption(String key)

Creates a new TranslatableCaption.

Parameters:

key - caption key

Returns:

caption

translatableCaptionProvider

public static <C> CaptionProvider<C> translatableCaptionProvider()

Caption provider mapping TranslatableCaption directly to it's key, for use with ComponentCaptionFormatter.translatable() or similar. This is necessary for the CaptionRegistry to recognize TranslatableCaption without messages.

Type Parameters:

C - command sender type

Returns:

caption provider

key

public @NonNull String key()

Specified by:

key in interface Caption