me.lucko.commodore

Interface Commodore

public interface Commodore

Utility for using Minecraft's 1.13 'brigadier' library in Bukkit plugins.

Method Summary

Modifier and Type	Method and Description
static Collection<String>	getAliases(org.bukkit.command.Command command) Gets all of the aliases known for the given command.
com.mojang.brigadier.CommandDispatcher	getDispatcher() Gets the current command dispatcher instance.
List<com.mojang.brigadier.tree.LiteralCommandNode<?>>	getRegisteredNodes() Gets a list of all nodes registered to the CommandDispatcher by this instance.
default void	register(org.bukkit.command.Command command, com.mojang.brigadier.builder.LiteralArgumentBuilder<?> argumentBuilder) Registers the provided argument data to the dispatcher, against all aliases defined for the command.
void	register(org.bukkit.command.Command command, com.mojang.brigadier.tree.LiteralCommandNode<?> node) Registers the provided argument data to the dispatcher, against all aliases defined for the command.
default void	register(com.mojang.brigadier.builder.LiteralArgumentBuilder<?> argumentBuilder) Registers the provided argument data to the dispatcher.
void	register(com.mojang.brigadier.tree.LiteralCommandNode<?> node) Registers the provided argument data to the dispatcher.

Method Detail

getDispatcher

com.mojang.brigadier.CommandDispatcher getDispatcher()

Gets the current command dispatcher instance.

CraftBukkit doesn't use the same dispatcher instance throughout the runtime of the server. The dispatcher instance is completely wiped (and replaced with a new instace) every time new plugins are loaded.

Returns:

the command dispatcher

getRegisteredNodes

List<com.mojang.brigadier.tree.LiteralCommandNode<?>> getRegisteredNodes()

Gets a list of all nodes registered to the CommandDispatcher by this instance.

Bear in mind that registrations are pushed to the dispatcher with a 1 tick delay. Nodes will not appear in this list until they have actually been registered.

Returns:

a list of all registered nodes.

register

void register(com.mojang.brigadier.tree.LiteralCommandNode<?> node)

Registers the provided argument data to the dispatcher.

Equivalent to calling CommandDispatcher.register(LiteralArgumentBuilder).

The registration action occurs after a delay of one tick. This is because the dispatcher instance is completely replaced after all plugins have been loaded.

Parameters:

node - the argument data

register

default void register(com.mojang.brigadier.builder.LiteralArgumentBuilder<?> argumentBuilder)

Registers the provided argument data to the dispatcher.

Equivalent to calling CommandDispatcher.register(LiteralArgumentBuilder).

The registration action occurs after a delay of one tick. This is because the dispatcher instance is completely replaced after all plugins have been loaded.

Parameters:

argumentBuilder - the argument data

register

void register(org.bukkit.command.Command command,
              com.mojang.brigadier.tree.LiteralCommandNode<?> node)

Registers the provided argument data to the dispatcher, against all aliases defined for the command.

Parameters:

command - the command to read aliases from

node - the argument data

register

default void register(org.bukkit.command.Command command,
                      com.mojang.brigadier.builder.LiteralArgumentBuilder<?> argumentBuilder)

Registers the provided argument data to the dispatcher, against all aliases defined for the command.

Parameters:

command - the command to read aliases from

argumentBuilder - the argument data, in a builder form

getAliases

static Collection<String> getAliases(org.bukkit.command.Command command)

Gets all of the aliases known for the given command.

This will include the main label, as well as defined aliases, and aliases including the fallback prefix added by Bukkit.

Parameters:

command - the command

Returns:

the aliases