kameloso.plugins.common.misc

The is not a plugin by itself but contains code common to all plugins, without which they will *not* function.

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

applyCustomSettings auto applyCustomSettings(IRCPlugin[] plugins, string[] customSettings, CoreSettings copyOfSettings): Changes a setting of a plugin, given both the names of the plugin and the setting, in string form.
catchUser void catchUser(IRCPlugin plugin, IRCUser newUser): Catch an IRCUser, saving it to the IRCPlugin's IRCPluginState.users array.
enqueue void enqueue(Plugin plugin, IRCEvent event, Permissions permissionsRequired, bool inFiber, Fun fun, string caller): Construct and enqueue a function replay in the plugin's queue of such.
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.
pluginNameOfFilename auto pluginNameOfFilename(string filename): Returns the name of a plugin based on its filename.
rehashUsers void rehashUsers(IRCPlugin plugin, string channelName): Rehashes a plugin's users, both the ones in the IRCPluginState.users
associative array and the ones in each dialect.defs.IRCChannel.users associative arrays.
replay auto replay(Plugin plugin, IRCEvent event, Fun fun, Permissions permissionsRequired, bool inFiber, string caller): Convenience function that returns a kameloso.plugins.common.core.Replay of the right type, *with* a subclass plugin reference attached.

Structs

EventURLs struct EventURLs: Undocumented in source.

kameloso.plugins.common.misc

Members

Classes

Functions

Structs

See Also

Meta

Source

License

Copyright

Authors