Class: Irc::BasicUserMessage

Class Irc::BasicUserMessage |
In: | rbot/message.rb
Parent: | Object

base user message class, all user messages derive from this (a user message is defined as having a source hostmask, a target nick/channel and a message part)

Methods

address? new stripcolour

Attributes

:message | [RW] | contents of the message
:source | [R] | hostmask of message source
:sourceaddress | [R] | url part of message source
:sourcenick | [R] | nick of message source
:target | [R] | nick/channel message was sent to
:time | [R] | when the message was received

Public Class methods

new(bot, source, target, message)

instantiate a new Message

bot: | associated bot class
source: | hostmask of the message source
target: | nick/channel message is destined for
message: | message part

stripcolour(string)

strip mIRC colour escapes from a string

Public Instance methods

address?()

returns true if the message was addressed to the bot. This includes any private message to the bot, or any public message which looks like it's addressed to the bot, e.g. "bot: foo", "bot, foo", a kick message when bot was kicked etc.