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

#burst ⇒ true, false (readonly) Also known as: burst?

Returns whether the reaction is a burst reaction.

Returns:

  • (true, false) —

    whether the reaction is a burst reaction.



18
19
20
 
# File 'lib/discordrb/events/reactions.rb', line 18

def burst
  @burst
end

#burst_colours ⇒ Array<ColourRGB> (readonly) Also known as: burst_colors

Returns an array of colors used for animations in burst reactions.

Returns:

  • (Array<ColourRGB>) —

    an array of colors used for animations in burst reactions.



25
26
27
 
# File 'lib/discordrb/events/reactions.rb', line 25

def burst_colours
  @burst_colours
end

#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

#type ⇒ Integer (readonly)

Returns the type of the reaction. 0 for normal, 1 for burst.

Returns:

  • (Integer) —

    the type of the reaction. 0 for normal, 1 for burst.



22
23
24
 
# File 'lib/discordrb/events/reactions.rb', line 22

def type
  @type
end

Instance Method Details

#channel ⇒ Channel

Returns the channel that was reacted in.

Returns:

  • (Channel) —

    the channel that was reacted in.



57
58
59
 
# File 'lib/discordrb/events/reactions.rb', line 57

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.



52
53
54
 
# File 'lib/discordrb/events/reactions.rb', line 52

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.



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

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.



42
43
44
45
46
47
48
49
 
# File 'lib/discordrb/events/reactions.rb', line 42

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