Package com.plotsquared.core.configuration.caption

Interface Caption

All Known Subinterfaces:

NamespacedCaption

All Known Implementing Classes:

CommandCategory, StaticCaption, TranslatableCaption

public interface Caption

Any message that can be sent to a player, the console, etc.

Method Summary

Modifier and Type	Method	Description
@NonNull String	getComponent(@NonNull LocaleHolder localeHolder)	Get the message that should be sent to the recipient
@NonNull Component	toComponent(@NonNull LocaleHolder localeHolder)	Get the Adventure ComponentLike for this caption
@NonNull Component	toComponent(@NonNull LocaleHolder localeHolder, @NonNull TagResolver @NonNull ... tagResolvers)	Get the Adventure ComponentLike for this caption while applying custom TagResolver (apart from the default core.prefix)
@NonNull String	toString()

Method Details

getComponent

@NonNull String getComponent(@NonNull LocaleHolder localeHolder)

Get the message that should be sent to the recipient

Parameters:

localeHolder - Locale holder

Returns:

Message

toComponent

@NonNull Component toComponent(@NonNull LocaleHolder localeHolder)

Get the Adventure ComponentLike for this caption

Parameters:

localeHolder - Locale holder

Returns:

ComponentLike

Since:

7.0.0

toComponent

@NonNull Component toComponent(@NonNull LocaleHolder localeHolder,
 @NonNull TagResolver @NonNull ... tagResolvers)

Get the Adventure ComponentLike for this caption while applying custom TagResolver (apart from the default core.prefix)

Parameters:

localeHolder - Local holder

tagResolvers - custom tag resolvers to replace placeholders / parameters

Returns:

ComponentLike

Since:

7.5.4

toString

@NonNull String toString()

Overrides:

toString in class Object