Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 06:16:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/3.x/api/evennia.contrib.tutorials.tutorial_world.intro_menu.html

341 lines
29 KiB
HTML
Raw Normal View History

Add 3.x legacy documentation
2023-12-20 23:10:55 +01:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
Fix 3.x legacy doc versioning
2023-12-21 00:12:31 +01:00
<title>evennia.contrib.tutorials.tutorial_world.intro_menu &#8212; Evennia 3.x documentation</title>
Add 3.x legacy documentation
2023-12-20 23:10:55 +01:00
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.contrib.tutorials.tutorial_world.mob" href="evennia.contrib.tutorials.tutorial_world.mob.html" />
<link rel="prev" title="evennia.contrib.tutorials.tutorial_world" href="evennia.contrib.tutorials.tutorial_world.html" />
</head><body>
<div class="admonition important">
<p class="first admonition-title">Note</p>
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.tutorial_world.mob.html" title="evennia.contrib.tutorials.tutorial_world.mob"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.tutorial_world.html" title="evennia.contrib.tutorials.tutorial_world"
accesskey="P">previous</a> |</li>
Fix 3.x legacy doc versioning
2023-12-21 00:12:31 +01:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 3.x</a> &#187;</li>
Add 3.x legacy documentation
2023-12-20 23:10:55 +01:00
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.tutorial_world.html" accesskey="U">evennia.contrib.tutorials.tutorial_world</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.tutorial_world.intro_menu</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.tutorials.tutorial_world.html"
title="previous chapter">evennia.contrib.tutorials.tutorial_world</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.tutorials.tutorial_world.mob.html"
title="next chapter">evennia.contrib.tutorials.tutorial_world.mob</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.tutorials.tutorial_world.intro_menu.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.tutorials.tutorial_world.intro_menu">
<span id="evennia-contrib-tutorials-tutorial-world-intro-menu"></span><h1>evennia.contrib.tutorials.tutorial_world.intro_menu<a class="headerlink" href="#module-evennia.contrib.tutorials.tutorial_world.intro_menu" title="Permalink to this headline"></a></h1>
<p>Intro menu / game tutor</p>
<p>Evennia contrib - Griatch 2020</p>
<p>This contrib is an intro-menu for general MUD and evennia usage using the
EvMenu menu-templating system.</p>
<p>EvMenu templating is a way to create a menu using a string-format instead
of creating all nodes manually. Of course, for full functionality one must
still create the goto-callbacks.</p>
<dl class="py function">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.do_nothing">
<code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">do_nothing</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#do_nothing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.do_nothing" title="Permalink to this definition"></a></dt>
<dd><p>Re-runs the current node</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.send_testing_tagged">
<code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">send_testing_tagged</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#send_testing_tagged"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.send_testing_tagged" title="Permalink to this definition"></a></dt>
<dd><p>Test to send a message to a pane tagged with ‘testing’ in the webclient.</p>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">DemoCommandSetHelp</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#DemoCommandSetHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Demo the help command</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.key">
<code class="sig-name descname">key</code><em class="property"> = 'Help Demo Set'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.priority">
<code class="sig-name descname">priority</code><em class="property"> = 2</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.priority" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#DemoCommandSetHelp.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>Hook method - this should be overloaded in the inheriting
class, and should take care of populating the cmdset by use of
self.add().</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_help">
<code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">goto_command_demo_help</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#goto_command_demo_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_help" title="Permalink to this definition"></a></dt>
<dd><p>Sets things up before going to the help-demo node</p>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">DemoCommandSetComms</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#DemoCommandSetComms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Demo communications</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.key">
<code class="sig-name descname">key</code><em class="property"> = 'Color Demo Set'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.priority">
<code class="sig-name descname">priority</code><em class="property"> = 2</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.priority" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.no_exits">
<code class="sig-name descname">no_exits</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.no_exits" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.no_objs">
<code class="sig-name descname">no_objs</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.no_objs" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#DemoCommandSetComms.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>Hook method - this should be overloaded in the inheriting
class, and should take care of populating the cmdset by use of
self.add().</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_comms">
<code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">goto_command_demo_comms</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#goto_command_demo_comms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_comms" title="Permalink to this definition"></a></dt>
<dd><p>Setup and go to the color demo node.</p>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">DemoCommandSetRoom</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#DemoCommandSetRoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
<p>Demo some general in-game commands command.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.key">
<code class="sig-name descname">key</code><em class="property"> = 'Room Demo Set'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.priority">
<code class="sig-name descname">priority</code><em class="property"> = 2</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.priority" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.no_exits">
<code class="sig-name descname">no_exits</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.no_exits" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.no_objs">
<code class="sig-name descname">no_objs</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.no_objs" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.at_cmdset_creation">
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#DemoCommandSetRoom.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.at_cmdset_creation" title="Permalink to this definition"></a></dt>
<dd><p>Hook method - this should be overloaded in the inheriting
class, and should take care of populating the cmdset by use of
self.add().</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom'</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_room">
<code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">goto_command_demo_room</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_string</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#goto_command_demo_room"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_room" title="Permalink to this definition"></a></dt>
<dd><p>Setup and go to the demo-room node. Generates a little 2-room environment
for testing out some commands.</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.goto_cleanup_cmdsets">
<code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">goto_cleanup_cmdsets</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">raw_strings</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#goto_cleanup_cmdsets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_cleanup_cmdsets" title="Permalink to this definition"></a></dt>
<dd><p>Cleanup all cmdsets.</p>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">TutorialEvMenu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">menudata</span></em>, <em class="sig-param"><span class="n">startnode</span><span class="o">=</span><span class="default_value">'start'</span></em>, <em class="sig-param"><span class="n">cmdset_mergetype</span><span class="o">=</span><span class="default_value">'Replace'</span></em>, <em class="sig-param"><span class="n">cmdset_priority</span><span class="o">=</span><span class="default_value">1</span></em>, <em class="sig-param"><span class="n">auto_quit</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">auto_look</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">auto_help</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">cmd_on_exit</span><span class="o">=</span><span class="default_value">'look'</span></em>, <em class="sig-param"><span class="n">persistent</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">startnode_input</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">session</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#TutorialEvMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.evmenu.html#evennia.utils.evmenu.EvMenu" title="evennia.utils.evmenu.EvMenu"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.evmenu.EvMenu</span></code></a></p>
<p>Custom EvMenu for displaying the intro-menu</p>
<dl class="py method">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu.close_menu">
<code class="sig-name descname">close_menu</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#TutorialEvMenu.close_menu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu.close_menu" title="Permalink to this definition"></a></dt>
<dd><p>Custom cleanup actions when closing menu</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu.options_formatter">
<code class="sig-name descname">options_formatter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">optionslist</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#TutorialEvMenu.options_formatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu.options_formatter" title="Permalink to this definition"></a></dt>
<dd><p>Formats the option block.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>optionlist</strong> (<em>list</em>) – List of (key, description) tuples for every
option related to this node.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>options (str)</em> – The formatted option display.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt id="evennia.contrib.tutorials.tutorial_world.intro_menu.init_menu">
<code class="sig-prename descclassname">evennia.contrib.tutorials.tutorial_world.intro_menu.</code><code class="sig-name descname">init_menu</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/tutorial_world/intro_menu.html#init_menu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.init_menu" title="Permalink to this definition"></a></dt>
<dd><p>Call to initialize the menu.</p>
</dd></dl>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.tutorial_world.mob.html" title="evennia.contrib.tutorials.tutorial_world.mob"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.tutorial_world.html" title="evennia.contrib.tutorials.tutorial_world"
>previous</a> |</li>
Fix 3.x legacy doc versioning
2023-12-21 00:12:31 +01:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 3.x</a> &#187;</li>
Add 3.x legacy documentation
2023-12-20 23:10:55 +01:00
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.tutorials.html" >evennia.contrib.tutorials</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.tutorials.tutorial_world.html" >evennia.contrib.tutorials.tutorial_world</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorials.tutorial_world.intro_menu</a></li>
</ul>
</div>
<div class="admonition important">
<p class="first admonition-title">Note</p>
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue Copy permalink