Class: Flexo::Event

Inherits:

Object

• Object
• Flexo::Event

Defined in:

lib/flexo/event.rb

Overview

Base class for all events generated by Flexo. Nothing of interest happening here, actually. Most of the fun stuff is taken care of by the subclasses

Direct Known Subclasses

Flexo::Events::JoinEvent, Flexo::Events::KickEvent, Flexo::Events::ModeEvent, Flexo::Events::NickEvent, Flexo::Events::PartEvent, Flexo::Events::PingEvent, Flexo::Events::PongEvent, Flexo::Events::PrivmsgEvent, Flexo::Events::QuitEvent, Flexo::Events::ReplyEvent, Flexo::Events::TopicEvent, Flexo::Events::UnknownEvent

Instance Attribute Summary

• #data ⇒ Object readonly

  Returns the value of attribute data.

• #nickname ⇒ Object (also: #nick, #from, #by, #who) readonly

  Returns the value of attribute nickname.

Instance Method Summary

• #initialize(manager, data) ⇒ Event constructor

  Create the event, setting some variables.

• #me? ⇒ Boolean (also: #is_me?, #from_me?, #by_me?)

  Checks the nickname in the hostmask to see if you’re the one that made this event trigger, or if it was someone else.

Constructor Details

#initialize(manager, data) ⇒ Event

Create the event, setting some variables

# File 'lib/flexo/event.rb', line 15

def initialize(manager, data)
  @manager = manager
  @data    = data
  @manager.logger.debug2("Creating instance of #{self.class}")
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.

# File 'lib/flexo/event.rb', line 6

def data
  @data
end

#nickname ⇒ Object (readonly) Also known as: nick, from, by, who

Returns the value of attribute nickname.

# File 'lib/flexo/event.rb', line 7

def nickname
  @nickname
end

Instance Method Details

#me? ⇒ Boolean Also known as: is_me?, from_me?, by_me?

Checks the nickname in the hostmask to see if you’re the one that made this event trigger, or if it was someone else.

Returns:

• (Boolean)

# File 'lib/flexo/event.rb', line 24

def me?
end