141 lines
9.9 KiB
HTML
141 lines
9.9 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="Source of the Rust file `game/game_logic/src/project_constants.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>project_constants.rs - source</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><script defer src="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[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></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"><div class="example-wrap"><pre class="line-numbers"><span id="1"> 1</span>
|
||
<span id="2"> 2</span>
|
||
<span id="3"> 3</span>
|
||
<span id="4"> 4</span>
|
||
<span id="5"> 5</span>
|
||
<span id="6"> 6</span>
|
||
<span id="7"> 7</span>
|
||
<span id="8"> 8</span>
|
||
<span id="9"> 9</span>
|
||
<span id="10">10</span>
|
||
<span id="11">11</span>
|
||
<span id="12">12</span>
|
||
<span id="13">13</span>
|
||
<span id="14">14</span>
|
||
<span id="15">15</span>
|
||
<span id="16">16</span>
|
||
<span id="17">17</span>
|
||
<span id="18">18</span>
|
||
<span id="19">19</span>
|
||
<span id="20">20</span>
|
||
<span id="21">21</span>
|
||
<span id="22">22</span>
|
||
<span id="23">23</span>
|
||
<span id="24">24</span>
|
||
<span id="25">25</span>
|
||
<span id="26">26</span>
|
||
<span id="27">27</span>
|
||
<span id="28">28</span>
|
||
<span id="29">29</span>
|
||
<span id="30">30</span>
|
||
<span id="31">31</span>
|
||
<span id="32">32</span>
|
||
<span id="33">33</span>
|
||
<span id="34">34</span>
|
||
<span id="35">35</span>
|
||
<span id="36">36</span>
|
||
<span id="37">37</span>
|
||
<span id="38">38</span>
|
||
<span id="39">39</span>
|
||
<span id="40">40</span>
|
||
<span id="41">41</span>
|
||
<span id="42">42</span>
|
||
<span id="43">43</span>
|
||
<span id="44">44</span>
|
||
<span id="45">45</span>
|
||
<span id="46">46</span>
|
||
<span id="47">47</span>
|
||
<span id="48">48</span>
|
||
<span id="49">49</span>
|
||
<span id="50">50</span>
|
||
<span id="51">51</span>
|
||
<span id="52">52</span>
|
||
<span id="53">53</span>
|
||
<span id="54">54</span>
|
||
<span id="55">55</span>
|
||
<span id="56">56</span>
|
||
<span id="57">57</span>
|
||
<span id="58">58</span>
|
||
<span id="59">59</span>
|
||
<span id="60">60</span>
|
||
<span id="61">61</span>
|
||
<span id="62">62</span>
|
||
<span id="63">63</span>
|
||
<span id="64">64</span>
|
||
<span id="65">65</span>
|
||
<span id="66">66</span>
|
||
<span id="67">67</span>
|
||
<span id="68">68</span>
|
||
</pre><pre class="rust"><code><span class="doccomment">//! The rust side of the `dist/project-constants.json` file</span>
|
||
<span class="doccomment">//! </span>
|
||
<span class="doccomment">//! ## Overview</span>
|
||
<span class="doccomment">//! </span>
|
||
<span class="doccomment">//! This file contains a structure defining all data we want to load from the project constants file.</span>
|
||
<span class="doccomment">//! Feel free to add anything you'd like here, just make sure the relavant data is also written in the JSON file so the game doesn't crash.</span>
|
||
<span class="doccomment">//! You can treat these as constants. I just prefer storing this kind of data in JSON rather than hard-coding it in the program.</span>
|
||
<span class="doccomment">//! </span>
|
||
<span class="doccomment">//! ## How this is loaded</span>
|
||
<span class="doccomment">//! </span>
|
||
<span class="doccomment">//! Somewhere in `lib.rs`, a call is made to load this through the `asset_manager`. </span>
|
||
<span class="doccomment">//! Its all already set up, so you shouldn't have to worry about the logistics.</span>
|
||
|
||
<span class="kw">use</span> <span class="ident">std::collections::HashMap</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||
|
||
<span class="doccomment">/// Constants relating to Discord</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Deserialize</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">DiscordConstants</span> {
|
||
<span class="doccomment">/// The Discord application ID</span>
|
||
<span class="kw">pub</span> <span class="ident">app_id</span>: <span class="ident">i64</span>,
|
||
|
||
<span class="doccomment">/// Artwork name mapping</span>
|
||
<span class="kw">pub</span> <span class="ident">artwork</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">String</span><span class="op">></span>,
|
||
|
||
<span class="doccomment">/// Strings</span>
|
||
<span class="kw">pub</span> <span class="ident">strings</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">String</span><span class="op">></span>,
|
||
}
|
||
|
||
<span class="doccomment">/// Constants relating to the Player</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Deserialize</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">PlayerConstants</span> {
|
||
|
||
<span class="doccomment">/// Maximum velocity, tiles per second</span>
|
||
<span class="kw">pub</span> <span class="ident">max_velocity</span>: <span class="ident">u32</span>,
|
||
|
||
<span class="doccomment">/// Acceleration, tiles per second per second</span>
|
||
<span class="kw">pub</span> <span class="ident">acceleration</span>: <span class="ident">u32</span>,
|
||
|
||
<span class="doccomment">/// Deceleration, tiles per second per second</span>
|
||
<span class="kw">pub</span> <span class="ident">deceleration</span>: <span class="ident">u32</span>,
|
||
|
||
<span class="doccomment">/// Starting size of player in tiles</span>
|
||
<span class="kw">pub</span> <span class="ident">start_size</span>: <span class="ident">f32</span>,
|
||
}
|
||
|
||
<span class="doccomment">/// This structure is filled with the contents of `dist/project-constants.json` at runtime</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Deserialize</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ProjectConstants</span> {
|
||
<span class="doccomment">/// The name of the game</span>
|
||
<span class="kw">pub</span> <span class="ident">game_name</span>: <span class="ident">String</span>,
|
||
|
||
<span class="doccomment">/// The window size to use on launch</span>
|
||
<span class="kw">pub</span> <span class="ident">base_window_size</span>: (<span class="ident">u32</span>, <span class="ident">u32</span>),
|
||
|
||
<span class="doccomment">/// The Discord constants</span>
|
||
<span class="kw">pub</span> <span class="ident">discord</span>: <span class="ident">DiscordConstants</span>,
|
||
|
||
<span class="doccomment">/// The Player constants</span>
|
||
<span class="kw">pub</span> <span class="ident">player</span>: <span class="ident">PlayerConstants</span>,
|
||
|
||
<span class="doccomment">/// The target framerate of the game</span>
|
||
<span class="kw">pub</span> <span class="ident">target_fps</span>: <span class="ident">u32</span>,
|
||
|
||
<span class="doccomment">/// The size of the game tiles</span>
|
||
<span class="kw">pub</span> <span class="ident">tile_size</span>: <span class="ident">u32</span>,
|
||
}
|
||
</code></pre></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> |