mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-12-01 10:44:56 +03:00
26 lines
30 KiB
HTML
26 lines
30 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>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="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><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">☰</div><a href='../../../game/index.html'><div class='logo-container'><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></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_agent_meter">has_agent_meter</a><a href="#method.has_common">has_common</a><a href="#method.has_minimap">has_minimap</a><a href="#method.has_speed">has_speed</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="#implementors">Implementors</a><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></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!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></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><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'>−</span>]</a></span><a class='srclink' href='../../../src/game/sandbox/gameplay/mod.rs.html#41-75' 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
|
|||
|
|
fn <a href='#tymethod.event' class='fnname'>event</a>(<br> &mut self, <br> ctx: &mut <a class="struct" href="../../../ezgui/event_ctx/struct.EventCtx.html" title="struct ezgui::event_ctx::EventCtx">EventCtx</a>, <br> app: &mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>, <br> controls: &mut <a class="struct" href="../../../game/sandbox/struct.SandboxControls.html" title="struct game::sandbox::SandboxControls">SandboxControls</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../../game/game/enum.Transition.html" title="enum game::game::Transition">Transition</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.draw' class='fnname'>draw</a>(&self, g: &mut <a class="struct" href="../../../ezgui/drawing/struct.GfxCtx.html" title="struct ezgui::drawing::GfxCtx">GfxCtx</a>, app: &<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>(&self, _: &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>(&self) -> <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>(&self) -> <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>(&self) -> <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>(&self) -> <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>(&self) -> <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_speed' class='fnname'>has_speed</a>(&self) -> <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_agent_meter' class='fnname'>has_agent_meter</a>(&self) -> <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>(&self) -> <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 id='event.v'>fn <a href='#tymethod.event' class='fnname'>event</a>(<br> &mut self, <br> ctx: &mut <a class="struct" href="../../../ezgui/event_ctx/struct.EventCtx.html" title="struct ezgui::event_ctx::EventCtx">EventCtx</a>, <br> app: &mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>, <br> controls: &mut <a class="struct" href="../../../game/sandbox/struct.SandboxControls.html" title="struct game::sandbox::SandboxControls">SandboxControls</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../../game/game/enum.Transition.html" title="enum game::game::Transition">Transition</a>></code></h3><h3 id='tymethod.draw' class='method'><code id='draw.v'>fn <a href='#tymethod.draw' class='fnname'>draw</a>(&self, g: &mut <a class="struct" href="../../../ezgui/drawing/struct.GfxCtx.html" title="struct ezgui::drawing::GfxCtx">GfxCtx</a>, app: &<a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>)</code></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 id='on_destroy.v'>fn <a href='#method.on_destroy' class='fnname'>on_destroy</a>(&self, _: &mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>)</code></h3><h3 id='method.can_move_canvas' class='method'><code id='can_move_canvas.v'>fn <a href='#method.can_move_canvas' class='fnname'>can_move_canvas</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><h3 id='method.can_examine_objects' class='method'><code id='can_examine_objects.v'>fn <a href='#method.can_examine_objects' class='fnname'>can_examine_objects</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><h3 id='method.has_common' class='method'><code id='has_common.v'>fn <a href='#method.has_common' class='fnname'>has_common</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><h3 id='method.has_tool_panel' class='method'><code id='has_tool_panel.v'>fn <a href='#method.has_tool_panel' class='fnname'>has_tool_panel</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><h3 id='method.has_time_panel' class='method'><code id='has_time_panel.v'>fn <a href='#method.has_time_panel' class='fnname'>has_time_panel</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><h3 id='method.has_speed' class='method'><code id='has_speed.v'>fn <a href='#method.has_speed' class='fnname'>has_speed</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><h3 id='method.has_agent_meter' class='method'><code id='has_agent_meter.v'>fn <a href='#method.has_agent_meter' class='fnname'>has_agent_meter</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><h3 id='method.has_minimap' class='method'><code id='has_minimap.v'>fn <a href='#method.has_minimap' class='fnname'>has_minimap</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3></div><span class='loading-content'>Loading content...</span><h2 id='implementations' class='small-section-header'>Implementations<a href='#implementations' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl dyn <a class="trait" href="../../../game/sandbox/gameplay/trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a></code><a href='#impl' class='anchor'></a></h3><div class='impl-items'><h4 id='method.is' class="method"><code id='is.v'>pub fn <a href='#method.is' class='fnname'>is</a><__T: <a class="trait" href="../../../game/sandbox/gameplay/trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h4><div class='docblock'><p>Returns true if the trait object wraps an object of type <code>__T</code>.</p>
|
|||
|
|
</div><h4 id='method.downcast' class="method"><code id='downcast.v'>pub fn <a href='#method.downcast' class='fnname'>downcast</a><__T: <a class="trait" href="../../../game/sandbox/gameplay/trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><__T>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></code></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 id='downcast_rc.v'>pub fn <a href='#method.downcast_rc' class='fnname'>downcast_rc</a><__T: <a class="trait" href="../../../game/sandbox/gameplay/trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><Self><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><__T>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><Self>></code></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 id='downcast_ref.v'>pub fn <a href='#method.downcast_ref' class='fnname'>downcast_ref</a><__T: <a class="trait" href="../../../game/sandbox/gameplay/trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>__T></code></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 id='downcast_mut.v'>pub fn <a href='#method.downcast_mut' class='fnname'>downcast_mut</a><__T: <a class="trait" href="../../../game/sandbox/gameplay/trait.GameplayState.html" title="trait game::sandbox::gameplay::GameplayState">GameplayState</a>>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>__T></code></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/commute/struct.OptimizeCommute.html" title="struct game::sandbox::gameplay::commute::OptimizeCommute">OptimizeCommute</a></code><a href='#impl-GameplayState' class='anchor'></a><a class='srclink' href='../../../src/game/sandbox/gameplay/commute.rs.html#120-216' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.event' class="method hidden"><code id='event.v-1'>fn <a href='#method.event' class='fnname'>event</a>(<br> &mut self, <br> ctx: &mut <a class="struct" href="../../../ezgui/event_ctx/struct.EventCtx.html" title="struct ezgui::event_ctx::EventCtx">EventCtx</a>, <br> app: &mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>, <br> controls: &mut <a class="struct" href="../../../game/sandbox/struct.SandboxControls.html" title="struct game::sandbox::SandboxControls">SandboxControls</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../../game/game/enum.Transition.html" title="enum game::game::Transition">Transition</a>></code><a class='srclink' href='../../../src/game/sandbox/gameplay/commute.rs.html#121-210' title='goto source code'>[src]</a></h4><h4 id='method.draw' class="method hidden"><code id='draw.v-1'>fn <a href='#method.draw' class='fnname'>draw</a>(&self, g: &mut <a class="struct" href="../../../ezgui/drawing/struct.GfxCtx.html" title="struct ezgui::drawing::GfxCtx">GfxCtx</a>, _: &<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/commute.rs.html#212-215' 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/fix_traffic_signals/struct.FixTrafficSignals.html" title="struct game::sandbox::gameplay::fix_traffic_signals::FixTrafficSignals">FixTrafficSignals</a></code><a href='#impl-GameplayState-1' class='anchor'></a><a class='srclink' href='../../../src/game/sandbox/gameplay/fix_traffic_signals.rs.html#102-283' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.event-1' class="method hidden"><code id='event.v-2'>fn <a href='#method.event-1' class='fnname'>event</a>(<br> &mut self, <br> ctx: &mut <a class="struct" href="../../../ezgui/event_ctx/struct.EventCtx.html" title="struct ezgui::event_ctx::EventCtx">EventCtx</a>, <br> app: &mut <a class="struct" href="../../../game/app/struct.App.html" title="struct game::app::App">App</a>, <br> controls: &mut <a class="struct" href="../../../game/sandbox/struct.SandboxControls.html" title="struct game::sandbox::SandboxControls">SandboxControls</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../../game/game/enum.Transition.html" title="enum game::game::Transition">Transition</a>></code><a class='srclink' href='../../../src/game/sandbox/gameplay/fix_traffic_signals.rs.html#103-271' title='goto source code'>[src]</a></h4><h4 id='method.draw-1' class="method hidden"><code id='draw.v-2'>fn <a href='#method.draw-1' class='fnname'>draw</a>(&self, g: &mut <a class="struct" href="../../../ezgui/drawing/struct.GfxCtx.html" title="struct ezgui::drawing::GfxCtx">GfxCtx</a>, _: &<a class="struct" href="../../../game/app/struct.App.html" title="struct
|