Package dev.jorel.commandapi.arguments

Interface ArgumentSuggestions

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ArgumentSuggestions

This class represents suggestions for an argument. ArgumentSuggestions objects are best created using the static methods as opposed to functionally.

Method Summary

Modifier and Type	Method	Description
static ArgumentSuggestions	empty()	Suggest nothing
static ArgumentSuggestions	merge(ArgumentSuggestions... suggestions)	Merge suggestions from multiple ArgumentSuggestions together
static ArgumentSuggestions	stringCollection(Function<SuggestionInfo,Collection<String>> suggestions)	Suggest a collection of strings as the result of a function
static ArgumentSuggestions	stringCollectionAsync(Function<SuggestionInfo,CompletableFuture<Collection<String>>> suggestions)	Suggest a collection of strings asynchronously
static ArgumentSuggestions	strings(String... suggestions)	Suggest hardcoded strings
static ArgumentSuggestions	strings(Collection<String> suggestions)	Suggest hardcoded strings
static ArgumentSuggestions	strings(Function<SuggestionInfo,String[]> suggestions)	Suggest an array of strings as the result of a function
static ArgumentSuggestions	stringsAsync(Function<SuggestionInfo,CompletableFuture<String[]>> suggestions)	Suggest an array of strings asynchronously
static ArgumentSuggestions	stringsWithTooltips(IStringTooltip... suggestions)	Suggest hardcoded strings with tooltips
static ArgumentSuggestions	stringsWithTooltips(Collection<IStringTooltip> suggestions)	Suggest hardcoded strings with tooltips
static ArgumentSuggestions	stringsWithTooltips(Function<SuggestionInfo,IStringTooltip[]> suggestions)	Suggest an array of strings with tooltips as the result of a function
static ArgumentSuggestions	stringsWithTooltipsAsync(Function<SuggestionInfo,CompletableFuture<IStringTooltip[]>> suggestions)	Suggest an array of strings with tooltips asynchronously
static ArgumentSuggestions	stringsWithTooltipsCollection(Function<SuggestionInfo,Collection<IStringTooltip>> suggestions)	Suggest a collection of strings with tooltips as the result of a function
static ArgumentSuggestions	stringsWithTooltipsCollectionAsync(Function<SuggestionInfo,CompletableFuture<Collection<IStringTooltip>>> suggestions)	Suggest a collection of strings with tooltips asynchronously
CompletableFuture<com.mojang.brigadier.suggestion.Suggestions>	suggest(SuggestionInfo info, com.mojang.brigadier.suggestion.SuggestionsBuilder builder)	Create a CompletableFuture resolving onto a brigadier Suggestions object.

Method Details

suggest

CompletableFuture<com.mojang.brigadier.suggestion.Suggestions> suggest(SuggestionInfo info,
 com.mojang.brigadier.suggestion.SuggestionsBuilder builder)
                                                                throws com.mojang.brigadier.exceptions.CommandSyntaxException

Create a CompletableFuture resolving onto a brigadier Suggestions object.

Parameters:

info - The suggestions info

builder - The Brigadier SuggestionsBuilder object

Returns:

a CompletableFuture resolving onto a brigadier Suggestions object.

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException - if there is an error making suggestions

empty

static ArgumentSuggestions empty()

Suggest nothing

Returns:

an ArgumentSuggestions object suggesting nothing.

strings

static ArgumentSuggestions strings(String... suggestions)

Suggest hardcoded strings

Parameters:

suggestions - array of hardcoded strings

Returns:

an ArgumentSuggestions object suggesting hardcoded strings

strings

static ArgumentSuggestions strings(Collection<String> suggestions)

Suggest hardcoded strings

Parameters:

suggestions - collection of hardcoded strings

Returns:

an ArgumentSuggestions object suggesting hardcoded strings

strings

static ArgumentSuggestions strings(Function<SuggestionInfo,String[]> suggestions)

Suggest an array of strings as the result of a function

Parameters:

suggestions - function providing the strings as an array

Returns:

an ArgumentSuggestions object suggesting the result of the function

stringCollection

static ArgumentSuggestions stringCollection(Function<SuggestionInfo,Collection<String>> suggestions)

Suggest a collection of strings as the result of a function

Parameters:

suggestions - function providing the strings as a collection

Returns:

an ArgumentSuggestions object suggesting the result of the function

stringsAsync

static ArgumentSuggestions stringsAsync(Function<SuggestionInfo,CompletableFuture<String[]>> suggestions)

Suggest an array of strings asynchronously

Parameters:

suggestions - function providing the array of strings asynchronously

Returns:

an ArgumentSuggestions object suggesting the result of the asynchronous function

stringCollectionAsync

static ArgumentSuggestions stringCollectionAsync(Function<SuggestionInfo,CompletableFuture<Collection<String>>> suggestions)

Suggest a collection of strings asynchronously

Parameters:

suggestions - function providing the collection of strings asynchronously

Returns:

an ArgumentSuggestions object suggesting the result of the asynchronous function

stringsWithTooltips

static ArgumentSuggestions stringsWithTooltips(IStringTooltip... suggestions)

Suggest hardcoded strings with tooltips

Parameters:

suggestions - collection of hardcoded strings with tooltips

Returns:

an ArgumentSuggestions object suggesting the hardcoded strings with tooltips

stringsWithTooltips

static ArgumentSuggestions stringsWithTooltips(Collection<IStringTooltip> suggestions)

Suggest hardcoded strings with tooltips

Parameters:

suggestions - collection of hardcoded strings with tooltips

Returns:

an ArgumentSuggestions object suggesting the hardcoded strings with tooltips

stringsWithTooltips

static ArgumentSuggestions stringsWithTooltips(Function<SuggestionInfo,IStringTooltip[]> suggestions)

Suggest an array of strings with tooltips as the result of a function

Parameters:

suggestions - function providing the array of strings with tooltips

Returns:

an ArgumentSuggestions object suggesting the result of the function

stringsWithTooltipsCollection

static ArgumentSuggestions stringsWithTooltipsCollection(Function<SuggestionInfo,Collection<IStringTooltip>> suggestions)

Suggest a collection of strings with tooltips as the result of a function

Parameters:

suggestions - function providing the collection of strings with tooltips

Returns:

an ArgumentSuggestions object suggesting the result of the function

stringsWithTooltipsAsync

static ArgumentSuggestions stringsWithTooltipsAsync(Function<SuggestionInfo,CompletableFuture<IStringTooltip[]>> suggestions)

Suggest an array of strings with tooltips asynchronously

Parameters:

suggestions - function providing the array of strings with tooltips asynchronously

Returns:

an ArgumentSuggestions object suggesting the result of the asynchronous function

stringsWithTooltipsCollectionAsync

static ArgumentSuggestions stringsWithTooltipsCollectionAsync(Function<SuggestionInfo,CompletableFuture<Collection<IStringTooltip>>> suggestions)

Suggest a collection of strings with tooltips asynchronously

Parameters:

suggestions - function providing the collection of strings with tooltips asynchronously

Returns:

an ArgumentSuggestions object suggesting the result of the asynchronous function

merge

static ArgumentSuggestions merge(ArgumentSuggestions... suggestions)

Merge suggestions from multiple ArgumentSuggestions together

Parameters:

suggestions - The ArgumentSuggestions to be merged

Returns:

an ArgumentSuggestions object suggesting everything suggested by the input suggestions