Plugin
Bases: Plugin
Bases: Command
property
writable
¶
executor: CommandExecutor
Gets the CommandExecutor to run when parsing this command
PluginDescription(
name: str,
version: str,
description: str | None = None,
load: PluginLoadOrder | None = None,
authors: list[str] | None = None,
contributors: list[str] | None = None,
website: str | None = None,
prefix: str | None = None,
provides: list[str] | None = None,
depend: list[str] | None = None,
soft_depend: list[str] | None = None,
load_before: list[str] | None = None,
default_permission: PermissionDefault | None = None,
commands: list[Command] | None = None,
permissions: list[Permission] | None = None,
*args,
**kwargs
)
Represents the basic information about a plugin that the plugin loader needs to know.
property
¶
api_version: str
Gives the API version which this plugin is designed to support.
property
¶
Gives the list of commands the plugin will register at runtime.
property
¶
default_permission: PermissionDefault
Gives the default value of permissions registered for the plugin.
property
¶
description: str
Gives a human-friendly description of the functionality the plugin provides.
property
¶
load: PluginLoadOrder
Gives the phase of server startup that the plugin should be loaded.
property
¶
Gets the list of plugins that should consider this plugin a soft-dependency.
property
¶
name: str
Gives the name of the plugin. This name is a unique identifier for plugins.
property
¶
permissions: list[Permission]
Gives the list of permissions the plugin will register at runtime, immediately proceeding enabling.
property
¶
Gives the list of other plugin APIs which this plugin provides. These are usable for other plugins to depend on.
property
¶
Gives a list of other plugins that the plugin requires for full functionality.
PluginLoadOrder(value: int)
Represents the order in which a plugin should be initialized and enabled.
PluginLoader(server: Server)
Represents a plugin loader, which handles direct access to specific types of plugins
Represents a plugin manager that handles all plugins from the Server
get_default_perm_subscriptions(
op: bool,
) -> set[Permissible]
Gets a set containing all subscribed Permissibles to the given default list, by op status.
get_default_permissions(op: bool) -> set[Permission]
Gets the default permissions for the given op status.
get_permission(name: str) -> Permission
Gets a Permission from its fully qualified name.
get_permission_subscriptions(
permission: str,
) -> set[Permissible]
Gets a set containing all subscribed Permissibles to the given permission.
get_plugin(name: str) -> Plugin
Checks if the given plugin is loaded and returns it when applicable.
Checks if the given plugin is enabled or not
is_plugin_enabled(plugin: Plugin) -> bool
Checks if the given plugin is enabled or not
Loads the plugin contained within the specified directory
recalculate_permission_defaults(perm: Permission) -> None
Recalculates the defaults for the given Permission.
register_event(
name: str,
executor: Callable[[Event], None],
priority: EventPriority,
plugin: Plugin,
ignore_cancelled: bool,
) -> None
Registers the given event
remove_permission(perm: Permission) -> None
Removes a Permission registration from this plugin manager by permission object.
remove_permission(name: str) -> None
Removes a Permission registration from this plugin manager by name.
subscribe_to_default_perms(
op: bool, permissible: Permissible
) -> None
Subscribes to the given Default permissions by operator status.
subscribe_to_permission(
permission: str, permissible: Permissible
) -> None
Subscribes the given Permissible for information about the requested Permission.
unsubscribe_from_default_perms(
op: bool, permissible: Permissible
) -> None
Unsubscribes from the given Default permissions by operator status.
unsubscribe_from_permission(
permission: str, permissible: Permissible
) -> None
Unsubscribes the given Permissible for information about the requested Permission.