java.lang.Object

net.minestom.server.command.builder.CommandSyntax

public class CommandSyntax
extends java.lang.Object

Represents a syntax in Command which is initialized with Command.addSyntax(CommandExecutor, Argument[]).

Method Summary

Modifier and Type	Method	Description
`Argument<?>[]`	`getArguments()`	Gets all the required `Argument` for this syntax.
`CommandCondition`	`getCommandCondition()`	Gets the condition to use this syntax.
`CommandExecutor`	`getExecutor()`	Gets the `CommandExecutor` of this syntax, executed once the syntax is properly written.
`void`	`setCommandCondition(CommandCondition commandCondition)`	Changes the command condition of this syntax.
`void`	`setExecutor(CommandExecutor executor)`	Changes the `CommandExecutor` of this syntax.

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

Constructor Details
- CommandSyntax
  
  protected CommandSyntax(@Nullable CommandCondition commandCondition, @NotNull CommandExecutor commandExecutor, @NotNull Argument<?>... args)
Method Details
- getCommandCondition
  
  @Nullable public CommandCondition getCommandCondition()
  
  Gets the condition to use this syntax.
  
  Returns:
  
  this command condition, null if none
- setCommandCondition
  
  public void setCommandCondition(@Nullable CommandCondition commandCondition)
  
  Changes the command condition of this syntax.
  Be aware that changing the command condition will not automatically update players auto-completion. You can create a new packet containing the changes with CommandManager.createDeclareCommandsPacket(Player).
  
  Parameters:
  
  commandCondition - the new command condition, null to remove it
- getExecutor
  
  @NotNull public CommandExecutor getExecutor()
  
  Gets the CommandExecutor of this syntax, executed once the syntax is properly written.
  
  Returns:
  
  the executor of this syntax
- setExecutor
  
  public void setExecutor(@NotNull CommandExecutor executor)
  
  Changes the CommandExecutor of this syntax.
  
  Parameters:
  
  executor - the new executor
- getArguments
  
  @NotNull public Argument<?>[] getArguments()
  
  Gets all the required Argument for this syntax.
  
  Returns:
  
  the required arguments

Class CommandSyntax