Package com.velocitypowered.api.command

Interface CommandMeta

public interface CommandMeta

Contains metadata for a Command.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CommandMeta.Builder	Provides a fluent interface to create CommandMetas.

Method Summary

Modifier and Type	Method	Description
Collection<String>	getAliases()	Returns a non-empty collection containing the case-insensitive aliases used to execute the command.
Collection<com.mojang.brigadier.tree.CommandNode<CommandSource>>	getHints()	Returns an immutable collection containing command nodes that provide additional argument metadata and tab-complete suggestions.
@Nullable Object	getPlugin()	Returns the plugin who registered the command.

Method Details

getAliases

Collection<String> getAliases()

Returns a non-empty collection containing the case-insensitive aliases used to execute the command.

Returns:

the command aliases

getHints

Collection<com.mojang.brigadier.tree.CommandNode<CommandSource>> getHints()

Returns an immutable collection containing command nodes that provide additional argument metadata and tab-complete suggestions. Note some Command implementations may not support hinting.

Returns:

the hinting command nodes

getPlugin

@Nullable Object getPlugin()

Returns the plugin who registered the command. Note some Command registrations may not provide this information.

Returns:

the registering plugin