Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-04 15:07:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html
Evennia docbuilder action 77e2ff397f Updated HTML docs.
2024-11-12 09:45:16 +00:00

536 lines
No EOL
40 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>
<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 players', 'manage ideas', 'manage bugs']</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><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">cmdset</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">[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 players manage ideas manage bugs', 'category': 'general', 'key': 'manage reports', 'no_prefix': ' manage players manage ideas manage bugs', '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 command’s 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 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 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 wouldn’t 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>
Reference in a new issue View git blame Copy permalink