Class CommandUsageBox

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 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 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(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 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