Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-27 18:26:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.contrib.tutorials.tutorial_world.intro_menu.html

408 lines
42 KiB
HTML
Raw Normal View History

Updated HTML docs.
2025-08-15 18:14:21 +00:00
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>evennia.contrib.tutorials.tutorial_world.intro_menu &#8212; Evennia latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="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="related" role="navigation" aria-label="Related">
<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>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<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="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="Link to this heading"></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 class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.do_nothing">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">do_nothing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_string</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.do_nothing" title="Link to this definition"></a></dt>
<dd><p>Re-runs the current node</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.send_testing_tagged">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">send_testing_tagged</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_string</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.send_testing_tagged" title="Link 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 class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">DemoCommandSetHelp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdsetobj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp" title="Link 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">CmdSet</span></code></a></p>
<p>Demo the help command</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Help</span> <span class="pre">Demo</span> <span class="pre">Set'</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.priority">
<span class="sig-name descname"><span class="pre">priority</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.priority" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.at_cmdset_creation">
<span class="sig-name descname"><span class="pre">at_cmdset_creation</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.at_cmdset_creation" title="Link 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 class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp'</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_help">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">goto_command_demo_help</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_string</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_help" title="Link 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 class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">DemoCommandSetComms</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdsetobj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms" title="Link 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">CmdSet</span></code></a></p>
<p>Demo communications</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Color</span> <span class="pre">Demo</span> <span class="pre">Set'</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.priority">
<span class="sig-name descname"><span class="pre">priority</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.priority" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.no_exits">
<span class="sig-name descname"><span class="pre">no_exits</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.no_exits" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.no_objs">
<span class="sig-name descname"><span class="pre">no_objs</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.no_objs" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.at_cmdset_creation">
<span class="sig-name descname"><span class="pre">at_cmdset_creation</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.at_cmdset_creation" title="Link 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 class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms'</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_comms">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">goto_command_demo_comms</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_string</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_comms" title="Link to this definition"></a></dt>
<dd><p>Setup and go to the color demo node.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">DemoCommandSetRoom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdsetobj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom" title="Link 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">CmdSet</span></code></a></p>
<p>Demo some general in-game commands command.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Room</span> <span class="pre">Demo</span> <span class="pre">Set'</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.priority">
<span class="sig-name descname"><span class="pre">priority</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.priority" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.no_exits">
<span class="sig-name descname"><span class="pre">no_exits</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.no_exits" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.no_objs">
<span class="sig-name descname"><span class="pre">no_objs</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.no_objs" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.at_cmdset_creation">
<span class="sig-name descname"><span class="pre">at_cmdset_creation</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.at_cmdset_creation" title="Link 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 class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom'</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_room">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">goto_command_demo_room</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_string</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_room" title="Link 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 class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.goto_cleanup_cmdsets">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">goto_cleanup_cmdsets</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_strings</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_cleanup_cmdsets" title="Link to this definition"></a></dt>
<dd><p>Cleanup all cmdsets.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">TutorialEvMenu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">menudata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startnode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'start'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdset_mergetype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Replace'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdset_priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_quit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_look</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_help</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmd_on_exit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'look'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persistent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startnode_input</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu" title="Link 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">EvMenu</span></code></a></p>
<p>Custom EvMenu for displaying the intro-menu</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu.close_menu">
<span class="sig-name descname"><span class="pre">close_menu</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu.close_menu" title="Link to this definition"></a></dt>
<dd><p>Custom cleanup actions when closing menu</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu.options_formatter">
<span class="sig-name descname"><span class="pre">options_formatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">optionslist</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu.options_formatter" title="Link to this definition"></a></dt>
<dd><p>Formats the option block.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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<span class="colon">:</span></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 class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.intro_menu.init_menu">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.tutorials.tutorial_world.intro_menu.</span></span><span class="sig-name descname"><span class="pre">init_menu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.init_menu" title="Link to this definition"></a></dt>
<dd><p>Call to initialize the menu.</p>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.contrib.tutorials.tutorial_world.intro_menu</a><ul>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.do_nothing"><code class="docutils literal notranslate"><span class="pre">do_nothing()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.send_testing_tagged"><code class="docutils literal notranslate"><span class="pre">send_testing_tagged()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetHelp</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.key"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetHelp.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.priority"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetHelp.priority</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.at_cmdset_creation"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetHelp.at_cmdset_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetHelp.path"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetHelp.path</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_help"><code class="docutils literal notranslate"><span class="pre">goto_command_demo_help()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetComms</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.key"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetComms.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.priority"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetComms.priority</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.no_exits"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetComms.no_exits</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.no_objs"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetComms.no_objs</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.at_cmdset_creation"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetComms.at_cmdset_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetComms.path"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetComms.path</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_comms"><code class="docutils literal notranslate"><span class="pre">goto_command_demo_comms()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetRoom</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.key"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetRoom.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.priority"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetRoom.priority</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.no_exits"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetRoom.no_exits</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.no_objs"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetRoom.no_objs</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.at_cmdset_creation"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetRoom.at_cmdset_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.DemoCommandSetRoom.path"><code class="docutils literal notranslate"><span class="pre">DemoCommandSetRoom.path</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_command_demo_room"><code class="docutils literal notranslate"><span class="pre">goto_command_demo_room()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.goto_cleanup_cmdsets"><code class="docutils literal notranslate"><span class="pre">goto_cleanup_cmdsets()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu"><code class="docutils literal notranslate"><span class="pre">TutorialEvMenu</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu.close_menu"><code class="docutils literal notranslate"><span class="pre">TutorialEvMenu.close_menu()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.TutorialEvMenu.options_formatter"><code class="docutils literal notranslate"><span class="pre">TutorialEvMenu.options_formatter()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.tutorials.tutorial_world.intro_menu.init_menu"><code class="docutils literal notranslate"><span class="pre">init_menu()</span></code></a></li>
</ul>
</li>
</ul>
<div>
<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>
</div>
<div>
<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>
<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>
<h3>Doc Versions</h3>
<ul>
<li>
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
Updated HTML docs.
2026-02-15 18:13:08 +00:00
<li>
<a href="https://www.evennia.com/docs/6.x/index.html">v6.0.0 branch (outdated)</a>
</li>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<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>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<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="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in a new issue Copy permalink