Package org.incendo.cloud.brigadier.suggestion

Interface TooltipSuggestion

All Superinterfaces:

Suggestion

@API(status=STABLE,
     since="2.0.0")
@Immutable
public interface TooltipSuggestion
extends Suggestion

Suggestion that has an optional Brigadier message tooltip.

Since:

2.0.0

Method Summary

Modifier and Type	Method	Description
@NonNull String	suggestion()
static @NonNull TooltipSuggestion	suggestion(@NonNull String suggestion, @Nullable com.mojang.brigadier.Message tooltip)	Returns a new TooltipSuggestion with the given suggestion and tooltip.
@Nullable com.mojang.brigadier.Message	tooltip()	Returns the tooltip.
static @NonNull TooltipSuggestion	tooltipSuggestion(@NonNull Suggestion suggestion)	Returns a new TooltipSuggestion that uses the given suggestion and has a null tooltip.
@NonNull TooltipSuggestion	withSuggestion(@NonNull String suggestion)

Method Details

suggestion

static @NonNull TooltipSuggestion suggestion(@NonNull String suggestion,
 @Nullable com.mojang.brigadier.Message tooltip)

Returns a new TooltipSuggestion with the given suggestion and tooltip.

Parameters:

suggestion - the suggestion

tooltip - the optional tooltip that is displayed when hovering over the suggestion

Returns:

the suggestion instance

tooltipSuggestion

static @NonNull TooltipSuggestion tooltipSuggestion(@NonNull Suggestion suggestion)

Returns a new TooltipSuggestion that uses the given suggestion and has a null tooltip.

Parameters:

suggestion - the suggestion

Returns:

the suggestion instance

suggestion

@NonNull String suggestion()

Specified by:

suggestion in interface Suggestion

tooltip

@Nullable com.mojang.brigadier.Message tooltip()

Returns the tooltip.

Returns:

the tooltip, or null

withSuggestion

@NonNull TooltipSuggestion withSuggestion(@NonNull String suggestion)

Specified by:

withSuggestion in interface Suggestion