From 14ae7cdf1712ca85b5fc64ea86d6964f1863e406 Mon Sep 17 00:00:00 2001 From: bdistin Date: Thu, 9 Mar 2017 17:32:44 -0600 Subject: [PATCH] [Docs] Evaluated Permissions References (#1250) * Docs / Permissions Overwrites Reference * Docs / Evaluated Permissions Reference * Clarify role.permissions is not evaluated * Update Role.js --- src/structures/GuildMember.js | 3 ++- src/structures/Role.js | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/structures/GuildMember.js b/src/structures/GuildMember.js index f2fac38b4..cfa1ea155 100644 --- a/src/structures/GuildMember.js +++ b/src/structures/GuildMember.js @@ -280,7 +280,8 @@ class GuildMember { } /** - * Returns `channel.permissionsFor(guildMember)`. Returns evaluated permissions for a member in a guild channel. + * Returns `channel.permissionsFor(guildMember)`. Returns permissions for a member in a guild channel, + * taking into account roles and permission overwrites. * @param {ChannelResolvable} channel Guild channel to use as context * @returns {?Permissions} */ diff --git a/src/structures/Role.js b/src/structures/Role.js index 6d1556b41..d2ec8814d 100644 --- a/src/structures/Role.js +++ b/src/structures/Role.js @@ -55,7 +55,7 @@ class Role { this.position = data.position; /** - * The evaluated permissions number + * The permissions bitfield of the role * @type {number} */ this.permissions = data.permissions;