com.mrivanplays.commandworker.core.argument

Interface Argument

All Known Implementing Classes:

LiteralArgument, RequiredArgument

public interface Argument

Represents wrapped argument, which would get wrapped in a brigadier one later when command is being registered.

Method Summary

Modifier and Type	Method and Description
default <T> @Nullable com.mojang.brigadier.arguments.ArgumentType<T>	getArgumentType() Returns the brigadier argument type, if the argument is required.
@NotNull List<Argument>	getChildren() Returns unmodifiable copy of the children this argument is holding.
@NotNull String	getName() Returns the name of the argument.
default @Nullable Consumer<com.mojang.brigadier.suggestion.SuggestionsBuilder>	getSuggestionsConsumer() Returns the SuggestionsBuilder consumer, which is able to modify the suggestions for this argument.
default boolean	isLiteral() Returns whether or not this argument is literal.
boolean	shouldExecuteCommand() Returns whether or not this argument should call the base command's execute method when the argument ends up being the last typed argument.

Method Detail

getName

@NotNull
@NotNull String getName()

Returns the name of the argument. Usually the completion you see if the argument is literal

Returns:

name

getArgumentType

@Nullable
default <T> @Nullable com.mojang.brigadier.arguments.ArgumentType<T> getArgumentType()

Returns the brigadier argument type, if the argument is required.

A literal argument does not have a dedicated argument type, and this will return null if the argument is literal.

Type Parameters:

T - the type held by the argument type.

Returns:

argument type

isLiteral

default boolean isLiteral()

Returns whether or not this argument is literal.

Returns:

true if literal, false otherwise

getSuggestionsConsumer

@Nullable
default @Nullable Consumer<com.mojang.brigadier.suggestion.SuggestionsBuilder> getSuggestionsConsumer()

Returns the SuggestionsBuilder consumer, which is able to modify the suggestions for this argument. By default, this returns null.

We do not suggest using suggestions builder to add your suggestions. Instead, use literal arguments with combination with a required one

Returns:

suggestions consumer

shouldExecuteCommand

boolean shouldExecuteCommand()

Returns whether or not this argument should call the base command's execute method when the argument ends up being the last typed argument. This marking is being ignored if brigadier isn't supported for the minecraft version your plugin is being ran on.

Returns:

true if should have execute, false otherwise

getChildren

@NotNull
@NotNull List<Argument> getChildren()

Returns unmodifiable copy of the children this argument is holding.

Returns:

children