Updated HTML docs.

This commit is contained in:
Evennia docbuilder action 2024-07-13 12:28:54 +00:00
parent 58238762eb
commit a18f3016e6
54 changed files with 2367 additions and 108 deletions

View file

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a260bb964af762b1012707e746c40c81
config: a48d1cf2b2f7e12c2c08c31be8772e8d
tags: 645f666f9bcd5a90fca523b33c5a78b7

View file

@ -200,6 +200,8 @@
<section id="main">
<h2>Main<a class="headerlink" href="#main" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/evennia/evennia/pull/3531">Feat</a>: New contrib; <code class="docutils literal notranslate"><span class="pre">in-game</span> <span class="pre">reports</span></code> for handling user reportgs,
bugs etc in-game (InspectorCaracal)</p></li>
<li><p><a class="reference external" href="https://github.com/evennia/evennia/pull/3586">Feat</a>: Add ANSI color support <code class="docutils literal notranslate"><span class="pre">|U</span></code>, <code class="docutils literal notranslate"><span class="pre">|I</span></code>, <code class="docutils literal notranslate"><span class="pre">|i</span></code>, <code class="docutils literal notranslate"><span class="pre">|s</span></code>, <code class="docutils literal notranslate"><span class="pre">|S</span></code> for
underline reset, italic/reset and strikethrough/reset (0xDEADFED5)</p></li>
<li><p><a class="reference external" href="https://github.com/evennia/evennia/pull/3550">Fix</a>: Issue where rpsystem contrib search would do a global instead

View file

@ -130,6 +130,7 @@
<section class="tex2jax_ignore mathjax_ignore" id="in-game-reporting-system">
<h1>In-Game Reporting System<a class="headerlink" href="#in-game-reporting-system" title="Permalink to this headline"></a></h1>
<p>Contrib by InspectorCaracal, 2024</p>
<p>This contrib provides an in-game reports system, handling bug reports, player reports, and idea submissions by default. It also supports adding your own types of reports, or removing any of the default report types.</p>
<p>Each type of report has its own command for submitting new reports, and an admin command is also provided for managing the reports through a menu.</p>
<section id="installation">
@ -232,7 +233,7 @@
<span class="sd"> Usage:</span>
<span class="sd"> customreport &lt;message&gt;</span>
<span class="sd"> </span>
<span class="sd"> This is a custom report type.</span>
<span class="sd"> &quot;&quot;&quot;</span>

View file

@ -411,9 +411,9 @@ this module carefully before continuing.</p>
</section>
<section id="ingame-reports">
<h3><code class="docutils literal notranslate"><span class="pre">ingame_reports</span></code><a class="headerlink" href="#ingame-reports" title="Permalink to this headline"></a></h3>
<p><em>This contrib provides an in-game reports system, handling bug reports, player reports, and idea submissions by default. It also supports adding your own types of reports, or removing any of the default report types.</em></p>
<p>Each type of report has its own command for submitting new reports, and an admin command is also provided for managing the reports through a menu.</p>
<p><a class="reference internal" href="Contrib-Ingame-Reports.html"><span class="doc std std-doc">Read the documentation</span></a> - <span class="xref myst">Browse the Code</span></p>
<p><em>Contrib by InspectorCaracal, 2024</em></p>
<p>This contrib provides an in-game reports system, handling bug reports, player reports, and idea submissions by default. It also supports adding your own types of reports, or removing any of the default report types.</p>
<p><a class="reference internal" href="Contrib-Ingame-Reports.html"><span class="doc std std-doc">Read the documentation</span></a> - <a class="reference internal" href="../api/evennia.contrib.base_systems.ingame_reports.html#evennia-contrib-base-systems-ingame-reports"><span class="std std-ref">Browse the Code</span></a></p>
</section>
<section id="menu-login">
<h3><code class="docutils literal notranslate"><span class="pre">menu_login</span></code><a class="headerlink" href="#menu-login" title="Permalink to this headline"></a></h3>

View file

