39 lines
9.4 KiB
HTML
39 lines
9.4 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="Interfacing with Discord"><meta name="keywords" content="rust, rustlang, rust-lang, discord"><title>game_logic::discord - 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"><!--[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="../../game_logic/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Module discord</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li><li><a href="#types">Type Definitions</a></li></ul></div><div id="sidebar-vars" data-name="discord" 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="../../game_logic/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">Module <a href="../index.html">game_logic</a>::<wbr><a class="mod" href="#">discord</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/game_logic/discord/mod.rs.html#1-120" 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"><p>Interfacing with Discord</p>
|
||
<h3 id="overview" class="section-header"><a href="#overview">Overview</a></h3>
|
||
<p>When the game is run at the same time as a Discord client on a computer, it will attach to the user’s
|
||
account and display <a href="https://discord.com/rich-presence">Rich Presence</a> information.</p>
|
||
<p>This is handled through the <a href="https://github.com/EmbarkStudios/discord-sdk"><code>discord-sdk</code></a> crate,
|
||
but still requires some additional code to get everything set up.</p>
|
||
<p>Our main focuses in this module are:</p>
|
||
<ul>
|
||
<li>Ensuring that the game does not crash when Discord is not running</li>
|
||
<li>Ensuring that Discord can not pause the game by taking too long to respond to an update</li>
|
||
</ul>
|
||
<p>To solve these, we run this task in its own thread, and talk to it through
|
||
Tokio’s <a href="https://docs.rs/tokio/latest/tokio/sync/mpsc/fn.channel.html"><code>mpsc</code></a>
|
||
implementation (as we are already working in an async context).</p>
|
||
<h3 id="usage" class="section-header"><a href="#usage">Usage</a></h3>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">app_id</span> <span class="op">=</span> <span class="number">123456789</span>;
|
||
|
||
<span class="comment">// Connect to discord</span>
|
||
<span class="kw">let</span> <span class="ident">discord</span> <span class="op">=</span> <span class="ident">DiscordRpcThreadHandle::new</span>(<span class="ident">app_id</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">event_loop_discord_tx</span> <span class="op">=</span> <span class="ident">discord</span>.<span class="ident">get_channel</span>();
|
||
|
||
<span class="comment">// When this variable is dropped, the connection is closed, so keep this around</span>
|
||
<span class="kw">let</span> <span class="ident">discord_task_handle</span> <span class="op">=</span> <span class="ident">discord</span>.<span class="ident">begin_thread_non_blocking</span>();
|
||
|
||
<span class="comment">// We can then send signals any time we want</span>
|
||
<span class="ident">event_loop_discord_tx</span>.<span class="ident">send</span>(<span class="ident">DiscordRpcSignal::BeginGameTimer</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();</code></pre></div>
|
||
</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 signal::<a class="enum" href="signal/enum.DiscordRpcSignal.html" title="enum game_logic::discord::signal::DiscordRpcSignal">DiscordRpcSignal</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use ipc::<a class="enum" href="ipc/enum.DiscordError.html" title="enum game_logic::discord::ipc::DiscordError">DiscordError</a>;</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="ipc/index.html" title="game_logic::discord::ipc mod">ipc</a></div><div class="item-right docblock-short"><p>Discord Rich Presence utilities</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="signal/index.html" title="game_logic::discord::signal mod">signal</a></div><div class="item-right docblock-short"><p>This file contains a system for signaling Discord RPC context changes between threads.</p>
|
||
</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.DiscordRpcThreadHandle.html" title="game_logic::discord::DiscordRpcThreadHandle struct">DiscordRpcThreadHandle</a></div><div class="item-right docblock-short"></div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.DISCORD_CONNECT_TIMEOUT_SECONDS.html" title="game_logic::discord::DISCORD_CONNECT_TIMEOUT_SECONDS constant">DISCORD_CONNECT_TIMEOUT_SECONDS</a></div><div class="item-right docblock-short"><p>How long to wait before we give up on connecting to Discord.</p>
|
||
</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.DiscordChannel.html" title="game_logic::discord::DiscordChannel type">DiscordChannel</a></div><div class="item-right docblock-short"><p>A cross-thread communication channel for sending Discord RPC events.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="game_logic" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |