173 lines
14 KiB
HTML
173 lines
14 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/model/world_object.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>world_object.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>
|
||
<span id="69">69</span>
|
||
<span id="70">70</span>
|
||
<span id="71">71</span>
|
||
<span id="72">72</span>
|
||
<span id="73">73</span>
|
||
<span id="74">74</span>
|
||
<span id="75">75</span>
|
||
<span id="76">76</span>
|
||
<span id="77">77</span>
|
||
<span id="78">78</span>
|
||
<span id="79">79</span>
|
||
<span id="80">80</span>
|
||
<span id="81">81</span>
|
||
<span id="82">82</span>
|
||
<span id="83">83</span>
|
||
<span id="84">84</span>
|
||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::collections::HashMap</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">nalgebra</span> <span class="kw">as</span> <span class="ident">na</span>;
|
||
<span class="kw">use</span> <span class="ident">serde::Deserialize</span>;
|
||
|
||
<span class="kw">use</span> <span class="kw">crate</span>::{
|
||
<span class="ident">asset_manager</span>::{<span class="ident">load_json_structure</span>, <span class="ident">InternalJsonLoadError</span>},
|
||
<span class="ident">rendering::utilities::anim_texture::AnimatedTexture</span>,
|
||
};
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">PossiblyAnimatedTexture</span> {
|
||
<span class="doccomment">/// Signal if the texture is animated or static</span>
|
||
<span class="kw">pub</span> <span class="ident">animated</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">bool</span><span class="op">></span>,
|
||
<span class="doccomment">/// Relative file path from `dist` to the texture</span>
|
||
<span class="kw">pub</span> <span class="ident">file_path</span>: <span class="ident">String</span>,
|
||
}
|
||
|
||
<span class="doccomment">/// Defines a collider in object space.</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ObjectCollider</span> {
|
||
<span class="doccomment">/// Position, relative to the object's center (north east is 1,1 south west is -1,-1)</span>
|
||
<span class="kw">pub</span> <span class="ident">position</span>: <span class="ident">na::Vector2</span><span class="op"><</span><span class="ident">f32</span><span class="op">></span>,
|
||
<span class="doccomment">/// Possible sizing</span>
|
||
<span class="kw">pub</span> <span class="ident">size</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">na::Vector2</span><span class="op"><</span><span class="ident">f32</span><span class="op">></span><span class="op">></span>,
|
||
}
|
||
|
||
<span class="comment">// Handy aliases</span>
|
||
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">ObjectSpaceObjectCollider</span> <span class="op">=</span> <span class="ident">ObjectCollider</span>;
|
||
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">WorldSpaceObjectCollider</span> <span class="op">=</span> <span class="ident">ObjectCollider</span>;
|
||
|
||
<span class="doccomment">/// Definition of an object. Only one of these should exist *per object*, and they will be GPU instanced.</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">WorldObject</span> {
|
||
<span class="doccomment">/// Object name. Must match the name of the texture</span>
|
||
<span class="kw">pub</span> <span class="ident">name</span>: <span class="ident">String</span>,
|
||
<span class="doccomment">/// The object's bottom texture</span>
|
||
<span class="kw">pub</span> <span class="ident">bottom_texture</span>: <span class="ident">PossiblyAnimatedTexture</span>,
|
||
<span class="doccomment">/// The object's top texture</span>
|
||
<span class="kw">pub</span> <span class="ident">top_texture</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">PossiblyAnimatedTexture</span><span class="op">></span>,
|
||
<span class="doccomment">/// colliders describing the object's footprint</span>
|
||
<span class="kw">pub</span> <span class="ident">footprint</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">ObjectSpaceObjectCollider</span><span class="op">></span>,
|
||
<span class="doccomment">/// A "sphere of influence" for the object. This is used for showing under the roof</span>
|
||
<span class="kw">pub</span> <span class="ident">visualization_radius</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">f32</span><span class="op">></span>,
|
||
<span class="doccomment">/// Colliders for physics</span>
|
||
<span class="kw">pub</span> <span class="ident">physics_colliders</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">ObjectSpaceObjectCollider</span><span class="op">></span>,
|
||
<span class="doccomment">/// Temperature</span>
|
||
<span class="kw">pub</span> <span class="ident">temperature</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">f32</span><span class="op">></span>,
|
||
<span class="doccomment">/// Friction</span>
|
||
<span class="kw">pub</span> <span class="ident">friction</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">f32</span><span class="op">></span>,
|
||
}
|
||
|
||
<span class="doccomment">/// Used to reference an object in the world definition</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Deserialize</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">WorldObjectRef</span> {
|
||
<span class="doccomment">/// Object type</span>
|
||
<span class="attribute">#[<span class="ident">serde</span>(<span class="ident">rename</span> <span class="op">=</span> <span class="string">"type"</span>)]</span>
|
||
<span class="kw">pub</span> <span class="ident">kind</span>: <span class="ident">String</span>,
|
||
<span class="doccomment">/// Object name</span>
|
||
<span class="kw">pub</span> <span class="ident">name</span>: <span class="ident">String</span>,
|
||
<span class="doccomment">/// Variant name</span>
|
||
<span class="kw">pub</span> <span class="ident">variant</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>,
|
||
<span class="doccomment">/// Object position (tile-space *not* pixel-space). 1,1 being up and to the right</span>
|
||
<span class="ident">position</span>: <span class="ident">na::Vector2</span><span class="op"><</span><span class="ident">f32</span><span class="op">></span>,
|
||
<span class="doccomment">/// Object rotation, positive is clockwise</span>
|
||
<span class="kw">pub</span> <span class="ident">rotation_degrees</span>: <span class="ident">f32</span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">WorldObjectRef</span> {
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_key</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">String</span> {
|
||
<span class="macro">format!</span>(
|
||
<span class="string">"{}:{}:{}"</span>,
|
||
<span class="self">self</span>.<span class="ident">kind</span>,
|
||
<span class="self">self</span>.<span class="ident">name</span>,
|
||
<span class="self">self</span>.<span class="ident">variant</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap_or</span>(<span class="kw-2">&</span><span class="string">"default"</span>.<span class="ident">to_string</span>())
|
||
)
|
||
}
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_world_space_position</span>(<span class="kw-2">&</span><span class="self">self</span>)-> <span class="ident">na::Vector2</span><span class="op"><</span><span class="ident">f32</span><span class="op">></span> {
|
||
<span class="self">self</span>.<span class="ident">position</span> <span class="op">*</span> <span class="number">128.0</span>
|
||
}
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_tile_space_position</span>(<span class="kw-2">&</span><span class="self">self</span>)-> <span class="ident">na::Vector2</span><span class="op"><</span><span class="ident">f32</span><span class="op">></span> {
|
||
<span class="self">self</span>.<span class="ident">position</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> |