evennia/docs/2.x/api/evennia.commands.default.account.html
Evennia docbuilder action f8bbd74eb2 Updated HTML docs.
2023-12-07 08:58:47 +00:00

928 lines
No EOL
68 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>evennia.commands.default.account &#8212; Evennia 2.x documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.commands.default.admin" href="evennia.commands.default.admin.html" />
<link rel="prev" title="evennia.commands.default" href="evennia.commands.default.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.commands.default.admin.html" title="evennia.commands.default.admin"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.commands.default.html" title="evennia.commands.default"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</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.account</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.commands.default.html"
title="previous chapter">evennia.commands.default</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.commands.default.admin.html"
title="next chapter">evennia.commands.default.admin</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.commands.default.account.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Doc Versions</h3>
<ul>
<li><a href="evennia.commands.default.account.html">2.x (main branch)</a></li>
<ul>
<li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.commands.default.account">
<span id="evennia-commands-default-account"></span><h1>evennia.commands.default.account<a class="headerlink" href="#module-evennia.commands.default.account" title="Permalink to this headline"></a></h1>
<p>Account (OOC) commands. These are stored on the Account object
and self.caller is thus always an Account, not an Object/Character.</p>
<p>These commands go in the AccountCmdset and are accessible also
when puppeting a Character (although with lower priority)</p>
<p>These commands use the account_caller property which tells the command
parent (MuxCommand, usually) to setup caller correctly. They use
self.account to make sure to always use the account object rather than
self.caller (which change depending on the level you are calling from)
The property self.character can be used to access the character when
these commands are triggered with a connected character (such as the
case of the <strong>ooc</strong> command), it is None if we are OOC.</p>
<p>Note that under MULTISESSION_MODE &gt; 2, Account commands should use
self.msg() and similar methods to reroute returns to the correct
method. Otherwise all text will be returned to all connected sessions.</p>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdOOCLook">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdOOCLook</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdOOCLook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.account.MuxAccountLookCommand</span></code></p>
<p>look while out-of-character</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>look</p>
</dd>
</dl>
<p>Look in the ooc state.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.key">
<code class="sig-name descname">key</code><em class="property"> = 'look'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdOOCLook.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdOOCLook.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.func" title="Permalink to this definition"></a></dt>
<dd><p>implement the ooc look command</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdIC">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdIC</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdIC"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdIC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>control an object you have permission to puppet</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>ic &lt;character&gt;</p>
</dd>
</dl>
<p>Go in-character (IC) as a given Character.</p>
<p>This will attempt to “become” a different object assuming you have
the right to do so. Note that its the ACCOUNT character that puppets
characters/objects and which needs to have the correct permission!</p>
<p>You cannot become an object that is already controlled by another
account. In principle &lt;character&gt; can be any in-game object as long
as you the account have access right to puppet it.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdIC.key">
<code class="sig-name descname">key</code><em class="property"> = 'ic'</em><a class="headerlink" href="#evennia.commands.default.account.CmdIC.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdIC.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdIC.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdIC.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['puppet']</em><a class="headerlink" href="#evennia.commands.default.account.CmdIC.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdIC.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdIC.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdIC.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdIC.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdIC.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdIC.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdIC.func" title="Permalink to this definition"></a></dt>
<dd><p>Main puppet method</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdIC.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdIC.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdIC.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'puppet', 'category': 'general', 'key': 'ic', 'no_prefix': ' puppet', 'tags': '', 'text': '\n control an object you have permission to puppet\n\n Usage:\n ic &lt;character&gt;\n\n Go in-character (IC) as a given Character.\n\n This will attempt to &quot;become&quot; a different object assuming you have\n the right to do so. Note that it\'s the ACCOUNT character that puppets\n characters/objects and which needs to have the correct permission!\n\n You cannot become an object that is already controlled by another\n account. In principle &lt;character&gt; can be any in-game object as long\n as you the account have access right to puppet it.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdIC.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdOOC">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdOOC</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdOOC"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdOOC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.account.MuxAccountLookCommand</span></code></p>
<p>stop puppeting and go ooc</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>ooc</p>
</dd>
</dl>
<p>Go out-of-character (OOC).</p>
<p>This will leave your current character and put you in a incorporeal OOC state.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOC.key">
<code class="sig-name descname">key</code><em class="property"> = 'ooc'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOC.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOC.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOC.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOC.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['unpuppet']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOC.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOC.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOC.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOC.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOC.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdOOC.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdOOC.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdOOC.func" title="Permalink to this definition"></a></dt>
<dd><p>Implement function</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOC.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOC.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOOC.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'unpuppet', 'category': 'general', 'key': 'ooc', 'no_prefix': ' unpuppet', 'tags': '', 'text': '\n stop puppeting and go ooc\n\n Usage:\n ooc\n\n Go out-of-character (OOC).\n\n This will leave your current character and put you in a incorporeal OOC state.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOC.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdPassword">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdPassword</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdPassword"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdPassword" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>change your password</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>password &lt;old password&gt; = &lt;new password&gt;</p>
</dd>
</dl>
<p>Changes your password. Make sure to pick a safe one.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdPassword.key">
<code class="sig-name descname">key</code><em class="property"> = 'password'</em><a class="headerlink" href="#evennia.commands.default.account.CmdPassword.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdPassword.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.account.CmdPassword.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdPassword.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdPassword.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdPassword.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdPassword.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdPassword.func" title="Permalink to this definition"></a></dt>
<dd><p>hook function.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdPassword.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.account.CmdPassword.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdPassword.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdPassword.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdPassword.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.account.CmdPassword.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdPassword.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'password', 'no_prefix': ' ', 'tags': '', 'text': '\n change your password\n\n Usage:\n password &lt;old password&gt; = &lt;new password&gt;\n\n Changes your password. Make sure to pick a safe one.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdPassword.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdQuit">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdQuit</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdQuit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdQuit" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>quit the game</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>quit</p>
</dd>
<dt>Switch:</dt><dd><p>all - disconnect all connected sessions</p>
</dd>
</dl>
<p>Gracefully disconnect your current session from the
game. Use the /all switch to disconnect from all sessions.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuit.key">
<code class="sig-name descname">key</code><em class="property"> = 'quit'</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuit.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuit.switch_options">
<code class="sig-name descname">switch_options</code><em class="property"> = ('all',)</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuit.switch_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuit.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuit.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuit.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuit.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdQuit.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdQuit.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdQuit.func" title="Permalink to this definition"></a></dt>
<dd><p>hook function</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuit.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuit.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuit.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuit.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuit.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuit.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuit.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'quit', 'no_prefix': ' ', 'tags': '', 'text': '\n quit the game\n\n Usage:\n quit\n\n Switch:\n all - disconnect all connected sessions\n\n Gracefully disconnect your current session from the\n game. Use the /all switch to disconnect from all sessions.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdCharCreate">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdCharCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdCharCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdCharCreate" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>create a new character</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>charcreate &lt;charname&gt; [= desc]</p>
</dd>
</dl>
<p>Create a new character, optionally giving it a description. You
may use upper-case letters in the name - you will nevertheless
always be able to access your character using lower-case letters
if you want.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharCreate.key">
<code class="sig-name descname">key</code><em class="property"> = 'charcreate'</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharCreate.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharCreate.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharCreate.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharCreate.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharCreate.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharCreate.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharCreate.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdCharCreate.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdCharCreate.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdCharCreate.func" title="Permalink to this definition"></a></dt>
<dd><p>create the new character</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharCreate.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharCreate.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharCreate.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharCreate.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharCreate.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'charcreate', 'no_prefix': ' ', 'tags': '', 'text': '\n create a new character\n\n Usage:\n charcreate &lt;charname&gt; [= desc]\n\n Create a new character, optionally giving it a description. You\n may use upper-case letters in the name - you will nevertheless\n always be able to access your character using lower-case letters\n if you want.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharCreate.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdOption">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdOption</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdOption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdOption" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>Set an account option</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>option[/save] [name = value]</p>
</dd>
<dt>Switches:</dt><dd><p>save - Save the current option settings for future logins.
clear - Clear the saved options.</p>
</dd>
</dl>
<p>This command allows for viewing and setting client interface
settings. Note that saved options may not be able to be used if
later connecting with a client with different capabilities.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOption.key">
<code class="sig-name descname">key</code><em class="property"> = 'option'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOption.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['options']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOption.switch_options">
<code class="sig-name descname">switch_options</code><em class="property"> = ('save', 'clear')</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption.switch_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOption.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOption.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdOption.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdOption.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdOption.func" title="Permalink to this definition"></a></dt>
<dd><p>Implements the command</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOption.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOption.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdOption.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'options', 'category': 'general', 'key': 'option', 'no_prefix': ' options', 'tags': '', 'text': '\n Set an account option\n\n Usage:\n option[/save] [name = value]\n\n Switches:\n save - Save the current option settings for future logins.\n clear - Clear the saved options.\n\n This command allows for viewing and setting client interface\n settings. Note that saved options may not be able to be used if\n later connecting with a client with different capabilities.\n\n\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdSessions">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdSessions</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdSessions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdSessions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>check your connected session(s)</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>sessions</p>
</dd>
</dl>
<p>Lists the sessions currently connected to your account.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdSessions.key">
<code class="sig-name descname">key</code><em class="property"> = 'sessions'</em><a class="headerlink" href="#evennia.commands.default.account.CmdSessions.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdSessions.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdSessions.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdSessions.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdSessions.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdSessions.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdSessions.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdSessions.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdSessions.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdSessions.func" title="Permalink to this definition"></a></dt>
<dd><p>Implement function</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdSessions.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.account.CmdSessions.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdSessions.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdSessions.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdSessions.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'sessions', 'no_prefix': ' ', 'tags': '', 'text': '\n check your connected session(s)\n\n Usage:\n sessions\n\n Lists the sessions currently connected to your account.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdSessions.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdWho">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdWho</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdWho"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdWho" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>list who is currently online</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>who
doing</p>
</dd>
</dl>
<p>Shows who is currently online. Doing is an alias that limits info
also for those with all permissions.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdWho.key">
<code class="sig-name descname">key</code><em class="property"> = 'who'</em><a class="headerlink" href="#evennia.commands.default.account.CmdWho.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdWho.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['doing']</em><a class="headerlink" href="#evennia.commands.default.account.CmdWho.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdWho.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdWho.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdWho.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdWho.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdWho.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdWho.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdWho.func" title="Permalink to this definition"></a></dt>
<dd><p>Get all connected accounts by polling session.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdWho.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdWho.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdWho.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdWho.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdWho.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'doing', 'category': 'general', 'key': 'who', 'no_prefix': ' doing', 'tags': '', 'text': '\n list who is currently online\n\n Usage:\n who\n doing\n\n Shows who is currently online. Doing is an alias that limits info\n also for those with all permissions.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdWho.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdColorTest">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdColorTest</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdColorTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>testing which colors your client support</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>color ansi | xterm256</p>
</dd>
</dl>
<p>Prints a color map along with in-mud color codes to use to produce
them. It also tests what is supported in your client. Choices are
16-color ansi (supported in most muds) or the 256-color xterm256
standard. No checking is done to determine your client supports
color - if not you will see rubbish appear.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.key">
<code class="sig-name descname">key</code><em class="property"> = 'color'</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.slice_bright_fg">
<code class="sig-name descname">slice_bright_fg</code><em class="property"> = slice(7, 15, None)</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.slice_bright_fg" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.slice_dark_fg">
<code class="sig-name descname">slice_dark_fg</code><em class="property"> = slice(15, 23, None)</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.slice_dark_fg" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.slice_dark_bg">
<code class="sig-name descname">slice_dark_bg</code><em class="property"> = slice(-8, None, None)</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.slice_dark_bg" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.slice_bright_bg">
<code class="sig-name descname">slice_bright_bg</code><em class="property"> = slice(None, None, None)</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.slice_bright_bg" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdColorTest.table_format">
<code class="sig-name descname">table_format</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">table</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdColorTest.table_format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.table_format" title="Permalink to this definition"></a></dt>
<dd><p>Helper method to format the ansi/xterm256 tables.
Takes a table of columns [[val,val,…],[val,val,…],…]</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdColorTest.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdColorTest.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.func" title="Permalink to this definition"></a></dt>
<dd><p>Show color tables</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdColorTest.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'color', 'no_prefix': ' ', 'tags': '', 'text': '\n testing which colors your client support\n\n Usage:\n color ansi | xterm256\n\n Prints a color map along with in-mud color codes to use to produce\n them. It also tests what is supported in your client. Choices are\n 16-color ansi (supported in most muds) or the 256-color xterm256\n standard. No checking is done to determine your client supports\n color - if not you will see rubbish appear.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdColorTest.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdQuell">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdQuell</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdQuell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdQuell" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>use characters permissions instead of accounts</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>quell
unquell</p>
</dd>
</dl>
<p>Normally the permission level of the Account is used when puppeting a
Character/Object to determine access. This command will switch the lock
system to make use of the puppeted Objects permissions instead. This is
useful mainly for testing.
Hierarchical permission quelling only work downwards, thus an Account cannot
use a higher-permission Character to escalate their permission level.
Use the unquell command to revert back to normal operation.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuell.key">
<code class="sig-name descname">key</code><em class="property"> = 'quell'</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuell.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['unquell']</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuell.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuell.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuell.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdQuell.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdQuell.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdQuell.func" title="Permalink to this definition"></a></dt>
<dd><p>Perform the command</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuell.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdQuell.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'unquell', 'category': 'general', 'key': 'quell', 'no_prefix': ' unquell', 'tags': '', 'text': &quot;\n use character's permissions instead of account's\n\n Usage:\n quell\n unquell\n\n Normally the permission level of the Account is used when puppeting a\n Character/Object to determine access. This command will switch the lock\n system to make use of the puppeted Object's permissions instead. This is\n useful mainly for testing.\n Hierarchical permission quelling only work downwards, thus an Account cannot\n use a higher-permission Character to escalate their permission level.\n Use the unquell command to revert back to normal operation.\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdCharDelete">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdCharDelete</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdCharDelete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdCharDelete" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>delete a character - this cannot be undone!</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>chardelete &lt;charname&gt;</p>
</dd>
</dl>
<p>Permanently deletes one of your characters.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharDelete.key">
<code class="sig-name descname">key</code><em class="property"> = 'chardelete'</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharDelete.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharDelete.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharDelete.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharDelete.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharDelete.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdCharDelete.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdCharDelete.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdCharDelete.func" title="Permalink to this definition"></a></dt>
<dd><p>delete the character</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharDelete.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharDelete.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharDelete.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharDelete.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdCharDelete.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'chardelete', 'no_prefix': ' ', 'tags': '', 'text': '\n delete a character - this cannot be undone!\n\n Usage:\n chardelete &lt;charname&gt;\n\n Permanently deletes one of your characters.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdCharDelete.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.account.CmdStyle">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.account.</code><code class="sig-name descname">CmdStyle</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdStyle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdStyle" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>In-game style options</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>style
style &lt;option&gt; = &lt;value&gt;</p>
</dd>
</dl>
<p>Configure stylings for in-game display elements like table borders, help
entries etc. Use without arguments to see all available options.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdStyle.key">
<code class="sig-name descname">key</code><em class="property"> = 'style'</em><a class="headerlink" href="#evennia.commands.default.account.CmdStyle.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdStyle.switch_options">
<code class="sig-name descname">switch_options</code><em class="property"> = ['clear']</em><a class="headerlink" href="#evennia.commands.default.account.CmdStyle.switch_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdStyle.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdStyle.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdStyle.func" title="Permalink to this definition"></a></dt>
<dd><p>This is the hook function that actually does all the work. It is called
by the cmdhandler right after self.parser() finishes, and so has access
to all the variables defined therein.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdStyle.list_styles">
<code class="sig-name descname">list_styles</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdStyle.list_styles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdStyle.list_styles" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.account.CmdStyle.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/account.html#CmdStyle.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.account.CmdStyle.set" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdStyle.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.account.CmdStyle.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdStyle.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.commands.default.account.CmdStyle.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdStyle.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.commands.default.account.CmdStyle.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.account.CmdStyle.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'style', 'no_prefix': ' ', 'tags': '', 'text': '\n In-game style options\n\n Usage:\n style\n style &lt;option&gt; = &lt;value&gt;\n\n Configure stylings for in-game display elements like table borders, help\n entries etc. Use without arguments to see all available options.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdStyle.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.commands.default.admin.html" title="evennia.commands.default.admin"
>next</a> |</li>
<li class="right" >
<a href="evennia.commands.default.html" title="evennia.commands.default"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</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.account</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>