CommandUsageBox (worldedit-core 7.2.0 API)

java.lang.Object
- com.sk89q.worldedit.util.formatting.component.TextComponentProducer
- - com.sk89q.worldedit.util.formatting.component.CommandUsageBox

public class CommandUsageBox
extends TextComponentProducer

A box to describe usage of a command.

Constructor Summary

Constructors
Constructor and Description
`CommandUsageBox(java.util.List<org.enginehub.piston.Command> commands, java.lang.String commandString, java.lang.String helpRootCommand)` Create a new usage box.
`CommandUsageBox(java.util.List<org.enginehub.piston.Command> commands, java.lang.String commandString, java.lang.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
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandUsageBox
```
public CommandUsageBox(java.util.List<org.enginehub.piston.Command> commands,
                       java.lang.String commandString,
                       java.lang.String helpRootCommand)
                throws InvalidComponentException
```
Create a new usage box.

Parameters:

commands - the commands to describe

commandString - the commands that were used, such as "/we" or "/brush sphere"

helpRootCommand - the command used to get subcommand help

Throws:

InvalidComponentException

CommandUsageBox

public CommandUsageBox(java.util.List<org.enginehub.piston.Command> commands,
                       java.lang.String commandString,
                       java.lang.String helpRootCommand,
                       @Nullable
                       org.enginehub.piston.CommandParameters parameters)
                throws InvalidComponentException

Create a new usage box.

Parameters:: commands - the commands to describe; commandString - the commands that were used, such as "/we" or "/brush sphere"; helpRootCommand - the command used to get subcommand help; parameters - list of parameters to use
Throws:: InvalidComponentException

Class CommandUsageBox

Constructor Summary

Method Summary

Methods inherited from class com.sk89q.worldedit.util.formatting.component.TextComponentProducer

Methods inherited from class java.lang.Object

Constructor Detail

CommandUsageBox

CommandUsageBox