Package dev.plex.command.annotation

Annotation Interface CommandParameters

@Retention(RUNTIME) public @interface CommandParameters
Storage for a command's parameters

  • Required Element Summary Link icon

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The name

  • Optional Element Summary Link icon

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    aliases
    The aliases (optional)
    String
    description
    The description
    String
    usage
    The usage (optional)

  • Element Details

    • name Link icon

      String name
      The name
      Returns:
      Name of the command

    • description Link icon

      String description
      The description
      Returns:
      Description of the command
      Default:
      ""

    • usage Link icon

      String usage
      The usage (optional)
      Returns:
      The usage of the command
      Default:
      "/<command>"

    • aliases Link icon

      String aliases
      The aliases (optional)
      Returns:
      The aliases of the command
      Default:
      ""