Role

Un Role est un rôle d’un serveur. Vous en obtenez un depuis guild.roles, member.roles, member.highestRole, une option role d’une commande ou guild.createRole(). Chaque serveur a un rôle @everyone que chaque membre possède : guild.everyoneRole, dont l’identifiant est celui du serveur.

import type { Guild } from 'chapterjs';

async function createModerators(guild: Guild) {
  const role = await guild.createRole({
    name: 'Modérateurs',
    permissions: ['KickMembers', 'BanMembers', 'ModerateMembers'],
    hoist: true,
  });
  return `${role} a été créé.`; // "<@&id> a été créé."
}

Comment vérifier et donner des permissions est dans Permissions ; comment une commande reçoit un rôle est dans Options.

Propriétés

Snowflake

L’identifiant unique que Discord lui a donné.

Date

Quand il a été créé : un identifiant Discord contient sa date de création.

Snowflake

L’identifiant du serveur du rôle.

Guild

Le serveur du rôle.

string

Le nom du rôle.

number

La couleur sous forme de nombre (0xff0000) ; 0 veut dire pas de couleur.

boolean

Si les membres qui ont ce rôle sont affichés à part dans la liste des membres.

number

Où se trouve le rôle dans la hiérarchie : plus il est haut, plus il est puissant.

Permissions

Ce que le rôle permet sur le serveur. Voir Permissions.

boolean

Si le rôle appartient à une intégration (un bot, les boosters…).

boolean

Si tout le monde peut mentionner le rôle.

string | null

L’emoji standard affiché à côté du rôle, quand il en a un.

boolean

Si c’est le rôle @everyone, que chaque membre a.

GuildMember[]

Les membres qui ont ce rôle, parmi ceux que connaît le bot.

members est lu parmi les membres dont le bot se souvient (voir Mémoire), donc ce n’est pas toujours chaque membre qui a le rôle.

Helpers

Ils lisent ce dont le bot se souvient : ils n’envoient jamais de requête.

iconURL()

iconURL(options?: ImageOptions): string | null

L’URL de l’icône du rôle, quand il en a une. Voir ImageOptions.

isHigherThan()

isHigherThan(other: Role): boolean

Si ce rôle est au-dessus d’un autre dans la hiérarchie. À position égale, le rôle le plus ancien est au-dessus. Documentation de Discord

toString()

toString(): string

<@&id> : mentionne le rôle quand il est mis dans un message.

toJSON()

toJSON(): object

Les données de Discord sous forme d’objet simple, avec des noms en camelCase.

Actions

edit()

edit(options: RoleEditOptions, reason?: string): Promise<Role>

Modifie le rôle. Voir RoleEditOptions. Documentation de Discord

delete()

delete(reason?: string): Promise<void>

Supprime le rôle. Documentation de Discord

Types

RoleEditOptions est dans Options, à côté de RoleCreateOptions. Permissions est dans Permissions.

Référence

Vos fichiers

Structures

Types

CLI

Propriétés

Helpers

iconURL()

isHigherThan()

toString()

toJSON()

Actions

edit()

delete()

Types