@ -0,0 +1,257 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.contrib.base_systems.ingame_reports.menu &#8212; Evennia latest documentation</title>
<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" />
</head><body>
<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="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.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><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="menu.html">latest (main branch)</a></li>
<li><a href="../4.x/index.html">v4.0.0 branch (outdated)</a></li>
<li><a href="../3.x/index.html">v3.0.0 branch (outdated)</a></li>
<li><a href="../2.x/index.html">v2.0.0 branch (outdated)</a></li>
<li><a href="../1.x/index.html">v1.0.0 branch (outdated)</a></li>
<li><a href="../0.x/index.html">v0.9.5 branch (outdated)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for evennia.contrib.base_systems.ingame_reports.menu</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">The report-management menu module.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="kn">from</span> <span class="nn">evennia.comms.models</span> <span class="kn">import</span> <span class="n">Msg</span>
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="kn">import</span> <span class="n">logger</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">crop</span><span class="p">,</span> <span class="n">datetime_format</span><span class="p">,</span> <span class="n">is_iter</span><span class="p">,</span> <span class="n">iter_to_str</span>
<span class="c1"># the number of reports displayed on each page</span>
<span class="n">_REPORTS_PER_PAGE</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">_REPORT_STATUS_TAGS</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;closed&quot;</span><span class="p">,</span> <span class="s2">&quot;in progress&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">settings</span><span class="p">,</span> <span class="s2">&quot;INGAME_REPORT_STATUS_TAGS&quot;</span><span class="p">):</span>
<span class="k">if</span> <span class="n">is_iter</span><span class="p">(</span><span class="n">settings</span><span class="o">.</span><span class="n">INGAME_REPORT_STATUS_TAGS</span><span class="p">):</span>
<span class="n">_REPORT_STATUS_TAGS</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">INGAME_REPORT_STATUS_TAGS</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">log_warn</span><span class="p">(</span>
<span class="s2">&quot;The &#39;INGAME_REPORT_STATUS_TAGS&#39; setting must be an iterable of strings; falling back to defaults.&quot;</span>
<span class="p">)</span>
<div class="viewcode-block" id="menunode_list_reports"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.menu.html#evennia.contrib.base_systems.ingame_reports.menu.menunode_list_reports">[docs]</a><span class="k">def</span> <span class="nf">menunode_list_reports</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">raw_string</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Paginates and lists out reports for the provided hub&quot;&quot;&quot;</span>
<span class="n">hub</span> <span class="o">=</span> <span class="n">caller</span><span class="o">.</span><span class="n">ndb</span><span class="o">.</span><span class="n">_evmenu</span><span class="o">.</span><span class="n">hub</span>
<span class="n">page</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;page&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">start</span> <span class="o">=</span> <span class="n">page</span> <span class="o">*</span> <span class="n">_REPORTS_PER_PAGE</span>
<span class="n">end</span> <span class="o">=</span> <span class="n">start</span> <span class="o">+</span> <span class="n">_REPORTS_PER_PAGE</span>
<span class="n">report_slice</span> <span class="o">=</span> <span class="n">report_list</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">end</span><span class="p">]</span>
<span class="n">hub_name</span> <span class="o">=</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">hub</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;_&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">title</span><span class="p">()</span>
<span class="n">text</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;Managing </span><span class="si">{</span><span class="n">hub_name</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">report_list</span> <span class="o">:=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">caller</span><span class="o">.</span><span class="n">ndb</span><span class="o">.</span><span class="n">_evmenu</span><span class="p">,</span> <span class="s2">&quot;report_list&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)):</span>
<span class="n">report_list</span> <span class="o">=</span> <span class="n">Msg</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">search_message</span><span class="p">(</span><span class="n">receiver</span><span class="o">=</span><span class="n">hub</span><span class="p">)</span><span class="o">.</span><span class="n">order_by</span><span class="p">(</span><span class="s2">&quot;db_date_created&quot;</span><span class="p">)</span>
<span class="n">caller</span><span class="o">.</span><span class="n">ndb</span><span class="o">.</span><span class="n">_evmenu</span><span class="o">.</span><span class="n">report_list</span> <span class="o">=</span> <span class="n">report_list</span>
<span class="c1"># allow the menu to filter print-outs by status</span>
<span class="k">if</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;status&quot;</span><span class="p">):</span>
<span class="n">new_report_list</span> <span class="o">=</span> <span class="n">report_list</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">db_tags__db_key</span><span class="o">=</span><span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;status&quot;</span><span class="p">])</span>
<span class="c1"># we don&#39;t filter reports if there are no reports under that filter</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">new_report_list</span><span class="p">:</span>
<span class="n">text</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;(No </span><span class="si">{</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2"> reports)</span><span class="se">\n</span><span class="si">{</span><span class="n">text</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">report_list</span> <span class="o">=</span> <span class="n">new_report_list</span>
<span class="n">text</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;Managing </span><span class="si">{</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">hub_name</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">report_list</span> <span class="o">=</span> <span class="n">report_list</span><span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">db_tags__db_key</span><span class="o">=</span><span class="s2">&quot;closed&quot;</span><span class="p">)</span>
<span class="c1"># filter by lock access</span>
<span class="n">report_list</span> <span class="o">=</span> <span class="p">[</span><span class="n">msg</span> <span class="k">for</span> <span class="n">msg</span> <span class="ow">in</span> <span class="n">report_list</span> <span class="k">if</span> <span class="n">msg</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="s2">&quot;read&quot;</span><span class="p">)]</span>
<span class="c1"># this will catch both no reports filed and no permissions</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">report_list</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;There is nothing there for you to manage.&quot;</span><span class="p">,</span> <span class="p">{}</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;desc&quot;</span><span class="p">:</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">datetime_format</span><span class="p">(</span><span class="n">report</span><span class="o">.</span><span class="n">date_created</span><span class="p">)</span><span class="si">}</span><span class="s2"> - </span><span class="si">{</span><span class="n">crop</span><span class="p">(</span><span class="n">report</span><span class="o">.</span><span class="n">message</span><span class="p">,</span><span class="w"> </span><span class="mi">50</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
<span class="s2">&quot;goto&quot;</span><span class="p">:</span> <span class="p">(</span><span class="s2">&quot;menunode_manage_report&quot;</span><span class="p">,</span> <span class="p">{</span><span class="s2">&quot;report&quot;</span><span class="p">:</span> <span class="n">report</span><span class="p">}),</span>
<span class="p">}</span>
<span class="k">for</span> <span class="n">report</span> <span class="ow">in</span> <span class="n">report_slice</span>
<span class="p">]</span>
<span class="n">options</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="p">{</span>
<span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="p">(</span><span class="s2">&quot;|uF|nilter by status&quot;</span><span class="p">,</span> <span class="s2">&quot;filter&quot;</span><span class="p">,</span> <span class="s2">&quot;status&quot;</span><span class="p">,</span> <span class="s2">&quot;f&quot;</span><span class="p">),</span>
<span class="s2">&quot;goto&quot;</span><span class="p">:</span> <span class="s2">&quot;menunode_choose_filter&quot;</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">start</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">options</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="p">{</span>
<span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="p">(</span><span class="sa">f</span><span class="s2">&quot;|uP|nrevious </span><span class="si">{</span><span class="n">_REPORTS_PER_PAGE</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="s2">&quot;previous&quot;</span><span class="p">,</span> <span class="s2">&quot;prev&quot;</span><span class="p">,</span> <span class="s2">&quot;p&quot;</span><span class="p">),</span>
<span class="s2">&quot;goto&quot;</span><span class="p">:</span> <span class="p">(</span>
<span class="s2">&quot;menunode_list_reports&quot;</span><span class="p">,</span>
<span class="p">{</span><span class="s2">&quot;page&quot;</span><span class="p">:</span> <span class="nb">max</span><span class="p">(</span><span class="n">start</span> <span class="o">-</span> <span class="n">_REPORTS_PER_PAGE</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="o">//</span> <span class="n">_REPORTS_PER_PAGE</span><span class="p">},</span>
<span class="p">),</span>
<span class="p">}</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">end</span> <span class="o">&lt;</span> <span class="nb">len</span><span class="p">(</span><span class="n">report_list</span><span class="p">):</span>
<span class="n">options</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="p">{</span>
<span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="p">(</span><span class="sa">f</span><span class="s2">&quot;|uN|next </span><span class="si">{</span><span class="n">_REPORTS_PER_PAGE</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="s2">&quot;next&quot;</span><span class="p">,</span> <span class="s2">&quot;n&quot;</span><span class="p">),</span>
<span class="s2">&quot;goto&quot;</span><span class="p">:</span> <span class="p">(</span>
<span class="s2">&quot;menunode_list_reports&quot;</span><span class="p">,</span>
<span class="p">{</span><span class="s2">&quot;page&quot;</span><span class="p">:</span> <span class="p">(</span><span class="n">start</span> <span class="o">+</span> <span class="n">_REPORTS_PER_PAGE</span><span class="p">)</span> <span class="o">//</span> <span class="n">_REPORTS_PER_PAGE</span><span class="p">},</span>
<span class="p">),</span>
<span class="p">}</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">text</span><span class="p">,</span> <span class="n">options</span></div>
<div class="viewcode-block" id="menunode_choose_filter"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.menu.html#evennia.contrib.base_systems.ingame_reports.menu.menunode_choose_filter">[docs]</a><span class="k">def</span> <span class="nf">menunode_choose_filter</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">raw_string</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;apply or clear a status filter to the main report view&quot;&quot;&quot;</span>
<span class="n">text</span> <span class="o">=</span> <span class="s2">&quot;View which reports?&quot;</span>
<span class="c1"># options for all the possible statuses</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">{</span><span class="s2">&quot;desc&quot;</span><span class="p">:</span> <span class="n">status</span><span class="p">,</span> <span class="s2">&quot;goto&quot;</span><span class="p">:</span> <span class="p">(</span><span class="s2">&quot;menunode_list_reports&quot;</span><span class="p">,</span> <span class="p">{</span><span class="s2">&quot;status&quot;</span><span class="p">:</span> <span class="n">status</span><span class="p">})}</span>
<span class="k">for</span> <span class="n">status</span> <span class="ow">in</span> <span class="n">_REPORT_STATUS_TAGS</span>
<span class="p">]</span>
<span class="c1"># no filter</span>
<span class="n">options</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s2">&quot;desc&quot;</span><span class="p">:</span> <span class="s2">&quot;All open reports&quot;</span><span class="p">,</span> <span class="s2">&quot;goto&quot;</span><span class="p">:</span> <span class="s2">&quot;menunode_list_reports&quot;</span><span class="p">})</span>
<span class="k">return</span> <span class="n">text</span><span class="p">,</span> <span class="n">options</span></div>
<span class="k">def</span> <span class="nf">_report_toggle_tag</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">raw_string</span><span class="p">,</span> <span class="n">report</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;goto callable to toggle a status tag on or off&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">report</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">all</span><span class="p">():</span>
<span class="n">report</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">report</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="s2">&quot;menunode_manage_report&quot;</span><span class="p">,</span> <span class="p">{</span><span class="s2">&quot;report&quot;</span><span class="p">:</span> <span class="n">report</span><span class="p">})</span>
<div class="viewcode-block" id="menunode_manage_report"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.menu.html#evennia.contrib.base_systems.ingame_reports.menu.menunode_manage_report">[docs]</a><span class="k">def</span> <span class="nf">menunode_manage_report</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">raw_string</span><span class="p">,</span> <span class="n">report</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Read out the full report text and targets, and allow for changing the report&#39;s status.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">receivers</span> <span class="o">=</span> <span class="p">[</span><span class="n">r</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">report</span><span class="o">.</span><span class="n">receivers</span> <span class="k">if</span> <span class="n">r</span> <span class="o">!=</span> <span class="n">caller</span><span class="o">.</span><span class="n">ndb</span><span class="o">.</span><span class="n">_evmenu</span><span class="o">.</span><span class="n">hub</span><span class="p">]</span>
<span class="n">text</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
<span class="si">{</span><span class="n">report</span><span class="o">.</span><span class="n">message</span><span class="si">}</span>
<span class="si">{</span><span class="n">datetime_format</span><span class="p">(</span><span class="n">report</span><span class="o">.</span><span class="n">date_created</span><span class="p">)</span><span class="si">}</span><span class="s2"> by </span><span class="si">{</span><span class="n">iter_to_str</span><span class="p">(</span><span class="n">report</span><span class="o">.</span><span class="n">senders</span><span class="p">)</span><span class="si">}{</span><span class="s1">&#39; about &#39;</span><span class="o">+</span><span class="n">iter_to_str</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">get_display_name</span><span class="p">(</span><span class="n">caller</span><span class="p">)</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">r</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">receivers</span><span class="p">)</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">receivers</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s1">&#39;&#39;</span><span class="si">}</span>
<span class="si">{</span><span class="n">iter_to_str</span><span class="p">(</span><span class="n">report</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">all</span><span class="p">())</span><span class="si">}</span><span class="s2">&quot;&quot;&quot;</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">_REPORT_STATUS_TAGS</span><span class="p">:</span>
<span class="n">options</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="p">{</span>
<span class="s2">&quot;desc&quot;</span><span class="p">:</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="s1">&#39;Unmark&#39;</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">tag</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">report</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">all</span><span class="p">()</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s1">&#39;Mark&#39;</span><span class="w"> </span><span class="si">}</span><span class="s2"> as </span><span class="si">{</span><span class="n">tag</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
<span class="s2">&quot;goto&quot;</span><span class="p">:</span> <span class="p">(</span><span class="n">_report_toggle_tag</span><span class="p">,</span> <span class="p">{</span><span class="s2">&quot;report&quot;</span><span class="p">:</span> <span class="n">report</span><span class="p">,</span> <span class="s2">&quot;tag&quot;</span><span class="p">:</span> <span class="n">tag</span><span class="p">}),</span>
<span class="p">}</span>
<span class="p">)</span>
<span class="n">options</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s2">&quot;desc&quot;</span><span class="p">:</span> <span class="sa">f</span><span class="s2">&quot;Manage another report&quot;</span><span class="p">,</span> <span class="s2">&quot;goto&quot;</span><span class="p">:</span> <span class="s2">&quot;menunode_list_reports&quot;</span><span class="p">})</span>
<span class="k">return</span> <span class="n">text</span><span class="p">,</span> <span class="n">options</span></div>
</pre></div>
</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="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.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> 3.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,438 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.contrib.base_systems.ingame_reports.reports &#8212; Evennia latest documentation</title>
<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" />
</head><body>
<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="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.reports</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><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="reports.html">latest (main branch)</a></li>
<li><a href="../4.x/index.html">v4.0.0 branch (outdated)</a></li>
<li><a href="../3.x/index.html">v3.0.0 branch (outdated)</a></li>
<li><a href="../2.x/index.html">v2.0.0 branch (outdated)</a></li>
<li><a href="../1.x/index.html">v1.0.0 branch (outdated)</a></li>
<li><a href="../0.x/index.html">v0.9.5 branch (outdated)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for evennia.contrib.base_systems.ingame_reports.reports</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">In-Game Reporting System</span>
<span class="sd">This contrib provides an in-game reporting system, with player-facing commands and a staff</span>
<span class="sd">management interface.</span>
<span class="sd"># Installation</span>
<span class="sd">To install, just add the provided cmdset to your default AccountCmdSet:</span>
<span class="sd"> # in commands/default_cmdset.py</span>
<span class="sd"> from evennia.contrib.base_systems.ingame_reports import ReportsCmdSet</span>
<span class="sd"> class AccountCmdSet(default_cmds.AccountCmdSet):</span>
<span class="sd"> # ...</span>
<span class="sd"> def at_cmdset_creation(self):</span>
<span class="sd"> # ...</span>
<span class="sd"> self.add(ReportsCmdSet)</span>
<span class="sd"># Features</span>
<span class="sd">The contrib provides three commands by default and their associated report types: `CmdBug`, `CmdIdea`,</span>
<span class="sd">and `CmdReport` (which is for reporting other players).</span>
<span class="sd"> </span>
<span class="sd">The `ReportCmdBase` class holds most of the functionality for creating new reports, providing a</span>
<span class="sd">convenient parent class for adding your own categories of reports.</span>
<span class="sd">The contrib can be further configured through two settings, `INGAME_REPORT_TYPES` and `INGAME_REPORT_STATUS_TAGS`</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="kn">from</span> <span class="nn">evennia</span> <span class="kn">import</span> <span class="n">CmdSet</span>
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="kn">import</span> <span class="n">create</span><span class="p">,</span> <span class="n">evmenu</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">search</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">class_from_module</span><span class="p">,</span> <span class="n">datetime_format</span><span class="p">,</span> <span class="n">is_iter</span><span class="p">,</span> <span class="n">iter_to_str</span>
<span class="kn">from</span> <span class="nn">evennia.commands.default.muxcommand</span> <span class="kn">import</span> <span class="n">MuxCommand</span>
<span class="kn">from</span> <span class="nn">evennia.comms.models</span> <span class="kn">import</span> <span class="n">Msg</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">menu</span>
<span class="n">_DEFAULT_COMMAND_CLASS</span> <span class="o">=</span> <span class="n">class_from_module</span><span class="p">(</span><span class="n">settings</span><span class="o">.</span><span class="n">COMMAND_DEFAULT_CLASS</span><span class="p">)</span>
<span class="c1"># the default report types</span>
<span class="n">_REPORT_TYPES</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;bugs&quot;</span><span class="p">,</span> <span class="s2">&quot;ideas&quot;</span><span class="p">,</span> <span class="s2">&quot;players&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">settings</span><span class="p">,</span> <span class="s2">&quot;INGAME_REPORT_TYPES&quot;</span><span class="p">):</span>
<span class="k">if</span> <span class="n">is_iter</span><span class="p">(</span><span class="n">settings</span><span class="o">.</span><span class="n">INGAME_REPORT_TYPES</span><span class="p">):</span>
<span class="n">_REPORT_TYPES</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">INGAME_REPORT_TYPES</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">log_warn</span><span class="p">(</span>
<span class="s2">&quot;The &#39;INGAME_REPORT_TYPES&#39; setting must be an iterable of strings; falling back to defaults.&quot;</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_report_hub</span><span class="p">(</span><span class="n">report_type</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A helper function to retrieve the global script which acts as the hub for a given report type.</span>
<span class="sd"> Args:</span>
<span class="sd"> report_type (str): The category of reports to retrieve the script for.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Script or None: The global script, or None if it couldn&#39;t be retrieved or created</span>
<span class="sd"> Note: If no matching valid script exists, this function will attempt to create it.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">hub_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">report_type</span><span class="si">}</span><span class="s2">_reports&quot;</span>
<span class="c1"># NOTE: due to a regression in GLOBAL_SCRIPTS, we use search_script instead of the container</span>
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">hub</span> <span class="o">:=</span> <span class="n">search</span><span class="o">.</span><span class="n">search_script</span><span class="p">(</span><span class="n">hub_key</span><span class="p">)):</span>
<span class="n">hub</span> <span class="o">=</span> <span class="n">create</span><span class="o">.</span><span class="n">create_script</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">hub_key</span><span class="p">)</span>
<span class="k">return</span> <span class="n">hub</span> <span class="ow">or</span> <span class="kc">None</span>
<div class="viewcode-block" id="CmdManageReports"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports">[docs]</a><span class="k">class</span> <span class="nc">CmdManageReports</span><span class="p">(</span><span class="n">_DEFAULT_COMMAND_CLASS</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> manage the various reports</span>
<span class="sd"> Usage:</span>
<span class="sd"> manage [report type]</span>
<span class="sd"> Available report types:</span>
<span class="sd"> bugs</span>
<span class="sd"> ideas</span>
<span class="sd"> players</span>
<span class="sd"> Initializes a menu for reviewing and changing the status of current reports.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="s2">&quot;manage reports&quot;</span>
<span class="n">aliases</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;manage </span><span class="si">{</span><span class="n">report_type</span><span class="si">}</span><span class="s2">&quot;</span> <span class="k">for</span> <span class="n">report_type</span> <span class="ow">in</span> <span class="n">_REPORT_TYPES</span><span class="p">)</span>
<span class="n">locks</span> <span class="o">=</span> <span class="s2">&quot;cmd:pperm(Admin)&quot;</span>
<div class="viewcode-block" id="CmdManageReports.get_help"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.get_help">[docs]</a> <span class="k">def</span> <span class="nf">get_help</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns a help string containing the configured available report types&quot;&quot;&quot;</span>
<span class="n">report_types</span> <span class="o">=</span> <span class="n">iter_to_str</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2"> &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_REPORT_TYPES</span><span class="p">))</span>
<span class="n">helptext</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
<span class="s2">manage the various reports</span>
<span class="s2">Usage:</span>
<span class="s2"> manage [report type]</span>
<span class="s2"> </span>
<span class="s2">Available report types:</span>
<span class="s2"> </span><span class="si">{</span><span class="n">report_types</span><span class="si">}</span>
<span class="s2">Initializes a menu for reviewing and changing the status of current reports.</span>
<span class="s2">&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">helptext</span></div>
<div class="viewcode-block" id="CmdManageReports.func"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.func">[docs]</a> <span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">report_type</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmdstring</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="n">report_type</span> <span class="o">==</span> <span class="s2">&quot;reports&quot;</span><span class="p">:</span>
<span class="n">report_type</span> <span class="o">=</span> <span class="s2">&quot;players&quot;</span>
<span class="k">if</span> <span class="n">report_type</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_REPORT_TYPES</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;&#39;</span><span class="si">{</span><span class="n">report_type</span><span class="si">}</span><span class="s2">&#39; is not a valid report category.&quot;</span><span class="p">)</span>
<span class="k">return</span>
<span class="c1"># remove the trailing s, just so everything reads nicer</span>
<span class="n">report_type</span> <span class="o">=</span> <span class="n">report_type</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="n">hub</span> <span class="o">=</span> <span class="n">_get_report_hub</span><span class="p">(</span><span class="n">report_type</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">hub</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;You cannot manage that.&quot;</span><span class="p">)</span>
<span class="n">evmenu</span><span class="o">.</span><span class="n">EvMenu</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">account</span><span class="p">,</span> <span class="n">menu</span><span class="p">,</span> <span class="n">startnode</span><span class="o">=</span><span class="s2">&quot;menunode_list_reports&quot;</span><span class="p">,</span> <span class="n">hub</span><span class="o">=</span><span class="n">hub</span><span class="p">,</span> <span class="n">persistent</span><span class="o">=</span><span class="kc">True</span>
<span class="p">)</span></div></div>
<div class="viewcode-block" id="ReportCmdBase"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase">[docs]</a><span class="k">class</span> <span class="nc">ReportCmdBase</span><span class="p">(</span><span class="n">_DEFAULT_COMMAND_CLASS</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A parent class for creating report commands. This help text may be displayed if</span>
<span class="sd"> your command&#39;s help text is not properly configured.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">help_category</span> <span class="o">=</span> <span class="s2">&quot;reports&quot;</span>
<span class="c1"># defines what locks the reports generated by this command will have set</span>
<span class="n">report_locks</span> <span class="o">=</span> <span class="s2">&quot;read:pperm(Admin)&quot;</span>
<span class="c1"># determines if the report can be filed without a target</span>
<span class="n">require_target</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># the message sent to the reporter after the report has been created</span>
<span class="n">success_msg</span> <span class="o">=</span> <span class="s2">&quot;Your report has been filed.&quot;</span>
<span class="c1"># the report type for this command, if different from the key</span>
<span class="n">report_type</span> <span class="o">=</span> <span class="kc">None</span>
<div class="viewcode-block" id="ReportCmdBase.at_pre_cmd"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.at_pre_cmd">[docs]</a> <span class="k">def</span> <span class="nf">at_pre_cmd</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;validate that the needed hub script exists - if not, cancel the command&quot;&quot;&quot;</span>
<span class="n">hub</span> <span class="o">=</span> <span class="n">_get_report_hub</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">report_type</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">hub</span><span class="p">:</span>
<span class="c1"># a return value of True from `at_pre_cmd` cancels the command</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hub</span> <span class="o">=</span> <span class="n">hub</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">at_pre_cmd</span><span class="p">()</span></div>
<div class="viewcode-block" id="ReportCmdBase.parse"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.parse">[docs]</a> <span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Parse the target and message out of the arguments.</span>
<span class="sd"> </span>
<span class="sd"> Override if you want different syntax, but make sure to assign `report_message` and `target_str`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># do the base MuxCommand parsing first</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">parse</span><span class="p">()</span>
<span class="c1"># split out the report message and target strings</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">rhs</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">report_message</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rhs</span>
<span class="bp">self</span><span class="o">.</span><span class="n">target_str</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lhs</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">report_message</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lhs</span>
<span class="bp">self</span><span class="o">.</span><span class="n">target_str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span></div>
<div class="viewcode-block" id="ReportCmdBase.target_search"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.target_search">[docs]</a> <span class="k">def</span> <span class="nf">target_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">searchterm</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Search for a target that matches the given search term. By default, does a normal search via the</span>
<span class="sd"> caller - a local object search for a Character, or an account search for an Account.</span>
<span class="sd"> Args:</span>
<span class="sd"> searchterm (str) - The string to search for</span>
<span class="sd"> Returns:</span>
<span class="sd"> result (Object, Account, or None) - the result of the search</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">searchterm</span><span class="p">)</span></div>
<div class="viewcode-block" id="ReportCmdBase.create_report"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.create_report">[docs]</a> <span class="k">def</span> <span class="nf">create_report</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates the report. By default, this creates a Msg with any provided args and kwargs.</span>
<span class="sd"> Returns:</span>
<span class="sd"> success (bool) - True if the report was created successfully, or False if there was an issue.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">create</span><span class="o">.</span><span class="n">create_message</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="ReportCmdBase.func"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.func">[docs]</a> <span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">hub</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">hub</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;You must provide a message.&quot;</span><span class="p">)</span>
<span class="k">return</span>
<span class="n">target</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_str</span><span class="p">:</span>
<span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_search</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">target_str</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">target</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">require_target</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;You must include a target.&quot;</span><span class="p">)</span>
<span class="k">return</span>
<span class="n">receivers</span> <span class="o">=</span> <span class="p">[</span><span class="n">hub</span><span class="p">]</span>
<span class="k">if</span> <span class="n">target</span><span class="p">:</span>
<span class="n">receivers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_report</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">account</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">report_message</span><span class="p">,</span> <span class="n">receivers</span><span class="o">=</span><span class="n">receivers</span><span class="p">,</span> <span class="n">locks</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">report_locks</span><span class="p">,</span> <span class="n">tags</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;report&quot;</span><span class="p">]</span>
<span class="p">):</span>
<span class="c1"># the report Msg was successfully created</span>
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">success_msg</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># something went wrong</span>
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span>
<span class="s2">&quot;Something went wrong creating your report. Please try again later or contact staff directly.&quot;</span>
<span class="p">)</span></div></div>
<span class="c1"># The commands below are the usable reporting commands</span>
<div class="viewcode-block" id="CmdBug"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdBug">[docs]</a><span class="k">class</span> <span class="nc">CmdBug</span><span class="p">(</span><span class="n">ReportCmdBase</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> file a bug</span>
<span class="sd"> Usage:</span>
<span class="sd"> bug [&lt;target&gt; =] &lt;message&gt;</span>
<span class="sd"> Note: If a specific object, location or character is bugged, please target it for the report.</span>
<span class="sd"> Examples:</span>
<span class="sd"> bug hammer = This doesn&#39;t work as a crafting tool but it should</span>
<span class="sd"> bug every time I go through a door I get the message twice</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="s2">&quot;bug&quot;</span>
<span class="n">report_locks</span> <span class="o">=</span> <span class="s2">&quot;read:pperm(Developer)&quot;</span></div>
<div class="viewcode-block" id="CmdReport"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdReport">[docs]</a><span class="k">class</span> <span class="nc">CmdReport</span><span class="p">(</span><span class="n">ReportCmdBase</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> report a player</span>
<span class="sd"> Usage:</span>
<span class="sd"> report &lt;player&gt; = &lt;message&gt;</span>
<span class="sd"> All player reports will be reviewed.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="s2">&quot;report&quot;</span>
<span class="n">report_type</span> <span class="o">=</span> <span class="s2">&quot;player&quot;</span>
<span class="n">require_target</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">account_caller</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="CmdIdea"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea">[docs]</a><span class="k">class</span> <span class="nc">CmdIdea</span><span class="p">(</span><span class="n">ReportCmdBase</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> submit a suggestion</span>
<span class="sd"> Usage:</span>
<span class="sd"> ideas</span>
<span class="sd"> idea &lt;message&gt;</span>
<span class="sd"> Example:</span>
<span class="sd"> idea wouldn&#39;t it be cool if we had horses we could ride</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="s2">&quot;idea&quot;</span>
<span class="n">aliases</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;ideas&quot;</span><span class="p">,)</span>
<span class="n">report_locks</span> <span class="o">=</span> <span class="s2">&quot;read:pperm(Builder)&quot;</span>
<span class="n">success_msg</span> <span class="o">=</span> <span class="s2">&quot;Thank you for your suggestion!&quot;</span>
<div class="viewcode-block" id="CmdIdea.func"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.func">[docs]</a> <span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># we add an extra feature to this command, allowing you to see all your submitted ideas</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmdstring</span> <span class="o">==</span> <span class="s2">&quot;ideas&quot;</span><span class="p">:</span>
<span class="c1"># list your ideas</span>
<span class="k">if</span> <span class="p">(</span>
<span class="n">ideas</span> <span class="o">:=</span> <span class="n">Msg</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">search_message</span><span class="p">(</span><span class="n">sender</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">account</span><span class="p">,</span> <span class="n">receiver</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">hub</span><span class="p">)</span>
<span class="o">.</span><span class="n">order_by</span><span class="p">(</span><span class="s2">&quot;-db_date_created&quot;</span><span class="p">)</span>
<span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">db_tags__db_key</span><span class="o">=</span><span class="s2">&quot;closed&quot;</span><span class="p">)</span>
<span class="p">):</span>
<span class="c1"># todo: use a paginated menu</span>
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span>
<span class="s2">&quot;Ideas you&#39;ve submitted:</span><span class="se">\n</span><span class="s2"> &quot;</span>
<span class="o">+</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2"> &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;|w</span><span class="si">{</span><span class="n">item</span><span class="o">.</span><span class="n">message</span><span class="si">}</span><span class="s2">|n (submitted </span><span class="si">{</span><span class="n">datetime_format</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">date_created</span><span class="p">)</span><span class="si">}</span><span class="s2">)&quot;</span>
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">ideas</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;You have no open suggestions.&quot;</span><span class="p">)</span>
<span class="k">return</span>
<span class="c1"># proceed to do the normal report-command functionality</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">func</span><span class="p">()</span></div></div>
<div class="viewcode-block" id="ReportsCmdSet"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet">[docs]</a><span class="k">class</span> <span class="nc">ReportsCmdSet</span><span class="p">(</span><span class="n">CmdSet</span><span class="p">):</span>
<span class="n">key</span> <span class="o">=</span> <span class="s2">&quot;Reports CmdSet&quot;</span>
<div class="viewcode-block" id="ReportsCmdSet.at_cmdset_creation"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.at_cmdset_creation">[docs]</a> <span class="k">def</span> <span class="nf">at_cmdset_creation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">at_cmdset_creation</span><span class="p">()</span>
<span class="k">if</span> <span class="s2">&quot;bugs&quot;</span> <span class="ow">in</span> <span class="n">_REPORT_TYPES</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">CmdBug</span><span class="p">)</span>
<span class="k">if</span> <span class="s2">&quot;ideas&quot;</span> <span class="ow">in</span> <span class="n">_REPORT_TYPES</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">CmdIdea</span><span class="p">)</span>
<span class="k">if</span> <span class="s2">&quot;players&quot;</span> <span class="ow">in</span> <span class="n">_REPORT_TYPES</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">CmdReport</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">CmdManageReports</span><span class="p">)</span></div></div>
</pre></div>
</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="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.reports</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> 3.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,209 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.contrib.base_systems.ingame_reports.tests &#8212; Evennia latest documentation</title>
<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" />
</head><body>
<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="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.tests</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><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="tests.html">latest (main branch)</a></li>
<li><a href="../4.x/index.html">v4.0.0 branch (outdated)</a></li>
<li><a href="../3.x/index.html">v3.0.0 branch (outdated)</a></li>
<li><a href="../2.x/index.html">v2.0.0 branch (outdated)</a></li>
<li><a href="../1.x/index.html">v1.0.0 branch (outdated)</a></li>
<li><a href="../0.x/index.html">v0.9.5 branch (outdated)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for evennia.contrib.base_systems.ingame_reports.tests</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">unittest.mock</span> <span class="kn">import</span> <span class="n">Mock</span><span class="p">,</span> <span class="n">patch</span><span class="p">,</span> <span class="n">MagicMock</span>
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="kn">import</span> <span class="n">create</span>
<span class="kn">from</span> <span class="nn">evennia.comms.models</span> <span class="kn">import</span> <span class="n">TempMsg</span>
<span class="kn">from</span> <span class="nn">evennia.utils.test_resources</span> <span class="kn">import</span> <span class="n">EvenniaCommandTest</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">menu</span><span class="p">,</span> <span class="n">reports</span>
<span class="k">class</span> <span class="nc">_MockQuerySet</span><span class="p">(</span><span class="nb">list</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">order_by</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">exclude</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">filter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">_mock_pre</span><span class="p">(</span><span class="n">cmdobj</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;helper to mock at_pre_cmd&quot;&quot;&quot;</span>
<span class="n">cmdobj</span><span class="o">.</span><span class="n">hub</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>
<div class="viewcode-block" id="TestReportCommands"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.tests.html#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands">[docs]</a><span class="k">class</span> <span class="nc">TestReportCommands</span><span class="p">(</span><span class="n">EvenniaCommandTest</span><span class="p">):</span>
<div class="viewcode-block" id="TestReportCommands.test_report_cmd_base"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.tests.html#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_report_cmd_base">[docs]</a> <span class="nd">@patch</span><span class="o">.</span><span class="n">object</span><span class="p">(</span><span class="n">create</span><span class="p">,</span> <span class="s2">&quot;create_message&quot;</span><span class="p">,</span> <span class="n">new</span><span class="o">=</span><span class="n">MagicMock</span><span class="p">())</span>
<span class="k">def</span> <span class="nf">test_report_cmd_base</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;verify that the base command functionality works&quot;&quot;&quot;</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">reports</span><span class="o">.</span><span class="n">ReportCmdBase</span>
<span class="c1"># avoid test side-effects</span>
<span class="k">with</span> <span class="n">patch</span><span class="o">.</span><span class="n">object</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="s2">&quot;at_pre_cmd&quot;</span><span class="p">,</span> <span class="n">new</span><span class="o">=</span><span class="n">_mock_pre</span><span class="p">)</span> <span class="k">as</span> <span class="n">_</span><span class="p">:</span>
<span class="c1"># no arguments</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">(),</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="s2">&quot;You must provide a message.&quot;</span><span class="p">)</span>
<span class="c1"># arguments, no target, no target required</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">(),</span> <span class="s2">&quot;test&quot;</span><span class="p">,</span> <span class="s2">&quot;Your report has been filed.&quot;</span><span class="p">)</span>
<span class="c1"># arguments, custom success message</span>
<span class="n">custom_success</span> <span class="o">=</span> <span class="s2">&quot;custom success message&quot;</span>
<span class="n">cmd</span><span class="o">.</span><span class="n">success_msg</span> <span class="o">=</span> <span class="n">custom_success</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">(),</span> <span class="s2">&quot;test&quot;</span><span class="p">,</span> <span class="n">custom_success</span><span class="p">)</span>
<span class="c1"># arguments, no target, target required</span>
<span class="n">cmd</span><span class="o">.</span><span class="n">require_target</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">(),</span> <span class="s2">&quot;test&quot;</span><span class="p">,</span> <span class="s2">&quot;You must include a target.&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="TestReportCommands.test_ideas_list"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.tests.html#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_ideas_list">[docs]</a> <span class="nd">@patch</span><span class="o">.</span><span class="n">object</span><span class="p">(</span><span class="n">create</span><span class="p">,</span> <span class="s2">&quot;create_message&quot;</span><span class="p">,</span> <span class="n">new</span><span class="o">=</span><span class="n">MagicMock</span><span class="p">())</span>
<span class="nd">@patch</span><span class="o">.</span><span class="n">object</span><span class="p">(</span><span class="n">reports</span><span class="p">,</span> <span class="s2">&quot;datetime_format&quot;</span><span class="p">,</span> <span class="n">return_value</span><span class="o">=</span><span class="s2">&quot;now&quot;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">test_ideas_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mock_datetime_format</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">reports</span><span class="o">.</span><span class="n">CmdIdea</span>
<span class="n">fake_ideas</span> <span class="o">=</span> <span class="n">_MockQuerySet</span><span class="p">([</span><span class="n">TempMsg</span><span class="p">(</span><span class="n">message</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;idea </span><span class="si">{</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">)])</span>
<span class="n">expected</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
<span class="s2">Ideas you&#39;ve submitted:</span>
<span class="s2"> idea 1 (submitted now)</span>
<span class="s2"> idea 2 (submitted now)</span>
<span class="s2"> idea 3 (submitted now)</span>
<span class="s2">&quot;&quot;&quot;</span>
<span class="k">with</span> <span class="n">patch</span><span class="o">.</span><span class="n">object</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="s2">&quot;at_pre_cmd&quot;</span><span class="p">,</span> <span class="n">new</span><span class="o">=</span><span class="n">_mock_pre</span><span class="p">)</span> <span class="k">as</span> <span class="n">_</span><span class="p">:</span>
<span class="c1"># submitting an idea</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">(),</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="s2">&quot;You must provide a message.&quot;</span><span class="p">)</span>
<span class="c1"># arguments, no target, no target required</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">(),</span> <span class="s2">&quot;test&quot;</span><span class="p">,</span> <span class="s2">&quot;Thank you for your suggestion!&quot;</span><span class="p">)</span>
<span class="c1"># viewing your submitted ideas</span>
<span class="k">with</span> <span class="n">patch</span><span class="o">.</span><span class="n">object</span><span class="p">(</span><span class="n">reports</span><span class="o">.</span><span class="n">Msg</span><span class="o">.</span><span class="n">objects</span><span class="p">,</span> <span class="s2">&quot;search_message&quot;</span><span class="p">,</span> <span class="n">return_value</span><span class="o">=</span><span class="n">fake_ideas</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">(),</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">cmdstring</span><span class="o">=</span><span class="s2">&quot;ideas&quot;</span><span class="p">,</span> <span class="n">msg</span><span class="o">=</span><span class="n">expected</span><span class="p">)</span></div>
<div class="viewcode-block" id="TestReportCommands.test_cmd_manage_reports"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.ingame_reports.tests.html#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_cmd_manage_reports">[docs]</a> <span class="nd">@patch</span><span class="o">.</span><span class="n">object</span><span class="p">(</span><span class="n">reports</span><span class="o">.</span><span class="n">evmenu</span><span class="p">,</span> <span class="s2">&quot;EvMenu&quot;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">test_cmd_manage_reports</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">evmenu_mock</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">reports</span><span class="o">.</span><span class="n">CmdManageReports</span>
<span class="n">hub</span> <span class="o">=</span> <span class="n">Mock</span><span class="p">()</span>
<span class="k">with</span> <span class="n">patch</span><span class="o">.</span><span class="n">object</span><span class="p">(</span><span class="n">reports</span><span class="p">,</span> <span class="s2">&quot;_get_report_hub&quot;</span><span class="p">,</span> <span class="n">return_value</span><span class="o">=</span><span class="n">hub</span><span class="p">)</span> <span class="k">as</span> <span class="n">_</span><span class="p">:</span>
<span class="c1"># invalid report type fails</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call</span><span class="p">(</span>
<span class="n">cmd</span><span class="p">(),</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">cmdstring</span><span class="o">=</span><span class="s2">&quot;manage custom&quot;</span><span class="p">,</span> <span class="n">msg</span><span class="o">=</span><span class="s2">&quot;&#39;custom&#39; is not a valid report category.&quot;</span>
<span class="p">)</span>
<span class="c1"># verify valid type triggers evmenu</span>
<span class="bp">self</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">(),</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">cmdstring</span><span class="o">=</span><span class="s2">&quot;manage bugs&quot;</span><span class="p">)</span>
<span class="n">evmenu_mock</span><span class="o">.</span><span class="n">assert_called_once_with</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">account</span><span class="p">,</span>
<span class="n">menu</span><span class="p">,</span>
<span class="n">startnode</span><span class="o">=</span><span class="s2">&quot;menunode_list_reports&quot;</span><span class="p">,</span>
<span class="n">hub</span><span class="o">=</span><span class="n">hub</span><span class="p">,</span>
<span class="n">persistent</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">)</span></div></div>
</pre></div>
</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="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.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> 3.2.1.
</div>
</body>
</html>

View file

@ -148,6 +148,9 @@
<li><a href="evennia/contrib/base_systems/ingame_python/scripts.html">evennia.contrib.base_systems.ingame_python.scripts</a></li>
<li><a href="evennia/contrib/base_systems/ingame_python/tests.html">evennia.contrib.base_systems.ingame_python.tests</a></li>
<li><a href="evennia/contrib/base_systems/ingame_python/utils.html">evennia.contrib.base_systems.ingame_python.utils</a></li>
<li><a href="evennia/contrib/base_systems/ingame_reports/menu.html">evennia.contrib.base_systems.ingame_reports.menu</a></li>
<li><a href="evennia/contrib/base_systems/ingame_reports/reports.html">evennia.contrib.base_systems.ingame_reports.reports</a></li>
<li><a href="evennia/contrib/base_systems/ingame_reports/tests.html">evennia.contrib.base_systems.ingame_reports.tests</a></li>
<li><a href="evennia/contrib/base_systems/mux_comms_cmds/mux_comms_cmds.html">evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds</a></li>
<li><a href="evennia/contrib/base_systems/mux_comms_cmds/tests.html">evennia.contrib.base_systems.mux_comms_cmds.tests</a></li>
<li><a href="evennia/contrib/base_systems/unixcommand/tests.html">evennia.contrib.base_systems.unixcommand.tests</a></li>

View file

@ -2,6 +2,8 @@
## Main
- [Feat][pull3531]: New contrib; `in-game reports` for handling user reportgs,
bugs etc in-game (InspectorCaracal)
- [Feat][pull3586]: Add ANSI color support `|U`, `|I`, `|i`, `|s`, `|S` for
underline reset, italic/reset and strikethrough/reset (0xDEADFED5)
- [Fix][pull3550]: Issue where rpsystem contrib search would do a global instead
@ -18,6 +20,7 @@ underline reset, italic/reset and strikethrough/reset (0xDEADFED5)
[pull3571]: https://github.com/evennia/evennia/pull/3571
[pull3586]: https://github.com/evennia/evennia/pull/3586
[pull3550]: https://github.com/evennia/evennia/pull/3550
[pull3531]: https://github.com/evennia/evennia/pull/3531
## Evennia 4.2.0

View file

@ -1,5 +1,7 @@
# In-Game Reporting System
Contrib by InspectorCaracal, 2024
This contrib provides an in-game reports system, handling bug reports, player reports, and idea submissions by default. It also supports adding your own types of reports, or removing any of the default report types.
Each type of report has its own command for submitting new reports, and an admin command is also provided for managing the reports through a menu.
@ -116,7 +118,7 @@ class CmdCustomReport(ReportCmdBase):
Usage:
customreport <message>
This is a custom report type.
"""
@ -127,6 +129,7 @@ class CmdCustomReport(ReportCmdBase):
Add this new command to your default cmdset to enable filing your new report type.
----
<small>This document page is generated from `evennia/contrib/base_systems/ingame_reports/README.md`. Changes to this

View file

@ -177,9 +177,9 @@ this module carefully before continuing.
### `ingame_reports`
_This contrib provides an in-game reports system, handling bug reports, player reports, and idea submissions by default. It also supports adding your own types of reports, or removing any of the default report types._
_Contrib by InspectorCaracal, 2024_
Each type of report has its own command for submitting new reports, and an admin command is also provided for managing the reports through a menu.
This contrib provides an in-game reports system, handling bug reports, player reports, and idea submissions by default. It also supports adding your own types of reports, or removing any of the default report types.
[Read the documentation](./Contrib-Ingame-Reports.md) - [Browse the Code](evennia.contrib.base_systems.ingame_reports)

View file

@ -0,0 +1,19 @@
```{eval-rst}
evennia.contrib.base\_systems.ingame\_reports
=====================================================
.. automodule:: evennia.contrib.base_systems.ingame_reports
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 6
evennia.contrib.base_systems.ingame_reports.menu
evennia.contrib.base_systems.ingame_reports.reports
evennia.contrib.base_systems.ingame_reports.tests
```

View file

@ -0,0 +1,10 @@
```{eval-rst}
evennia.contrib.base\_systems.ingame\_reports.menu
=========================================================
.. automodule:: evennia.contrib.base_systems.ingame_reports.menu
:members:
:undoc-members:
:show-inheritance:
```

View file

@ -0,0 +1,10 @@
```{eval-rst}
evennia.contrib.base\_systems.ingame\_reports.reports
============================================================
.. automodule:: evennia.contrib.base_systems.ingame_reports.reports
:members:
:undoc-members:
:show-inheritance:
```

View file

@ -0,0 +1,10 @@
```{eval-rst}
evennia.contrib.base\_systems.ingame\_reports.tests
==========================================================
.. automodule:: evennia.contrib.base_systems.ingame_reports.tests
:members:
:undoc-members:
:show-inheritance:
```

View file

@ -19,6 +19,7 @@ evennia.contrib.base\_systems
evennia.contrib.base_systems.email_login
evennia.contrib.base_systems.godotwebsocket
evennia.contrib.base_systems.ingame_python
evennia.contrib.base_systems.ingame_reports
evennia.contrib.base_systems.menu_login
evennia.contrib.base_systems.mux_comms_cmds
evennia.contrib.base_systems.unixcommand

View file

@ -211,6 +211,16 @@
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.utils.html">evennia.contrib.base_systems.ingame_python.utils</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.html">evennia.contrib.base_systems.ingame_reports</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.menu.html">evennia.contrib.base_systems.ingame_reports.menu</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html">evennia.contrib.base_systems.ingame_reports.reports</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html#installation">Installation</a></li>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html#features">Features</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.tests.html">evennia.contrib.base_systems.ingame_reports.tests</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.html">evennia.contrib.base_systems.menu_login</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.connection_screens.html">evennia.contrib.base_systems.menu_login.connection_screens</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.menu_login.html">evennia.contrib.base_systems.menu_login.menu_login</a></li>

View file

@ -331,7 +331,7 @@ to accounts respectively.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.admin.CmdEmit.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['remit', 'pemit']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['pemit', 'remit']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -362,7 +362,7 @@ to accounts respectively.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.admin.CmdEmit.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'remit pemit', 'category': 'admin', 'key': 'emit', 'no_prefix': ' remit pemit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n remit [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n pemit [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'pemit remit', 'category': 'admin', 'key': 'emit', 'no_prefix': ' pemit remit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n remit [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n pemit [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -1415,7 +1415,7 @@ server settings.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.building.CmdTypeclass.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;type', '&#64;typeclasses', '&#64;parent', '&#64;swap', '&#64;update']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;swap', '&#64;update', '&#64;typeclasses', '&#64;parent', '&#64;type']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -1446,7 +1446,7 @@ server settings.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.building.CmdTypeclass.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;type &#64;typeclasses &#64;parent &#64;swap &#64;update', 'category': 'building', 'key': '&#64;typeclass', 'no_prefix': 'typeclass type typeclasses parent swap update', 'tags': '', 'text': &quot;\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] &lt;object&gt; [= typeclass.path]\n typeclass/prototype &lt;object&gt; = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;swap &#64;update &#64;typeclasses &#64;parent &#64;type', 'category': 'building', 'key': '&#64;typeclass', 'no_prefix': 'typeclass swap update typeclasses parent type', 'tags': '', 'text': &quot;\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] &lt;object&gt; [= typeclass.path]\n typeclass/prototype &lt;object&gt; = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -1601,7 +1601,7 @@ If object is not specified, the current location is examined.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.building.CmdExamine.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;ex', '&#64;exam']</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;exam', '&#64;ex']</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -1874,7 +1874,7 @@ the cases, see the module doc.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.building.CmdExamine.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;ex &#64;exam', 'category': 'building', 'key': '&#64;examine', 'no_prefix': 'examine ex exam', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [&lt;object&gt;[/attrname]]\n examine [*&lt;account&gt;[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n script - examine a Script\n channel - examine a Channel\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;exam &#64;ex', 'category': 'building', 'key': '&#64;examine', 'no_prefix': 'examine exam ex', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [&lt;object&gt;[/attrname]]\n examine [*&lt;account&gt;[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n script - examine a Script\n channel - examine a Channel\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

File diff suppressed because one or more lines are too long

View file

@ -282,7 +282,7 @@ for everyone to use, you need build privileges and the alias command.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.general.CmdNick.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['nicks', 'nickname']</em><a class="headerlink" href="#evennia.commands.default.general.CmdNick.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['nickname', 'nicks']</em><a class="headerlink" href="#evennia.commands.default.general.CmdNick.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -314,7 +314,7 @@ for everyone to use, you need build privileges and the alias command.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.general.CmdNick.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'nicks nickname', 'category': 'general', 'key': 'nick', 'no_prefix': ' nicks nickname', 'tags': '', 'text': '\n define a personal alias/nick by defining a string to\n match and replace it with another on the fly\n\n Usage:\n nick[/switches] &lt;string&gt; [= [replacement_string]]\n nick[/switches] &lt;template&gt; = &lt;replacement_template&gt;\n nick/delete &lt;string&gt; or number\n nicks\n\n Switches:\n inputline - replace on the inputline (default)\n object - replace on object-lookup\n account - replace on account-lookup\n list - show all defined aliases (also &quot;nicks&quot; works)\n delete - remove nick by index in /list\n clearall - clear all nicks\n\n Examples:\n nick hi = say Hello, I\'m Sarah!\n nick/object tom = the tall man\n nick build $1 $2 = create/drop $1;$2\n nick tell $1 $2=page $1=$2\n nick tm?$1=page tallman=$1\n nick tm\\=$1=page tallman=$1\n\n A \'nick\' is a personal string replacement. Use $1, $2, ... to catch arguments.\n Put the last $-marker without an ending space to catch all remaining text. You\n can also use unix-glob matching for the left-hand side &lt;string&gt;:\n\n * - matches everything\n ? - matches 0 or 1 single characters\n [abcd] - matches these chars in any order\n [!abcd] - matches everything not among these chars\n \\= - escape literal \'=\' you want in your &lt;string&gt;\n\n Note that no objects are actually renamed or changed by this command - your nicks\n are only available to you. If you want to permanently add keywords to an object\n for everyone to use, you need build privileges and the alias command.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdNick.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'nickname nicks', 'category': 'general', 'key': 'nick', 'no_prefix': ' nickname nicks', 'tags': '', 'text': '\n define a personal alias/nick by defining a string to\n match and replace it with another on the fly\n\n Usage:\n nick[/switches] &lt;string&gt; [= [replacement_string]]\n nick[/switches] &lt;template&gt; = &lt;replacement_template&gt;\n nick/delete &lt;string&gt; or number\n nicks\n\n Switches:\n inputline - replace on the inputline (default)\n object - replace on object-lookup\n account - replace on account-lookup\n list - show all defined aliases (also &quot;nicks&quot; works)\n delete - remove nick by index in /list\n clearall - clear all nicks\n\n Examples:\n nick hi = say Hello, I\'m Sarah!\n nick/object tom = the tall man\n nick build $1 $2 = create/drop $1;$2\n nick tell $1 $2=page $1=$2\n nick tm?$1=page tallman=$1\n nick tm\\=$1=page tallman=$1\n\n A \'nick\' is a personal string replacement. Use $1, $2, ... to catch arguments.\n Put the last $-marker without an ending space to catch all remaining text. You\n can also use unix-glob matching for the left-hand side &lt;string&gt;:\n\n * - matches everything\n ? - matches 0 or 1 single characters\n [abcd] - matches these chars in any order\n [!abcd] - matches everything not among these chars\n \\= - escape literal \'=\' you want in your &lt;string&gt;\n\n Note that no objects are actually renamed or changed by this command - your nicks\n are only available to you. If you want to permanently add keywords to an object\n for everyone to use, you need build privileges and the alias command.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdNick.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -611,7 +611,7 @@ placing it in their inventory.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.general.CmdSay.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&quot;', &quot;'&quot;]</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = [&quot;'&quot;, '&quot;']</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -642,7 +642,7 @@ placing it in their inventory.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.general.CmdSay.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&quot; \'', 'category': 'general', 'key': 'say', 'no_prefix': ' &quot; \'', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '\' &quot;', 'category': 'general', 'key': 'say', 'no_prefix': ' \' &quot;', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -722,7 +722,7 @@ automatically begin with your name.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.general.CmdPose.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = [':', 'emote']</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['emote', ':']</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -763,7 +763,7 @@ space.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.general.CmdPose.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ': emote', 'category': 'general', 'key': 'pose', 'no_prefix': ' : emote', 'tags': '', 'text': &quot;\n strike a pose\n\n Usage:\n pose &lt;pose text&gt;\n pose's &lt;pose text&gt;\n\n Example:\n pose is standing by the wall, smiling.\n -&gt; others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'emote :', 'category': 'general', 'key': 'pose', 'no_prefix': ' emote :', 'tags': '', 'text': &quot;\n strike a pose\n\n Usage:\n pose &lt;pose text&gt;\n pose's &lt;pose text&gt;\n\n Example:\n pose is standing by the wall, smiling.\n -&gt; others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -697,7 +697,7 @@ See <a href="#id11"><span class="problematic" id="id12">|</span></a>luhttps://ww
<dl class="py attribute">
<dt id="evennia.commands.default.system.CmdTasks.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;task', '&#64;delays']</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;delays', '&#64;task']</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -743,7 +743,7 @@ to all the variables defined therein.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.system.CmdTasks.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;task &#64;delays', 'category': 'system', 'key': '&#64;tasks', 'no_prefix': 'tasks task delays', 'tags': '', 'text': &quot;\n Display or terminate active tasks (delays).\n\n Usage:\n tasks[/switch] [task_id or function_name]\n\n Switches:\n pause - Pause the callback of a task.\n unpause - Process all callbacks made since pause() was called.\n do_task - Execute the task (call its callback).\n call - Call the callback of this task.\n remove - Remove a task without executing it.\n cancel - Stop a task from automatically executing.\n\n Notes:\n A task is a single use method of delaying the call of a function. Calls are created\n in code, using `evennia.utils.delay`.\n See |luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.\n\n By default, tasks that are canceled and never called are cleaned up after one minute.\n\n Examples:\n - `tasks/cancel move_callback` - Cancels all movement delays from the slow_exit contrib.\n In this example slow exits creates it's tasks with\n `utils.delay(move_delay, move_callback)`\n - `tasks/cancel 2` - Cancel task id 2.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;delays &#64;task', 'category': 'system', 'key': '&#64;tasks', 'no_prefix': 'tasks delays task', 'tags': '', 'text': &quot;\n Display or terminate active tasks (delays).\n\n Usage:\n tasks[/switch] [task_id or function_name]\n\n Switches:\n pause - Pause the callback of a task.\n unpause - Process all callbacks made since pause() was called.\n do_task - Execute the task (call its callback).\n call - Call the callback of this task.\n remove - Remove a task without executing it.\n cancel - Stop a task from automatically executing.\n\n Notes:\n A task is a single use method of delaying the call of a function. Calls are created\n in code, using `evennia.utils.delay`.\n See |luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.\n\n By default, tasks that are canceled and never called are cleaned up after one minute.\n\n Examples:\n - `tasks/cancel move_callback` - Cancels all movement delays from the slow_exit contrib.\n In this example slow exits creates it's tasks with\n `utils.delay(move_delay, move_callback)`\n - `tasks/cancel 2` - Cancel task id 2.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -980,7 +980,7 @@ main test suite started with</p>
<p>Test the batch processor.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.tests.TestBatchProcess.red_button">
<code class="sig-name descname">red_button</code><em class="property"> = &lt;module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmp_scktfmn/096100ee55549c0f73415bd692ad656cca288e8f/evennia/contrib/tutorials/red_button/red_button.py'&gt;</em><a class="headerlink" href="#evennia.commands.default.tests.TestBatchProcess.red_button" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">red_button</code><em class="property"> = &lt;module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpg82d_qk5/783dc46cd33652369623fc0c9ee2040139d3c86c/evennia/contrib/tutorials/red_button/red_button.py'&gt;</em><a class="headerlink" href="#evennia.commands.default.tests.TestBatchProcess.red_button" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">

View file

@ -136,7 +136,7 @@ connect “account name” “pass word”</p>
<dl class="py attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['conn', 'co', 'con']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['con', 'co', 'conn']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -171,7 +171,7 @@ there is no object yet before the account has logged in)</p>
<dl class="py attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'no_prefix': ' conn co con', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect &quot;account name&quot; &quot;pass word&quot;\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'con co conn', 'category': 'general', 'key': 'connect', 'no_prefix': ' con co conn', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect &quot;account name&quot; &quot;pass word&quot;\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -306,7 +306,7 @@ All it does is display the connect screen.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'look']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -332,7 +332,7 @@ All it does is display the connect screen.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' look l', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -153,7 +153,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['conn', 'co', 'con']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['con', 'co', 'conn']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -183,7 +183,7 @@ there is no object yet before the account has logged in)</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'no_prefix': ' conn co con', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect &lt;email&gt; &lt;password&gt;\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'con co conn', 'category': 'general', 'key': 'connect', 'no_prefix': ' con co conn', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect &lt;email&gt; &lt;password&gt;\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -311,7 +311,7 @@ All it does is display the connect screen.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'look']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -337,7 +337,7 @@ All it does is display the connect screen.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' look l', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -170,6 +170,16 @@
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.utils.html">evennia.contrib.base_systems.ingame_python.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.html">evennia.contrib.base_systems.ingame_reports</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.menu.html">evennia.contrib.base_systems.ingame_reports.menu</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html">evennia.contrib.base_systems.ingame_reports.reports</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html#installation">Installation</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html#features">Features</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.tests.html">evennia.contrib.base_systems.ingame_reports.tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.html">evennia.contrib.base_systems.menu_login</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.connection_screens.html">evennia.contrib.base_systems.menu_login.connection_screens</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.menu_login.html">evennia.contrib.base_systems.menu_login.menu_login</a></li>

View file

@ -130,7 +130,7 @@
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;calls', '&#64;callbacks', '&#64;callback']</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;callback', '&#64;calls', '&#64;callbacks']</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -211,7 +211,7 @@ on user permission.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;calls &#64;callbacks &#64;callback', 'category': 'building', 'key': '&#64;call', 'no_prefix': 'call calls callbacks callback', 'tags': '', 'text': '\n Command to edit callbacks.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;callback &#64;calls &#64;callbacks', 'category': 'building', 'key': '&#64;call', 'no_prefix': 'call callback calls callbacks', 'tags': '', 'text': '\n Command to edit callbacks.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -17,7 +17,7 @@
<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.base_systems.menu_login" href="evennia.contrib.base_systems.menu_login.html" />
<link rel="next" title="evennia.contrib.base_systems.ingame_reports" href="evennia.contrib.base_systems.ingame_reports.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_python.typeclasses" href="evennia.contrib.base_systems.ingame_python.typeclasses.html" />
</head><body>
@ -34,7 +34,7 @@
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.menu_login.html" title="evennia.contrib.base_systems.menu_login"
<a href="evennia.contrib.base_systems.ingame_reports.html" title="evennia.contrib.base_systems.ingame_reports"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.typeclasses.html" title="evennia.contrib.base_systems.ingame_python.typeclasses"
@ -72,8 +72,8 @@
<p class="topless"><a href="evennia.contrib.base_systems.ingame_python.typeclasses.html"
title="previous chapter">evennia.contrib.base_systems.ingame_python.typeclasses</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.menu_login.html"
title="next chapter">evennia.contrib.base_systems.menu_login</a></p>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_reports.html"
title="next chapter">evennia.contrib.base_systems.ingame_reports</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
@ -255,7 +255,7 @@ either “yes” or “okay” (maybe say I dont like it, but okay).</p
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.menu_login.html" title="evennia.contrib.base_systems.menu_login"
<a href="evennia.contrib.base_systems.ingame_reports.html" title="evennia.contrib.base_systems.ingame_reports"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.typeclasses.html" title="evennia.contrib.base_systems.ingame_python.typeclasses"

View file

@ -0,0 +1,170 @@
<!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/" />
<title>evennia.contrib.base_systems.ingame_reports &#8212; Evennia latest documentation</title>
<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.base_systems.ingame_reports.menu" href="evennia.contrib.base_systems.ingame_reports.menu.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_python.utils" href="evennia.contrib.base_systems.ingame_python.utils.html" />
</head><body>
<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.base_systems.ingame_reports.menu.html" title="evennia.contrib.base_systems.ingame_reports.menu"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.utils.html" title="evennia.contrib.base_systems.ingame_python.utils"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</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" accesskey="U">evennia.contrib.base_systems</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports</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.base_systems.ingame_python.utils.html"
title="previous chapter">evennia.contrib.base_systems.ingame_python.utils</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_reports.menu.html"
title="next chapter">evennia.contrib.base_systems.ingame_reports.menu</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.base_systems.ingame_reports.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="evennia.contrib.base_systems.ingame_reports.html">latest (main branch)</a></li>
<li><a href="../4.x/index.html">v4.0.0 branch (outdated)</a></li>
<li><a href="../3.x/index.html">v3.0.0 branch (outdated)</a></li>
<li><a href="../2.x/index.html">v2.0.0 branch (outdated)</a></li>
<li><a href="../1.x/index.html">v1.0.0 branch (outdated)</a></li>
<li><a href="../0.x/index.html">v0.9.5 branch (outdated)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.base_systems.ingame_reports">
<span id="evennia-contrib-base-systems-ingame-reports"></span><h1>evennia.contrib.base_systems.ingame_reports<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_reports" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.menu.html">evennia.contrib.base_systems.ingame_reports.menu</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html">evennia.contrib.base_systems.ingame_reports.reports</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html#features">Features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.tests.html">evennia.contrib.base_systems.ingame_reports.tests</a></li>
</ul>
</div>
</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.base_systems.ingame_reports.menu.html" title="evennia.contrib.base_systems.ingame_reports.menu"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.utils.html" title="evennia.contrib.base_systems.ingame_python.utils"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</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-this"><a href="">evennia.contrib.base_systems.ingame_reports</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> 3.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,180 @@
<!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/" />
<title>evennia.contrib.base_systems.ingame_reports.menu &#8212; Evennia latest documentation</title>
<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.base_systems.ingame_reports.reports" href="evennia.contrib.base_systems.ingame_reports.reports.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_reports" href="evennia.contrib.base_systems.ingame_reports.html" />
</head><body>
<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.base_systems.ingame_reports.reports.html" title="evennia.contrib.base_systems.ingame_reports.reports"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_reports.html" title="evennia.contrib.base_systems.ingame_reports"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</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.ingame_reports.html" accesskey="U">evennia.contrib.base_systems.ingame_reports</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.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.base_systems.ingame_reports.html"
title="previous chapter">evennia.contrib.base_systems.ingame_reports</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_reports.reports.html"
title="next chapter">evennia.contrib.base_systems.ingame_reports.reports</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.base_systems.ingame_reports.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="evennia.contrib.base_systems.ingame_reports.menu.html">latest (main branch)</a></li>
<li><a href="../4.x/index.html">v4.0.0 branch (outdated)</a></li>
<li><a href="../3.x/index.html">v3.0.0 branch (outdated)</a></li>
<li><a href="../2.x/index.html">v2.0.0 branch (outdated)</a></li>
<li><a href="../1.x/index.html">v1.0.0 branch (outdated)</a></li>
<li><a href="../0.x/index.html">v0.9.5 branch (outdated)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.base_systems.ingame_reports.menu">
<span id="evennia-contrib-base-systems-ingame-reports-menu"></span><h1>evennia.contrib.base_systems.ingame_reports.menu<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_reports.menu" title="Permalink to this headline"></a></h1>
<p>The report-management menu module.</p>
<dl class="py function">
<dt id="evennia.contrib.base_systems.ingame_reports.menu.menunode_list_reports">
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_reports.menu.</code><code class="sig-name descname">menunode_list_reports</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/base_systems/ingame_reports/menu.html#menunode_list_reports"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.menu.menunode_list_reports" title="Permalink to this definition"></a></dt>
<dd><p>Paginates and lists out reports for the provided hub</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.contrib.base_systems.ingame_reports.menu.menunode_choose_filter">
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_reports.menu.</code><code class="sig-name descname">menunode_choose_filter</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/base_systems/ingame_reports/menu.html#menunode_choose_filter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.menu.menunode_choose_filter" title="Permalink to this definition"></a></dt>
<dd><p>apply or clear a status filter to the main report view</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.contrib.base_systems.ingame_reports.menu.menunode_manage_report">
<code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_reports.menu.</code><code class="sig-name descname">menunode_manage_report</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="n">report</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/base_systems/ingame_reports/menu.html#menunode_manage_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.menu.menunode_manage_report" title="Permalink to this definition"></a></dt>
<dd><p>Read out the full report text and targets, and allow for changing the reports status.</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.base_systems.ingame_reports.reports.html" title="evennia.contrib.base_systems.ingame_reports.reports"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_reports.html" title="evennia.contrib.base_systems.ingame_reports"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</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.ingame_reports.html" >evennia.contrib.base_systems.ingame_reports</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.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> 3.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,536 @@
<!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/" />
<title>evennia.contrib.base_systems.ingame_reports.reports &#8212; Evennia latest documentation</title>
<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.base_systems.ingame_reports.tests" href="evennia.contrib.base_systems.ingame_reports.tests.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_reports.menu" href="evennia.contrib.base_systems.ingame_reports.menu.html" />
</head><body>
<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.base_systems.ingame_reports.tests.html" title="evennia.contrib.base_systems.ingame_reports.tests"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_reports.menu.html" title="evennia.contrib.base_systems.ingame_reports.menu"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</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.ingame_reports.html" accesskey="U">evennia.contrib.base_systems.ingame_reports</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.reports</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>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.contrib.base_systems.ingame_reports.reports</a><ul>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#features">Features</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_reports.menu.html"
title="previous chapter">evennia.contrib.base_systems.ingame_reports.menu</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_reports.tests.html"
title="next chapter">evennia.contrib.base_systems.ingame_reports.tests</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.base_systems.ingame_reports.reports.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="evennia.contrib.base_systems.ingame_reports.reports.html">latest (main branch)</a></li>
<li><a href="../4.x/index.html">v4.0.0 branch (outdated)</a></li>
<li><a href="../3.x/index.html">v3.0.0 branch (outdated)</a></li>
<li><a href="../2.x/index.html">v2.0.0 branch (outdated)</a></li>
<li><a href="../1.x/index.html">v1.0.0 branch (outdated)</a></li>
<li><a href="../0.x/index.html">v0.9.5 branch (outdated)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.base_systems.ingame_reports.reports">
<span id="evennia-contrib-base-systems-ingame-reports-reports"></span><h1>evennia.contrib.base_systems.ingame_reports.reports<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_reports.reports" title="Permalink to this headline"></a></h1>
<p>In-Game Reporting System</p>
<p>This contrib provides an in-game reporting system, with player-facing commands and a staff
management interface.</p>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
<p>To install, just add the provided cmdset to your default AccountCmdSet:</p>
<blockquote>
<div><p># in commands/default_cmdset.py</p>
<p>from evennia.contrib.base_systems.ingame_reports import ReportsCmdSet</p>
<dl>
<dt>class AccountCmdSet(default_cmds.AccountCmdSet):</dt><dd><p># …</p>
<dl class="simple">
<dt>def at_cmdset_creation(self):</dt><dd><p># …
self.add(ReportsCmdSet)</p>
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</section>
<section id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h2>
<p>The contrib provides three commands by default and their associated report types: <strong>CmdBug</strong>, <strong>CmdIdea</strong>,
and <strong>CmdReport</strong> (which is for reporting other players).</p>
<p>The <strong>ReportCmdBase</strong> class holds most of the functionality for creating new reports, providing a
convenient parent class for adding your own categories of reports.</p>
<p>The contrib can be further configured through two settings, <strong>INGAME_REPORT_TYPES</strong> and <strong>INGAME_REPORT_STATUS_TAGS</strong></p>
<dl class="py class">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_reports.reports.</code><code class="sig-name descname">CmdManageReports</code><span class="sig-paren">(</span><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/base_systems/ingame_reports/reports.html#CmdManageReports"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>manage the various reports</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>manage [report type]</p>
</dd>
<dt>Available report types:</dt><dd><p>bugs
ideas
players</p>
</dd>
</dl>
<p>Initializes a menu for reviewing and changing the status of current reports.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.key">
<code class="sig-name descname">key</code><em class="property"> = 'manage reports'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['manage ideas', 'manage bugs', 'manage players']</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:pperm(Admin)'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.get_help">
<code class="sig-name descname">get_help</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#CmdManageReports.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.get_help" title="Permalink to this definition"></a></dt>
<dd><p>Returns a help string containing the configured available report types</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#CmdManageReports.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.func" title="Permalink to this definition"></a></dt>
<dd><p>This is the hook function that actually does all the work. It is called
by the cmdhandler right after self.parser() finishes, and so has access
to all the variables defined therein.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:pperm(Admin)'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'manage ideas manage bugs manage players', 'category': 'general', 'key': 'manage reports', 'no_prefix': ' manage ideas manage bugs manage players', 'tags': '', 'text': '\n manage the various reports\n\n Usage:\n manage [report type]\n\n Available report types:\n bugs\n ideas\n players\n\n Initializes a menu for reviewing and changing the status of current reports.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_reports.reports.</code><code class="sig-name descname">ReportCmdBase</code><span class="sig-paren">(</span><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/base_systems/ingame_reports/reports.html#ReportCmdBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>A parent class for creating report commands. This help text may be displayed if
your commands help text is not properly configured.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'reports'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_locks">
<code class="sig-name descname">report_locks</code><em class="property"> = 'read:pperm(Admin)'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.require_target">
<code class="sig-name descname">require_target</code><em class="property"> = False</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.require_target" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.success_msg">
<code class="sig-name descname">success_msg</code><em class="property"> = 'Your report has been filed.'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.success_msg" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_type">
<code class="sig-name descname">report_type</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.at_pre_cmd">
<code class="sig-name descname">at_pre_cmd</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#ReportCmdBase.at_pre_cmd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.at_pre_cmd" title="Permalink to this definition"></a></dt>
<dd><p>validate that the needed hub script exists - if not, cancel the command</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.parse">
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#ReportCmdBase.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.parse" title="Permalink to this definition"></a></dt>
<dd><p>Parse the target and message out of the arguments.</p>
<p>Override if you want different syntax, but make sure to assign <strong>report_message</strong> and <strong>target_str</strong>.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.target_search">
<code class="sig-name descname">target_search</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">searchterm</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/base_systems/ingame_reports/reports.html#ReportCmdBase.target_search"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.target_search" title="Permalink to this definition"></a></dt>
<dd><p>Search for a target that matches the given search term. By default, does a normal search via the
caller - a local object search for a Character, or an account search for an Account.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>searchterm</strong> (<em>str</em>) </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>result (Object, Account, or None) - the result of the search</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.create_report">
<code class="sig-name descname">create_report</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</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/base_systems/ingame_reports/reports.html#ReportCmdBase.create_report"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.create_report" title="Permalink to this definition"></a></dt>
<dd><p>Creates the report. By default, this creates a Msg with any provided args and kwargs.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>success (bool) - True if the report was created successfully, or False if there was an issue.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#ReportCmdBase.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.func" title="Permalink to this definition"></a></dt>
<dd><p>This is the hook function that actually does all the work. It is called
by the cmdhandler right after self.parser() finishes, and so has access
to all the variables defined therein.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.key">
<code class="sig-name descname">key</code><em class="property"> = 'command'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'reports', 'key': 'command', 'no_prefix': ' ', 'tags': '', 'text': &quot;\n A parent class for creating report commands. This help text may be displayed if\n your command's help text is not properly configured.\n &quot;}</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_reports.reports.</code><code class="sig-name descname">CmdBug</code><span class="sig-paren">(</span><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/base_systems/ingame_reports/reports.html#CmdBug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase" title="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase</span></code></a></p>
<p>file a bug</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>bug [&lt;target&gt; =] &lt;message&gt;</p>
</dd>
</dl>
<p>Note: If a specific object, location or character is bugged, please target it for the report.</p>
<p class="rubric">Examples</p>
<p>bug hammer = This doesnt work as a crafting tool but it should
bug every time I go through a door I get the message twice</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.key">
<code class="sig-name descname">key</code><em class="property"> = 'bug'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.report_locks">
<code class="sig-name descname">report_locks</code><em class="property"> = 'read:pperm(Developer)'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.report_locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'reports'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'reports', 'key': 'bug', 'no_prefix': ' ', 'tags': '', 'text': &quot;\n file a bug\n\n Usage:\n bug [&lt;target&gt; =] &lt;message&gt;\n\n Note: If a specific object, location or character is bugged, please target it for the report.\n\n Examples:\n bug hammer = This doesn't work as a crafting tool but it should\n bug every time I go through a door I get the message twice\n &quot;}</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_reports.reports.</code><code class="sig-name descname">CmdReport</code><span class="sig-paren">(</span><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/base_systems/ingame_reports/reports.html#CmdReport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase" title="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase</span></code></a></p>
<p>report a player</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>report &lt;player&gt; = &lt;message&gt;</p>
</dd>
</dl>
<p>All player reports will be reviewed.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.key">
<code class="sig-name descname">key</code><em class="property"> = 'report'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.report_type">
<code class="sig-name descname">report_type</code><em class="property"> = 'player'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.report_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.require_target">
<code class="sig-name descname">require_target</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.require_target" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'reports'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'reports', 'key': 'report', 'no_prefix': ' ', 'tags': '', 'text': '\n report a player\n\n Usage:\n report &lt;player&gt; = &lt;message&gt;\n\n All player reports will be reviewed.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_reports.reports.</code><code class="sig-name descname">CmdIdea</code><span class="sig-paren">(</span><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/base_systems/ingame_reports/reports.html#CmdIdea"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase" title="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase</span></code></a></p>
<p>submit a suggestion</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>ideas
idea &lt;message&gt;</p>
</dd>
</dl>
<p class="rubric">Example</p>
<p>idea wouldnt it be cool if we had horses we could ride</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.key">
<code class="sig-name descname">key</code><em class="property"> = 'idea'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['ideas']</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.report_locks">
<code class="sig-name descname">report_locks</code><em class="property"> = 'read:pperm(Builder)'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.report_locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.success_msg">
<code class="sig-name descname">success_msg</code><em class="property"> = 'Thank you for your suggestion!'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.success_msg" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#CmdIdea.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.func" title="Permalink to this definition"></a></dt>
<dd><p>This is the hook function that actually does all the work. It is called
by the cmdhandler right after self.parser() finishes, and so has access
to all the variables defined therein.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'reports'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ideas', 'category': 'reports', 'key': 'idea', 'no_prefix': ' ideas', 'tags': '', 'text': &quot;\n submit a suggestion\n\n Usage:\n ideas\n idea &lt;message&gt;\n\n Example:\n idea wouldn't it be cool if we had horses we could ride\n &quot;}</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_reports.reports.</code><code class="sig-name descname">ReportsCmdSet</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/base_systems/ingame_reports/reports.html#ReportsCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet" 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>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.key">
<code class="sig-name descname">key</code><em class="property"> = 'Reports CmdSet'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.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/base_systems/ingame_reports/reports.html#ReportsCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.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.base_systems.ingame_reports.reports.ReportsCmdSet.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet'</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</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.base_systems.ingame_reports.tests.html" title="evennia.contrib.base_systems.ingame_reports.tests"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_reports.menu.html" title="evennia.contrib.base_systems.ingame_reports.menu"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</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.ingame_reports.html" >evennia.contrib.base_systems.ingame_reports</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.reports</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> 3.2.1.
</div>
</body>
</html>

View file

@ -0,0 +1,183 @@
<!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/" />
<title>evennia.contrib.base_systems.ingame_reports.tests &#8212; Evennia latest documentation</title>
<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.base_systems.menu_login" href="evennia.contrib.base_systems.menu_login.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_reports.reports" href="evennia.contrib.base_systems.ingame_reports.reports.html" />
</head><body>
<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.base_systems.menu_login.html" title="evennia.contrib.base_systems.menu_login"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_reports.reports.html" title="evennia.contrib.base_systems.ingame_reports.reports"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</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.ingame_reports.html" accesskey="U">evennia.contrib.base_systems.ingame_reports</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.tests</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.base_systems.ingame_reports.reports.html"
title="previous chapter">evennia.contrib.base_systems.ingame_reports.reports</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.menu_login.html"
title="next chapter">evennia.contrib.base_systems.menu_login</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.base_systems.ingame_reports.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="evennia.contrib.base_systems.ingame_reports.tests.html">latest (main branch)</a></li>
<li><a href="../4.x/index.html">v4.0.0 branch (outdated)</a></li>
<li><a href="../3.x/index.html">v3.0.0 branch (outdated)</a></li>
<li><a href="../2.x/index.html">v2.0.0 branch (outdated)</a></li>
<li><a href="../1.x/index.html">v1.0.0 branch (outdated)</a></li>
<li><a href="../0.x/index.html">v0.9.5 branch (outdated)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.base_systems.ingame_reports.tests">
<span id="evennia-contrib-base-systems-ingame-reports-tests"></span><h1>evennia.contrib.base_systems.ingame_reports.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_reports.tests" title="Permalink to this headline"></a></h1>
<dl class="py class">
<dt id="evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_reports.tests.</code><code class="sig-name descname">TestReportCommands</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/tests.html#TestReportCommands"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.EvenniaCommandTest" title="evennia.utils.test_resources.EvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaCommandTest</span></code></a></p>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_report_cmd_base">
<code class="sig-name descname">test_report_cmd_base</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/tests.html#TestReportCommands.test_report_cmd_base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_report_cmd_base" title="Permalink to this definition"></a></dt>
<dd><p>verify that the base command functionality works</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_ideas_list">
<code class="sig-name descname">test_ideas_list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_datetime_format</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/tests.html#TestReportCommands.test_ideas_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_ideas_list" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_cmd_manage_reports">
<code class="sig-name descname">test_cmd_manage_reports</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">evmenu_mock</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/tests.html#TestReportCommands.test_cmd_manage_reports"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_cmd_manage_reports" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</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.base_systems.menu_login.html" title="evennia.contrib.base_systems.menu_login"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_reports.reports.html" title="evennia.contrib.base_systems.ingame_reports.reports"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</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.ingame_reports.html" >evennia.contrib.base_systems.ingame_reports</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_reports.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> 3.2.1.
</div>
</body>
</html>

View file

@ -18,7 +18,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.contrib.base_systems.menu_login.connection_screens" href="evennia.contrib.base_systems.menu_login.connection_screens.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_python.utils" href="evennia.contrib.base_systems.ingame_python.utils.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_reports.tests" href="evennia.contrib.base_systems.ingame_reports.tests.html" />
</head><body>
@ -37,7 +37,7 @@
<a href="evennia.contrib.base_systems.menu_login.connection_screens.html" title="evennia.contrib.base_systems.menu_login.connection_screens"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.utils.html" title="evennia.contrib.base_systems.ingame_python.utils"
<a href="evennia.contrib.base_systems.ingame_reports.tests.html" title="evennia.contrib.base_systems.ingame_reports.tests"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
@ -68,8 +68,8 @@
</div>
<script>$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_python.utils.html"
title="previous chapter">evennia.contrib.base_systems.ingame_python.utils</a></p>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_reports.tests.html"
title="previous chapter">evennia.contrib.base_systems.ingame_reports.tests</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.menu_login.connection_screens.html"
title="next chapter">evennia.contrib.base_systems.menu_login.connection_screens</a></p>
@ -144,7 +144,7 @@
<a href="evennia.contrib.base_systems.menu_login.connection_screens.html" title="evennia.contrib.base_systems.menu_login.connection_screens"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.utils.html" title="evennia.contrib.base_systems.ingame_python.utils"
<a href="evennia.contrib.base_systems.ingame_reports.tests.html" title="evennia.contrib.base_systems.ingame_reports.tests"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>

View file

@ -174,7 +174,7 @@ aliases to an already joined channel.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['chanalias', 'aliaschan']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['aliaschan', 'chanalias']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -205,7 +205,7 @@ aliases to an already joined channel.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'chanalias aliaschan', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' chanalias aliaschan', 'tags': '', 'text': '\n Add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] &lt;channel&gt;\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'aliaschan chanalias', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' aliaschan chanalias', 'tags': '', 'text': '\n Add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] &lt;channel&gt;\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -231,7 +231,7 @@ for that channel.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['delaliaschan', 'delchanalias']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['delchanalias', 'delaliaschan']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -262,7 +262,7 @@ for that channel.</p>
<dl class="py attribute">
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'delaliaschan delchanalias', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delaliaschan delchanalias', 'tags': '', 'text': &quot;\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom &lt;alias or channel&gt;\n delcom/all &lt;channel&gt;\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n &quot;}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'delchanalias delaliaschan', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delchanalias delaliaschan', 'tags': '', 'text': &quot;\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom &lt;alias or channel&gt;\n delcom/all &lt;channel&gt;\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n &quot;}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -225,7 +225,7 @@ the operation will be general or on the room.</p>
<dl class="py attribute">
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['quit', 'chicken out', 'abort', 'q']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['quit', 'abort', 'chicken out', 'q']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@ -249,7 +249,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'quit chicken out abort q', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' quit chicken out abort q', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'quit abort chicken out q', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' quit abort chicken out q', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -385,7 +385,7 @@ shout</p>
<dl class="py attribute">
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = [';', 'whisper', 'shout']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['shout', 'whisper', ';']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -414,7 +414,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '; whisper shout', 'category': 'general', 'key': 'say', 'no_prefix': ' ; whisper shout', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say &lt;text&gt;\n whisper\n shout\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'shout whisper ;', 'category': 'general', 'key': 'say', 'no_prefix': ' shout whisper ;', 'tags': '', 'text': '\n Perform an communication action.\n\n Usage:\n say &lt;text&gt;\n whisper\n shout\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -442,7 +442,7 @@ emote /me points to /box and /lever.</p>
<dl class="py attribute">
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = [':', 'pose']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['pose', ':']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -481,7 +481,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ': pose', 'category': 'general', 'key': 'emote', 'no_prefix': ' : pose', 'tags': '', 'text': '\n Perform a free-form emote. Use /me to\n include yourself in the emote and /name\n to include other objects or characters.\n Use &quot;...&quot; to enact speech.\n\n Usage:\n emote &lt;emote&gt;\n :&lt;emote\n\n Example:\n emote /me smiles at /peter\n emote /me points to /box and /lever.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'pose :', 'category': 'general', 'key': 'emote', 'no_prefix': ' pose :', 'tags': '', 'text': '\n Perform a free-form emote. Use /me to\n include yourself in the emote and /name\n to include other objects or characters.\n Use &quot;...&quot; to enact speech.\n\n Usage:\n emote &lt;emote&gt;\n :&lt;emote\n\n Example:\n emote /me smiles at /peter\n emote /me points to /box and /lever.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -504,7 +504,7 @@ looks and what actions is available.</p>
<dl class="py attribute">
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['ex', 'e', 'examine', 'unfocus']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['examine', 'ex', 'e', 'unfocus']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -533,7 +533,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ex e examine unfocus', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' ex e examine unfocus', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus &lt;obj&gt;\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'examine ex e unfocus', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' examine ex e unfocus', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus &lt;obj&gt;\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -595,7 +595,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['inv', 'give', 'i', 'inventory']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['inventory', 'inv', 'i', 'give']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@ -619,7 +619,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'inv give i inventory', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inv give i inventory', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'inventory inv i give', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' inventory inv i give', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -289,7 +289,7 @@ achievements/progress rats</p>
<dl class="py attribute">
<dt id="evennia.contrib.game_systems.achievements.achievements.CmdAchieve.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['achieves', 'achieve', 'achievement']</em><a class="headerlink" href="#evennia.contrib.game_systems.achievements.achievements.CmdAchieve.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['achievement', 'achieves', 'achieve']</em><a class="headerlink" href="#evennia.contrib.game_systems.achievements.achievements.CmdAchieve.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -337,7 +337,7 @@ to all the variables defined therein.</p>
<dl class="py attribute">
<dt id="evennia.contrib.game_systems.achievements.achievements.CmdAchieve.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'achieves achieve achievement', 'category': 'general', 'key': 'achievements', 'no_prefix': ' achieves achieve achievement', 'tags': '', 'text': '\n view achievements\n\n Usage:\n achievements[/switches] [args]\n\n Switches:\n all View all achievements, including locked ones.\n completed View achievements you\'ve completed.\n progress View achievements you have partially completed\n\n Check your achievement statuses or browse the list. Providing a command argument\n will search all your currently unlocked achievements for matches, and the switches\n will filter the list to something other than &quot;all unlocked&quot;. Combining a command\n argument with a switch will search only in that list.\n\n Examples:\n achievements apples\n achievements/all\n achievements/progress rats\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.achievements.achievements.CmdAchieve.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'achievement achieves achieve', 'category': 'general', 'key': 'achievements', 'no_prefix': ' achievement achieves achieve', 'tags': '', 'text': '\n view achievements\n\n Usage:\n achievements[/switches] [args]\n\n Switches:\n all View all achievements, including locked ones.\n completed View achievements you\'ve completed.\n progress View achievements you have partially completed\n\n Check your achievement statuses or browse the list. Providing a command argument\n will search all your currently unlocked achievements for matches, and the switches\n will filter the list to something other than &quot;all unlocked&quot;. Combining a command\n argument with a switch will search only in that list.\n\n Examples:\n achievements apples\n achievements/all\n achievements/progress rats\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.achievements.achievements.CmdAchieve.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -759,7 +759,7 @@ try to influence the other part in the deal.</p>
<dl class="py attribute">
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['deal', 'offers']</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['offers', 'deal']</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -785,7 +785,7 @@ try to influence the other part in the deal.</p>
<dl class="py attribute">
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'deal offers', 'category': 'trading', 'key': 'status', 'no_prefix': ' deal offers', 'tags': '', 'text': &quot;\n show a list of the current deal\n\n Usage:\n status\n deal\n offers\n\n Shows the currently suggested offers on each sides of the deal. To\n accept the current deal, use the 'accept' command. Use 'offer' to\n change your deal. You might also want to use 'say', 'emote' etc to\n try to influence the other part in the deal.\n &quot;}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'offers deal', 'category': 'trading', 'key': 'status', 'no_prefix': ' offers deal', 'tags': '', 'text': &quot;\n show a list of the current deal\n\n Usage:\n status\n deal\n offers\n\n Shows the currently suggested offers on each sides of the deal. To\n accept the current deal, use the 'accept' command. Use 'offer' to\n change your deal. You might also want to use 'say', 'emote' etc to\n try to influence the other part in the deal.\n &quot;}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -173,6 +173,16 @@ useful but are deemed too game-specific to go into the core library.</p>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.utils.html">evennia.contrib.base_systems.ingame_python.utils</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.html">evennia.contrib.base_systems.ingame_reports</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.menu.html">evennia.contrib.base_systems.ingame_reports.menu</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html">evennia.contrib.base_systems.ingame_reports.reports</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html#installation">Installation</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html#features">Features</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.tests.html">evennia.contrib.base_systems.ingame_reports.tests</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.html">evennia.contrib.base_systems.menu_login</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.connection_screens.html">evennia.contrib.base_systems.menu_login.connection_screens</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.menu_login.html">evennia.contrib.base_systems.menu_login.menu_login</a></li>

View file

@ -736,7 +736,7 @@ commands the caller can use.</p>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&quot;', &quot;'&quot;]</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = [&quot;'&quot;, '&quot;']</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -767,7 +767,7 @@ commands the caller can use.</p>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&quot; \'', 'category': 'general', 'key': 'say', 'no_prefix': ' &quot; \'', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '\' &quot;', 'category': 'general', 'key': 'say', 'no_prefix': ' \' &quot;', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -908,7 +908,7 @@ Using the command without arguments will list all current recogs.</p>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.rpsystem.rpsystem.CmdRecog.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['forget', 'recognize']</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdRecog.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['recognize', 'forget']</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdRecog.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@ -935,7 +935,7 @@ Using the command without arguments will list all current recogs.</p>
<dl class="py attribute">
<dt id="evennia.contrib.rpg.rpsystem.rpsystem.CmdRecog.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'forget recognize', 'category': 'general', 'key': 'recog', 'no_prefix': ' forget recognize', 'tags': '', 'text': '\n Recognize another person in the same room.\n\n Usage:\n recog\n recog sdesc as alias\n forget alias\n\n Example:\n recog tall man as Griatch\n forget griatch\n\n This will assign a personal alias for a person, or forget said alias.\n Using the command without arguments will list all current recogs.\n\n '}</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdRecog.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'recognize forget', 'category': 'general', 'key': 'recog', 'no_prefix': ' recognize forget', 'tags': '', 'text': '\n Recognize another person in the same room.\n\n Usage:\n recog\n recog sdesc as alias\n forget alias\n\n Example:\n recog tall man as Griatch\n forget griatch\n\n This will assign a personal alias for a person, or forget said alias.\n Using the command without arguments will list all current recogs.\n\n '}</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdRecog.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -480,7 +480,7 @@ turn of combat, performing everyones actions in random order.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['turnbased combat', 'hit']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['hit', 'turnbased combat']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -526,7 +526,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'turnbased combat hit', 'category': 'general', 'key': 'attack', 'no_prefix': ' turnbased combat hit', 'tags': '', 'text': '\n Start or join combat.\n\n Usage:\n attack [&lt;target&gt;]\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hit turnbased combat', 'category': 'general', 'key': 'attack', 'no_prefix': ' hit turnbased combat', 'tags': '', 'text': '\n Start or join combat.\n\n Usage:\n attack [&lt;target&gt;]\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -491,7 +491,7 @@ boost INT Wizard Goblin</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.combat_twitch.CmdStunt.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['boost', 'foil']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_twitch.CmdStunt.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['foil', 'boost']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_twitch.CmdStunt.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -525,7 +525,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.combat_twitch.CmdStunt.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'boost foil', 'category': 'combat', 'key': 'stunt', 'no_prefix': ' boost foil', 'tags': '', 'text': '\n Perform a combat stunt, that boosts an ally against a target, or\n foils an enemy, giving them disadvantage against an ally.\n\n Usage:\n boost [ability] &lt;recipient&gt; &lt;target&gt;\n foil [ability] &lt;recipient&gt; &lt;target&gt;\n boost [ability] &lt;target&gt; (same as boost me &lt;target&gt;)\n foil [ability] &lt;target&gt; (same as foil &lt;target&gt; me)\n\n Example:\n boost STR me Goblin\n boost DEX Goblin\n foil STR Goblin me\n foil INT Goblin\n boost INT Wizard Goblin\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_twitch.CmdStunt.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'foil boost', 'category': 'combat', 'key': 'stunt', 'no_prefix': ' foil boost', 'tags': '', 'text': '\n Perform a combat stunt, that boosts an ally against a target, or\n foils an enemy, giving them disadvantage against an ally.\n\n Usage:\n boost [ability] &lt;recipient&gt; &lt;target&gt;\n foil [ability] &lt;recipient&gt; &lt;target&gt;\n boost [ability] &lt;target&gt; (same as boost me &lt;target&gt;)\n foil [ability] &lt;target&gt; (same as foil &lt;target&gt; me)\n\n Example:\n boost STR me Goblin\n boost DEX Goblin\n foil STR Goblin me\n foil INT Goblin\n boost INT Wizard Goblin\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_twitch.CmdStunt.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -307,7 +307,7 @@ unwear &lt;item&gt;</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['unwield', 'unwear']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['unwear', 'unwield']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@ -331,7 +331,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'unwield unwear', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwield unwear', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove &lt;item&gt;\n unwield &lt;item&gt;\n unwear &lt;item&gt;\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'unwear unwield', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwear unwield', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove &lt;item&gt;\n unwield &lt;item&gt;\n unwear &lt;item&gt;\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -167,7 +167,7 @@ such as when closing the lid and un-blinding a character.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['press', 'push', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['push', 'press button', 'press']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -196,7 +196,7 @@ check if the lid is open or closed.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'no_prefix': ' press push press button', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push press button press', 'category': 'general', 'key': 'push button', 'no_prefix': ' push press button press', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -393,7 +393,7 @@ be mutually exclusive.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['press', 'push', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['push', 'press button', 'press']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -422,7 +422,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'no_prefix': ' press push press button', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push press button press', 'category': 'general', 'key': 'push button', 'no_prefix': ' push press button press', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -520,7 +520,7 @@ be mutually exclusive.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['examine', 'ex', 'feel', 'get', 'listen', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['feel', 'ex', 'l', 'examine', 'listen', 'get']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -546,7 +546,7 @@ be mutually exclusive.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'examine ex feel get listen l', 'category': 'general', 'key': 'look', 'no_prefix': ' examine ex feel get listen l', 'tags': '', 'text': &quot;\n Looking around in darkness\n\n Usage:\n look &lt;obj&gt;\n\n ... not that there's much to see in the dark.\n\n &quot;}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'feel ex l examine listen get', 'category': 'general', 'key': 'look', 'no_prefix': ' feel ex l examine listen get', 'tags': '', 'text': &quot;\n Looking around in darkness\n\n Usage:\n look &lt;obj&gt;\n\n ... not that there's much to see in the dark.\n\n &quot;}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -439,7 +439,7 @@ of the object. We overload it with our own version.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdLight.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['light', 'burn']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['burn', 'light']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -466,7 +466,7 @@ to sit on a “lightable” object, we operate only on self.obj.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdLight.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'light burn', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' light burn', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'burn light', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' burn light', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -570,7 +570,7 @@ shift green root up/down</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['push', 'shiftroot', 'pull', 'move']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['move', 'shiftroot', 'push', 'pull']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -606,7 +606,7 @@ yellow/green - horizontal roots</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push shiftroot pull move', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' push shiftroot pull move', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'move shiftroot push pull', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' move shiftroot push pull', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -793,7 +793,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['thrust', 'kill', 'chop', 'slash', 'fight', 'bash', 'parry', 'defend', 'hit', 'stab', 'pierce']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['kill', 'slash', 'fight', 'stab', 'defend', 'hit', 'bash', 'pierce', 'thrust', 'parry', 'chop']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -819,7 +819,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'thrust kill chop slash fight bash parry defend hit stab pierce', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' thrust kill chop slash fight bash parry defend hit stab pierce', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab &lt;enemy&gt;\n slash &lt;enemy&gt;\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'kill slash fight stab defend hit bash pierce thrust parry chop', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' kill slash fight stab defend hit bash pierce thrust parry chop', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab &lt;enemy&gt;\n slash &lt;enemy&gt;\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -982,7 +982,7 @@ to find something.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['feel around', 'fiddle', 'search', 'feel', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['fiddle', 'search', 'feel', 'l', 'feel around']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -1010,7 +1010,7 @@ random chance of eventually finding a light source.</p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'feel around fiddle search feel l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' feel around fiddle search feel l', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'fiddle search feel l feel around', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' fiddle search feel l feel around', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -222,7 +222,7 @@ git evennia pull - Pull the latest evennia code.</p>
<dl class="py attribute">
<dt id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.directory">
<code class="sig-name descname">directory</code><em class="property"> = '/tmp/tmp_scktfmn/096100ee55549c0f73415bd692ad656cca288e8f/evennia'</em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.directory" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">directory</code><em class="property"> = '/tmp/tmpg82d_qk5/783dc46cd33652369623fc0c9ee2040139d3c86c/evennia'</em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.directory" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -283,7 +283,7 @@ git pull - Pull the latest code from your current branch.</p>
<dl class="py attribute">
<dt id="evennia.contrib.utils.git_integration.git_integration.CmdGit.directory">
<code class="sig-name descname">directory</code><em class="property"> = '/tmp/tmp_scktfmn/096100ee55549c0f73415bd692ad656cca288e8f/evennia/game_template'</em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.directory" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">directory</code><em class="property"> = '/tmp/tmpg82d_qk5/783dc46cd33652369623fc0c9ee2040139d3c86c/evennia/game_template'</em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.directory" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">

View file

@ -323,6 +323,16 @@ with q, remove the break line and restart server when finished.</p></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.ingame_python.utils.html">evennia.contrib.base_systems.ingame_python.utils</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.html">evennia.contrib.base_systems.ingame_reports</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.menu.html">evennia.contrib.base_systems.ingame_reports.menu</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html">evennia.contrib.base_systems.ingame_reports.reports</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html#installation">Installation</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.reports.html#features">Features</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.ingame_reports.tests.html">evennia.contrib.base_systems.ingame_reports.tests</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.html">evennia.contrib.base_systems.menu_login</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.connection_screens.html">evennia.contrib.base_systems.menu_login.connection_screens</a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.base_systems.menu_login.menu_login.html">evennia.contrib.base_systems.menu_login.menu_login</a></li>

View file

@ -356,7 +356,7 @@ indentation.</p>
<dl class="py attribute">
<dt id="evennia.utils.eveditor.CmdEditorGroup.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = [':', ':&lt;', ':y', ':r', ':s', ':=', ':x', ':u', ':!', ':i', '::', ':I', ':j', ':::', ':A', ':f', ':S', ':fd', ':dd', ':q!', ':dw', ':echo', ':uu', ':wq', ':w', ':UU', ':DD', ':q', ':h', ':p', ':fi', ':&gt;']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = [':dw', ':', ':q', ':y', ':w', ':x', ':!', ':u', ':wq', ':fi', ':fd', ':::', '::', ':h', ':A', ':dd', ':p', ':&lt;', ':UU', ':j', ':I', ':=', ':f', ':DD', ':r', ':s', ':i', ':S', ':uu', ':echo', ':q!', ':&gt;']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -384,7 +384,7 @@ efficient presentation.</p>
<dl class="py attribute">
<dt id="evennia.utils.eveditor.CmdEditorGroup.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ': :&lt; :y :r :s := :x :u :! :i :: :I :j ::: :A :f :S :fd :dd :q! :dw :echo :uu :wq :w :UU :DD :q :h :p :fi :&gt;', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' : :&lt; :y :r :s := :x :u :! :i :: :I :j ::: :A :f :S :fd :dd :q! :dw :echo :uu :wq :w :UU :DD :q :h :p :fi :&gt;', 'tags': '', 'text': '\n Commands for the editor\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ':dw : :q :y :w :x :! :u :wq :fi :fd ::: :: :h :A :dd :p :&lt; :UU :j :I := :f :DD :r :s :i :S :uu :echo :q! :&gt;', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :dw : :q :y :w :x :! :u :wq :fi :fd ::: :: :h :A :dd :p :&lt; :UU :j :I := :f :DD :r :s :i :S :uu :echo :q! :&gt;', 'tags': '', 'text': '\n Commands for the editor\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -955,7 +955,7 @@ single question.</p>
<dl class="py attribute">
<dt id="evennia.utils.evmenu.CmdYesNoQuestion.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['no', 'a', 'y', 'yes', 'abort', '__nomatch_command', 'n']</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['__nomatch_command', 'no', 'y', 'abort', 'n', 'a', 'yes']</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -981,7 +981,7 @@ single question.</p>
<dl class="py attribute">
<dt id="evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'no a y yes abort __nomatch_command n', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' no a y yes abort __nomatch_command n', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '__nomatch_command no y abort n a yes', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' __nomatch_command no y abort n a yes', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -151,7 +151,7 @@ the <strong>caller.msg()</strong> construct every time the page is updated.</p>
<dl class="py attribute">
<dt id="evennia.utils.evmore.CmdMore.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['e', 'a', 'end', 'q', 'next', 'p', 'top', 'abort', 't', 'quit', 'previous', 'n']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['end', 'previous', 'abort', 'n', 'p', 'quit', 'a', 't', 'q', 'top', 'e', 'next']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -177,7 +177,7 @@ the <strong>caller.msg()</strong> construct every time the page is updated.</p>
<dl class="py attribute">
<dt id="evennia.utils.evmore.CmdMore.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'e a end q next p top abort t quit previous n', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' e a end q next p top abort t quit previous n', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'end previous abort n p quit a t q top e next', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' end previous abort n p quit a t q top e next', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

View file

@ -541,6 +541,8 @@
<li><a href="api/evennia.commands.default.comms.html#evennia.commands.default.comms.CmdPage.account_caller">(evennia.commands.default.comms.CmdPage attribute)</a>
</li>
<li><a href="api/evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxAccountCommand.account_caller">(evennia.commands.default.muxcommand.MuxAccountCommand attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.account_caller">(evennia.contrib.base_systems.ingame_reports.reports.CmdReport attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.account_caller">(evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom attribute)</a>
</li>
@ -1049,6 +1051,16 @@
<li><a href="api/evennia.contrib.base_systems.email_login.email_login.html#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.aliases">(evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_python.commands.html#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases">(evennia.contrib.base_systems.ingame_python.commands.CmdCallback attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.aliases">(evennia.contrib.base_systems.ingame_reports.reports.CmdBug attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.aliases">(evennia.contrib.base_systems.ingame_reports.reports.CmdIdea attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.aliases">(evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.aliases">(evennia.contrib.base_systems.ingame_reports.reports.CmdReport attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.aliases">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases">(evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom attribute)</a>
</li>
@ -1615,12 +1627,12 @@
</li>
<li><a href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject.appearance_template">appearance_template (evennia.objects.objects.DefaultObject attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.append">append() (evennia.locks.lockhandler.LockHandler method)</a>
</li>
<li><a href="api/evennia.server.portal.telnet.html#evennia.server.portal.telnet.TelnetProtocol.applicationDataReceived">applicationDataReceived() (evennia.server.portal.telnet.TelnetProtocol method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/evennia.contrib.tutorials.evadventure.chargen.html#evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet.apply">apply() (evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet method)</a>
</li>
<li><a href="api/evennia.contrib.game_systems.turnbattle.tb_basic.html#evennia.contrib.game_systems.turnbattle.tb_basic.BasicCombatRules.apply_damage">apply_damage() (evennia.contrib.game_systems.turnbattle.tb_basic.BasicCombatRules method)</a>
@ -1861,6 +1873,8 @@
<li><a href="api/evennia.commands.default.cmdset_unloggedin.html#evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet.at_cmdset_creation">(evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.building_menu.building_menu.html#evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet.at_cmdset_creation">(evennia.contrib.base_systems.building_menu.building_menu.BuildingMenuCmdSet method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.at_cmdset_creation">(evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet method)</a>
</li>
<li><a href="api/evennia.contrib.full_systems.evscaperoom.commands.html#evennia.contrib.full_systems.evscaperoom.commands.CmdSetEvScapeRoom.at_cmdset_creation">(evennia.contrib.full_systems.evscaperoom.commands.CmdSetEvScapeRoom method)</a>
</li>
@ -2495,6 +2509,8 @@
<li><a href="api/evennia.commands.default.unloggedin.html#evennia.commands.default.unloggedin.CmdUnconnectedCreate.at_pre_cmd">(evennia.commands.default.unloggedin.CmdUnconnectedCreate method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.email_login.email_login.html#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.at_pre_cmd">(evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.at_pre_cmd">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase method)</a>
</li>
</ul></li>
<li><a href="api/evennia.contrib.game_systems.turnbattle.tb_equip.html#evennia.contrib.game_systems.turnbattle.tb_equip.TBEArmor.at_pre_drop">at_pre_drop() (evennia.contrib.game_systems.turnbattle.tb_equip.TBEArmor method)</a>
@ -3800,6 +3816,8 @@
<li><a href="api/evennia.contrib.tutorials.tutorial_world.rooms.html#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp">CmdBridgeHelp (class in evennia.contrib.tutorials.tutorial_world.rooms)</a>
</li>
<li><a href="api/evennia.contrib.rpg.buffs.buff.html#evennia.contrib.rpg.buffs.buff.CmdBuff">CmdBuff (class in evennia.contrib.rpg.buffs.buff)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdBug">CmdBug (class in evennia.contrib.base_systems.ingame_reports.reports)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_python.commands.html#evennia.contrib.base_systems.ingame_python.commands.CmdCallback">CmdCallback (class in evennia.contrib.base_systems.ingame_python.commands)</a>
</li>
@ -4000,6 +4018,8 @@
<li><a href="api/evennia.commands.default.general.html#evennia.commands.default.general.CmdHome">CmdHome (class in evennia.commands.default.general)</a>
</li>
<li><a href="api/evennia.commands.default.account.html#evennia.commands.default.account.CmdIC">CmdIC (class in evennia.commands.default.account)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea">CmdIdea (class in evennia.contrib.base_systems.ingame_reports.reports)</a>
</li>
<li><a href="api/evennia.commands.default.tests.html#evennia.commands.default.tests.CmdInterrupt">CmdInterrupt (class in evennia.commands.default.tests)</a>
</li>
@ -4050,6 +4070,8 @@
<li><a href="api/evennia.contrib.game_systems.mail.mail.html#evennia.contrib.game_systems.mail.mail.CmdMail">CmdMail (class in evennia.contrib.game_systems.mail.mail)</a>
</li>
<li><a href="api/evennia.contrib.game_systems.mail.mail.html#evennia.contrib.game_systems.mail.mail.CmdMailCharacter">CmdMailCharacter (class in evennia.contrib.game_systems.mail.mail)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports">CmdManageReports (class in evennia.contrib.base_systems.ingame_reports.reports)</a>
</li>
<li><a href="api/evennia.contrib.grid.ingame_map_display.ingame_map_display.html#evennia.contrib.grid.ingame_map_display.ingame_map_display.CmdMap">CmdMap (class in evennia.contrib.grid.ingame_map_display.ingame_map_display)</a>
@ -4161,6 +4183,8 @@
<li><a href="api/evennia.contrib.tutorials.evadventure.commands.html#evennia.contrib.tutorials.evadventure.commands.CmdRemove">(class in evennia.contrib.tutorials.evadventure.commands)</a>
</li>
</ul></li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdReport">CmdReport (class in evennia.contrib.base_systems.ingame_reports.reports)</a>
</li>
<li><a href="api/evennia.contrib.full_systems.evscaperoom.commands.html#evennia.contrib.full_systems.evscaperoom.commands.CmdRerouter">CmdRerouter (class in evennia.contrib.full_systems.evscaperoom.commands)</a>
</li>
<li><a href="api/evennia.commands.default.system.html#evennia.commands.default.system.CmdReset">CmdReset (class in evennia.commands.default.system)</a>
@ -4926,6 +4950,8 @@
<li><a href="api/evennia.contrib.tutorials.evadventure.dungeon.html#evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranch.create_out_exit">create_out_exit() (evennia.contrib.tutorials.evadventure.dungeon.EvAdventureDungeonBranch method)</a>
</li>
<li><a href="api/evennia.prototypes.prototypes.html#evennia.prototypes.prototypes.create_prototype">create_prototype() (in module evennia.prototypes.prototypes)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.create_report">create_report() (evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase method)</a>
</li>
<li><a href="api/evennia.utils.test_resources.html#evennia.utils.test_resources.EvenniaTestMixin.create_rooms">create_rooms() (evennia.utils.test_resources.EvenniaTestMixin method)</a>
</li>
@ -6833,6 +6859,34 @@
<ul>
<li><a href="api/evennia.contrib.base_systems.ingame_python.utils.html#module-evennia.contrib.base_systems.ingame_python.utils">module</a>
</li>
</ul></li>
<li>
evennia.contrib.base_systems.ingame_reports
<ul>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.html#module-evennia.contrib.base_systems.ingame_reports">module</a>
</li>
</ul></li>
<li>
evennia.contrib.base_systems.ingame_reports.menu
<ul>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.menu.html#module-evennia.contrib.base_systems.ingame_reports.menu">module</a>
</li>
</ul></li>
<li>
evennia.contrib.base_systems.ingame_reports.reports
<ul>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#module-evennia.contrib.base_systems.ingame_reports.reports">module</a>
</li>
</ul></li>
<li>
evennia.contrib.base_systems.ingame_reports.tests
<ul>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.tests.html#module-evennia.contrib.base_systems.ingame_reports.tests">module</a>
</li>
</ul></li>
<li>
@ -7661,6 +7715,8 @@
<li><a href="api/evennia.contrib.tutorials.evadventure.combat_twitch.html#module-evennia.contrib.tutorials.evadventure.combat_twitch">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
evennia.contrib.tutorials.evadventure.commands
@ -7675,8 +7731,6 @@
<li><a href="api/evennia.contrib.tutorials.evadventure.dungeon.html#module-evennia.contrib.tutorials.evadventure.dungeon">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
evennia.contrib.tutorials.evadventure.enums
@ -10023,6 +10077,12 @@
<li><a href="api/evennia.contrib.base_systems.email_login.email_login.html#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.func">(evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_python.commands.html#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.func">(evennia.contrib.base_systems.ingame_python.commands.CmdCallback method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.func">(evennia.contrib.base_systems.ingame_reports.reports.CmdIdea method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.func">(evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.func">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.func">(evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom method)</a>
</li>
@ -10881,14 +10941,14 @@
</li>
<li><a href="api/evennia.web.api.serializers.html#evennia.web.api.serializers.ObjectDBSerializer.get_exits">get_exits() (evennia.web.api.serializers.ObjectDBSerializer static method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount.get_extra_display_name_info">get_extra_display_name_info() (evennia.accounts.accounts.DefaultAccount method)</a>
<ul>
<li><a href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject.get_extra_display_name_info">(evennia.objects.objects.DefaultObject method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/evennia.commands.command.html#evennia.commands.command.Command.get_extra_info">get_extra_info() (evennia.commands.command.Command method)</a>
<ul>
@ -10931,6 +10991,8 @@
<ul>
<li><a href="api/evennia.contrib.base_systems.ingame_python.commands.html#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.get_help">(evennia.contrib.base_systems.ingame_python.commands.CmdCallback method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.get_help">(evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.unixcommand.unixcommand.html#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.get_help">(evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand method)</a>
</li>
@ -11701,6 +11763,16 @@
<li><a href="api/evennia.contrib.base_systems.email_login.email_login.html#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.help_category">(evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_python.commands.html#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.help_category">(evennia.contrib.base_systems.ingame_python.commands.CmdCallback attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.help_category">(evennia.contrib.base_systems.ingame_reports.reports.CmdBug attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.help_category">(evennia.contrib.base_systems.ingame_reports.reports.CmdIdea attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.help_category">(evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.help_category">(evennia.contrib.base_systems.ingame_reports.reports.CmdReport attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.help_category">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.help_category">(evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom attribute)</a>
</li>
@ -12873,6 +12945,18 @@
<li><a href="api/evennia.contrib.base_systems.email_login.email_login.html#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.key">(evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_python.commands.html#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.key">(evennia.contrib.base_systems.ingame_python.commands.CmdCallback attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.key">(evennia.contrib.base_systems.ingame_reports.reports.CmdBug attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.key">(evennia.contrib.base_systems.ingame_reports.reports.CmdIdea attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.key">(evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.key">(evennia.contrib.base_systems.ingame_reports.reports.CmdReport attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.key">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.key">(evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.key">(evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom attribute)</a>
</li>
@ -13845,6 +13929,16 @@
<li><a href="api/evennia.contrib.base_systems.email_login.email_login.html#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.lock_storage">(evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_python.commands.html#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.lock_storage">(evennia.contrib.base_systems.ingame_python.commands.CmdCallback attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.lock_storage">(evennia.contrib.base_systems.ingame_reports.reports.CmdBug attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.lock_storage">(evennia.contrib.base_systems.ingame_reports.reports.CmdIdea attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.lock_storage">(evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.lock_storage">(evennia.contrib.base_systems.ingame_reports.reports.CmdReport attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.lock_storage">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.lock_storage">(evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom attribute)</a>
</li>
@ -14439,6 +14533,8 @@
<li><a href="api/evennia.contrib.base_systems.email_login.email_login.html#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.locks">(evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_python.commands.html#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.locks">(evennia.contrib.base_systems.ingame_python.commands.CmdCallback attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.locks">(evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.locks">(evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom attribute)</a>
</li>
@ -14972,8 +15068,14 @@
<li><a href="api/evennia.contrib.tutorials.talking_npc.talking_npc.html#evennia.contrib.tutorials.talking_npc.talking_npc.menu_start_node">menu_start_node() (in module evennia.contrib.tutorials.talking_npc.talking_npc)</a>
</li>
<li><a href="api/evennia.contrib.tutorials.evadventure.npcs.html#evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC.menudata">menudata (evennia.contrib.tutorials.evadventure.npcs.EvAdventureTalkativeNPC attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.menu.html#evennia.contrib.base_systems.ingame_reports.menu.menunode_choose_filter">menunode_choose_filter() (in module evennia.contrib.base_systems.ingame_reports.menu)</a>
</li>
<li><a href="api/evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.menunode_fieldfill">menunode_fieldfill() (in module evennia.contrib.utils.fieldfill.fieldfill)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.menu.html#evennia.contrib.base_systems.ingame_reports.menu.menunode_list_reports">menunode_list_reports() (in module evennia.contrib.base_systems.ingame_reports.menu)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.menu.html#evennia.contrib.base_systems.ingame_reports.menu.menunode_manage_report">menunode_manage_report() (in module evennia.contrib.base_systems.ingame_reports.menu)</a>
</li>
<li><a href="api/evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.menunode_treeselect">menunode_treeselect() (in module evennia.contrib.utils.tree_select.tree_select)</a>
</li>
@ -15324,6 +15426,14 @@
<li><a href="api/evennia.contrib.base_systems.ingame_python.tests.html#module-evennia.contrib.base_systems.ingame_python.tests">evennia.contrib.base_systems.ingame_python.tests</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_python.utils.html#module-evennia.contrib.base_systems.ingame_python.utils">evennia.contrib.base_systems.ingame_python.utils</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.html#module-evennia.contrib.base_systems.ingame_reports">evennia.contrib.base_systems.ingame_reports</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.menu.html#module-evennia.contrib.base_systems.ingame_reports.menu">evennia.contrib.base_systems.ingame_reports.menu</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#module-evennia.contrib.base_systems.ingame_reports.reports">evennia.contrib.base_systems.ingame_reports.reports</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.tests.html#module-evennia.contrib.base_systems.ingame_reports.tests">evennia.contrib.base_systems.ingame_reports.tests</a>
</li>
<li><a href="api/evennia.contrib.base_systems.menu_login.connection_screens.html#module-evennia.contrib.base_systems.menu_login.connection_screens">evennia.contrib.base_systems.menu_login.connection_screens</a>
</li>
@ -17096,6 +17206,8 @@
<li><a href="api/evennia.contrib.base_systems.email_login.email_login.html#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.parse">(evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.godotwebsocket.text2bbcode.html#evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextToBBCODEparser.parse">(evennia.contrib.base_systems.godotwebsocket.text2bbcode.TextToBBCODEparser method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.parse">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.unixcommand.unixcommand.html#evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand.parse">(evennia.contrib.base_systems.unixcommand.unixcommand.UnixCommand method)</a>
</li>
@ -17260,6 +17372,8 @@
<li><a href="api/evennia.contrib.base_systems.ingame_python.scripts.html#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.path">(evennia.contrib.base_systems.ingame_python.scripts.EventHandler attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_python.scripts.html#evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript.path">(evennia.contrib.base_systems.ingame_python.scripts.TimeEventScript attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.path">(evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdSetLegacyComms.path">(evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdSetLegacyComms attribute)</a>
</li>
@ -18500,8 +18614,6 @@
<li><a href="api/evennia.utils.utils.html#evennia.utils.utils.repeat">(in module evennia.utils.utils)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/evennia.contrib.grid.extended_room.extended_room.html#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.repeat_broadcast_message_to_room">repeat_broadcast_message_to_room() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method)</a>
</li>
<li><a href="api/evennia.scripts.models.html#evennia.scripts.models.ScriptDB.repeats">repeats() (evennia.scripts.models.ScriptDB property)</a>
@ -18514,6 +18626,8 @@
<li><a href="api/evennia.utils.ansi.html#evennia.utils.ansi.ANSIString.replace">(evennia.utils.ansi.ANSIString method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/evennia.utils.evtable.html#evennia.utils.evtable.EvCell.replace_data">replace_data() (evennia.utils.evtable.EvCell method)</a>
</li>
<li><a href="api/evennia.contrib.grid.extended_room.extended_room.html#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.replace_legacy_time_of_day_markup">replace_legacy_time_of_day_markup() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method)</a>
@ -18529,9 +18643,33 @@
</li>
</ul></li>
<li><a href="api/evennia.server.profiling.dummyrunner.html#evennia.server.profiling.dummyrunner.DummyClient.report">report() (evennia.server.profiling.dummyrunner.DummyClient method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.report_locks">report_locks (evennia.contrib.base_systems.ingame_reports.reports.CmdBug attribute)</a>
<ul>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.report_locks">(evennia.contrib.base_systems.ingame_reports.reports.CmdIdea attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_locks">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase attribute)</a>
</li>
</ul></li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.report_type">report_type (evennia.contrib.base_systems.ingame_reports.reports.CmdReport attribute)</a>
<ul>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_type">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase attribute)</a>
</li>
</ul></li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase">ReportCmdBase (class in evennia.contrib.base_systems.ingame_reports.reports)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet">ReportsCmdSet (class in evennia.contrib.base_systems.ingame_reports.reports)</a>
</li>
<li><a href="api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.AccountDBPasswordChecker.requestAvatarId">requestAvatarId() (evennia.server.portal.ssh.AccountDBPasswordChecker method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.require_target">require_target (evennia.contrib.base_systems.ingame_reports.reports.CmdReport attribute)</a>
<ul>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.require_target">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase attribute)</a>
</li>
</ul></li>
<li><a href="api/evennia.commands.cmdsethandler.html#evennia.commands.cmdsethandler.CmdSetHandler.reset">reset() (evennia.commands.cmdsethandler.CmdSetHandler method)</a>
<ul>
@ -19348,6 +19486,16 @@
<li><a href="api/evennia.contrib.base_systems.email_login.email_login.html#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit.search_index_entry">(evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedQuit attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_python.commands.html#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry">(evennia.contrib.base_systems.ingame_python.commands.CmdCallback attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.search_index_entry">(evennia.contrib.base_systems.ingame_reports.reports.CmdBug attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.search_index_entry">(evennia.contrib.base_systems.ingame_reports.reports.CmdIdea attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.search_index_entry">(evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.search_index_entry">(evennia.contrib.base_systems.ingame_reports.reports.CmdReport attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.search_index_entry">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase attribute)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry">(evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom attribute)</a>
</li>
@ -20752,6 +20900,12 @@
<li><a href="api/evennia.contrib.game_systems.crafting.example_recipes.html#evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe.success_message">(evennia.contrib.game_systems.crafting.example_recipes.FireballRecipe attribute)</a>
</li>
<li><a href="api/evennia.contrib.game_systems.crafting.example_recipes.html#evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe.success_message">(evennia.contrib.game_systems.crafting.example_recipes.HealingRecipe attribute)</a>
</li>
</ul></li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.success_msg">success_msg (evennia.contrib.base_systems.ingame_reports.reports.CmdIdea attribute)</a>
<ul>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.success_msg">(evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase attribute)</a>
</li>
</ul></li>
<li><a href="api/evennia.web.website.views.accounts.html#evennia.web.website.views.accounts.AccountCreateView.success_url">success_url (evennia.web.website.views.accounts.AccountCreateView attribute)</a>
@ -21064,6 +21218,8 @@
<li><a href="api/evennia.contrib.grid.xyzgrid.xymap_legend.html#evennia.contrib.grid.xyzgrid.xymap_legend.MapTransitionNode.target_map_xyz">(evennia.contrib.grid.xyzgrid.xymap_legend.MapTransitionNode attribute)</a>
</li>
</ul></li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.target_search">target_search() (evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase method)</a>
</li>
<li><a href="api/evennia.contrib.grid.xyzgrid.commands.html#evennia.contrib.grid.xyzgrid.commands.PathData.task">task (evennia.contrib.grid.xyzgrid.commands.PathData attribute)</a>
</li>
<li><a href="api/evennia.scripts.taskhandler.html#evennia.scripts.taskhandler.TaskHandler">TaskHandler (class in evennia.scripts.taskhandler)</a>
@ -21587,6 +21743,8 @@
<li><a href="api/evennia.contrib.grid.extended_room.tests.html#evennia.contrib.grid.extended_room.tests.TestExtendedRoomCommands.test_cmd_detail">test_cmd_detail() (evennia.contrib.grid.extended_room.tests.TestExtendedRoomCommands method)</a>
</li>
<li><a href="api/evennia.contrib.grid.extended_room.tests.html#evennia.contrib.grid.extended_room.tests.TestExtendedRoomCommands.test_cmd_look">test_cmd_look() (evennia.contrib.grid.extended_room.tests.TestExtendedRoomCommands method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.tests.html#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_cmd_manage_reports">test_cmd_manage_reports() (evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands method)</a>
</li>
<li><a href="api/evennia.contrib.game_systems.puzzles.tests.html#evennia.contrib.game_systems.puzzles.tests.TestPuzzles.test_cmd_puzzle">test_cmd_puzzle() (evennia.contrib.game_systems.puzzles.tests.TestPuzzles method)</a>
</li>
@ -22215,6 +22373,8 @@
<li><a href="api/evennia.commands.default.tests.html#evennia.commands.default.tests.TestAccount.test_ic__nonaccess">test_ic__nonaccess() (evennia.commands.default.tests.TestAccount method)</a>
</li>
<li><a href="api/evennia.commands.default.tests.html#evennia.commands.default.tests.TestAccount.test_ic__other_object">test_ic__other_object() (evennia.commands.default.tests.TestAccount method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.tests.html#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_ideas_list">test_ideas_list() (evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands method)</a>
</li>
<li><a href="api/evennia.server.portal.tests.html#evennia.server.portal.tests.TestIRC.test_identity">test_identity() (evennia.server.portal.tests.TestIRC method)</a>
</li>
@ -22583,6 +22743,8 @@
<li><a href="api/evennia.contrib.tutorials.evadventure.tests.test_combat.html#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_remove_combatant">test_remove_combatant() (evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_replacing_class_component_slot_with_runtime_component">test_replacing_class_component_slot_with_runtime_component() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.tests.html#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands.test_report_cmd_base">test_report_cmd_base() (evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands method)</a>
</li>
<li><a href="api/evennia.contrib.rpg.traits.tests.html#evennia.contrib.rpg.traits.tests.TestTrait.test_repr">test_repr() (evennia.contrib.rpg.traits.tests.TestTrait method)</a>
</li>
@ -22666,12 +22828,12 @@
</li>
<li><a href="api/evennia.commands.default.tests.html#evennia.commands.default.tests.TestAccount.test_sessions">test_sessions() (evennia.commands.default.tests.TestAccount method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/evennia.web.api.tests.html#evennia.web.api.tests.TestEvenniaRESTApi.test_set_attribute">test_set_attribute() (evennia.web.api.tests.TestEvenniaRESTApi method)</a>
</li>
<li><a href="api/evennia.contrib.full_systems.evscaperoom.tests.html#evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands.test_set_focus">test_set_focus() (evennia.contrib.full_systems.evscaperoom.tests.TestEvscaperoomCommands method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/evennia.commands.default.tests.html#evennia.commands.default.tests.TestHelp.test_set_help">test_set_help() (evennia.commands.default.tests.TestHelp method)</a>
</li>
<li><a href="api/evennia.commands.default.tests.html#evennia.commands.default.tests.TestBuilding.test_set_home">test_set_home() (evennia.commands.default.tests.TestBuilding method)</a>
@ -23613,6 +23775,8 @@
<li><a href="api/evennia.contrib.utils.random_string_generator.tests.html#evennia.contrib.utils.random_string_generator.tests.TestRandomStringGenerator">TestRandomStringGenerator (class in evennia.contrib.utils.random_string_generator.tests)</a>
</li>
<li><a href="api/evennia.utils.idmapper.tests.html#evennia.utils.idmapper.tests.SharedMemorysTest.testRegularReferences">testRegularReferences() (evennia.utils.idmapper.tests.SharedMemorysTest method)</a>
</li>
<li><a href="api/evennia.contrib.base_systems.ingame_reports.tests.html#evennia.contrib.base_systems.ingame_reports.tests.TestReportCommands">TestReportCommands (class in evennia.contrib.base_systems.ingame_reports.tests)</a>
</li>
<li><a href="api/evennia.contrib.rpg.rpsystem.tests.html#evennia.contrib.rpg.rpsystem.tests.TestRPSystem">TestRPSystem (class in evennia.contrib.rpg.rpsystem.tests)</a>
</li>

Binary file not shown.

View file

@ -442,6 +442,26 @@
<td>&#160;&#160;&#160;
<a href="api/evennia.contrib.base_systems.ingame_python.utils.html#module-evennia.contrib.base_systems.ingame_python.utils"><code class="xref">evennia.contrib.base_systems.ingame_python.utils</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="api/evennia.contrib.base_systems.ingame_reports.html#module-evennia.contrib.base_systems.ingame_reports"><code class="xref">evennia.contrib.base_systems.ingame_reports</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="api/evennia.contrib.base_systems.ingame_reports.menu.html#module-evennia.contrib.base_systems.ingame_reports.menu"><code class="xref">evennia.contrib.base_systems.ingame_reports.menu</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="api/evennia.contrib.base_systems.ingame_reports.reports.html#module-evennia.contrib.base_systems.ingame_reports.reports"><code class="xref">evennia.contrib.base_systems.ingame_reports.reports</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="api/evennia.contrib.base_systems.ingame_reports.tests.html#module-evennia.contrib.base_systems.ingame_reports.tests"><code class="xref">evennia.contrib.base_systems.ingame_reports.tests</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;

File diff suppressed because one or more lines are too long