Package net.citizensnpcs.api.command
Annotation Type Command
- 
Required Element SummaryRequired Elements
- 
Optional Element SummaryOptional ElementsModifier and TypeOptional ElementDescriptionDefines the flags available for this command.A longer description of the command and any flags it uses which will be displayed in addition todesc()in help commands.intThe maximum number of arguments that the command will accept.intMinimum number of arguments that are accepted by the command.String[]The argument modifiers accepted by the command.booleanWhether to parse placeholders from the input command.The permission of the command.booleanWhether a flag or value flag MUST be used for this command.Command usage string that is displayed when an error occurs with the command processing.String[]List of value flags (without --).
- 
Element Details- 
aliasesString[] aliasesA list of root-level command aliases that will be accepted for this command. For example:{"npc", "npc2"}would match both /npc and /npc2.
- 
descString descA short description of the command that will be displayed with the command usage and help. Translatable.
- 
flagsString flagsDefines the flags available for this command. A flag is a single character such as-fthat will alter the behaviour of the command. Each character in this string will be counted as a valid flag: extra flags will be discarded. Accepts * as a catch all.- Default:
- ""
 
- 
helpString helpA longer description of the command and any flags it uses which will be displayed in addition todesc()in help commands. Translatable.- Default:
- ""
 
- 
maxint maxThe maximum number of arguments that the command will accept. Default is-1, or an unlimited number of arguments.- Default:
- -1
 
- 
minint minMinimum number of arguments that are accepted by the command.- Default:
- 0
 
- 
modifiersString[] modifiersThe argument modifiers accepted by the command. Also accepts'*'as a catch all.- Default:
- {""}
 
- 
parsePlaceholdersboolean parsePlaceholdersWhether to parse placeholders from the input command.- Default:
- false
 
- 
permissionString permissionThe permission of the command. The comamnd sender will get an error if this is not met.- Default:
- ""
 
- 
requiresFlagsboolean requiresFlagsWhether a flag or value flag MUST be used for this command.- Default:
- false
 
- 
usageString usageCommand usage string that is displayed when an error occurs with the command processing.- Default:
- ""
 
- 
valueFlagsString[] valueFlagsList of value flags (without --).- Default:
- {}
 
 
-