org.spongepowered.api.plugin

Annotation Type Plugin

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Plugin

An annotation used to describe and mark a Sponge plugin.

Field Summary

Fields

Modifier and Type	Fields and Description
static Pattern	ID_PATTERN The pattern plugin IDs must match.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	id An ID for the plugin to be used internally.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	authors The authors 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.

Field Detail

ID_PATTERN

public static final Pattern ID_PATTERN

The pattern plugin IDs must match. Plugin IDs must be lower case, and start with an alphabetic character. It may only contain alphanumeric characters, dashes or underscores. It cannot be longer than 64 characters.

Element Detail

id

public abstract String id

An ID for the plugin to be used internally. The ID should be unique as to not conflict with other plugins.

The plugin ID must match the ID_PATTERN.

Returns:

The plugin identifier

See Also:

Java package naming conventions

name

public abstract 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

public abstract String version

The version of the plugin.

Returns:

The plugin version, or an empty string if unknown

Default:

""

dependencies

public abstract Dependency[] dependencies

The dependencies required to load before this plugin.

Returns:

The plugin dependencies

Default:

{}

description

public abstract 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

public abstract String url

The URL or website of the plugin.

Returns:

The plugin url, or an empty string if unknown

Default:

""

authors

public abstract String[] authors

The authors of the plugin.

Returns:

The plugin authors, or empty if unknown

Default:

{}