DiscordHelper

Introduction

DiscordHelper permet d'interagir plus facilement avec votre serveur discord grâce aux webhooks.

Getting Started

Nous allons commencer par déclarer une propriété de type ${\color{LimeGreen}\normalsize{\textsf{DiscordWebhookClient}}}$ Cette propriété doit stocker l'un de vos webhooks dans le cas où vous souhaiteriez que votre plugin puisse envoyer des messages dans certains canaux.

using Life;

namespace MyPlugin
{
    public class DiscordPlugin : ModKit.ModKit
    {
         public static DiscordWebhookClient WebhookClient = new DiscordWebhookClient("url_de_votre__webhook");
    }
}

Envoyer un message dans un canal

Lorsque vous avez votre webhook, vous pouvez utiliser la méthode asynchrone ${\color{NavyBlue}\normalsize{\textsf{SendMsg(DiscordWebhookClient webhookClient, string msg)}}}$ pour envoyer un message dans votre canal discord.

• ${\color{Goldenrod}\normalsize{\textsf{webhookClient}}}$ : Le client webhook Discord utilisé pour envoyer le message.
• ${\color{Goldenrod}\normalsize{\textsf{msg}}}$ : Le message a envoyer dans votre canal discord.

public async void votreFonction()
{
    await DiscordHelper.SendMsg(DiscordPlugin.WebhookClient, $"votre message");
}

Envoyer un embed dans un canal

Envoie un embed dans votre canal discord. ${\color{NavyBlue}\normalsize{\textsf{SendEmbed(DiscordWebhookClient webhookClient, string hexColor, string title, string description, List fieldNames, List fieldValues, bool inlineFields,}}}$ ${\color{NavyBlue}\normalsize{\textsf{bool showFooter, string footerText)}}}$

• ${\color{Goldenrod}\normalsize{\textsf{webhookClient}}}$ : Le client webhook Discord utilisé pour envoyer le message.
• ${\color{Goldenrod}\normalsize{\textsf{hexColor}}}$ : La couleur de l'embed au format hexadécimal.
• ${\color{Goldenrod}\normalsize{\textsf{title}}}$ : Le titre de l'embed.
• ${\color{Goldenrod}\normalsize{\textsf{description}}}$ : La description de l'embed.
• ${\color{Goldenrod}\normalsize{\textsf{fieldNames}}}$ : Les noms des champs à inclure dans l'embed.
• ${\color{Goldenrod}\normalsize{\textsf{fieldValues}}}$ : Les valeurs associées aux noms de champs.
• ${\color{Goldenrod}\normalsize{\textsf{inlineFields}}}$ : Indique si les champs doivent être affichés en ligne (true) ou sous forme de liste (false).
• ${\color{Goldenrod}\normalsize{\textsf{showFooter}}}$ : Indique si le footer être affiché (true) ou non (false).
• ${\color{Goldenrod}\normalsize{\textsf{footerText}}}$ : Le texte à afficher dans le footer de l'embed.

public async void VotreFonction()
{
    string hexColor = "#3498db"; // Couleur en hexadécimal (ex: bleu)
    string title = "Titre de l'embed";
    string description = "Ceci est la description de votre embed.";

    List<string> fieldNames = new List<string> { 
        "Exemple 1", 
        "Exemple 2", 
        "Exemple 3" 
    };
    List<string> fieldValues = new List<string> {
        "Valeur associée à Exemple 1",
        "Valeur associée à Exemple 2",
        "Valeur associée à Exemple 3"
    };

    bool inlineFields = false; // Affiche les champs en liste
    bool showFooter = true;   // Affiche un pied de page
    string footerText = "Texte du pied de page";

    await DiscordHelper.SendEmbed(DiscordPlugin.WebhookClient, hexColor, title, description, fieldNames, fieldValues, inlineFields, showFooter, footerText);
}