Package org.incendo.cloud.minecraft.extras.suggestion

Interface ComponentTooltipSuggestion

All Superinterfaces:

Suggestion

@Immutable
public interface ComponentTooltipSuggestion
extends Suggestion

Method Summary

Modifier and Type	Method	Description
@NonNull String	suggestion()
static @NonNull ComponentTooltipSuggestion	suggestion(@NonNull String suggestion)	Returns a new ComponentTooltipSuggestion with no tooltip.
static @NonNull ComponentTooltipSuggestion	suggestion(@NonNull String suggestion, @Nullable Component tooltip)	Returns a new ComponentTooltipSuggestion with the provided tooltip.
@Nullable Component	tooltip()	Returns the Component tooltip or null if there is no tooltip.
@NonNull ComponentTooltipSuggestion	withSuggestion(@NonNull String suggestion)

Method Details

suggestion

@NonNull String suggestion()

Specified by:

suggestion in interface Suggestion

tooltip

@Nullable Component tooltip()

Returns the Component tooltip or null if there is no tooltip.

Returns:

the tooltip

withSuggestion

@NonNull ComponentTooltipSuggestion withSuggestion(@NonNull String suggestion)

Specified by:

withSuggestion in interface Suggestion

suggestion

static @NonNull ComponentTooltipSuggestion suggestion(@NonNull String suggestion)

Returns a new ComponentTooltipSuggestion with no tooltip.

Parameters:

suggestion - suggestion

Returns:

suggestion

suggestion

static @NonNull ComponentTooltipSuggestion suggestion(@NonNull String suggestion,
 @Nullable Component tooltip)

Returns a new ComponentTooltipSuggestion with the provided tooltip.

Parameters:

suggestion - suggestion

tooltip - tooltip

Returns:

suggestion