endstone/plugin

methPlugin

Plugin() =default

methPlugin

Plugin(const Plugin&) =delete

methoperator=

Plugin& operator=(const Plugin&) =delete

meth~Plugin

~Plugin() override=default

methgetDescriptionabstractconst

const PluginDescription& getDescription() const =0

Returns the details of this plugin.

methonLoadvirtual

void onLoad()

Called after a plugin is loaded but before it has been enabled.

When multiple plugins are loaded, the onLoad() for all plugins is called before any onEnable() is called.

methonEnablevirtual

void onEnable()

Called when this plugin is enabled.

methonDisablevirtual

void onDisable()

Called when this plugin is disabled.

methgetLoggerconst

Logger& getLogger() const

Returns the plugin logger associated with this server's logger. The returned logger automatically tags all log messages with the plugin's name.

methisEnabledconst

bool isEnabled() const

Returns a value indicating whether this plugin is currently enabled.

methgetPluginLoaderconst

PluginLoader& getPluginLoader() const

Gets the associated PluginLoader responsible for this plugin.

methgetServerconst

Server& getServer() const

Returns the Server instance currently running this plugin.

methgetNameconst

std::string getName() const

Returns the name of the plugin.

This should return the bare name of the plugin and should be used for comparison.

methgetCommandconst

PluginCommand* getCommand(std::string name) const

Gets the command with the given name, specific to this plugin.

methgetDataFolderconst

const std::filesystem::path& getDataFolder() const

Returns the folder that the plugin data's files are located in. The folder may not yet exist.

methregisterEvent

void registerEvent(void(T::*)(EventType&) func, T& instance, EventPriority priority = EventPriority::Normal, bool ignore_cancelled = false)

methregisterEvent

void registerEvent(std::function<void(EventType&)> func, EventPriority priority = EventPriority::Normal, bool ignore_cancelled = false)

methsetEnabledprotected

void setEnabled(bool enabled)

Sets the enabled state of this plugin

methPluginDescription

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 = {})

methgetNameconst

std::string getName() const

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

methgetVersionconst

std::string getVersion() const

Gives the version of the plugin.

methgetFullNameconst

std::string getFullName() const

Returns the name of a plugin, including the version.

methgetAPIVersionconst

std::string getAPIVersion() const

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

methgetDescriptionconst

std::string getDescription() const

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

methgetLoadconst

PluginLoadOrder getLoad() const

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

methgetAuthorsconst

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

Gives the list of authors for the plugin.

methgetContributorsconst

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

Gives the list of contributors for the plugin.

methgetWebsiteconst

std::string getWebsite() const

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

methgetPrefixconst

std::string getPrefix() const

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

methgetProvidesconst

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.

methgetDependconst

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

Gives a list of other plugins that the plugin requires.

methgetSoftDependconst

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

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

methgetLoadBeforeconst

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

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

methgetDefaultPermissionconst

PermissionDefault getDefaultPermission() const

Gives the default value of permissions registered for the plugin.

methgetCommandsconst

std::vector<Command> getCommands() const

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

methgetPermissionsconst

std::vector<Permission> getPermissions() const

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

varserver_protected

Server& server_

methPluginLoaderexplicit

PluginLoader(Server& server)

methPluginLoader

PluginLoader(const PluginLoader&) =delete

methoperator=

PluginLoader& operator=(const PluginLoader&) =delete

meth~PluginLoadervirtual

~PluginLoader() =default

methloadPluginabstract

Plugin* loadPlugin(std::string file) =0

Loads the plugin contained in the specified file

methloadPluginsvirtual

std::vector<Plugin*> loadPlugins(std::string directory)

Loads the plugin contained within the specified directory.

methgetPluginFileFiltersabstractconst

std::vector<std::string> getPluginFileFilters() const =0

Returns a list of all filename filters expected by this PluginLoader.

methenablePluginvirtualconst

void enablePlugin(Plugin& plugin) const

Enables the specified plugin Attempting to enable a plugin that is already enabled will have no effect.

methdisablePluginvirtualconst

void disablePlugin(Plugin& plugin) const

Disables the specified plugin Attempting to disable a plugin that is not enabled will have no effect.

methgetServerconst

Server& getServer() const

Retrieves the Server object associated with the PluginLoader.

This function returns a reference to the Server object that the PluginLoader is associated with.

methPluginManager

PluginManager() =default

methPluginManager

PluginManager(PluginManager const&) =delete

methoperator=

PluginManager& operator=(PluginManager const&) =delete

meth~PluginManagervirtual

~PluginManager() =default

methregisterLoaderabstract

void registerLoader(std::unique_ptr<PluginLoader> loader) =0

Registers the specified plugin loader

methgetPluginabstractconst

Plugin* getPlugin(const std::string& name) const =0

Checks if the given plugin is loaded and returns it when applicable. Please note that the name of the plugin is case-sensitive

methgetPluginsabstractconst

std::vector<Plugin*> getPlugins() const =0

Gets a list of all currently loaded plugins

methisPluginEnabledabstractconst

