Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-22 15:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/6.x/api/evennia.commands.default.system.html
Griatch 9e122e89ca Update with 6.x branch docs
2026-02-15 19:06:04 +01:00

2250 lines
No EOL
243 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.commands.default.system &#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.commands.default.tests" href="evennia.commands.default.tests.html" />
<link rel="prev" title="evennia.commands.default.syscommands" href="evennia.commands.default.syscommands.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.commands.default.tests.html" title="evennia.commands.default.tests"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.commands.default.syscommands.html" title="evennia.commands.default.syscommands"
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.commands.html" >evennia.commands</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.commands.default.html" accesskey="U">evennia.commands.default</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.commands.default.system</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.commands.default.system">
<span id="evennia-commands-default-system"></span><h1>evennia.commands.default.system<a class="headerlink" href="#module-evennia.commands.default.system" title="Link to this heading"></a></h1>
<p>System commands</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAccounts">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdAccounts</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/commands/default/system.html#CmdAccounts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdAccounts" 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 registered accounts</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>accounts [nr]
accounts/delete &lt;name or #id&gt; [: reason]</p>
</dd>
<dt>Switches:</dt><dd><p>delete - delete an account from the server</p>
</dd>
</dl>
<p>By default, lists statistics about the Accounts registered with the game.
It will list the &lt;nr&gt; amount of latest registered accounts
If not given, &lt;nr&gt; defaults to 10.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAccounts.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">'&#64;accounts'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAccounts.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAccounts.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">['&#64;account']</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAccounts.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAccounts.switch_options">
<span class="sig-name descname"><span class="pre">switch_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('delete',)</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAccounts.switch_options" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAccounts.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:perm(listaccounts)</span> <span class="pre">or</span> <span class="pre">perm(Admin)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAccounts.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAccounts.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAccounts.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAccounts.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/commands/default/system.html#CmdAccounts.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdAccounts.func" title="Link to this definition"></a></dt>
<dd><p>List the accounts</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAccounts.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:perm(listaccounts)</span> <span class="pre">or</span> <span class="pre">perm(Admin)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAccounts.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAccounts.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">'&#64;account',</span> <span class="pre">'category':</span> <span class="pre">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;accounts',</span> <span class="pre">'no_prefix':</span> <span class="pre">'accounts</span> <span class="pre">account',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nManage</span> <span class="pre">registered</span> <span class="pre">accounts\n\nUsage:\n</span>&#160; <span class="pre">accounts</span> <span class="pre">[nr]\n</span>&#160; <span class="pre">accounts/delete</span> <span class="pre">&lt;name</span> <span class="pre">or</span> <span class="pre">#id&gt;</span> <span class="pre">[:</span> <span class="pre">reason]\n\nSwitches:\n</span>&#160; <span class="pre">delete</span>&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">delete</span> <span class="pre">an</span> <span class="pre">account</span> <span class="pre">from</span> <span class="pre">the</span> <span class="pre">server\n\nBy</span> <span class="pre">default,</span> <span class="pre">lists</span> <span class="pre">statistics</span> <span class="pre">about</span> <span class="pre">the</span> <span class="pre">Accounts</span> <span class="pre">registered</span> <span class="pre">with</span> <span class="pre">the</span> <span class="pre">game.\nIt</span> <span class="pre">will</span> <span class="pre">list</span> <span class="pre">the</span> <span class="pre">&lt;nr&gt;</span> <span class="pre">amount</span> <span class="pre">of</span> <span class="pre">latest</span> <span class="pre">registered</span> <span class="pre">accounts\nIf</span> <span class="pre">not</span> <span class="pre">given,</span> <span class="pre">&lt;nr&gt;</span> <span class="pre">defaults</span> <span class="pre">to</span> <span class="pre">10.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAccounts.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.commands.default.system.CmdReload">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdReload</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/commands/default/system.html#CmdReload"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdReload" 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>reload the server</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>reload [reason]</p>
</dd>
</dl>
<p>This restarts the server. The Portal is not
affected. Non-persistent scripts will survive a reload (use
reset to purge) and at_reload() hooks will be called.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReload.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">'&#64;reload'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReload.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReload.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">['&#64;restart']</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReload.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReload.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:perm(reload)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReload.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReload.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReload.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReload.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/commands/default/system.html#CmdReload.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdReload.func" title="Link to this definition"></a></dt>
<dd><p>Reload the system.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReload.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:perm(reload)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReload.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReload.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">'&#64;restart',</span> <span class="pre">'category':</span> <span class="pre">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;reload',</span> <span class="pre">'no_prefix':</span> <span class="pre">'reload</span> <span class="pre">restart',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nreload</span> <span class="pre">the</span> <span class="pre">server\n\nUsage:\n</span>&#160; <span class="pre">reload</span> <span class="pre">[reason]\n\nThis</span> <span class="pre">restarts</span> <span class="pre">the</span> <span class="pre">server.</span> <span class="pre">The</span> <span class="pre">Portal</span> <span class="pre">is</span> <span class="pre">not\naffected.</span> <span class="pre">Non-persistent</span> <span class="pre">scripts</span> <span class="pre">will</span> <span class="pre">survive</span> <span class="pre">a</span> <span class="pre">reload</span> <span class="pre">(use\nreset</span> <span class="pre">to</span> <span class="pre">purge)</span> <span class="pre">and</span> <span class="pre">at_reload()</span> <span class="pre">hooks</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">called.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReload.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.commands.default.system.CmdReset">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdReset</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/commands/default/system.html#CmdReset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdReset" 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>reset and reboot the server</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>reset</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>For normal updating you are recommended to use reload rather
than this command. Use shutdown for a complete stop of
everything.</p>
<p>This emulates a cold reboot of the Server component of Evennia.
The difference to shutdown is that the Server will auto-reboot
and that it does not affect the Portal, so no users will be
disconnected. Contrary to reload however, all shutdown hooks will
be called and any non-database saved scripts, ndb-attributes,
cmdsets etc will be wiped.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReset.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">'&#64;reset'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReset.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReset.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:perm(reload)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReset.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReset.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReset.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReset.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/commands/default/system.html#CmdReset.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdReset.func" title="Link to this definition"></a></dt>
<dd><p>Reload the system.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReset.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.commands.default.system.CmdReset.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReset.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:perm(reload)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReset.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdReset.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">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;reset',</span> <span class="pre">'no_prefix':</span> <span class="pre">'reset</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nreset</span> <span class="pre">and</span> <span class="pre">reboot</span> <span class="pre">the</span> <span class="pre">server\n\nUsage:\n</span>&#160; <span class="pre">reset\n\nNotes:\n</span>&#160; <span class="pre">For</span> <span class="pre">normal</span> <span class="pre">updating</span> <span class="pre">you</span> <span class="pre">are</span> <span class="pre">recommended</span> <span class="pre">to</span> <span class="pre">use</span> <span class="pre">reload</span> <span class="pre">rather\n</span>&#160; <span class="pre">than</span> <span class="pre">this</span> <span class="pre">command.</span> <span class="pre">Use</span> <span class="pre">shutdown</span> <span class="pre">for</span> <span class="pre">a</span> <span class="pre">complete</span> <span class="pre">stop</span> <span class="pre">of\n</span>&#160; <span class="pre">everything.\n\nThis</span> <span class="pre">emulates</span> <span class="pre">a</span> <span class="pre">cold</span> <span class="pre">reboot</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">Server</span> <span class="pre">component</span> <span class="pre">of</span> <span class="pre">Evennia.\nThe</span> <span class="pre">difference</span> <span class="pre">to</span> <span class="pre">shutdown</span> <span class="pre">is</span> <span class="pre">that</span> <span class="pre">the</span> <span class="pre">Server</span> <span class="pre">will</span> <span class="pre">auto-reboot\nand</span> <span class="pre">that</span> <span class="pre">it</span> <span class="pre">does</span> <span class="pre">not</span> <span class="pre">affect</span> <span class="pre">the</span> <span class="pre">Portal,</span> <span class="pre">so</span> <span class="pre">no</span> <span class="pre">users</span> <span class="pre">will</span> <span class="pre">be\ndisconnected.</span> <span class="pre">Contrary</span> <span class="pre">to</span> <span class="pre">reload</span> <span class="pre">however,</span> <span class="pre">all</span> <span class="pre">shutdown</span> <span class="pre">hooks</span> <span class="pre">will\nbe</span> <span class="pre">called</span> <span class="pre">and</span> <span class="pre">any</span> <span class="pre">non-database</span> <span class="pre">saved</span> <span class="pre">scripts,</span> <span class="pre">ndb-attributes,\ncmdsets</span> <span class="pre">etc</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">wiped.\n\n'}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdReset.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.commands.default.system.CmdShutdown">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdShutdown</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/commands/default/system.html#CmdShutdown"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdShutdown" 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>stop the server completely</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>shutdown [announcement]</p>
</dd>
</dl>
<p>Gracefully shut down both Server and Portal.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdShutdown.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">'&#64;shutdown'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdShutdown.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdShutdown.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:perm(shutdown)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdShutdown.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdShutdown.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdShutdown.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdShutdown.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/commands/default/system.html#CmdShutdown.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdShutdown.func" title="Link to this definition"></a></dt>
<dd><p>Define function</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdShutdown.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.commands.default.system.CmdShutdown.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdShutdown.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:perm(shutdown)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdShutdown.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdShutdown.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">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;shutdown',</span> <span class="pre">'no_prefix':</span> <span class="pre">'shutdown</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nstop</span> <span class="pre">the</span> <span class="pre">server</span> <span class="pre">completely\n\nUsage:\n</span>&#160; <span class="pre">shutdown</span> <span class="pre">[announcement]\n\nGracefully</span> <span class="pre">shut</span> <span class="pre">down</span> <span class="pre">both</span> <span class="pre">Server</span> <span class="pre">and</span> <span class="pre">Portal.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdShutdown.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.commands.default.system.CmdPy">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdPy</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/commands/default/system.html#CmdPy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdPy" 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>execute a snippet of python code</p>
<dl>
<dt>Usage:</dt><dd><p>py [cmd]
py/edit
py/time &lt;cmd&gt;
py/clientraw &lt;cmd&gt;
py/noecho</p>
</dd>
<dt>Switches:</dt><dd><p>time - output an approximate execution time for &lt;cmd&gt;
edit - open a code editor for multi-line code experimentation
clientraw - turn off all client-specific escaping. Note that this may</p>
<blockquote>
<div><p>lead to different output depending on prototocol (such as angular brackets
being parsed as HTML in the webclient but not in telnet clients)</p>
</div></blockquote>
<dl class="simple">
<dt>noecho - in Python console mode, turn off the input echo (e.g. if your client</dt><dd><p>does this for you already)</p>
</dd>
</dl>
</dd>
</dl>
<p>Without argument, open a Python console in-game. This is a full console,
accepting multi-line Python code for testing and debugging. Type <strong>exit()</strong> to
return to the game. If Evennia is reloaded, the console will be closed.</p>
<p>Enter a line of instruction after the ‘py’ command to execute it
immediately. Separate multiple commands by ‘;’ or open the code editor
using the /edit switch (all lines added in editor will be executed
immediately when closing or using the execute command in the editor).</p>
<p>A few variables are made available for convenience in order to offer access
to the system (you can import more at execution time).</p>
<dl class="simple">
<dt>Available variables in py environment:</dt><dd><p>self, me : caller
here : caller.location
evennia : the evennia API
inherits_from(obj, parent) : check object inheritance</p>
</dd>
</dl>
<p>You can explore The evennia API from inside the game by calling
the <strong>__doc__</strong> property on entities:</p>
<blockquote>
<div><p>py evennia.__doc__
py evennia.managers.__doc__</p>
</div></blockquote>
<p><a href="#id1"><span class="problematic" id="id2">|</span></a>rNote: In the wrong hands this command is a severe security risk. It
should only be accessible by trusted server admins/superusers.|n</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdPy.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">'&#64;py'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdPy.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdPy.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">['&#64;!']</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdPy.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdPy.switch_options">
<span class="sig-name descname"><span class="pre">switch_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('time',</span> <span class="pre">'edit',</span> <span class="pre">'clientraw',</span> <span class="pre">'noecho')</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdPy.switch_options" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdPy.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:perm(py)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdPy.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdPy.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdPy.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdPy.arg_regex">
<span class="sig-name descname"><span class="pre">arg_regex</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">re.compile('',</span> <span class="pre">re.IGNORECASE)</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdPy.arg_regex" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdPy.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/commands/default/system.html#CmdPy.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdPy.func" title="Link to this definition"></a></dt>
<dd><p>hook function</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdPy.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:perm(py)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdPy.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdPy.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">'&#64;!',</span> <span class="pre">'category':</span> <span class="pre">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;py',</span> <span class="pre">'no_prefix':</span> <span class="pre">'py</span> <span class="pre">!',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nexecute</span> <span class="pre">a</span> <span class="pre">snippet</span> <span class="pre">of</span> <span class="pre">python</span> <span class="pre">code\n\nUsage:\n</span>&#160; <span class="pre">py</span> <span class="pre">[cmd]\n</span>&#160; <span class="pre">py/edit\n</span>&#160; <span class="pre">py/time</span> <span class="pre">&lt;cmd&gt;\n</span>&#160; <span class="pre">py/clientraw</span> <span class="pre">&lt;cmd&gt;\n</span>&#160; <span class="pre">py/noecho\n\nSwitches:\n</span>&#160; <span class="pre">time</span> <span class="pre">-</span> <span class="pre">output</span> <span class="pre">an</span> <span class="pre">approximate</span> <span class="pre">execution</span> <span class="pre">time</span> <span class="pre">for</span> <span class="pre">&lt;cmd&gt;\n</span>&#160; <span class="pre">edit</span> <span class="pre">-</span> <span class="pre">open</span> <span class="pre">a</span> <span class="pre">code</span> <span class="pre">editor</span> <span class="pre">for</span> <span class="pre">multi-line</span> <span class="pre">code</span> <span class="pre">experimentation\n</span>&#160; <span class="pre">clientraw</span> <span class="pre">-</span> <span class="pre">turn</span> <span class="pre">off</span> <span class="pre">all</span> <span class="pre">client-specific</span> <span class="pre">escaping.</span> <span class="pre">Note</span> <span class="pre">that</span> <span class="pre">this</span> <span class="pre">may\n</span>&#160;&#160;&#160; <span class="pre">lead</span> <span class="pre">to</span> <span class="pre">different</span> <span class="pre">output</span> <span class="pre">depending</span> <span class="pre">on</span> <span class="pre">prototocol</span> <span class="pre">(such</span> <span class="pre">as</span> <span class="pre">angular</span> <span class="pre">brackets\n</span>&#160;&#160;&#160; <span class="pre">being</span> <span class="pre">parsed</span> <span class="pre">as</span> <span class="pre">HTML</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">webclient</span> <span class="pre">but</span> <span class="pre">not</span> <span class="pre">in</span> <span class="pre">telnet</span> <span class="pre">clients)\n</span>&#160; <span class="pre">noecho</span> <span class="pre">-</span> <span class="pre">in</span> <span class="pre">Python</span> <span class="pre">console</span> <span class="pre">mode,</span> <span class="pre">turn</span> <span class="pre">off</span> <span class="pre">the</span> <span class="pre">input</span> <span class="pre">echo</span> <span class="pre">(e.g.</span> <span class="pre">if</span> <span class="pre">your</span> <span class="pre">client\n</span>&#160;&#160;&#160; <span class="pre">does</span> <span class="pre">this</span> <span class="pre">for</span> <span class="pre">you</span> <span class="pre">already)\n\nWithout</span> <span class="pre">argument,</span> <span class="pre">open</span> <span class="pre">a</span> <span class="pre">Python</span> <span class="pre">console</span> <span class="pre">in-game.</span> <span class="pre">This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">full</span> <span class="pre">console,\naccepting</span> <span class="pre">multi-line</span> <span class="pre">Python</span> <span class="pre">code</span> <span class="pre">for</span> <span class="pre">testing</span> <span class="pre">and</span> <span class="pre">debugging.</span> <span class="pre">Type</span> <span class="pre">`exit()`</span> <span class="pre">to\nreturn</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">game.</span> <span class="pre">If</span> <span class="pre">Evennia</span> <span class="pre">is</span> <span class="pre">reloaded,</span> <span class="pre">the</span> <span class="pre">console</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">closed.\n\nEnter</span> <span class="pre">a</span> <span class="pre">line</span> <span class="pre">of</span> <span class="pre">instruction</span> <span class="pre">after</span> <span class="pre">the</span> <span class="pre">'py'</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">execute</span> <span class="pre">it\nimmediately.</span>&#160; <span class="pre">Separate</span> <span class="pre">multiple</span> <span class="pre">commands</span> <span class="pre">by</span> <span class="pre">';'</span> <span class="pre">or</span> <span class="pre">open</span> <span class="pre">the</span> <span class="pre">code</span> <span class="pre">editor\nusing</span> <span class="pre">the</span> <span class="pre">/edit</span> <span class="pre">switch</span> <span class="pre">(all</span> <span class="pre">lines</span> <span class="pre">added</span> <span class="pre">in</span> <span class="pre">editor</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">executed\nimmediately</span> <span class="pre">when</span> <span class="pre">closing</span> <span class="pre">or</span> <span class="pre">using</span> <span class="pre">the</span> <span class="pre">execute</span> <span class="pre">command</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">editor).\n\nA</span> <span class="pre">few</span> <span class="pre">variables</span> <span class="pre">are</span> <span class="pre">made</span> <span class="pre">available</span> <span class="pre">for</span> <span class="pre">convenience</span> <span class="pre">in</span> <span class="pre">order</span> <span class="pre">to</span> <span class="pre">offer</span> <span class="pre">access\nto</span> <span class="pre">the</span> <span class="pre">system</span> <span class="pre">(you</span> <span class="pre">can</span> <span class="pre">import</span> <span class="pre">more</span> <span class="pre">at</span> <span class="pre">execution</span> <span class="pre">time).\n\nAvailable</span> <span class="pre">variables</span> <span class="pre">in</span> <span class="pre">py</span> <span class="pre">environment:\n</span>&#160; <span class="pre">self,</span> <span class="pre">me</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">:</span> <span class="pre">caller\n</span>&#160; <span class="pre">here</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">:</span> <span class="pre">caller.location\n</span>&#160; <span class="pre">evennia</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">:</span> <span class="pre">the</span> <span class="pre">evennia</span> <span class="pre">API\n</span>&#160; <span class="pre">inherits_from(obj,</span> <span class="pre">parent)</span> <span class="pre">:</span> <span class="pre">check</span> <span class="pre">object</span> <span class="pre">inheritance\n\nYou</span> <span class="pre">can</span> <span class="pre">explore</span> <span class="pre">The</span> <span class="pre">evennia</span> <span class="pre">API</span> <span class="pre">from</span> <span class="pre">inside</span> <span class="pre">the</span> <span class="pre">game</span> <span class="pre">by</span> <span class="pre">calling\nthe</span> <span class="pre">`__doc__`</span> <span class="pre">property</span> <span class="pre">on</span> <span class="pre">entities:\n</span>&#160;&#160;&#160; <span class="pre">py</span> <span class="pre">evennia.__doc__\n</span>&#160;&#160;&#160; <span class="pre">py</span> <span class="pre">evennia.managers.__doc__\n\n|rNote:</span> <span class="pre">In</span> <span class="pre">the</span> <span class="pre">wrong</span> <span class="pre">hands</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">severe</span> <span class="pre">security</span> <span class="pre">risk.</span>&#160; <span class="pre">It\nshould</span> <span class="pre">only</span> <span class="pre">be</span> <span class="pre">accessible</span> <span class="pre">by</span> <span class="pre">trusted</span> <span class="pre">server</span> <span class="pre">admins/superusers.|n\n\n&quot;}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdPy.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.commands.default.system.CmdService">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdService</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/commands/default/system.html#CmdService"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdService" 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 system services</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>service[/switch] &lt;service&gt;</p>
</dd>
<dt>Switches:</dt><dd><p>list - shows all available services (default)
start - activates or reactivate a service
stop - stops/inactivate a service (can often be restarted)
delete - tries to permanently remove a service</p>
</dd>
</dl>
<p>Service management system. Allows for the listing,
starting, and stopping of services. If no switches
are given, services will be listed. Note that to operate on the
service you have to supply the full (green or red) name as given
in the list.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdService.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">'&#64;service'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdService.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdService.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">['&#64;services']</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdService.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdService.switch_options">
<span class="sig-name descname"><span class="pre">switch_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('list',</span> <span class="pre">'start',</span> <span class="pre">'stop',</span> <span class="pre">'delete')</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdService.switch_options" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdService.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:perm(service)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdService.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdService.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdService.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdService.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/commands/default/system.html#CmdService.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdService.func" title="Link to this definition"></a></dt>
<dd><p>Implement command</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdService.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:perm(service)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdService.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdService.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">'&#64;services',</span> <span class="pre">'category':</span> <span class="pre">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;service',</span> <span class="pre">'no_prefix':</span> <span class="pre">'service</span> <span class="pre">services',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nmanage</span> <span class="pre">system</span> <span class="pre">services\n\nUsage:\n</span>&#160; <span class="pre">service[/switch]</span> <span class="pre">&lt;service&gt;\n\nSwitches:\n</span>&#160; <span class="pre">list</span>&#160;&#160; <span class="pre">-</span> <span class="pre">shows</span> <span class="pre">all</span> <span class="pre">available</span> <span class="pre">services</span> <span class="pre">(default)\n</span>&#160; <span class="pre">start</span>&#160; <span class="pre">-</span> <span class="pre">activates</span> <span class="pre">or</span> <span class="pre">reactivate</span> <span class="pre">a</span> <span class="pre">service\n</span>&#160; <span class="pre">stop</span>&#160;&#160; <span class="pre">-</span> <span class="pre">stops/inactivate</span> <span class="pre">a</span> <span class="pre">service</span> <span class="pre">(can</span> <span class="pre">often</span> <span class="pre">be</span> <span class="pre">restarted)\n</span>&#160; <span class="pre">delete</span> <span class="pre">-</span> <span class="pre">tries</span> <span class="pre">to</span> <span class="pre">permanently</span> <span class="pre">remove</span> <span class="pre">a</span> <span class="pre">service\n\nService</span> <span class="pre">management</span> <span class="pre">system.</span> <span class="pre">Allows</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">listing,\nstarting,</span> <span class="pre">and</span> <span class="pre">stopping</span> <span class="pre">of</span> <span class="pre">services.</span> <span class="pre">If</span> <span class="pre">no</span> <span class="pre">switches\nare</span> <span class="pre">given,</span> <span class="pre">services</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">listed.</span> <span class="pre">Note</span> <span class="pre">that</span> <span class="pre">to</span> <span class="pre">operate</span> <span class="pre">on</span> <span class="pre">the\nservice</span> <span class="pre">you</span> <span class="pre">have</span> <span class="pre">to</span> <span class="pre">supply</span> <span class="pre">the</span> <span class="pre">full</span> <span class="pre">(green</span> <span class="pre">or</span> <span class="pre">red)</span> <span class="pre">name</span> <span class="pre">as</span> <span class="pre">given\nin</span> <span class="pre">the</span> <span class="pre">list.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdService.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.commands.default.system.CmdAbout">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdAbout</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/commands/default/system.html#CmdAbout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdAbout" 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>show Evennia info</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>about</p>
</dd>
</dl>
<p>Display info about the game engine.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAbout.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">'&#64;about'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAbout.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAbout.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">['&#64;version']</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAbout.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAbout.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:all()'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAbout.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAbout.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAbout.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAbout.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/commands/default/system.html#CmdAbout.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdAbout.func" title="Link to this definition"></a></dt>
<dd><p>Display information about server or target</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAbout.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.commands.default.system.CmdAbout.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdAbout.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">'&#64;version',</span> <span class="pre">'category':</span> <span class="pre">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;about',</span> <span class="pre">'no_prefix':</span> <span class="pre">'about</span> <span class="pre">version',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nshow</span> <span class="pre">Evennia</span> <span class="pre">info\n\nUsage:\n</span>&#160; <span class="pre">about\n\nDisplay</span> <span class="pre">info</span> <span class="pre">about</span> <span class="pre">the</span> <span class="pre">game</span> <span class="pre">engine.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdAbout.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.commands.default.system.CmdTime">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdTime</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/commands/default/system.html#CmdTime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdTime" 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>show server time statistics</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>time</p>
</dd>
</dl>
<p>List Server time statistics such as uptime
and the current time stamp.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTime.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">'&#64;time'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTime.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTime.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">['&#64;uptime']</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTime.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTime.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:perm(time)</span> <span class="pre">or</span> <span class="pre">perm(Player)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTime.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTime.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTime.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTime.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/commands/default/system.html#CmdTime.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdTime.func" title="Link to this definition"></a></dt>
<dd><p>Show server time data in a table.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTime.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:perm(time)</span> <span class="pre">or</span> <span class="pre">perm(Player)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTime.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTime.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">'&#64;uptime',</span> <span class="pre">'category':</span> <span class="pre">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;time',</span> <span class="pre">'no_prefix':</span> <span class="pre">'time</span> <span class="pre">uptime',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nshow</span> <span class="pre">server</span> <span class="pre">time</span> <span class="pre">statistics\n\nUsage:\n</span>&#160; <span class="pre">time\n\nList</span> <span class="pre">Server</span> <span class="pre">time</span> <span class="pre">statistics</span> <span class="pre">such</span> <span class="pre">as</span> <span class="pre">uptime\nand</span> <span class="pre">the</span> <span class="pre">current</span> <span class="pre">time</span> <span class="pre">stamp.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTime.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.commands.default.system.CmdServerLoad">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdServerLoad</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/commands/default/system.html#CmdServerLoad"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad" 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>show server load and memory statistics</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>server[/mem]</p>
</dd>
<dt>Switches:</dt><dd><p>mem - return only a string of the current memory usage
flushmem - flush the idmapper cache</p>
</dd>
</dl>
<p>This command shows server load statistics and dynamic memory
usage. It also allows to flush the cache of accessed database
objects.</p>
<p>Some Important statistics in the table:</p>
<p><a href="#id3"><span class="problematic" id="id4">|</span></a>wServer load|n is an average of processor usage. It’s usually
between 0 (no usage) and 1 (100% usage), but may also be
temporarily higher if your computer has multiple CPU cores.</p>
<p>The <a href="#id5"><span class="problematic" id="id6">|</span></a>wResident/Virtual memory|n displays the total memory used by
the server process.</p>
<p>Evennia <a href="#id7"><span class="problematic" id="id8">|</span></a>wcaches|n all retrieved database entities when they are
loaded by use of the idmapper functionality. This allows Evennia
to maintain the same instances of an entity and allowing
non-persistent storage schemes. The total amount of cached objects
are displayed plus a breakdown of database object types.</p>
<p>The <a href="#id9"><span class="problematic" id="id10">|</span></a>wflushmem|n switch allows to flush the object cache. Please
note that due to how Python’s memory management works, releasing
caches may not show you a lower Residual/Virtual memory footprint,
the released memory will instead be re-used by the program.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdServerLoad.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">'&#64;server'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdServerLoad.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">['&#64;serverload']</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdServerLoad.switch_options">
<span class="sig-name descname"><span class="pre">switch_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('mem',</span> <span class="pre">'flushmem')</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.switch_options" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdServerLoad.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:perm(list)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdServerLoad.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdServerLoad.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/commands/default/system.html#CmdServerLoad.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.func" title="Link to this definition"></a></dt>
<dd><p>Show list.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdServerLoad.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:perm(list)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdServerLoad.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">'&#64;serverload',</span> <span class="pre">'category':</span> <span class="pre">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;server',</span> <span class="pre">'no_prefix':</span> <span class="pre">'server</span> <span class="pre">serverload',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nshow</span> <span class="pre">server</span> <span class="pre">load</span> <span class="pre">and</span> <span class="pre">memory</span> <span class="pre">statistics\n\nUsage:\n</span>&#160;&#160; <span class="pre">server[/mem]\n\nSwitches:\n</span>&#160;&#160;&#160; <span class="pre">mem</span> <span class="pre">-</span> <span class="pre">return</span> <span class="pre">only</span> <span class="pre">a</span> <span class="pre">string</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">current</span> <span class="pre">memory</span> <span class="pre">usage\n</span>&#160;&#160;&#160; <span class="pre">flushmem</span> <span class="pre">-</span> <span class="pre">flush</span> <span class="pre">the</span> <span class="pre">idmapper</span> <span class="pre">cache\n\nThis</span> <span class="pre">command</span> <span class="pre">shows</span> <span class="pre">server</span> <span class="pre">load</span> <span class="pre">statistics</span> <span class="pre">and</span> <span class="pre">dynamic</span> <span class="pre">memory\nusage.</span> <span class="pre">It</span> <span class="pre">also</span> <span class="pre">allows</span> <span class="pre">to</span> <span class="pre">flush</span> <span class="pre">the</span> <span class="pre">cache</span> <span class="pre">of</span> <span class="pre">accessed</span> <span class="pre">database\nobjects.\n\nSome</span> <span class="pre">Important</span> <span class="pre">statistics</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">table:\n\n|wServer</span> <span class="pre">load|n</span> <span class="pre">is</span> <span class="pre">an</span> <span class="pre">average</span> <span class="pre">of</span> <span class="pre">processor</span> <span class="pre">usage.</span> <span class="pre">It's</span> <span class="pre">usually\nbetween</span> <span class="pre">0</span> <span class="pre">(no</span> <span class="pre">usage)</span> <span class="pre">and</span> <span class="pre">1</span> <span class="pre">(100%</span> <span class="pre">usage),</span> <span class="pre">but</span> <span class="pre">may</span> <span class="pre">also</span> <span class="pre">be\ntemporarily</span> <span class="pre">higher</span> <span class="pre">if</span> <span class="pre">your</span> <span class="pre">computer</span> <span class="pre">has</span> <span class="pre">multiple</span> <span class="pre">CPU</span> <span class="pre">cores.\n\nThe</span> <span class="pre">|wResident/Virtual</span> <span class="pre">memory|n</span> <span class="pre">displays</span> <span class="pre">the</span> <span class="pre">total</span> <span class="pre">memory</span> <span class="pre">used</span> <span class="pre">by\nthe</span> <span class="pre">server</span> <span class="pre">process.\n\nEvennia</span> <span class="pre">|wcaches|n</span> <span class="pre">all</span> <span class="pre">retrieved</span> <span class="pre">database</span> <span class="pre">entities</span> <span class="pre">when</span> <span class="pre">they</span> <span class="pre">are\nloaded</span> <span class="pre">by</span> <span class="pre">use</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">idmapper</span> <span class="pre">functionality.</span> <span class="pre">This</span> <span class="pre">allows</span> <span class="pre">Evennia\nto</span> <span class="pre">maintain</span> <span class="pre">the</span> <span class="pre">same</span> <span class="pre">instances</span> <span class="pre">of</span> <span class="pre">an</span> <span class="pre">entity</span> <span class="pre">and</span> <span class="pre">allowing\nnon-persistent</span> <span class="pre">storage</span> <span class="pre">schemes.</span> <span class="pre">The</span> <span class="pre">total</span> <span class="pre">amount</span> <span class="pre">of</span> <span class="pre">cached</span> <span class="pre">objects\nare</span> <span class="pre">displayed</span> <span class="pre">plus</span> <span class="pre">a</span> <span class="pre">breakdown</span> <span class="pre">of</span> <span class="pre">database</span> <span class="pre">object</span> <span class="pre">types.\n\nThe</span> <span class="pre">|wflushmem|n</span> <span class="pre">switch</span> <span class="pre">allows</span> <span class="pre">to</span> <span class="pre">flush</span> <span class="pre">the</span> <span class="pre">object</span> <span class="pre">cache.</span> <span class="pre">Please\nnote</span> <span class="pre">that</span> <span class="pre">due</span> <span class="pre">to</span> <span class="pre">how</span> <span class="pre">Python's</span> <span class="pre">memory</span> <span class="pre">management</span> <span class="pre">works,</span> <span class="pre">releasing\ncaches</span> <span class="pre">may</span> <span class="pre">not</span> <span class="pre">show</span> <span class="pre">you</span> <span class="pre">a</span> <span class="pre">lower</span> <span class="pre">Residual/Virtual</span> <span class="pre">memory</span> <span class="pre">footprint,\nthe</span> <span class="pre">released</span> <span class="pre">memory</span> <span class="pre">will</span> <span class="pre">instead</span> <span class="pre">be</span> <span class="pre">re-used</span> <span class="pre">by</span> <span class="pre">the</span> <span class="pre">program.\n\n&quot;}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.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.commands.default.system.CmdTasks">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdTasks</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/commands/default/system.html#CmdTasks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdTasks" 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>Display or terminate active tasks (delays).</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>tasks[/switch] [task_id or function_name]</p>
</dd>
<dt>Switches:</dt><dd><p>pause - Pause the callback of a task.
unpause - Process all callbacks made since pause() was called.
do_task - Execute the task (call its callback).
call - Call the callback of this task.
remove - Remove a task without executing it.
cancel - Stop a task from automatically executing.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>A task is a single use method of delaying the call of a function. Calls are created
in code, using <strong>evennia.utils.delay</strong>.
See <a href="#id11"><span class="problematic" id="id12">|</span></a>luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.</p>
<p>By default, tasks that are canceled and never called are cleaned up after one minute.</p>
<p class="rubric">Examples</p>
<ul class="simple">
<li><dl class="simple">
<dt><strong>tasks/cancel move_callback</strong> - Cancels all movement delays from the slow_exit contrib.</dt><dd><p>In this example slow exits creates it’s tasks with
<strong>utils.delay(move_delay, move_callback)</strong></p>
</dd>
</dl>
</li>
<li><p><strong>tasks/cancel 2</strong> - Cancel task id 2.</p></li>
</ul>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTasks.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">'&#64;tasks'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTasks.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">['&#64;delays',</span> <span class="pre">'&#64;task']</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTasks.switch_options">
<span class="sig-name descname"><span class="pre">switch_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('pause',</span> <span class="pre">'unpause',</span> <span class="pre">'do_task',</span> <span class="pre">'call',</span> <span class="pre">'remove',</span> <span class="pre">'cancel')</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.switch_options" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTasks.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:all();perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTasks.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTasks.coll_date_func">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">coll_date_func</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/system.html#CmdTasks.coll_date_func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.coll_date_func" title="Link to this definition"></a></dt>
<dd><p>Replace regex characters in date string and collect deferred function name.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTasks.do_task_action">
<span class="sig-name descname"><span class="pre">do_task_action</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/commands/default/system.html#CmdTasks.do_task_action"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.do_task_action" title="Link to this definition"></a></dt>
<dd><p>Process the action of a tasks command.</p>
<p>This exists to gain support with yes or no function from EvMenu.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTasks.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/commands/default/system.html#CmdTasks.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.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.commands.default.system.CmdTasks.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();cmd:perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTasks.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">'&#64;delays</span> <span class="pre">&#64;task',</span> <span class="pre">'category':</span> <span class="pre">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;tasks',</span> <span class="pre">'no_prefix':</span> <span class="pre">'tasks</span> <span class="pre">delays</span> <span class="pre">task',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nDisplay</span> <span class="pre">or</span> <span class="pre">terminate</span> <span class="pre">active</span> <span class="pre">tasks</span> <span class="pre">(delays).\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">tasks[/switch]</span> <span class="pre">[task_id</span> <span class="pre">or</span> <span class="pre">function_name]\n\nSwitches:\n</span>&#160;&#160;&#160; <span class="pre">pause</span>&#160;&#160; <span class="pre">-</span> <span class="pre">Pause</span> <span class="pre">the</span> <span class="pre">callback</span> <span class="pre">of</span> <span class="pre">a</span> <span class="pre">task.\n</span>&#160;&#160;&#160; <span class="pre">unpause</span> <span class="pre">-</span> <span class="pre">Process</span> <span class="pre">all</span> <span class="pre">callbacks</span> <span class="pre">made</span> <span class="pre">since</span> <span class="pre">pause()</span> <span class="pre">was</span> <span class="pre">called.\n</span>&#160;&#160;&#160; <span class="pre">do_task</span> <span class="pre">-</span> <span class="pre">Execute</span> <span class="pre">the</span> <span class="pre">task</span> <span class="pre">(call</span> <span class="pre">its</span> <span class="pre">callback).\n</span>&#160;&#160;&#160; <span class="pre">call</span>&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">Call</span> <span class="pre">the</span> <span class="pre">callback</span> <span class="pre">of</span> <span class="pre">this</span> <span class="pre">task.\n</span>&#160;&#160;&#160; <span class="pre">remove</span>&#160; <span class="pre">-</span> <span class="pre">Remove</span> <span class="pre">a</span> <span class="pre">task</span> <span class="pre">without</span> <span class="pre">executing</span> <span class="pre">it.\n</span>&#160;&#160;&#160; <span class="pre">cancel</span>&#160; <span class="pre">-</span> <span class="pre">Stop</span> <span class="pre">a</span> <span class="pre">task</span> <span class="pre">from</span> <span class="pre">automatically</span> <span class="pre">executing.\n\nNotes:\n</span>&#160;&#160;&#160; <span class="pre">A</span> <span class="pre">task</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">single</span> <span class="pre">use</span> <span class="pre">method</span> <span class="pre">of</span> <span class="pre">delaying</span> <span class="pre">the</span> <span class="pre">call</span> <span class="pre">of</span> <span class="pre">a</span> <span class="pre">function.</span> <span class="pre">Calls</span> <span class="pre">are</span> <span class="pre">created\n</span>&#160;&#160;&#160; <span class="pre">in</span> <span class="pre">code,</span> <span class="pre">using</span> <span class="pre">`evennia.utils.delay`.\n</span>&#160;&#160;&#160; <span class="pre">See</span> <span class="pre">|luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe</span> <span class="pre">docs|le</span> <span class="pre">for</span> <span class="pre">help.\n\n</span>&#160;&#160;&#160; <span class="pre">By</span> <span class="pre">default,</span> <span class="pre">tasks</span> <span class="pre">that</span> <span class="pre">are</span> <span class="pre">canceled</span> <span class="pre">and</span> <span class="pre">never</span> <span class="pre">called</span> <span class="pre">are</span> <span class="pre">cleaned</span> <span class="pre">up</span> <span class="pre">after</span> <span class="pre">one</span> <span class="pre">minute.\n\nExamples:\n</span>&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">`tasks/cancel</span> <span class="pre">move_callback`</span> <span class="pre">-</span> <span class="pre">Cancels</span> <span class="pre">all</span> <span class="pre">movement</span> <span class="pre">delays</span> <span class="pre">from</span> <span class="pre">the</span> <span class="pre">slow_exit</span> <span class="pre">contrib.\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">In</span> <span class="pre">this</span> <span class="pre">example</span> <span class="pre">slow</span> <span class="pre">exits</span> <span class="pre">creates</span> <span class="pre">it's</span> <span class="pre">tasks</span> <span class="pre">with\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">`utils.delay(move_delay,</span> <span class="pre">move_callback)`\n</span>&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">`tasks/cancel</span> <span class="pre">2`</span> <span class="pre">-</span> <span class="pre">Cancel</span> <span class="pre">task</span> <span class="pre">id</span> <span class="pre">2.\n\n&quot;}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.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.commands.default.system.CmdTickers">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">CmdTickers</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/commands/default/system.html#CmdTickers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdTickers" 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>View running tickers</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>tickers</p>
</dd>
</dl>
<p>Note: Tickers are created, stopped and manipulated in Python code
using the TickerHandler. This is merely a convenience function for
inspecting the current status.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTickers.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">'&#64;tickers'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTickers.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTickers.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">'system'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTickers.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTickers.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:perm(tickers)</span> <span class="pre">or</span> <span class="pre">perm(Builder)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTickers.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTickers.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/commands/default/system.html#CmdTickers.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.CmdTickers.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.commands.default.system.CmdTickers.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.commands.default.system.CmdTickers.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTickers.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:perm(tickers)</span> <span class="pre">or</span> <span class="pre">perm(Builder)'</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTickers.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.CmdTickers.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">'system',</span> <span class="pre">'key':</span> <span class="pre">'&#64;tickers',</span> <span class="pre">'no_prefix':</span> <span class="pre">'tickers</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nView</span> <span class="pre">running</span> <span class="pre">tickers\n\nUsage:\n</span>&#160; <span class="pre">tickers\n\nNote:</span> <span class="pre">Tickers</span> <span class="pre">are</span> <span class="pre">created,</span> <span class="pre">stopped</span> <span class="pre">and</span> <span class="pre">manipulated</span> <span class="pre">in</span> <span class="pre">Python</span> <span class="pre">code\nusing</span> <span class="pre">the</span> <span class="pre">TickerHandler.</span> <span class="pre">This</span> <span class="pre">is</span> <span class="pre">merely</span> <span class="pre">a</span> <span class="pre">convenience</span> <span class="pre">function</span> <span class="pre">for\ninspecting</span> <span class="pre">the</span> <span class="pre">current</span> <span class="pre">status.\n\n'}</span></em><a class="headerlink" href="#evennia.commands.default.system.CmdTickers.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.commands.default.system.AccountDB">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">AccountDB</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/accounts/models.html#AccountDB"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.AccountDB" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypedObject</span></code></a>, <a class="reference internal" href="evennia.accounts.models.html#evennia.accounts.models.AbstractUser" title="django.contrib.auth.models.AbstractUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbstractUser</span></code></a></p>
<p>This is a special model using Django’s ‘profile’ functionality
and extends the default Django User model. It is defined as such
by use of the variable AUTH_PROFILE_MODULE in the settings.
One accesses the fields/methods. We try use this model as much
as possible rather than User, since we can customize this to
our liking.</p>
<p>The TypedObject supplies the following (inherited) properties:</p>
<blockquote>
<div><ul class="simple">
<li><p>key - main name</p></li>
<li><p>typeclass_path - the path to the decorating typeclass</p></li>
<li><p>typeclass - auto-linked typeclass</p></li>
<li><p>date_created - time stamp of object creation</p></li>
<li><p>permissions - perm strings</p></li>
<li><p>dbref - #id of object</p></li>
<li><p>db - persistent attribute storage</p></li>
<li><p>ndb - non-persistent attribute storage</p></li>
</ul>
</div></blockquote>
<p>The AccountDB adds the following properties:</p>
<blockquote>
<div><ul class="simple">
<li><p>is_connected - If any Session is currently connected to this Account</p></li>
<li><p>name - alias for user.username</p></li>
<li><p>sessions - sessions connected to this account</p></li>
<li><p>is_superuser - bool if this account is a superuser</p></li>
<li><p>is_bot - bool if this account is a bot and not a real account</p></li>
</ul>
</div></blockquote>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.DoesNotExist">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DoesNotExist</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.dbserialize.html#evennia.utils.dbserialize.ObjectDoesNotExist" title="django.core.exceptions.ObjectDoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectDoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.MultipleObjectsReturned">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MultipleObjectsReturned</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.account_subscription_set">
<span class="sig-name descname"><span class="pre">account_subscription_set</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.account_subscription_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.cmdset_storage">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cmdset_storage</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.cmdset_storage" title="Link to this definition"></a></dt>
<dd><p>Getter. Allows for value = self.name. Returns a list of cmdset_storage.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.date_joined">
<span class="sig-name descname"><span class="pre">date_joined</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.date_joined" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.db_attributes">
<span class="sig-name descname"><span class="pre">db_attributes</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.db_attributes" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.db_cmdset_storage">
<span class="sig-name descname"><span class="pre">db_cmdset_storage</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.db_cmdset_storage" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.db_date_created">
<span class="sig-name descname"><span class="pre">db_date_created</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.db_date_created" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.db_is_bot">
<span class="sig-name descname"><span class="pre">db_is_bot</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.db_is_bot" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.db_is_connected">
<span class="sig-name descname"><span class="pre">db_is_connected</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.db_is_connected" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.db_key">
<span class="sig-name descname"><span class="pre">db_key</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.db_key" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.db_lock_storage">
<span class="sig-name descname"><span class="pre">db_lock_storage</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.db_lock_storage" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.db_tags">
<span class="sig-name descname"><span class="pre">db_tags</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.db_tags" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.db_typeclass_path">
<span class="sig-name descname"><span class="pre">db_typeclass_path</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.db_typeclass_path" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.email">
<span class="sig-name descname"><span class="pre">email</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.email" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.first_name">
<span class="sig-name descname"><span class="pre">first_name</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.first_name" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.get_next_by_date_joined">
<span class="sig-name descname"><span class="pre">get_next_by_date_joined</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field=&lt;django.db.models.fields.DateTimeField:</span> <span class="pre">date_joined&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_next=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.get_next_by_date_joined" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.get_next_by_db_date_created">
<span class="sig-name descname"><span class="pre">get_next_by_db_date_created</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field=&lt;django.db.models.fields.DateTimeField:</span> <span class="pre">db_date_created&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_next=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.get_next_by_db_date_created" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.get_previous_by_date_joined">
<span class="sig-name descname"><span class="pre">get_previous_by_date_joined</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field=&lt;django.db.models.fields.DateTimeField:</span> <span class="pre">date_joined&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_next=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.get_previous_by_date_joined" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.get_previous_by_db_date_created">
<span class="sig-name descname"><span class="pre">get_previous_by_db_date_created</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field=&lt;django.db.models.fields.DateTimeField:</span> <span class="pre">db_date_created&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_next=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.get_previous_by_db_date_created" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.groups">
<span class="sig-name descname"><span class="pre">groups</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.groups" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.hide_from_accounts_set">
<span class="sig-name descname"><span class="pre">hide_from_accounts_set</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.hide_from_accounts_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.id">
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.id" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.is_active">
<span class="sig-name descname"><span class="pre">is_active</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.is_active" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.is_bot">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_bot</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.is_bot" title="Link to this definition"></a></dt>
<dd><p>A wrapper for getting database field <strong>db_is_bot</strong>.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.is_connected">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_connected</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.is_connected" title="Link to this definition"></a></dt>
<dd><p>A wrapper for getting database field <strong>db_is_connected</strong>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.is_staff">
<span class="sig-name descname"><span class="pre">is_staff</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.is_staff" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.is_superuser">
<span class="sig-name descname"><span class="pre">is_superuser</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.is_superuser" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.key">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">key</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.last_login">
<span class="sig-name descname"><span class="pre">last_login</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.last_login" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.last_name">
<span class="sig-name descname"><span class="pre">last_name</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.last_name" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.logentry_set">
<span class="sig-name descname"><span class="pre">logentry_set</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.logentry_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
many-to-one relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Parent.children**</strong> is a <strong>**ReverseManyToOneDescriptor**</strong> instance.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.name">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.objectdb_set">
<span class="sig-name descname"><span class="pre">objectdb_set</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.objectdb_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
many-to-one relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Parent.children**</strong> is a <strong>**ReverseManyToOneDescriptor**</strong> instance.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.objects">
<span class="sig-name descname"><span class="pre">objects</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;evennia.accounts.manager.AccountDBManager</span> <span class="pre">object&gt;</span></em><a class="headerlink" href="#evennia.commands.default.system.AccountDB.objects" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.password">
<span class="sig-name descname"><span class="pre">password</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.password" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.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.accounts.models.AccountDB'</span></em><a class="headerlink" href="#evennia.commands.default.system.AccountDB.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.receiver_account_set">
<span class="sig-name descname"><span class="pre">receiver_account_set</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.receiver_account_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.scriptdb_set">
<span class="sig-name descname"><span class="pre">scriptdb_set</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.scriptdb_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
many-to-one relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Parent.children**</strong> is a <strong>**ReverseManyToOneDescriptor**</strong> instance.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.sender_account_set">
<span class="sig-name descname"><span class="pre">sender_account_set</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.sender_account_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.typename">
<span class="sig-name descname"><span class="pre">typename</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SharedMemoryModelBase'</span></em><a class="headerlink" href="#evennia.commands.default.system.AccountDB.typename" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.uid">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uid</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.uid" title="Link to this definition"></a></dt>
<dd><p>Getter. Retrieves the user id</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.user_permissions">
<span class="sig-name descname"><span class="pre">user_permissions</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.user_permissions" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.AccountDB.username">
<span class="sig-name descname"><span class="pre">username</span></span><a class="headerlink" href="#evennia.commands.default.system.AccountDB.username" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.system.COMMAND_DEFAULT_CLASS">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">COMMAND_DEFAULT_CLASS</span></span><a class="headerlink" href="#evennia.commands.default.system.COMMAND_DEFAULT_CLASS" title="Link to this definition"></a></dt>
<dd><p>alias of <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>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">EvEditor</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">loadfunc</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">savefunc</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">quitfunc</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persistent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">codefunc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This defines a line editor object. It creates all relevant commands
and tracks the current state of the buffer. It also cleans up after
itself.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loadfunc</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">savefunc</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">quitfunc</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persistent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">codefunc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.__init__" title="Link to this definition"></a></dt>
<dd><p>Launches a full in-game line editor, mimicking the functionality of VIM.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>caller</strong> (<em>Object</em>) – Who is using the editor.</p></li>
<li><p><strong>loadfunc</strong> (<em>callable</em><em>, </em><em>optional</em>) – This will be called as
<strong>loadfunc(caller)</strong> when the editor is first started. Its
return will be used as the editor’s starting buffer.</p></li>
<li><p><strong>savefunc</strong> (<em>callable</em><em>, </em><em>optional</em>) – This will be called as
<strong>savefunc(caller, buffer)</strong> when the save-command is given and
is used to actually determine where/how result is saved.
It should return <strong>True</strong> if save was successful and also
handle any feedback to the user.</p></li>
<li><p><strong>quitfunc</strong> (<em>callable</em><em>, </em><em>optional</em>) – This will optionally be
called as <strong>quitfunc(caller)</strong> when the editor is
exited. If defined, it should handle all wanted feedback
to the user.</p></li>
<li><p><strong>quitfunc_args</strong> (<em>tuple</em><em>, </em><em>optional</em>) – Optional tuple of arguments to
supply to <strong>quitfunc</strong>.</p></li>
<li><p><strong>key</strong> (<em>str</em><em>, </em><em>optional</em>) – An optional key for naming this
session and make it unique from other editing sessions.</p></li>
<li><p><strong>persistent</strong> (<em>bool</em><em>, </em><em>optional</em>) – Make the editor survive a reboot. Note
that if this is set, all callables must be possible to pickle</p></li>
<li><p><strong>codefunc</strong> (<em>bool</em><em>, </em><em>optional</em>) – If given, will run the editor in code mode.
This will be called as <strong>codefunc(caller, buf)</strong>.</p></li>
</ul>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>In persistent mode, all the input callables (savefunc etc)
must be possible to be <em>pickled</em>, this excludes e.g.
callables that are class methods or functions defined
dynamically or as part of another function. In
non-persistent mode no such restrictions exist.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.decrease_indent">
<span class="sig-name descname"><span class="pre">decrease_indent</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.decrease_indent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.decrease_indent" title="Link to this definition"></a></dt>
<dd><p>Decrease automatic indentation by 1 level.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.deduce_indent">
<span class="sig-name descname"><span class="pre">deduce_indent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffer</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.deduce_indent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.deduce_indent" title="Link to this definition"></a></dt>
<dd><p>Try to deduce the level of indentation of the given line.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.display_buffer">
<span class="sig-name descname"><span class="pre">display_buffer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buf</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">offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linenums</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{'raw':</span> <span class="pre">False}</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.display_buffer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.display_buffer" title="Link to this definition"></a></dt>
<dd><p>This displays the line editor buffer, or selected parts of it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>buf</strong> (<em>str</em><em>, </em><em>optional</em>) – The buffer or part of buffer to display.</p></li>
<li><p><strong>offset</strong> (<em>int</em><em>, </em><em>optional</em>) – If <strong>buf</strong> is set and is not the full buffer,
<strong>offset</strong> should define the actual starting line number, to
get the linenum display right.</p></li>
<li><p><strong>linenums</strong> (<em>bool</em><em>, </em><em>optional</em>) – Show line numbers in buffer.</p></li>
<li><p><strong>options</strong> – raw (bool, optional): Tell protocol to not parse
formatting information.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.display_help">
<span class="sig-name descname"><span class="pre">display_help</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.display_help"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.display_help" title="Link to this definition"></a></dt>
<dd><p>Shows the help entry for the editor.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.get_buffer">
<span class="sig-name descname"><span class="pre">get_buffer</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.get_buffer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.get_buffer" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>buffer (str)</em> – The current buffer.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.increase_indent">
<span class="sig-name descname"><span class="pre">increase_indent</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.increase_indent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.increase_indent" title="Link to this definition"></a></dt>
<dd><p>Increase automatic indentation by 1 level.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.load_buffer">
<span class="sig-name descname"><span class="pre">load_buffer</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.load_buffer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.load_buffer" title="Link to this definition"></a></dt>
<dd><p>Load the buffer using the load function hook.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.quit">
<span class="sig-name descname"><span class="pre">quit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.quit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.quit" title="Link to this definition"></a></dt>
<dd><p>Cleanly exit the editor.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.save_buffer">
<span class="sig-name descname"><span class="pre">save_buffer</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.save_buffer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.save_buffer" title="Link to this definition"></a></dt>
<dd><p>Saves the content of the buffer.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.swap_autoindent">
<span class="sig-name descname"><span class="pre">swap_autoindent</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.swap_autoindent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.swap_autoindent" title="Link to this definition"></a></dt>
<dd><p>Swap automatic indentation on or off.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.update_buffer">
<span class="sig-name descname"><span class="pre">update_buffer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">buf</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/eveditor.html#EvEditor.update_buffer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.update_buffer" title="Link to this definition"></a></dt>
<dd><p>This should be called when the buffer has been changed
somehow. It will handle unsaved flag and undo updating.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>buf</strong> (<em>str</em>) – The text to update the buffer with.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvEditor.update_undo">
<span class="sig-name descname"><span class="pre">update_undo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">step</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/utils/eveditor.html#EvEditor.update_undo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvEditor.update_undo" title="Link to this definition"></a></dt>
<dd><p>This updates the undo position.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>step</strong> (<em>int</em><em>, </em><em>optional</em>) – The amount of steps
to progress the undo position to. This
may be a negative value for undo and
a positive value for redo.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvTable">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">EvTable</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/utils/evtable.html#EvTable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvTable" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The table class holds a list of EvColumns, each consisting of EvCells so
that the result is a 2D matrix.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvTable.__init__">
<span class="sig-name descname"><span class="pre">__init__</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/utils/evtable.html#EvTable.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvTable.__init__" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>table.</strong> (<em>Header texts for the</em>)</p>
</dd>
<dt class="field-even">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>table</strong> (list of lists or list of <strong>EvColumns</strong>, optional) – This is used to build the table in a quick way. If not
given, the table will start out empty and <strong>add_</strong> methods
need to be used to add rows/columns.</p></li>
<li><p><strong>header</strong> (<em>bool</em><em>, </em><em>optional</em>) – <strong>True</strong>/<strong>False</strong> - turn off the
header texts (<strong>*args</strong>) being treated as a header (such as
not adding extra underlining)</p></li>
<li><p><strong>pad_width</strong> (<em>int</em><em>, </em><em>optional</em>) – How much empty space to pad your cells with
(default is 1)</p></li>
<li><p><strong>border</strong> (<em>str</em><em>, </em><em>optional</em><em>)</em>) – The border style to use. This is one of
- <strong>None</strong> - No border drawing at all.
- “table” - only a border around the whole table.
- “tablecols” - table and column borders. (default)
- “header” - only border under header.
- “cols” - only vertical borders.
- “incols” - vertical borders, no outer edges.
- “rows” - only borders between rows.
- “cells” - border around all cells.</p></li>
<li><p><strong>border_width</strong> (<em>int</em><em>, </em><em>optional</em>) – Width of table borders, if border is active.
Note that widths wider than 1 may give artifacts in the corners. Default is 1.</p></li>
<li><p><strong>corner_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character to use in corners when border is active.
Default is <strong>+</strong>.</p></li>
<li><p><strong>corner_top_left_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character used for “nw” corner of table.
Defaults to <strong>corner_char</strong>.</p></li>
<li><p><strong>corner_top_right_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character used for “ne” corner of table.
Defaults to <strong>corner_char</strong>.</p></li>
<li><p><strong>corner_bottom_left_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character used for “sw” corner of table.
Defaults to <strong>corner_char</strong>.</p></li>
<li><p><strong>corner_bottom_right_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character used for “se” corner of table.
Defaults to <strong>corner_char</strong>.</p></li>
<li><p><strong>pretty_corners</strong> (<em>bool</em><em>, </em><em>optional</em>) – Use custom characters to
make the table corners look “rounded”. Uses UTF-8
characters. Defaults to <strong>False</strong> for maximum compatibility with various displays
that may occationally have issues with UTF-8 characters.</p></li>
<li><p><strong>header_line_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character to use for underlining
the header row (default is ‘~’). Requires <strong>border</strong> to not be <strong>None</strong>.</p></li>
<li><p><strong>width</strong> (<em>int</em><em>, </em><em>optional</em>) – Fixed width of table. If not set,
width is set by the total width of each column. This will
resize individual columns in the vertical direction to fit.</p></li>
<li><p><strong>height</strong> (<em>int</em><em>, </em><em>optional</em>) – Fixed height of table. Defaults to being unset. Width is
still given precedence. If given, table cells will crop text rather
than expand vertically.</p></li>
<li><p><strong>evenwidth</strong> (<em>bool</em><em>, </em><em>optional</em>) – Used with the <strong>width</strong> keyword. Adjusts columns to have as
even width as possible. This often looks best also for mixed-length tables. Default
is <strong>False</strong>.</p></li>
<li><p><strong>maxwidth</strong> (<em>int</em><em>, </em><em>optional</em>) – This will set a maximum width
of the table while allowing it to be smaller. Only if it grows wider than this
size will it be resized by expanding horizontally (or crop <strong>height</strong> is given).
This keyword has no meaning if <strong>width</strong> is set.</p></li>
</ul>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Exception</strong> – If given erroneous input or width settings for the data.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Beyond those table-specific keywords, the non-overlapping keywords
of <strong>EvCell.__init__</strong> are also available. These will be passed down
to every cell in the table.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvTable.add_column">
<span class="sig-name descname"><span class="pre">add_column</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/utils/evtable.html#EvTable.add_column"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvTable.add_column" title="Link to this definition"></a></dt>
<dd><p>Add a column to table. If there are more rows in new column
than there are rows in the current table, the table will
expand with empty rows in the other columns. If too few, the
new column with get new empty rows. All filling rows are added
to the end.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>args</strong> (<strong>EvColumn</strong> or multiple strings) – Either a single EvColumn instance or
a number of data string arguments to be used to create a new column.</p></li>
<li><p><strong>header</strong> (<em>str</em><em>, </em><em>optional</em>) – The header text for the column</p></li>
<li><p><strong>xpos</strong> (<em>int</em><em>, </em><em>optional</em>) – Index position in table <em>before</em> which
to input new column. If not given, column will be added to the end
of the table. Uses Python indexing (so first column is <strong>xpos=0</strong>)</p></li>
</ul>
</dd>
<dt class="field-even">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>Cell.__init__.</strong> (<em>Other keywords as per</em>)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvTable.add_header">
<span class="sig-name descname"><span class="pre">add_header</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/utils/evtable.html#EvTable.add_header"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvTable.add_header" title="Link to this definition"></a></dt>
<dd><p>Add header to table. This is a number of texts to be put at
the top of the table. They will replace an existing header.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>args</strong> (<em>str</em>) – These strings will be used as the header texts.</p>
</dd>
<dt class="field-even">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>applied</strong> (<em>Same keywords as per EvTable.__init__. Will be</em>)</p></li>
<li><p><strong>cells.</strong> (<em>to the new header's</em>)</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvTable.add_row">
<span class="sig-name descname"><span class="pre">add_row</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/utils/evtable.html#EvTable.add_row"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvTable.add_row" title="Link to this definition"></a></dt>
<dd><p>Add a row to table (not a header). If there are more cells in
the given row than there are cells in the current table the
table will be expanded with empty columns to match. These will
be added to the end of the table. In the same way, adding a
line with too few cells will lead to the last ones getting
padded.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>args</strong> (<em>str</em>) – Any number of string argumnets to use as the
data in the row (one cell per argument).</p></li>
<li><p><strong>ypos</strong> (<em>int</em><em>, </em><em>optional</em>) – Index position in table before which to
input new row. If not given, will be added to the end of the table.
Uses Python indexing (so first row is <strong>ypos=0</strong>)</p></li>
</ul>
</dd>
<dt class="field-even">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>EvCell.__init__.</strong> (<em>Other keywords are as per</em>)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvTable.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/evtable.html#EvTable.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvTable.get" title="Link to this definition"></a></dt>
<dd><p>Return lines of table as a list.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>table_lines (list)</em> – The lines of the table, in order.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvTable.reformat">
<span class="sig-name descname"><span class="pre">reformat</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/utils/evtable.html#EvTable.reformat"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvTable.reformat" title="Link to this definition"></a></dt>
<dd><p>Force a re-shape of the entire table.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>EvTable.__init__.</strong> (<em>Table options as per</em>)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvTable.reformat_column">
<span class="sig-name descname"><span class="pre">reformat_column</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</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/utils/evtable.html#EvTable.reformat_column"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvTable.reformat_column" title="Link to this definition"></a></dt>
<dd><p>Sends custom options to a specific column in the table.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>index</strong> (<em>int</em>) – Which column to reformat. The column index is
given from 0 to Ncolumns-1.</p>
</dd>
<dt class="field-even">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>EvCell.__init__.</strong> (<em>Column options as per</em>)</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Exception</strong> – if an invalid index is found.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvenniaPythonConsole">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">EvenniaPythonConsole</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/system.html#EvenniaPythonConsole"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvenniaPythonConsole" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveConsole</span></code></p>
<p>Evennia wrapper around a Python interactive console.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvenniaPythonConsole.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/system.html#EvenniaPythonConsole.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvenniaPythonConsole.__init__" title="Link to this definition"></a></dt>
<dd><p>Constructor.</p>
<p>The optional locals argument will be passed to the
InteractiveInterpreter base class.</p>
<p>The optional filename argument should specify the (file)name
of the input stream; it will show up in tracebacks.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvenniaPythonConsole.write">
<span class="sig-name descname"><span class="pre">write</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/system.html#EvenniaPythonConsole.write"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvenniaPythonConsole.write" title="Link to this definition"></a></dt>
<dd><p>Don’t send to stderr, send to self.caller.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.EvenniaPythonConsole.push">
<span class="sig-name descname"><span class="pre">push</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/system.html#EvenniaPythonConsole.push"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.EvenniaPythonConsole.push" title="Link to this definition"></a></dt>
<dd><p>Push some code, whether complete or not.</p>
</dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.commands.default.system.PrintRecursionError">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">PrintRecursionError</span></span><a class="reference internal" href="../_modules/evennia/commands/default/system.html#PrintRecursionError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.PrintRecursionError" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">RecursionError</span></code></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask">
<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.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">TaskHandlerTask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>An object to represent a single TaskHandler task.</p>
<dl class="simple">
<dt>Instance Attributes:</dt><dd><p>task_id (int): the global id for this task
deferred (deferred): a reference to this task’s deferred</p>
</dd>
<dt>Property Attributes:</dt><dd><p>paused (bool): check if the deferred instance of a task has been paused.
called(self): A task attribute to check if the deferred instance of a task has been called.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.pause">
<span class="sig-name descname"><span class="pre">pause</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.pause"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.pause" title="Link to this definition"></a></dt>
<dd><p>Pause the callback of a task.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.unpause">
<span class="sig-name descname"><span class="pre">unpause</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.unpause"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.unpause" title="Link to this definition"></a></dt>
<dd><p>Process all callbacks made since pause() was called.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.do_task">
<span class="sig-name descname"><span class="pre">do_task</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.do_task"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.do_task" title="Link to this definition"></a></dt>
<dd><p>Execute the task (call its callback).</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.call">
<span class="sig-name descname"><span class="pre">call</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.call"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.call" title="Link to this definition"></a></dt>
<dd><p>Call the callback of this task.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.remove">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.remove"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.remove" title="Link to this definition"></a></dt>
<dd><p>Remove a task without executing it.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.cancel">
<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.cancel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.cancel" title="Link to this definition"></a></dt>
<dd><p>Stop a task from automatically executing.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.active">
<span class="sig-name descname"><span class="pre">active</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.active"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.active" title="Link to this definition"></a></dt>
<dd><p>Check if a task is active (has not been called yet).</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.exists">
<span class="sig-name descname"><span class="pre">exists</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.exists" title="Link to this definition"></a></dt>
<dd><p>Check if a task exists.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.get_id">
<span class="sig-name descname"><span class="pre">get_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.get_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.get_id" title="Link to this definition"></a></dt>
<dd><p>Returns the global id for this task. For use with</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="id0">
<span class="sig-name descname"><span class="pre">active</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.active"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id0" title="Link to this definition"></a></dt>
<dd><p>Check if a task is active (has not been called yet).</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>bool</em> –</p>
<dl class="simple">
<dt>True if a task is active (has not been called yet). False if</dt><dd><p>it is not (has been called) or if the task does not exist.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="id13">
<span class="sig-name descname"><span class="pre">call</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.call"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id13" title="Link to this definition"></a></dt>
<dd><p>Call the callback of a task.
Leave the task unaffected otherwise.
This does not use the task’s deferred instance.
The only requirement is that the task exist in task handler.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>bool or any</em> – Set to <strong>False</strong> if the task does not exist in task
handler. Otherwise it will be the return of the task’s callback.</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.called">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">called</span></span><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.called" title="Link to this definition"></a></dt>
<dd><p>A task attribute to check if the deferred instance of a task has been called.</p>
<p>This exists to mock usage of a twisted deferred object.
It will not set to True if Task.call has been called. This only happens if
task’s deferred instance calls the callback.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>bool</em> –</p>
<dl class="simple">
<dt>True if the deferred instance of this task has called the callback.</dt><dd><p>False if the deferred instnace of this task has not called the callback.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="id14">
<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.cancel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id14" title="Link to this definition"></a></dt>
<dd><p>Stop a task from automatically executing.
This will not remove the task.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>bool</em> –</p>
<dl class="simple">
<dt>True if the cancel completed successfully.</dt><dd><p>False if the cancel did not complete successfully.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="id15">
<span class="sig-name descname"><span class="pre">do_task</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.do_task"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id15" title="Link to this definition"></a></dt>
<dd><p>Execute the task (call its callback).
If calling before timedelay, cancel the deferred instance affliated to this task.
Remove the task from the dictionary of current tasks on a successful
callback.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>bool or any</em> – Set to <strong>False</strong> if the task does not exist in task
handler. Otherwise it will be the return of the task’s callback.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="id16">
<span class="sig-name descname"><span class="pre">exists</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id16" title="Link to this definition"></a></dt>
<dd><p>Check if a task exists.
Most task handler methods check for existence for you.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>bool</em> – True the task exists False if it does not.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.get_deferred">
<span class="sig-name descname"><span class="pre">get_deferred</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.get_deferred"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.get_deferred" title="Link to this definition"></a></dt>
<dd><p>Return the instance of the deferred the task id is using.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>bool or deferred</em> –</p>
<dl class="simple">
<dt>An instance of a deferred or False if there is no task with the id.</dt><dd><p>None is returned if there is no deferred affiliated with this id.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="id17">
<span class="sig-name descname"><span class="pre">get_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.get_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id17" title="Link to this definition"></a></dt>
<dd><p>Returns the global id for this task. For use with
<strong>evennia.scripts.taskhandler.TASK_HANDLER</strong>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>task_id (int)</em> – global task id for this task.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="id18">
<span class="sig-name descname"><span class="pre">pause</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.pause"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id18" title="Link to this definition"></a></dt>
<dd><p>Pause the callback of a task.
To resume use <strong>TaskHandlerTask.unpause</strong>.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.commands.default.system.TaskHandlerTask.paused">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paused</span></span><a class="headerlink" href="#evennia.commands.default.system.TaskHandlerTask.paused" title="Link to this definition"></a></dt>
<dd><p>A task attribute to check if the deferred instance of a task has been paused.</p>
<p>This exists to mock usage of a twisted deferred object.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><p><em>bool or None</em> –</p>
<dl class="simple">
<dt>True if the task was properly paused. None if the task does not have</dt><dd><p>a deferred instance.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="id19">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.remove"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id19" title="Link to this definition"></a></dt>
<dd><p>Remove a task without executing it.
Deletes the instance of the task’s deferred.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>task_id</strong> (<em>int</em>) – an existing task ID.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>bool</em> – True if the removal completed successfully.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="id20">
<span class="sig-name descname"><span class="pre">unpause</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.unpause"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id20" title="Link to this definition"></a></dt>
<dd><p>Unpause a task, run the task if it has passed delay time.</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.commands.default.system.ask_yes_no">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">ask_yes_no</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">prompt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Yes</span> <span class="pre">or</span> <span class="pre">No</span> <span class="pre">{options}?'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">yes_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Yes'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'No'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</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">allow_abort</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="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/utils/evmenu.html#ask_yes_no"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.ask_yes_no" title="Link to this definition"></a></dt>
<dd><p>A helper function for asking a simple yes/no question. This will cause
the system to pause and wait for input from the player.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>caller</strong> (<em>Object</em>) – The entity being asked.</p></li>
<li><p><strong>prompt</strong> (<em>str</em>) – The yes/no question to ask. This takes an optional formatting
marker <strong>{options}</strong> which will be filled with ‘Y/N’, ‘[Y]/N’ or
‘Y/[N]’ depending on the setting of <strong>default</strong>. If <strong>allow_abort</strong> is set,
then the ‘A(bort)’ option will also be available.</p></li>
<li><p><strong>yes_action</strong> (<em>callable</em><em> or </em><em>str</em>) – If a callable, this will be called
with <strong>(caller, *args, **kwargs)</strong> when the Yes-choice is made.
If a string, this string will be echoed back to the caller.</p></li>
<li><p><strong>no_action</strong> (<em>callable</em><em> or </em><em>str</em>) – If a callable, this will be called
with <strong>(caller, *args, **kwargs)</strong> when the No-choice is made.
If a string, this string will be echoed back to the caller.</p></li>
<li><p><strong>default</strong> (<em>str optional</em>) – This is what the user will get if they just press the
return key without giving any input. One of ‘N’, ‘Y’, ‘A’ or <strong>None</strong>
for no default (an explicit choice must be given). If ‘A’ (abort)
is given, <strong>allow_abort</strong> kwarg is ignored and assumed set.</p></li>
<li><p><strong>allow_abort</strong> (<em>bool</em><em>, </em><em>optional</em>) – If set, the ‘A(bort)’ option is available
(a third option meaning neither yes or no but just exits the prompt).</p></li>
<li><p><strong>session</strong> (<a class="reference internal" href="evennia.server.session.html#evennia.server.session.Session" title="evennia.server.session.Session"><em>Session</em></a><em>, </em><em>optional</em>) – This allows to specify the
session to send the prompt to. It’s usually only needed if <strong>caller</strong>
is an Account in multisession modes greater than 2. The session is
then updated by the command and is available (for example in
callbacks) through <strong>caller.ndb._yes_no_question.session</strong>.</p></li>
<li><p><strong>*args</strong> – Additional arguments passed on into callables.</p></li>
<li><p><strong>**kwargs</strong> – Additional keyword args passed on into callables.</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>RuntimeError</strong><strong>, </strong><strong>FooError</strong> – If default and <strong>allow_abort</strong> clashes.</p>
</dd>
</dl>
<p class="rubric">Example</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># just returning strings</span>
<span class="n">ask_yes_no</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="s2">&quot;Are you happy </span><span class="si">{options}</span><span class="s2">?&quot;</span><span class="p">,</span>
<span class="s2">&quot;you answered yes&quot;</span><span class="p">,</span> <span class="s2">&quot;you answered no&quot;</span><span class="p">)</span>
<span class="c1"># trigger callables</span>
<span class="n">ask_yes_no</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="s2">&quot;Are you sad </span><span class="si">{options}</span><span class="s2">?&quot;</span><span class="p">,</span>
<span class="n">_callable_yes</span><span class="p">,</span> <span class="n">_callable_no</span><span class="p">,</span> <span class="n">allow_abort</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.commands.default.system.class_from_module">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">class_from_module</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">defaultpaths</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">fallback</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/utils/utils.html#class_from_module"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.class_from_module" title="Link to this definition"></a></dt>
<dd><p>Return a class from a module, given the class’ full python path. This is
primarily used to convert db_typeclass_path:s to classes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path</strong> (<em>str</em>) – Full Python dot-path to module.</p></li>
<li><p><strong>defaultpaths</strong> (<em>iterable</em><em>, </em><em>optional</em>) – If a direct import from <strong>path</strong> fails,
try subsequent imports by prepending those paths to <strong>path</strong>.</p></li>
<li><p><strong>fallback</strong> (<em>str</em>) – If all other attempts fail, use this path as a fallback.
This is intended as a last-resort. In the example of Evennia
loading, this would be a path to a default parent class in the
evennia repo itself.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>class (Class)</em> – An uninstantiated class recovered from path.</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>ImportError</strong> – If all loading failed.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.commands.default.system.evennia_local_vars">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">evennia_local_vars</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/system.html#evennia_local_vars"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.evennia_local_vars" title="Link to this definition"></a></dt>
<dd><p>Return Evennia local variables usable in the py command as a dictionary.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.commands.default.system.iter_to_str">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.default.system.</span></span><span class="sig-name descname"><span class="pre">iter_to_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iterable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">','</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endsep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">',</span> <span class="pre">and'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">addquote</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/utils.html#iter_to_str"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.system.iter_to_str" title="Link to this definition"></a></dt>
<dd><p>This pretty-formats an iterable list as string output, adding an optional
alternative separator to the second to last entry. If <strong>addquote</strong>
is <strong>True</strong>, the outgoing strings will be surrounded by quotes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>iterable</strong> (<em>any</em>) – Usually an iterable to print. Each element must be possible to
present with a string. Note that if this is a generator, it will be
consumed by this operation.</p></li>
<li><p><strong>sep</strong> (<em>str</em><em>, </em><em>optional</em>) – The string to use as a separator for each item in the iterable.</p></li>
<li><p><strong>endsep</strong> (<em>str</em><em>, </em><em>optional</em>) – The last item separator will be replaced with this value.</p></li>
<li><p><strong>addquote</strong> (<em>bool</em><em>, </em><em>optional</em>) – This will surround all outgoing
values with double quotes.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>str</em> – The list represented as a string.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Default is to use ‘Oxford comma’, like 1, 2, 3, and 4.</p>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">&#39;,&#39;</span><span class="p">)</span>
<span class="go">&#39;1, 2, 3&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
<span class="go">&#39;1, 2 3&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">ensdep</span><span class="o">=</span><span class="s1">&#39;and&#39;</span><span class="p">)</span>
<span class="go">&#39;1, 2 and 3&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;;&#39;</span><span class="p">,</span> <span class="n">endsep</span><span class="o">=</span><span class="s1">&#39;;&#39;</span><span class="p">)</span>
<span class="go">&#39;1; 2; 3&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">iter_to_string</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">],</span> <span class="n">addquote</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="go">&#39;&quot;1&quot;, &quot;2&quot;, and &quot;3&quot;&#39;</span>
</pre></div>
</div>
</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.commands.default.system</a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAccounts"><code class="docutils literal notranslate"><span class="pre">CmdAccounts</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAccounts.key"><code class="docutils literal notranslate"><span class="pre">CmdAccounts.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAccounts.aliases"><code class="docutils literal notranslate"><span class="pre">CmdAccounts.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAccounts.switch_options"><code class="docutils literal notranslate"><span class="pre">CmdAccounts.switch_options</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAccounts.locks"><code class="docutils literal notranslate"><span class="pre">CmdAccounts.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAccounts.help_category"><code class="docutils literal notranslate"><span class="pre">CmdAccounts.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAccounts.func"><code class="docutils literal notranslate"><span class="pre">CmdAccounts.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAccounts.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdAccounts.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAccounts.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdAccounts.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReload"><code class="docutils literal notranslate"><span class="pre">CmdReload</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReload.key"><code class="docutils literal notranslate"><span class="pre">CmdReload.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReload.aliases"><code class="docutils literal notranslate"><span class="pre">CmdReload.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReload.locks"><code class="docutils literal notranslate"><span class="pre">CmdReload.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReload.help_category"><code class="docutils literal notranslate"><span class="pre">CmdReload.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReload.func"><code class="docutils literal notranslate"><span class="pre">CmdReload.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReload.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdReload.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReload.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdReload.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReset"><code class="docutils literal notranslate"><span class="pre">CmdReset</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReset.key"><code class="docutils literal notranslate"><span class="pre">CmdReset.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReset.locks"><code class="docutils literal notranslate"><span class="pre">CmdReset.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReset.help_category"><code class="docutils literal notranslate"><span class="pre">CmdReset.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReset.func"><code class="docutils literal notranslate"><span class="pre">CmdReset.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReset.aliases"><code class="docutils literal notranslate"><span class="pre">CmdReset.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReset.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdReset.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdReset.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdReset.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdShutdown"><code class="docutils literal notranslate"><span class="pre">CmdShutdown</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdShutdown.key"><code class="docutils literal notranslate"><span class="pre">CmdShutdown.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdShutdown.locks"><code class="docutils literal notranslate"><span class="pre">CmdShutdown.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdShutdown.help_category"><code class="docutils literal notranslate"><span class="pre">CmdShutdown.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdShutdown.func"><code class="docutils literal notranslate"><span class="pre">CmdShutdown.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdShutdown.aliases"><code class="docutils literal notranslate"><span class="pre">CmdShutdown.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdShutdown.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdShutdown.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdShutdown.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdShutdown.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdPy"><code class="docutils literal notranslate"><span class="pre">CmdPy</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdPy.key"><code class="docutils literal notranslate"><span class="pre">CmdPy.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdPy.aliases"><code class="docutils literal notranslate"><span class="pre">CmdPy.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdPy.switch_options"><code class="docutils literal notranslate"><span class="pre">CmdPy.switch_options</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdPy.locks"><code class="docutils literal notranslate"><span class="pre">CmdPy.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdPy.help_category"><code class="docutils literal notranslate"><span class="pre">CmdPy.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdPy.arg_regex"><code class="docutils literal notranslate"><span class="pre">CmdPy.arg_regex</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdPy.func"><code class="docutils literal notranslate"><span class="pre">CmdPy.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdPy.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdPy.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdPy.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdPy.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdService"><code class="docutils literal notranslate"><span class="pre">CmdService</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdService.key"><code class="docutils literal notranslate"><span class="pre">CmdService.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdService.aliases"><code class="docutils literal notranslate"><span class="pre">CmdService.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdService.switch_options"><code class="docutils literal notranslate"><span class="pre">CmdService.switch_options</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdService.locks"><code class="docutils literal notranslate"><span class="pre">CmdService.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdService.help_category"><code class="docutils literal notranslate"><span class="pre">CmdService.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdService.func"><code class="docutils literal notranslate"><span class="pre">CmdService.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdService.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdService.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdService.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdService.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAbout"><code class="docutils literal notranslate"><span class="pre">CmdAbout</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAbout.key"><code class="docutils literal notranslate"><span class="pre">CmdAbout.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAbout.aliases"><code class="docutils literal notranslate"><span class="pre">CmdAbout.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAbout.locks"><code class="docutils literal notranslate"><span class="pre">CmdAbout.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAbout.help_category"><code class="docutils literal notranslate"><span class="pre">CmdAbout.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAbout.func"><code class="docutils literal notranslate"><span class="pre">CmdAbout.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAbout.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdAbout.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdAbout.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdAbout.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTime"><code class="docutils literal notranslate"><span class="pre">CmdTime</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTime.key"><code class="docutils literal notranslate"><span class="pre">CmdTime.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTime.aliases"><code class="docutils literal notranslate"><span class="pre">CmdTime.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTime.locks"><code class="docutils literal notranslate"><span class="pre">CmdTime.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTime.help_category"><code class="docutils literal notranslate"><span class="pre">CmdTime.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTime.func"><code class="docutils literal notranslate"><span class="pre">CmdTime.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTime.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdTime.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTime.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdTime.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdServerLoad"><code class="docutils literal notranslate"><span class="pre">CmdServerLoad</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdServerLoad.key"><code class="docutils literal notranslate"><span class="pre">CmdServerLoad.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdServerLoad.aliases"><code class="docutils literal notranslate"><span class="pre">CmdServerLoad.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdServerLoad.switch_options"><code class="docutils literal notranslate"><span class="pre">CmdServerLoad.switch_options</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdServerLoad.locks"><code class="docutils literal notranslate"><span class="pre">CmdServerLoad.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdServerLoad.help_category"><code class="docutils literal notranslate"><span class="pre">CmdServerLoad.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdServerLoad.func"><code class="docutils literal notranslate"><span class="pre">CmdServerLoad.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdServerLoad.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdServerLoad.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdServerLoad.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdServerLoad.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks"><code class="docutils literal notranslate"><span class="pre">CmdTasks</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks.key"><code class="docutils literal notranslate"><span class="pre">CmdTasks.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks.aliases"><code class="docutils literal notranslate"><span class="pre">CmdTasks.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks.switch_options"><code class="docutils literal notranslate"><span class="pre">CmdTasks.switch_options</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks.locks"><code class="docutils literal notranslate"><span class="pre">CmdTasks.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks.help_category"><code class="docutils literal notranslate"><span class="pre">CmdTasks.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks.coll_date_func"><code class="docutils literal notranslate"><span class="pre">CmdTasks.coll_date_func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks.do_task_action"><code class="docutils literal notranslate"><span class="pre">CmdTasks.do_task_action()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks.func"><code class="docutils literal notranslate"><span class="pre">CmdTasks.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdTasks.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTasks.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdTasks.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTickers"><code class="docutils literal notranslate"><span class="pre">CmdTickers</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTickers.key"><code class="docutils literal notranslate"><span class="pre">CmdTickers.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTickers.help_category"><code class="docutils literal notranslate"><span class="pre">CmdTickers.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTickers.locks"><code class="docutils literal notranslate"><span class="pre">CmdTickers.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTickers.func"><code class="docutils literal notranslate"><span class="pre">CmdTickers.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTickers.aliases"><code class="docutils literal notranslate"><span class="pre">CmdTickers.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTickers.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdTickers.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.CmdTickers.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdTickers.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB"><code class="docutils literal notranslate"><span class="pre">AccountDB</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">AccountDB.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">AccountDB.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.account_subscription_set"><code class="docutils literal notranslate"><span class="pre">AccountDB.account_subscription_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.cmdset_storage"><code class="docutils literal notranslate"><span class="pre">AccountDB.cmdset_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.date_joined"><code class="docutils literal notranslate"><span class="pre">AccountDB.date_joined</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.db_attributes"><code class="docutils literal notranslate"><span class="pre">AccountDB.db_attributes</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.db_cmdset_storage"><code class="docutils literal notranslate"><span class="pre">AccountDB.db_cmdset_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.db_date_created"><code class="docutils literal notranslate"><span class="pre">AccountDB.db_date_created</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.db_is_bot"><code class="docutils literal notranslate"><span class="pre">AccountDB.db_is_bot</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.db_is_connected"><code class="docutils literal notranslate"><span class="pre">AccountDB.db_is_connected</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.db_key"><code class="docutils literal notranslate"><span class="pre">AccountDB.db_key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.db_lock_storage"><code class="docutils literal notranslate"><span class="pre">AccountDB.db_lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.db_tags"><code class="docutils literal notranslate"><span class="pre">AccountDB.db_tags</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.db_typeclass_path"><code class="docutils literal notranslate"><span class="pre">AccountDB.db_typeclass_path</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.email"><code class="docutils literal notranslate"><span class="pre">AccountDB.email</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.first_name"><code class="docutils literal notranslate"><span class="pre">AccountDB.first_name</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.get_next_by_date_joined"><code class="docutils literal notranslate"><span class="pre">AccountDB.get_next_by_date_joined()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.get_next_by_db_date_created"><code class="docutils literal notranslate"><span class="pre">AccountDB.get_next_by_db_date_created()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.get_previous_by_date_joined"><code class="docutils literal notranslate"><span class="pre">AccountDB.get_previous_by_date_joined()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.get_previous_by_db_date_created"><code class="docutils literal notranslate"><span class="pre">AccountDB.get_previous_by_db_date_created()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.groups"><code class="docutils literal notranslate"><span class="pre">AccountDB.groups</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.hide_from_accounts_set"><code class="docutils literal notranslate"><span class="pre">AccountDB.hide_from_accounts_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.id"><code class="docutils literal notranslate"><span class="pre">AccountDB.id</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.is_active"><code class="docutils literal notranslate"><span class="pre">AccountDB.is_active</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.is_bot"><code class="docutils literal notranslate"><span class="pre">AccountDB.is_bot</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.is_connected"><code class="docutils literal notranslate"><span class="pre">AccountDB.is_connected</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.is_staff"><code class="docutils literal notranslate"><span class="pre">AccountDB.is_staff</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.is_superuser"><code class="docutils literal notranslate"><span class="pre">AccountDB.is_superuser</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.key"><code class="docutils literal notranslate"><span class="pre">AccountDB.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.last_login"><code class="docutils literal notranslate"><span class="pre">AccountDB.last_login</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.last_name"><code class="docutils literal notranslate"><span class="pre">AccountDB.last_name</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.logentry_set"><code class="docutils literal notranslate"><span class="pre">AccountDB.logentry_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.name"><code class="docutils literal notranslate"><span class="pre">AccountDB.name</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.objectdb_set"><code class="docutils literal notranslate"><span class="pre">AccountDB.objectdb_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.objects"><code class="docutils literal notranslate"><span class="pre">AccountDB.objects</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.password"><code class="docutils literal notranslate"><span class="pre">AccountDB.password</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.path"><code class="docutils literal notranslate"><span class="pre">AccountDB.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.receiver_account_set"><code class="docutils literal notranslate"><span class="pre">AccountDB.receiver_account_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.scriptdb_set"><code class="docutils literal notranslate"><span class="pre">AccountDB.scriptdb_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.sender_account_set"><code class="docutils literal notranslate"><span class="pre">AccountDB.sender_account_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.typename"><code class="docutils literal notranslate"><span class="pre">AccountDB.typename</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.uid"><code class="docutils literal notranslate"><span class="pre">AccountDB.uid</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.user_permissions"><code class="docutils literal notranslate"><span class="pre">AccountDB.user_permissions</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.AccountDB.username"><code class="docutils literal notranslate"><span class="pre">AccountDB.username</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.COMMAND_DEFAULT_CLASS"><code class="docutils literal notranslate"><span class="pre">COMMAND_DEFAULT_CLASS</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor"><code class="docutils literal notranslate"><span class="pre">EvEditor</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.__init__"><code class="docutils literal notranslate"><span class="pre">EvEditor.__init__()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.decrease_indent"><code class="docutils literal notranslate"><span class="pre">EvEditor.decrease_indent()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.deduce_indent"><code class="docutils literal notranslate"><span class="pre">EvEditor.deduce_indent()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.display_buffer"><code class="docutils literal notranslate"><span class="pre">EvEditor.display_buffer()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.display_help"><code class="docutils literal notranslate"><span class="pre">EvEditor.display_help()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.get_buffer"><code class="docutils literal notranslate"><span class="pre">EvEditor.get_buffer()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.increase_indent"><code class="docutils literal notranslate"><span class="pre">EvEditor.increase_indent()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.load_buffer"><code class="docutils literal notranslate"><span class="pre">EvEditor.load_buffer()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.quit"><code class="docutils literal notranslate"><span class="pre">EvEditor.quit()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.save_buffer"><code class="docutils literal notranslate"><span class="pre">EvEditor.save_buffer()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.swap_autoindent"><code class="docutils literal notranslate"><span class="pre">EvEditor.swap_autoindent()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.update_buffer"><code class="docutils literal notranslate"><span class="pre">EvEditor.update_buffer()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvEditor.update_undo"><code class="docutils literal notranslate"><span class="pre">EvEditor.update_undo()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvTable"><code class="docutils literal notranslate"><span class="pre">EvTable</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.EvTable.__init__"><code class="docutils literal notranslate"><span class="pre">EvTable.__init__()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvTable.add_column"><code class="docutils literal notranslate"><span class="pre">EvTable.add_column()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvTable.add_header"><code class="docutils literal notranslate"><span class="pre">EvTable.add_header()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvTable.add_row"><code class="docutils literal notranslate"><span class="pre">EvTable.add_row()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvTable.get"><code class="docutils literal notranslate"><span class="pre">EvTable.get()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvTable.reformat"><code class="docutils literal notranslate"><span class="pre">EvTable.reformat()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvTable.reformat_column"><code class="docutils literal notranslate"><span class="pre">EvTable.reformat_column()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvenniaPythonConsole"><code class="docutils literal notranslate"><span class="pre">EvenniaPythonConsole</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.EvenniaPythonConsole.__init__"><code class="docutils literal notranslate"><span class="pre">EvenniaPythonConsole.__init__()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvenniaPythonConsole.write"><code class="docutils literal notranslate"><span class="pre">EvenniaPythonConsole.write()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.EvenniaPythonConsole.push"><code class="docutils literal notranslate"><span class="pre">EvenniaPythonConsole.push()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.PrintRecursionError"><code class="docutils literal notranslate"><span class="pre">PrintRecursionError</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.pause"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.pause()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.unpause"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.unpause()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.do_task"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.do_task()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.call"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.call()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.remove"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.remove()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.cancel"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.cancel()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.active"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.active()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.exists"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.exists()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.get_id"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.get_id()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.__init__"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.__init__()</span></code></a></li>
<li><a class="reference internal" href="#id0"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.active()</span></code></a></li>
<li><a class="reference internal" href="#id13"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.call()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.called"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.called</span></code></a></li>
<li><a class="reference internal" href="#id14"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.cancel()</span></code></a></li>
<li><a class="reference internal" href="#id15"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.do_task()</span></code></a></li>
<li><a class="reference internal" href="#id16"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.exists()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.get_deferred"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.get_deferred()</span></code></a></li>
<li><a class="reference internal" href="#id17"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.get_id()</span></code></a></li>
<li><a class="reference internal" href="#id18"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.pause()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.TaskHandlerTask.paused"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.paused</span></code></a></li>
<li><a class="reference internal" href="#id19"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.remove()</span></code></a></li>
<li><a class="reference internal" href="#id20"><code class="docutils literal notranslate"><span class="pre">TaskHandlerTask.unpause()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.system.ask_yes_no"><code class="docutils literal notranslate"><span class="pre">ask_yes_no()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.class_from_module"><code class="docutils literal notranslate"><span class="pre">class_from_module()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.evennia_local_vars"><code class="docutils literal notranslate"><span class="pre">evennia_local_vars()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.system.iter_to_str"><code class="docutils literal notranslate"><span class="pre">iter_to_str()</span></code></a></li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.commands.default.syscommands.html"
title="previous chapter">evennia.commands.default.syscommands</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.commands.default.tests.html"
title="next chapter">evennia.commands.default.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.commands.default.system.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/6.x/index.html">v6.0.0 branch (outdated)</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.commands.default.tests.html" title="evennia.commands.default.tests"
>next</a> |</li>
<li class="right" >
<a href="evennia.commands.default.syscommands.html" title="evennia.commands.default.syscommands"
>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.commands.html" >evennia.commands</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.commands.default.html" >evennia.commands.default</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.commands.default.system</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