mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-12-22 22:01:41 +03:00
24 lines
22 KiB
HTML
24 lines
22 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="API documentation for the Rust `GameplayState` trait in crate `game`."><meta name="keywords" content="rust, rustlang, rust-lang, GameplayState"><title>GameplayState in game::sandbox::gameplay - 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><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"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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 href='../../../game/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a><h2 class="location">Trait GameplayState</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><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><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><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><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><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><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../../index.html">game</a>::<wbr><a href="../index.html">sandbox</a>::<wbr><a href="index.html">gameplay</a></h2><div id="sidebar-vars" data-name="GameplayState" data-ty="trait" data-relpath=""></div><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" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" 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><section id="main" class="content"><h1 class="fqn"><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><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/sandbox/gameplay/mod.rs.html#48-78" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait GameplayState: Downcast {
|
||
fn <a href="#tymethod.event" class="fnname">event</a>(<br> &mut self, <br> ctx: &mut EventCtx<'_>, <br> app: &mut <a class="struct" href="../../app/struct.App.html" title="struct game::app::App">App</a>, <br> controls: &mut <a class="struct" href="../struct.SandboxControls.html" title="struct game::sandbox::SandboxControls">SandboxControls</a>, <br> actions: &mut <a class="struct" href="../struct.Actions.html" title="struct game::sandbox::Actions">Actions</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/1.58.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Transition<<a class="struct" href="../../app/struct.App.html" title="struct game::app::App">App</a>>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.draw" class="fnname">draw</a>(&self, g: &mut GfxCtx<'_>, app: &<a class="struct" href="../../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>(&mut self, ctx: &mut EventCtx<'_>, app: &<a class="struct" href="../../app/struct.App.html" title="struct game::app::App">App</a>);
|
||
|
||
fn <a href="#method.on_destroy" class="fnname">on_destroy</a>(&self, _: &mut <a class="struct" href="../../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>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.can_examine_objects" class="fnname">can_examine_objects</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.has_common" class="fnname">has_common</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.has_tool_panel" class="fnname">has_tool_panel</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.has_time_panel" class="fnname">has_time_panel</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.has_minimap" class="fnname">has_minimap</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a> { ... }
|
||
}</code></pre></div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><div id="tymethod.event" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#49-55" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.event" class="fnname">event</a>(<br> &mut self, <br> ctx: &mut EventCtx<'_>, <br> app: &mut <a class="struct" href="../../app/struct.App.html" title="struct game::app::App">App</a>, <br> controls: &mut <a class="struct" href="../struct.SandboxControls.html" title="struct game::sandbox::SandboxControls">SandboxControls</a>, <br> actions: &mut <a class="struct" href="../struct.Actions.html" title="struct game::sandbox::Actions">Actions</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.58.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Transition<<a class="struct" href="../../app/struct.App.html" title="struct game::app::App">App</a>>></h4></div><div id="tymethod.draw" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#56" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.draw" class="fnname">draw</a>(&self, g: &mut GfxCtx<'_>, app: &<a class="struct" href="../../app/struct.App.html" title="struct game::app::App">App</a>)</h4></div><div id="tymethod.recreate_panels" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#58" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.recreate_panels" class="fnname">recreate_panels</a>(&mut self, ctx: &mut EventCtx<'_>, app: &<a class="struct" href="../../app/struct.App.html" title="struct game::app::App">App</a>)</h4></div></div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><div id="method.on_destroy" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#57" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.on_destroy" class="fnname">on_destroy</a>(&self, _: &mut <a class="struct" href="../../app/struct.App.html" title="struct game::app::App">App</a>)</h4></div><div id="method.can_move_canvas" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#60-62" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.can_move_canvas" class="fnname">can_move_canvas</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a></h4></div><div id="method.can_examine_objects" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#63-65" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.can_examine_objects" class="fnname">can_examine_objects</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a></h4></div><div id="method.has_common" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#66-68" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.has_common" class="fnname">has_common</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a></h4></div><div id="method.has_tool_panel" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#69-71" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.has_tool_panel" class="fnname">has_tool_panel</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a></h4></div><div id="method.has_time_panel" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#72-74" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.has_time_panel" class="fnname">has_time_panel</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a></h4></div><div id="method.has_minimap" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#75-77" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.has_minimap" class="fnname">has_minimap</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a></h4></div></div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#79" title="goto source code">[src]</a></div><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl dyn <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.is" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#79" title="goto source code">[src]</a></div><a href="#method.is" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.is" class="fnname">is</a><__T: <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Returns true if the trait object wraps an object of type <code>__T</code>.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.downcast" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#79" title="goto source code">[src]</a></div><a href="#method.downcast" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.downcast" class="fnname">downcast</a><__T: <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>>(<br> self: <a class="struct" href="https://doc.rust-lang.org/1.58.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.58.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.58.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><__T>, <a class="struct" href="https://doc.rust-lang.org/1.58.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></div></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.downcast_rc" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#79" title="goto source code">[src]</a></div><a href="#method.downcast_rc" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.downcast_rc" class="fnname">downcast_rc</a><__T: <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>>(<br> self: <a class="struct" href="https://doc.rust-lang.org/1.58.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><Self><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.58.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.58.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><__T>, <a class="struct" href="https://doc.rust-lang.org/1.58.1/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><Self>></h4></div></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.downcast_ref" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#79" title="goto source code">[src]</a></div><a href="#method.downcast_ref" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.downcast_ref" class="fnname">downcast_ref</a><__T: <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.58.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.reference.html">&</a>__T></h4></div></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.downcast_mut" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/mod.rs.html#79" title="goto source code">[src]</a></div><a href="#method.downcast_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.downcast_mut" class="fnname">downcast_mut</a><__T: <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.58.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.reference.html">&mut </a>__T></h4></div></summary><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></details></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><div id="impl-GameplayState" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/actdev.rs.html#48-264" title="goto source code">[src]</a></div><a href="#impl-GameplayState" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a> for <a class="struct" href="actdev/struct.Actdev.html" title="struct game::sandbox::gameplay::actdev::Actdev">Actdev</a></h3></div><div id="impl-GameplayState-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/commute.rs.html#101-218" title="goto source code">[src]</a></div><a href="#impl-GameplayState-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a> for <a class="struct" href="commute/struct.OptimizeCommute.html" title="struct game::sandbox::gameplay::commute::OptimizeCommute">OptimizeCommute</a></h3></div><div id="impl-GameplayState-2" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/fix_traffic_signals.rs.html#84-319" title="goto source code">[src]</a></div><a href="#impl-GameplayState-2" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a> for <a class="struct" href="fix_traffic_signals/struct.FixTrafficSignals.html" title="struct game::sandbox::gameplay::fix_traffic_signals::FixTrafficSignals">FixTrafficSignals</a></h3></div><div id="impl-GameplayState-3" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/freeform/mod.rs.html#40-169" title="goto source code">[src]</a></div><a href="#impl-GameplayState-3" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a> for <a class="struct" href="freeform/struct.Freeform.html" title="struct game::sandbox::gameplay::freeform::Freeform">Freeform</a></h3></div><div id="impl-GameplayState-4" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/play_scenario.rs.html#53-208" title="goto source code">[src]</a></div><a href="#impl-GameplayState-4" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a> for <a class="struct" href="play_scenario/struct.PlayScenario.html" title="struct game::sandbox::gameplay::play_scenario::PlayScenario">PlayScenario</a></h3></div><div id="impl-GameplayState-5" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/game/sandbox/gameplay/tutorial.rs.html#357-462" title="goto source code">[src]</a></div><a href="#impl-GameplayState-5" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a> for <a class="struct" href="tutorial/struct.Tutorial.html" title="struct game::sandbox::gameplay::tutorial::Tutorial">Tutorial</a></h3></div></div><script type="text/javascript" src="../../../implementors/game/sandbox/gameplay/trait.GameplayState.js" async></script></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="game" data-search-index-js="../../../search-index.js" data-search-js="../../../search.js"></div>
|
||
</body></html> |