Package com.velocitypowered.api.command
Interface CommandMeta.Builder
- Enclosing interface:
- CommandMeta
public static interface CommandMeta.Builder
Provides a fluent interface to create
CommandMeta
s.-
Method Summary
Modifier and TypeMethodDescriptionSpecifies additional aliases that can be used to execute the command.build()
Returns a newly-createdCommandMeta
based on the specified parameters.hint
(com.mojang.brigadier.tree.CommandNode<CommandSource> node) Specifies a command node providing additional argument metadata and tab-complete suggestions.Specifies the plugin who registers theCommand
.
-
Method Details
-
aliases
Specifies additional aliases that can be used to execute the command.- Parameters:
aliases
- the command aliases- Returns:
- this builder, for chaining
-
hint
Specifies a command node providing additional argument metadata and tab-complete suggestions.- Parameters:
node
- the command node- Returns:
- this builder, for chaining
- Throws:
IllegalArgumentException
- if the node is executable, i.e. has a non-nullCommand
, or has a redirect.
-
plugin
Specifies the plugin who registers theCommand
.- Parameters:
plugin
- the registering plugin- Returns:
- this builder, for chaining
-
build
CommandMeta build()Returns a newly-createdCommandMeta
based on the specified parameters.- Returns:
- the built
CommandMeta
-