abstreet/rustdoc/game/info/trait.ContextualActions.html
2022-05-21 16:24:57 +00:00

13 lines
13 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>ContextualActions in game::info - Rust</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>
<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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../game/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../game/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">ContextualActions</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.actions">actions</a></li><li><a href="#tymethod.execute">execute</a></li><li><a href="#tymethod.gameplay_mode">gameplay_mode</a></li><li><a href="#tymethod.is_paused">is_paused</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In game::info</a></h2><div id="sidebar-vars" data-name="ContextualActions" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../game/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><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><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></h1><span class="out-of-band"><a class="srclink" href="../../src/game/info/mod.rs.html#837-852">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait ContextualActions {
fn <a href="#tymethod.actions" class="fnname">actions</a>(&amp;self, app: &amp;<a class="struct" href="../app/struct.App.html" title="struct game::app::App">App</a>, id: <a class="enum" href="../../map_gui/enum.ID.html" title="enum map_gui::ID">ID</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.tuple.html">(</a>Key, <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.tuple.html">)</a>&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.u8.html">u8</a>, A&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;A&gt; <a class="trait" href="https://doc.rust-lang.org/1.61.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.u8.html">u8</a>, A&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="https://doc.rust-lang.org/1.61.0/core/alloc/trait.Allocator.html" title="trait core::alloc::Allocator">Allocator</a>,&nbsp;</span></span></code></span></span></span></span>;
<span class="item-spacer"></span> 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&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;app: &amp;mut <a class="struct" href="../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="../../map_gui/enum.ID.html" title="enum map_gui::ID">ID</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;action: <a class="struct" href="https://doc.rust-lang.org/1.61.0/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/1.61.0/std/primitive.bool.html">bool</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; Transition&lt;<a class="struct" href="../app/struct.App.html" title="struct game::app::App">App</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.is_paused" class="fnname">is_paused</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.bool.html">bool</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.gameplay_mode" class="fnname">gameplay_mode</a>(&amp;self) -&gt; <a class="enum" href="../sandbox/gameplay/enum.GameplayMode.html" title="enum game::sandbox::gameplay::GameplayMode">GameplayMode</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.actions" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/game/info/mod.rs.html#839">source</a></div><h4 class="code-header">fn <a href="#tymethod.actions" class="fnname">actions</a>(&amp;self, app: &amp;<a class="struct" href="../app/struct.App.html" title="struct game::app::App">App</a>, id: <a class="enum" href="../../map_gui/enum.ID.html" title="enum map_gui::ID">ID</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.tuple.html">(</a>Key, <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a><a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.tuple.html">)</a>&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.u8.html">u8</a>, A&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;A&gt; <a class="trait" href="https://doc.rust-lang.org/1.61.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.u8.html">u8</a>, A&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="https://doc.rust-lang.org/1.61.0/core/alloc/trait.Allocator.html" title="trait core::alloc::Allocator">Allocator</a>,&nbsp;</span></span></code></span></span></span></span></h4></div><div id="tymethod.execute" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/game/info/mod.rs.html#840-847">source</a></div><h4 class="code-header">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&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;app: &amp;mut <a class="struct" href="../app/struct.App.html" title="struct game::app::App">App</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;id: <a class="enum" href="../../map_gui/enum.ID.html" title="enum map_gui::ID">ID</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;action: <a class="struct" href="https://doc.rust-lang.org/1.61.0/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/1.61.0/std/primitive.bool.html">bool</a><br>) -&gt; Transition&lt;<a class="struct" href="../app/struct.App.html" title="struct game::app::App">App</a>&gt;</h4></div><div id="tymethod.is_paused" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/game/info/mod.rs.html#850">source</a></div><h4 class="code-header">fn <a href="#tymethod.is_paused" class="fnname">is_paused</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.bool.html">bool</a></h4></div><div id="tymethod.gameplay_mode" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/game/info/mod.rs.html#851">source</a></div><h4 class="code-header">fn <a href="#tymethod.gameplay_mode" class="fnname">gameplay_mode</a>(&amp;self) -&gt; <a class="enum" href="../sandbox/gameplay/enum.GameplayMode.html" title="enum game::sandbox::gameplay::GameplayMode">GameplayMode</a></h4></div></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-ContextualActions" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/game/debug/mod.rs.html#594-865">source</a></span><a href="#impl-ContextualActions" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.ContextualActions.html" title="trait game::info::ContextualActions">ContextualActions</a> for game::debug::<a class="struct" href="../debug/struct.Actions.html" title="struct game::debug::Actions">Actions</a></h3></section><section id="impl-ContextualActions-1" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/game/sandbox/mod.rs.html#307-428">source</a></span><a href="#impl-ContextualActions-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.ContextualActions.html" title="trait game::info::ContextualActions">ContextualActions</a> for game::sandbox::<a class="struct" href="../sandbox/struct.Actions.html" title="struct game::sandbox::Actions">Actions</a></h3></section></div><script type="text/javascript" src="../../implementors/game/info/trait.ContextualActions.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="game" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.61.0 (fe5b13d68 2022-05-18)" ></div>
</body></html>