base class for all rbot plugins certain methods will be called if they are
provided, if you define one of the following methods, it will be called as
appropriate:
listen(UserMessage): | Called for all messages of any type. To differentiate them, use
message.kind_of? It'll be either a PrivMessage, NoticeMessage, KickMessage, QuitMessage, PartMessage, JoinMessage, NickMessage, etc.
|
privmsg(PrivMessage): | called for a PRIVMSG if the first word matches one the plugin register()d
for. Use m.plugin to get that word and m.params for the rest of the
message, if applicable.
|
kick(KickMessage): | Called when a user (or the bot) is kicked from a channel the bot is in.
|
join(JoinMessage): | Called when a user (or the bot) joins a channel
|
part(PartMessage): | Called when a user (or the bot) parts a channel
|
quit(QuitMessage): | Called when a user (or the bot) quits IRC
|
nick(NickMessage): | Called when a user (or the bot) changes Nick
|
topic(TopicMessage): | Called when a user (or the bot) changes a channel topic
|
save: | Called when you are required to save your plugin's state, if you maintain
data between sessions
|
cleanup: | called before your plugin is "unloaded", prior to a plugin reload
or bot quit - close any open files/connections or flush caches here
|