Module: Discordrb::UserAttributes

Included in:
Light::LightProfile, User
Defined in:
lib/discordrb/data.rb

Overview

Mixin for the attributes users should have

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#avatar_id ⇒ String

Returns the ID of this user's current avatar, can be used to generate an avatar URL.

Returns:

  • (String) —

    the ID of this user's current avatar, can be used to generate an avatar URL.

See Also:



120
121
122
 
# File 'lib/discordrb/data.rb', line 120

def avatar_id
  @avatar_id
end

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

Returns whether this user is a Discord bot account.

Returns:

  • (true, false) —

    whether this user is a Discord bot account



115
116
117
 
# File 'lib/discordrb/data.rb', line 115

def 
  @bot_account
end

#discriminator ⇒ String (readonly) Also known as: discrim, tag, discord_tag

Returns this user's discriminator which is used internally to identify users with identical usernames.

Returns:

  • (String) —

    this user's discriminator which is used internally to identify users with identical usernames.



109
110
111
 
# File 'lib/discordrb/data.rb', line 109

def discriminator
  @discriminator
end

#username ⇒ String (readonly) Also known as: name

Returns this user's username.

Returns:

  • (String) —

    this user's username



105
106
107
 
# File 'lib/discordrb/data.rb', line 105

def username
  @username
end

Instance Method Details

#avatar_url ⇒ String

Utility function to get a user's avatar URL.

Returns:

  • (String) —

    the URL to the avatar image.



136
137
138
 
# File 'lib/discordrb/data.rb', line 136

def avatar_url
  API::User.avatar_url(@id, @avatar_id)
end

#distinct ⇒ String

Utility function to get Discord's distinct representation of a user, i. e. username + discriminator

Returns:

  • (String) —

    distinct representation of user



130
131
132
 
# File 'lib/discordrb/data.rb', line 130

def distinct
  "#{@username}##{@discriminator}"
end

#mention ⇒ String

Utility function to mention users in messages

Returns:

  • (String) —

    the mention code in the form of <@id>



124
125
126
 
# File 'lib/discordrb/data.rb', line 124

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