Package org.incendo.cloud.brigadier.suggestion

Interface TooltipSuggestion

All Superinterfaces:

Suggestion

All Known Implementing Classes:

TooltipSuggestion.TooltipSuggestionImpl

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

Suggestion that has an optional Brigadier message tooltip.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TooltipSuggestion.TooltipSuggestionImpl

Method Summary

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

Methods inherited from interface org.incendo.cloud.suggestion.Suggestion

suggestion

Method Details

tooltipSuggestion

static @NonNull TooltipSuggestion tooltipSuggestion(@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

tooltip

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

Returns the tooltip.

Returns:

the tooltip, or null

withSuggestion

default @NonNull TooltipSuggestion withSuggestion(@NonNull String string)

Specified by:

withSuggestion in interface Suggestion

withTooltip

default @NonNull TooltipSuggestion withTooltip(@NonNull com.mojang.brigadier.Message tooltip)

Returns a copy of this suggestion instance using the given tooltip

Parameters:

tooltip - the new tooltip

Returns:

the new suggestion