Class: Rubycord::Emoji

Inherits:
Object
  • Object
show all
Includes:
IDObject
Defined in:
lib/rubycord/data/emoji.rb

Overview

Server emoji

Instance Attribute Summary collapse

Attributes included from IDObject

#id

Instance Method Summary collapse

Methods included from IDObject

#creation_time, synthesise

Instance Attribute Details

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

Returns if the emoji is animated.

Returns:

  • (true, false) —

    if the emoji is animated



16
17
18
 
# File 'lib/rubycord/data/emoji.rb', line 16

def animated
  @animated
end

#name ⇒ String (readonly)

Returns the emoji name.

Returns:



7
8
9
 
# File 'lib/rubycord/data/emoji.rb', line 7

def name
  @name
end

#roles ⇒ Array<Role>? (readonly)

Returns roles this emoji is active for, or nil if the emoji's server is unknown.

Returns:

  • (Array<Role>, nil) —

    roles this emoji is active for, or nil if the emoji's server is unknown



13
14
15
 
# File 'lib/rubycord/data/emoji.rb', line 13

def roles
  @roles
end

#server ⇒ Server? (readonly)

Returns the server of this emoji.

Returns:

  • (Server, nil) —

    the server of this emoji



10
11
12
 
# File 'lib/rubycord/data/emoji.rb', line 10

def server
  @server
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?

ID or name based comparison



33
34
35
36
37
38
 
# File 'lib/rubycord/data/emoji.rb', line 33

def ==(other)
  return false unless other.is_a? Emoji
  return Rubycord.id_compare(@id, other) if @id

  name == other.name
end

#icon_url ⇒ String

Returns the icon URL of the emoji.

Returns:

  • (String) —

    the icon URL of the emoji



60
61
62
 
# File 'lib/rubycord/data/emoji.rb', line 60

def icon_url
  API.emoji_icon_url(id)
end

#inspect ⇒ Object

The inspect method is overwritten to give more useful output



65
66
67
 
# File 'lib/rubycord/data/emoji.rb', line 65

def inspect
  "<Emoji name=#{name} id=#{id} animated=#{animated}>"
end

#mention ⇒ String Also known as: use, to_s

Returns the layout to mention it (or have it used) in a message.

Returns:

  • (String) —

    the layout to mention it (or have it used) in a message



43
44
45
46
47
 
# File 'lib/rubycord/data/emoji.rb', line 43

def mention
  return name if id.nil?

  "<#{"a" if animated}:#{name}:#{id}>"
end

#to_reaction ⇒ String

Returns the layout to use this emoji in a reaction.

Returns:

  • (String) —

    the layout to use this emoji in a reaction



53
54
55
56
57
 
# File 'lib/rubycord/data/emoji.rb', line 53

def to_reaction
  return name if id.nil?

  "#{name}:#{id}"
end