com.velocitypowered.api.command

Class BrigadierCommand

java.lang.Object

com.velocitypowered.api.command.BrigadierCommand

All Implemented Interfaces:

Command

public final class BrigadierCommand
extends Object
implements Command

A command that uses Brigadier for parsing the command and providing suggestions to the client.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FORWARD Return code used by a Command to indicate the command execution should be forwarded to the backend server.

Constructor Summary

Constructors

Constructor and Description
BrigadierCommand(com.mojang.brigadier.builder.LiteralArgumentBuilder<CommandSource> builder) Constructs a BrigadierCommand from the node returned by the given builder.
BrigadierCommand(com.mojang.brigadier.tree.LiteralCommandNode<CommandSource> node) Constructs a BrigadierCommand from the given command node.

Method Summary

Modifier and Type	Method and Description
com.mojang.brigadier.tree.LiteralCommandNode<CommandSource>	getNode() Returns the literal node for this command.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.velocitypowered.api.command.Command

execute, hasPermission, suggest, suggestAsync

Field Detail

FORWARD

public static final int FORWARD

Return code used by a Command to indicate the command execution should be forwarded to the backend server.

See Also:

Constant Field Values

Constructor Detail

BrigadierCommand

public BrigadierCommand(com.mojang.brigadier.builder.LiteralArgumentBuilder<CommandSource> builder)

Constructs a BrigadierCommand from the node returned by the given builder.

Parameters:

builder - the LiteralCommandNode builder

BrigadierCommand

public BrigadierCommand(com.mojang.brigadier.tree.LiteralCommandNode<CommandSource> node)

Constructs a BrigadierCommand from the given command node.

Parameters:

node - the command node

Method Detail

getNode

public com.mojang.brigadier.tree.LiteralCommandNode<CommandSource> getNode()

Returns the literal node for this command.

Returns:

the command node