Class: Discordrb::Events::ReactionEvent

Inherits:
Event
  • Object
show all
Includes:
Respondable
Defined in:
lib/discordrb/events/reactions.rb

Overview

Generic superclass for events about adding and removing reactions

Direct Known Subclasses

ReactionAddEvent, ReactionRemoveEvent

Instance Attribute Summary collapse

Attributes inherited from Event

#bot

Instance Method Summary collapse

Methods included from Respondable

#<<, #drain, #drain_into, #send_embed, #send_message, #send_message!, #send_temporary_message

Instance Attribute Details

#emoji ⇒ Emoji (readonly)

Returns the emoji that was reacted with.

Returns:

  • (Emoji) —

    the emoji that was reacted with.



12
13
14
 
# File 'lib/discordrb/events/reactions.rb', line 12

def emoji
  @emoji
end

Instance Method Details

#channel ⇒ Channel

Returns the channel that was reacted in.

Returns:

  • (Channel) —

    the channel that was reacted in.



43
44
45
 
# File 'lib/discordrb/events/reactions.rb', line 43

def channel
  @channel ||= @bot.channel(@channel_id)
end

#message ⇒ Message

Returns the message that was reacted to.

Returns:

  • (Message) —

    the message that was reacted to.



38
39
40
 
# File 'lib/discordrb/events/reactions.rb', line 38

def message
  @message ||= channel.load_message(@message_id)
end

#server ⇒ Server?

Returns the server that was reacted in. If reacted in a PM channel, it will be nil.

Returns:

  • (Server, nil) —

    the server that was reacted in. If reacted in a PM channel, it will be nil.



48
49
50
 
# File 'lib/discordrb/events/reactions.rb', line 48

def server
  @server ||= channel.server
end

#user ⇒ User, Member

Returns the user that reacted to this message, or member if a server exists.

Returns:

  • (User, Member) —

    the user that reacted to this message, or member if a server exists.



28
29
30
31
32
33
34
35
 
# File 'lib/discordrb/events/reactions.rb', line 28

def user
  # Cache the user so we don't do requests all the time
  @user ||= if server
              @server.member(@user_id)
            else
              @bot.user(@user_id)
            end
end