Annotation Interface Option


Describes an optional argument to a command.
Author:
cdivilly
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Description of the optional argument's purpose
    The name of the option
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    Indicates if the option takes a value
    The type of the option value
  • Element Details

    • name

      String name
      The name of the option
      Returns:
      option name
    • description

      TranslatableText description
      Description of the optional argument's purpose
      Returns:
      option description
    • type

      Class<?> type
      The type of the option value
      Returns:
      option type
      Default:
      java.lang.String.class
    • hasArgument

      boolean hasArgument
      Indicates if the option takes a value
      Returns:
      true if the option takes a value, false otherwise
      Default:
      true