Package me.totalfreedom.command.annotation

Annotation Interface Info

@Retention(RUNTIME) public @interface Info
This interface holds the information for each command. This annotation defines the command's name, description, usage, and aliases. Commands must have this annotation present to be registered with the handler.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    Technically, this is the only required value you must supply yourself.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    aliases
    By default, this returns an empty array.
    String
    description
    By default, this is set to "This is the default command description."
    String
    usage
    By default, this is set to "/<command>"

  • Element Details

    • name

      String name
      Technically, this is the only required value you must supply yourself. However, it is HIGHLY recommended you supply the other optional values as well, for better customization of your command.
      Returns:
      The command's name.

    • description

      String description
      By default, this is set to "This is the default command description."
      Returns:
      The command's description.
      Default:
      "This is the default command description."

    • usage

      String usage
      By default, this is set to "/<command>"
      Returns:
      The command's usage.
      Default:
      "/<command>"

    • aliases

      String[] aliases
      By default, this returns an empty array.
      Returns:
      The command's aliases.
      Default:
      {}