Files
discord.js/src/structures/Emoji.js
Schuyler Cebulskie b7f582b7f0 Clean up a bunch of stuff
- Channel typing data is now a Map
- Client properties on structures are now non-enumerable and
non-configurable
2016-09-07 00:24:45 -04:00

98 lines
2.0 KiB
JavaScript

const Constants = require('../util/Constants');
const Collection = require('../util/Collection');
/**
* Represents a Custom Emoji
*/
class Emoji {
constructor(guild, data) {
/**
* The Client that instantiated this object
* @type {Client}
*/
this.client = guild.client;
Object.defineProperty(this, 'client', { enumerable: false, configurable: false });
/**
* The Guild this emoji is part of
* @type {Guild}
*/
this.guild = guild;
this.setup(data);
}
setup(data) {
/**
* The ID of the Emoji
* @type {string}
*/
this.id = data.id;
/**
* The name of the Emoji
* @type {string}
*/
this.name = data.name;
/**
* Whether or not this emoji requires colons surrounding it
* @type {boolean}
*/
this.requiresColons = data.require_colons;
/**
* Whether this emoji is managed by an external service
* @type {boolean}
*/
this.managed = data.managed;
this._roles = data.roles;
}
/**
* The time the emoji was created
* @readonly
* @type {Date}
*/
get creationDate() {
return new Date((this.id / 4194304) + 1420070400000);
}
/**
* A collection of roles this emoji is active for (empty if all), mapped by role ID.
* @type {Collection<string, Role>}
* @readonly
*/
get roles() {
const roles = new Collection();
for (const role of this._roles) {
if (this.guild.roles.has(role)) roles.set(role, this.guild.roles.get(role));
}
return roles;
}
/**
* The URL to the emoji file
* @type {string}
* @readonly
*/
get url() {
return `${Constants.Endpoints.CDN}/emojis/${this.id}.png`;
}
/**
* When concatenated with a string, this automatically returns the emoji mention rather than the object.
* @returns {string}
* @example
* // send an emoji:
* const emoji = guild.emojis.array()[0];
* msg.reply(`Hello! ${emoji}`);
*/
toString() {
return this.requiresColons ? `<:${this.name}:${this.id}>` : this.name;
}
}
module.exports = Emoji;