Annotation Type CCMD

@Retention(RUNTIME) @Target(METHOD) public @interface CCMD
Annotation for console command entry points. Console commands can be attached to any public method that is on an EngineElement.
Author:
Matthew Tropiano

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    debug
    Checks if this is exposed in DEBUG mode only.
    String
    description
    Command description.
    String[]
    usage
    Usage blurb.
    String
    value
    The command name.

  • Element Details

    • value

      String value
      The command name. If not specified (or blank), this uses the method name. The command name is case-insensitive.
      Returns:
      the command name to use.
      Default:
      ""

    • usage

      String[] usage
      Usage blurb.
      Returns:
      the usage parameters.
      Default:
      {}

    • description

      String description
      Command description.
      Returns:
      the console command description.
      Default:
      "Console command."

    • debug

      boolean debug
      Checks if this is exposed in DEBUG mode only.
      Returns:
      true if so, false if not.
      Default:
      false