204 lines
27 KiB
HTML
204 lines
27 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="⚔️ discord-sdk"><meta name="keywords" content="rust, rustlang, rust-lang, discord_sdk"><title>discord_sdk - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../discord_sdk/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Crate discord_sdk</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.3.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all discord_sdk's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><div id="sidebar-vars" data-name="discord_sdk" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../discord_sdk/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">discord_sdk</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/discord_sdk/lib.rs.html#1-266" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="-discord-sdk" class="section-header"><a href="#-discord-sdk">⚔️ discord-sdk</a></h2>
|
||
<p><a href="https://embark.dev"><img src="https://img.shields.io/badge/embark-open%20source-blueviolet.svg" alt="Embark" /></a>
|
||
<a href="https://discord.gg/dAuKfZS"><img src="https://img.shields.io/badge/discord-ark-%237289da.svg?logo=discord" alt="Embark" /></a>
|
||
<a href="https://crates.io/crates/discord-sdk"><img src="https://img.shields.io/crates/v/discord-sdk.svg" alt="Crates.io" /></a>
|
||
<a href="https://docs.rs/discord-sdk"><img src="https://docs.rs/discord-sdk/badge.svg" alt="Docs" /></a>
|
||
<a href="https://deps.rs/repo/github/EmbarkStudios/discord-sdk"><img src="https://deps.rs/repo/github/EmbarkStudios/discord-sdk/status.svg" alt="dependency status" /></a>
|
||
<a href="https://github.com/EmbarkStudios/discord-sdk/actions"><img src="https://github.com/EmbarkStudios/discord-sdk/workflows/CI/badge.svg" alt="Build status" /></a></p>
|
||
<p>An (unofficial) open source Rust implementation of the <a href="https://discord.com/developers/docs/game-sdk/sdk-starter-guide">Discord Game SDK</a>.</p>
|
||
<h3 id="why-not-use-this" class="section-header"><a href="#why-not-use-this">Why not use this?</a></h3>
|
||
<ul>
|
||
<li>This project is not official and is using a largely undocumented protocol that Discord could change/break at any time in the future.</li>
|
||
<li>There is already a <a href="https://crates.io/crates/discord_game_sdk">Rust wrapper</a> for the official Game SDK.</li>
|
||
<li>Your project is not also in Rust. We may add a C API for this crate in the future, but for now this is a Rust only project.</li>
|
||
</ul>
|
||
<h3 id="why-use-this" class="section-header"><a href="#why-use-this">Why use this?</a></h3>
|
||
<ul>
|
||
<li>You use Rust for your project and want to integrate features such as <a href="https://discord.com/rich-presence">rich presence/activities</a> provided by Discord.</li>
|
||
<li>You don’t want to have a dependency on a closed source, shared library.</li>
|
||
<li>You like to live dangerously (though this library does also have some automated tests!).</li>
|
||
</ul>
|
||
<h3 id="implemented-features" class="section-header"><a href="#implemented-features">Implemented Features</a></h3><h4 id="todo-achievements" class="section-header"><a href="#todo-achievements">TODO: Achievements</a></h4><h4 id="activities-rich-presence" class="section-header"><a href="#activities-rich-presence">Activities (Rich Presence)</a></h4><h5 id="commands" class="section-header"><a href="#commands">Commands</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/activities#updateactivity">Update Activity</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/activities#clearactivity">Clear Activity</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/activities#sendrequestreply">Send Join Request Reply</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/activities#sendinvite">Send Invite</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/activities#acceptinvite">Accept Invite</a></li>
|
||
</ul>
|
||
<h5 id="events" class="section-header"><a href="#events">Events</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/activities#onactivityjoin">Join</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/activities#onactivityspectate">Spectate</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/activities#onactivityjoinrequest">Join Request</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/activities#onactivityinvite">Invite</a></li>
|
||
</ul>
|
||
<h5 id="other" class="section-header"><a href="#other">Other</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/activities#registercommand">Application Registration (Windows, Linux, Mac)</a></li>
|
||
</ul>
|
||
<h4 id="todo-applications" class="section-header"><a href="#todo-applications">TODO: Applications</a></h4><h4 id="-voice" class="section-header"><a href="#-voice">⚠️ Voice</a></h4><h5 id="commands-1" class="section-header"><a href="#commands-1">Commands</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/discord-voice#setinputmode">Set Input Mode</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/discord-voice#setselfmute">Set Self Mute</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/discord-voice#setselfdeaf">Set Self Deaf</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/discord-voice#setlocalmute">Set Local Mute</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/discord-voice#setlocalvolume">Set Local Volume</a></li>
|
||
</ul>
|
||
<h5 id="events-1" class="section-header"><a href="#events-1">Events</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<code>VOICE_SETTINGS_UPDATE_2</code> - Undocumented, but this event is fired for all voice settings changes, <em>except</em> for “Set Local Volume”.</li>
|
||
</ul>
|
||
<h4 id="todo-images" class="section-header"><a href="#todo-images">TODO: Images</a></h4><h4 id="-lobbies" class="section-header"><a href="#-lobbies">⚠️ Lobbies</a></h4><h5 id="commands-2" class="section-header"><a href="#commands-2">Commands</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#createlobby">Create Lobby</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#updatelobby">Update Lobby</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#deletelobby">Delete Lobby</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#connectlobby">Connect Lobby</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#disconnectlobby">Disconnect Lobby</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#updatemember">Update Member</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#sendlobbymessage">Send Lobby Message</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#search">Search</a> - <strong>NOTE</strong>: This seems to be completely broken and never returns results.</li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#connectvoice">Connect Voice</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#disconnectvoice">Disconnect Voice</a></li>
|
||
</ul>
|
||
<h5 id="events-2" class="section-header"><a href="#events-2">Events</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#onlobbyupdate">Lobby Update</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#onlobbydelete">Lobby Delete</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#onmemberconnect">Member Connect</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#onmemberupdate">Member Update</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#onmemberdisconnect">Member Disconnect</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#onlobbymessage">Lobby Message</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#onspeaking">Speaking</a></li>
|
||
</ul>
|
||
<h5 id="other-1" class="section-header"><a href="#other-1">Other</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox"/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/lobbies#integrated-networking">Integrated Networking</a></li>
|
||
</ul>
|
||
<h4 id="-networking" class="section-header"><a href="#-networking">⚠️ Networking</a></h4><h4 id="overlay" class="section-header"><a href="#overlay">Overlay</a></h4>
|
||
<p><strong>NOTE</strong>: These are only tested insofar as the protocol is (probably) correct, however, the overlay is currently extremely limited, and so we were unable to test that the overlay commands <em>actually</em> function correctly since our primary project is Vulkan.</p>
|
||
<blockquote>
|
||
<p><a href="https://support.discord.com/hc/en-us/articles/217659737-Games-Overlay-101">Note, there are a few other cases that overlay will not work with. The overlay is currently not supported for Mac, games with Vulkan support, and generally old games.</a></p>
|
||
</blockquote>
|
||
<p>Also note, the SDK itself and its documentation uses the utterly confusing terminology of Un/Locked when talking about the overlay, this crate instead uses <code>Visibility</code>, as in <code>Visible</code> or <code>Hidden</code>.</p>
|
||
<h5 id="commands-3" class="section-header"><a href="#commands-3">Commands</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/overlay#setlocked">Toggle Visibility</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/overlay#openactivityinvite">Open Activity Invite</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/overlay#openguildinvite">Open Guild Invite</a></li>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/overlay#openvoicesettings">Open Voice Settings</a> - <strong>NOTE</strong>: AFAICT, if your application does not have the overlay enabled (eg, because it is Vulkan or a CLI or whatnot), this will <strong>crash Discord</strong>.</li>
|
||
</ul>
|
||
<h5 id="events-3" class="section-header"><a href="#events-3">Events</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/overlay#ontoggle">Overlay Update</a></li>
|
||
</ul>
|
||
<h4 id="relationships" class="section-header"><a href="#relationships">Relationships</a></h4><h5 id="commands-4" class="section-header"><a href="#commands-4">Commands</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/relationships#first-notes">Get Relationships</a> - <strong>NOTE</strong>: This command is not really exposed directly from the regular Game SDK, but is implicitly executed by the SDK during intialization.</li>
|
||
</ul>
|
||
<h5 id="events-4" class="section-header"><a href="#events-4">Events</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/relationships#onrelationshipupdate">Relationship Update</a></li>
|
||
</ul>
|
||
<h4 id="todo-storage" class="section-header"><a href="#todo-storage">TODO: Storage</a></h4><h4 id="todo-store" class="section-header"><a href="#todo-store">TODO?: Store</a></h4><h4 id="users" class="section-header"><a href="#users">Users</a></h4><h5 id="commands-5" class="section-header"><a href="#commands-5">Commands</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/users#getcurrentuser">Get Current User</a></li>
|
||
<li><input disabled="" type="checkbox"/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/users#getuser">Get User</a></li>
|
||
</ul>
|
||
<h5 id="events-5" class="section-header"><a href="#events-5">Events</a></h5>
|
||
<ul>
|
||
<li><input disabled="" type="checkbox" checked=""/>
|
||
<a href="https://discord.com/developers/docs/game-sdk/users#oncurrentuserupdate">Current User Update</a></li>
|
||
</ul>
|
||
<h4 id="-deprecation" class="section-header"><a href="#-deprecation">⚠️ Deprecation</a></h4>
|
||
<p>This hasn’t been officially announced by Discord yet, but the <a href="#voice">Voice</a>, <a href="#lobbies">Lobbies</a>, and <a href="#networking">Networking</a> functionality will be deprecated and removed sometime in the future. Since only the lobbies functionality has been implemented thusfar, we will mark that functionality as <a href="https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-deprecated-attribute"><code>deprecated</code></a> once it is official.</p>
|
||
<h3 id="testing" class="section-header"><a href="#testing">Testing</a></h3>
|
||
<p>Unfortunately Discord does not provide a convenient way to perform automated testing, as it requires an actual working Discord application to be running and logged in, which makes automated (particularly headless) testing…annoying.</p>
|
||
<p>For now, it’s required that you manually spin up 2 different Discord applications (eg, Stable and Canary) and log in with separate accounts on the same machine, then run one test at a time.</p>
|
||
<h4 id="activities" class="section-header"><a href="#activities">Activities</a></h4><div class="example-wrap"><pre class="language-sh"><code>cargo test --features local-testing test_activity</code></pre></div><h4 id="lobbies" class="section-header"><a href="#lobbies">Lobbies</a></h4>
|
||
<p><strong>NOTE</strong>: This does not test the lobby <code>search</code> functionality as that command seems to be non-functioning and never returns results, even if the <a href="https://discord.com/developers/docs/game-sdk/lobbies#create-lobby-search">REST</a> equivalent does return the expected results.</p>
|
||
<div class="example-wrap"><pre class="language-sh"><code>cargo test --features local-testing test_lobbies</code></pre></div><h3 id="contribution" class="section-header"><a href="#contribution">Contribution</a></h3>
|
||
<p><a href="CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/contributor%20covenant-v1.4-ff69b4.svg" alt="Contributor Covenant" /></a></p>
|
||
<p>We welcome community contributions to this project.</p>
|
||
<p>Please read our <a href="CONTRIBUTING.md">Contributor Guide</a> for more information on how to get started.
|
||
Please also read our <a href="CONTRIBUTING.md/#Contributor-Terms">Contributor Terms</a> before you make any contributions.</p>
|
||
<p>Any contribution intentionally submitted for inclusion in an Embark Studios project, shall comply with the Rust standard licensing model (MIT OR Apache 2.0) and therefore be dual licensed as described below, without any additional terms or conditions:</p>
|
||
<h4 id="license" class="section-header"><a href="#license">License</a></h4>
|
||
<p>This contribution is dual licensed under EITHER OF</p>
|
||
<ul>
|
||
<li>Apache License, Version 2.0, (<a href="LICENSE-APACHE">LICENSE-APACHE</a> or <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></li>
|
||
<li>MIT license (<a href="LICENSE-MIT">LICENSE-MIT</a> or <a href="http://opensource.org/licenses/MIT">http://opensource.org/licenses/MIT</a>)</li>
|
||
</ul>
|
||
<p>at your option.</p>
|
||
<p>For clarity, “your” refers to Embark or any other licensee/user of the contribution.</p>
|
||
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left import-item"><code>pub use error::<a class="enum" href="error/enum.DiscordApiErr.html" title="enum discord_sdk::error::DiscordApiErr">DiscordApiErr</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use error::<a class="enum" href="error/enum.DiscordErr.html" title="enum discord_sdk::error::DiscordErr">DiscordErr</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use error::<a class="enum" href="error/enum.Error.html" title="enum discord_sdk::error::Error">Error</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use <a class="mod" href="../crossbeam_channel/index.html" title="mod crossbeam_channel">crossbeam_channel</a> as cc;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="activity/index.html" title="discord_sdk::activity mod">activity</a></div><div class="item-right docblock-short"><p>Provides types and functionality for <a href="https://discord.com/developers/docs/game-sdk/activities">Activities</a>
|
||
, also known as Rich Presence</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="error/index.html" title="discord_sdk::error mod">error</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="handlers/index.html" title="discord_sdk::handlers mod">handlers</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="lobby/index.html" title="discord_sdk::lobby mod">lobby</a></div><div class="item-right docblock-short"><p>Provides types and functionality for <a href="https://discord.com/developers/docs/game-sdk/lobbies">Lobbies</a></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="overlay/index.html" title="discord_sdk::overlay mod">overlay</a></div><div class="item-right docblock-short"><p>Provides types and functionality for the Discord <a href="https://discord.com/developers/docs/game-sdk/overlay">Overlay</a></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="registration/index.html" title="discord_sdk::registration mod">registration</a></div><div class="item-right docblock-short"><p>Functionality for registering an application with Discord so that Discord can
|
||
start it in the future eg. when the user accpets an invite to play the game
|
||
by another user</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="relations/index.html" title="discord_sdk::relations mod">relations</a></div><div class="item-right docblock-short"><p>Provides types and functionality for <a href="https://discord.com/developers/docs/game-sdk/relationships">Relationships</a></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="user/index.html" title="discord_sdk::user mod">user</a></div><div class="item-right docblock-short"><p>Provides types and functionality around <a href="https://discord.com/developers/docs/game-sdk/users">Users</a></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="voice/index.html" title="discord_sdk::voice mod">voice</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="wheel/index.html" title="discord_sdk::wheel mod">wheel</a></div><div class="item-right docblock-short"></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Discord.html" title="discord_sdk::Discord struct">Discord</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OffsetDateTime.html" title="discord_sdk::OffsetDateTime struct">OffsetDateTime</a></div><div class="item-right docblock-short"><p>A <a href="../time/primitive_date_time/struct.PrimitiveDateTime.html" title="PrimitiveDateTime"><code>PrimitiveDateTime</code></a> with a <a href="../time/utc_offset/struct.UtcOffset.html" title="UtcOffset"><code>UtcOffset</code></a>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Snowflake.html" title="discord_sdk::Snowflake struct">Snowflake</a></div><div class="item-right docblock-short"><p>Discord uses <a href="https://discord.com/developers/docs/reference#snowflakes">snowflakes</a>
|
||
for most/all of their unique identifiers, including users, lobbies, etc</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Subscriptions.html" title="discord_sdk::Subscriptions struct">Subscriptions</a></div><div class="item-right docblock-short"></div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.DiscordApp.html" title="discord_sdk::DiscordApp enum">DiscordApp</a></div><div class="item-right docblock-short"><p>The details on the <a href="https://discord.com/developers/docs/game-sdk/sdk-starter-guide#get-set-up">Application</a>
|
||
you’ve created in Discord.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.DiscordMsg.html" title="discord_sdk::DiscordMsg enum">DiscordMsg</a></div><div class="item-right docblock-short"><p>An event or error sent from Discord</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Event.html" title="discord_sdk::Event enum">Event</a></div><div class="item-right docblock-short"><p>An event sent from Discord to notify us of some kind of state change or
|
||
completed action.</p>
|
||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.DiscordHandler.html" title="discord_sdk::DiscordHandler trait">DiscordHandler</a></div><div class="item-right docblock-short"></div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.AppId.html" title="discord_sdk::AppId type">AppId</a></div><div class="item-right docblock-short"></div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="discord_sdk" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |