Class: Discordrb::Emoji

Inherits:

Object

• Object
• Discordrb::Emoji

Includes:

IDObject

Defined in:

lib/discordrb/data.rb

Overview

Server emoji

Instance Attribute Summary

• #name ⇒ String readonly

  The emoji name.

• #roles ⇒ Array<Role> readonly

  Roles this emoji is active for.

• #server ⇒ Server readonly

  The server of this emoji.

Attributes included from IDObject

#id

Instance Method Summary

• #icon_url ⇒ String

  The icon URL of the emoji.

• #initialize(data, bot, server) ⇒ Emoji constructor

  A new instance of Emoji.

• #inspect ⇒ Object

  The inspect method is overwritten to give more useful output.

• #mention ⇒ String (also: #use, #to_s)

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

• #to_reaction ⇒ String

  The layout to use this emoji in a reaction.

Methods included from IDObject

#==, #creation_time, synthesise

Constructor Details

#initialize(data, bot, server) ⇒ Emoji

# File 'lib/discordrb/data.rb', line 2002

def initialize(data, bot, server)
  @bot = bot
  @roles = nil

  @name = data['name']
  @server = server
  @id = data['id'].nil? ? nil : data['id'].to_i

  process_roles(data['roles']) if server
end

Instance Attribute Details

#name ⇒ String (readonly)

# File 'lib/discordrb/data.rb', line 1994

def name
  @name
end

#roles ⇒ Array<Role> (readonly)

# File 'lib/discordrb/data.rb', line 2000

def roles
  @roles
end

#server ⇒ Server (readonly)

# File 'lib/discordrb/data.rb', line 1997

def server
  @server
end

Instance Method Details

#icon_url ⇒ String

# File 'lib/discordrb/data.rb', line 2027

def icon_url
  API.emoji_icon_url(@id)
end

#inspect ⇒ Object

The inspect method is overwritten to give more useful output

# File 'lib/discordrb/data.rb', line 2032

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

#mention ⇒ String Also known as: use, to_s

# File 'lib/discordrb/data.rb', line 2014

def mention
  "<:#{@name}:#{@id}>"
end

#to_reaction ⇒ String

# File 'lib/discordrb/data.rb', line 2022

def to_reaction
  "#{@name}:#{@id}"
end