kameloso.plugins.help

The Help plugin serves the help command, and nothing else at this point.

It is used to query the bot for available commands in a tidy list.

Members

Classes

HelpPlugin class HelpPlugin: The Help plugin serves the help command.

Functions

addPrefix auto addPrefix(HelpPlugin plugin, string word, PrefixPolicy policy): Adds a prefix to a command word; the command prefix if the passed policy is kameloso.plugins.common.PrefixPolicy.prefixed, the bot nickname if it is kameloso.plugins.common.PrefixPolicy.nickname, and as is if it is kameloso.plugins.common.PrefixPolicy.direct.
filterHiddenCommands auto filterHiddenCommands(IRCPlugin.CommandMetadata[string] aa): Filters out hidden commands from an associative array of IRCPlugin.CommandMetadata.
onCommandHelp void onCommandHelp(HelpPlugin plugin, IRCEvent event): Sends a list of all plugins' commands to the requesting user.
sendCommandHelpImpl void sendCommandHelpImpl(HelpPlugin plugin, string otherPluginName, IRCEvent event, string commandString, IRCPlugin.CommandMetadata command): Sends the help text for a command to the querying channel or user.
sendFullPluginListing void sendFullPluginListing(HelpPlugin plugin, IRCEvent event, IRCPlugin.CommandMetadata[string][string] allPluginCommands): Sends the help list of all plugins and all commands.
sendMessage void sendMessage(HelpPlugin plugin, IRCEvent event, string content, Message.Property properties, string caller): Sends a message to the channel or user that triggered the event. If HelpSettings.repliesInQuery is set, we send the message as a query; otherwise we send it to the channel.
sendOnlyCommandHelp void sendOnlyCommandHelp(HelpPlugin plugin, string commandString, IRCEvent event, IRCPlugin.CommandMetadata[string][string] allPluginCommands): Sends the help list of a single command of a specific plugin. Only the command was supplied, prefixed with the command prefix.
sendPluginCommandHelp void sendPluginCommandHelp(HelpPlugin plugin, string pluginName, string commandName, IRCEvent event, IRCPlugin.CommandMetadata[string][string] allPluginCommands): Sends the help list of a single command of a specific plugin. Both were supplied.
sendSpecificPluginListing void sendSpecificPluginListing(HelpPlugin plugin, string pluginName, IRCEvent event, IRCPlugin.CommandMetadata[string][string] allPluginCommands): Sends the command help listing for a specific plugin.
stripPrefix auto stripPrefix(HelpPlugin plugin, string prefixed): Strips any prefixes from the passed string; prefixes being the command prefix, the bot's nickname, or the shorthand with only the first letter of the bot's nickname.

Structs

HelpSettings struct HelpSettings: Settings for the Help plugin, to toggle it enabled or disabled.

kameloso.plugins.help

Members

Classes

Functions

Structs

See Also

Meta

License

Copyright

Authors