org.cloudburstmc.api.plugin

Interface PluginDescription

public interface PluginDescription

Method Summary

Modifier and Type	Method and Description
List<String>	getAuthors() The author of this plugin.
List<PluginDependency>	getDependencies() The array of plugin IDs that this plugin requires in order to function fully.
Optional<String>	getDescription()
String	getId() The ID for this plugin.
String	getName()
Optional<Path>	getPath() The path where the plugin is located on the file system.
PluginLoader	getPluginLoader()
Optional<String>	getUrl() Plugin's website specified in the plugin.yml.
String	getVersion() The version of this plugin.

Method Detail

getId

@Nonnull
String getId()

The ID for this plugin. This should be an alphanumeric name. Slashes are also allowed.

Returns:

the ID for this plugin

getName

@Nonnull
String getName()

getDescription

@Nonnull
Optional<String> getDescription()

getPath

@Nonnull
Optional<Path> getPath()

The path where the plugin is located on the file system.

Returns:

the path of this plugin

getAuthors

@Nonnull
List<String> getAuthors()

The author of this plugin.

Returns:

the plugin's author

getVersion

@Nonnull
String getVersion()

The version of this plugin.

Returns:

the version of this plugin

getDependencies

@Nonnull
List<PluginDependency> getDependencies()

The array of plugin IDs that this plugin requires in order to function fully.

Returns:

the dependencies

getUrl

@Nonnull
Optional<String> getUrl()

Plugin's website specified in the plugin.yml.

Returns:

website url

getPluginLoader

@Nonnull
PluginLoader getPluginLoader()