From a68d5e1c132bc4d195466f0c5af430aeb1cdcc5b Mon Sep 17 00:00:00 2001 From: professor91 Date: Thu, 5 Oct 2023 13:36:06 +0530 Subject: [PATCH 1/3] DOCS: added resolved object example --- docpages/example_code/resolved_objects.cpp | 46 +++++++++++++++++++ .../interactions_and_components.md | 1 + .../resolved_objects.md | 9 ++++ 3 files changed, 56 insertions(+) create mode 100644 docpages/example_code/resolved_objects.cpp create mode 100644 docpages/example_programs/interactions_and_components/resolved_objects.md diff --git a/docpages/example_code/resolved_objects.cpp b/docpages/example_code/resolved_objects.cpp new file mode 100644 index 0000000000..97b70af6b7 --- /dev/null +++ b/docpages/example_code/resolved_objects.cpp @@ -0,0 +1,46 @@ +#include + +int main() { + dpp::cluster bot("token", dpp::i_default_intents); + + bot.on_log(dpp::utility::cout_logger()); + + /* The event is fired when someone issues your commands */ + bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) { + + /* Check which command they ran */ + if (event.command.get_command_name() == "addrole") { + + /* Fetch a parameter value from the command options */ + dpp::snowflake user_id = std::get(event.get_parameter("user")); + dpp::snowflake role_id = std::get(event.get_parameter("role")); + + /* Get member object from resolved list */ + dpp::guild_member resolved_member = event.command.get_resolved_member(user_id); + + resolved_member.add_role(role_id); + bot.guild_edit_member(resolved_member); + + event.reply("Added role"); + } + }); + + /* Attach on_ready event */ + bot.on_ready([&bot](const dpp::ready_t& event) { + if (dpp::run_once()) { + + dpp::slashcommand add_role("addrole", "Give user a role", bot.me.id); + + /* Add user and role type command options to the slash command */ + add_role.add_option(dpp::command_option(dpp::co_user, "user", "User to give role to", true)); + add_role.add_option(dpp::command_option(dpp::co_role, "role", "Role to give", true)); + + bot.global_command_create(add_role); + } + }); + + /* Start bot */ + bot.start(dpp::st_wait); + + return 0; +} diff --git a/docpages/example_programs/interactions_and_components.md b/docpages/example_programs/interactions_and_components.md index e371a6d792..022a156ba5 100644 --- a/docpages/example_programs/interactions_and_components.md +++ b/docpages/example_programs/interactions_and_components.md @@ -16,3 +16,4 @@ The example programs listed here demonstrate lots of things to do with interacti * \subpage discord-application-command-file-upload "Using file parameters in slash commands" * \subpage private-messaging * \subpage making_threads +* \subpage resolved-objects diff --git a/docpages/example_programs/interactions_and_components/resolved_objects.md b/docpages/example_programs/interactions_and_components/resolved_objects.md new file mode 100644 index 0000000000..dbd0f09830 --- /dev/null +++ b/docpages/example_programs/interactions_and_components/resolved_objects.md @@ -0,0 +1,9 @@ +\page resolved-objects Using Resolved Objects + +If your slash command accepts options like user, channel, or role you can get their value, passed by user, from parameters. Though parameter gives you only the snowflake id of the passed value. + +If you need object of that snowflake, you can get that from the resolved set using its snowflake id. + +Below is an example showing how to get a member, passed in command options, using resolved set. + +\include{cpp} resolved_objects.cpp From ed9e4541d23803b46c26a95f71f9798685dd6574 Mon Sep 17 00:00:00 2001 From: professor91 Date: Sat, 7 Oct 2023 00:40:00 +0530 Subject: [PATCH 2/3] changed indent spaces to tabs --- docpages/example_code/resolved_objects.cpp | 58 +++++++++++----------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/docpages/example_code/resolved_objects.cpp b/docpages/example_code/resolved_objects.cpp index 97b70af6b7..6727851478 100644 --- a/docpages/example_code/resolved_objects.cpp +++ b/docpages/example_code/resolved_objects.cpp @@ -1,46 +1,46 @@ #include int main() { - dpp::cluster bot("token", dpp::i_default_intents); + dpp::cluster bot("token"); - bot.on_log(dpp::utility::cout_logger()); + bot.on_log(dpp::utility::cout_logger()); - /* The event is fired when someone issues your commands */ - bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) { + /* The event is fired when someone issues your commands */ + bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) { - /* Check which command they ran */ - if (event.command.get_command_name() == "addrole") { + /* Check which command they ran */ + if (event.command.get_command_name() == "addrole") { - /* Fetch a parameter value from the command options */ - dpp::snowflake user_id = std::get(event.get_parameter("user")); - dpp::snowflake role_id = std::get(event.get_parameter("role")); + /* Fetch a parameter value from the command options */ + dpp::snowflake user_id = std::get(event.get_parameter("user")); + dpp::snowflake role_id = std::get(event.get_parameter("role")); - /* Get member object from resolved list */ - dpp::guild_member resolved_member = event.command.get_resolved_member(user_id); + /* Get member object from resolved list */ + dpp::guild_member resolved_member = event.command.get_resolved_member(user_id); - resolved_member.add_role(role_id); - bot.guild_edit_member(resolved_member); + resolved_member.add_role(role_id); + bot.guild_edit_member(resolved_member); - event.reply("Added role"); - } - }); + event.reply("Added role"); + } + }); - /* Attach on_ready event */ - bot.on_ready([&bot](const dpp::ready_t& event) { - if (dpp::run_once()) { + /* Attach on_ready event */ + bot.on_ready([&bot](const dpp::ready_t& event) { + if (dpp::run_once()) { - dpp::slashcommand add_role("addrole", "Give user a role", bot.me.id); + dpp::slashcommand add_role("addrole", "Give user a role", bot.me.id); - /* Add user and role type command options to the slash command */ - add_role.add_option(dpp::command_option(dpp::co_user, "user", "User to give role to", true)); - add_role.add_option(dpp::command_option(dpp::co_role, "role", "Role to give", true)); + /* Add user and role type command options to the slash command */ + add_role.add_option(dpp::command_option(dpp::co_user, "user", "User to give role to", true)); + add_role.add_option(dpp::command_option(dpp::co_role, "role", "Role to give", true)); - bot.global_command_create(add_role); - } - }); + bot.global_command_create(add_role); + } + }); - /* Start bot */ - bot.start(dpp::st_wait); + /* Start bot */ + bot.start(dpp::st_wait); - return 0; + return 0; } From b7325a5088cd970a3a0a703638beea14ff1e032c Mon Sep 17 00:00:00 2001 From: professor91 Date: Sun, 8 Oct 2023 15:11:40 +0530 Subject: [PATCH 3/3] fix wordings --- .../interactions_and_components/resolved_objects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docpages/example_programs/interactions_and_components/resolved_objects.md b/docpages/example_programs/interactions_and_components/resolved_objects.md index dbd0f09830..cbe5134114 100644 --- a/docpages/example_programs/interactions_and_components/resolved_objects.md +++ b/docpages/example_programs/interactions_and_components/resolved_objects.md @@ -1,6 +1,6 @@ \page resolved-objects Using Resolved Objects -If your slash command accepts options like user, channel, or role you can get their value, passed by user, from parameters. Though parameter gives you only the snowflake id of the passed value. +If your slash command accepts options like user, channel, or role you can get their value, as specified by the user in the command, from parameters. Though parameter gives you only the snowflake id of the passed value. If you need object of that snowflake, you can get that from the resolved set using its snowflake id.