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 Sep 23, 2024
1 parent 4b3fed6 commit 29ccc47
Show file tree
Hide file tree
Showing 364 changed files with 36,996 additions and 34,568 deletions.
181 changes: 91 additions & 90 deletions annotated.html
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions annotated_dup.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,7 @@ var annotated_dup =
[ "message_reaction_remove_all_t", "structdpp_1_1message__reaction__remove__all__t.html", "structdpp_1_1message__reaction__remove__all__t" ],
[ "message_reaction_remove_emoji_t", "structdpp_1_1message__reaction__remove__emoji__t.html", "structdpp_1_1message__reaction__remove__emoji__t" ],
[ "message_reaction_remove_t", "structdpp_1_1message__reaction__remove__t.html", "structdpp_1_1message__reaction__remove__t" ],
[ "message_snapshot", "structdpp_1_1message__snapshot.html", "structdpp_1_1message__snapshot" ],
[ "message_update_t", "structdpp_1_1message__update__t.html", "structdpp_1_1message__update__t" ],
[ "moveable_promise", "classdpp_1_1moveable__promise.html", "classdpp_1_1moveable__promise" ],
[ "moving_averager", "structdpp_1_1moving__averager.html", "structdpp_1_1moving__averager" ],
Expand Down
2 changes: 1 addition & 1 deletion awaiting-events.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a10553ebb8d10ba58595f825e0a89eb1b"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a10553ebb8d10ba58595f825e0a89eb1b">dpp::interaction_create_t::edit_original_response</a></div><div class="ttdeci">void edit_original_response(const message &amp;m, command_completion_event_t callback=utility::log_error()) const</div><div class="ttdoc">Edit original response message for this interaction.</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a8b0c69c156a1e532507a918c13414f14"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a8b0c69c156a1e532507a918c13414f14">dpp::interaction_create_t::command</a></div><div class="ttdeci">interaction command</div><div class="ttdoc">command interaction</div><div class="ttdef"><b>Definition:</b> dispatcher.h:678</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_aef38626cd24d2212b00ab866509b4d59"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#aef38626cd24d2212b00ab866509b4d59">dpp::interaction_create_t::co_reply</a></div><div class="ttdeci">dpp::async&lt; dpp::confirmation_callback_t &gt; co_reply() const</div><div class="ttdoc">Acknowledge interaction without displaying a message to the user, for use with button and select menu...</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2016</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2034</div></div>
<div class="ttc" id="astructdpp_1_1ready__t_html"><div class="ttname"><a href="structdpp_1_1ready__t.html">dpp::ready_t</a></div><div class="ttdoc">Session ready.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:961</div></div>
<div class="ttc" id="astructdpp_1_1slashcommand__t_html"><div class="ttname"><a href="structdpp_1_1slashcommand__t.html">dpp::slashcommand_t</a></div><div class="ttdoc">User has issued a slash command.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:695</div></div>
</div><!-- fragment --><p >Note that there is a problem with that! If the user never clicks your button, or if the message gets deleted, your coroutine will be stuck waiting... And waiting... Forever until your bot shuts down, occupying a space in memory. This is where the <a class="el" href="expiring-buttons.html">next example</a> comes into play as a solution, with a button that expires with time.</p>
Expand Down
4 changes: 2 additions & 2 deletions caching-messages.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a8b0c69c156a1e532507a918c13414f14"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a8b0c69c156a1e532507a918c13414f14">dpp::interaction_create_t::command</a></div><div class="ttdeci">interaction command</div><div class="ttdoc">command interaction</div><div class="ttdef"><b>Definition:</b> dispatcher.h:678</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_ae89b601e82f534d5d87135b82a6f0491"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#ae89b601e82f534d5d87135b82a6f0491">dpp::interaction_create_t::get_parameter</a></div><div class="ttdeci">virtual command_value get_parameter(const std::string &amp;name) const</div><div class="ttdoc">Get a slashcommand parameter.</div></div>
<div class="ttc" id="astructdpp_1_1message__create__t_html"><div class="ttname"><a href="structdpp_1_1message__create__t.html">dpp::message_create_t</a></div><div class="ttdoc">Create message.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:1635</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2016</div></div>
<div class="ttc" id="astructdpp_1_1message_html_acb17877db423d2ac4b103a67e1ae2ff6"><div class="ttname"><a href="structdpp_1_1message.html#acb17877db423d2ac4b103a67e1ae2ff6">dpp::message::content</a></div><div class="ttdeci">std::string content</div><div class="ttdoc">Contents of the message.</div><div class="ttdef"><b>Definition:</b> message.h:2061</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2034</div></div>
<div class="ttc" id="astructdpp_1_1message_html_acb17877db423d2ac4b103a67e1ae2ff6"><div class="ttname"><a href="structdpp_1_1message.html#acb17877db423d2ac4b103a67e1ae2ff6">dpp::message::content</a></div><div class="ttdeci">std::string content</div><div class="ttdoc">Contents of the message.</div><div class="ttdef"><b>Definition:</b> message.h:2079</div></div>
<div class="ttc" id="astructdpp_1_1ready__t_html"><div class="ttname"><a href="structdpp_1_1ready__t.html">dpp::ready_t</a></div><div class="ttdoc">Session ready.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:961</div></div>
<div class="ttc" id="astructdpp_1_1slashcommand__t_html"><div class="ttname"><a href="structdpp_1_1slashcommand__t.html">dpp::slashcommand_t</a></div><div class="ttdoc">User has issued a slash command.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:695</div></div>
</div><!-- fragment --> </div></div><!-- contents --><script src="https://giscus.app/client.js" data-repo="brainboxdotcc/dpp-comments" data-repo-id="R_kgDOHOY4xg" data-category="General" data-category-id="DIC_kwDOHOY4xs4CRYtj" data-mapping="pathname" data-strict="1" data-reactions-enabled="1" data-emit-metadata="1" data-input-position="top" data-theme="preferred_color_scheme" data-lang="en" data-loading="lazy" crossorigin="anonymous" async></script>
Expand Down
2 changes: 1 addition & 1 deletion callback-functions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@
<div class="ttc" id="astructdpp_1_1confirmation__callback__t_html_ac32b677abe27aa496063ee34a4ae1fbd"><div class="ttname"><a href="structdpp_1_1confirmation__callback__t.html#ac32b677abe27aa496063ee34a4ae1fbd">dpp::confirmation_callback_t::get</a></div><div class="ttdeci">T get() const</div><div class="ttdoc">Get the stored value via std::get.</div><div class="ttdef"><b>Definition:</b> restresults.h:323</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a34f374b358f8d2d49fa93bfe5a2c0493"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a34f374b358f8d2d49fa93bfe5a2c0493">dpp::interaction_create_t::reply</a></div><div class="ttdeci">void reply(command_completion_event_t callback=utility::log_error()) const</div><div class="ttdoc">Acknowledge interaction without displaying a message to the user, for use with button and select menu...</div></div>
<div class="ttc" id="astructdpp_1_1interaction__create__t_html_a8b0c69c156a1e532507a918c13414f14"><div class="ttname"><a href="structdpp_1_1interaction__create__t.html#a8b0c69c156a1e532507a918c13414f14">dpp::interaction_create_t::command</a></div><div class="ttdeci">interaction command</div><div class="ttdoc">command interaction</div><div class="ttdef"><b>Definition:</b> dispatcher.h:678</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2016</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2034</div></div>
<div class="ttc" id="astructdpp_1_1ready__t_html"><div class="ttname"><a href="structdpp_1_1ready__t.html">dpp::ready_t</a></div><div class="ttdoc">Session ready.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:961</div></div>
<div class="ttc" id="astructdpp_1_1slashcommand__t_html"><div class="ttname"><a href="structdpp_1_1slashcommand__t.html">dpp::slashcommand_t</a></div><div class="ttdoc">User has issued a slash command.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:695</div></div>
</div><!-- fragment --><p >This is the result:</p>
Expand Down
2 changes: 1 addition & 1 deletion classdpp_1_1channel__collector.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#abe7a5ff238f82ee080030514
<div class="ttc" id="aclassdpp_1_1channel__collector_html_ac048b6f35cb511cc9b8d46b1591b243e"><div class="ttname"><a href="classdpp_1_1channel__collector.html#ac048b6f35cb511cc9b8d46b1591b243e">dpp::channel_collector::filter</a></div><div class="ttdeci">virtual const dpp::channel * filter(const dpp::channel_create_t &amp;element)</div><div class="ttdoc">Select and filter the items which are to appear in the list This is called every time a new event is ...</div><div class="ttdef"><b>Definition:</b> collector.h:354</div></div>
<div class="ttc" id="anamespacedpp_1_1unicode__emoji_html_a24ac871c89f4e1779cfeda23077faeac"><div class="ttname"><a href="namespacedpp_1_1unicode__emoji.html#a24ac871c89f4e1779cfeda23077faeac">dpp::unicode_emoji::m</a></div><div class="ttdeci">constexpr const char m[]</div><div class="ttdef"><b>Definition:</b> unicode_emoji.h:5304</div></div>
<div class="ttc" id="astructdpp_1_1message__create__t_html"><div class="ttname"><a href="structdpp_1_1message__create__t.html">dpp::message_create_t</a></div><div class="ttdoc">Create message.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:1635</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2016</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2034</div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">element</td><td>The event data to filter </td></tr>
Expand Down
2 changes: 1 addition & 1 deletion classdpp_1_1collector.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#abe7a5ff238f82ee080030514
<div class="ttc" id="aclassdpp_1_1collector_html_abe7a5ff238f82ee08003051468626c15"><div class="ttname"><a href="classdpp_1_1collector.html#abe7a5ff238f82ee08003051468626c15">dpp::collector::filter</a></div><div class="ttdeci">virtual const C * filter(const T &amp;element)=0</div><div class="ttdoc">Filter the list of elements.</div></div>
<div class="ttc" id="anamespacedpp_1_1unicode__emoji_html_a24ac871c89f4e1779cfeda23077faeac"><div class="ttname"><a href="namespacedpp_1_1unicode__emoji.html#a24ac871c89f4e1779cfeda23077faeac">dpp::unicode_emoji::m</a></div><div class="ttdeci">constexpr const char m[]</div><div class="ttdef"><b>Definition:</b> unicode_emoji.h:5304</div></div>
<div class="ttc" id="astructdpp_1_1message__create__t_html"><div class="ttname"><a href="structdpp_1_1message__create__t.html">dpp::message_create_t</a></div><div class="ttdoc">Create message.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:1635</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2016</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2034</div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">element</td><td>The event data to filter </td></tr>
Expand Down
2 changes: 1 addition & 1 deletion classdpp_1_1event__router__t.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2223cf644fac6d4ab67b5923
<div class="ttc" id="aclassdpp_1_1task_html"><div class="ttname"><a href="classdpp_1_1task.html">dpp::task</a></div><div class="ttdoc">A coroutine task. It starts immediately on construction and can be co_await-ed, making it perfect for...</div><div class="ttdef"><b>Definition:</b> task.h:95</div></div>
<div class="ttc" id="anamespacedpp_1_1unicode__emoji_html_a1121b729a73cc36fb0bf2b8e3d7dc979"><div class="ttname"><a href="namespacedpp_1_1unicode__emoji.html#a1121b729a73cc36fb0bf2b8e3d7dc979">dpp::unicode_emoji::b</a></div><div class="ttdeci">constexpr const char b[]</div><div class="ttdef"><b>Definition:</b> unicode_emoji.h:5255</div></div>
<div class="ttc" id="astructdpp_1_1button__click__t_html"><div class="ttname"><a href="structdpp_1_1button__click__t.html">dpp::button_click_t</a></div><div class="ttdoc">Click on button.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:703</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2016</div></div>
<div class="ttc" id="astructdpp_1_1message_html"><div class="ttname"><a href="structdpp_1_1message.html">dpp::message</a></div><div class="ttdoc">Represents messages sent and received on Discord.</div><div class="ttdef"><b>Definition:</b> message.h:2034</div></div>
<div class="ttc" id="astructdpp_1_1slashcommand__t_html"><div class="ttname"><a href="structdpp_1_1slashcommand__t.html">dpp::slashcommand_t</a></div><div class="ttdoc">User has issued a slash command.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:695</div></div>
</div><!-- fragment --><p >This can be combined with <a class="el" href="classdpp_1_1when__any.html" title="Experimental class to co_await on a bunch of awaitable objects, resuming when the first one completes...">dpp::when_any</a> and other awaitables, for example <a class="el" href="classdpp_1_1cluster.html#ab960df57796742a4013c7a492f782ed8" title="Get an awaitable to wait a certain amount of seconds. Use the co_await keyword on its return value to...">dpp::cluster::co_sleep</a> to create expiring buttons.</p>
<dl class="section warning"><dt>Warning</dt><dd>On resumption the awaiter will be given <b>a reference</b> to the event. This means that variable may become dangling at the next co_await, be careful and save it in a variable if you need to. </dd></dl>
Expand Down
Loading

0 comments on commit 29ccc47

Please sign in to comment.