Annotation Interface Command
Describes a command line command
- Author:
- cdivilly
-
Required Element Summary
Required ElementsModifier and TypeRequired ElementDescriptionThe command descriptionThe command name -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionArgument[]Command ArgumentsbooleanIndicates if the command is documentedOption[]Command OptionsbooleanIndicates that the command wishes to consume the command line arguments itself, without usingoptions()orarguments()
-
Element Details
-
name
String nameThe command name- Returns:
- command name
-
description
TranslatableText descriptionThe command description- Returns:
- command description
-
-
-
documented
boolean documentedIndicates if the command is documented- Returns:
- true if the command is documented, false otherwise
- Default:
- true
-
options
Option[] optionsCommand Options- Returns:
- The command
Options
- Default:
- {}
-
arguments
Argument[] argumentsCommand Arguments- Returns:
- The command
Arguments
- Default:
- {}
-
processArgs
boolean processArgsIndicates that the command wishes to consume the command line arguments itself, without usingoptions()orarguments()- Returns:
- true if this Command wants to process the command line arguments itself
- Since:
- 20.2
- Default:
- false
-