endstone::PluginDescription

Represents the basic information about a plugin that the plugin loader needs to know.

Functions:

PluginDescription

PluginDescription(
    std::string name, std::string version, std::string description = "",
    PluginLoadOrder load = PluginLoadOrder::PostWorld,
    std::vector<std::string> authors = {},
    std::vector<std::string> contributors = {}, std::string website = "",
    std::string prefix = "", std::vector<std::string> provides = {},
    std::vector<std::string> depend = {},
    std::vector<std::string> soft_depend = {},
    std::vector<std::string> load_before = {},
    PermissionDefault default_permission = PermissionDefault::Operator,
    std::vector<Command> commands = {},
    std::vector<Permission> permissions = {})

getAPIVersion

std::string getAPIVersion() const

Gives the API version which this plugin is designed to support.

Returns:

the API version supported by the plugin

getAuthors

std::vector<std::string> getAuthors() const

Gives the list of authors for the plugin.

Returns:

an immutable list of the plugin’s authors

getCommands

std::vector<Command> getCommands() const

Gives the list of commands the plugin will register at runtime.

Returns:

the commands this plugin will register

getContributors

std::vector<std::string> getContributors() const

Gives the list of contributors for the plugin.

Returns:

an immutable list of the plugin’s contributions

getDefaultPermission

PermissionDefault getDefaultPermission() const

Gives the default value of permissions registered for the plugin.

Returns:

the default value for the plugin’s permissions

getDepend

std::vector<std::string> getDepend() const

Gives a list of other plugins that the plugin requires.

Returns:

immutable list of the plugin’s dependencies

getDescription

std::string getDescription() const

Gives a human-friendly description of the functionality the plugin provides.

Returns:

description of this plugin, or empty if not specified

getFullName

std::string getFullName() const

Returns the name of a plugin, including the version.

Returns:

a descriptive name of the plugin and respective version

getLoad

PluginLoadOrder getLoad() const

Gives the phase of server startup that the plugin should be loaded.

Returns:

the phase when the plugin should be loaded

getLoadBefore

std::vector<std::string> getLoadBefore() const

Gets the list of plugins that should consider this plugin a soft-dependency.

Returns:

immutable list of plugins that should consider this plugin a soft-dependency

getName

std::string getName() const

Gives the name of the plugin. This name is a unique identifier for plugins.

Returns:

the name of the plugin

getPermissions

std::vector<Permission> getPermissions() const

Gives the list of permissions the plugin will register at runtime, immediately proceeding enabling.

Returns:

the permissions this plugin will register

getPrefix

std::string getPrefix() const

Gives the token to prefix plugin-specific logging messages with.

Returns:

the prefixed logging token, or empty if not specified

getProvides

std::vector<std::string> getProvides() const

Gives the list of other plugin APIs which this plugin provides. These are usable for other plugins to depend on.

Returns:

immutable list of the plugin APIs which this plugin provides

getSoftDepend

std::vector<std::string> getSoftDepend() const

Gives a list of other plugins that the plugin requires for full functionality.

Returns:

immutable list of the plugin’s preferred dependencies

getVersion

std::string getVersion() const

Gives the version of the plugin.

Returns:

the version of the plugin

getWebsite

std::string getWebsite() const

Gives the plugin’s or plugin’s author’s website.

Returns:

the website of this plugin, or empty if not specified