Interface AsyncTabCompleteEvent.Completion

Enclosing class:

AsyncTabCompleteEvent

public static interface AsyncTabCompleteEvent.Completion

A rich tab completion, consisting of a string suggestion, and a nullable Component tooltip.

Since:

1.16.5

Method Summary

Modifier and Type	Method	Description
static AsyncTabCompleteEvent.Completion	completion(String suggestion)	Create a new AsyncTabCompleteEvent.Completion from a suggestion string.
static AsyncTabCompleteEvent.Completion	completion(String suggestion, @Nullable net.kyori.adventure.text.Component tooltip)	Create a new AsyncTabCompleteEvent.Completion from a suggestion string and a tooltip Component.
String	suggestion()	Get the suggestion string for this AsyncTabCompleteEvent.Completion.
@Nullable net.kyori.adventure.text.Component	tooltip()	Get the suggestion tooltip for this AsyncTabCompleteEvent.Completion.

Method Details

suggestion

String suggestion()

Get the suggestion string for this AsyncTabCompleteEvent.Completion.

Returns:

suggestion string

Since:

1.16.5

tooltip

@Nullable net.kyori.adventure.text.Component tooltip()

Get the suggestion tooltip for this AsyncTabCompleteEvent.Completion.

Returns:

tooltip component

Since:

1.16.5

completion

static AsyncTabCompleteEvent.Completion completion(String suggestion)

Create a new AsyncTabCompleteEvent.Completion from a suggestion string.

Parameters:

suggestion - suggestion string

Returns:

new completion instance

Since:

1.16.5

completion

static AsyncTabCompleteEvent.Completion completion(String suggestion,
 @Nullable net.kyori.adventure.text.Component tooltip)

Create a new AsyncTabCompleteEvent.Completion from a suggestion string and a tooltip Component.

If the provided component is null, the suggestion will not have a tooltip.

Parameters:

suggestion - suggestion string

tooltip - tooltip component, or null

Returns:

new completion instance

Since:

1.16.5