Class Irc::Plugins::Plugin
In: lib/rbot/plugins.rb
Parent: Object

Methods

cleanup   flush_registry   handle   help   map   map!   name   new   privmsg   privmsg   register   usage  

Attributes

bot  [R] 

Public Class methods

initialise your plugin. Always call super if you override this method, as important variables are set up for you

Public Instance methods

return a help string for your module. for complex modules, you may wish to break your help into topics, and return a list of available topics if topic is nil. plugin is passed containing the matching prefix for this message - if your plugin handles multiple prefixes, make sure you return the correct help for the prefix requested

return an identifier for this plugin, defaults to a list of the message prefixes handled (used for error messages etc)

register the plugin as a handler for messages prefixed name this can be called multiple times for a plugin to handle multiple message prefixes

default usage method provided as a utility for simple plugins. The MessageMapper uses ‘usage’ as its default fallback method.

[Validate]