kameloso.plugins.common

This module contains common functions and types used by all plugins.

Modules

mixins module kameloso.plugins.common.mixins: Mixins for common functionality, such as the issuing of WHOIS calls.
scheduling module kameloso.plugins.common.scheduling: This modules deals with delaying execution of Fibers and delegates to a later point in time, and registering such to await a specific type of IRCEvent.

Members

Classes

IRCPluginInitialisationException class IRCPluginInitialisationException: Exception thrown when an IRC plugin failed to initialise itself or its resources.
IRCPluginSettingsException class IRCPluginSettingsException: Exception thrown when an IRC plugin failed to have its settings set.

Functions

catchUser void catchUser(IRCPlugin plugin, IRCUser newUser): Catch an IRCUser, saving it to the IRCPlugin's IRCPluginState.users array.
getUser auto getUser(IRCPlugin plugin, string specified): Retrieves an IRCUser from the passed plugin's users associative array. If none exists, returns a minimally viable IRCUser with the passed nickname as its only value.
idOf auto idOf(IRCUser user): Returns either the nickname or the account of a user, depending on whether the account is known.
idOf auto idOf(IRCPlugin plugin, string nickname): Returns either the nickname or the account of a user, depending on whether the account is known. Overload that looks up the passed nickname in the passed plugin's users associative array of IRCUsers.
nameOf auto nameOf(IRCUser user): Returns either the nickname or the display name of a user, depending on whether the display name is known or not.
nameOf auto nameOf(IRCPlugin plugin, string specified): Returns either the nickname or the display name of a user, depending on whether the display name is known or not. Overload that looks up the passed nickname in the passed plugin's users associative array of IRCUsers.
pluginFileBaseName auto pluginFileBaseName(string filename): Returns a meaningful basename of a plugin filename.
pluginFilenameSlicerImpl auto pluginFilenameSlicerImpl(string filename, bool getPluginName): Implementation function, code shared between pluginFileBaseName and pluginNameOfFilename.
pluginNameOfFilename auto pluginNameOfFilename(string filename): Returns the name of a plugin based on its filename.

kameloso.plugins.common

Modules

Members

Classes

Functions

See Also

Meta

License

Copyright

Authors