mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 13:56:30 +01:00
532 lines
No EOL
35 KiB
HTML
532 lines
No EOL
35 KiB
HTML
|
||
<!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.admin — Evennia 0.9.5 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>
|
||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</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" />
|
||
</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="nav-item nav-item-0"><a href="../index.html">Evennia 0.9.5</a> »</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="Permalink to this headline">¶</a></h1>
|
||
<p>Admin commands</p>
|
||
<dl class="py class">
|
||
<dt id="evennia.commands.default.admin.CmdBoot">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.admin.</code><code class="sig-name descname">CmdBoot</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/admin.html#CmdBoot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot" 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>kick an account from the server.</p>
|
||
<dl class="simple">
|
||
<dt>Usage</dt><dd><p>boot[/switches] <account obj> [: 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 id="evennia.commands.default.admin.CmdBoot.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'boot'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdBoot.switch_options">
|
||
<code class="sig-name descname">switch_options</code><em class="property"> = ('quiet', 'sid')</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.switch_options" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdBoot.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(boot) or perm(Admin)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdBoot.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'admin'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.commands.default.admin.CmdBoot.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/admin.html#CmdBoot.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implementing the function</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdBoot.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdBoot.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(boot) or perm(Admin)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBoot.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.commands.default.admin.CmdBan">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.admin.</code><code class="sig-name descname">CmdBan</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/admin.html#CmdBan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdBan" 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>ban an account from the server</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>ban [<name or ip> [: 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 id="evennia.commands.default.admin.CmdBan.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'ban'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdBan.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['bans']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdBan.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(ban) or perm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdBan.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'admin'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.commands.default.admin.CmdBan.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/admin.html#CmdBan.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.func" title="Permalink 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 id="evennia.commands.default.admin.CmdBan.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(ban) or perm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.commands.default.admin.CmdUnban">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.admin.</code><code class="sig-name descname">CmdUnban</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/admin.html#CmdUnban"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban" 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>remove a ban from an account</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>unban <banid></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 id="evennia.commands.default.admin.CmdUnban.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'unban'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdUnban.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(unban) or perm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdUnban.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'admin'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.commands.default.admin.CmdUnban.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/admin.html#CmdUnban.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implement unbanning</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdUnban.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdUnban.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(unban) or perm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdUnban.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.commands.default.admin.CmdEmit">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.admin.</code><code class="sig-name descname">CmdEmit</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/admin.html#CmdEmit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit" 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>admin command for emitting message to multiple objects</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>emit[/switches] [<obj>, <obj>, … =] <message>
|
||
remit [<obj>, <obj>, … =] <message>
|
||
pemit [<obj>, <obj>, … =] <message></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 id="evennia.commands.default.admin.CmdEmit.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'emit'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdEmit.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['remit', 'pemit']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdEmit.switch_options">
|
||
<code class="sig-name descname">switch_options</code><em class="property"> = ('room', 'accounts', 'contents')</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.switch_options" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdEmit.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(emit) or perm(Builder)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdEmit.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'admin'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.commands.default.admin.CmdEmit.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/admin.html#CmdEmit.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implement the command</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdEmit.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(emit) or perm(Builder)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.commands.default.admin.CmdNewPassword">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.admin.</code><code class="sig-name descname">CmdNewPassword</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/admin.html#CmdNewPassword"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword" 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 the password of an account</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>userpassword <user obj> = <new password></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Set an account’s password.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdNewPassword.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'userpassword'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdNewPassword.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(newpassword) or perm(Admin)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdNewPassword.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'admin'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.commands.default.admin.CmdNewPassword.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/admin.html#CmdNewPassword.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implement the function.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdNewPassword.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdNewPassword.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(newpassword) or perm(Admin)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdNewPassword.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.commands.default.admin.CmdPerm">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.admin.</code><code class="sig-name descname">CmdPerm</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/admin.html#CmdPerm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm" 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 the permissions of an account/object</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>perm[/switch] <object> [= <permission>[,<permission>,…]]
|
||
perm[/switch] <a href="#id1"><span class="problematic" id="id2">*</span></a><account> [= <permission>[,<permission>,…]]</p>
|
||
</dd>
|
||
<dt>Switches:</dt><dd><p>del - delete the given permission from <object> or <account>.
|
||
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 <object>.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdPerm.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'perm'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdPerm.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['setperm']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdPerm.switch_options">
|
||
<code class="sig-name descname">switch_options</code><em class="property"> = ('del', 'account')</em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.switch_options" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdPerm.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(perm) or perm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdPerm.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'admin'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.commands.default.admin.CmdPerm.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/admin.html#CmdPerm.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implement function</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdPerm.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(perm) or perm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.commands.default.admin.CmdWall">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.admin.</code><code class="sig-name descname">CmdWall</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/admin.html#CmdWall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdWall" 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>make an announcement to all</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>wall <message></p>
|
||
</dd>
|
||
</dl>
|
||
<p>Announces a message to all connected sessions
|
||
including all currently unlogged in.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdWall.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'wall'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdWall.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(wall) or perm(Admin)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdWall.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'admin'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.commands.default.admin.CmdWall.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/admin.html#CmdWall.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implements command</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdWall.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdWall.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(wall) or perm(Admin)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdWall.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.commands.default.admin.CmdForce">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.admin.</code><code class="sig-name descname">CmdForce</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/admin.html#CmdForce"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdForce" 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>forces an object to execute a command</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>force <object>=<command string></p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Example</p>
|
||
<p>force bob=get stick</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdForce.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'force'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdForce.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(spawn) or perm(Builder)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdForce.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'building'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdForce.perm_used">
|
||
<code class="sig-name descname">perm_used</code><em class="property"> = 'edit'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.perm_used" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.commands.default.admin.CmdForce.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/admin.html#CmdForce.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implements the force command</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdForce.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.commands.default.admin.CmdForce.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(spawn) or perm(Builder)'</em><a class="headerlink" href="#evennia.commands.default.admin.CmdForce.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main 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>
|
||
<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">Home page</a> </li>
|
||
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
||
<a href="https://discord.gg/NecFePw">Discord</a> -
|
||
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
||
</li>
|
||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||
</ul>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="../../1.0-dev/api/evennia.commands.default.admin.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="evennia.commands.default.admin.html">0.9.5 (v0.9.5 branch)</a></li>
|
||
</ul>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></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="nav-item nav-item-0"><a href="../index.html">Evennia 0.9.5</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.commands.default.admin</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2020, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |