Package net.minestom.server.command.builder

Class SimpleCommand

java.lang.Object

net.minestom.server.command.builder.Command

net.minestom.server.command.builder.SimpleCommand

public abstract class SimpleCommand
extends Command

Constructor Summary

Constructors

Constructor	Description
SimpleCommand(@NotNull String name, @Nullable String... aliases)

Method Summary

Modifier and Type	Method	Description
abstract boolean	hasAccess(@NotNull CommandSender sender, @Nullable String commandString)	Called to know if a player has access to the command.
abstract boolean	process(@NotNull CommandSender sender, @NotNull String command, @NotNull String[] args)	Called when the command is executed by a CommandSender.

Methods inherited from class net.minestom.server.command.builder.Command

addConditionalSyntax, addSubcommand, addSyntax, addSyntax, getAliases, getCondition, getDefaultExecutor, getName, getNames, getSubcommands, getSyntaxes, getSyntaxesStrings, getSyntaxesTree, globalListener, isValidName, setArgumentCallback, setCondition, setDefaultExecutor

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleCommand

public SimpleCommand(@NotNull
 @NotNull String name,
 @Nullable
 @Nullable String... aliases)

Method Details

process

public abstract boolean process(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull String command,
 @NotNull
 @NotNull String[] args)

Called when the command is executed by a CommandSender.

Parameters:

sender - the sender which executed the command

command - the command name used

args - an array containing all the args (split by space char)

Returns:

true when the command is successful, false otherwise

hasAccess

public abstract boolean hasAccess(@NotNull
 @NotNull CommandSender sender,
 @Nullable
 @Nullable String commandString)

Called to know if a player has access to the command.

Parameters:

sender - the command sender to check the access

commandString - the raw command string, null if this is an access request

Returns:

true if the player has access to the command, false otherwise