Annotation Interface ScriptManifest

@Retention(RUNTIME) @Target(TYPE) public @interface ScriptManifest
Annotation for BotScript implementations to declare script metadata.

Example usage:

@ScriptManifest(name = "Woodcutter", version = "1.2", author = "Dev", description = "Chops trees")
public class WoodcutterScript implements BotScript { ... }
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The display name of the script.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    author
    The author of the script.
    ScriptCategory
    category
    The category this script belongs to.
    String
    description
    A brief description of what the script does.
    String
    version
    The version string of the script.

  • Element Details

    • name

      String name
      The display name of the script.
      Returns:
      the script name

    • version

      String version
      The version string of the script.
      Returns:
      the version, defaults to "1.0"
      Default:
      "1.0"

    • author

      String author
      The author of the script.
      Returns:
      the author name, defaults to empty
      Default:
      ""

    • description

      String description
      A brief description of what the script does.
      Returns:
      the description, defaults to empty
      Default:
      ""

    • category

      ScriptCategory category
      The category this script belongs to.
      Returns:
      the script category, defaults to ScriptCategory.UNCATEGORIZED
      Default:
      UNCATEGORIZED