Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-18 14:19:05 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
evennia/docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html
Evennia docbuilder action d35cbb8f68 Updated HTML docs.
2026-01-12 16:46:03 +00:00

618 lines
No EOL
65 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>evennia.contrib.base_systems.ingame_reports.reports &#8212; Evennia latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.contrib.base_systems.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">
<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</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="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="Link to this heading"></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="Link to this heading"></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="Link to this heading"></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>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_reports.reports.</span></span><span class="sig-name descname"><span class="pre">CmdManageReports</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#CmdManageReports"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports" title="Link 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">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 class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'manage</span> <span class="pre">reports'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['manage</span> <span class="pre">players',</span> <span class="pre">'manage</span> <span class="pre">ideas',</span> <span class="pre">'manage</span> <span class="pre">bugs']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.locks">
<span class="sig-name descname"><span class="pre">locks</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:pperm(Admin)'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.get_help">
<span class="sig-name descname"><span class="pre">get_help</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdset</span></span></em><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.get_help" title="Link 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 class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.func">
<span class="sig-name descname"><span class="pre">func</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.func" title="Link to this definition"></a></dt>
<dd><dl class="simple">
<dt>This is the hook function that actually does all the work. It is called</dt><dd><p>by the cmdhandler right after self.parser() finishes, and so has access
to all the variables defined therein.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'general'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:pperm(Admin)'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'manage</span> <span class="pre">players</span> <span class="pre">manage</span> <span class="pre">ideas</span> <span class="pre">manage</span> <span class="pre">bugs',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'manage</span> <span class="pre">reports',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">manage</span> <span class="pre">players</span> <span class="pre">manage</span> <span class="pre">ideas</span> <span class="pre">manage</span> <span class="pre">bugs',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nmanage</span> <span class="pre">the</span> <span class="pre">various</span> <span class="pre">reports\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">manage</span> <span class="pre">[report</span> <span class="pre">type]\n\nAvailable</span> <span class="pre">report</span> <span class="pre">types:\n</span>&#160;&#160;&#160; <span class="pre">bugs\n</span>&#160;&#160;&#160; <span class="pre">ideas\n</span>&#160;&#160;&#160; <span class="pre">players\n\nInitializes</span> <span class="pre">a</span> <span class="pre">menu</span> <span class="pre">for</span> <span class="pre">reviewing</span> <span class="pre">and</span> <span class="pre">changing</span> <span class="pre">the</span> <span class="pre">status</span> <span class="pre">of</span> <span class="pre">current</span> <span class="pre">reports.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_reports.reports.</span></span><span class="sig-name descname"><span class="pre">ReportCmdBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#ReportCmdBase"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase" title="Link 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">MuxCommand</span></code></a></p>
<p>A parent class for creating report commands. This help text may be displayed if
your command’s help text is not properly configured.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'reports'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_locks">
<span class="sig-name descname"><span class="pre">report_locks</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'read:pperm(Admin)'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.require_target">
<span class="sig-name descname"><span class="pre">require_target</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.require_target" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.success_msg">
<span class="sig-name descname"><span class="pre">success_msg</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Your</span> <span class="pre">report</span> <span class="pre">has</span> <span class="pre">been</span> <span class="pre">filed.'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.success_msg" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_type">
<span class="sig-name descname"><span class="pre">report_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.at_pre_cmd">
<span class="sig-name descname"><span class="pre">at_pre_cmd</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.at_pre_cmd" title="Link 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 class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.parse">
<span class="sig-name descname"><span class="pre">parse</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.parse" title="Link 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 class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.target_search">
<span class="sig-name descname"><span class="pre">target_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">searchterm</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#ReportCmdBase.target_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.target_search" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>searchterm</strong> (<em>str</em>)</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></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 class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.create_report">
<span class="sig-name descname"><span class="pre">create_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#ReportCmdBase.create_report"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.create_report" title="Link 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<span class="colon">:</span></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 class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.func">
<span class="sig-name descname"><span class="pre">func</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.func" title="Link to this definition"></a></dt>
<dd><dl class="simple">
<dt>This is the hook function that actually does all the work. It is called</dt><dd><p>by the cmdhandler right after self.parser() finishes, and so has access
to all the variables defined therein.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'command'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:all();'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'',</span> <span class="pre">'category':</span> <span class="pre">'reports',</span> <span class="pre">'key':</span> <span class="pre">'command',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nA</span> <span class="pre">parent</span> <span class="pre">class</span> <span class="pre">for</span> <span class="pre">creating</span> <span class="pre">report</span> <span class="pre">commands.</span> <span class="pre">This</span> <span class="pre">help</span> <span class="pre">text</span> <span class="pre">may</span> <span class="pre">be</span> <span class="pre">displayed</span> <span class="pre">if\nyour</span> <span class="pre">command's</span> <span class="pre">help</span> <span class="pre">text</span> <span class="pre">is</span> <span class="pre">not</span> <span class="pre">properly</span> <span class="pre">configured.\n&quot;}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_reports.reports.</span></span><span class="sig-name descname"><span class="pre">CmdBug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#CmdBug"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug" title="Link 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">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 doesn’t 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 class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bug'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.report_locks">
<span class="sig-name descname"><span class="pre">report_locks</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'read:pperm(Developer)'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.report_locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'reports'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:all();'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdBug.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'',</span> <span class="pre">'category':</span> <span class="pre">'reports',</span> <span class="pre">'key':</span> <span class="pre">'bug',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nfile</span> <span class="pre">a</span> <span class="pre">bug\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">bug</span> <span class="pre">[&lt;target&gt;</span> <span class="pre">=]</span> <span class="pre">&lt;message&gt;\n\nNote:</span> <span class="pre">If</span> <span class="pre">a</span> <span class="pre">specific</span> <span class="pre">object,</span> <span class="pre">location</span> <span class="pre">or</span> <span class="pre">character</span> <span class="pre">is</span> <span class="pre">bugged,</span> <span class="pre">please</span> <span class="pre">target</span> <span class="pre">it</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">report.\n\nExamples:\n</span>&#160;&#160;&#160; <span class="pre">bug</span> <span class="pre">hammer</span> <span class="pre">=</span> <span class="pre">This</span> <span class="pre">doesn't</span> <span class="pre">work</span> <span class="pre">as</span> <span class="pre">a</span> <span class="pre">crafting</span> <span class="pre">tool</span> <span class="pre">but</span> <span class="pre">it</span> <span class="pre">should\n</span>&#160;&#160;&#160; <span class="pre">bug</span> <span class="pre">every</span> <span class="pre">time</span> <span class="pre">I</span> <span class="pre">go</span> <span class="pre">through</span> <span class="pre">a</span> <span class="pre">door</span> <span class="pre">I</span> <span class="pre">get</span> <span class="pre">the</span> <span class="pre">message</span> <span class="pre">twice\n&quot;}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_reports.reports.</span></span><span class="sig-name descname"><span class="pre">CmdReport</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#CmdReport"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport" title="Link 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">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 class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'report'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.report_type">
<span class="sig-name descname"><span class="pre">report_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'player'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.report_type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.require_target">
<span class="sig-name descname"><span class="pre">require_target</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.require_target" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.account_caller">
<span class="sig-name descname"><span class="pre">account_caller</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.account_caller" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'reports'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:all();'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdReport.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'',</span> <span class="pre">'category':</span> <span class="pre">'reports',</span> <span class="pre">'key':</span> <span class="pre">'report',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nreport</span> <span class="pre">a</span> <span class="pre">player\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">report</span> <span class="pre">&lt;player&gt;</span> <span class="pre">=</span> <span class="pre">&lt;message&gt;\n\nAll</span> <span class="pre">player</span> <span class="pre">reports</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">reviewed.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_reports.reports.</span></span><span class="sig-name descname"><span class="pre">CmdIdea</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#CmdIdea"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea" title="Link 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">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 wouldn’t it be cool if we had horses we could ride</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'idea'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['ideas']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.report_locks">
<span class="sig-name descname"><span class="pre">report_locks</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'read:pperm(Builder)'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.report_locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.success_msg">
<span class="sig-name descname"><span class="pre">success_msg</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Thank</span> <span class="pre">you</span> <span class="pre">for</span> <span class="pre">your</span> <span class="pre">suggestion!'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.success_msg" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.func">
<span class="sig-name descname"><span class="pre">func</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.func" title="Link to this definition"></a></dt>
<dd><dl class="simple">
<dt>This is the hook function that actually does all the work. It is called</dt><dd><p>by the cmdhandler right after self.parser() finishes, and so has access
to all the variables defined therein.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'reports'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:all();'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'ideas',</span> <span class="pre">'category':</span> <span class="pre">'reports',</span> <span class="pre">'key':</span> <span class="pre">'idea',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">ideas',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nsubmit</span> <span class="pre">a</span> <span class="pre">suggestion\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">ideas\n</span>&#160;&#160;&#160; <span class="pre">idea</span> <span class="pre">&lt;message&gt;\n\nExample:\n</span>&#160;&#160;&#160; <span class="pre">idea</span> <span class="pre">wouldn't</span> <span class="pre">it</span> <span class="pre">be</span> <span class="pre">cool</span> <span class="pre">if</span> <span class="pre">we</span> <span class="pre">had</span> <span class="pre">horses</span> <span class="pre">we</span> <span class="pre">could</span> <span class="pre">ride\n&quot;}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_reports.reports.</span></span><span class="sig-name descname"><span class="pre">ReportsCmdSet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdsetobj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#ReportsCmdSet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">CmdSet</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Reports</span> <span class="pre">CmdSet'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.at_cmdset_creation">
<span class="sig-name descname"><span class="pre">at_cmdset_creation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_reports/reports.html#ReportsCmdSet.at_cmdset_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.at_cmdset_creation" title="Link to this definition"></a></dt>
<dd><p>Hook method - this should be overloaded in the inheriting
class, and should take care of populating the cmdset by use of
self.add().</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.contrib.base_systems.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>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports"><code class="docutils literal notranslate"><span class="pre">CmdManageReports</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.key"><code class="docutils literal notranslate"><span class="pre">CmdManageReports.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.aliases"><code class="docutils literal notranslate"><span class="pre">CmdManageReports.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.locks"><code class="docutils literal notranslate"><span class="pre">CmdManageReports.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.get_help"><code class="docutils literal notranslate"><span class="pre">CmdManageReports.get_help()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.func"><code class="docutils literal notranslate"><span class="pre">CmdManageReports.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.help_category"><code class="docutils literal notranslate"><span class="pre">CmdManageReports.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdManageReports.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdManageReports.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.help_category"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_locks"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.report_locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.require_target"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.require_target</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.success_msg"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.success_msg</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.report_type"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.report_type</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.at_pre_cmd"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.at_pre_cmd()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.parse"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.parse()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.target_search"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.target_search()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.create_report"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.create_report()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.func"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.aliases"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.key"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.lock_storage"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportCmdBase.search_index_entry"><code class="docutils literal notranslate"><span class="pre">ReportCmdBase.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug"><code class="docutils literal notranslate"><span class="pre">CmdBug</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.key"><code class="docutils literal notranslate"><span class="pre">CmdBug.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.report_locks"><code class="docutils literal notranslate"><span class="pre">CmdBug.report_locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.aliases"><code class="docutils literal notranslate"><span class="pre">CmdBug.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.help_category"><code class="docutils literal notranslate"><span class="pre">CmdBug.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdBug.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdBug.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdBug.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport"><code class="docutils literal notranslate"><span class="pre">CmdReport</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.key"><code class="docutils literal notranslate"><span class="pre">CmdReport.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.report_type"><code class="docutils literal notranslate"><span class="pre">CmdReport.report_type</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.require_target"><code class="docutils literal notranslate"><span class="pre">CmdReport.require_target</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.account_caller"><code class="docutils literal notranslate"><span class="pre">CmdReport.account_caller</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.aliases"><code class="docutils literal notranslate"><span class="pre">CmdReport.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.help_category"><code class="docutils literal notranslate"><span class="pre">CmdReport.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdReport.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdReport.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdReport.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea"><code class="docutils literal notranslate"><span class="pre">CmdIdea</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.key"><code class="docutils literal notranslate"><span class="pre">CmdIdea.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.aliases"><code class="docutils literal notranslate"><span class="pre">CmdIdea.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.report_locks"><code class="docutils literal notranslate"><span class="pre">CmdIdea.report_locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.success_msg"><code class="docutils literal notranslate"><span class="pre">CmdIdea.success_msg</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.func"><code class="docutils literal notranslate"><span class="pre">CmdIdea.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.help_category"><code class="docutils literal notranslate"><span class="pre">CmdIdea.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdIdea.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdIdea.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdIdea.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet"><code class="docutils literal notranslate"><span class="pre">ReportsCmdSet</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.key"><code class="docutils literal notranslate"><span class="pre">ReportsCmdSet.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.at_cmdset_creation"><code class="docutils literal notranslate"><span class="pre">ReportsCmdSet.at_cmdset_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_reports.reports.ReportsCmdSet.path"><code class="docutils literal notranslate"><span class="pre">ReportsCmdSet.path</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<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>
</div>
<div>
<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>
<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="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.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</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> 8.2.3.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink