リアクションによる役職の付与、剝奪

まずはじめに

この記事は海外の開発者様Anson様のコードを日本語で少し分かりやすく解説した物になります。また、ご本人様への確認を取り許可を頂いている為二次配布を禁止し、個人利用にのみ使用可能とします。

元ソースの掲載ページ
ご本人様の解説動画

概要

ここ最近DiscordのBot開発にのめり込んでいるのですが、よく大手のサーバーに入っているbotでリアクションを付けると役職が付与されるアレ、どうすれば上手く実現できるのかなぁ...と悩みつつcommand.commandsのやつを調べたりなんやらと色々探してみたはいいものの、まっっっっっっったくと言って良いほどしっくりくるpython用の日本語の記事が無かったんですよね。なので私が調べ見つけた海外の開発者Anson様のコードを一部改変したものを掲載、簡単な解説を忘備録として。

筆者の環境

前回の記事と変わらずですが一応。

• Windows10
• Pycharm Community Edition
• python 3.7.4
• discord.py 1.2.4

前提条件

こちらも前回と変わらずpythonとdiscord.pyが動く環境が有る前提でお話します。
無いよ、という方は各自調べてください。ここでは一切解説しません
また、同じ名前のカスタム絵文字と役職が無いと以下のbotでは役職を付与する事が出来ないので事前に設定しておいてください。

*例
*

本題

import discord

client = discord.Client()


@client.event
async def on_raw_reaction_add(payload):

    if payload.message_id == ID:

        print(payload.emoji.name)
        guild_id = payload.guild_id
        guild = discord.utils.find(lambda g: g.id == guild_id, client.guilds)

        role = discord.utils.find(lambda r: r.name == payload.emoji.name, guild.roles)

        if role is not None:
            print(role.name + " was found!")
            print(role.id)
            member = discord.utils.find(lambda m: m.id == payload.user_id, guild.members)
            await member.add_roles(role)
            print("done")


@client.event
async def on_raw_reaction_remove(payload):
    if payload.message_id == ID:
        print(payload.emoji.name)

        guild_id = payload.guild_id
        guild = discord.utils.find(lambda g: g.id == guild_id, client.guilds)
        role = discord.utils.find(lambda r: r.name == payload.emoji.name, guild.roles)

        if role is not None:
            member = discord.utils.find(lambda m: m.id == payload.user_id, guild.members)
            await member.remove_roles(role)
            print("done")


@client.event
async def on_ready():
    print("Botは正常に起動しました！")
    print(client.user.name)  # ボットの名前
    print(client.user.id)  # ボットのID
    print(discord.__version__)  # discord.pyのバージョン
    print('------')
    await client.change_presence(activity=discord.Game(name="役職を管理！"))

client.run("TOKEN")

こちらになります。今回は

on_raw_reaction_add(payload)

と

on_raw_reaction_remove(payload)

がキーとなってきます

では少しではありますが簡単な解説を以下に。

簡単な解説

コメントアウトの方に解説を書かせて頂きます。

@client.event
async def on_raw_reaction_add(payload):
    # メッセージにリアクションが追加されたときに以下の動作が呼び出されます

    if payload.message_id == ID:
        # ここでリアクションを追加して欲しいメッセージをあらかじめ設定しておきます(IDに該当メッセージのIDをコピペしてください)

        guild_id = payload.guild_id
        guild = discord.utils.find(lambda g: g.id == guild_id, client.guilds)

        role = discord.utils.find(lambda r: r.name == payload.emoji.name, guild.roles)

lambda関数に関しては
https://qiita.com/nagataaaas/items/531b1fc5ce42a791c7df
(nagataaaas様の記事)を読めば理解出来ると思います。

        if role is not None:
            # 対応する役職があった場合以下の動作を行います

@client.event
async def on_raw_reaction_remove(payload):
    # メッセージからリアクションが削除されたときに呼び出されます

    if payload.message_id == ID:
    # IDには先ほどon_raw_reaction_add(payload)の方で使ったIDと同じものを利用してください。

こんなものですかね。同じような記述のコードは省略しました。

最後に

discord.pyの日本語の記事って少ない or versionが古いものが多いですよねぇ...
このbotに関しても実装したい...けど日本語の記事でそれっぽいのは見つからないし...と言った流れで海外の方のコードを漁るようになったら案外早く見つかったので、私と同じく初学者の方であれこれしたいけどそれっぽいの見つかんないよ！てかドキュメント読んでも分かんないよ！って方は海外の方を参考にしてみては？

改めて、今回参考にさせて頂いたサイトや開発者様のURLを載せて〆ようと思います。

Anson様のyoutubeチャンネル
公式ドキュメントのon_raw_reaction_add(payload)ページ
nagataaaas様のQiitaページ