Class: Discordrb::Events::EventHandler

Inherits:
Object
  • Object
show all
Defined in:
lib/discordrb/events/generic.rb

Overview

Generic event handler that can be extended

Instance Method Summary collapse

Constructor Details

#initialize(attributes, block) ⇒ EventHandler

Returns a new instance of EventHandler.



62
63
64
65
 
# File 'lib/discordrb/events/generic.rb', line 62

def initialize(attributes, block)
  @attributes = attributes
  @block = block
end

Instance Method Details

#after_call(event) ⇒ Object

to be overwritten by extending event handlers



86
 
# File 'lib/discordrb/events/generic.rb', line 86

def after_call(event); end

#call(event) ⇒ Object

Calls this handler

Parameters:

  • event (Object) —

    The event object to call this handler with



81
82
83
 
# File 'lib/discordrb/events/generic.rb', line 81

def call(event)
  @block.call(event)
end

#match(event) ⇒ Object

Checks whether this handler matches the given event, and then calls it.

Parameters:

  • event (Object) —

    The event object to match and call the handler with



75
76
77
 
# File 'lib/discordrb/events/generic.rb', line 75

def match(event)
  call(event) if matches? event
end

#matches?(_) ⇒ Boolean

Whether or not this event handler matches the given event with its attributes.

Returns:

  • (Boolean)

Raises:

  • (RuntimeError) —

    if this method is called - overwrite it in your event handler!



69
70
71
 
# File 'lib/discordrb/events/generic.rb', line 69

def matches?(_)
  raise 'Attempted to call matches?() from a generic EventHandler'
end

#matches_all(attributes, to_check, &block) ⇒ Object

See Also:

  • matches_all


89
90
91
 
# File 'lib/discordrb/events/generic.rb', line 89

def matches_all(attributes, to_check, &block)
  Discordrb::Events.matches_all(attributes, to_check, &block)
end