com.velocitypowered.api.command

Interface Command

public interface Command

Represents a command that can be executed by a CommandSource, such as a Player or the console.

Method Summary

Modifier and Type	Method and Description
void	execute(CommandSource source, String[] args) Executes the command for the specified CommandSource.
default boolean	hasPermission(CommandSource source, String[] args) Tests to check if the source has permission to use this command with the provided args.
default List<String>	suggest(CommandSource source, String[] currentArgs) Provides tab complete suggestions for a command for a specified CommandSource.

Method Detail

execute

void execute(CommandSource source,
             String[] args)

Executes the command for the specified CommandSource.

Parameters:

source - the source of this command

args - the arguments for this command

suggest

default List<String> suggest(CommandSource source,
                             String[] currentArgs)

Provides tab complete suggestions for a command for a specified CommandSource.

Parameters:

source - the source to run the command for

currentArgs - the current, partial arguments for this command

Returns:

tab complete suggestions

hasPermission

default boolean hasPermission(CommandSource source,
                              String[] args)

Tests to check if the source has permission to use this command with the provided args.

If this method returns false, the handling will be forwarded onto the players current server.

Parameters:

source - the source of the command

args - the arguments for this command

Returns:

whether the source has permission