evennia/docs/latest/api/evennia.contrib.base_systems.building_menu.tests.html
Evennia docbuilder action 243d596662 Updated HTML docs.
2025-08-15 18:14:21 +00:00

264 lines
No EOL
20 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" 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.base_systems.building_menu.tests &#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.base_systems.color_markups" href="evennia.contrib.base_systems.color_markups.html" />
<link rel="prev" title="evennia.contrib.base_systems.building_menu.building_menu" href="evennia.contrib.base_systems.building_menu.building_menu.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.base_systems.color_markups.html" title="evennia.contrib.base_systems.color_markups"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.building_menu.building_menu.html" title="evennia.contrib.base_systems.building_menu.building_menu"
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.base_systems.html" >evennia.contrib.base_systems</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.base_systems.building_menu.html" accesskey="U">evennia.contrib.base_systems.building_menu</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.building_menu.tests</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.base_systems.building_menu.tests">
<span id="evennia-contrib-base-systems-building-menu-tests"></span><h1>evennia.contrib.base_systems.building_menu.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.building_menu.tests" title="Link to this heading"></a></h1>
<p>Building menu tests.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.building_menu.tests.Submenu">
<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.base_systems.building_menu.tests.</span></span><span class="sig-name descname"><span class="pre">Submenu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</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">obj</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">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Building</span> <span class="pre">menu:</span> <span class="pre">{obj}'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keys</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">parents</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">persistent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#Submenu"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.Submenu" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.base_systems.building_menu.building_menu.html#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu" title="evennia.contrib.base_systems.building_menu.building_menu.BuildingMenu"><code class="xref py py-class docutils literal notranslate"><span class="pre">BuildingMenu</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.building_menu.tests.Submenu.init">
<span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exit</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#Submenu.init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.Submenu.init" title="Link to this definition"></a></dt>
<dd><p>Create the sub-menu to edit the specified object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>obj</strong> (<em>Object</em>) the object to edit.</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This method is probably to be overridden in your subclasses.
Use <strong>add_choice</strong> and its variants to create menu choices.</p>
</div>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu">
<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.base_systems.building_menu.tests.</span></span><span class="sig-name descname"><span class="pre">TestBuildingMenu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">methodName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'runTest'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaCommandTest" title="evennia.utils.test_resources.BaseEvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseEvenniaCommandTest</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.setUp">
<span class="sig-name descname"><span class="pre">setUp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.setUp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.setUp" title="Link to this definition"></a></dt>
<dd><p>Sets up testing environment</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_quit">
<span class="sig-name descname"><span class="pre">test_quit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_quit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_quit" title="Link to this definition"></a></dt>
<dd><p>Try to quit the building menu.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_setattr">
<span class="sig-name descname"><span class="pre">test_setattr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_setattr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_setattr" title="Link to this definition"></a></dt>
<dd><p>Test the simple setattr provided by building menus.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_add_choice_without_key">
<span class="sig-name descname"><span class="pre">test_add_choice_without_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_add_choice_without_key"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_add_choice_without_key" title="Link to this definition"></a></dt>
<dd><p>Try to add choices without keys.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_callbacks">
<span class="sig-name descname"><span class="pre">test_callbacks</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_callbacks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_callbacks" title="Link to this definition"></a></dt>
<dd><p>Test callbacks in menus.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_multi_level">
<span class="sig-name descname"><span class="pre">test_multi_level</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_multi_level"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_multi_level" title="Link to this definition"></a></dt>
<dd><p>Test multi-level choices.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_submenu">
<span class="sig-name descname"><span class="pre">test_submenu</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/building_menu/tests.html#TestBuildingMenu.test_submenu"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_submenu" title="Link to this definition"></a></dt>
<dd><p>Test to add sub-menus.</p>
</dd></dl>
</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.base_systems.building_menu.tests</a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.building_menu.tests.Submenu"><code class="docutils literal notranslate"><span class="pre">Submenu</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.building_menu.tests.Submenu.init"><code class="docutils literal notranslate"><span class="pre">Submenu.init()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu"><code class="docutils literal notranslate"><span class="pre">TestBuildingMenu</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.setUp"><code class="docutils literal notranslate"><span class="pre">TestBuildingMenu.setUp()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_quit"><code class="docutils literal notranslate"><span class="pre">TestBuildingMenu.test_quit()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_setattr"><code class="docutils literal notranslate"><span class="pre">TestBuildingMenu.test_setattr()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_add_choice_without_key"><code class="docutils literal notranslate"><span class="pre">TestBuildingMenu.test_add_choice_without_key()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_callbacks"><code class="docutils literal notranslate"><span class="pre">TestBuildingMenu.test_callbacks()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_multi_level"><code class="docutils literal notranslate"><span class="pre">TestBuildingMenu.test_multi_level()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_submenu"><code class="docutils literal notranslate"><span class="pre">TestBuildingMenu.test_submenu()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.building_menu.building_menu.html"
title="previous chapter">evennia.contrib.base_systems.building_menu.building_menu</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.color_markups.html"
title="next chapter">evennia.contrib.base_systems.color_markups</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.base_systems.building_menu.tests.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>
<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.base_systems.color_markups.html" title="evennia.contrib.base_systems.color_markups"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.building_menu.building_menu.html" title="evennia.contrib.base_systems.building_menu.building_menu"
>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.base_systems.html" >evennia.contrib.base_systems</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.base_systems.building_menu.html" >evennia.contrib.base_systems.building_menu</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.building_menu.tests</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>