Class Irc::BasicUserMessage
In: rbot/message.rb
Parent: Object
Class: JoinMessage Class: PartMessage Class: Plugins Class: KickMessage Class: IrcAuth Class: IRCChannel Class: IrcSocket Class: BotConfig Class: Keywords Class: BotRegistryAccessor Class: IrcClient Class: DBHash Class: Language Class: TopicMessage Class: QuitMessage Class: PrivMessage Class: UserMessage Class: NoticeMessage Class: IrcBot Class: BasicUserMessage Class: NickMessage Class: Plugin Class: BotRegistry Class: Keyword Class: DBTree Module: Irc

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)

address?    new    stripcolour   
: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

strip mIRC colour escapes from a string

Public Instance methods

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.