bool isPluginEnabled(const std::string& name) const =0

Checks if the given plugin is enabled or not Please note that the name of the plugin is case-sensitive.

methisPluginEnabledabstractconst

bool isPluginEnabled(Plugin* plugin) const =0

Checks if the given plugin is enabled or not

methloadPluginabstract

Plugin* loadPlugin(std::string file) =0

Loads the plugin in the specified file

File must be valid according to the current enabled Plugin interfaces

methloadPluginsabstract

std::vector<Plugin*> loadPlugins(std::string directory) =0

Loads the plugin contained within the specified directory

methloadPluginsabstract

std::vector<Plugin*> loadPlugins(std::vector<std::string> files) =0

Loads the plugins in the list of the files

methenablePluginabstractconst

void enablePlugin(Plugin& plugin) const =0

Enables the specified plugin Attempting to enable a plugin that is already enabled will have no effect

methenablePluginsabstractconst

void enablePlugins() const =0

Enable all the loaded plugins

methdisablePluginabstract

void disablePlugin(Plugin& plugin) =0

Disables the specified plugin Attempting to disable a plugin that is not enabled will have no effect

methdisablePluginsabstract

void disablePlugins() =0

Disables all the loaded plugins

methclearPluginsabstract

void clearPlugins() =0

Disables and removes all plugins

methcallEventabstract

void callEvent(Event& event) =0

Calls an event which will be passed to plugins.

methregisterEventabstract

void registerEvent(std::string event, std::function<void(Event&)> executor, EventPriority priority, Plugin& plugin, bool ignore_cancelled) =0

Registers the given event

methgetPermissionabstractconst

Permission* getPermission(std::string name) const =0

Gets a Permission from its fully qualified name

methaddPermissionabstract

Permission& addPermission(std::unique_ptr<Permission> perm) =0

Adds a Permission to this plugin manager.

methremovePermissionabstract

void removePermission(Permission& perm) =0

Removes a Permission registration from this plugin manager.

If the specified permission does not exist in this plugin manager, nothing will happen. Removing a permission registration will not remove the permission from any Permissibles that have it.

methremovePermissionabstract

void removePermission(std::string name) =0

Removes a Permission registration from this plugin manager.

If the specified permission does not exist in this plugin manager, nothing will happen. Removing a permission registration will not remove the permission from any Permissibles that have it.

methgetDefaultPermissionsabstractconst

std::vector<Permission*> getDefaultPermissions(PermissionLevel level) const =0

Gets the default permissions for the given permission level

methrecalculatePermissionDefaultsabstract

void recalculatePermissionDefaults(Permission& perm) =0

Recalculates the defaults for the given Permission.

This will have no effect if the specified permission is not registered here.

methsubscribeToPermissionabstract

void subscribeToPermission(std::string permission, Permissible& permissible) =0

Subscribes the given Permissible for information about the requested Permission, by name. If the specified Permission changes in any form, the Permissible will be asked to recalculate.

methunsubscribeFromPermissionabstract

void unsubscribeFromPermission(std::string permission, Permissible& permissible) =0

Unsubscribes the given Permissible for information about the requested Permission, by name.

methgetPermissionSubscriptionsabstractconst

std::unordered_set<Permissible*> getPermissionSubscriptions(std::string permission) const =0

Gets a set containing all subscribed Permissibles to the given permission, by name

methsubscribeToDefaultPermsabstract

void subscribeToDefaultPerms(PermissionLevel level, Permissible& permissible) =0

Subscribes to the given Default permissions by permission level

If the specified defaults change in any form, the Permissible will be asked to recalculate.

methunsubscribeFromDefaultPermsabstract

void unsubscribeFromDefaultPerms(PermissionLevel level, Permissible& permissible) =0

Unsubscribes from the given Default permissions by permission level

methgetDefaultPermSubscriptionsabstractconst

std::unordered_set<Permissible*> getDefaultPermSubscriptions(PermissionLevel level) const =0

Gets a set containing all subscribed Permissibles to the given default list, by permission level

methgetPermissionsabstractconst

std::unordered_set<Permission*> getPermissions() const =0

Gets a set of all registered permissions.

This set is a copy and will not be modified live.

meth~Servicevirtual

~Service() =default

meth~ServiceManagervirtual

~ServiceManager() =default

methregisterServiceabstract

void registerService(std::string name, std::shared_ptr<Service> provider, const Plugin& plugin, ServicePriority priority) =0

Register a provider of a service.

methunregisterAllabstract

void unregisterAll(const Plugin& plugin) =0

Unregister all the services registered by a particular plugin.

methunregisterabstract

void unregister(std::string name, const Service& provider) =0

Unregister a particular provider for a particular service.

methunregisterabstract

void unregister(const Service& provider) =0

Unregister a particular provider.

methgetabstractconst

std::shared_ptr<Service> get(std::string name) const =0

Queries for a provider. This may return null if no provider has been registered for a service. The highest priority provider is returned.

methloadconst

std::shared_ptr<T> load(std::string name) const