abstreet/rustdoc/game/info/trait.ContextualActions.html

8 lines
14 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 `ContextualActions` trait in crate `game`."><meta name="keywords" content="rust, rustlang, rust-lang, ContextualActions"><title>game::info::ContextualActions - 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">&#9776;</div><a href='../../game/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait ContextualActions</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.actions">actions</a><a href="#tymethod.execute">execute</a><a href="#tymethod.gameplay_mode">gameplay_mode</a><a href="#tymethod.is_paused">is_paused</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'>info</a></p><script>window.sidebarCurrent = {name: 'ContextualActions', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/game/info/mod.rs.html#692-707' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>game</a>::<wbr><a href='index.html'>info</a>::<wbr><a class="trait" href=''>ContextualActions</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait ContextualActions {
fn <a href='#tymethod.actions' class='fnname'>actions</a>(&amp;self, app: &amp;<a class="struct" href="../../game/app/struct.App.html" title="struct game::app::App">App</a>, id: <a class="enum" href="../../game/helpers/enum.ID.html" title="enum game::helpers::ID">ID</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Key, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.execute' class='fnname'>execute</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, <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;id: <a class="enum" href="../../game/helpers/enum.ID.html" title="enum game::helpers::ID">ID</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;action: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;close_panel: &amp;mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <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.is_paused' class='fnname'>is_paused</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='#tymethod.gameplay_mode' class='fnname'>gameplay_mode</a>(&amp;self) -&gt; <a class="enum" href="../../game/sandbox/gameplay/enum.GameplayMode.html" title="enum game::sandbox::gameplay::GameplayMode">GameplayMode</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.actions' class='method'><code>fn <a href='#tymethod.actions' class='fnname'>actions</a>(&amp;self, app: &amp;<a class="struct" href="../../game/app/struct.App.html" title="struct game::app::App">App</a>, id: <a class="enum" href="../../game/helpers/enum.ID.html" title="enum game::helpers::ID">ID</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Key, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;</code></h3><h3 id='tymethod.execute' class='method'><code>fn <a href='#tymethod.execute' class='fnname'>execute</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut EventCtx, <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;id: <a class="enum" href="../../game/helpers/enum.ID.html" title="enum game::helpers::ID">ID</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;action: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;close_panel: &amp;mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; <a class="enum" href="../../game/game/enum.Transition.html" title="enum game::game::Transition">Transition</a></code></h3><h3 id='tymethod.is_paused' class='method'><code>fn <a href='#tymethod.is_paused' class='fnname'>is_paused</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><h3 id='tymethod.gameplay_mode' class='method'><code>fn <a href='#tymethod.gameplay_mode' class='fnname'>gameplay_mode</a>(&amp;self) -&gt; <a class="enum" href="../../game/sandbox/gameplay/enum.GameplayMode.html" title="enum game::sandbox::gameplay::GameplayMode">GameplayMode</a></code></h3></div><span class='loading-content'>Loading content...</span>
<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-ContextualActions' class='impl'><code class='in-band'>impl ContextualActions for game::debug::<a class="struct" href="../../game/debug/struct.Actions.html" title="struct game::debug::Actions">Actions</a></code><a href='#impl-ContextualActions' class='anchor'></a><a class='srclink' href='../../src/game/debug/mod.rs.html#453-644' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.actions' class="method hidden"><code>fn <a href='#method.actions' class='fnname'>actions</a>(&amp;self, app: &amp;<a class="struct" href="../../game/app/struct.App.html" title="struct game::app::App">App</a>, id: <a class="enum" href="../../game/helpers/enum.ID.html" title="enum game::helpers::ID">ID</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Key, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;</code><a class='srclink' href='../../src/game/debug/mod.rs.html#454-491' title='goto source code'>[src]</a></h4><h4 id='method.execute' class="method hidden"><code>fn <a href='#method.execute' class='fnname'>execute</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut EventCtx, <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;id: <a class="enum" href="../../game/helpers/enum.ID.html" title="enum game::helpers::ID">ID</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;action: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;close_info: &amp;mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -&gt; <a class="enum" href="../../game/game/enum.Transition.html" title="enum game::game::Transition">Transition</a></code><a class='srclink' href='../../src/game/debug/mod.rs.html#493-634' title='goto source code'>[src]</a></h4><h4 id='method.is_paused' class="method hidden"><code>fn <a href='#method.is_paused' class='fnname'>is_paused</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/debug/mod.rs.html#636-638' title='goto source code'>[src]</a></h4><h4 id='method.gameplay_mode' class="method hidden"><code>fn <a href='#method.gameplay_mode' class='fnname'>gameplay_mode</a>(&amp;self) -&gt; <a class="enum" href="../../game/sandbox/gameplay/enum.GameplayMode.html" title="enum game::sandbox::gameplay::GameplayMode">GameplayMode</a></code><a class='srclink' href='../../src/game/debug/mod.rs.html#640-643' title='goto source code'>[src]</a></h4></div><h3 id='impl-ContextualActions-1' class='impl'><code class='in-band'>impl ContextualActions for game::sandbox::<a class="struct" href="../../game/sandbox/struct.Actions.html" title="struct game::sandbox::Actions">Actions</a></code><a href='#impl-ContextualActions-1' class='anchor'></a><a class='srclink' href='../../src/game/sandbox/mod.rs.html#393-500' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.actions-1' class="method hidden"><code>fn <a href='#method.actions-1' class='fnname'>actions</a>(&amp;self, app: &amp;<a class="struct" href="../../game/app/struct.App.html" title="struct game::app::App">App</a>, id: <a class="enum" href="../../game/helpers/enum.ID.html" title="enum game::helpers::ID">ID</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec: