Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-04 23:17:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.commands.default.admin.html

880 lines
98 KiB
HTML
Raw Normal View History

Updated HTML docs.
2025-08-15 18:14:21 +00:00
<!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.admin &#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.batchprocess" href="evennia.commands.default.batchprocess.html" />
<link rel="prev" title="evennia.commands.default.account" href="evennia.commands.default.account.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.batchprocess.html" title="evennia.commands.default.batchprocess"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.commands.default.account.html" title="evennia.commands.default.account"
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.admin</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.commands.default.admin">
<span id="evennia-commands-default-admin"></span><h1>evennia.commands.default.admin<a class="headerlink" href="#module-evennia.commands.default.admin" title="Link to this heading"></a></h1>
<p>Admin commands</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdBoot">
<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.admin.</span></span><span class="sig-name descname"><span class="pre">CmdBoot</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/admin.html#CmdBoot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot" 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>kick an account from the server.</p>
<dl class="simple">
<dt>Usage</dt><dd><p>boot[/switches] &lt;account obj&gt; [: reason]</p>
</dd>
<dt>Switches:</dt><dd><p>quiet - Silently boot without informing account
sid - boot by session id instead of name or dbref</p>
</dd>
</dl>
<p>Boot an account object from the server. If a reason is
supplied it will be echoed to the user unless /quiet is set.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdBoot.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">'boot'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.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.admin.CmdBoot.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">('quiet',</span> <span class="pre">'sid')</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.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.admin.CmdBoot.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(boot)</span> <span class="pre">or</span> <span class="pre">perm(Admin)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.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.admin.CmdBoot.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">'admin'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.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.admin.CmdBoot.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/admin.html#CmdBoot.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.func" title="Link to this definition"></a></dt>
<dd><p>Implementing the function</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdBoot.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.admin.CmdBoot.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.admin.CmdBoot.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(boot)</span> <span class="pre">or</span> <span class="pre">perm(Admin)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.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.admin.CmdBoot.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">'admin',</span> <span class="pre">'key':</span> <span class="pre">'boot',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nkick</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\nUsage\n</span>&#160; <span class="pre">boot[/switches]</span> <span class="pre">&lt;account</span> <span class="pre">obj&gt;</span> <span class="pre">[:</span> <span class="pre">reason]\n\nSwitches:\n</span>&#160; <span class="pre">quiet</span> <span class="pre">-</span> <span class="pre">Silently</span> <span class="pre">boot</span> <span class="pre">without</span> <span class="pre">informing</span> <span class="pre">account\n</span>&#160; <span class="pre">sid</span> <span class="pre">-</span> <span class="pre">boot</span> <span class="pre">by</span> <span class="pre">session</span> <span class="pre">id</span> <span class="pre">instead</span> <span class="pre">of</span> <span class="pre">name</span> <span class="pre">or</span> <span class="pre">dbref\n\nBoot</span> <span class="pre">an</span> <span class="pre">account</span> <span class="pre">object</span> <span class="pre">from</span> <span class="pre">the</span> <span class="pre">server.</span> <span class="pre">If</span> <span class="pre">a</span> <span class="pre">reason</span> <span class="pre">is\nsupplied</span> <span class="pre">it</span> <span class="pre">will</span> <span class="pre">be</span> <span class="pre">echoed</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">user</span> <span class="pre">unless</span> <span class="pre">/quiet</span> <span class="pre">is</span> <span class="pre">set.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.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.admin.CmdBan">
<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.admin.</span></span><span class="sig-name descname"><span class="pre">CmdBan</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/admin.html#CmdBan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdBan" 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>ban an account from the server</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>ban [&lt;name or ip&gt; [: reason]]</p>
</dd>
</dl>
<p>Without any arguments, shows numbered list of active bans.</p>
<p>This command bans a user from accessing the game. Supply an optional
reason to be able to later remember why the ban was put in place.</p>
<p>It is often preferable to ban an account from the server than to
delete an account with accounts/delete. If banned by name, that account
account can no longer be logged into.</p>
<p>IP (Internet Protocol) address banning allows blocking all access
from a specific address or subnet. Use an asterisk (*) as a
wildcard.</p>
<p class="rubric">Examples</p>
<p>ban thomas - ban account ‘thomas’
ban/ip 134.233.2.111 - ban specific ip address
ban/ip 134.233.2.* - ban all in a subnet
ban/ip 134.233.*.* - even wider ban</p>
<p>A single IP filter can be easy to circumvent by changing computers
or requesting a new IP address. Setting a wide IP block filter with
wildcards might be tempting, but remember that it may also
accidentally block innocent users connecting from the same country
or region.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdBan.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">'ban'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.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.admin.CmdBan.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">['bans']</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.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.admin.CmdBan.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(ban)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.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.admin.CmdBan.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">'admin'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.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.admin.CmdBan.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/admin.html#CmdBan.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.func" title="Link to this definition"></a></dt>
<dd><p>Bans are stored in a serverconf db object as a list of
dictionaries:</p>
<blockquote>
<div><dl class="simple">
<dt>[ (name, ip, ipregex, date, reason),</dt><dd><p>(name, ip, ipregex, date, reason),… ]</p>
</dd>
</dl>
</div></blockquote>
<p>where name and ip are set by the user and are shown in
lists. ipregex is a converted form of ip where the * is
replaced by an appropriate regex pattern for fast
matching. date is the time stamp the ban was instigated and
‘reason’ is any optional info given to the command. Unset
values in each tuple is set to the empty string.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdBan.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(ban)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.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.admin.CmdBan.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">'bans',</span> <span class="pre">'category':</span> <span class="pre">'admin',</span> <span class="pre">'key':</span> <span class="pre">'ban',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">bans',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nban</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\nUsage:\n</span>&#160; <span class="pre">ban</span> <span class="pre">[&lt;name</span> <span class="pre">or</span> <span class="pre">ip&gt;</span> <span class="pre">[:</span> <span class="pre">reason]]\n\nWithout</span> <span class="pre">any</span> <span class="pre">arguments,</span> <span class="pre">shows</span> <span class="pre">numbered</span> <span class="pre">list</span> <span class="pre">of</span> <span class="pre">active</span> <span class="pre">bans.\n\nThis</span> <span class="pre">command</span> <span class="pre">bans</span> <span class="pre">a</span> <span class="pre">user</span> <span class="pre">from</span> <span class="pre">accessing</span> <span class="pre">the</span> <span class="pre">game.</span> <span class="pre">Supply</span> <span class="pre">an</span> <span class="pre">optional\nreason</span> <span class="pre">to</span> <span class="pre">be</span> <span class="pre">able</span> <span class="pre">to</span> <span class="pre">later</span> <span class="pre">remember</span> <span class="pre">why</span> <span class="pre">the</span> <span class="pre">ban</span> <span class="pre">was</span> <span class="pre">put</span> <span class="pre">in</span> <span class="pre">place.\n\nIt</span> <span class="pre">is</span> <span class="pre">often</span> <span class="pre">preferable</span> <span class="pre">to</span> <span class="pre">ban</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</span> <span class="pre">than</span> <span class="pre">to\ndelete</span> <span class="pre">an</span> <span class="pre">account</span> <span class="pre">with</span> <span class="pre">accounts/delete.</span> <span class="pre">If</span> <span class="pre">banned</span> <span class="pre">by</span> <span class="pre">name,</span> <span class="pre">that</span> <span class="pre">account\naccount</span> <span class="pre">can</span> <span class="pre">no</span> <span class="pre">longer</span> <span class="pre">be</span> <span class="pre">logged</span> <span class="pre">into.\n\nIP</span> <span class="pre">(Internet</span> <span class="pre">Protocol)</span> <span class="pre">address</span> <span class="pre">banning</span> <span class="pre">allows</span> <span class="pre">blocking</span> <span class="pre">all</span> <span class="pre">access\nfrom</span> <span class="pre">a</span> <span class="pre">specific</span> <span class="pre">address</span> <span class="pre">or</span> <span class="pre">subnet.</span> <span class="pre">Use</span> <span class="pre">an</span> <span class="pre">asterisk</span> <span class="pre">(*)</span> <span class="pre">as</span> <span class="pre">a\nwildcard.\n\nExamples:\n</span>&#160; <span class="pre">ban</span> <span class="pre">thomas</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">ban</span> <span class="pre">account</span> <span class="pre">'thomas'\n</span>&#160; <span class="pre">ban/ip</span> <span class="pre">134.233.2.111</span>&#160;&#160; <span class="pre">-</span> <span class="pre">ban</span> <span class="pre">specific</span> <span class="pre">ip</span> <span class="pre">address\n</span>&#160; <span class="pre">ban/ip</span> <span class="pre">134.233.2.*</span>&#160;&#160;&
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdUnban">
<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.admin.</span></span><span class="sig-name descname"><span class="pre">CmdUnban</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/admin.html#CmdUnban"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban" 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>remove a ban from an account</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>unban &lt;banid&gt;</p>
</dd>
</dl>
<p>This will clear an account name/ip ban previously set with the ban
command. Use this command without an argument to view a numbered
list of bans. Use the numbers in this list to select which one to
unban.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdUnban.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">'unban'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.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.admin.CmdUnban.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(unban)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.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.admin.CmdUnban.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">'admin'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.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.admin.CmdUnban.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/admin.html#CmdUnban.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.func" title="Link to this definition"></a></dt>
<dd><p>Implement unbanning</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdUnban.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.admin.CmdUnban.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.admin.CmdUnban.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(unban)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.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.admin.CmdUnban.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">'admin',</span> <span class="pre">'key':</span> <span class="pre">'unban',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nremove</span> <span class="pre">a</span> <span class="pre">ban</span> <span class="pre">from</span> <span class="pre">an</span> <span class="pre">account\n\nUsage:\n</span>&#160; <span class="pre">unban</span> <span class="pre">&lt;banid&gt;\n\nThis</span> <span class="pre">will</span> <span class="pre">clear</span> <span class="pre">an</span> <span class="pre">account</span> <span class="pre">name/ip</span> <span class="pre">ban</span> <span class="pre">previously</span> <span class="pre">set</span> <span class="pre">with</span> <span class="pre">the</span> <span class="pre">ban\ncommand.</span>&#160; <span class="pre">Use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">without</span> <span class="pre">an</span> <span class="pre">argument</span> <span class="pre">to</span> <span class="pre">view</span> <span class="pre">a</span> <span class="pre">numbered\nlist</span> <span class="pre">of</span> <span class="pre">bans.</span> <span class="pre">Use</span> <span class="pre">the</span> <span class="pre">numbers</span> <span class="pre">in</span> <span class="pre">this</span> <span class="pre">list</span> <span class="pre">to</span> <span class="pre">select</span> <span class="pre">which</span> <span class="pre">one</span> <span class="pre">to\nunban.\n\n'}</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.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.admin.CmdEmit">
<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.admin.</span></span><span class="sig-name descname"><span class="pre">CmdEmit</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/admin.html#CmdEmit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit" 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>admin command for emitting message to multiple objects</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>emit[/switches] [&lt;obj&gt;, &lt;obj&gt;, … =] &lt;message&gt;
remit [&lt;obj&gt;, &lt;obj&gt;, … =] &lt;message&gt;
pemit [&lt;obj&gt;, &lt;obj&gt;, … =] &lt;message&gt;</p>
</dd>
<dt>Switches:</dt><dd><p>room - limit emits to rooms only (default)
accounts - limit emits to accounts only
contents - send to the contents of matched objects too</p>
</dd>
</dl>
<p>Emits a message to the selected objects or to
your immediate surroundings. If the object is a room,
send to its contents. remit and pemit are just
limited forms of emit, for sending to rooms and
to accounts respectively.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdEmit.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">'emit'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.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.admin.CmdEmit.aliases">
Updated HTML docs.
2026-02-15 17:42:43 +00:00
<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">['remit',</span> <span class="pre">'pemit']</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Link to this definition"></a></dt>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdEmit.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">('room',</span> <span class="pre">'accounts',</span> <span class="pre">'contents')</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.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.admin.CmdEmit.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(emit)</span> <span class="pre">or</span> <span class="pre">perm(Builder)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.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.admin.CmdEmit.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">'admin'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.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.admin.CmdEmit.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/admin.html#CmdEmit.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.func" title="Link to this definition"></a></dt>
<dd><p>Implement the command</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdEmit.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(emit)</span> <span class="pre">or</span> <span class="pre">perm(Builder)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.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.admin.CmdEmit.search_index_entry">
Updated HTML docs.
2026-02-15 17:42:43 +00:00
<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">'remit</span> <span class="pre">pemit',</span> <span class="pre">'category':</span> <span class="pre">'admin',</span> <span class="pre">'key':</span> <span class="pre">'emit',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">remit</span> <span class="pre">pemit',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nadmin</span> <span class="pre">command</span> <span class="pre">for</span> <span class="pre">emitting</span> <span class="pre">message</span> <span class="pre">to</span> <span class="pre">multiple</span> <span class="pre">objects\n\nUsage:\n</span>&#160; <span class="pre">emit[/switches]</span> <span class="pre">[&lt;obj&gt;,</span> <span class="pre">&lt;obj&gt;,</span> <span class="pre">...</span> <span class="pre">=]</span> <span class="pre">&lt;message&gt;\n</span>&#160; <span class="pre">remit</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[&lt;obj&gt;,</span> <span class="pre">&lt;obj&gt;,</span> <span class="pre">...</span> <span class="pre">=]</span> <span class="pre">&lt;message&gt;\n</span>&#160; <span class="pre">pemit</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[&lt;obj&gt;,</span> <span class="pre">&lt;obj&gt;,</span> <span class="pre">...</span> <span class="pre">=]</span> <span class="pre">&lt;message&gt;\n\nSwitches:\n</span>&#160; <span class="pre">room</span>&#160;&#160;&#160;&#160; <span class="pre">-</span>&#160; <span class="pre">limit</span> <span class="pre">emits</span> <span class="pre">to</span> <span class="pre">rooms</span> <span class="pre">only</span> <span class="pre">(default)\n</span>&#160; <span class="pre">accounts</span> <span class="pre">-</span>&#160; <span class="pre">limit</span> <span class="pre">emits</span> <span class="pre">to</span> <span class="pre">accounts</span> <span class="pre">only\n</span>&#160; <span class="pre">contents</span> <span class="pre">-</span>&#160; <span class="pre">send</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">contents</span> <span class="pre">of</span> <span class="pre">matched</span> <span class="pre">objects</span> <span class="pre">too\n\nEmits</span> <span class="pre">a</span> <span class="pre">message</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">selected</span> <span class="pre">objects</span> <span class="pre">or</span> <span class="pre">to\nyour</span> <span class="pre">immediate</span> <span class="pre">surroundings.</span> <span class="pre">If</span> <span class="pre">the</span> <span class="pre">object</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">room,\nsend</span> <span class="pre">to</span> <span class="pre">its</span> <span class="pre">contents.</span> <span class="pre">remit</span> <span class="pre">and</span> <span class="pre">pemit</span> <span class="pre">are</span> <span class="pre">just\nlimited</span> <span class="pre">forms</span> <span class="pre">of</span> <span class="pre">emit,</span> <span class="pre">for</span> <span class="pre">sending</span> <span class="pre">to</span> <span class="pre">rooms</span> <span class="pre">and\nto</span> <span class="pre">accounts</span> <span class="pre">respectively.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Link to this definition"></a></dt>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdNewPassword">
<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.admin.</span></span><span class="sig-name descname"><span class="pre">CmdNewPassword</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/admin.html#CmdNewPassword"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword" 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>change the password of an account</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>userpassword &lt;user obj&gt; = &lt;new password&gt;</p>
</dd>
</dl>
<p>Set an account’s password.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdNewPassword.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">'userpassword'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.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.admin.CmdNewPassword.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(newpassword)</span> <span class="pre">or</span> <span class="pre">perm(Admin)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.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.admin.CmdNewPassword.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">'admin'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.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.admin.CmdNewPassword.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/admin.html#CmdNewPassword.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.func" title="Link to this definition"></a></dt>
<dd><p>Implement the function.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdNewPassword.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.admin.CmdNewPassword.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.admin.CmdNewPassword.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(newpassword)</span> <span class="pre">or</span> <span class="pre">perm(Admin)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.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.admin.CmdNewPassword.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">'admin',</span> <span class="pre">'key':</span> <span class="pre">'userpassword',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nchange</span> <span class="pre">the</span> <span class="pre">password</span> <span class="pre">of</span> <span class="pre">an</span> <span class="pre">account\n\nUsage:\n</span>&#160; <span class="pre">userpassword</span> <span class="pre">&lt;user</span> <span class="pre">obj&gt;</span> <span class="pre">=</span> <span class="pre">&lt;new</span> <span class="pre">password&gt;\n\nSet</span> <span class="pre">an</span> <span class="pre">account's</span> <span class="pre">password.\n&quot;}</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.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.admin.CmdPerm">
<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.admin.</span></span><span class="sig-name descname"><span class="pre">CmdPerm</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/admin.html#CmdPerm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm" 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>set the permissions of an account/object</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>perm[/switch] &lt;object&gt; [= &lt;permission&gt;[,&lt;permission&gt;,…]]
perm[/switch] <a href="#id1"><span class="problematic" id="id2">*</span></a>&lt;account&gt; [= &lt;permission&gt;[,&lt;permission&gt;,…]]</p>
</dd>
<dt>Switches:</dt><dd><p>del - delete the given permission from &lt;object&gt; or &lt;account&gt;.
account - set permission on an account (same as adding * to name)</p>
</dd>
</dl>
<p>This command sets/clears individual permission strings on an object
or account. If no permission is given, list all permissions on &lt;object&gt;.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdPerm.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">'perm'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.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.admin.CmdPerm.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">['setperm']</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.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.admin.CmdPerm.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">('del',</span> <span class="pre">'account')</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.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.admin.CmdPerm.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(perm)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.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.admin.CmdPerm.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">'admin'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.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.admin.CmdPerm.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/admin.html#CmdPerm.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.func" title="Link to this definition"></a></dt>
<dd><p>Implement function</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdPerm.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(perm)</span> <span class="pre">or</span> <span class="pre">perm(Developer)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.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.admin.CmdPerm.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">'setperm',</span> <span class="pre">'category':</span> <span class="pre">'admin',</span> <span class="pre">'key':</span> <span class="pre">'perm',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">setperm',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nset</span> <span class="pre">the</span> <span class="pre">permissions</span> <span class="pre">of</span> <span class="pre">an</span> <span class="pre">account/object\n\nUsage:\n</span>&#160; <span class="pre">perm[/switch]</span> <span class="pre">&lt;object&gt;</span> <span class="pre">[=</span> <span class="pre">&lt;permission&gt;[,&lt;permission&gt;,...]]\n</span>&#160; <span class="pre">perm[/switch]</span> <span class="pre">*&lt;account&gt;</span> <span class="pre">[=</span> <span class="pre">&lt;permission&gt;[,&lt;permission&gt;,...]]\n\nSwitches:\n</span>&#160; <span class="pre">del</span>&#160;&#160;&#160;&#160; <span class="pre">-</span>&#160; <span class="pre">delete</span> <span class="pre">the</span> <span class="pre">given</span> <span class="pre">permission</span> <span class="pre">from</span> <span class="pre">&lt;object&gt;</span> <span class="pre">or</span> <span class="pre">&lt;account&gt;.\n</span>&#160; <span class="pre">account</span> <span class="pre">-</span>&#160; <span class="pre">set</span> <span class="pre">permission</span> <span class="pre">on</span> <span class="pre">an</span> <span class="pre">account</span> <span class="pre">(same</span> <span class="pre">as</span> <span class="pre">adding</span> <span class="pre">*</span> <span class="pre">to</span> <span class="pre">name)\n\nThis</span> <span class="pre">command</span> <span class="pre">sets/clears</span> <span class="pre">individual</span> <span class="pre">permission</span> <span class="pre">strings</span> <span class="pre">on</span> <span class="pre">an</span> <span class="pre">object\nor</span> <span class="pre">account.</span> <span class="pre">If</span> <span class="pre">no</span> <span class="pre">permission</span> <span class="pre">is</span> <span class="pre">given,</span> <span class="pre">list</span> <span class="pre">all</span> <span class="pre">permissions</span> <span class="pre">on</span> <span class="pre">&lt;object&gt;.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.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.admin.CmdWall">
<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.admin.</span></span><span class="sig-name descname"><span class="pre">CmdWall</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/admin.html#CmdWall"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdWall" 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>make an announcement to all</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>wall &lt;message&gt;</p>
</dd>
</dl>
<p>Announces a message to all connected sessions
including all currently unlogged in.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdWall.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">'wall'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.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.admin.CmdWall.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(wall)</span> <span class="pre">or</span> <span class="pre">perm(Admin)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.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.admin.CmdWall.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">'admin'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.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.admin.CmdWall.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/admin.html#CmdWall.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.func" title="Link to this definition"></a></dt>
<dd><p>Implements command</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdWall.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.admin.CmdWall.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.admin.CmdWall.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(wall)</span> <span class="pre">or</span> <span class="pre">perm(Admin)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.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.admin.CmdWall.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">'admin',</span> <span class="pre">'key':</span> <span class="pre">'wall',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nmake</span> <span class="pre">an</span> <span class="pre">announcement</span> <span class="pre">to</span> <span class="pre">all\n\nUsage:\n</span>&#160; <span class="pre">wall</span> <span class="pre">&lt;message&gt;\n\nAnnounces</span> <span class="pre">a</span> <span class="pre">message</span> <span class="pre">to</span> <span class="pre">all</span> <span class="pre">connected</span> <span class="pre">sessions\nincluding</span> <span class="pre">all</span> <span class="pre">currently</span> <span class="pre">unlogged</span> <span class="pre">in.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.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.admin.CmdForce">
<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.admin.</span></span><span class="sig-name descname"><span class="pre">CmdForce</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/admin.html#CmdForce"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdForce" 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>forces an object to execute a command</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>force &lt;object&gt;=&lt;command string&gt;</p>
</dd>
</dl>
<p class="rubric">Example</p>
<p>force bob=get stick</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdForce.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">'force'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.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.admin.CmdForce.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(spawn)</span> <span class="pre">or</span> <span class="pre">perm(Builder)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.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.admin.CmdForce.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">'building'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.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.admin.CmdForce.perm_used">
<span class="sig-name descname"><span class="pre">perm_used</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'edit'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.perm_used" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdForce.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/admin.html#CmdForce.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.func" title="Link to this definition"></a></dt>
<dd><p>Implements the force command</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdForce.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.admin.CmdForce.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.admin.CmdForce.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(spawn)</span> <span class="pre">or</span> <span class="pre">perm(Builder)'</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.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.admin.CmdForce.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">'building',</span> <span class="pre">'key':</span> <span class="pre">'force',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nforces</span> <span class="pre">an</span> <span class="pre">object</span> <span class="pre">to</span> <span class="pre">execute</span> <span class="pre">a</span> <span class="pre">command\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">force</span> <span class="pre">&lt;object&gt;=&lt;command</span> <span class="pre">string&gt;\n\nExample:\n</span>&#160;&#160;&#160; <span class="pre">force</span> <span class="pre">bob=get</span> <span class="pre">stick\n'}</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.COMMAND_DEFAULT_CLASS">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.default.admin.</span></span><span class="sig-name descname"><span class="pre">COMMAND_DEFAULT_CLASS</span></span><a class="headerlink" href="#evennia.commands.default.admin.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.admin.ServerConfig">
<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.admin.</span></span><span class="sig-name descname"><span class="pre">ServerConfig</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/server/models.html#ServerConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.ServerConfig" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.idmapper.models.html#evennia.utils.idmapper.models.WeakSharedMemoryModel" title="evennia.utils.idmapper.models.WeakSharedMemoryModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">WeakSharedMemoryModel</span></code></a></p>
<p>On-the fly storage of global settings.</p>
<p>Properties defined on ServerConfig:</p>
<blockquote>
<div><ul class="simple">
<li><p>key: Main identifier</p></li>
<li><p>value: Value stored in key. This is a pickled storage.</p></li>
</ul>
</div></blockquote>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.commands.default.admin.ServerConfig.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.admin.ServerConfig.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.admin.ServerConfig.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.admin.ServerConfig.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>
Updated HTML docs.
2026-02-15 17:42:43 +00:00
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.commands.default.admin.ServerConfig.NotUpdated">
<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">NotUpdated</span></span><a class="headerlink" href="#evennia.commands.default.admin.ServerConfig.NotUpdated" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectNotUpdated</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DatabaseError</span></code></p>
</dd></dl>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.ServerConfig.db_key">
<span class="sig-name descname"><span class="pre">db_key</span></span><a class="headerlink" href="#evennia.commands.default.admin.ServerConfig.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.admin.ServerConfig.db_value">
<span class="sig-name descname"><span class="pre">db_value</span></span><a class="headerlink" href="#evennia.commands.default.admin.ServerConfig.db_value" 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.admin.ServerConfig.id">
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#evennia.commands.default.admin.ServerConfig.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 property">
<dt class="sig sig-object py" id="evennia.commands.default.admin.ServerConfig.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.admin.ServerConfig.key" title="Link to this definition"></a></dt>
<dd><p>Getter. Allows for value = self.key</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.ServerConfig.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.server.manager.ServerConfigManager</span> <span class="pre">object&gt;</span></em><a class="headerlink" href="#evennia.commands.default.admin.ServerConfig.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.admin.ServerConfig.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.server.models.ServerConfig'</span></em><a class="headerlink" href="#evennia.commands.default.admin.ServerConfig.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.commands.default.admin.ServerConfig.store">
<span class="sig-name descname"><span class="pre">store</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/models.html#ServerConfig.store"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.ServerConfig.store" title="Link to this definition"></a></dt>
<dd><p>Wrap the storage.</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>key</strong> (<em>str</em>) – The name of this store.</p></li>
<li><p><strong>value</strong> (<em>str</em>) – The data to store with this <strong>key</strong>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.ServerConfig.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">'WeakSharedMemoryModelBase'</span></em><a class="headerlink" href="#evennia.commands.default.admin.ServerConfig.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.admin.ServerConfig.value">
<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">value</span></span><a class="headerlink" href="#evennia.commands.default.admin.ServerConfig.value" title="Link to this definition"></a></dt>
<dd><p>Getter. Allows for value = self.value</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.commands.default.admin.class_from_module">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.default.admin.</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.admin.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.admin.list_bans">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.default.admin.</span></span><span class="sig-name descname"><span class="pre">list_bans</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">banlist</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/admin.html#list_bans"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.default.admin.list_bans" title="Link to this definition"></a></dt>
<dd><p>Helper function to display a list of active bans. Input argument
is the banlist read into the two commands ban and unban below.</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>cmd</strong> (<a class="reference internal" href="evennia.commands.command.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><em>Command</em></a>) – Instance of the Ban command.</p></li>
<li><p><strong>banlist</strong> (<em>list</em>) – List of bans to list.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.commands.default.admin</a><ul>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBoot"><code class="docutils literal notranslate"><span class="pre">CmdBoot</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBoot.key"><code class="docutils literal notranslate"><span class="pre">CmdBoot.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBoot.switch_options"><code class="docutils literal notranslate"><span class="pre">CmdBoot.switch_options</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBoot.locks"><code class="docutils literal notranslate"><span class="pre">CmdBoot.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBoot.help_category"><code class="docutils literal notranslate"><span class="pre">CmdBoot.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBoot.func"><code class="docutils literal notranslate"><span class="pre">CmdBoot.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBoot.aliases"><code class="docutils literal notranslate"><span class="pre">CmdBoot.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBoot.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdBoot.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBoot.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdBoot.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBan"><code class="docutils literal notranslate"><span class="pre">CmdBan</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBan.key"><code class="docutils literal notranslate"><span class="pre">CmdBan.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBan.aliases"><code class="docutils literal notranslate"><span class="pre">CmdBan.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBan.locks"><code class="docutils literal notranslate"><span class="pre">CmdBan.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBan.help_category"><code class="docutils literal notranslate"><span class="pre">CmdBan.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBan.func"><code class="docutils literal notranslate"><span class="pre">CmdBan.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBan.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdBan.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdBan.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdBan.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdUnban"><code class="docutils literal notranslate"><span class="pre">CmdUnban</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdUnban.key"><code class="docutils literal notranslate"><span class="pre">CmdUnban.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdUnban.locks"><code class="docutils literal notranslate"><span class="pre">CmdUnban.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdUnban.help_category"><code class="docutils literal notranslate"><span class="pre">CmdUnban.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdUnban.func"><code class="docutils literal notranslate"><span class="pre">CmdUnban.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdUnban.aliases"><code class="docutils literal notranslate"><span class="pre">CmdUnban.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdUnban.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdUnban.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdUnban.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdUnban.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdEmit"><code class="docutils literal notranslate"><span class="pre">CmdEmit</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdEmit.key"><code class="docutils literal notranslate"><span class="pre">CmdEmit.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdEmit.aliases"><code class="docutils literal notranslate"><span class="pre">CmdEmit.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdEmit.switch_options"><code class="docutils literal notranslate"><span class="pre">CmdEmit.switch_options</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdEmit.locks"><code class="docutils literal notranslate"><span class="pre">CmdEmit.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdEmit.help_category"><code class="docutils literal notranslate"><span class="pre">CmdEmit.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdEmit.func"><code class="docutils literal notranslate"><span class="pre">CmdEmit.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdEmit.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdEmit.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdEmit.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdEmit.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdNewPassword"><code class="docutils literal notranslate"><span class="pre">CmdNewPassword</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdNewPassword.key"><code class="docutils literal notranslate"><span class="pre">CmdNewPassword.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdNewPassword.locks"><code class="docutils literal notranslate"><span class="pre">CmdNewPassword.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdNewPassword.help_category"><code class="docutils literal notranslate"><span class="pre">CmdNewPassword.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdNewPassword.func"><code class="docutils literal notranslate"><span class="pre">CmdNewPassword.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdNewPassword.aliases"><code class="docutils literal notranslate"><span class="pre">CmdNewPassword.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdNewPassword.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdNewPassword.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdNewPassword.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdNewPassword.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdPerm"><code class="docutils literal notranslate"><span class="pre">CmdPerm</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdPerm.key"><code class="docutils literal notranslate"><span class="pre">CmdPerm.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdPerm.aliases"><code class="docutils literal notranslate"><span class="pre">CmdPerm.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdPerm.switch_options"><code class="docutils literal notranslate"><span class="pre">CmdPerm.switch_options</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdPerm.locks"><code class="docutils literal notranslate"><span class="pre">CmdPerm.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdPerm.help_category"><code class="docutils literal notranslate"><span class="pre">CmdPerm.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdPerm.func"><code class="docutils literal notranslate"><span class="pre">CmdPerm.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdPerm.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdPerm.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdPerm.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdPerm.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdWall"><code class="docutils literal notranslate"><span class="pre">CmdWall</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdWall.key"><code class="docutils literal notranslate"><span class="pre">CmdWall.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdWall.locks"><code class="docutils literal notranslate"><span class="pre">CmdWall.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdWall.help_category"><code class="docutils literal notranslate"><span class="pre">CmdWall.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdWall.func"><code class="docutils literal notranslate"><span class="pre">CmdWall.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdWall.aliases"><code class="docutils literal notranslate"><span class="pre">CmdWall.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdWall.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdWall.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdWall.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdWall.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdForce"><code class="docutils literal notranslate"><span class="pre">CmdForce</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdForce.key"><code class="docutils literal notranslate"><span class="pre">CmdForce.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdForce.locks"><code class="docutils literal notranslate"><span class="pre">CmdForce.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdForce.help_category"><code class="docutils literal notranslate"><span class="pre">CmdForce.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdForce.perm_used"><code class="docutils literal notranslate"><span class="pre">CmdForce.perm_used</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdForce.func"><code class="docutils literal notranslate"><span class="pre">CmdForce.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdForce.aliases"><code class="docutils literal notranslate"><span class="pre">CmdForce.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdForce.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdForce.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.CmdForce.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdForce.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.admin.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.admin.ServerConfig"><code class="docutils literal notranslate"><span class="pre">ServerConfig</span></code></a><ul>
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">ServerConfig.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">ServerConfig.MultipleObjectsReturned</span></code></a></li>
Updated HTML docs.
2026-02-15 17:42:43 +00:00
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.NotUpdated"><code class="docutils literal notranslate"><span class="pre">ServerConfig.NotUpdated</span></code></a></li>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.db_key"><code class="docutils literal notranslate"><span class="pre">ServerConfig.db_key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.db_value"><code class="docutils literal notranslate"><span class="pre">ServerConfig.db_value</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.id"><code class="docutils literal notranslate"><span class="pre">ServerConfig.id</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.key"><code class="docutils literal notranslate"><span class="pre">ServerConfig.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.objects"><code class="docutils literal notranslate"><span class="pre">ServerConfig.objects</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.path"><code class="docutils literal notranslate"><span class="pre">ServerConfig.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.store"><code class="docutils literal notranslate"><span class="pre">ServerConfig.store()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.typename"><code class="docutils literal notranslate"><span class="pre">ServerConfig.typename</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.default.admin.ServerConfig.value"><code class="docutils literal notranslate"><span class="pre">ServerConfig.value</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.commands.default.admin.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.admin.list_bans"><code class="docutils literal notranslate"><span class="pre">list_bans()</span></code></a></li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.commands.default.account.html"
title="previous chapter">evennia.commands.default.account</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.commands.default.batchprocess.html"
title="next chapter">evennia.commands.default.batchprocess</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.admin.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Doc Versions</h3>
<ul>
<li>
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.commands.default.batchprocess.html" title="evennia.commands.default.batchprocess"
>next</a> |</li>
<li class="right" >
<a href="evennia.commands.default.account.html" title="evennia.commands.default.account"
>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.admin</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 Copy permalink