definitions/structs/role.yml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

---
name: Role
description: "Information about a role within a guild. A role represents a set of permissions, and can be attached to one or multiple users. A role has various miscellaneous configurations, such as being assigned a colour. Roles are unique per guild and do not cross over to other guilds in any way, and can have channel-specific permission overrides in addition to guild-level permissions."
fields:
  - name: id
    type: RoleId
  - name: colour
    from: color
    description: >
      The colour of the role in 0xRRGGBB format. This is an ergonomic
      representation of the inner value.
    type: Colour
  - name: hoist
    description: "Whether the role is pinned above lesser roles, causing members
      in the role to be seen above others."
    type: bool
  - name: managed
    description: "Whether the role is managed by an integration service."
    type: bool
  - name: mentionable
    default: false
    description: "Whether the role can be mentioned, similar to mentioning a
      specific member or @everyone. Only members of the role will be notified if
      a role is mentioned with this set to true."
    type: bool
  - name: name
    type: string
  - name: permissions
    description: "A set of permissions that the role has been assigned. See the
      `permissions` module for more information."
    type: Permissions
  - name: position
    description: "The role's position in the position list. Roles above another
      are considered higher in the role hierarchy in most situations.

      The @everyone role is always position 0."
    type: u64