abstreet/rustdoc/game/sandbox/gameplay/trait.GameplayState.html

25 lines
35 KiB
HTML
Raw Normal View History

<!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="API documentation for the Rust `GameplayState` trait in crate `game`."><meta name="keywords" content="rust, rustlang, rust-lang, GameplayState"><title>game::sandbox::gameplay::GameplayState - Rust</title><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="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../../game/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a><p class="location">Trait GameplayState</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.draw">draw</a><a href="#tymethod.event">event</a><a href="#tymethod.recreate_panels">recreate_panels</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.can_examine_objects">can_examine_objects</a><a href="#method.can_move_canvas">can_move_canvas</a><a href="#method.has_common">has_common</a><a href="#method.has_minimap">has_minimap</a><a href="#method.has_time_panel">has_time_panel</a><a href="#method.has_tool_panel">has_tool_panel</a><a href="#method.on_destroy">on_destroy</a></div><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.downcast">downcast</a><a href="#method.downcast_mut">downcast_mut</a><a href="#method.downcast_rc">downcast_rc</a><a href="#method.downcast_ref">downcast_ref</a><a href="#method.is">is</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../../index.html">game</a>::<wbr><a href="../index.html">sandbox</a>::<wbr><a href="index.html">gameplay</a></p><script>window.sidebarCurrent = {name: "GameplayState", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><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" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><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">&#x2212;</span>]</a></span><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#48-78" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../../index.html">game</a>::<wbr><a href="../index.html">sandbox</a>::<wbr><a href="index.html">gameplay</a>::<wbr><a class="trait" href="">GameplayState</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait GameplayState: Downcast {
fn <a href="#tymethod.event" class="fnname">event</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;app: &amp;mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;controls: &amp;mut <a class="struct" href="../../../game/sandbox/struct.SandboxControls.html" title="struct game::sandbox::SandboxControls">SandboxControls</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;actions: &amp;mut <a class="struct" href="../../../game/sandbox/struct.Actions.html" title="struct game::sandbox::Actions">Actions</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Transition&lt;<a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>&gt;&gt;;
<div class="item-spacer"></div> fn <a href="#tymethod.draw" class="fnname">draw</a>(&amp;self, g: &amp;mut GfxCtx&lt;'_&gt;, app: &amp;<a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>);
<div class="item-spacer"></div> fn <a href="#tymethod.recreate_panels" class="fnname">recreate_panels</a>(&amp;mut self, ctx: &amp;mut EventCtx&lt;'_&gt;, app: &amp;<a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>);
fn <a href="#method.on_destroy" class="fnname">on_destroy</a>(&amp;self, _: &amp;mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>) { ... }
<div class="item-spacer"></div> fn <a href="#method.can_move_canvas" class="fnname">can_move_canvas</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class="item-spacer"></div> fn <a href="#method.can_examine_objects" class="fnname">can_examine_objects</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class="item-spacer"></div> fn <a href="#method.has_common" class="fnname">has_common</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class="item-spacer"></div> fn <a href="#method.has_tool_panel" class="fnname">has_tool_panel</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class="item-spacer"></div> fn <a href="#method.has_time_panel" class="fnname">has_time_panel</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class="item-spacer"></div> fn <a href="#method.has_minimap" class="fnname">has_minimap</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
}</pre></div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.event" class="method"><code>fn <a href="#tymethod.event" class="fnname">event</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;app: &amp;mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;controls: &amp;mut <a class="struct" href="../../../game/sandbox/struct.SandboxControls.html" title="struct game::sandbox::SandboxControls">SandboxControls</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;actions: &amp;mut <a class="struct" href="../../../game/sandbox/struct.Actions.html" title="struct game::sandbox::Actions">Actions</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Transition&lt;<a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>&gt;&gt;</code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#49-55" title="goto source code">[src]</a></h3><h3 id="tymethod.draw" class="method"><code>fn <a href="#tymethod.draw" class="fnname">draw</a>(&amp;self, g: &amp;mut GfxCtx&lt;'_&gt;, app: &amp;<a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>)</code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#56" title="goto source code">[src]</a></h3><h3 id="tymethod.recreate_panels" class="method"><code>fn <a href="#tymethod.recreate_panels" class="fnname">recreate_panels</a>(&amp;mut self, ctx: &amp;mut EventCtx&lt;'_&gt;, app: &amp;<a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>)</code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#58" title="goto source code">[src]</a></h3></div><span class="loading-content">Loading content...</span><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.on_destroy" class="method"><code>fn <a href="#method.on_destroy" class="fnname">on_destroy</a>(&amp;self, _: &amp;mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>)</code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#57" title="goto source code">[src]</a></h3><h3 id="method.can_move_canvas" class="method"><code>fn <a href="#method.can_move_canvas" class="fnname">can_move_canvas</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#60-62" title="goto source code">[src]</a></h3><h3 id="method.can_examine_objects" class="method"><code>fn <a href="#method.can_examine_objects" class="fnname">can_examine_objects</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#63-65" title="goto source code">[src]</a></h3><h3 id="method.has_common" class="method"><code>fn <a href="#method.has_common" class="fnname">has_common</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#66-68" title="goto source code">[src]</a></h3><h3 id="method.has_tool_panel" class="method"><code>fn <a href="#method.has_tool_panel" class="fnname">has_tool_panel</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#69-71" title="goto source code">[src]</a></h3><h3 id="method.has_time_panel" class="method"><code>fn <a href="#method.has_time_panel
</div><h4 id="method.downcast" class="method"><code>pub fn <a href="#method.downcast" class="fnname">downcast</a>&lt;__T:&nbsp;<a class="trait" href="../../../game/sandbox/gameplay/trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;__T&gt;, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;&gt;</code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#79" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a boxed object from a boxed trait object if the underlying object is of type
<code>__T</code>. Returns the original boxed trait if it isn't.</p>
</div><h4 id="method.downcast_rc" class="method"><code>pub fn <a href="#method.downcast_rc" class="fnname">downcast_rc</a>&lt;__T:&nbsp;<a class="trait" href="../../../game/sandbox/gameplay/trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Self&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;__T&gt;, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Self&gt;&gt;</code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#79" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns an <code>Rc</code>-ed object from an <code>Rc</code>-ed trait object if the underlying object is of
type <code>__T</code>. Returns the original <code>Rc</code>-ed trait if it isn't.</p>
</div><h4 id="method.downcast_ref" class="method"><code>pub fn <a href="#method.downcast_ref" class="fnname">downcast_ref</a>&lt;__T:&nbsp;<a class="trait" href="../../../game/sandbox/gameplay/trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>&gt;(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>__T&gt;</code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#79" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the object within the trait object if it is of type <code>__T</code>, or
<code>None</code> if it isn't.</p>
</div><h4 id="method.downcast_mut" class="method"><code>pub fn <a href="#method.downcast_mut" class="fnname">downcast_mut</a>&lt;__T:&nbsp;<a class="trait" href="../../../game/sandbox/gameplay/trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>&gt;(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>__T&gt;</code><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#79" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the object within the trait object if it is of type
<code>__T</code>, or <code>None</code> if it isn't.</p>
</div></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-GameplayState" class="impl"><code class="in-band">impl GameplayState for <a class="struct" href="../../../game/sandbox/gameplay/actdev/struct.Actdev.html" title="struct game::sandbox::gameplay::actdev::Actdev">Actdev</a></code><a href="#impl-GameplayState" class="anchor"></a><a class="srclink" href="../../../src/game/sandbox/gameplay/actdev.rs.html#48-260" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.event" class="method hidden"><code>fn <a href="#method.event" class="fnname">event</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;app: &amp;mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;controls: &amp;mut <a class="struct" href="../../../game/sandbox/struct.SandboxControls.html" title="struct game::sandbox::SandboxControls">SandboxControls</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;actions: &amp;mut <a class="struct" href="../../../game/sandbox/struct.Actions.html" title="struct game::sandbox::Actions">Actions</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Transition&lt;<a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>&gt;&gt;</code><a class="srclink" href="../../../src/game/sandbox/gameplay/actdev.rs.html#49-190" title="goto source code">[src]</a></h4><h4 id="method.draw" class="method hidden"><code>fn <a href="#method.draw" class="fnname">draw</a>(&amp;self, g: &amp;mut GfxCtx&lt;'_&gt;, _: &amp;<a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>)</code><a class="srclink" href="../../../src/game/sandbox/gameplay/actdev.rs.html#192-194" title="goto source code">[src]</a></h4><h4 id="method.recreate_panels" class="method hidden"><code>fn <a href="#method.recreate_panels" class="fnname">recreate_panels</a>(&amp;mut self, ctx: &amp;mut EventCtx&lt;'_&gt;, app: &amp;<a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>)</code><a class="srclink" href="../../../src/game/sandbox/gameplay/actdev.rs.html#196-254" title="goto source code">[src]</a></h4><h4 id="method.has_tool_panel-1" class="method hidden"><code>fn <a href="#method.has_tool_panel-1" class="fnname">has_tool_panel</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../../src/game/sandbox/gameplay/actdev.rs.html#256-259" title="goto source code">[src]</a></h4></div><h3 id="impl-GameplayState-1" class="impl"><code class="in-band">impl GameplayState for <a class="struct" href="../../../game/sandbox/gameplay/commute/struct.OptimizeCommute.html" title="struct game::sandbox::gameplay::commute::OptimizeCommute">OptimizeCommute</a></code><a href="#impl-GameplayState-1" class="anchor"></a><a class="srclink" href="../../../src/game/sandbox/gameplay/commute.rs.html#101-207" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.event-1" class="method hidden"><code>fn <a href="#method.event-1" class="fnname">event</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;app: &amp;mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;controls: &amp;mut <a class="struct" href="../../../game/sandbox/struct.SandboxControls.html" title="struct game::sandbox::SandboxControls">SandboxControls</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;actions: &amp;mut <a class="struct" href="../../../game/sandbox/struct.Actions.html" title="struct game::sandbox::Actions">Actions</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang