Package com.velocitypowered.api.plugin

Annotation Type Dependency

@Retention(RUNTIME)
@Target({})
public @interface Dependency

Indicates that the Plugin depends on another plugin in order to enable.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	id	The plugin ID of the dependency.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	optional	Whether or not the dependency is not required to enable this plugin.
String	version	The required version of the dependency.

Element Detail

id

String id

The plugin ID of the dependency.

Returns:

The dependency plugin ID

See Also:

Plugin.id()

version

String version

The required version of the dependency. This should be in an NPM-compatible versioning format, which you can figure from npm's SemVer checker. If not specified, this assumes any version is acceptable.

Returns:

the version requirement

Default:

"*"

optional

boolean optional

Whether or not the dependency is not required to enable this plugin. By default this is false, meaning that the dependency is required to enable this plugin.

Returns:

true if the dependency is not required for the plugin to work

Default:

false