docs: Added emoji page (brainboxdotcc#1019)

docpages/example_code/using_emojis1.cpp

@@ -0,0 +1,29 @@
+#include <dpp/dpp.h>
+#include <dpp/unicode_emoji.h>
+
+int main() {
+	dpp::cluster bot("Epic Token");
+
+	bot.on_log(dpp::utility::cout_logger());
+
+	/* We'll be using two emojis: shocked guy and animated mad face. */
+	dpp::emoji shocked("vahuyi", 1179366531856093214);
+	dpp::emoji mad("mad", 1117795317052616704, dpp::e_animated); /* We need this third argument, which is an emoji flag. */
+
+	bot.on_slashcommand([shocked, mad](const dpp::slashcommand_t& event) {
+		if (event.command.get_command_name() == "send-emojis") {
+			/* Here we send our very informative message: three epic emojis. */
+			event.reply(dpp::unicode_emoji::nerd + shocked.get_mention() + mad.get_mention());
+		}
+	});
+
+	bot.on_ready([&bot](const dpp::ready_t& event) {
+		if (dpp::run_once<struct register_bot_commands>()) {
+			bot.global_command_create(dpp::slashcommand("send-emojis", "Send the emojis", bot.me.id));
+		}
+	});
+
+	/* Start the bot! */
+	bot.start(dpp::st_wait);
+	return 0;
+}

docpages/example_code/using_emojis2.cpp

@@ -0,0 +1,35 @@
+#include <dpp/dpp.h>
+#include <dpp/unicode_emoji.h>
+
+int main() {
+	dpp::cluster bot("Epic Token", dpp::i_default_intents | dpp::i_message_content);
+	/* The second argument is a bitmask of intents - i_message_content is needed to see the messages */
+
+	bot.on_log(dpp::utility::cout_logger());
+
+	/* We'll be using a shocked guy emoji */
+	dpp::emoji shocked("vahuyi", 1179366531856093214);
+	dpp::emoji mad("mad", 1117795317052616704, dpp::e_animated); /* We need this third argument, which is an emoji flag. */
+
+	bot.on_message_create([&bot, shocked, mad](const dpp::message_create_t& event) {
+		if (event.msg.content == "I'm hungry") {
+			/* But if they're hungry */
+			bot.message_add_reaction(event.msg.id, event.msg.channel_id, dpp::unicode_emoji::cut_of_meat);
+			/* Let's send some meat to the message, so they don't starve. They will thank us later. */
+
+		} else if (event.msg.content == "WHAT?") {
+			/* If some unknown content shocked the user */
+			bot.message_add_reaction(event.msg.id, event.msg.channel_id, shocked.format());
+			/* React to their message with a shocked guy */
+
+		} else if (event.msg.content == "I'm unsubscribing") {
+			/* They are angry! We should also be! */
+			bot.message_add_reaction(event.msg.id, event.msg.channel_id, mad.format());
+			/* React to their message with a mad emoji */
+		}
+	});
+
+	/* Start the bot! */
+	bot.start(dpp::st_wait);
+	return 0;
+}

docpages/example_code/using_emojis3.cpp

@@ -0,0 +1,45 @@
+#include <dpp/dpp.h>
+#include <dpp/unicode_emoji.h>
+
+int main() {
+	dpp::cluster bot("Epic Token");
+
+	bot.on_log(dpp::utility::cout_logger());
+
+	/* We now have a new character! That's for the select menu. */
+	dpp::emoji walter("walter_black", 1179374919088361544);
+	dpp::emoji mad("mad", 1117795317052616704, dpp::e_animated); /* We need this third argument, which is an emoji flag. */
+
+	/* The event is fired when someone issues your commands */
+	bot.on_slashcommand([walter, mad](const dpp::slashcommand_t& event) {
+		if (event.command.get_command_name() == "select") {
+			dpp::message msg(event.command.channel_id, "Now.");
+			msg.add_component(
+				dpp::component().add_component(
+					dpp::component()
+						.set_type(dpp::cot_selectmenu)
+						.set_placeholder("Say my name.")
+						.add_select_option(dpp::select_option("Do what?", "Yeah, you do.", "I don't have a damn clue what you're talking about.").set_emoji(dpp::unicode_emoji::thinking))
+						.add_select_option(dpp::select_option("Heisenberg", "You're goddamn right!", "The one and only").set_emoji(walter.name, walter.id))
+						.add_select_option(dpp::select_option("I'm unsubscribing", "Wait what", "Pure cruelty").set_emoji(mad.name, mad.id, mad.is_animated())) /* Since our mad emoji is animated, we should tell that to the function */
+						.set_id("myselectid")
+				)
+			);
+			event.reply(msg);
+		}
+	});
+
+	bot.on_select_click([](const dpp::select_click_t& event) {
+		event.reply(event.values[0]);
+	});
+
+	bot.on_ready([&bot](const dpp::ready_t& event) {
+		if (dpp::run_once<struct register_bot_commands>()) {
+			bot.global_command_create(dpp::slashcommand("select", "Send the select menu", bot.me.id));
+		}
+	});
+
+	/* Start the bot! */
+	bot.start(dpp::st_wait);
+	return 0;
+}

docpages/example_programs/misc.md

@@ -11,3 +11,4 @@ This section lists examples that do not fit neatly into any of the categories ab
 * \subpage cpp-eval-command-discord
 * \subpage checking-member-permissions
 * \subpage setting_status
+* \subpage using-emojis

docpages/example_programs/misc/using-emojis.md

@@ -0,0 +1,29 @@
+\page using-emojis Using Emojis
+
+Need your bot to use an emoji? Then you've come to the right place! Here are three examples of using emojis.
+
+\note If your bot isn't in the guild you want to use the custom emoji from, it won't work, giving you dpp::err_unknown_emoji.
+
+First - Sending emojis. You have to use its mention, which depends on the type. If it's a default emoji, you use the corresponding character. So, for example, if you wanted to send a nerd emoji, you would use the nerd unicode character. Now, custom emoji. There are two types: static and animated. Their mentions are `<:[name]:[id]>` and `<a:[name]:[id]>`, where `[name]` means the emoji name and `[id]` is for its ID. When you send such mention, it automatically gets converted into your emoji. Here's an example of sending emojis:
+
+\include{cpp} using_emojis1.cpp
+
+Now, our bot will send our epic emojis!
+
+\image html using_emojis1.png
+
+Second - Reacting to messages. Sometimes there's something so interesting in the chat that we want to react to it. While we see the emoji we react with, for bots, it's some plain text. There are different formats for different kinds of emoji when reacting too. For unicode, it's simply its character, like when sending. For custom ones it's either `[name]:[id]` (if static) or `a:[name]:[id]` (if animated). Let's show our bot's honest reactions!
+
+\include{cpp} using_emojis2.cpp
+
+Yay, our bot has emotions now!
+
+\image html using_emojis2.png
+
+Finally, select menus. These guys are covered \ref components3 "here". They require emoji components (name, ID, animated state) to come separately. If the emoji you're using isn't animated, you don't have to specify that. If your emoji is unicode, it doesn't even have an ID, so you only put the character, since both animated state and ID are defaulted to none (false/0).
+
+\include{cpp} using_emojis3.cpp
+
+Yay, our context menu is now interesting!
+
+\image html using_emojis3.png