Class CommandUsageBox
java.lang.Object
com.sk89q.worldedit.util.formatting.component.TextComponentProducer
com.sk89q.worldedit.util.formatting.component.CommandUsageBox
A box to describe usage of a command.
-
Constructor Summary
ConstructorDescriptionCommandUsageBox
(List<org.enginehub.piston.Command> commands, String commandString, String helpRootCommand) Create a new usage box.CommandUsageBox
(List<org.enginehub.piston.Command> commands, String commandString, String helpRootCommand, org.enginehub.piston.CommandParameters parameters) Create a new usage box. -
Method Summary
Methods inherited from class com.sk89q.worldedit.util.formatting.component.TextComponentProducer
append, append, create, getBuilder, newline, reset
-
Constructor Details
-
CommandUsageBox
public CommandUsageBox(List<org.enginehub.piston.Command> commands, String commandString, String helpRootCommand) throws InvalidComponentException Create a new usage box.- Parameters:
commands
- the commands to describecommandString
- the commands that were used, such as "/we" or "/brush sphere"helpRootCommand
- the command used to get subcommand help- Throws:
InvalidComponentException
-
CommandUsageBox
public CommandUsageBox(List<org.enginehub.piston.Command> commands, String commandString, String helpRootCommand, @Nullable org.enginehub.piston.CommandParameters parameters) throws InvalidComponentException Create a new usage box.- Parameters:
commands
- the commands to describecommandString
- the commands that were used, such as "/we" or "/brush sphere"helpRootCommand
- the command used to get subcommand helpparameters
- list of parameters to use- Throws:
InvalidComponentException
-