Module net.minestom.server

Package net.minestom.server.command.builder

Class Command

java.lang.Object

net.minestom.server.command.builder.Command

Direct Known Subclasses:

SimpleCommand

public class Command
extends Object

Represents a command which has suggestion/auto-completion.

The command works using a list of valid syntaxes. For instance we could build the command "/health set Notch 50" into multiple argument types "/health [set/add/remove] [username] [integer]"

All the default argument types can be found in ArgumentType and the syntax be created/registered using addSyntax(CommandExecutor, Argument[]).

If the command is executed with an incorrect syntax or without any argument, the default CommandExecutor will be called, you can set it using setDefaultExecutor(CommandExecutor).

Before any syntax to be successfully executed the CommandSender needs to validated the CommandCondition sets with setCondition(CommandCondition) (ignored if null).

Some Argument could also require additional condition (eg: a number which need to be between 2 values), in this case, if the whole syntax is correct but not the argument condition, you can listen to its error code using setArgumentCallback(ArgumentCallback, Argument) or Argument.setCallback(ArgumentCallback).

Constructor Summary

Constructors

Constructor	Description
Command(String name)	Creates a Command with a name and no alias.
Command(String name, String... aliases)	Creates a Command with a name and one or multiple aliases.

Method Summary

Modifier and Type	Method	Description
Collection<CommandSyntax>	addConditionalSyntax(@Nullable CommandCondition commandCondition, CommandExecutor executor, Argument<?>... args)	Adds a new syntax in the command.
void	addSubcommand(Command command)
Collection<CommandSyntax>	addSyntax(CommandExecutor executor, String format)	Creates a syntax from a formatted string.
Collection<CommandSyntax>	addSyntax(CommandExecutor executor, Argument<?>... args)	Adds a new syntax without condition.
String[]	getAliases()	Gets the command's aliases.
@Nullable CommandCondition	getCondition()	Gets the CommandCondition.
@Nullable CommandExecutor	getDefaultExecutor()	Gets the default CommandExecutor which is called when there is no argument or if no corresponding syntax has been found.
String	getName()	Gets the main command's name.
String[]	getNames()	Gets all the possible names for this command.
List<Command>	getSubcommands()
Collection<CommandSyntax>	getSyntaxes()	Gets all the syntaxes of this command.
Set<String>	getSyntaxesStrings()
String	getSyntaxesTree()
void	globalListener(CommandSender sender, @UnknownNullability CommandContext context, String command)	Called when a CommandSender executes this command before any syntax callback.
static boolean	isValidName(Command command, String name)
void	setArgumentCallback(ArgumentCallback callback, Argument<?> argument)	Sets an ArgumentCallback.
void	setCondition(@Nullable CommandCondition commandCondition)	Sets the CommandCondition.
void	setDefaultExecutor(@Nullable CommandExecutor executor)	Sets the default CommandExecutor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Command

public Command(String name,
 String... aliases)

Creates a Command with a name and one or multiple aliases.

Parameters:

name - the name of the command

aliases - the command aliases

See Also:

• Command(String)

Command

public Command(String name)

Creates a Command with a name and no alias.

Parameters:

name - the name of the command

See Also:

• Command(String, String...)

Method Details

getCondition

@Nullable
public @Nullable CommandCondition getCondition()

Gets the CommandCondition.

It is called after the parsing and just before the execution no matter the syntax used and can be used to check permissions or the CommandSender type.

Worth mentioning that the condition is also used to know if the command known from a player (at connection).

Returns:

the command condition, null if not any

setCondition

public void setCondition(@Nullable
 @Nullable CommandCondition commandCondition)

Sets the CommandCondition.

Parameters:

commandCondition - the new command condition, null to do not call anything

See Also:

• getCondition()

setArgumentCallback

public void setArgumentCallback(ArgumentCallback callback,
 Argument<?> argument)

Sets an ArgumentCallback.

The argument callback is called when there's an error in the argument.

Parameters:

callback - the callback for the argument

argument - the argument which get the callback

addSubcommand

public void addSubcommand(Command command)

getSubcommands

public List<Command> getSubcommands()

addConditionalSyntax

public Collection<CommandSyntax> addConditionalSyntax(@Nullable
 @Nullable CommandCondition commandCondition,
 CommandExecutor executor,
 Argument<?>... args)

Adds a new syntax in the command.

A syntax is simply a list of arguments and an executor called when successfully parsed.

Parameters:

commandCondition - the condition to use the syntax

executor - the executor to call when the syntax is successfully received

args - all the arguments of the syntax, the length needs to be higher than 0

Returns:

the created syntaxes, there can be multiple of them when optional arguments are used

addSyntax

public Collection<CommandSyntax> addSyntax(CommandExecutor executor,
 Argument<?>... args)

Adds a new syntax without condition.

See Also:

• addConditionalSyntax(CommandCondition, CommandExecutor, Argument[])

addSyntax

@Experimental
public Collection<CommandSyntax> addSyntax(CommandExecutor executor,
 String format)

Creates a syntax from a formatted string.

Currently in beta as the format is not final.

Parameters:

executor - the syntax executor

format - the syntax format

Returns:

the newly created syntaxes.

getName

public String getName()

Gets the main command's name.

Returns:

the main command's name

getAliases

public String[] getAliases()

Gets the command's aliases.

Returns:

the command aliases, can be null or empty

getNames

public String[] getNames()

Gets all the possible names for this command.

Include getName() and getAliases().

Returns:

this command names

getDefaultExecutor

@Nullable
public @Nullable CommandExecutor getDefaultExecutor()

Gets the default CommandExecutor which is called when there is no argument or if no corresponding syntax has been found.

Returns:

the default executor, null if not any

See Also:

• setDefaultExecutor(CommandExecutor)

setDefaultExecutor

public void setDefaultExecutor(@Nullable
 @Nullable CommandExecutor executor)

Sets the default CommandExecutor.

Parameters:

executor - the new default executor, null to remove it

See Also:

• getDefaultExecutor()

getSyntaxes

public Collection<CommandSyntax> getSyntaxes()

Gets all the syntaxes of this command.

Returns:

a collection containing all this command syntaxes

See Also:

• addSyntax(CommandExecutor, Argument[])

globalListener

public void globalListener(CommandSender sender,
 @UnknownNullability CommandContext context,
 String command)

Called when a CommandSender executes this command before any syntax callback.

WARNING: the CommandCondition is not executed, and all the CommandSyntax are not checked, this is called every time a CommandSender send a command which start by getName() or getAliases().

Can be used if you wish to still suggest the player syntaxes but want to parse things mostly by yourself.

Parameters:

sender - the CommandSender

context - the UNCHECKED context of the command, some can be null even when unexpected

command - the raw UNCHECKED received command

getSyntaxesStrings

@Experimental
public Set<String> getSyntaxesStrings()

getSyntaxesTree

@Experimental
public String getSyntaxesTree()

isValidName

public static boolean isValidName(Command command,
 String name)