Class | Irc::UserMessage |
In: |
lib/rbot/message.rb
|
Parent: | BasicUserMessage |
class for handling IRC user messages. Includes some utilities for handling the message, for example in plugins. The message member will have any bot addressing "^bot: " removed (address? will return true in this case)
action | [R] | for PRIVMSGs, true if the message was a CTCP ACTION (CTCP stuff will be stripped from the message) |
channel | [R] | channel the message was in, nil for privately addressed messages |
ctcp | [R] | for PRIVMSGs, false unless the message was a CTCP command, in which case it evaluates to the CTCP command itself (TIME, PING, VERSION, etc). The CTCP command parameters are then stored in the message. |
params | [R] | for plugin messages, the rest of the message, with the plugin name removed |
plugin | [R] | for plugin messages, the name of the plugin invoked by the message |
replyto | [R] | convenience member. Who to reply to (i.e. would be sourcenick for a privately addressed message, or target (the channel) for a publicly addressed message |
instantiate a new UserMessage
bot: | associated bot class |
source: | hostmask of the message source |
target: | nick/channel message is destined for |
message: | message part |
send a CTCP response, i.e. a private NOTICE to the sender with the same CTCP command and the reply as a parameter
Same as reply, but when replying in public it adds the nick of the user the bot is replying to