Annotation Interface Option
Describes an optional argument to a command.
- Author:
- cdivilly
-
Required Element Summary
Required ElementsModifier and TypeRequired ElementDescriptionDescription of the optional argument's purposeThe name of the option -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionbooleanIndicates if the option takes a valueClass<?>The type of the option value
-
Element Details
-
name
String nameThe name of the option- Returns:
- option name
-
description
TranslatableText descriptionDescription of the optional argument's purpose- Returns:
- option description
-
-
-
type
Class<?> typeThe type of the option value- Returns:
- option type
- Default:
- java.lang.String.class
-
hasArgument
boolean hasArgumentIndicates if the option takes a value- Returns:
- true if the option takes a value, false otherwise
- Default:
- true
-