Package com.velocitypowered.api.plugin
Annotation Type Plugin
-
@Retention(RUNTIME) @Target(TYPE) public @interface Plugin
Annotation used to describe a Velocity plugin.
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String[]
authors
The author of the plugin.Dependency[]
dependencies
The dependencies required to load before this plugin.String
description
The description of the plugin, explaining what it can be used for.String
name
The human readable name of the plugin as to be used in descriptions and similar things.String
url
The URL or website of the plugin.String
version
The version of the plugin.
-
-
-
Element Detail
-
id
String id
The ID of the plugin. This ID should be unique as to not conflict with other plugins. The plugin ID may contain alphanumeric characters, dashes, and underscores, and be a maximum of 64 characters long.- Returns:
- the ID for this plugin
-
-
-
name
String name
The human readable name of the plugin as to be used in descriptions and similar things.- Returns:
- The plugin name, or an empty string if unknown
- Default:
- ""
-
-
-
version
String version
The version of the plugin.- Returns:
- the version of the plugin, or an empty string if unknown
- Default:
- ""
-
-
-
description
String description
The description of the plugin, explaining what it can be used for.- Returns:
- The plugin description, or an empty string if unknown
- Default:
- ""
-
-
-
url
String url
The URL or website of the plugin.- Returns:
- The plugin url, or an empty string if unknown
- Default:
- ""
-
-
-
authors
String[] authors
The author of the plugin.- Returns:
- the plugin's author, or empty if unknown
- Default:
- {""}
-
-
-
dependencies
Dependency[] dependencies
The dependencies required to load before this plugin.- Returns:
- the plugin dependencies
- Default:
- {}
-
-