Skip to content

Commit

Permalink
automatic commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Docs Deployment Bot committed Oct 7, 2024
1 parent d7af454 commit 9b1b170
Show file tree
Hide file tree
Showing 657 changed files with 36,087 additions and 28,452 deletions.
5 changes: 4 additions & 1 deletion advanced-reference.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@ var advanced_reference =
[
[ "Clusters, Shards, and Guilds", "clusters-shards-guilds.html", null ],
[ "Thread Model", "thread-model.html", null ],
[ "Voice Model", "voice-model.html", null ],
[ "Voice Model", "voice-model.html", [
[ "High Level Summary", "voice-model.html#autotoc_md85", null ],
[ "Flow Diagram", "voice-model.html#autotoc_md86", null ]
] ],
[ "Coding Style Standards", "coding-standards.html", null ],
[ "Documentation Style Standards", "docs-standards.html", null ],
[ "Unit Tests", "unit-tests.html", null ],
Expand Down
376 changes: 189 additions & 187 deletions annotated.html

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions annotated_dup.js
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ var annotated_dup =
[ "context_menu_t", "structdpp_1_1context__menu__t.html", "structdpp_1_1context__menu__t" ],
[ "coroutine", "classdpp_1_1coroutine.html", "classdpp_1_1coroutine" ],
[ "coroutine_dummy", "structdpp_1_1coroutine__dummy.html", "structdpp_1_1coroutine__dummy" ],
[ "dave_binary_header_t", "structdpp_1_1dave__binary__header__t.html", "structdpp_1_1dave__binary__header__t" ],
[ "discord_client", "classdpp_1_1discord__client.html", "classdpp_1_1discord__client" ],
[ "discord_voice_client", "classdpp_1_1discord__voice__client.html", "classdpp_1_1discord__voice__client" ],
[ "dns_cache_entry", "structdpp_1_1dns__cache__entry.html", "structdpp_1_1dns__cache__entry" ],
Expand Down Expand Up @@ -342,6 +343,7 @@ var annotated_dup =
[ "user_update_t", "structdpp_1_1user__update__t.html", "structdpp_1_1user__update__t" ],
[ "voice_buffer_send_t", "structdpp_1_1voice__buffer__send__t.html", "structdpp_1_1voice__buffer__send__t" ],
[ "voice_client_disconnect_t", "structdpp_1_1voice__client__disconnect__t.html", "structdpp_1_1voice__client__disconnect__t" ],
[ "voice_client_platform_t", "structdpp_1_1voice__client__platform__t.html", "structdpp_1_1voice__client__platform__t" ],
[ "voice_client_speaking_t", "structdpp_1_1voice__client__speaking__t.html", "structdpp_1_1voice__client__speaking__t" ],
[ "voice_exception", "classdpp_1_1voice__exception.html", "classdpp_1_1voice__exception" ],
[ "voice_out_packet", "structdpp_1_1voice__out__packet.html", "structdpp_1_1voice__out__packet" ],
Expand Down
228 changes: 228 additions & 0 deletions audioframe.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions awaiting-events.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,14 +152,14 @@
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="aclassdpp_1_1cluster_html"><div class="ttname"><a href="classdpp_1_1cluster.html">dpp::cluster</a></div><div class="ttdoc">The cluster class represents a group of shards and a command queue for sending and receiving commands...</div><div class="ttdef"><b>Definition:</b> cluster.h:80</div></div>
<div class="ttc" id="aclassdpp_1_1cluster_html_ab840686c7cd2e15f4a66ab64f62e106b"><div class="ttname"><a href="classdpp_1_1cluster.html#ab840686c7cd2e15f4a66ab64f62e106b">dpp::cluster::on_log</a></div><div class="ttdeci">event_router_t&lt; log_t &gt; on_log</div><div class="ttdoc">Called when a log message is to be written to the log. You can attach any logging system here you wis...</div><div class="ttdef"><b>Definition:</b> cluster.h:476</div></div>
<div class="ttc" id="aclassdpp_1_1cluster_html_af9409347218d270da0aeb22b0a27c38d"><div class="ttname"><a href="classdpp_1_1cluster.html#af9409347218d270da0aeb22b0a27c38d">dpp::cluster::on_button_click</a></div><div class="ttdeci">event_router_t&lt; button_click_t &gt; on_button_click</div><div class="ttdoc">Called when a button is clicked attached to a message. Button clicks are triggered by discord when bu...</div><div class="ttdef"><b>Definition:</b> cluster.h:520</div></div>
<div class="ttc" id="aclassdpp_1_1cluster_html_ab840686c7cd2e15f4a66ab64f62e106b"><div class="ttname"><a href="classdpp_1_1cluster.html#ab840686c7cd2e15f4a66ab64f62e106b">dpp::cluster::on_log</a></div><div class="ttdeci">event_router_t&lt; log_t &gt; on_log</div><div class="ttdoc">Called when a log message is to be written to the log. You can attach any logging system here you wis...</div><div class="ttdef"><b>Definition:</b> cluster.h:485</div></div>
<div class="ttc" id="aclassdpp_1_1cluster_html_af9409347218d270da0aeb22b0a27c38d"><div class="ttname"><a href="classdpp_1_1cluster.html#af9409347218d270da0aeb22b0a27c38d">dpp::cluster::on_button_click</a></div><div class="ttdeci">event_router_t&lt; button_click_t &gt; on_button_click</div><div class="ttdoc">Called when a button is clicked attached to a message. Button clicks are triggered by discord when bu...</div><div class="ttdef"><b>Definition:</b> cluster.h:529</div></div>
<div class="ttc" id="aclassdpp_1_1component_html"><div class="ttname"><a href="classdpp_1_1component.html">dpp::component</a></div><div class="ttdoc">Represents the component object. A component is a clickable button or drop down list within a discord...</div><div class="ttdef"><b>Definition:</b> message.h:348</div></div>
<div class="ttc" id="aclassdpp_1_1component_html_a281e39d6b8c65b1fd301d195a835e703"><div class="ttname"><a href="classdpp_1_1component.html#a281e39d6b8c65b1fd301d195a835e703">dpp::component::set_type</a></div><div class="ttdeci">component &amp; set_type(component_type ct)</div><div class="ttdoc">Set the type of the component. Button components (type dpp::cot_button) should always be contained wi...</div></div>
<div class="ttc" id="aclassdpp_1_1component_html_a33f254b5ac5a043870cb30efc99fb580"><div class="ttname"><a href="classdpp_1_1component.html#a33f254b5ac5a043870cb30efc99fb580">dpp::component::set_label</a></div><div class="ttdeci">component &amp; set_label(std::string_view label)</div><div class="ttdoc">Set the label of the component, e.g. button text. For action rows, this field is ignored....</div></div>
<div class="ttc" id="aclassdpp_1_1component_html_a3707437be16cc7dfd5edcf321f8e842d"><div class="ttname"><a href="classdpp_1_1component.html#a3707437be16cc7dfd5edcf321f8e842d">dpp::component::add_component</a></div><div class="ttdeci">component &amp; add_component(const component &amp;c)</div><div class="ttdoc">Add a sub-component, only valid for action rows. Adding subcomponents to a component will automatical...</div></div>
<div class="ttc" id="aclassdpp_1_1component_html_a5b5e20746e11d017569ccc46efd56688"><div class="ttname"><a href="classdpp_1_1component.html#a5b5e20746e11d017569ccc46efd56688">dpp::component::set_id</a></div><div class="ttdeci">component &amp; set_id(std::string_view id)</div><div class="ttdoc">Set the id of the component. For action rows, this field is ignored. Setting the id will auto-set the...</div></div>
<div class="ttc" id="aclassdpp_1_1discord__client_html_afed78d2e1b09e006ede8b4690895a866"><div class="ttname"><a href="classdpp_1_1discord__client.html#afed78d2e1b09e006ede8b4690895a866">dpp::discord_client::creator</a></div><div class="ttdeci">class dpp::cluster * creator</div><div class="ttdoc">Owning cluster.</div><div class="ttdef"><b>Definition:</b> discordclient.h:275</div></div>
<div class="ttc" id="aclassdpp_1_1discord__client_html_afed78d2e1b09e006ede8b4690895a866"><div class="ttname"><a href="classdpp_1_1discord__client.html#afed78d2e1b09e006ede8b4690895a866">dpp::discord_client::creator</a></div><div class="ttdeci">class dpp::cluster * creator</div><div class="ttdoc">Owning cluster.</div><div class="ttdef"><b>Definition:</b> discordclient.h:283</div></div>
<div class="ttc" id="aclassdpp_1_1interaction_html_aabbb8d58d708128098516ed443d5c140"><div class="ttname"><a href="classdpp_1_1interaction.html#aabbb8d58d708128098516ed443d5c140">dpp::interaction::get_command_name</a></div><div class="ttdeci">std::string get_command_name() const</div><div class="ttdoc">Get the command name for a command interaction.</div></div>
<div class="ttc" id="aclassdpp_1_1managed_html_a40bf0c6cc03909910512808fa6caa112"><div class="ttname"><a href="classdpp_1_1managed.html#a40bf0c6cc03909910512808fa6caa112">dpp::managed::id</a></div><div class="ttdeci">snowflake id</div><div class="ttdoc">Unique ID of object set by Discord. This value contains a timestamp, worker ID, internal server ID,...</div><div class="ttdef"><b>Definition:</b> managed.h:39</div></div>
<div class="ttc" id="aclassdpp_1_1slashcommand_html"><div class="ttname"><a href="classdpp_1_1slashcommand.html">dpp::slashcommand</a></div><div class="ttdoc">Represents an application command, created by your bot either globally, or on a guild.</div><div class="ttdef"><b>Definition:</b> appcommand.h:1342</div></div>
Expand Down
2 changes: 1 addition & 1 deletion build-a-bot-xcode.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
</div>
</li>
</ol>
<h2><a class="anchor" id="autotoc_md172"></a>
<h2><a class="anchor" id="autotoc_md174"></a>
Troubleshooting</h2>
<ul>
<li>Stuck? You can find us on the <a href="https://discord.gg/dpp">official Discord server</a> - ask away! We don't bite! </li>
Expand Down
2 changes: 1 addition & 1 deletion build-a-discord-bot-linux-clion.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
</div><!--header-->
<div class="contents">
<div class="textblock"><dl class="section warning"><dt>Warning</dt><dd><b>This tutorial assumes you are using Ubuntu</b>. You might use other distros if you prefer, but keep in mind the setup process might be different! This tutorial also teaches you how to use DPP with CMake, using the JetBrains IDE <b><a href="https://www.jetbrains.com/clion/">CLion</a></b>. If you have not installed CLion, You can <a href="https://www.jetbrains.com/de-de/clion/download/">download CLion here</a>. If you do not have DPP installed, visit <a class="el" href="buildcmake.html">this page</a> on how to setup the project using a precompiled version of DPP. If you want to use source and haven't set that up, look towards <a class="el" href="buildlinux.html">this page</a> on how to do so. <b>This tutorial will not teach you how to setup CMake and will assume you have already done so</b>.</dd></dl>
<h3><a class="anchor" id="autotoc_md152"></a>
<h3><a class="anchor" id="autotoc_md154"></a>
Add an example program</h3>
<p >Open up CLion and open the folder for your bot. You may notice that CLion will start doing the whole CMake process and it will create a folder called <code>cmake-build-debug</code>, this is normal so don't be alarmed! It is just CLion registering all the CMake stuff so it can build and give you auto-suggestions.</p>
<p >Now, you can open your <code>main.cpp</code> file. If you have code there, then you're one step ahead! If not, copy and paste the following <a class="el" href="firstbot.html">example program</a> in the <code>main.cpp</code> and set your bot token (see <a class="el" href="creating-a-bot-application.html">Creating a Bot Token</a>). Here's how your <code>main.cpp</code> file should look:</p>
Expand Down
6 changes: 3 additions & 3 deletions build-a-discord-bot-windows-visual-studio.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,14 +103,14 @@
<div class="contents">
<div class="textblock"><p >To create a basic bot using <b>Visual Studio 2019</b> or <b>Visual Studio 2022</b>, follow the steps below to create a <em>working skeleton project you can build upon</em>.</p>
<p >If you prefer a video tutorial, you can watch the video below! Otherwise, scroll past and keep reading!</p>
<h2><a class="anchor" id="autotoc_md169"></a>
<h2><a class="anchor" id="autotoc_md171"></a>
Video Tutorial</h2>
<p >

<iframe width="560" height="315" src="https://www.youtube.com/embed/JGqaQ9nH5sk?si=dung8KuYbWvP2_oL" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

</p>
<h2><a class="anchor" id="autotoc_md170"></a>
<h2><a class="anchor" id="autotoc_md172"></a>
Text Tutorial</h2>
<ol type="1">
<li>Make sure you have Visual Studio 2019 or 2022. Community, Professional or Enterprise work fine. These instructions are not for Visual Studio Code. You can <a href="https://visualstudio.microsoft.com/downloads/">download the correct version here</a>. Note that older versions of Visual Studio will not work as they do not support enough of the C++17 standard.</li>
Expand All @@ -132,7 +132,7 @@ <h2><a class="anchor" id="autotoc_md170"></a>
</div>
</li>
</ol>
<h2><a class="anchor" id="autotoc_md171"></a>
<h2><a class="anchor" id="autotoc_md173"></a>
Troubleshooting</h2>
<ul>
<li>If you get an error that looks like this: <div class="fragment"><div class="line"> 1&gt;MyBot.obj : error LNK2019: unresolved external symbol &quot;__declspec(dllimport) public: class dpp::async&lt;struct dpp::confirmation_callback_t&gt;</div>
Expand Down
Loading

0 comments on commit 9b1b170

Please sign in to comment.