From 35ac80024a71ae4a71144f1b8f8735e5322177d8 Mon Sep 17 00:00:00 2001 From: Amish Shah Date: Wed, 26 Oct 2016 15:52:40 +0100 Subject: [PATCH] Rename some events (mainly guild events) --- src/client/actions/GuildMemberRemove.js | 5 ++--- src/client/actions/GuildRoleCreate.js | 7 +++---- src/client/actions/GuildRoleDelete.js | 5 ++--- src/client/actions/GuildRoleUpdate.js | 5 ++--- .../websocket/packets/handlers/GuildMembersChunk.js | 5 ++--- src/client/websocket/packets/handlers/PresenceUpdate.js | 3 +-- src/structures/Guild.js | 8 +++----- src/util/Constants.js | 6 +++--- 8 files changed, 18 insertions(+), 26 deletions(-) diff --git a/src/client/actions/GuildMemberRemove.js b/src/client/actions/GuildMemberRemove.js index 88221174f..d68b8b5f2 100644 --- a/src/client/actions/GuildMemberRemove.js +++ b/src/client/actions/GuildMemberRemove.js @@ -17,7 +17,7 @@ class GuildMemberRemoveAction extends Action { guild.memberCount--; guild._removeMember(member); this.deleted.set(guild.id + data.user.id, member); - if (client.status === Constants.Status.READY) client.emit(Constants.Events.GUILD_MEMBER_REMOVE, guild, member); + if (client.status === Constants.Status.READY) client.emit(Constants.Events.GUILD_MEMBER_REMOVE, member); this.scheduleForDeletion(guild.id, data.user.id); } else { member = this.deleted.get(guild.id + data.user.id) || null; @@ -43,8 +43,7 @@ class GuildMemberRemoveAction extends Action { /** * Emitted whenever a member leaves a guild, or is kicked. * @event Client#guildMemberRemove - * @param {Guild} guild The guild that the member has left. - * @param {GuildMember} member The member that has left the guild. + * @param {GuildMember} member The member that has left/been kicked from the guild. */ module.exports = GuildMemberRemoveAction; diff --git a/src/client/actions/GuildRoleCreate.js b/src/client/actions/GuildRoleCreate.js index 206fb043a..82ea19a3b 100644 --- a/src/client/actions/GuildRoleCreate.js +++ b/src/client/actions/GuildRoleCreate.js @@ -11,7 +11,7 @@ class GuildRoleCreate extends Action { const already = guild.roles.has(data.role.id); const role = new Role(guild, data.role); guild.roles.set(role.id, role); - if (!already) client.emit(Constants.Events.GUILD_ROLE_CREATE, guild, role); + if (!already) client.emit(Constants.Events.GUILD_ROLE_CREATE, role); return { role, }; @@ -24,9 +24,8 @@ class GuildRoleCreate extends Action { } /** - * Emitted whenever a guild role is created. - * @event Client#guildRoleCreate - * @param {Guild} guild The guild that the role was created in. + * Emitted whenever a role is created. + * @event Client#roleCreate * @param {Role} role The role that was created. */ diff --git a/src/client/actions/GuildRoleDelete.js b/src/client/actions/GuildRoleDelete.js index a55c7356a..eeaa1e902 100644 --- a/src/client/actions/GuildRoleDelete.js +++ b/src/client/actions/GuildRoleDelete.js @@ -17,7 +17,7 @@ class GuildRoleDeleteAction extends Action { guild.roles.delete(data.role_id); this.deleted.set(guild.id + data.role_id, role); this.scheduleForDeletion(guild.id, data.role_id); - client.emit(Constants.Events.GUILD_ROLE_DELETE, guild, role); + client.emit(Constants.Events.GUILD_ROLE_DELETE, role); } else { role = this.deleted.get(guild.id + data.role_id) || null; } @@ -39,8 +39,7 @@ class GuildRoleDeleteAction extends Action { /** * Emitted whenever a guild role is deleted. - * @event Client#guildRoleDelete - * @param {Guild} guild The guild that the role was deleted in. + * @event Client#roleDelete * @param {Role} role The role that was deleted. */ diff --git a/src/client/actions/GuildRoleUpdate.js b/src/client/actions/GuildRoleUpdate.js index 72ad1513a..8270517b6 100644 --- a/src/client/actions/GuildRoleUpdate.js +++ b/src/client/actions/GuildRoleUpdate.js @@ -15,7 +15,7 @@ class GuildRoleUpdateAction extends Action { if (role) { oldRole = cloneObject(role); role.setup(data.role); - client.emit(Constants.Events.GUILD_ROLE_UPDATE, guild, oldRole, role); + client.emit(Constants.Events.GUILD_ROLE_UPDATE, oldRole, role); } return { @@ -33,8 +33,7 @@ class GuildRoleUpdateAction extends Action { /** * Emitted whenever a guild role is updated. - * @event Client#guildRoleUpdate - * @param {Guild} guild The guild that the role was updated in. + * @event Client#roleUpdate * @param {Role} oldRole The role before the update. * @param {Role} newRole The role after the update. */ diff --git a/src/client/websocket/packets/handlers/GuildMembersChunk.js b/src/client/websocket/packets/handlers/GuildMembersChunk.js index 6c6257f24..1a58e1cea 100644 --- a/src/client/websocket/packets/handlers/GuildMembersChunk.js +++ b/src/client/websocket/packets/handlers/GuildMembersChunk.js @@ -15,14 +15,13 @@ class GuildMembersChunkHandler extends AbstractHandler { } guild._checkChunks(); - client.emit(Constants.Events.GUILD_MEMBERS_CHUNK, guild, members); + client.emit(Constants.Events.GUILD_MEMBERS_CHUNK, members); } } /** - * Emitted whenever a chunk of Guild members is received + * Emitted whenever a chunk of Guild members is received (all members come from the same guild) * @event Client#guildMembersChunk - * @param {Guild} guild The guild that the chunks relate to * @param {GuildMember[]} members The members in the chunk */ diff --git a/src/client/websocket/packets/handlers/PresenceUpdate.js b/src/client/websocket/packets/handlers/PresenceUpdate.js index 531855b48..9edacd76a 100644 --- a/src/client/websocket/packets/handlers/PresenceUpdate.js +++ b/src/client/websocket/packets/handlers/PresenceUpdate.js @@ -33,7 +33,7 @@ class PresenceUpdateHandler extends AbstractHandler { deaf: false, mute: false, }, false); - client.emit(Constants.Events.GUILD_MEMBER_AVAILABLE, guild, member); + client.emit(Constants.Events.GUILD_MEMBER_AVAILABLE, member); } if (member) { const oldMember = cloneObject(member); @@ -66,7 +66,6 @@ class PresenceUpdateHandler extends AbstractHandler { /** * Emitted whenever a member becomes available in a large Guild * @event Client#guildMemberAvailable - * @param {Guild} guild The guild that the member became available in * @param {GuildMember} member The member that became available */ diff --git a/src/structures/Guild.js b/src/structures/Guild.js index d9c7f6ed9..58b28cb8a 100644 --- a/src/structures/Guild.js +++ b/src/structures/Guild.js @@ -726,11 +726,10 @@ class Guild { /** * Emitted whenever a user joins a guild. * @event Client#guildMemberAdd - * @param {Guild} guild The guild that the user has joined - * @param {GuildMember} member The member that has joined + * @param {GuildMember} member The member that has joined a guild */ if (this.client.ws.status === Constants.Status.READY && emitEvent && !existing) { - this.client.emit(Constants.Events.GUILD_MEMBER_ADD, this, member); + this.client.emit(Constants.Events.GUILD_MEMBER_ADD, member); } this._checkChunks(); @@ -749,11 +748,10 @@ class Guild { /** * Emitted whenever a Guild Member changes - i.e. new role, removed role, nickname * @event Client#guildMemberUpdate - * @param {Guild} guild The guild that the update affects * @param {GuildMember} oldMember The member before the update * @param {GuildMember} newMember The member after the update */ - this.client.emit(Constants.Events.GUILD_MEMBER_UPDATE, this, oldMember, member); + this.client.emit(Constants.Events.GUILD_MEMBER_UPDATE, oldMember, member); } return { diff --git a/src/util/Constants.js b/src/util/Constants.js index cd163cc37..95d203319 100644 --- a/src/util/Constants.js +++ b/src/util/Constants.js @@ -170,9 +170,9 @@ exports.Events = { GUILD_MEMBER_AVAILABLE: 'guildMemberAvailable', GUILD_MEMBER_SPEAKING: 'guildMemberSpeaking', GUILD_MEMBERS_CHUNK: 'guildMembersChunk', - GUILD_ROLE_CREATE: 'guildRoleCreate', - GUILD_ROLE_DELETE: 'guildRoleDelete', - GUILD_ROLE_UPDATE: 'guildRoleUpdate', + GUILD_ROLE_CREATE: 'roleCreate', + GUILD_ROLE_DELETE: 'roleDelete', + GUILD_ROLE_UPDATE: 'roleUpdate', GUILD_EMOJI_CREATE: 'guildEmojiCreate', GUILD_EMOJI_DELETE: 'guildEmojiDelete', GUILD_EMOJI_UPDATE: 'guildEmojiUpdate',