From 57c5ed19c4a86eddd9493ca2933a3676272c0d50 Mon Sep 17 00:00:00 2001 From: professor <72993616+professor91@users.noreply.github.com> Date: Sun, 8 Oct 2023 15:49:36 +0530 Subject: [PATCH] DOCS: added resolved object example (#923) --- 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..6727851478 --- /dev/null +++ b/docpages/example_code/resolved_objects.cpp @@ -0,0 +1,46 @@ +#include + +int main() { + dpp::cluster bot("token"); + + 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..cbe5134114 --- /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, 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. + +Below is an example showing how to get a member, passed in command options, using resolved set. + +\include{cpp} resolved_objects.cpp