Spigot DispatchCommand - Java

Spigot DispatchCommand is a powerful command system for plugins using the Spigot API. It allows you to easily register and handle commands within your plugin, and provides many useful features like tab completion, command aliases, and subcommands.

Getting Started

To use Spigot DispatchCommand in your plugin, you first need to add it as a dependency in your pom.xml or build.gradle file. You can find the latest version on the project page on GitHub.

Once you have added the dependency, you can start using DispatchCommand in your plugin code. The basic structure of a command using DispatchCommand looks like this:

public class MyPluginCommand implements CommandExecutor {
    
    @Override
    public boolean onCommand(CommandSender sender, Command cmd, String label, String[] args) {
        // Handle command here
    }
        
}

You can register this command in your plugin using the PluginCommand class:

PluginCommand myCommand = getCommand("mycommand");
myCommand.setExecutor(new MyPluginCommand());

This will register the command "mycommand" to be handled by the MyPluginCommand class.

Features

DispatchCommand provides many useful features for handling commands in your plugin. Here are some of the most important ones:

Tab Completion

You can easily provide tab completion for your commands using DispatchCommand. To do this, you simply need to implement the TabCompleter interface and set it on your command.

public class MyPluginCommand implements CommandExecutor, TabCompleter {
    
    @Override
    public List<String> onTabComplete(CommandSender sender, Command cmd, String label, String[] args) {
        // Handle tab completion here
    }
        
}

You can then set the tab completer on your command:

PluginCommand myCommand = getCommand("mycommand");
myCommand.setExecutor(new MyPluginCommand());
myCommand.setTabCompleter(new MyPluginCommand());

Command Aliases

You can register aliases for your commands using DispatchCommand. This allows players to use alternative names to execute your commands.

PluginCommand myCommand = getCommand("mycommand");
myCommand.setAliases(Arrays.asList("alias1", "alias2"));

Subcommands

You can easily implement subcommands using DispatchCommand. To do this, you simply need to register a child command for your main command.

PluginCommand myCommand = getCommand("mycommand");
PluginCommand childCommand = myCommand.getChild("subcommand");
childCommand.setExecutor(new MyChildCommand());

The MyChildCommand class would implement the CommandExecutor interface.

Conclusion

Spigot DispatchCommand is a powerful and flexible command system for plugins using the Spigot API. It provides many useful features like tab completion, command aliases, and subcommands, and is easy to use and integrate into your plugin code.