mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 13:56:30 +01:00
3047 lines
No EOL
357 KiB
HTML
3047 lines
No EOL
357 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Default Command Help — 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>
|
||
<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="">Default Command Help</a></li>
|
||
</ul>
|
||
<div class="develop">develop branch</div>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="default-command-help">
|
||
<h1>Default Command Help<a class="headerlink" href="#default-command-help" title="Permalink to this headline">¶</a></h1>
|
||
<blockquote>
|
||
<div><p><em>This page is auto-generated. Do not modify - your changes will be lost. Report problems to the
|
||
<a class="reference external" href="https://github.com/evennia/evennia/issues">issue tracker</a>.</em></p>
|
||
</div></blockquote>
|
||
<p>The full set of default Evennia commands currently contains 92 commands in 9 source
|
||
files. Our policy for adding default commands is outlined <a class="reference internal" href="Using-MUX-as-a-Standard.html"><span class="doc">here</span></a>. More
|
||
information about how commands work can be found in the documentation for <a class="reference internal" href="Commands.html"><span class="doc">Commands</span></a>.</p>
|
||
<div class="section" id="a-z">
|
||
<h2>A-Z<a class="headerlink" href="#a-z" title="Permalink to this headline">¶</a></h2>
|
||
<ul class="simple">
|
||
<li><p>[<code class="docutils literal notranslate"><span class="pre">__unloggedin_look_command</span></code>](https://github.com/evennia/evennia/wiki/Default-Command-
|
||
Help#wiki-<code class="docutils literal notranslate"><span class="pre">--unloggedin-look-command</span></code>-cmdunconnectedlook) - look when in unlogged-in state</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-about-cmdabout">about</a> - show Evennia info</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-access-cmdaccess">access</a> - show your current game access</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-addcom-cmdaddcom">addcom</a> - add a channel alias and/or subscribe to a
|
||
channel</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-alias-cmdsetobjalias">alias</a> - adding permanent aliases for object</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-allcom-cmdallcom">allcom</a> - perform admin operations on all channels</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-ban-cmdban">ban</a> - ban an account from the server</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-batchcode-cmdbatchcode">batchcode</a> - build from batch-code file</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-batchcommands-cmdbatchcommands">batchcommands</a> - build from batch-
|
||
command file</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-boot-cmdboot">boot</a> - kick an account from the server.</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-cboot-cmdcboot">cboot</a> - kick an account from a channel you control</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-ccreate-cmdchannelcreate">ccreate</a> - create a new channel</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-cdesc-cmdcdesc">cdesc</a> - describe a channel you control</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-cdestroy-cmdcdestroy">cdestroy</a> - destroy a channel you created</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-cemit-cmdcemit">cemit</a> - send an admin message to a channel you control</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-channels-cmdchannels">channels</a> - list all channels available to you</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-charcreate-cmdcharcreate">charcreate</a> - create a new character</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-chardelete-cmdchardelete">chardelete</a> - delete a character - this
|
||
cannot be undone!</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-clock-cmdclock">clock</a> - change channel locks of a channel you control</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-cmdsets-cmdlistcmdsets">cmdsets</a> - list command sets defined on an
|
||
object</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-color-cmdcolortest">color</a> - testing which colors your client support</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-command-objmanipcommand">command</a> - This is a parent class for some of
|
||
the defining objmanip commands</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-connect-cmdunconnectedconnect">connect</a> - connect to the game</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-copy-cmdcopy">copy</a> - copy an object and its properties</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-cpattr-cmdcpattr">cpattr</a> - copy attributes between objects</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-create-cmdunconnectedcreate">create</a> - create a new account account</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-create-cmdcreate">create</a> - create new objects</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-cwho-cmdcwho">cwho</a> - show who is listening to a channel</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-delcom-cmddelcom">delcom</a> - remove a channel alias and/or unsubscribe
|
||
from channel</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-desc-cmddesc">desc</a> - describe an object or the current room.</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-destroy-cmddestroy">destroy</a> - permanently delete objects</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-dig-cmddig">dig</a> - build new rooms and connect them to the current
|
||
location</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-drop-cmddrop">drop</a> - drop something</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-emit-cmdemit">emit</a> - admin command for emitting message to multiple
|
||
objects</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-examine-cmdexamine">examine</a> - get detailed information about an object</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-find-cmdfind">find</a> - search the database for objects</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-force-cmdforce">force</a> - forces an object to execute a command</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-get-cmdget">get</a> - pick up something</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-give-cmdgive">give</a> - give away something to someone</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-help-cmdunconnectedhelp">help</a> - get help when in unconnected-in state</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-help-cmdhelp">help</a> - View help or a list of topics</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-home-cmdhome">home</a> - move to your character’s home location</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-ic-cmdic">ic</a> - control an object you have permission to puppet</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-inventory-cmdinventory">inventory</a> - view inventory</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-irc2chan-cmdirc2chan">irc2chan</a> - Link an evennia channel to an
|
||
external IRC channel</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-link-cmdlink">link</a> - link existing rooms together with exits</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-lock-cmdlock">lock</a> - assign a lock definition to an object</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-look-cmdlook">look</a> - look at location or object</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-look-cmdooclook">look</a> - look while out-of-character</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-mvattr-cmdmvattr">mvattr</a> - move attributes between objects</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-name-cmdname">name</a> - change the name and/or aliases of an object</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-nick-cmdnick">nick</a> - define a personal alias/nick by defining a string
|
||
to</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-objects-cmdobjects">objects</a> - statistics on objects in the database</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-ooc-cmdooc">ooc</a> - stop puppeting and go ooc</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-open-cmdopen">open</a> - open a new exit from the current room</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-option-cmdoption">option</a> - Set an account option</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-page-cmdpage">page</a> - send a private message to another account</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-password-cmdpassword">password</a> - change your password</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-perm-cmdperm">perm</a> - set the permissions of an account/object</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-pose-cmdpose">pose</a> - strike a pose</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-py-cmdpy">py</a> - execute a snippet of python code</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-quell-cmdquell">quell</a> - use character’s permissions instead of
|
||
account’s</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-quit-cmdunconnectedquit">quit</a> - quit when in unlogged-in state</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-quit-cmdquit">quit</a> - quit the game</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-reload-cmdreload">reload</a> - reload the server</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-reset-cmdreset">reset</a> - reset and reboot the server</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-rss2chan-cmdrss2chan">rss2chan</a> - link an evennia channel to an
|
||
external RSS feed</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-say-cmdsay">say</a> - speak as your character</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-script-cmdscript">script</a> - attach a script to an object</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-scripts-cmdscripts">scripts</a> - list and manage all running scripts</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-server-cmdserverload">server</a> - show server load and memory statistics</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-service-cmdservice">service</a> - manage system services</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-sessions-cmdsessions">sessions</a> - check your connected session(s)</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-set-cmdsetattribute">set</a> - set attribute on an object or account</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-setdesc-cmdsetdesc">setdesc</a> - describe yourself</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-sethelp-cmdsethelp">sethelp</a> - Edit the help database.</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-sethome-cmdsethome">sethome</a> - set an object’s home location</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-shutdown-cmdshutdown">shutdown</a> - stop the server completely</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-spawn-cmdspawn">spawn</a> - spawn objects from prototype</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-style-cmdstyle">style</a> - In-game style options</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-tag-cmdtag">tag</a> - handles the tags of an object</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-tel-cmdteleport">tel</a> - teleport object to another location</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-time-cmdtime">time</a> - show server time statistics</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-tunnel-cmdtunnel">tunnel</a> - create new rooms in cardinal directions
|
||
only</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-typeclass-cmdtypeclass">typeclass</a> - set or change an object’s
|
||
typeclass</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-unban-cmdunban">unban</a> - remove a ban from an account</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-unlink-cmdunlink">unlink</a> - remove exit-connections between rooms</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-userpassword-cmdnewpassword">userpassword</a> - change the password of an
|
||
account</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-wall-cmdwall">wall</a> - make an announcement to all</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-whisper-cmdwhisper">whisper</a> - Speak privately as your character to
|
||
another</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-who-cmdwho">who</a> - list who is currently online</p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#wiki-wipe-cmdwipe">wipe</a> - clear all attributes from an object</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="a-z-by-source-file">
|
||
<h2>A-Z by source file<a class="headerlink" href="#a-z-by-source-file" title="Permalink to this headline">¶</a></h2>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#accountpy">account.py</a></p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#adminpy">admin.py</a></p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#batchprocesspy">batchprocess.py</a></p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#buildingpy">building.py</a></p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#commspy">comms.py</a></p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#generalpy">general.py</a></p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#helppy">help.py</a></p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#systempy">system.py</a></p></li>
|
||
<li><p><a class="reference external" href="Default-Command-Help.html#unloggedinpy">unloggedin.py</a></p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="command-details">
|
||
<h2>Command details<a class="headerlink" href="#command-details" title="Permalink to this headline">¶</a></h2>
|
||
<p>These are generated from the auto-documentation and are ordered by their source file location in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/">evennia/commands/default/</a></p>
|
||
<div class="section" id="account-py">
|
||
<h3><code class="docutils literal notranslate"><span class="pre">account.py</span></code><a class="headerlink" href="#account-py" title="Permalink to this headline">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">View account.py
|
||
source</a></p>
|
||
<div class="section" id="charcreate-cmdcharcreate">
|
||
<h4>charcreate (CmdCharCreate)<a class="headerlink" href="#charcreate-cmdcharcreate" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">create</span> <span class="n">a</span> <span class="n">new</span> <span class="n">character</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">charcreate</span> <span class="o"><</span><span class="n">charname</span><span class="o">></span> <span class="p">[</span><span class="o">=</span> <span class="n">desc</span><span class="p">]</span>
|
||
|
||
<span class="n">Create</span> <span class="n">a</span> <span class="n">new</span> <span class="n">character</span><span class="p">,</span> <span class="n">optionally</span> <span class="n">giving</span> <span class="n">it</span> <span class="n">a</span> <span class="n">description</span><span class="o">.</span> <span class="n">You</span>
|
||
<span class="n">may</span> <span class="n">use</span> <span class="n">upper</span><span class="o">-</span><span class="n">case</span> <span class="n">letters</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">name</span> <span class="o">-</span> <span class="n">you</span> <span class="n">will</span> <span class="n">nevertheless</span>
|
||
<span class="n">always</span> <span class="n">be</span> <span class="n">able</span> <span class="n">to</span> <span class="n">access</span> <span class="n">your</span> <span class="n">character</span> <span class="n">using</span> <span class="n">lower</span><span class="o">-</span><span class="n">case</span> <span class="n">letters</span>
|
||
<span class="k">if</span> <span class="n">you</span> <span class="n">want</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>charcreate</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:pperm(Player)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdCharCreate</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="chardelete-cmdchardelete">
|
||
<h4>chardelete (CmdCharDelete)<a class="headerlink" href="#chardelete-cmdchardelete" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> delete a character - this cannot be undone!
|
||
|
||
Usage:
|
||
chardelete <charname>
|
||
|
||
Permanently deletes one of your characters.
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>chardelete</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:pperm(Player)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdCharDelete</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="color-cmdcolortest">
|
||
<h4>color (CmdColorTest)<a class="headerlink" href="#color-cmdcolortest" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">testing</span> <span class="n">which</span> <span class="n">colors</span> <span class="n">your</span> <span class="n">client</span> <span class="n">support</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">color</span> <span class="n">ansi</span><span class="o">||</span><span class="n">xterm256</span>
|
||
|
||
<span class="n">Prints</span> <span class="n">a</span> <span class="n">color</span> <span class="nb">map</span> <span class="n">along</span> <span class="k">with</span> <span class="ow">in</span><span class="o">-</span><span class="n">mud</span> <span class="n">color</span> <span class="n">codes</span> <span class="n">to</span> <span class="n">use</span> <span class="n">to</span> <span class="n">produce</span>
|
||
<span class="n">them</span><span class="o">.</span> <span class="n">It</span> <span class="n">also</span> <span class="n">tests</span> <span class="n">what</span> <span class="ow">is</span> <span class="n">supported</span> <span class="ow">in</span> <span class="n">your</span> <span class="n">client</span><span class="o">.</span> <span class="n">Choices</span> <span class="n">are</span>
|
||
<span class="mi">16</span><span class="o">-</span><span class="n">color</span> <span class="n">ansi</span> <span class="p">(</span><span class="n">supported</span> <span class="ow">in</span> <span class="n">most</span> <span class="n">muds</span><span class="p">)</span> <span class="ow">or</span> <span class="n">the</span> <span class="mi">256</span><span class="o">-</span><span class="n">color</span> <span class="n">xterm256</span>
|
||
<span class="n">standard</span><span class="o">.</span> <span class="n">No</span> <span class="n">checking</span> <span class="ow">is</span> <span class="n">done</span> <span class="n">to</span> <span class="n">determine</span> <span class="n">your</span> <span class="n">client</span> <span class="n">supports</span>
|
||
<span class="n">color</span> <span class="o">-</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">you</span> <span class="n">will</span> <span class="n">see</span> <span class="n">rubbish</span> <span class="n">appear</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>color</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdColorTest</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="ic-cmdic">
|
||
<h4>ic (CmdIC)<a class="headerlink" href="#ic-cmdic" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> control an object you have permission to puppet
|
||
|
||
Usage:
|
||
ic <character>
|
||
|
||
Go in-character (IC) as a given Character.
|
||
|
||
This will attempt to "become" a different object assuming you have
|
||
the right to do so. Note that it's the ACCOUNT character that puppets
|
||
characters/objects and which needs to have the correct permission!
|
||
|
||
You cannot become an object that is already controlled by another
|
||
account. In principle <character> can be any in-game object as long
|
||
as you the account have access right to puppet it.
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>ic</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>puppet</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdIC</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="look-cmdooclook">
|
||
<h4>look (CmdOOCLook)<a class="headerlink" href="#look-cmdooclook" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">look</span> <span class="k">while</span> <span class="n">out</span><span class="o">-</span><span class="n">of</span><span class="o">-</span><span class="n">character</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">look</span>
|
||
|
||
<span class="n">Look</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">ooc</span> <span class="n">state</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>look</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>l</em>, <em>ls</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdOOCLook</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="ooc-cmdooc">
|
||
<h4>ooc (CmdOOC)<a class="headerlink" href="#ooc-cmdooc" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">stop</span> <span class="n">puppeting</span> <span class="ow">and</span> <span class="n">go</span> <span class="n">ooc</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">ooc</span>
|
||
|
||
<span class="n">Go</span> <span class="n">out</span><span class="o">-</span><span class="n">of</span><span class="o">-</span><span class="n">character</span> <span class="p">(</span><span class="n">OOC</span><span class="p">)</span><span class="o">.</span>
|
||
|
||
<span class="n">This</span> <span class="n">will</span> <span class="n">leave</span> <span class="n">your</span> <span class="n">current</span> <span class="n">character</span> <span class="ow">and</span> <span class="n">put</span> <span class="n">you</span> <span class="ow">in</span> <span class="n">a</span> <span class="n">incorporeal</span> <span class="n">OOC</span> <span class="n">state</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>ooc</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>unpuppet</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:pperm(Player)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdOOC</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="option-cmdoption">
|
||
<h4>option (CmdOption)<a class="headerlink" href="#option-cmdoption" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">Set</span> <span class="n">an</span> <span class="n">account</span> <span class="n">option</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">option</span><span class="p">[</span><span class="o">/</span><span class="n">save</span><span class="p">]</span> <span class="p">[</span><span class="n">name</span> <span class="o">=</span> <span class="n">value</span><span class="p">]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">save</span> <span class="o">-</span> <span class="n">Save</span> <span class="n">the</span> <span class="n">current</span> <span class="n">option</span> <span class="n">settings</span> <span class="k">for</span> <span class="n">future</span> <span class="n">logins</span><span class="o">.</span>
|
||
<span class="n">clear</span> <span class="o">-</span> <span class="n">Clear</span> <span class="n">the</span> <span class="n">saved</span> <span class="n">options</span><span class="o">.</span>
|
||
|
||
<span class="n">This</span> <span class="n">command</span> <span class="n">allows</span> <span class="k">for</span> <span class="n">viewing</span> <span class="ow">and</span> <span class="n">setting</span> <span class="n">client</span> <span class="n">interface</span>
|
||
<span class="n">settings</span><span class="o">.</span> <span class="n">Note</span> <span class="n">that</span> <span class="n">saved</span> <span class="n">options</span> <span class="n">may</span> <span class="ow">not</span> <span class="n">be</span> <span class="n">able</span> <span class="n">to</span> <span class="n">be</span> <span class="n">used</span> <span class="k">if</span>
|
||
<span class="n">later</span> <span class="n">connecting</span> <span class="k">with</span> <span class="n">a</span> <span class="n">client</span> <span class="k">with</span> <span class="n">different</span> <span class="n">capabilities</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>option</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>options</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdOption</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="password-cmdpassword">
|
||
<h4>password (CmdPassword)<a class="headerlink" href="#password-cmdpassword" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">change</span> <span class="n">your</span> <span class="n">password</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">password</span> <span class="o"><</span><span class="n">old</span> <span class="n">password</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">new</span> <span class="n">password</span><span class="o">></span>
|
||
|
||
<span class="n">Changes</span> <span class="n">your</span> <span class="n">password</span><span class="o">.</span> <span class="n">Make</span> <span class="n">sure</span> <span class="n">to</span> <span class="n">pick</span> <span class="n">a</span> <span class="n">safe</span> <span class="n">one</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>password</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:pperm(Player)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdPassword</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="quell-cmdquell">
|
||
<h4>quell (CmdQuell)<a class="headerlink" href="#quell-cmdquell" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">use</span> <span class="n">character</span><span class="s1">'s permissions instead of account'</span><span class="n">s</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">quell</span>
|
||
<span class="n">unquell</span>
|
||
|
||
<span class="n">Normally</span> <span class="n">the</span> <span class="n">permission</span> <span class="n">level</span> <span class="n">of</span> <span class="n">the</span> <span class="n">Account</span> <span class="ow">is</span> <span class="n">used</span> <span class="n">when</span> <span class="n">puppeting</span> <span class="n">a</span>
|
||
<span class="n">Character</span><span class="o">/</span><span class="n">Object</span> <span class="n">to</span> <span class="n">determine</span> <span class="n">access</span><span class="o">.</span> <span class="n">This</span> <span class="n">command</span> <span class="n">will</span> <span class="n">switch</span> <span class="n">the</span> <span class="n">lock</span>
|
||
<span class="n">system</span> <span class="n">to</span> <span class="n">make</span> <span class="n">use</span> <span class="n">of</span> <span class="n">the</span> <span class="n">puppeted</span> <span class="n">Object</span><span class="s1">'s permissions instead. This is</span>
|
||
<span class="n">useful</span> <span class="n">mainly</span> <span class="k">for</span> <span class="n">testing</span><span class="o">.</span>
|
||
<span class="n">Hierarchical</span> <span class="n">permission</span> <span class="n">quelling</span> <span class="n">only</span> <span class="n">work</span> <span class="n">downwards</span><span class="p">,</span> <span class="n">thus</span> <span class="n">an</span> <span class="n">Account</span> <span class="n">cannot</span>
|
||
<span class="n">use</span> <span class="n">a</span> <span class="n">higher</span><span class="o">-</span><span class="n">permission</span> <span class="n">Character</span> <span class="n">to</span> <span class="n">escalate</span> <span class="n">their</span> <span class="n">permission</span> <span class="n">level</span><span class="o">.</span>
|
||
<span class="n">Use</span> <span class="n">the</span> <span class="n">unquell</span> <span class="n">command</span> <span class="n">to</span> <span class="n">revert</span> <span class="n">back</span> <span class="n">to</span> <span class="n">normal</span> <span class="n">operation</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>quell</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>unquell</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:pperm(Player)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdQuell</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="quit-cmdquit">
|
||
<h4>quit (CmdQuit)<a class="headerlink" href="#quit-cmdquit" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">quit</span> <span class="n">the</span> <span class="n">game</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">quit</span>
|
||
|
||
<span class="n">Switch</span><span class="p">:</span>
|
||
<span class="nb">all</span> <span class="o">-</span> <span class="n">disconnect</span> <span class="nb">all</span> <span class="n">connected</span> <span class="n">sessions</span>
|
||
|
||
<span class="n">Gracefully</span> <span class="n">disconnect</span> <span class="n">your</span> <span class="n">current</span> <span class="n">session</span> <span class="kn">from</span> <span class="nn">the</span>
|
||
<span class="n">game</span><span class="o">.</span> <span class="n">Use</span> <span class="n">the</span> <span class="o">/</span><span class="nb">all</span> <span class="n">switch</span> <span class="n">to</span> <span class="n">disconnect</span> <span class="kn">from</span> <span class="nn">all</span> <span class="n">sessions</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>quit</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdQuit</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="sessions-cmdsessions">
|
||
<h4>sessions (CmdSessions)<a class="headerlink" href="#sessions-cmdsessions" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">check</span> <span class="n">your</span> <span class="n">connected</span> <span class="n">session</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">sessions</span>
|
||
|
||
<span class="n">Lists</span> <span class="n">the</span> <span class="n">sessions</span> <span class="n">currently</span> <span class="n">connected</span> <span class="n">to</span> <span class="n">your</span> <span class="n">account</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>sessions</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdSessions</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultSession’</em> of class <code class="docutils literal notranslate"><span class="pre">SessionCmdSet</span></code> in [cmdset_session.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_session.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="style-cmdstyle">
|
||
<h4>style (CmdStyle)<a class="headerlink" href="#style-cmdstyle" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">In</span><span class="o">-</span><span class="n">game</span> <span class="n">style</span> <span class="n">options</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">style</span>
|
||
<span class="n">style</span> <span class="o"><</span><span class="n">option</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">value</span><span class="o">></span>
|
||
|
||
<span class="n">Configure</span> <span class="n">stylings</span> <span class="k">for</span> <span class="ow">in</span><span class="o">-</span><span class="n">game</span> <span class="n">display</span> <span class="n">elements</span> <span class="n">like</span> <span class="n">table</span> <span class="n">borders</span><span class="p">,</span> <span class="n">help</span>
|
||
<span class="n">entriest</span> <span class="n">etc</span><span class="o">.</span> <span class="n">Use</span> <span class="n">without</span> <span class="n">arguments</span> <span class="n">to</span> <span class="n">see</span> <span class="nb">all</span> <span class="n">available</span> <span class="n">options</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>style</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdStyle</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="who-cmdwho">
|
||
<h4>who (CmdWho)<a class="headerlink" href="#who-cmdwho" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nb">list</span> <span class="n">who</span> <span class="ow">is</span> <span class="n">currently</span> <span class="n">online</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">who</span>
|
||
<span class="n">doing</span>
|
||
|
||
<span class="n">Shows</span> <span class="n">who</span> <span class="ow">is</span> <span class="n">currently</span> <span class="n">online</span><span class="o">.</span> <span class="n">Doing</span> <span class="ow">is</span> <span class="n">an</span> <span class="n">alias</span> <span class="n">that</span> <span class="n">limits</span> <span class="n">info</span>
|
||
<span class="n">also</span> <span class="k">for</span> <span class="n">those</span> <span class="k">with</span> <span class="nb">all</span> <span class="n">permissions</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>who</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>doing</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdWho</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/account.py">account.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="admin-py">
|
||
<h3><code class="docutils literal notranslate"><span class="pre">admin.py</span></code><a class="headerlink" href="#admin-py" title="Permalink to this headline">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py">View admin.py
|
||
source</a></p>
|
||
<div class="section" id="ban-cmdban">
|
||
<h4>ban (CmdBan)<a class="headerlink" href="#ban-cmdban" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">ban</span> <span class="n">an</span> <span class="n">account</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">server</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">ban</span> <span class="p">[</span><span class="o"><</span><span class="n">name</span> <span class="ow">or</span> <span class="n">ip</span><span class="o">></span> <span class="p">[:</span> <span class="n">reason</span><span class="p">]]</span>
|
||
|
||
<span class="n">Without</span> <span class="nb">any</span> <span class="n">arguments</span><span class="p">,</span> <span class="n">shows</span> <span class="n">numbered</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">active</span> <span class="n">bans</span><span class="o">.</span>
|
||
|
||
<span class="n">This</span> <span class="n">command</span> <span class="n">bans</span> <span class="n">a</span> <span class="n">user</span> <span class="kn">from</span> <span class="nn">accessing</span> <span class="n">the</span> <span class="n">game</span><span class="o">.</span> <span class="n">Supply</span> <span class="n">an</span> <span class="n">optional</span>
|
||
<span class="n">reason</span> <span class="n">to</span> <span class="n">be</span> <span class="n">able</span> <span class="n">to</span> <span class="n">later</span> <span class="n">remember</span> <span class="n">why</span> <span class="n">the</span> <span class="n">ban</span> <span class="n">was</span> <span class="n">put</span> <span class="ow">in</span> <span class="n">place</span><span class="o">.</span>
|
||
|
||
<span class="n">It</span> <span class="ow">is</span> <span class="n">often</span> <span class="n">preferable</span> <span class="n">to</span> <span class="n">ban</span> <span class="n">an</span> <span class="n">account</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">server</span> <span class="n">than</span> <span class="n">to</span>
|
||
<span class="n">delete</span> <span class="n">an</span> <span class="n">account</span> <span class="k">with</span> <span class="n">accounts</span><span class="o">/</span><span class="n">delete</span><span class="o">.</span> <span class="n">If</span> <span class="n">banned</span> <span class="n">by</span> <span class="n">name</span><span class="p">,</span> <span class="n">that</span> <span class="n">account</span>
|
||
<span class="n">account</span> <span class="n">can</span> <span class="n">no</span> <span class="n">longer</span> <span class="n">be</span> <span class="n">logged</span> <span class="n">into</span><span class="o">.</span>
|
||
|
||
<span class="n">IP</span> <span class="p">(</span><span class="n">Internet</span> <span class="n">Protocol</span><span class="p">)</span> <span class="n">address</span> <span class="n">banning</span> <span class="n">allows</span> <span class="n">blocking</span> <span class="nb">all</span> <span class="n">access</span>
|
||
<span class="kn">from</span> <span class="nn">a</span> <span class="n">specific</span> <span class="n">address</span> <span class="ow">or</span> <span class="n">subnet</span><span class="o">.</span> <span class="n">Use</span> <span class="n">an</span> <span class="n">asterisk</span> <span class="p">(</span><span class="o">*</span><span class="p">)</span> <span class="k">as</span> <span class="n">a</span>
|
||
<span class="n">wildcard</span><span class="o">.</span>
|
||
|
||
<span class="n">Examples</span><span class="p">:</span>
|
||
<span class="n">ban</span> <span class="n">thomas</span> <span class="o">-</span> <span class="n">ban</span> <span class="n">account</span> <span class="s1">'thomas'</span>
|
||
<span class="n">ban</span><span class="o">/</span><span class="n">ip</span> <span class="mf">134.233</span><span class="o">.</span><span class="mf">2.111</span> <span class="o">-</span> <span class="n">ban</span> <span class="n">specific</span> <span class="n">ip</span> <span class="n">address</span>
|
||
<span class="n">ban</span><span class="o">/</span><span class="n">ip</span> <span class="mf">134.233</span><span class="o">.</span><span class="mf">2.</span><span class="o">*</span> <span class="o">-</span> <span class="n">ban</span> <span class="nb">all</span> <span class="ow">in</span> <span class="n">a</span> <span class="n">subnet</span>
|
||
<span class="n">ban</span><span class="o">/</span><span class="n">ip</span> <span class="mf">134.233</span><span class="o">.*.*</span> <span class="o">-</span> <span class="n">even</span> <span class="n">wider</span> <span class="n">ban</span>
|
||
|
||
<span class="n">A</span> <span class="n">single</span> <span class="n">IP</span> <span class="nb">filter</span> <span class="n">can</span> <span class="n">be</span> <span class="n">easy</span> <span class="n">to</span> <span class="n">circumvent</span> <span class="n">by</span> <span class="n">changing</span> <span class="n">computers</span>
|
||
<span class="ow">or</span> <span class="n">requesting</span> <span class="n">a</span> <span class="n">new</span> <span class="n">IP</span> <span class="n">address</span><span class="o">.</span> <span class="n">Setting</span> <span class="n">a</span> <span class="n">wide</span> <span class="n">IP</span> <span class="n">block</span> <span class="nb">filter</span> <span class="k">with</span>
|
||
<span class="n">wildcards</span> <span class="n">might</span> <span class="n">be</span> <span class="n">tempting</span><span class="p">,</span> <span class="n">but</span> <span class="n">remember</span> <span class="n">that</span> <span class="n">it</span> <span class="n">may</span> <span class="n">also</span>
|
||
<span class="n">accidentally</span> <span class="n">block</span> <span class="n">innocent</span> <span class="n">users</span> <span class="n">connecting</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">same</span> <span class="n">country</span>
|
||
<span class="ow">or</span> <span class="n">region</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>ban</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>bans</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(ban) or perm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Admin”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdBan</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py">admin.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="boot-cmdboot">
|
||
<h4>boot (CmdBoot)<a class="headerlink" href="#boot-cmdboot" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">kick</span> <span class="n">an</span> <span class="n">account</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">server</span><span class="o">.</span>
|
||
|
||
<span class="n">Usage</span>
|
||
<span class="n">boot</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="o"><</span><span class="n">account</span> <span class="n">obj</span><span class="o">></span> <span class="p">[:</span> <span class="n">reason</span><span class="p">]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">quiet</span> <span class="o">-</span> <span class="n">Silently</span> <span class="n">boot</span> <span class="n">without</span> <span class="n">informing</span> <span class="n">account</span>
|
||
<span class="n">sid</span> <span class="o">-</span> <span class="n">boot</span> <span class="n">by</span> <span class="n">session</span> <span class="nb">id</span> <span class="n">instead</span> <span class="n">of</span> <span class="n">name</span> <span class="ow">or</span> <span class="n">dbref</span>
|
||
|
||
<span class="n">Boot</span> <span class="n">an</span> <span class="n">account</span> <span class="nb">object</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">server</span><span class="o">.</span> <span class="n">If</span> <span class="n">a</span> <span class="n">reason</span> <span class="ow">is</span>
|
||
<span class="n">supplied</span> <span class="n">it</span> <span class="n">will</span> <span class="n">be</span> <span class="n">echoed</span> <span class="n">to</span> <span class="n">the</span> <span class="n">user</span> <span class="n">unless</span> <span class="o">/</span><span class="n">quiet</span> <span class="ow">is</span> <span class="nb">set</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>boot</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(boot) or perm(Admin)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Admin”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdBoot</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py">admin.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="emit-cmdemit">
|
||
<h4>emit (CmdEmit)<a class="headerlink" href="#emit-cmdemit" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">admin</span> <span class="n">command</span> <span class="k">for</span> <span class="n">emitting</span> <span class="n">message</span> <span class="n">to</span> <span class="n">multiple</span> <span class="n">objects</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">emit</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="p">[</span><span class="o"><</span><span class="n">obj</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span><span class="p">,</span> <span class="o">...</span> <span class="o">=</span><span class="p">]</span> <span class="o"><</span><span class="n">message</span><span class="o">></span>
|
||
<span class="n">remit</span> <span class="p">[</span><span class="o"><</span><span class="n">obj</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span><span class="p">,</span> <span class="o">...</span> <span class="o">=</span><span class="p">]</span> <span class="o"><</span><span class="n">message</span><span class="o">></span>
|
||
<span class="n">pemit</span> <span class="p">[</span><span class="o"><</span><span class="n">obj</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span><span class="p">,</span> <span class="o">...</span> <span class="o">=</span><span class="p">]</span> <span class="o"><</span><span class="n">message</span><span class="o">></span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">room</span> <span class="o">-</span> <span class="n">limit</span> <span class="n">emits</span> <span class="n">to</span> <span class="n">rooms</span> <span class="n">only</span> <span class="p">(</span><span class="n">default</span><span class="p">)</span>
|
||
<span class="n">accounts</span> <span class="o">-</span> <span class="n">limit</span> <span class="n">emits</span> <span class="n">to</span> <span class="n">accounts</span> <span class="n">only</span>
|
||
<span class="n">contents</span> <span class="o">-</span> <span class="n">send</span> <span class="n">to</span> <span class="n">the</span> <span class="n">contents</span> <span class="n">of</span> <span class="n">matched</span> <span class="n">objects</span> <span class="n">too</span>
|
||
|
||
<span class="n">Emits</span> <span class="n">a</span> <span class="n">message</span> <span class="n">to</span> <span class="n">the</span> <span class="n">selected</span> <span class="n">objects</span> <span class="ow">or</span> <span class="n">to</span>
|
||
<span class="n">your</span> <span class="n">immediate</span> <span class="n">surroundings</span><span class="o">.</span> <span class="n">If</span> <span class="n">the</span> <span class="nb">object</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">room</span><span class="p">,</span>
|
||
<span class="n">send</span> <span class="n">to</span> <span class="n">its</span> <span class="n">contents</span><span class="o">.</span> <span class="n">remit</span> <span class="ow">and</span> <span class="n">pemit</span> <span class="n">are</span> <span class="n">just</span>
|
||
<span class="n">limited</span> <span class="n">forms</span> <span class="n">of</span> <span class="n">emit</span><span class="p">,</span> <span class="k">for</span> <span class="n">sending</span> <span class="n">to</span> <span class="n">rooms</span> <span class="ow">and</span>
|
||
<span class="n">to</span> <span class="n">accounts</span> <span class="n">respectively</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>emit</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>remit</em>, <em>pemit</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(emit) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Admin”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdEmit</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py">admin.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="force-cmdforce">
|
||
<h4>force (CmdForce)<a class="headerlink" href="#force-cmdforce" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">forces</span> <span class="n">an</span> <span class="nb">object</span> <span class="n">to</span> <span class="n">execute</span> <span class="n">a</span> <span class="n">command</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">force</span> <span class="o"><</span><span class="nb">object</span><span class="o">>=<</span><span class="n">command</span> <span class="n">string</span><span class="o">></span>
|
||
|
||
<span class="n">Example</span><span class="p">:</span>
|
||
<span class="n">force</span> <span class="n">bob</span><span class="o">=</span><span class="n">get</span> <span class="n">stick</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>force</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(spawn) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdForce</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py">admin.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="perm-cmdperm">
|
||
<h4>perm (CmdPerm)<a class="headerlink" href="#perm-cmdperm" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nb">set</span> <span class="n">the</span> <span class="n">permissions</span> <span class="n">of</span> <span class="n">an</span> <span class="n">account</span><span class="o">/</span><span class="nb">object</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">perm</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span> <span class="p">[</span><span class="o">=</span> <span class="o"><</span><span class="n">permission</span><span class="o">></span><span class="p">[,</span><span class="o"><</span><span class="n">permission</span><span class="o">></span><span class="p">,</span><span class="o">...</span><span class="p">]]</span>
|
||
<span class="n">perm</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o">*<</span><span class="n">account</span><span class="o">></span> <span class="p">[</span><span class="o">=</span> <span class="o"><</span><span class="n">permission</span><span class="o">></span><span class="p">[,</span><span class="o"><</span><span class="n">permission</span><span class="o">></span><span class="p">,</span><span class="o">...</span><span class="p">]]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="k">del</span> <span class="o">-</span> <span class="n">delete</span> <span class="n">the</span> <span class="n">given</span> <span class="n">permission</span> <span class="kn">from</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span> <span class="ow">or</span> <span class="o"><</span><span class="n">account</span><span class="o">>.</span>
|
||
<span class="n">account</span> <span class="o">-</span> <span class="nb">set</span> <span class="n">permission</span> <span class="n">on</span> <span class="n">an</span> <span class="n">account</span> <span class="p">(</span><span class="n">same</span> <span class="k">as</span> <span class="n">adding</span> <span class="o">*</span> <span class="n">to</span> <span class="n">name</span><span class="p">)</span>
|
||
|
||
<span class="n">This</span> <span class="n">command</span> <span class="n">sets</span><span class="o">/</span><span class="n">clears</span> <span class="n">individual</span> <span class="n">permission</span> <span class="n">strings</span> <span class="n">on</span> <span class="n">an</span> <span class="nb">object</span>
|
||
<span class="ow">or</span> <span class="n">account</span><span class="o">.</span> <span class="n">If</span> <span class="n">no</span> <span class="n">permission</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="nb">list</span> <span class="nb">all</span> <span class="n">permissions</span> <span class="n">on</span> <span class="o"><</span><span class="nb">object</span><span class="o">>.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>perm</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>setperm</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(perm) or perm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Admin”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdPerm</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py">admin.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="unban-cmdunban">
|
||
<h4>unban (CmdUnban)<a class="headerlink" href="#unban-cmdunban" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">remove</span> <span class="n">a</span> <span class="n">ban</span> <span class="kn">from</span> <span class="nn">an</span> <span class="n">account</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">unban</span> <span class="o"><</span><span class="n">banid</span><span class="o">></span>
|
||
|
||
<span class="n">This</span> <span class="n">will</span> <span class="n">clear</span> <span class="n">an</span> <span class="n">account</span> <span class="n">name</span><span class="o">/</span><span class="n">ip</span> <span class="n">ban</span> <span class="n">previously</span> <span class="nb">set</span> <span class="k">with</span> <span class="n">the</span> <span class="n">ban</span>
|
||
<span class="n">command</span><span class="o">.</span> <span class="n">Use</span> <span class="n">this</span> <span class="n">command</span> <span class="n">without</span> <span class="n">an</span> <span class="n">argument</span> <span class="n">to</span> <span class="n">view</span> <span class="n">a</span> <span class="n">numbered</span>
|
||
<span class="nb">list</span> <span class="n">of</span> <span class="n">bans</span><span class="o">.</span> <span class="n">Use</span> <span class="n">the</span> <span class="n">numbers</span> <span class="ow">in</span> <span class="n">this</span> <span class="nb">list</span> <span class="n">to</span> <span class="n">select</span> <span class="n">which</span> <span class="n">one</span> <span class="n">to</span>
|
||
<span class="n">unban</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>unban</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(unban) or perm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Admin”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdUnban</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py">admin.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="userpassword-cmdnewpassword">
|
||
<h4>userpassword (CmdNewPassword)<a class="headerlink" href="#userpassword-cmdnewpassword" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">change</span> <span class="n">the</span> <span class="n">password</span> <span class="n">of</span> <span class="n">an</span> <span class="n">account</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">userpassword</span> <span class="o"><</span><span class="n">user</span> <span class="n">obj</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">new</span> <span class="n">password</span><span class="o">></span>
|
||
|
||
<span class="n">Set</span> <span class="n">an</span> <span class="n">account</span><span class="s1">'s password.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>userpassword</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(newpassword) or perm(Admin)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Admin”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdNewPassword</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py">admin.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="wall-cmdwall">
|
||
<h4>wall (CmdWall)<a class="headerlink" href="#wall-cmdwall" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">make</span> <span class="n">an</span> <span class="n">announcement</span> <span class="n">to</span> <span class="nb">all</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">wall</span> <span class="o"><</span><span class="n">message</span><span class="o">></span>
|
||
|
||
<span class="n">Announces</span> <span class="n">a</span> <span class="n">message</span> <span class="n">to</span> <span class="nb">all</span> <span class="n">connected</span> <span class="n">sessions</span>
|
||
<span class="n">including</span> <span class="nb">all</span> <span class="n">currently</span> <span class="n">unlogged</span> <span class="ow">in</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>wall</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(wall) or perm(Admin)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Admin”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdWall</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/admin.py">admin.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="batchprocess-py">
|
||
<h3><code class="docutils literal notranslate"><span class="pre">batchprocess.py</span></code><a class="headerlink" href="#batchprocess-py" title="Permalink to this headline">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/batchprocess.py">View batchprocess.py
|
||
source</a></p>
|
||
<div class="section" id="batchcode-cmdbatchcode">
|
||
<h4>batchcode (CmdBatchCode)<a class="headerlink" href="#batchcode-cmdbatchcode" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">build</span> <span class="kn">from</span> <span class="nn">batch</span><span class="o">-</span><span class="n">code</span> <span class="n">file</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">batchcode</span><span class="p">[</span><span class="o">/</span><span class="n">interactive</span><span class="p">]</span> <span class="o"><</span><span class="n">python</span> <span class="n">path</span> <span class="n">to</span> <span class="n">file</span><span class="o">></span>
|
||
|
||
<span class="n">Switch</span><span class="p">:</span>
|
||
<span class="n">interactive</span> <span class="o">-</span> <span class="n">this</span> <span class="n">mode</span> <span class="n">will</span> <span class="n">offer</span> <span class="n">more</span> <span class="n">control</span> <span class="n">when</span>
|
||
<span class="n">executing</span> <span class="n">the</span> <span class="n">batch</span> <span class="n">file</span><span class="p">,</span> <span class="n">like</span> <span class="n">stepping</span><span class="p">,</span>
|
||
<span class="n">skipping</span><span class="p">,</span> <span class="n">reloading</span> <span class="n">etc</span><span class="o">.</span>
|
||
<span class="n">debug</span> <span class="o">-</span> <span class="n">auto</span><span class="o">-</span><span class="n">delete</span> <span class="nb">all</span> <span class="n">objects</span> <span class="n">that</span> <span class="n">has</span> <span class="n">been</span> <span class="n">marked</span> <span class="k">as</span>
|
||
<span class="n">deletable</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">script</span> <span class="n">file</span> <span class="p">(</span><span class="n">see</span> <span class="n">example</span> <span class="n">files</span> <span class="k">for</span>
|
||
<span class="n">syntax</span><span class="p">)</span><span class="o">.</span> <span class="n">This</span> <span class="ow">is</span> <span class="n">useful</span> <span class="n">so</span> <span class="k">as</span> <span class="n">to</span> <span class="n">to</span> <span class="ow">not</span> <span class="n">leave</span> <span class="n">multiple</span>
|
||
<span class="nb">object</span> <span class="n">copies</span> <span class="n">behind</span> <span class="n">when</span> <span class="n">testing</span> <span class="n">out</span> <span class="n">the</span> <span class="n">script</span><span class="o">.</span>
|
||
|
||
<span class="n">Runs</span> <span class="n">batches</span> <span class="n">of</span> <span class="n">commands</span> <span class="kn">from</span> <span class="nn">a</span> <span class="n">batch</span><span class="o">-</span><span class="n">code</span> <span class="n">text</span> <span class="n">file</span> <span class="p">(</span><span class="o">*.</span><span class="n">py</span><span class="p">)</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>batchcode</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>batchcodes</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:superuser()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdBatchCode</span></code> in [batchprocess.py](https://github.com/evennia/evennia/tree/mast
|
||
er/evennia/commands/default/batchprocess.py).
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="batchcommands-cmdbatchcommands">
|
||
<h4>batchcommands (CmdBatchCommands)<a class="headerlink" href="#batchcommands-cmdbatchcommands" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">build</span> <span class="kn">from</span> <span class="nn">batch</span><span class="o">-</span><span class="n">command</span> <span class="n">file</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">batchcommands</span><span class="p">[</span><span class="o">/</span><span class="n">interactive</span><span class="p">]</span> <span class="o"><</span><span class="n">python</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">to</span><span class="o">.</span><span class="n">file</span><span class="o">></span>
|
||
|
||
<span class="n">Switch</span><span class="p">:</span>
|
||
<span class="n">interactive</span> <span class="o">-</span> <span class="n">this</span> <span class="n">mode</span> <span class="n">will</span> <span class="n">offer</span> <span class="n">more</span> <span class="n">control</span> <span class="n">when</span>
|
||
<span class="n">executing</span> <span class="n">the</span> <span class="n">batch</span> <span class="n">file</span><span class="p">,</span> <span class="n">like</span> <span class="n">stepping</span><span class="p">,</span>
|
||
<span class="n">skipping</span><span class="p">,</span> <span class="n">reloading</span> <span class="n">etc</span><span class="o">.</span>
|
||
|
||
<span class="n">Runs</span> <span class="n">batches</span> <span class="n">of</span> <span class="n">commands</span> <span class="kn">from</span> <span class="nn">a</span> <span class="n">batch</span><span class="o">-</span><span class="n">cmd</span> <span class="n">text</span> <span class="n">file</span> <span class="p">(</span><span class="o">*.</span><span class="n">ev</span><span class="p">)</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>batchcommands</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>batchcmd</em>, <em>batchcommand</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(batchcommands) or perm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdBatchCommands</span></code> in [batchprocess.py](https://github.com/evennia/evennia/tree/
|
||
master/evennia/commands/default/batchprocess.py).
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="building-py">
|
||
<h3><code class="docutils literal notranslate"><span class="pre">building.py</span></code><a class="headerlink" href="#building-py" title="Permalink to this headline">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">View building.py
|
||
source</a></p>
|
||
<div class="section" id="alias-cmdsetobjalias">
|
||
<h4>alias (CmdSetObjAlias)<a class="headerlink" href="#alias-cmdsetobjalias" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> adding permanent aliases for object
|
||
|
||
Usage:
|
||
alias <obj> [= [alias[,alias,alias,...]]]
|
||
alias <obj> =
|
||
alias/category <obj> = [alias[,alias,...]:<category>
|
||
|
||
Switches:
|
||
category - requires ending input with :category, to store the
|
||
given aliases with the given category.
|
||
|
||
Assigns aliases to an object so it can be referenced by more
|
||
than one name. Assign empty to remove all aliases from object. If
|
||
assigning a category, all aliases given will be using this category.
|
||
|
||
Observe that this is not the same thing as personal aliases
|
||
created with the 'nick' command! Aliases set with alias are
|
||
changing the object in question, making those aliases usable
|
||
by everyone.
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>alias</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>setobjalias</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(setobjalias) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdSetObjAlias</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="cmdsets-cmdlistcmdsets">
|
||
<h4>cmdsets (CmdListCmdSets)<a class="headerlink" href="#cmdsets-cmdlistcmdsets" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nb">list</span> <span class="n">command</span> <span class="n">sets</span> <span class="n">defined</span> <span class="n">on</span> <span class="n">an</span> <span class="nb">object</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">cmdsets</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span>
|
||
|
||
<span class="n">This</span> <span class="n">displays</span> <span class="nb">all</span> <span class="n">cmdsets</span> <span class="n">assigned</span>
|
||
<span class="n">to</span> <span class="n">a</span> <span class="n">user</span><span class="o">.</span> <span class="n">Defaults</span> <span class="n">to</span> <span class="n">yourself</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>cmdsets</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>listcmsets</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(listcmdsets) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdListCmdSets</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="command-objmanipcommand">
|
||
<h4>command (ObjManipCommand)<a class="headerlink" href="#command-objmanipcommand" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">parent</span> <span class="k">class</span> <span class="nc">for</span> <span class="n">some</span> <span class="n">of</span> <span class="n">the</span> <span class="n">defining</span> <span class="n">objmanip</span> <span class="n">commands</span>
|
||
<span class="n">since</span> <span class="n">they</span> <span class="n">tend</span> <span class="n">to</span> <span class="n">have</span> <span class="n">some</span> <span class="n">more</span> <span class="n">variables</span> <span class="n">to</span> <span class="n">define</span> <span class="n">new</span> <span class="n">objects</span><span class="o">.</span>
|
||
|
||
<span class="n">Each</span> <span class="nb">object</span> <span class="n">definition</span> <span class="n">can</span> <span class="n">have</span> <span class="n">several</span> <span class="n">components</span><span class="o">.</span> <span class="n">First</span> <span class="ow">is</span>
|
||
<span class="n">always</span> <span class="n">a</span> <span class="n">name</span><span class="p">,</span> <span class="n">followed</span> <span class="n">by</span> <span class="n">an</span> <span class="n">optional</span> <span class="n">alias</span> <span class="nb">list</span> <span class="ow">and</span> <span class="k">finally</span> <span class="n">an</span>
|
||
<span class="n">some</span> <span class="n">optional</span> <span class="n">data</span><span class="p">,</span> <span class="n">such</span> <span class="k">as</span> <span class="n">a</span> <span class="n">typeclass</span> <span class="ow">or</span> <span class="n">a</span> <span class="n">location</span><span class="o">.</span> <span class="n">A</span> <span class="n">comma</span> <span class="s1">','</span>
|
||
<span class="n">separates</span> <span class="n">different</span> <span class="n">objects</span><span class="o">.</span> <span class="n">Like</span> <span class="n">this</span><span class="p">:</span>
|
||
|
||
<span class="n">name1</span><span class="p">;</span><span class="n">alias</span><span class="p">;</span><span class="n">alias</span><span class="p">;</span><span class="n">alias</span><span class="p">:</span><span class="n">option</span><span class="p">,</span> <span class="n">name2</span><span class="p">;</span><span class="n">alias</span><span class="p">;</span><span class="n">alias</span> <span class="o">...</span>
|
||
|
||
<span class="n">Spaces</span> <span class="n">between</span> <span class="nb">all</span> <span class="n">components</span> <span class="n">are</span> <span class="n">stripped</span><span class="o">.</span>
|
||
|
||
<span class="n">A</span> <span class="n">second</span> <span class="n">situation</span> <span class="ow">is</span> <span class="n">attribute</span> <span class="n">manipulation</span><span class="o">.</span> <span class="n">Such</span> <span class="n">commands</span>
|
||
<span class="n">are</span> <span class="n">simpler</span> <span class="ow">and</span> <span class="n">offer</span> <span class="n">combinations</span>
|
||
|
||
<span class="n">objname</span><span class="o">/</span><span class="n">attr</span><span class="o">/</span><span class="n">attr</span><span class="o">/</span><span class="n">attr</span><span class="p">,</span> <span class="n">objname</span><span class="o">/</span><span class="n">attr</span><span class="p">,</span> <span class="o">...</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>command</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">ObjManipCommand</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘<Unknown>’</em> of class <code class="docutils literal notranslate"><span class="pre"><Unknown></span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/"></a>.</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="copy-cmdcopy">
|
||
<h4>copy (CmdCopy)<a class="headerlink" href="#copy-cmdcopy" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">copy</span> <span class="n">an</span> <span class="nb">object</span> <span class="ow">and</span> <span class="n">its</span> <span class="n">properties</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">copy</span><span class="p">[</span><span class="o">/</span><span class="n">reset</span><span class="p">]</span> <span class="o"><</span><span class="n">original</span> <span class="n">obj</span><span class="o">></span> <span class="p">[</span><span class="o">=</span> <span class="o"><</span><span class="n">new_name</span><span class="o">></span><span class="p">][;</span><span class="n">alias</span><span class="p">;</span><span class="n">alias</span><span class="o">..</span><span class="p">]</span>
|
||
<span class="p">[:</span><span class="o"><</span><span class="n">new_location</span><span class="o">></span><span class="p">]</span> <span class="p">[,</span><span class="o"><</span><span class="n">new_name2</span><span class="o">></span> <span class="o">...</span><span class="p">]</span>
|
||
|
||
<span class="n">switch</span><span class="p">:</span>
|
||
<span class="n">reset</span> <span class="o">-</span> <span class="n">make</span> <span class="n">a</span> <span class="s1">'clean'</span> <span class="n">copy</span> <span class="n">off</span> <span class="n">the</span> <span class="nb">object</span><span class="p">,</span> <span class="n">thus</span>
|
||
<span class="n">removing</span> <span class="nb">any</span> <span class="n">changes</span> <span class="n">that</span> <span class="n">might</span> <span class="n">have</span> <span class="n">been</span> <span class="n">made</span> <span class="n">to</span> <span class="n">the</span> <span class="n">original</span>
|
||
<span class="n">since</span> <span class="n">it</span> <span class="n">was</span> <span class="n">first</span> <span class="n">created</span><span class="o">.</span>
|
||
|
||
<span class="n">Create</span> <span class="n">one</span> <span class="ow">or</span> <span class="n">more</span> <span class="n">copies</span> <span class="n">of</span> <span class="n">an</span> <span class="nb">object</span><span class="o">.</span> <span class="n">If</span> <span class="n">you</span> <span class="n">don</span><span class="s1">'t supply any targets,</span>
|
||
<span class="n">one</span> <span class="n">exact</span> <span class="n">copy</span> <span class="n">of</span> <span class="n">the</span> <span class="n">original</span> <span class="nb">object</span> <span class="n">will</span> <span class="n">be</span> <span class="n">created</span> <span class="k">with</span> <span class="n">the</span> <span class="n">name</span> <span class="o">*</span><span class="n">_copy</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>copy</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(copy) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdCopy</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="cpattr-cmdcpattr">
|
||
<h4>cpattr (CmdCpAttr)<a class="headerlink" href="#cpattr-cmdcpattr" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">copy</span> <span class="n">attributes</span> <span class="n">between</span> <span class="n">objects</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">cpattr</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">obj</span><span class="o">>/<</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">obj1</span><span class="o">>/<</span><span class="n">attr1</span><span class="o">></span> <span class="p">[,</span><span class="o"><</span><span class="n">obj2</span><span class="o">>/<</span><span class="n">attr2</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">obj3</span><span class="o">>/<</span><span class="n">attr3</span><span class="o">></span><span class="p">,</span><span class="o">...</span><span class="p">]</span>
|
||
<span class="n">cpattr</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">obj</span><span class="o">>/<</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">obj1</span><span class="o">></span> <span class="p">[,</span><span class="o"><</span><span class="n">obj2</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">obj3</span><span class="o">></span><span class="p">,</span><span class="o">...</span><span class="p">]</span>
|
||
<span class="n">cpattr</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">obj1</span><span class="o">>/<</span><span class="n">attr1</span><span class="o">></span> <span class="p">[,</span><span class="o"><</span><span class="n">obj2</span><span class="o">>/<</span><span class="n">attr2</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">obj3</span><span class="o">>/<</span><span class="n">attr3</span><span class="o">></span><span class="p">,</span><span class="o">...</span><span class="p">]</span>
|
||
<span class="n">cpattr</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">obj1</span><span class="o">></span><span class="p">[,</span><span class="o"><</span><span class="n">obj2</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">obj3</span><span class="o">></span><span class="p">,</span><span class="o">...</span><span class="p">]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">move</span> <span class="o">-</span> <span class="n">delete</span> <span class="n">the</span> <span class="n">attribute</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">source</span> <span class="nb">object</span> <span class="n">after</span> <span class="n">copying</span><span class="o">.</span>
|
||
|
||
<span class="n">Example</span><span class="p">:</span>
|
||
<span class="n">cpattr</span> <span class="n">coolness</span> <span class="o">=</span> <span class="n">Anna</span><span class="o">/</span><span class="n">chillout</span><span class="p">,</span> <span class="n">Anna</span><span class="o">/</span><span class="n">nicety</span><span class="p">,</span> <span class="n">Tom</span><span class="o">/</span><span class="n">nicety</span>
|
||
<span class="o">-></span>
|
||
<span class="n">copies</span> <span class="n">the</span> <span class="n">coolness</span> <span class="n">attribute</span> <span class="p">(</span><span class="n">defined</span> <span class="n">on</span> <span class="n">yourself</span><span class="p">),</span> <span class="n">to</span> <span class="n">attributes</span>
|
||
<span class="n">on</span> <span class="n">Anna</span> <span class="ow">and</span> <span class="n">Tom</span><span class="o">.</span>
|
||
|
||
<span class="n">Copy</span> <span class="n">the</span> <span class="n">attribute</span> <span class="n">one</span> <span class="nb">object</span> <span class="n">to</span> <span class="n">one</span> <span class="ow">or</span> <span class="n">more</span> <span class="n">attributes</span> <span class="n">on</span> <span class="n">another</span> <span class="nb">object</span><span class="o">.</span>
|
||
<span class="n">If</span> <span class="n">you</span> <span class="n">don</span><span class="s1">'t supply a source object, yourself is used.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>cpattr</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(cpattr) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdCpAttr</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="create-cmdcreate">
|
||
<h4>create (CmdCreate)<a class="headerlink" href="#create-cmdcreate" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">create</span> <span class="n">new</span> <span class="n">objects</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">create</span><span class="p">[</span><span class="o">/</span><span class="n">drop</span><span class="p">]</span> <span class="o"><</span><span class="n">objname</span><span class="o">></span><span class="p">[;</span><span class="n">alias</span><span class="p">;</span><span class="n">alias</span><span class="o">...</span><span class="p">][:</span><span class="n">typeclass</span><span class="p">],</span> <span class="o"><</span><span class="n">objname</span><span class="o">>...</span>
|
||
|
||
<span class="n">switch</span><span class="p">:</span>
|
||
<span class="n">drop</span> <span class="o">-</span> <span class="n">automatically</span> <span class="n">drop</span> <span class="n">the</span> <span class="n">new</span> <span class="nb">object</span> <span class="n">into</span> <span class="n">your</span> <span class="n">current</span>
|
||
<span class="n">location</span> <span class="p">(</span><span class="n">this</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">echoed</span><span class="p">)</span><span class="o">.</span> <span class="n">This</span> <span class="n">also</span> <span class="n">sets</span> <span class="n">the</span> <span class="n">new</span>
|
||
<span class="nb">object</span><span class="s1">'s home to the current location rather than to you.</span>
|
||
|
||
<span class="n">Creates</span> <span class="n">one</span> <span class="ow">or</span> <span class="n">more</span> <span class="n">new</span> <span class="n">objects</span><span class="o">.</span> <span class="n">If</span> <span class="n">typeclass</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">the</span> <span class="nb">object</span>
|
||
<span class="ow">is</span> <span class="n">created</span> <span class="k">as</span> <span class="n">a</span> <span class="n">child</span> <span class="n">of</span> <span class="n">this</span> <span class="n">typeclass</span><span class="o">.</span> <span class="n">The</span> <span class="n">typeclass</span> <span class="n">script</span> <span class="ow">is</span>
|
||
<span class="n">assumed</span> <span class="n">to</span> <span class="n">be</span> <span class="n">located</span> <span class="n">under</span> <span class="n">types</span><span class="o">/</span> <span class="ow">and</span> <span class="nb">any</span> <span class="n">further</span>
|
||
<span class="n">directory</span> <span class="n">structure</span> <span class="ow">is</span> <span class="n">given</span> <span class="ow">in</span> <span class="n">Python</span> <span class="n">notation</span><span class="o">.</span> <span class="n">So</span> <span class="k">if</span> <span class="n">you</span> <span class="n">have</span> <span class="n">a</span>
|
||
<span class="n">correct</span> <span class="n">typeclass</span> <span class="s1">'RedButton'</span> <span class="n">defined</span> <span class="ow">in</span>
|
||
<span class="n">types</span><span class="o">/</span><span class="n">examples</span><span class="o">/</span><span class="n">red_button</span><span class="o">.</span><span class="n">py</span><span class="p">,</span> <span class="n">you</span> <span class="n">could</span> <span class="n">create</span> <span class="n">a</span> <span class="n">new</span>
|
||
<span class="nb">object</span> <span class="n">of</span> <span class="n">this</span> <span class="nb">type</span> <span class="n">like</span> <span class="n">this</span><span class="p">:</span>
|
||
|
||
<span class="n">create</span><span class="o">/</span><span class="n">drop</span> <span class="n">button</span><span class="p">;</span><span class="n">red</span> <span class="p">:</span> <span class="n">examples</span><span class="o">.</span><span class="n">red_button</span><span class="o">.</span><span class="n">RedButton</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>create</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(create) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdCreate</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="desc-cmddesc">
|
||
<h4>desc (CmdDesc)<a class="headerlink" href="#desc-cmddesc" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">describe</span> <span class="n">an</span> <span class="nb">object</span> <span class="ow">or</span> <span class="n">the</span> <span class="n">current</span> <span class="n">room</span><span class="o">.</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">desc</span> <span class="p">[</span><span class="o"><</span><span class="n">obj</span><span class="o">></span> <span class="o">=</span><span class="p">]</span> <span class="o"><</span><span class="n">description</span><span class="o">></span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">edit</span> <span class="o">-</span> <span class="n">Open</span> <span class="n">up</span> <span class="n">a</span> <span class="n">line</span> <span class="n">editor</span> <span class="k">for</span> <span class="n">more</span> <span class="n">advanced</span> <span class="n">editing</span><span class="o">.</span>
|
||
|
||
<span class="n">Sets</span> <span class="n">the</span> <span class="s2">"desc"</span> <span class="n">attribute</span> <span class="n">on</span> <span class="n">an</span> <span class="nb">object</span><span class="o">.</span> <span class="n">If</span> <span class="n">an</span> <span class="nb">object</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">given</span><span class="p">,</span>
|
||
<span class="n">describe</span> <span class="n">the</span> <span class="n">current</span> <span class="n">room</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>desc</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>describe</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(desc) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdDesc</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="destroy-cmddestroy">
|
||
<h4>destroy (CmdDestroy)<a class="headerlink" href="#destroy-cmddestroy" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">permanently</span> <span class="n">delete</span> <span class="n">objects</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">destroy</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="p">[</span><span class="n">obj</span><span class="p">,</span> <span class="n">obj2</span><span class="p">,</span> <span class="n">obj3</span><span class="p">,</span> <span class="p">[</span><span class="n">dbref</span><span class="o">-</span><span class="n">dbref</span><span class="p">],</span> <span class="o">...</span><span class="p">]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">override</span> <span class="o">-</span> <span class="n">The</span> <span class="n">destroy</span> <span class="n">command</span> <span class="n">will</span> <span class="n">usually</span> <span class="n">avoid</span> <span class="n">accidentally</span>
|
||
<span class="n">destroying</span> <span class="n">account</span> <span class="n">objects</span><span class="o">.</span> <span class="n">This</span> <span class="n">switch</span> <span class="n">overrides</span> <span class="n">this</span> <span class="n">safety</span><span class="o">.</span>
|
||
<span class="n">force</span> <span class="o">-</span> <span class="n">destroy</span> <span class="n">without</span> <span class="n">confirmation</span><span class="o">.</span>
|
||
<span class="n">Examples</span><span class="p">:</span>
|
||
<span class="n">destroy</span> <span class="n">house</span><span class="p">,</span> <span class="n">roof</span><span class="p">,</span> <span class="n">door</span><span class="p">,</span> <span class="mi">44</span><span class="o">-</span><span class="mi">78</span>
|
||
<span class="n">destroy</span> <span class="mi">5</span><span class="o">-</span><span class="mi">10</span><span class="p">,</span> <span class="n">flower</span><span class="p">,</span> <span class="mi">45</span>
|
||
<span class="n">destroy</span><span class="o">/</span><span class="n">force</span> <span class="n">north</span>
|
||
|
||
<span class="n">Destroys</span> <span class="n">one</span> <span class="ow">or</span> <span class="n">many</span> <span class="n">objects</span><span class="o">.</span> <span class="n">If</span> <span class="n">dbrefs</span> <span class="n">are</span> <span class="n">used</span><span class="p">,</span> <span class="n">a</span> <span class="nb">range</span> <span class="n">to</span> <span class="n">delete</span> <span class="n">can</span> <span class="n">be</span>
|
||
<span class="n">given</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="mi">4</span><span class="o">-</span><span class="mf">10.</span> <span class="n">Also</span> <span class="n">the</span> <span class="n">end</span> <span class="n">points</span> <span class="n">will</span> <span class="n">be</span> <span class="n">deleted</span><span class="o">.</span> <span class="n">This</span> <span class="n">command</span>
|
||
<span class="n">displays</span> <span class="n">a</span> <span class="n">confirmation</span> <span class="n">before</span> <span class="n">destroying</span><span class="p">,</span> <span class="n">to</span> <span class="n">make</span> <span class="n">sure</span> <span class="n">of</span> <span class="n">your</span> <span class="n">choice</span><span class="o">.</span>
|
||
<span class="n">You</span> <span class="n">can</span> <span class="n">specify</span> <span class="n">the</span> <span class="o">/</span><span class="n">force</span> <span class="n">switch</span> <span class="n">to</span> <span class="n">bypass</span> <span class="n">this</span> <span class="n">confirmation</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>destroy</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>del</em>, <em>delete</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(destroy) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdDestroy</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="dig-cmddig">
|
||
<h4>dig (CmdDig)<a class="headerlink" href="#dig-cmddig" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">build</span> <span class="n">new</span> <span class="n">rooms</span> <span class="ow">and</span> <span class="n">connect</span> <span class="n">them</span> <span class="n">to</span> <span class="n">the</span> <span class="n">current</span> <span class="n">location</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">dig</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="o"><</span><span class="n">roomname</span><span class="o">></span><span class="p">[;</span><span class="n">alias</span><span class="p">;</span><span class="n">alias</span><span class="o">...</span><span class="p">][:</span><span class="n">typeclass</span><span class="p">]</span>
|
||
<span class="p">[</span><span class="o">=</span> <span class="o"><</span><span class="n">exit_to_there</span><span class="o">></span><span class="p">[;</span><span class="n">alias</span><span class="p">][:</span><span class="n">typeclass</span><span class="p">]]</span>
|
||
<span class="p">[,</span> <span class="o"><</span><span class="n">exit_to_here</span><span class="o">></span><span class="p">[;</span><span class="n">alias</span><span class="p">][:</span><span class="n">typeclass</span><span class="p">]]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">tel</span> <span class="ow">or</span> <span class="n">teleport</span> <span class="o">-</span> <span class="n">move</span> <span class="n">yourself</span> <span class="n">to</span> <span class="n">the</span> <span class="n">new</span> <span class="n">room</span>
|
||
|
||
<span class="n">Examples</span><span class="p">:</span>
|
||
<span class="n">dig</span> <span class="n">kitchen</span> <span class="o">=</span> <span class="n">north</span><span class="p">;</span><span class="n">n</span><span class="p">,</span> <span class="n">south</span><span class="p">;</span><span class="n">s</span>
|
||
<span class="n">dig</span> <span class="n">house</span><span class="p">:</span><span class="n">myrooms</span><span class="o">.</span><span class="n">MyHouseTypeclass</span>
|
||
<span class="n">dig</span> <span class="n">sheer</span> <span class="n">cliff</span><span class="p">;</span><span class="n">cliff</span><span class="p">;</span><span class="n">sheer</span> <span class="o">=</span> <span class="n">climb</span> <span class="n">up</span><span class="p">,</span> <span class="n">climb</span> <span class="n">down</span>
|
||
|
||
<span class="n">This</span> <span class="n">command</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">convenient</span> <span class="n">way</span> <span class="n">to</span> <span class="n">build</span> <span class="n">rooms</span> <span class="n">quickly</span><span class="p">;</span> <span class="n">it</span> <span class="n">creates</span> <span class="n">the</span>
|
||
<span class="n">new</span> <span class="n">room</span> <span class="ow">and</span> <span class="n">you</span> <span class="n">can</span> <span class="n">optionally</span> <span class="nb">set</span> <span class="n">up</span> <span class="n">exits</span> <span class="n">back</span> <span class="ow">and</span> <span class="n">forth</span> <span class="n">between</span> <span class="n">your</span>
|
||
<span class="n">current</span> <span class="n">room</span> <span class="ow">and</span> <span class="n">the</span> <span class="n">new</span> <span class="n">one</span><span class="o">.</span> <span class="n">You</span> <span class="n">can</span> <span class="n">add</span> <span class="k">as</span> <span class="n">many</span> <span class="n">aliases</span> <span class="k">as</span> <span class="n">you</span>
|
||
<span class="n">like</span> <span class="n">to</span> <span class="n">the</span> <span class="n">name</span> <span class="n">of</span> <span class="n">the</span> <span class="n">room</span> <span class="ow">and</span> <span class="n">the</span> <span class="n">exits</span> <span class="ow">in</span> <span class="n">question</span><span class="p">;</span> <span class="n">an</span> <span class="n">example</span>
|
||
<span class="n">would</span> <span class="n">be</span> <span class="s1">'north;no;n'</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>dig</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(dig) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdDig</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="examine-cmdexamine">
|
||
<h4>examine (CmdExamine)<a class="headerlink" href="#examine-cmdexamine" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">get</span> <span class="n">detailed</span> <span class="n">information</span> <span class="n">about</span> <span class="n">an</span> <span class="nb">object</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">examine</span> <span class="p">[</span><span class="o"><</span><span class="nb">object</span><span class="o">></span><span class="p">[</span><span class="o">/</span><span class="n">attrname</span><span class="p">]]</span>
|
||
<span class="n">examine</span> <span class="p">[</span><span class="o">*<</span><span class="n">account</span><span class="o">></span><span class="p">[</span><span class="o">/</span><span class="n">attrname</span><span class="p">]]</span>
|
||
|
||
<span class="n">Switch</span><span class="p">:</span>
|
||
<span class="n">account</span> <span class="o">-</span> <span class="n">examine</span> <span class="n">an</span> <span class="n">Account</span> <span class="p">(</span><span class="n">same</span> <span class="k">as</span> <span class="n">adding</span> <span class="o">*</span><span class="p">)</span>
|
||
<span class="nb">object</span> <span class="o">-</span> <span class="n">examine</span> <span class="n">an</span> <span class="n">Object</span> <span class="p">(</span><span class="n">useful</span> <span class="n">when</span> <span class="n">OOC</span><span class="p">)</span>
|
||
|
||
<span class="n">The</span> <span class="n">examine</span> <span class="n">command</span> <span class="n">shows</span> <span class="n">detailed</span> <span class="n">game</span> <span class="n">info</span> <span class="n">about</span> <span class="n">an</span>
|
||
<span class="nb">object</span> <span class="ow">and</span> <span class="n">optionally</span> <span class="n">a</span> <span class="n">specific</span> <span class="n">attribute</span> <span class="n">on</span> <span class="n">it</span><span class="o">.</span>
|
||
<span class="n">If</span> <span class="nb">object</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">specified</span><span class="p">,</span> <span class="n">the</span> <span class="n">current</span> <span class="n">location</span> <span class="ow">is</span> <span class="n">examined</span><span class="o">.</span>
|
||
|
||
<span class="n">Append</span> <span class="n">a</span> <span class="o">*</span> <span class="n">before</span> <span class="n">the</span> <span class="n">search</span> <span class="n">string</span> <span class="n">to</span> <span class="n">examine</span> <span class="n">an</span> <span class="n">account</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>examine</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>exam</em>, <em>ex</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(examine) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdExamine</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="find-cmdfind">
|
||
<h4>find (CmdFind)<a class="headerlink" href="#find-cmdfind" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">search</span> <span class="n">the</span> <span class="n">database</span> <span class="k">for</span> <span class="n">objects</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">find</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="o"><</span><span class="n">name</span> <span class="ow">or</span> <span class="n">dbref</span> <span class="ow">or</span> <span class="o">*</span><span class="n">account</span><span class="o">></span> <span class="p">[</span><span class="o">=</span> <span class="n">dbrefmin</span><span class="p">[</span><span class="o">-</span><span class="n">dbrefmax</span><span class="p">]]</span>
|
||
<span class="n">locate</span> <span class="o">-</span> <span class="n">this</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">shorthand</span> <span class="k">for</span> <span class="n">using</span> <span class="n">the</span> <span class="o">/</span><span class="n">loc</span> <span class="n">switch</span><span class="o">.</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">room</span> <span class="o">-</span> <span class="n">only</span> <span class="n">look</span> <span class="k">for</span> <span class="n">rooms</span> <span class="p">(</span><span class="n">location</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
|
||
<span class="n">exit</span> <span class="o">-</span> <span class="n">only</span> <span class="n">look</span> <span class="k">for</span> <span class="n">exits</span> <span class="p">(</span><span class="n">destination</span><span class="o">!=</span><span class="kc">None</span><span class="p">)</span>
|
||
<span class="n">char</span> <span class="o">-</span> <span class="n">only</span> <span class="n">look</span> <span class="k">for</span> <span class="n">characters</span> <span class="p">(</span><span class="n">BASE_CHARACTER_TYPECLASS</span><span class="p">)</span>
|
||
<span class="n">exact</span> <span class="o">-</span> <span class="n">only</span> <span class="n">exact</span> <span class="n">matches</span> <span class="n">are</span> <span class="n">returned</span><span class="o">.</span>
|
||
<span class="n">loc</span> <span class="o">-</span> <span class="n">display</span> <span class="nb">object</span> <span class="n">location</span> <span class="k">if</span> <span class="n">exists</span> <span class="ow">and</span> <span class="n">match</span> <span class="n">has</span> <span class="n">one</span> <span class="n">result</span>
|
||
<span class="n">startswith</span> <span class="o">-</span> <span class="n">search</span> <span class="k">for</span> <span class="n">names</span> <span class="n">starting</span> <span class="k">with</span> <span class="n">the</span> <span class="n">string</span><span class="p">,</span> <span class="n">rather</span> <span class="n">than</span> <span class="n">containing</span>
|
||
|
||
<span class="n">Searches</span> <span class="n">the</span> <span class="n">database</span> <span class="k">for</span> <span class="n">an</span> <span class="nb">object</span> <span class="n">of</span> <span class="n">a</span> <span class="n">particular</span> <span class="n">name</span> <span class="ow">or</span> <span class="n">exact</span> <span class="c1">#dbref.</span>
|
||
<span class="n">Use</span> <span class="o">*</span><span class="n">accountname</span> <span class="n">to</span> <span class="n">search</span> <span class="k">for</span> <span class="n">an</span> <span class="n">account</span><span class="o">.</span> <span class="n">The</span> <span class="n">switches</span> <span class="n">allows</span> <span class="k">for</span>
|
||
<span class="n">limiting</span> <span class="nb">object</span> <span class="n">matches</span> <span class="n">to</span> <span class="n">certain</span> <span class="n">game</span> <span class="n">entities</span><span class="o">.</span> <span class="n">Dbrefmin</span> <span class="ow">and</span> <span class="n">dbrefmax</span>
|
||
<span class="n">limits</span> <span class="n">matches</span> <span class="n">to</span> <span class="n">within</span> <span class="n">the</span> <span class="n">given</span> <span class="n">dbrefs</span> <span class="nb">range</span><span class="p">,</span> <span class="ow">or</span> <span class="n">above</span><span class="o">/</span><span class="n">below</span> <span class="k">if</span> <span class="n">only</span>
|
||
<span class="n">one</span> <span class="ow">is</span> <span class="n">given</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>find</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>locate</em>, <em>search</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(find) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdFind</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="link-cmdlink">
|
||
<h4>link (CmdLink)<a class="headerlink" href="#link-cmdlink" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">link</span> <span class="n">existing</span> <span class="n">rooms</span> <span class="n">together</span> <span class="k">with</span> <span class="n">exits</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">link</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">target</span><span class="o">></span>
|
||
<span class="n">link</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span> <span class="o">=</span>
|
||
<span class="n">link</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span>
|
||
|
||
<span class="n">Switch</span><span class="p">:</span>
|
||
<span class="n">twoway</span> <span class="o">-</span> <span class="n">connect</span> <span class="n">two</span> <span class="n">exits</span><span class="o">.</span> <span class="n">For</span> <span class="n">this</span> <span class="n">to</span> <span class="n">work</span><span class="p">,</span> <span class="n">BOTH</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span>
|
||
<span class="ow">and</span> <span class="o"><</span><span class="n">target</span><span class="o">></span> <span class="n">must</span> <span class="n">be</span> <span class="n">exit</span> <span class="n">objects</span><span class="o">.</span>
|
||
|
||
<span class="n">If</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span> <span class="ow">is</span> <span class="n">an</span> <span class="n">exit</span><span class="p">,</span> <span class="nb">set</span> <span class="n">its</span> <span class="n">destination</span> <span class="n">to</span> <span class="o"><</span><span class="n">target</span><span class="o">>.</span> <span class="n">Two</span><span class="o">-</span><span class="n">way</span> <span class="n">operation</span>
|
||
<span class="n">instead</span> <span class="n">sets</span> <span class="n">the</span> <span class="n">destination</span> <span class="n">to</span> <span class="n">the</span> <span class="o">*</span><span class="n">locations</span><span class="o">*</span> <span class="n">of</span> <span class="n">the</span> <span class="n">respective</span> <span class="n">given</span>
|
||
<span class="n">arguments</span><span class="o">.</span>
|
||
<span class="n">The</span> <span class="n">second</span> <span class="n">form</span> <span class="p">(</span><span class="n">a</span> <span class="n">lone</span> <span class="o">=</span><span class="p">)</span> <span class="n">sets</span> <span class="n">the</span> <span class="n">destination</span> <span class="n">to</span> <span class="kc">None</span> <span class="p">(</span><span class="n">same</span> <span class="k">as</span>
|
||
<span class="n">the</span> <span class="n">unlink</span> <span class="n">command</span><span class="p">)</span> <span class="ow">and</span> <span class="n">the</span> <span class="n">third</span> <span class="n">form</span> <span class="p">(</span><span class="n">without</span> <span class="o">=</span><span class="p">)</span> <span class="n">just</span> <span class="n">shows</span> <span class="n">the</span>
|
||
<span class="n">currently</span> <span class="nb">set</span> <span class="n">destination</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>link</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(link) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdLink</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="lock-cmdlock">
|
||
<h4>lock (CmdLock)<a class="headerlink" href="#lock-cmdlock" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">assign</span> <span class="n">a</span> <span class="n">lock</span> <span class="n">definition</span> <span class="n">to</span> <span class="n">an</span> <span class="nb">object</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">lock</span> <span class="o"><</span><span class="nb">object</span> <span class="ow">or</span> <span class="o">*</span><span class="n">account</span><span class="o">></span><span class="p">[</span> <span class="o">=</span> <span class="o"><</span><span class="n">lockstring</span><span class="o">></span><span class="p">]</span>
|
||
<span class="ow">or</span>
|
||
<span class="n">lock</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="nb">object</span> <span class="ow">or</span> <span class="o">*</span><span class="n">account</span><span class="o">>/<</span><span class="n">access_type</span><span class="o">></span>
|
||
|
||
<span class="n">Switch</span><span class="p">:</span>
|
||
<span class="k">del</span> <span class="o">-</span> <span class="n">delete</span> <span class="n">given</span> <span class="n">access</span> <span class="nb">type</span>
|
||
<span class="n">view</span> <span class="o">-</span> <span class="n">view</span> <span class="n">lock</span> <span class="n">associated</span> <span class="k">with</span> <span class="n">given</span> <span class="n">access</span> <span class="nb">type</span> <span class="p">(</span><span class="n">default</span><span class="p">)</span>
|
||
|
||
<span class="n">If</span> <span class="n">no</span> <span class="n">lockstring</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">shows</span> <span class="nb">all</span> <span class="n">locks</span> <span class="n">on</span>
|
||
<span class="nb">object</span><span class="o">.</span>
|
||
|
||
<span class="n">Lockstring</span> <span class="ow">is</span> <span class="n">of</span> <span class="n">the</span> <span class="n">form</span>
|
||
<span class="n">access_type</span><span class="p">:[</span><span class="n">NOT</span><span class="p">]</span> <span class="n">func1</span><span class="p">(</span><span class="n">args</span><span class="p">)[</span> <span class="n">AND</span><span class="o">|</span><span class="n">OR</span><span class="p">][</span> <span class="n">NOT</span><span class="p">]</span> <span class="n">func2</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">...</span><span class="p">]</span>
|
||
<span class="n">Where</span> <span class="n">func1</span><span class="p">,</span> <span class="n">func2</span> <span class="o">...</span> <span class="n">valid</span> <span class="n">lockfuncs</span> <span class="k">with</span> <span class="ow">or</span> <span class="n">without</span> <span class="n">arguments</span><span class="o">.</span>
|
||
<span class="n">Separator</span> <span class="n">expressions</span> <span class="n">need</span> <span class="ow">not</span> <span class="n">be</span> <span class="n">capitalized</span><span class="o">.</span>
|
||
|
||
<span class="n">For</span> <span class="n">example</span><span class="p">:</span>
|
||
<span class="s1">'get: id(25) or perm(Admin)'</span>
|
||
<span class="n">The</span> <span class="s1">'get'</span> <span class="n">lock</span> <span class="n">access_type</span> <span class="ow">is</span> <span class="n">checked</span> <span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="n">by</span> <span class="n">the</span> <span class="s1">'get'</span> <span class="n">command</span><span class="o">.</span>
|
||
<span class="n">An</span> <span class="nb">object</span> <span class="n">locked</span> <span class="k">with</span> <span class="n">this</span> <span class="n">example</span> <span class="n">lock</span> <span class="n">will</span> <span class="n">only</span> <span class="n">be</span> <span class="n">possible</span> <span class="n">to</span> <span class="n">pick</span> <span class="n">up</span>
|
||
<span class="n">by</span> <span class="n">Admins</span> <span class="ow">or</span> <span class="n">by</span> <span class="n">an</span> <span class="nb">object</span> <span class="k">with</span> <span class="nb">id</span><span class="o">=</span><span class="mf">25.</span>
|
||
|
||
<span class="n">You</span> <span class="n">can</span> <span class="n">add</span> <span class="n">several</span> <span class="n">access_types</span> <span class="n">after</span> <span class="n">one</span> <span class="n">another</span> <span class="n">by</span> <span class="n">separating</span>
|
||
<span class="n">them</span> <span class="n">by</span> <span class="s1">';'</span><span class="p">,</span> <span class="n">i</span><span class="o">.</span><span class="n">e</span><span class="p">:</span>
|
||
<span class="s1">'get:id(25); delete:perm(Builder)'</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>lock</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>locks</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd: perm(locks) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdLock</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="mvattr-cmdmvattr">
|
||
<h4>mvattr (CmdMvAttr)<a class="headerlink" href="#mvattr-cmdmvattr" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">move</span> <span class="n">attributes</span> <span class="n">between</span> <span class="n">objects</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">mvattr</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">obj</span><span class="o">>/<</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">obj1</span><span class="o">>/<</span><span class="n">attr1</span><span class="o">></span> <span class="p">[,</span><span class="o"><</span><span class="n">obj2</span><span class="o">>/<</span><span class="n">attr2</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">obj3</span><span class="o">>/<</span><span class="n">attr3</span><span class="o">></span><span class="p">,</span><span class="o">...</span><span class="p">]</span>
|
||
<span class="n">mvattr</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">obj</span><span class="o">>/<</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">obj1</span><span class="o">></span> <span class="p">[,</span><span class="o"><</span><span class="n">obj2</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">obj3</span><span class="o">></span><span class="p">,</span><span class="o">...</span><span class="p">]</span>
|
||
<span class="n">mvattr</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">obj1</span><span class="o">>/<</span><span class="n">attr1</span><span class="o">></span> <span class="p">[,</span><span class="o"><</span><span class="n">obj2</span><span class="o">>/<</span><span class="n">attr2</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">obj3</span><span class="o">>/<</span><span class="n">attr3</span><span class="o">></span><span class="p">,</span><span class="o">...</span><span class="p">]</span>
|
||
<span class="n">mvattr</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">obj1</span><span class="o">></span><span class="p">[,</span><span class="o"><</span><span class="n">obj2</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">obj3</span><span class="o">></span><span class="p">,</span><span class="o">...</span><span class="p">]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">copy</span> <span class="o">-</span> <span class="n">Don</span><span class="s1">'t delete the original after moving.</span>
|
||
|
||
<span class="n">Move</span> <span class="n">an</span> <span class="n">attribute</span> <span class="kn">from</span> <span class="nn">one</span> <span class="nb">object</span> <span class="n">to</span> <span class="n">one</span> <span class="ow">or</span> <span class="n">more</span> <span class="n">attributes</span> <span class="n">on</span> <span class="n">another</span>
|
||
<span class="nb">object</span><span class="o">.</span> <span class="n">If</span> <span class="n">you</span> <span class="n">don</span><span class="s1">'t supply a source object, yourself is used.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>mvattr</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(mvattr) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdMvAttr</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="name-cmdname">
|
||
<h4>name (CmdName)<a class="headerlink" href="#name-cmdname" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">change</span> <span class="n">the</span> <span class="n">name</span> <span class="ow">and</span><span class="o">/</span><span class="ow">or</span> <span class="n">aliases</span> <span class="n">of</span> <span class="n">an</span> <span class="nb">object</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">name</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">newname</span><span class="o">></span><span class="p">;</span><span class="n">alias1</span><span class="p">;</span><span class="n">alias2</span>
|
||
|
||
<span class="n">Rename</span> <span class="n">an</span> <span class="nb">object</span> <span class="n">to</span> <span class="n">something</span> <span class="n">new</span><span class="o">.</span> <span class="n">Use</span> <span class="o">*</span><span class="n">obj</span> <span class="n">to</span>
|
||
<span class="n">rename</span> <span class="n">an</span> <span class="n">account</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>name</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>rename</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(rename) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdName</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="open-cmdopen">
|
||
<h4>open (CmdOpen)<a class="headerlink" href="#open-cmdopen" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nb">open</span> <span class="n">a</span> <span class="n">new</span> <span class="n">exit</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">current</span> <span class="n">room</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="nb">open</span> <span class="o"><</span><span class="n">new</span> <span class="n">exit</span><span class="o">></span><span class="p">[;</span><span class="n">alias</span><span class="p">;</span><span class="n">alias</span><span class="o">..</span><span class="p">][:</span><span class="n">typeclass</span><span class="p">]</span> <span class="p">[,</span><span class="o"><</span><span class="k">return</span> <span class="n">exit</span><span class="o">></span><span class="p">[;</span><span class="n">alias</span><span class="p">;</span><span class="o">..</span><span class="p">][:</span><span class="n">typeclass</span><span class="p">]]]</span> <span class="o">=</span>
|
||
<span class="o"><</span><span class="n">destination</span><span class="o">></span>
|
||
|
||
<span class="n">Handles</span> <span class="n">the</span> <span class="n">creation</span> <span class="n">of</span> <span class="n">exits</span><span class="o">.</span> <span class="n">If</span> <span class="n">a</span> <span class="n">destination</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">the</span> <span class="n">exit</span>
|
||
<span class="n">will</span> <span class="n">point</span> <span class="n">there</span><span class="o">.</span> <span class="n">The</span> <span class="o"><</span><span class="k">return</span> <span class="n">exit</span><span class="o">></span> <span class="n">argument</span> <span class="n">sets</span> <span class="n">up</span> <span class="n">an</span> <span class="n">exit</span> <span class="n">at</span> <span class="n">the</span>
|
||
<span class="n">destination</span> <span class="n">leading</span> <span class="n">back</span> <span class="n">to</span> <span class="n">the</span> <span class="n">current</span> <span class="n">room</span><span class="o">.</span> <span class="n">Destination</span> <span class="n">name</span>
|
||
<span class="n">can</span> <span class="n">be</span> <span class="n">given</span> <span class="n">both</span> <span class="k">as</span> <span class="n">a</span> <span class="c1">#dbref and a name, if that name is globally</span>
|
||
<span class="n">unique</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>open</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(open) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdOpen</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="script-cmdscript">
|
||
<h4>script (CmdScript)<a class="headerlink" href="#script-cmdscript" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">attach</span> <span class="n">a</span> <span class="n">script</span> <span class="n">to</span> <span class="n">an</span> <span class="nb">object</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">script</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span> <span class="p">[</span><span class="o">=</span> <span class="n">script_path</span> <span class="ow">or</span> <span class="o"><</span><span class="n">scriptkey</span><span class="o">></span><span class="p">]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">start</span> <span class="o">-</span> <span class="n">start</span> <span class="nb">all</span> <span class="n">non</span><span class="o">-</span><span class="n">running</span> <span class="n">scripts</span> <span class="n">on</span> <span class="nb">object</span><span class="p">,</span> <span class="ow">or</span> <span class="n">a</span> <span class="n">given</span> <span class="n">script</span> <span class="n">only</span>
|
||
<span class="n">stop</span> <span class="o">-</span> <span class="n">stop</span> <span class="nb">all</span> <span class="n">scripts</span> <span class="n">on</span> <span class="n">objects</span><span class="p">,</span> <span class="ow">or</span> <span class="n">a</span> <span class="n">given</span> <span class="n">script</span> <span class="n">only</span>
|
||
|
||
<span class="n">If</span> <span class="n">no</span> <span class="n">script</span> <span class="n">path</span><span class="o">/</span><span class="n">key</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">lists</span> <span class="nb">all</span> <span class="n">scripts</span> <span class="n">active</span> <span class="n">on</span> <span class="n">the</span> <span class="n">given</span>
|
||
<span class="nb">object</span><span class="o">.</span>
|
||
<span class="n">Script</span> <span class="n">path</span> <span class="n">can</span> <span class="n">be</span> <span class="n">given</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">base</span> <span class="n">location</span> <span class="k">for</span> <span class="n">scripts</span> <span class="k">as</span> <span class="n">given</span> <span class="ow">in</span>
|
||
<span class="n">settings</span><span class="o">.</span> <span class="n">If</span> <span class="n">adding</span> <span class="n">a</span> <span class="n">new</span> <span class="n">script</span><span class="p">,</span> <span class="n">it</span> <span class="n">will</span> <span class="n">be</span> <span class="n">started</span> <span class="n">automatically</span>
|
||
<span class="p">(</span><span class="n">no</span> <span class="o">/</span><span class="n">start</span> <span class="n">switch</span> <span class="ow">is</span> <span class="n">needed</span><span class="p">)</span><span class="o">.</span> <span class="n">Using</span> <span class="n">the</span> <span class="o">/</span><span class="n">start</span> <span class="ow">or</span> <span class="o">/</span><span class="n">stop</span> <span class="n">switches</span> <span class="n">on</span> <span class="n">an</span>
|
||
<span class="nb">object</span> <span class="n">without</span> <span class="n">specifying</span> <span class="n">a</span> <span class="n">script</span> <span class="n">key</span><span class="o">/</span><span class="n">path</span> <span class="n">will</span> <span class="n">start</span><span class="o">/</span><span class="n">stop</span> <span class="n">ALL</span> <span class="n">scripts</span> <span class="n">on</span>
|
||
<span class="n">the</span> <span class="nb">object</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>script</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>addscript</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(script) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdScript</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="set-cmdsetattribute">
|
||
<h4>set (CmdSetAttribute)<a class="headerlink" href="#set-cmdsetattribute" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nb">set</span> <span class="n">attribute</span> <span class="n">on</span> <span class="n">an</span> <span class="nb">object</span> <span class="ow">or</span> <span class="n">account</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="nb">set</span> <span class="o"><</span><span class="n">obj</span><span class="o">>/<</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">value</span><span class="o">></span>
|
||
<span class="nb">set</span> <span class="o"><</span><span class="n">obj</span><span class="o">>/<</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span>
|
||
<span class="nb">set</span> <span class="o"><</span><span class="n">obj</span><span class="o">>/<</span><span class="n">attr</span><span class="o">></span>
|
||
<span class="nb">set</span> <span class="o">*<</span><span class="n">account</span><span class="o">>/<</span><span class="n">attr</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">value</span><span class="o">></span>
|
||
|
||
<span class="n">Switch</span><span class="p">:</span>
|
||
<span class="n">edit</span><span class="p">:</span> <span class="n">Open</span> <span class="n">the</span> <span class="n">line</span> <span class="n">editor</span> <span class="p">(</span><span class="n">string</span> <span class="n">values</span> <span class="n">only</span><span class="p">)</span>
|
||
<span class="n">script</span><span class="p">:</span> <span class="n">If</span> <span class="n">we</span><span class="s1">'re trying to set an attribute on a script</span>
|
||
<span class="n">channel</span><span class="p">:</span> <span class="n">If</span> <span class="n">we</span><span class="s1">'re trying to set an attribute on a channel</span>
|
||
<span class="n">account</span><span class="p">:</span> <span class="n">If</span> <span class="n">we</span><span class="s1">'re trying to set an attribute on an account</span>
|
||
<span class="n">room</span><span class="p">:</span> <span class="n">Setting</span> <span class="n">an</span> <span class="n">attribute</span> <span class="n">on</span> <span class="n">a</span> <span class="n">room</span> <span class="p">(</span><span class="k">global</span> <span class="n">search</span><span class="p">)</span>
|
||
<span class="n">exit</span><span class="p">:</span> <span class="n">Setting</span> <span class="n">an</span> <span class="n">attribute</span> <span class="n">on</span> <span class="n">an</span> <span class="n">exit</span> <span class="p">(</span><span class="k">global</span> <span class="n">search</span><span class="p">)</span>
|
||
<span class="n">char</span><span class="p">:</span> <span class="n">Setting</span> <span class="n">an</span> <span class="n">attribute</span> <span class="n">on</span> <span class="n">a</span> <span class="n">character</span> <span class="p">(</span><span class="k">global</span> <span class="n">search</span><span class="p">)</span>
|
||
<span class="n">character</span><span class="p">:</span> <span class="n">Alias</span> <span class="k">for</span> <span class="n">char</span><span class="p">,</span> <span class="k">as</span> <span class="n">above</span><span class="o">.</span>
|
||
|
||
<span class="n">Sets</span> <span class="n">attributes</span> <span class="n">on</span> <span class="n">objects</span><span class="o">.</span> <span class="n">The</span> <span class="n">second</span> <span class="n">example</span> <span class="n">form</span> <span class="n">above</span> <span class="n">clears</span> <span class="n">a</span>
|
||
<span class="n">previously</span> <span class="nb">set</span> <span class="n">attribute</span> <span class="k">while</span> <span class="n">the</span> <span class="n">third</span> <span class="n">form</span> <span class="n">inspects</span> <span class="n">the</span> <span class="n">current</span> <span class="n">value</span> <span class="n">of</span>
|
||
<span class="n">the</span> <span class="n">attribute</span> <span class="p">(</span><span class="k">if</span> <span class="nb">any</span><span class="p">)</span><span class="o">.</span> <span class="n">The</span> <span class="n">last</span> <span class="n">one</span> <span class="p">(</span><span class="k">with</span> <span class="n">the</span> <span class="n">star</span><span class="p">)</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">shortcut</span> <span class="k">for</span>
|
||
<span class="n">operating</span> <span class="n">on</span> <span class="n">a</span> <span class="n">player</span> <span class="n">Account</span> <span class="n">rather</span> <span class="n">than</span> <span class="n">an</span> <span class="n">Object</span><span class="o">.</span>
|
||
|
||
<span class="n">The</span> <span class="n">most</span> <span class="n">common</span> <span class="n">data</span> <span class="n">to</span> <span class="n">save</span> <span class="k">with</span> <span class="n">this</span> <span class="n">command</span> <span class="n">are</span> <span class="n">strings</span> <span class="ow">and</span>
|
||
<span class="n">numbers</span><span class="o">.</span> <span class="n">You</span> <span class="n">can</span> <span class="n">however</span> <span class="n">also</span> <span class="nb">set</span> <span class="n">Python</span> <span class="n">primitives</span> <span class="n">such</span> <span class="k">as</span> <span class="n">lists</span><span class="p">,</span>
|
||
<span class="n">dictionaries</span> <span class="ow">and</span> <span class="n">tuples</span> <span class="n">on</span> <span class="n">objects</span> <span class="p">(</span><span class="n">this</span> <span class="n">might</span> <span class="n">be</span> <span class="n">important</span> <span class="k">for</span>
|
||
<span class="n">the</span> <span class="n">functionality</span> <span class="n">of</span> <span class="n">certain</span> <span class="n">custom</span> <span class="n">objects</span><span class="p">)</span><span class="o">.</span> <span class="n">This</span> <span class="ow">is</span> <span class="n">indicated</span>
|
||
<span class="n">by</span> <span class="n">you</span> <span class="n">starting</span> <span class="n">your</span> <span class="n">value</span> <span class="k">with</span> <span class="n">one</span> <span class="n">of</span> <span class="o">|</span><span class="n">c</span><span class="s1">'|n, |c"|n, |c(|n, |c[|n</span>
|
||
<span class="ow">or</span> <span class="o">|</span><span class="n">c</span><span class="p">{</span> <span class="o">|</span><span class="n">n</span><span class="o">.</span>
|
||
|
||
<span class="n">Once</span> <span class="n">you</span> <span class="n">have</span> <span class="n">stored</span> <span class="n">a</span> <span class="n">Python</span> <span class="n">primitive</span> <span class="k">as</span> <span class="n">noted</span> <span class="n">above</span><span class="p">,</span> <span class="n">you</span> <span class="n">can</span> <span class="n">include</span>
|
||
<span class="o">|</span><span class="n">c</span><span class="p">[</span><span class="o"><</span><span class="n">key</span><span class="o">></span><span class="p">]</span><span class="o">|</span><span class="n">n</span> <span class="ow">in</span> <span class="o"><</span><span class="n">attr</span><span class="o">></span> <span class="n">to</span> <span class="n">reference</span> <span class="n">nested</span> <span class="n">values</span> <span class="ow">in</span> <span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span> <span class="n">a</span> <span class="nb">list</span> <span class="ow">or</span> <span class="nb">dict</span><span class="o">.</span>
|
||
|
||
<span class="n">Remember</span> <span class="n">that</span> <span class="k">if</span> <span class="n">you</span> <span class="n">use</span> <span class="n">Python</span> <span class="n">primitives</span> <span class="n">like</span> <span class="n">this</span><span class="p">,</span> <span class="n">you</span> <span class="n">must</span>
|
||
<span class="n">write</span> <span class="n">proper</span> <span class="n">Python</span> <span class="n">syntax</span> <span class="n">too</span> <span class="o">-</span> <span class="n">notably</span> <span class="n">you</span> <span class="n">must</span> <span class="n">include</span> <span class="n">quotes</span>
|
||
<span class="n">around</span> <span class="n">your</span> <span class="n">strings</span> <span class="ow">or</span> <span class="n">you</span> <span class="n">will</span> <span class="n">get</span> <span class="n">an</span> <span class="n">error</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>set</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(set) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdSetAttribute</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="sethome-cmdsethome">
|
||
<h4>sethome (CmdSetHome)<a class="headerlink" href="#sethome-cmdsethome" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nb">set</span> <span class="n">an</span> <span class="nb">object</span><span class="s1">'s home location</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">sethome</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span> <span class="p">[</span><span class="o">=</span> <span class="o"><</span><span class="n">home_location</span><span class="o">></span><span class="p">]</span>
|
||
<span class="n">sethom</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span>
|
||
|
||
<span class="n">The</span> <span class="s2">"home"</span> <span class="n">location</span> <span class="ow">is</span> <span class="n">a</span> <span class="s2">"safety"</span> <span class="n">location</span> <span class="k">for</span> <span class="n">objects</span><span class="p">;</span> <span class="n">they</span>
|
||
<span class="n">will</span> <span class="n">be</span> <span class="n">moved</span> <span class="n">there</span> <span class="k">if</span> <span class="n">their</span> <span class="n">current</span> <span class="n">location</span> <span class="n">ceases</span> <span class="n">to</span> <span class="n">exist</span><span class="o">.</span> <span class="n">All</span>
|
||
<span class="n">objects</span> <span class="n">should</span> <span class="n">always</span> <span class="n">have</span> <span class="n">a</span> <span class="n">home</span> <span class="n">location</span> <span class="k">for</span> <span class="n">this</span> <span class="n">reason</span><span class="o">.</span>
|
||
<span class="n">It</span> <span class="ow">is</span> <span class="n">also</span> <span class="n">a</span> <span class="n">convenient</span> <span class="n">target</span> <span class="n">of</span> <span class="n">the</span> <span class="s2">"home"</span> <span class="n">command</span><span class="o">.</span>
|
||
|
||
<span class="n">If</span> <span class="n">no</span> <span class="n">location</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">just</span> <span class="n">view</span> <span class="n">the</span> <span class="nb">object</span><span class="s1">'s home location.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>sethome</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(sethome) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdSetHome</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="spawn-cmdspawn">
|
||
<h4>spawn (CmdSpawn)<a class="headerlink" href="#spawn-cmdspawn" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">spawn</span> <span class="n">objects</span> <span class="kn">from</span> <span class="nn">prototype</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">spawn</span><span class="p">[</span><span class="o">/</span><span class="n">noloc</span><span class="p">]</span> <span class="o"><</span><span class="n">prototype_key</span><span class="o">></span>
|
||
<span class="n">spawn</span><span class="p">[</span><span class="o">/</span><span class="n">noloc</span><span class="p">]</span> <span class="o"><</span><span class="n">prototype_dict</span><span class="o">></span>
|
||
|
||
<span class="n">spawn</span><span class="o">/</span><span class="n">search</span> <span class="p">[</span><span class="n">prototype_keykey</span><span class="p">][;</span><span class="n">tag</span><span class="p">[,</span><span class="n">tag</span><span class="p">]]</span>
|
||
<span class="n">spawn</span><span class="o">/</span><span class="nb">list</span> <span class="p">[</span><span class="n">tag</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
|
||
<span class="n">spawn</span><span class="o">/</span><span class="n">show</span> <span class="p">[</span><span class="o"><</span><span class="n">prototype_key</span><span class="o">></span><span class="p">]</span>
|
||
<span class="n">spawn</span><span class="o">/</span><span class="n">update</span> <span class="o"><</span><span class="n">prototype_key</span><span class="o">></span>
|
||
|
||
<span class="n">spawn</span><span class="o">/</span><span class="n">save</span> <span class="o"><</span><span class="n">prototype_dict</span><span class="o">></span>
|
||
<span class="n">spawn</span><span class="o">/</span><span class="n">edit</span> <span class="p">[</span><span class="o"><</span><span class="n">prototype_key</span><span class="o">></span><span class="p">]</span>
|
||
<span class="n">olc</span> <span class="o">-</span> <span class="n">equivalent</span> <span class="n">to</span> <span class="n">spawn</span><span class="o">/</span><span class="n">edit</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">noloc</span> <span class="o">-</span> <span class="n">allow</span> <span class="n">location</span> <span class="n">to</span> <span class="n">be</span> <span class="kc">None</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">specified</span> <span class="n">explicitly</span><span class="o">.</span> <span class="n">Otherwise</span><span class="p">,</span>
|
||
<span class="n">location</span> <span class="n">will</span> <span class="n">default</span> <span class="n">to</span> <span class="n">caller</span><span class="s1">'s current location.</span>
|
||
<span class="n">search</span> <span class="o">-</span> <span class="n">search</span> <span class="n">prototype</span> <span class="n">by</span> <span class="n">name</span> <span class="ow">or</span> <span class="n">tags</span><span class="o">.</span>
|
||
<span class="nb">list</span> <span class="o">-</span> <span class="nb">list</span> <span class="n">available</span> <span class="n">prototypes</span><span class="p">,</span> <span class="n">optionally</span> <span class="n">limit</span> <span class="n">by</span> <span class="n">tags</span><span class="o">.</span>
|
||
<span class="n">show</span><span class="p">,</span> <span class="n">examine</span> <span class="o">-</span> <span class="n">inspect</span> <span class="n">prototype</span> <span class="n">by</span> <span class="n">key</span><span class="o">.</span> <span class="n">If</span> <span class="ow">not</span> <span class="n">given</span><span class="p">,</span> <span class="n">acts</span> <span class="n">like</span> <span class="nb">list</span><span class="o">.</span>
|
||
<span class="n">save</span> <span class="o">-</span> <span class="n">save</span> <span class="n">a</span> <span class="n">prototype</span> <span class="n">to</span> <span class="n">the</span> <span class="n">database</span><span class="o">.</span> <span class="n">It</span> <span class="n">will</span> <span class="n">be</span> <span class="n">listable</span> <span class="n">by</span> <span class="o">/</span><span class="nb">list</span><span class="o">.</span>
|
||
<span class="n">delete</span> <span class="o">-</span> <span class="n">remove</span> <span class="n">a</span> <span class="n">prototype</span> <span class="kn">from</span> <span class="nn">database</span><span class="p">,</span> <span class="k">if</span> <span class="n">allowed</span> <span class="n">to</span><span class="o">.</span>
|
||
<span class="n">update</span> <span class="o">-</span> <span class="n">find</span> <span class="n">existing</span> <span class="n">objects</span> <span class="k">with</span> <span class="n">the</span> <span class="n">same</span> <span class="n">prototype_key</span> <span class="ow">and</span> <span class="n">update</span>
|
||
<span class="n">them</span> <span class="k">with</span> <span class="n">latest</span> <span class="n">version</span> <span class="n">of</span> <span class="n">given</span> <span class="n">prototype</span><span class="o">.</span> <span class="n">If</span> <span class="n">given</span> <span class="k">with</span> <span class="o">/</span><span class="n">save</span><span class="p">,</span>
|
||
<span class="n">will</span> <span class="n">auto</span><span class="o">-</span><span class="n">update</span> <span class="nb">all</span> <span class="n">objects</span> <span class="k">with</span> <span class="n">the</span> <span class="n">old</span> <span class="n">version</span> <span class="n">of</span> <span class="n">the</span> <span class="n">prototype</span>
|
||
<span class="n">without</span> <span class="n">asking</span> <span class="n">first</span><span class="o">.</span>
|
||
<span class="n">edit</span><span class="p">,</span> <span class="n">olc</span> <span class="o">-</span> <span class="n">create</span><span class="o">/</span><span class="n">manipulate</span> <span class="n">prototype</span> <span class="ow">in</span> <span class="n">a</span> <span class="n">menu</span> <span class="n">interface</span><span class="o">.</span>
|
||
|
||
<span class="n">Example</span><span class="p">:</span>
|
||
<span class="n">spawn</span> <span class="n">GOBLIN</span>
|
||
<span class="n">spawn</span> <span class="p">{</span><span class="s2">"key"</span><span class="p">:</span><span class="s2">"goblin"</span><span class="p">,</span> <span class="s2">"typeclass"</span><span class="p">:</span><span class="s2">"monster.Monster"</span><span class="p">,</span> <span class="s2">"location"</span><span class="p">:</span><span class="s2">"#2"</span><span class="p">}</span>
|
||
<span class="n">spawn</span><span class="o">/</span><span class="n">save</span> <span class="p">{</span><span class="s2">"key"</span><span class="p">:</span> <span class="s2">"grunt"</span><span class="p">,</span> <span class="n">prototype</span><span class="p">:</span> <span class="s2">"goblin"</span><span class="p">};;</span><span class="n">mobs</span><span class="p">;</span><span class="n">edit</span><span class="p">:</span><span class="nb">all</span><span class="p">()</span>
|
||
|
||
<span class="n">Dictionary</span> <span class="n">keys</span><span class="p">:</span>
|
||
<span class="o">|</span><span class="n">wprototype_parent</span> <span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">name</span> <span class="n">of</span> <span class="n">parent</span> <span class="n">prototype</span> <span class="n">to</span> <span class="n">use</span><span class="o">.</span> <span class="n">Required</span> <span class="k">if</span> <span class="n">typeclass</span> <span class="ow">is</span>
|
||
<span class="ow">not</span> <span class="nb">set</span><span class="o">.</span> <span class="n">Can</span> <span class="n">be</span> <span class="n">a</span> <span class="n">path</span> <span class="ow">or</span> <span class="n">a</span> <span class="nb">list</span> <span class="k">for</span> <span class="n">multiple</span> <span class="n">inheritance</span> <span class="p">(</span><span class="n">inherits</span>
|
||
<span class="n">left</span> <span class="n">to</span> <span class="n">right</span><span class="p">)</span><span class="o">.</span> <span class="n">If</span> <span class="nb">set</span> <span class="n">one</span> <span class="n">of</span> <span class="n">the</span> <span class="n">parents</span> <span class="n">must</span> <span class="n">have</span> <span class="n">a</span> <span class="n">typeclass</span><span class="o">.</span>
|
||
<span class="o">|</span><span class="n">wtypeclass</span> <span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">string</span><span class="o">.</span> <span class="n">Required</span> <span class="k">if</span> <span class="n">prototype_parent</span> <span class="ow">is</span> <span class="ow">not</span> <span class="nb">set</span><span class="o">.</span>
|
||
<span class="o">|</span><span class="n">wkey</span> <span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">string</span><span class="p">,</span> <span class="n">the</span> <span class="n">main</span> <span class="nb">object</span> <span class="n">identifier</span>
|
||
<span class="o">|</span><span class="n">wlocation</span> <span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">this</span> <span class="n">should</span> <span class="n">be</span> <span class="n">a</span> <span class="n">valid</span> <span class="nb">object</span> <span class="ow">or</span> <span class="c1">#dbref</span>
|
||
<span class="o">|</span><span class="n">whome</span> <span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">valid</span> <span class="nb">object</span> <span class="ow">or</span> <span class="c1">#dbref</span>
|
||
<span class="o">|</span><span class="n">wdestination</span><span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">only</span> <span class="n">valid</span> <span class="k">for</span> <span class="n">exits</span> <span class="p">(</span><span class="nb">object</span> <span class="ow">or</span> <span class="n">dbref</span><span class="p">)</span>
|
||
<span class="o">|</span><span class="n">wpermissions</span><span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">string</span> <span class="ow">or</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">permission</span> <span class="n">strings</span>
|
||
<span class="o">|</span><span class="n">wlocks</span> <span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">a</span> <span class="n">lock</span><span class="o">-</span><span class="n">string</span>
|
||
<span class="o">|</span><span class="n">waliases</span> <span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">string</span> <span class="ow">or</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">strings</span><span class="o">.</span>
|
||
<span class="o">|</span><span class="n">wndb_</span><span class="o">|</span><span class="n">n</span><span class="o"><</span><span class="n">name</span><span class="o">></span> <span class="o">-</span> <span class="n">value</span> <span class="n">of</span> <span class="n">a</span> <span class="n">nattribute</span> <span class="p">(</span><span class="n">ndb_</span> <span class="ow">is</span> <span class="n">stripped</span><span class="p">)</span>
|
||
|
||
<span class="o">|</span><span class="n">wprototype_key</span><span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">name</span> <span class="n">of</span> <span class="n">this</span> <span class="n">prototype</span><span class="o">.</span> <span class="n">Unique</span><span class="o">.</span> <span class="n">Used</span> <span class="n">to</span> <span class="n">store</span><span class="o">/</span><span class="n">retrieve</span> <span class="kn">from</span> <span class="nn">db</span>
|
||
<span class="ow">and</span> <span class="n">update</span> <span class="n">existing</span> <span class="n">prototyped</span> <span class="n">objects</span> <span class="k">if</span> <span class="n">desired</span><span class="o">.</span>
|
||
<span class="o">|</span><span class="n">wprototype_desc</span><span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">desc</span> <span class="n">of</span> <span class="n">this</span> <span class="n">prototype</span><span class="o">.</span> <span class="n">Used</span> <span class="ow">in</span> <span class="n">listings</span>
|
||
<span class="o">|</span><span class="n">wprototype_locks</span><span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">locks</span> <span class="n">of</span> <span class="n">this</span> <span class="n">prototype</span><span class="o">.</span> <span class="n">Limits</span> <span class="n">who</span> <span class="n">may</span> <span class="n">use</span> <span class="n">prototype</span>
|
||
<span class="o">|</span><span class="n">wprototype_tags</span><span class="o">|</span><span class="n">n</span> <span class="o">-</span> <span class="n">tags</span> <span class="n">of</span> <span class="n">this</span> <span class="n">prototype</span><span class="o">.</span> <span class="n">Used</span> <span class="n">to</span> <span class="n">find</span> <span class="n">prototype</span>
|
||
|
||
<span class="nb">any</span> <span class="n">other</span> <span class="n">keywords</span> <span class="n">are</span> <span class="n">interpreted</span> <span class="k">as</span> <span class="n">Attributes</span> <span class="ow">and</span> <span class="n">their</span> <span class="n">values</span><span class="o">.</span>
|
||
|
||
<span class="n">The</span> <span class="n">available</span> <span class="n">prototypes</span> <span class="n">are</span> <span class="n">defined</span> <span class="n">globally</span> <span class="ow">in</span> <span class="n">modules</span> <span class="nb">set</span> <span class="ow">in</span>
|
||
<span class="n">settings</span><span class="o">.</span><span class="n">PROTOTYPE_MODULES</span><span class="o">.</span> <span class="n">If</span> <span class="n">spawn</span> <span class="ow">is</span> <span class="n">used</span> <span class="n">without</span> <span class="n">arguments</span> <span class="n">it</span>
|
||
<span class="n">displays</span> <span class="n">a</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">available</span> <span class="n">prototypes</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>spawn</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>olc</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(spawn) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdSpawn</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="tag-cmdtag">
|
||
<h4>tag (CmdTag)<a class="headerlink" href="#tag-cmdtag" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">handles</span> <span class="n">the</span> <span class="n">tags</span> <span class="n">of</span> <span class="n">an</span> <span class="nb">object</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">tag</span><span class="p">[</span><span class="o">/</span><span class="k">del</span><span class="p">]</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span> <span class="p">[</span><span class="o">=</span> <span class="o"><</span><span class="n">tag</span><span class="o">></span><span class="p">[:</span><span class="o"><</span><span class="n">category</span><span class="o">></span><span class="p">]]</span>
|
||
<span class="n">tag</span><span class="o">/</span><span class="n">search</span> <span class="o"><</span><span class="n">tag</span><span class="o">></span><span class="p">[:</span><span class="o"><</span><span class="n">category</span><span class="p">]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">search</span> <span class="o">-</span> <span class="k">return</span> <span class="nb">all</span> <span class="n">objects</span> <span class="k">with</span> <span class="n">a</span> <span class="n">given</span> <span class="n">Tag</span>
|
||
<span class="k">del</span> <span class="o">-</span> <span class="n">remove</span> <span class="n">the</span> <span class="n">given</span> <span class="n">tag</span><span class="o">.</span> <span class="n">If</span> <span class="n">no</span> <span class="n">tag</span> <span class="ow">is</span> <span class="n">specified</span><span class="p">,</span>
|
||
<span class="n">clear</span> <span class="nb">all</span> <span class="n">tags</span> <span class="n">on</span> <span class="nb">object</span><span class="o">.</span>
|
||
|
||
<span class="n">Manipulates</span> <span class="ow">and</span> <span class="n">lists</span> <span class="n">tags</span> <span class="n">on</span> <span class="n">objects</span><span class="o">.</span> <span class="n">Tags</span> <span class="n">allow</span> <span class="k">for</span> <span class="n">quick</span>
|
||
<span class="n">grouping</span> <span class="n">of</span> <span class="ow">and</span> <span class="n">searching</span> <span class="k">for</span> <span class="n">objects</span><span class="o">.</span> <span class="n">If</span> <span class="n">only</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span>
|
||
<span class="nb">list</span> <span class="nb">all</span> <span class="n">tags</span> <span class="n">on</span> <span class="n">the</span> <span class="nb">object</span><span class="o">.</span> <span class="n">If</span> <span class="o">/</span><span class="n">search</span> <span class="ow">is</span> <span class="n">used</span><span class="p">,</span> <span class="nb">list</span> <span class="n">objects</span>
|
||
<span class="k">with</span> <span class="n">the</span> <span class="n">given</span> <span class="n">tag</span><span class="o">.</span>
|
||
<span class="n">The</span> <span class="n">category</span> <span class="n">can</span> <span class="n">be</span> <span class="n">used</span> <span class="k">for</span> <span class="n">grouping</span> <span class="n">tags</span> <span class="n">themselves</span><span class="p">,</span> <span class="n">but</span> <span class="n">it</span>
|
||
<span class="n">should</span> <span class="n">be</span> <span class="n">used</span> <span class="k">with</span> <span class="n">restrain</span> <span class="o">-</span> <span class="n">tags</span> <span class="n">on</span> <span class="n">their</span> <span class="n">own</span> <span class="n">are</span> <span class="n">usually</span>
|
||
<span class="n">enough</span> <span class="n">to</span> <span class="k">for</span> <span class="n">most</span> <span class="n">grouping</span> <span class="n">schemes</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>tag</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>tags</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(tag) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdTag</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="tel-cmdteleport">
|
||
<h4>tel (CmdTeleport)<a class="headerlink" href="#tel-cmdteleport" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">teleport</span> <span class="nb">object</span> <span class="n">to</span> <span class="n">another</span> <span class="n">location</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">tel</span><span class="o">/</span><span class="n">switch</span> <span class="p">[</span><span class="o"><</span><span class="nb">object</span><span class="o">></span> <span class="n">to</span><span class="o">||=</span><span class="p">]</span> <span class="o"><</span><span class="n">target</span> <span class="n">location</span><span class="o">></span>
|
||
|
||
<span class="n">Examples</span><span class="p">:</span>
|
||
<span class="n">tel</span> <span class="n">Limbo</span>
|
||
<span class="n">tel</span><span class="o">/</span><span class="n">quiet</span> <span class="n">box</span> <span class="o">=</span> <span class="n">Limbo</span>
|
||
<span class="n">tel</span><span class="o">/</span><span class="n">tonone</span> <span class="n">box</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">quiet</span> <span class="o">-</span> <span class="n">don</span><span class="s1">'t echo leave/arrive messages to the source/target</span>
|
||
<span class="n">locations</span> <span class="k">for</span> <span class="n">the</span> <span class="n">move</span><span class="o">.</span>
|
||
<span class="n">intoexit</span> <span class="o">-</span> <span class="k">if</span> <span class="n">target</span> <span class="ow">is</span> <span class="n">an</span> <span class="n">exit</span><span class="p">,</span> <span class="n">teleport</span> <span class="n">INTO</span>
|
||
<span class="n">the</span> <span class="n">exit</span> <span class="nb">object</span> <span class="n">instead</span> <span class="n">of</span> <span class="n">to</span> <span class="n">its</span> <span class="n">destination</span>
|
||
<span class="n">tonone</span> <span class="o">-</span> <span class="k">if</span> <span class="nb">set</span><span class="p">,</span> <span class="n">teleport</span> <span class="n">the</span> <span class="nb">object</span> <span class="n">to</span> <span class="n">a</span> <span class="kc">None</span><span class="o">-</span><span class="n">location</span><span class="o">.</span> <span class="n">If</span> <span class="n">this</span>
|
||
<span class="n">switch</span> <span class="ow">is</span> <span class="nb">set</span><span class="p">,</span> <span class="o"><</span><span class="n">target</span> <span class="n">location</span><span class="o">></span> <span class="ow">is</span> <span class="n">ignored</span><span class="o">.</span>
|
||
<span class="n">Note</span> <span class="n">that</span> <span class="n">the</span> <span class="n">only</span> <span class="n">way</span> <span class="n">to</span> <span class="n">retrieve</span>
|
||
<span class="n">an</span> <span class="nb">object</span> <span class="kn">from</span> <span class="nn">a</span> <span class="kc">None</span> <span class="n">location</span> <span class="ow">is</span> <span class="n">by</span> <span class="n">direct</span> <span class="c1">#dbref</span>
|
||
<span class="n">reference</span><span class="o">.</span> <span class="n">A</span> <span class="n">puppeted</span> <span class="nb">object</span> <span class="n">cannot</span> <span class="n">be</span> <span class="n">moved</span> <span class="n">to</span> <span class="kc">None</span><span class="o">.</span>
|
||
<span class="n">loc</span> <span class="o">-</span> <span class="n">teleport</span> <span class="nb">object</span> <span class="n">to</span> <span class="n">the</span> <span class="n">target</span><span class="s1">'s location instead of its contents</span>
|
||
|
||
<span class="n">Teleports</span> <span class="n">an</span> <span class="nb">object</span> <span class="n">somewhere</span><span class="o">.</span> <span class="n">If</span> <span class="n">no</span> <span class="nb">object</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">you</span> <span class="n">yourself</span> <span class="n">are</span>
|
||
<span class="n">teleported</span> <span class="n">to</span> <span class="n">the</span> <span class="n">target</span> <span class="n">location</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>tel</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>teleport</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(teleport) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdTeleport</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="tunnel-cmdtunnel">
|
||
<h4>tunnel (CmdTunnel)<a class="headerlink" href="#tunnel-cmdtunnel" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">create</span> <span class="n">new</span> <span class="n">rooms</span> <span class="ow">in</span> <span class="n">cardinal</span> <span class="n">directions</span> <span class="n">only</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">tunnel</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">direction</span><span class="o">></span><span class="p">[:</span><span class="n">typeclass</span><span class="p">]</span> <span class="p">[</span><span class="o">=</span> <span class="o"><</span><span class="n">roomname</span><span class="o">></span><span class="p">[;</span><span class="n">alias</span><span class="p">;</span><span class="n">alias</span><span class="p">;</span><span class="o">...</span><span class="p">][:</span><span class="n">typeclass</span><span class="p">]]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">oneway</span> <span class="o">-</span> <span class="n">do</span> <span class="ow">not</span> <span class="n">create</span> <span class="n">an</span> <span class="n">exit</span> <span class="n">back</span> <span class="n">to</span> <span class="n">the</span> <span class="n">current</span> <span class="n">location</span>
|
||
<span class="n">tel</span> <span class="o">-</span> <span class="n">teleport</span> <span class="n">to</span> <span class="n">the</span> <span class="n">newly</span> <span class="n">created</span> <span class="n">room</span>
|
||
|
||
<span class="n">Example</span><span class="p">:</span>
|
||
<span class="n">tunnel</span> <span class="n">n</span>
|
||
<span class="n">tunnel</span> <span class="n">n</span> <span class="o">=</span> <span class="n">house</span><span class="p">;</span><span class="n">mike</span><span class="s1">'s place;green building</span>
|
||
|
||
<span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">simple</span> <span class="n">way</span> <span class="n">to</span> <span class="n">build</span> <span class="n">using</span> <span class="n">pre</span><span class="o">-</span><span class="n">defined</span> <span class="n">directions</span><span class="p">:</span>
|
||
<span class="o">|</span><span class="n">wn</span><span class="p">,</span><span class="n">ne</span><span class="p">,</span><span class="n">e</span><span class="p">,</span><span class="n">se</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">sw</span><span class="p">,</span><span class="n">w</span><span class="p">,</span><span class="n">nw</span><span class="o">|</span><span class="n">n</span> <span class="p">(</span><span class="n">north</span><span class="p">,</span> <span class="n">northeast</span> <span class="n">etc</span><span class="p">)</span>
|
||
<span class="o">|</span><span class="n">wu</span><span class="p">,</span><span class="n">d</span><span class="o">|</span><span class="n">n</span> <span class="p">(</span><span class="n">up</span> <span class="ow">and</span> <span class="n">down</span><span class="p">)</span>
|
||
<span class="o">|</span><span class="n">wi</span><span class="p">,</span><span class="n">o</span><span class="o">|</span><span class="n">n</span> <span class="p">(</span><span class="ow">in</span> <span class="ow">and</span> <span class="n">out</span><span class="p">)</span>
|
||
<span class="n">The</span> <span class="n">full</span> <span class="n">names</span> <span class="p">(</span><span class="n">north</span><span class="p">,</span> <span class="ow">in</span><span class="p">,</span> <span class="n">southwest</span><span class="p">,</span> <span class="n">etc</span><span class="p">)</span> <span class="n">will</span> <span class="n">always</span> <span class="n">be</span> <span class="n">put</span> <span class="k">as</span>
|
||
<span class="n">main</span> <span class="n">name</span> <span class="k">for</span> <span class="n">the</span> <span class="n">exit</span><span class="p">,</span> <span class="n">using</span> <span class="n">the</span> <span class="n">abbreviation</span> <span class="k">as</span> <span class="n">an</span> <span class="n">alias</span> <span class="p">(</span><span class="n">so</span> <span class="n">an</span>
|
||
<span class="n">exit</span> <span class="n">will</span> <span class="n">always</span> <span class="n">be</span> <span class="n">able</span> <span class="n">to</span> <span class="n">be</span> <span class="n">used</span> <span class="k">with</span> <span class="n">both</span> <span class="s2">"north"</span> <span class="k">as</span> <span class="n">well</span> <span class="k">as</span>
|
||
<span class="s2">"n"</span> <span class="k">for</span> <span class="n">example</span><span class="p">)</span><span class="o">.</span> <span class="n">Opposite</span> <span class="n">directions</span> <span class="n">will</span> <span class="n">automatically</span> <span class="n">be</span>
|
||
<span class="n">created</span> <span class="n">back</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">new</span> <span class="n">room</span> <span class="n">unless</span> <span class="n">the</span> <span class="o">/</span><span class="n">oneway</span> <span class="n">switch</span> <span class="ow">is</span> <span class="n">given</span><span class="o">.</span>
|
||
<span class="n">For</span> <span class="n">more</span> <span class="n">flexibility</span> <span class="ow">and</span> <span class="n">power</span> <span class="ow">in</span> <span class="n">creating</span> <span class="n">rooms</span><span class="p">,</span> <span class="n">use</span> <span class="n">dig</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>tunnel</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>tun</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd: perm(tunnel) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdTunnel</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="typeclass-cmdtypeclass">
|
||
<h4>typeclass (CmdTypeclass)<a class="headerlink" href="#typeclass-cmdtypeclass" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nb">set</span> <span class="ow">or</span> <span class="n">change</span> <span class="n">an</span> <span class="nb">object</span><span class="s1">'s typeclass</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">typeclass</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span> <span class="p">[</span><span class="o">=</span> <span class="n">typeclass</span><span class="o">.</span><span class="n">path</span><span class="p">]</span>
|
||
<span class="n">typeclass</span><span class="o">/</span><span class="n">prototype</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span> <span class="o">=</span> <span class="n">prototype_key</span>
|
||
|
||
<span class="n">typeclass</span><span class="o">/</span><span class="nb">list</span><span class="o">/</span><span class="n">show</span> <span class="p">[</span><span class="n">typeclass</span><span class="o">.</span><span class="n">path</span><span class="p">]</span>
|
||
<span class="n">swap</span> <span class="o">-</span> <span class="n">this</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">shorthand</span> <span class="k">for</span> <span class="n">using</span> <span class="o">/</span><span class="n">force</span><span class="o">/</span><span class="n">reset</span> <span class="n">flags</span><span class="o">.</span>
|
||
<span class="n">update</span> <span class="o">-</span> <span class="n">this</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">shorthand</span> <span class="k">for</span> <span class="n">using</span> <span class="n">the</span> <span class="o">/</span><span class="n">force</span><span class="o">/</span><span class="n">reload</span> <span class="n">flag</span><span class="o">.</span>
|
||
|
||
<span class="n">Switch</span><span class="p">:</span>
|
||
<span class="n">show</span><span class="p">,</span> <span class="n">examine</span> <span class="o">-</span> <span class="n">display</span> <span class="n">the</span> <span class="n">current</span> <span class="n">typeclass</span> <span class="n">of</span> <span class="nb">object</span> <span class="p">(</span><span class="n">default</span><span class="p">)</span> <span class="ow">or</span><span class="p">,</span> <span class="k">if</span>
|
||
<span class="n">given</span> <span class="n">a</span> <span class="n">typeclass</span> <span class="n">path</span><span class="p">,</span> <span class="n">show</span> <span class="n">the</span> <span class="n">docstring</span> <span class="n">of</span> <span class="n">that</span> <span class="n">typeclass</span><span class="o">.</span>
|
||
<span class="n">update</span> <span class="o">-</span> <span class="o">*</span><span class="n">only</span><span class="o">*</span> <span class="n">re</span><span class="o">-</span><span class="n">run</span> <span class="n">at_object_creation</span> <span class="n">on</span> <span class="n">this</span> <span class="nb">object</span>
|
||
<span class="n">meaning</span> <span class="n">locks</span> <span class="ow">or</span> <span class="n">other</span> <span class="n">properties</span> <span class="nb">set</span> <span class="n">later</span> <span class="n">may</span> <span class="n">remain</span><span class="o">.</span>
|
||
<span class="n">reset</span> <span class="o">-</span> <span class="n">clean</span> <span class="n">out</span> <span class="o">*</span><span class="nb">all</span><span class="o">*</span> <span class="n">the</span> <span class="n">attributes</span> <span class="ow">and</span> <span class="n">properties</span> <span class="n">on</span> <span class="n">the</span>
|
||
<span class="nb">object</span> <span class="o">-</span> <span class="n">basically</span> <span class="n">making</span> <span class="n">this</span> <span class="n">a</span> <span class="n">new</span> <span class="n">clean</span> <span class="nb">object</span><span class="o">.</span>
|
||
<span class="n">force</span> <span class="o">-</span> <span class="n">change</span> <span class="n">to</span> <span class="n">the</span> <span class="n">typeclass</span> <span class="n">also</span> <span class="k">if</span> <span class="n">the</span> <span class="nb">object</span>
|
||
<span class="n">already</span> <span class="n">has</span> <span class="n">a</span> <span class="n">typeclass</span> <span class="n">of</span> <span class="n">the</span> <span class="n">same</span> <span class="n">name</span><span class="o">.</span>
|
||
<span class="nb">list</span> <span class="o">-</span> <span class="n">show</span> <span class="n">available</span> <span class="n">typeclasses</span><span class="o">.</span> <span class="n">Only</span> <span class="n">typeclasses</span> <span class="ow">in</span> <span class="n">modules</span> <span class="n">actually</span>
|
||
<span class="n">imported</span> <span class="ow">or</span> <span class="n">used</span> <span class="kn">from</span> <span class="nn">somewhere</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">code</span> <span class="n">will</span> <span class="n">show</span> <span class="n">up</span> <span class="n">here</span>
|
||
<span class="p">(</span><span class="n">those</span> <span class="n">typeclasses</span> <span class="n">are</span> <span class="n">still</span> <span class="n">available</span> <span class="k">if</span> <span class="n">you</span> <span class="n">know</span> <span class="n">the</span> <span class="n">path</span><span class="p">)</span>
|
||
<span class="n">prototype</span> <span class="o">-</span> <span class="n">clean</span> <span class="ow">and</span> <span class="n">overwrite</span> <span class="n">the</span> <span class="nb">object</span> <span class="k">with</span> <span class="n">the</span> <span class="n">specified</span>
|
||
<span class="n">prototype</span> <span class="n">key</span> <span class="o">-</span> <span class="n">effectively</span> <span class="n">making</span> <span class="n">a</span> <span class="n">whole</span> <span class="n">new</span> <span class="nb">object</span><span class="o">.</span>
|
||
|
||
<span class="n">Example</span><span class="p">:</span>
|
||
<span class="nb">type</span> <span class="n">button</span> <span class="o">=</span> <span class="n">examples</span><span class="o">.</span><span class="n">red_button</span><span class="o">.</span><span class="n">RedButton</span>
|
||
<span class="nb">type</span><span class="o">/</span><span class="n">prototype</span> <span class="n">button</span><span class="o">=</span><span class="n">a</span> <span class="n">red</span> <span class="n">button</span>
|
||
|
||
<span class="n">If</span> <span class="n">the</span> <span class="n">typeclass_path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">given</span><span class="p">,</span> <span class="n">the</span> <span class="n">current</span> <span class="nb">object</span><span class="s1">'s typeclass is</span>
|
||
<span class="n">assumed</span><span class="o">.</span>
|
||
|
||
<span class="n">View</span> <span class="ow">or</span> <span class="nb">set</span> <span class="n">an</span> <span class="nb">object</span><span class="s1">'s typeclass. If setting, the creation hooks of the</span>
|
||
<span class="n">new</span> <span class="n">typeclass</span> <span class="n">will</span> <span class="n">be</span> <span class="n">run</span> <span class="n">on</span> <span class="n">the</span> <span class="nb">object</span><span class="o">.</span> <span class="n">If</span> <span class="n">you</span> <span class="n">have</span> <span class="n">clashing</span> <span class="n">properties</span> <span class="n">on</span>
|
||
<span class="n">the</span> <span class="n">old</span> <span class="n">class</span><span class="p">,</span> <span class="n">use</span> <span class="o">/</span><span class="n">reset</span><span class="o">.</span> <span class="n">By</span> <span class="n">default</span> <span class="n">you</span> <span class="n">are</span> <span class="n">protected</span> <span class="kn">from</span> <span class="nn">changing</span> <span class="n">to</span> <span class="n">a</span>
|
||
<span class="n">typeclass</span> <span class="n">of</span> <span class="n">the</span> <span class="n">same</span> <span class="n">name</span> <span class="k">as</span> <span class="n">the</span> <span class="n">one</span> <span class="n">you</span> <span class="n">already</span> <span class="n">have</span> <span class="o">-</span> <span class="n">use</span> <span class="o">/</span><span class="n">force</span> <span class="n">to</span>
|
||
<span class="n">override</span> <span class="n">this</span> <span class="n">protection</span><span class="o">.</span>
|
||
|
||
<span class="n">The</span> <span class="n">given</span> <span class="n">typeclass</span> <span class="n">must</span> <span class="n">be</span> <span class="n">identified</span> <span class="n">by</span> <span class="n">its</span> <span class="n">location</span> <span class="n">using</span> <span class="n">python</span>
|
||
<span class="n">dot</span><span class="o">-</span><span class="n">notation</span> <span class="n">pointing</span> <span class="n">to</span> <span class="n">the</span> <span class="n">correct</span> <span class="n">module</span> <span class="ow">and</span> <span class="n">class</span><span class="o">.</span> <span class="n">If</span> <span class="n">no</span> <span class="n">typeclass</span> <span class="ow">is</span>
|
||
<span class="n">given</span> <span class="p">(</span><span class="ow">or</span> <span class="n">a</span> <span class="n">wrong</span> <span class="n">typeclass</span> <span class="ow">is</span> <span class="n">given</span><span class="p">)</span><span class="o">.</span> <span class="n">Errors</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">path</span> <span class="ow">or</span> <span class="n">new</span> <span class="n">typeclass</span>
|
||
<span class="n">will</span> <span class="n">lead</span> <span class="n">to</span> <span class="n">the</span> <span class="n">old</span> <span class="n">typeclass</span> <span class="n">being</span> <span class="n">kept</span><span class="o">.</span> <span class="n">The</span> <span class="n">location</span> <span class="n">of</span> <span class="n">the</span> <span class="n">typeclass</span>
|
||
<span class="n">module</span> <span class="ow">is</span> <span class="n">searched</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">default</span> <span class="n">typeclass</span> <span class="n">directory</span><span class="p">,</span> <span class="k">as</span> <span class="n">defined</span> <span class="ow">in</span> <span class="n">the</span>
|
||
<span class="n">server</span> <span class="n">settings</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>typeclass</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>swap</em>, <em>parent</em>, <em>type</em>, <em>update</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(typeclass) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdTypeclass</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="unlink-cmdunlink">
|
||
<h4>unlink (CmdUnLink)<a class="headerlink" href="#unlink-cmdunlink" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">remove</span> <span class="n">exit</span><span class="o">-</span><span class="n">connections</span> <span class="n">between</span> <span class="n">rooms</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">unlink</span> <span class="o"><</span><span class="n">Object</span><span class="o">></span>
|
||
|
||
<span class="n">Unlinks</span> <span class="n">an</span> <span class="nb">object</span><span class="p">,</span> <span class="k">for</span> <span class="n">example</span> <span class="n">an</span> <span class="n">exit</span><span class="p">,</span> <span class="n">disconnecting</span>
|
||
<span class="n">it</span> <span class="kn">from</span> <span class="nn">whatever</span> <span class="n">it</span> <span class="n">was</span> <span class="n">connected</span> <span class="n">to</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>unlink</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(unlink) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdUnLink</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="wipe-cmdwipe">
|
||
<h4>wipe (CmdWipe)<a class="headerlink" href="#wipe-cmdwipe" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">clear</span> <span class="nb">all</span> <span class="n">attributes</span> <span class="kn">from</span> <span class="nn">an</span> <span class="nb">object</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">wipe</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span><span class="p">[</span><span class="o">/<</span><span class="n">attr</span><span class="o">></span><span class="p">[</span><span class="o">/<</span><span class="n">attr</span><span class="o">>...</span><span class="p">]]</span>
|
||
|
||
<span class="n">Example</span><span class="p">:</span>
|
||
<span class="n">wipe</span> <span class="n">box</span>
|
||
<span class="n">wipe</span> <span class="n">box</span><span class="o">/</span><span class="n">colour</span>
|
||
|
||
<span class="n">Wipes</span> <span class="nb">all</span> <span class="n">of</span> <span class="n">an</span> <span class="nb">object</span><span class="s1">'s attributes, or optionally only those</span>
|
||
<span class="n">matching</span> <span class="n">the</span> <span class="n">given</span> <span class="n">attribute</span><span class="o">-</span><span class="n">wildcard</span> <span class="n">search</span> <span class="n">string</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>wipe</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(wipe) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdWipe</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/building.py">building.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="comms-py">
|
||
<h3><code class="docutils literal notranslate"><span class="pre">comms.py</span></code><a class="headerlink" href="#comms-py" title="Permalink to this headline">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">View comms.py
|
||
source</a></p>
|
||
<div class="section" id="addcom-cmdaddcom">
|
||
<h4>addcom (CmdAddCom)<a class="headerlink" href="#addcom-cmdaddcom" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">add</span> <span class="n">a</span> <span class="n">channel</span> <span class="n">alias</span> <span class="ow">and</span><span class="o">/</span><span class="ow">or</span> <span class="n">subscribe</span> <span class="n">to</span> <span class="n">a</span> <span class="n">channel</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">addcom</span> <span class="p">[</span><span class="n">alias</span><span class="o">=</span><span class="p">]</span> <span class="o"><</span><span class="n">channel</span><span class="o">></span>
|
||
|
||
<span class="n">Joins</span> <span class="n">a</span> <span class="n">given</span> <span class="n">channel</span><span class="o">.</span> <span class="n">If</span> <span class="n">alias</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">this</span> <span class="n">will</span> <span class="n">allow</span> <span class="n">you</span> <span class="n">to</span>
|
||
<span class="n">refer</span> <span class="n">to</span> <span class="n">the</span> <span class="n">channel</span> <span class="n">by</span> <span class="n">this</span> <span class="n">alias</span> <span class="n">rather</span> <span class="n">than</span> <span class="n">the</span> <span class="n">full</span> <span class="n">channel</span>
|
||
<span class="n">name</span><span class="o">.</span> <span class="n">Subsequent</span> <span class="n">calls</span> <span class="n">of</span> <span class="n">this</span> <span class="n">command</span> <span class="n">can</span> <span class="n">be</span> <span class="n">used</span> <span class="n">to</span> <span class="n">add</span> <span class="n">multiple</span>
|
||
<span class="n">aliases</span> <span class="n">to</span> <span class="n">an</span> <span class="n">already</span> <span class="n">joined</span> <span class="n">channel</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>addcom</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>aliaschan</em>, <em>chanalias</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:not pperm(channel_banned)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdAddCom</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="allcom-cmdallcom">
|
||
<h4>allcom (CmdAllCom)<a class="headerlink" href="#allcom-cmdallcom" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">perform</span> <span class="n">admin</span> <span class="n">operations</span> <span class="n">on</span> <span class="nb">all</span> <span class="n">channels</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">allcom</span> <span class="p">[</span><span class="n">on</span> <span class="o">|</span> <span class="n">off</span> <span class="o">|</span> <span class="n">who</span> <span class="o">|</span> <span class="n">destroy</span><span class="p">]</span>
|
||
|
||
<span class="n">Allows</span> <span class="n">the</span> <span class="n">user</span> <span class="n">to</span> <span class="n">universally</span> <span class="n">turn</span> <span class="n">off</span> <span class="ow">or</span> <span class="n">on</span> <span class="nb">all</span> <span class="n">channels</span> <span class="n">they</span> <span class="n">are</span> <span class="n">on</span><span class="p">,</span> <span class="k">as</span>
|
||
<span class="n">well</span> <span class="k">as</span> <span class="n">perform</span> <span class="n">a</span> <span class="s1">'who'</span> <span class="k">for</span> <span class="nb">all</span> <span class="n">channels</span> <span class="n">they</span> <span class="n">are</span> <span class="n">on</span><span class="o">.</span> <span class="n">Destroy</span> <span class="n">deletes</span> <span class="nb">all</span>
|
||
<span class="n">channels</span> <span class="n">that</span> <span class="n">you</span> <span class="n">control</span><span class="o">.</span>
|
||
|
||
<span class="n">Without</span> <span class="n">argument</span><span class="p">,</span> <span class="n">works</span> <span class="n">like</span> <span class="n">comlist</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>allcom</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd: not pperm(channel_banned)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdAllCom</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="cboot-cmdcboot">
|
||
<h4>cboot (CmdCBoot)<a class="headerlink" href="#cboot-cmdcboot" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">kick</span> <span class="n">an</span> <span class="n">account</span> <span class="kn">from</span> <span class="nn">a</span> <span class="n">channel</span> <span class="n">you</span> <span class="n">control</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">cboot</span><span class="p">[</span><span class="o">/</span><span class="n">quiet</span><span class="p">]</span> <span class="o"><</span><span class="n">channel</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">account</span><span class="o">></span> <span class="p">[:</span><span class="n">reason</span><span class="p">]</span>
|
||
|
||
<span class="n">Switch</span><span class="p">:</span>
|
||
<span class="n">quiet</span> <span class="o">-</span> <span class="n">don</span><span class="s1">'t notify the channel</span>
|
||
|
||
<span class="n">Kicks</span> <span class="n">an</span> <span class="n">account</span> <span class="ow">or</span> <span class="nb">object</span> <span class="kn">from</span> <span class="nn">a</span> <span class="n">channel</span> <span class="n">you</span> <span class="n">control</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>cboot</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd: not pperm(channel_banned)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdCBoot</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="ccreate-cmdchannelcreate">
|
||
<h4>ccreate (CmdChannelCreate)<a class="headerlink" href="#ccreate-cmdchannelcreate" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">create</span> <span class="n">a</span> <span class="n">new</span> <span class="n">channel</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">ccreate</span> <span class="o"><</span><span class="n">new</span> <span class="n">channel</span><span class="o">></span><span class="p">[;</span><span class="n">alias</span><span class="p">;</span><span class="n">alias</span><span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="n">description</span>
|
||
|
||
<span class="n">Creates</span> <span class="n">a</span> <span class="n">new</span> <span class="n">channel</span> <span class="n">owned</span> <span class="n">by</span> <span class="n">you</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>ccreate</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>channelcreate</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:not pperm(channel_banned) and pperm(Player)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdChannelCreate</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="cdesc-cmdcdesc">
|
||
<h4>cdesc (CmdCdesc)<a class="headerlink" href="#cdesc-cmdcdesc" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">describe</span> <span class="n">a</span> <span class="n">channel</span> <span class="n">you</span> <span class="n">control</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">cdesc</span> <span class="o"><</span><span class="n">channel</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">description</span><span class="o">></span>
|
||
|
||
<span class="n">Changes</span> <span class="n">the</span> <span class="n">description</span> <span class="n">of</span> <span class="n">the</span> <span class="n">channel</span> <span class="k">as</span> <span class="n">shown</span> <span class="ow">in</span>
|
||
<span class="n">channel</span> <span class="n">lists</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>cdesc</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:not pperm(channel_banned)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdCdesc</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="cdestroy-cmdcdestroy">
|
||
<h4>cdestroy (CmdCdestroy)<a class="headerlink" href="#cdestroy-cmdcdestroy" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">destroy</span> <span class="n">a</span> <span class="n">channel</span> <span class="n">you</span> <span class="n">created</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">cdestroy</span> <span class="o"><</span><span class="n">channel</span><span class="o">></span>
|
||
|
||
<span class="n">Destroys</span> <span class="n">a</span> <span class="n">channel</span> <span class="n">that</span> <span class="n">you</span> <span class="n">control</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>cdestroy</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd: not pperm(channel_banned)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdCdestroy</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="cemit-cmdcemit">
|
||
<h4>cemit (CmdCemit)<a class="headerlink" href="#cemit-cmdcemit" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">send</span> <span class="n">an</span> <span class="n">admin</span> <span class="n">message</span> <span class="n">to</span> <span class="n">a</span> <span class="n">channel</span> <span class="n">you</span> <span class="n">control</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">cemit</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="o"><</span><span class="n">channel</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">message</span><span class="o">></span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">sendername</span> <span class="o">-</span> <span class="n">attach</span> <span class="n">the</span> <span class="n">sender</span><span class="s1">'s name before the message</span>
|
||
<span class="n">quiet</span> <span class="o">-</span> <span class="n">don</span><span class="s1">'t echo the message back to sender</span>
|
||
|
||
<span class="n">Allows</span> <span class="n">the</span> <span class="n">user</span> <span class="n">to</span> <span class="n">broadcast</span> <span class="n">a</span> <span class="n">message</span> <span class="n">over</span> <span class="n">a</span> <span class="n">channel</span> <span class="k">as</span> <span class="n">long</span> <span class="k">as</span>
|
||
<span class="n">they</span> <span class="n">control</span> <span class="n">it</span><span class="o">.</span> <span class="n">It</span> <span class="n">does</span> <span class="ow">not</span> <span class="n">show</span> <span class="n">the</span> <span class="n">user</span><span class="s1">'s name unless they</span>
|
||
<span class="n">provide</span> <span class="n">the</span> <span class="o">/</span><span class="n">sendername</span> <span class="n">switch</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>cemit</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>cmsg</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd: not pperm(channel_banned) and pperm(Player)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdCemit</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="channels-cmdchannels">
|
||
<h4>channels (CmdChannels)<a class="headerlink" href="#channels-cmdchannels" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nb">list</span> <span class="nb">all</span> <span class="n">channels</span> <span class="n">available</span> <span class="n">to</span> <span class="n">you</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">channels</span>
|
||
<span class="n">clist</span>
|
||
<span class="n">comlist</span>
|
||
|
||
<span class="n">Lists</span> <span class="nb">all</span> <span class="n">channels</span> <span class="n">available</span> <span class="n">to</span> <span class="n">you</span><span class="p">,</span> <span class="n">whether</span> <span class="n">you</span> <span class="n">listen</span> <span class="n">to</span> <span class="n">them</span> <span class="ow">or</span> <span class="ow">not</span><span class="o">.</span>
|
||
<span class="n">Use</span> <span class="s1">'comlist'</span> <span class="n">to</span> <span class="n">only</span> <span class="n">view</span> <span class="n">your</span> <span class="n">current</span> <span class="n">channel</span> <span class="n">subscriptions</span><span class="o">.</span>
|
||
<span class="n">Use</span> <span class="n">addcom</span><span class="o">/</span><span class="n">delcom</span> <span class="n">to</span> <span class="n">join</span> <span class="ow">and</span> <span class="n">leave</span> <span class="n">channels</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>channels</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>chanlist</em>, <em>channellist</em>, <em>clist</em>, <em>comlist</em>, <em>all channels</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd: not pperm(channel_banned)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdChannels</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="clock-cmdclock">
|
||
<h4>clock (CmdClock)<a class="headerlink" href="#clock-cmdclock" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">change</span> <span class="n">channel</span> <span class="n">locks</span> <span class="n">of</span> <span class="n">a</span> <span class="n">channel</span> <span class="n">you</span> <span class="n">control</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">clock</span> <span class="o"><</span><span class="n">channel</span><span class="o">></span> <span class="p">[</span><span class="o">=</span> <span class="o"><</span><span class="n">lockstring</span><span class="o">></span><span class="p">]</span>
|
||
|
||
<span class="n">Changes</span> <span class="n">the</span> <span class="n">lock</span> <span class="n">access</span> <span class="n">restrictions</span> <span class="n">of</span> <span class="n">a</span> <span class="n">channel</span><span class="o">.</span> <span class="n">If</span> <span class="n">no</span>
|
||
<span class="n">lockstring</span> <span class="n">was</span> <span class="n">given</span><span class="p">,</span> <span class="n">view</span> <span class="n">the</span> <span class="n">current</span> <span class="n">lock</span> <span class="n">definitions</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>clock</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:not pperm(channel_banned)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdClock</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="cwho-cmdcwho">
|
||
<h4>cwho (CmdCWho)<a class="headerlink" href="#cwho-cmdcwho" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">show</span> <span class="n">who</span> <span class="ow">is</span> <span class="n">listening</span> <span class="n">to</span> <span class="n">a</span> <span class="n">channel</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">cwho</span> <span class="o"><</span><span class="n">channel</span><span class="o">></span>
|
||
|
||
<span class="n">List</span> <span class="n">who</span> <span class="ow">is</span> <span class="n">connected</span> <span class="n">to</span> <span class="n">a</span> <span class="n">given</span> <span class="n">channel</span> <span class="n">you</span> <span class="n">have</span> <span class="n">access</span> <span class="n">to</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>cwho</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd: not pperm(channel_banned)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdCWho</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="delcom-cmddelcom">
|
||
<h4>delcom (CmdDelCom)<a class="headerlink" href="#delcom-cmddelcom" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">remove</span> <span class="n">a</span> <span class="n">channel</span> <span class="n">alias</span> <span class="ow">and</span><span class="o">/</span><span class="ow">or</span> <span class="n">unsubscribe</span> <span class="kn">from</span> <span class="nn">channel</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">delcom</span> <span class="o"><</span><span class="n">alias</span> <span class="ow">or</span> <span class="n">channel</span><span class="o">></span>
|
||
<span class="n">delcom</span><span class="o">/</span><span class="nb">all</span> <span class="o"><</span><span class="n">channel</span><span class="o">></span>
|
||
|
||
<span class="n">If</span> <span class="n">the</span> <span class="n">full</span> <span class="n">channel</span> <span class="n">name</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">unsubscribe</span> <span class="kn">from</span> <span class="nn">the</span>
|
||
<span class="n">channel</span><span class="o">.</span> <span class="n">If</span> <span class="n">an</span> <span class="n">alias</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">remove</span> <span class="n">the</span> <span class="n">alias</span> <span class="n">but</span> <span class="n">don</span><span class="s1">'t</span>
|
||
<span class="n">unsubscribe</span><span class="o">.</span> <span class="n">If</span> <span class="n">the</span> <span class="s1">'all'</span> <span class="n">switch</span> <span class="ow">is</span> <span class="n">used</span><span class="p">,</span> <span class="n">remove</span> <span class="nb">all</span> <span class="n">aliases</span>
|
||
<span class="k">for</span> <span class="n">that</span> <span class="n">channel</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>delcom</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>delaliaschan</em>, <em>delchanalias</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:not perm(channel_banned)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdDelCom</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="irc2chan-cmdirc2chan">
|
||
<h4>irc2chan (CmdIRC2Chan)<a class="headerlink" href="#irc2chan-cmdirc2chan" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">Link</span> <span class="n">an</span> <span class="n">evennia</span> <span class="n">channel</span> <span class="n">to</span> <span class="n">an</span> <span class="n">external</span> <span class="n">IRC</span> <span class="n">channel</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">irc2chan</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="o"><</span><span class="n">evennia_channel</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">ircnetwork</span><span class="o">></span> <span class="o"><</span><span class="n">port</span><span class="o">></span> <span class="o"><</span><span class="c1">#irchannel> <botname>[:typeclass]</span>
|
||
<span class="n">irc2chan</span><span class="o">/</span><span class="n">delete</span> <span class="n">botname</span><span class="o">|</span><span class="c1">#dbid</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="o">/</span><span class="n">delete</span> <span class="o">-</span> <span class="n">this</span> <span class="n">will</span> <span class="n">delete</span> <span class="n">the</span> <span class="n">bot</span> <span class="ow">and</span> <span class="n">remove</span> <span class="n">the</span> <span class="n">irc</span> <span class="n">connection</span>
|
||
<span class="n">to</span> <span class="n">the</span> <span class="n">channel</span><span class="o">.</span> <span class="n">Requires</span> <span class="n">the</span> <span class="n">botname</span> <span class="ow">or</span> <span class="c1">#dbid as input.</span>
|
||
<span class="o">/</span><span class="n">remove</span> <span class="o">-</span> <span class="n">alias</span> <span class="n">to</span> <span class="o">/</span><span class="n">delete</span>
|
||
<span class="o">/</span><span class="n">disconnect</span> <span class="o">-</span> <span class="n">alias</span> <span class="n">to</span> <span class="o">/</span><span class="n">delete</span>
|
||
<span class="o">/</span><span class="nb">list</span> <span class="o">-</span> <span class="n">show</span> <span class="nb">all</span> <span class="n">irc</span><span class="o"><-></span><span class="n">evennia</span> <span class="n">mappings</span>
|
||
<span class="o">/</span><span class="n">ssl</span> <span class="o">-</span> <span class="n">use</span> <span class="n">an</span> <span class="n">SSL</span><span class="o">-</span><span class="n">encrypted</span> <span class="n">connection</span>
|
||
|
||
<span class="n">Example</span><span class="p">:</span>
|
||
<span class="n">irc2chan</span> <span class="n">myircchan</span> <span class="o">=</span> <span class="n">irc</span><span class="o">.</span><span class="n">dalnet</span><span class="o">.</span><span class="n">net</span> <span class="mi">6667</span> <span class="c1">#mychannel evennia-bot</span>
|
||
<span class="n">irc2chan</span> <span class="n">public</span> <span class="o">=</span> <span class="n">irc</span><span class="o">.</span><span class="n">freenode</span><span class="o">.</span><span class="n">net</span> <span class="mi">6667</span> <span class="c1">#evgaming #evbot:accounts.mybot.MyBot</span>
|
||
|
||
<span class="n">This</span> <span class="n">creates</span> <span class="n">an</span> <span class="n">IRC</span> <span class="n">bot</span> <span class="n">that</span> <span class="n">connects</span> <span class="n">to</span> <span class="n">a</span> <span class="n">given</span> <span class="n">IRC</span> <span class="n">network</span> <span class="ow">and</span>
|
||
<span class="n">channel</span><span class="o">.</span> <span class="n">If</span> <span class="n">a</span> <span class="n">custom</span> <span class="n">typeclass</span> <span class="n">path</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">this</span> <span class="n">will</span> <span class="n">be</span> <span class="n">used</span>
|
||
<span class="n">instead</span> <span class="n">of</span> <span class="n">the</span> <span class="n">default</span> <span class="n">bot</span> <span class="n">class</span><span class="o">.</span>
|
||
<span class="n">The</span> <span class="n">bot</span> <span class="n">will</span> <span class="n">relay</span> <span class="n">everything</span> <span class="n">said</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">evennia</span> <span class="n">channel</span> <span class="n">to</span> <span class="n">the</span>
|
||
<span class="n">IRC</span> <span class="n">channel</span> <span class="ow">and</span> <span class="n">vice</span> <span class="n">versa</span><span class="o">.</span> <span class="n">The</span> <span class="n">bot</span> <span class="n">will</span> <span class="n">automatically</span> <span class="n">connect</span> <span class="n">at</span>
|
||
<span class="n">server</span> <span class="n">start</span><span class="p">,</span> <span class="n">so</span> <span class="n">this</span> <span class="n">command</span> <span class="n">need</span> <span class="n">only</span> <span class="n">be</span> <span class="n">given</span> <span class="n">once</span><span class="o">.</span> <span class="n">The</span>
|
||
<span class="o">/</span><span class="n">disconnect</span> <span class="n">switch</span> <span class="n">will</span> <span class="n">permanently</span> <span class="n">delete</span> <span class="n">the</span> <span class="n">bot</span><span class="o">.</span> <span class="n">To</span> <span class="n">only</span>
|
||
<span class="n">temporarily</span> <span class="n">deactivate</span> <span class="n">it</span><span class="p">,</span> <span class="n">use</span> <span class="n">the</span> <span class="o">|</span><span class="n">wservices</span><span class="o">|</span><span class="n">n</span> <span class="n">command</span> <span class="n">instead</span><span class="o">.</span>
|
||
<span class="n">Provide</span> <span class="n">an</span> <span class="n">optional</span> <span class="n">bot</span> <span class="k">class</span> <span class="nc">path</span> <span class="n">to</span> <span class="n">use</span> <span class="n">a</span> <span class="n">custom</span> <span class="n">bot</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>irc2chan</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:serversetting(IRC_ENABLED) and pperm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdIRC2Chan</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="page-cmdpage">
|
||
<h4>page (CmdPage)<a class="headerlink" href="#page-cmdpage" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">send</span> <span class="n">a</span> <span class="n">private</span> <span class="n">message</span> <span class="n">to</span> <span class="n">another</span> <span class="n">account</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">page</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="p">[</span><span class="o"><</span><span class="n">account</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="n">account</span><span class="o">></span><span class="p">,</span><span class="o">...</span> <span class="o">=</span> <span class="o"><</span><span class="n">message</span><span class="o">></span><span class="p">]</span>
|
||
<span class="n">tell</span> <span class="s1">''</span>
|
||
<span class="n">page</span> <span class="o"><</span><span class="n">number</span><span class="o">></span>
|
||
|
||
<span class="n">Switch</span><span class="p">:</span>
|
||
<span class="n">last</span> <span class="o">-</span> <span class="n">shows</span> <span class="n">who</span> <span class="n">you</span> <span class="n">last</span> <span class="n">messaged</span>
|
||
<span class="nb">list</span> <span class="o">-</span> <span class="n">show</span> <span class="n">your</span> <span class="n">last</span> <span class="o"><</span><span class="n">number</span><span class="o">></span> <span class="n">of</span> <span class="n">tells</span><span class="o">/</span><span class="n">pages</span> <span class="p">(</span><span class="n">default</span><span class="p">)</span>
|
||
|
||
<span class="n">Send</span> <span class="n">a</span> <span class="n">message</span> <span class="n">to</span> <span class="n">target</span> <span class="n">user</span> <span class="p">(</span><span class="k">if</span> <span class="n">online</span><span class="p">)</span><span class="o">.</span> <span class="n">If</span> <span class="n">no</span>
|
||
<span class="n">argument</span> <span class="ow">is</span> <span class="n">given</span><span class="p">,</span> <span class="n">you</span> <span class="n">will</span> <span class="n">get</span> <span class="n">a</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">your</span> <span class="n">latest</span> <span class="n">messages</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>page</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>tell</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:not pperm(page_banned)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdPage</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="rss2chan-cmdrss2chan">
|
||
<h4>rss2chan (CmdRSS2Chan)<a class="headerlink" href="#rss2chan-cmdrss2chan" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">link</span> <span class="n">an</span> <span class="n">evennia</span> <span class="n">channel</span> <span class="n">to</span> <span class="n">an</span> <span class="n">external</span> <span class="n">RSS</span> <span class="n">feed</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">rss2chan</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="o"><</span><span class="n">evennia_channel</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">rss_url</span><span class="o">></span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="o">/</span><span class="n">disconnect</span> <span class="o">-</span> <span class="n">this</span> <span class="n">will</span> <span class="n">stop</span> <span class="n">the</span> <span class="n">feed</span> <span class="ow">and</span> <span class="n">remove</span> <span class="n">the</span> <span class="n">connection</span> <span class="n">to</span> <span class="n">the</span>
|
||
<span class="n">channel</span><span class="o">.</span>
|
||
<span class="o">/</span><span class="n">remove</span> <span class="o">-</span> <span class="s2">"</span>
|
||
<span class="o">/</span><span class="nb">list</span> <span class="o">-</span> <span class="n">show</span> <span class="nb">all</span> <span class="n">rss</span><span class="o">-></span><span class="n">evennia</span> <span class="n">mappings</span>
|
||
|
||
<span class="n">Example</span><span class="p">:</span>
|
||
<span class="n">rss2chan</span> <span class="n">rsschan</span> <span class="o">=</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">code</span><span class="o">.</span><span class="n">google</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">feeds</span><span class="o">/</span><span class="n">p</span><span class="o">/</span><span class="n">evennia</span><span class="o">/</span><span class="n">updates</span><span class="o">/</span><span class="n">basic</span>
|
||
|
||
<span class="n">This</span> <span class="n">creates</span> <span class="n">an</span> <span class="n">RSS</span> <span class="n">reader</span> <span class="n">that</span> <span class="n">connects</span> <span class="n">to</span> <span class="n">a</span> <span class="n">given</span> <span class="n">RSS</span> <span class="n">feed</span> <span class="n">url</span><span class="o">.</span> <span class="n">Updates</span>
|
||
<span class="n">will</span> <span class="n">be</span> <span class="n">echoed</span> <span class="k">as</span> <span class="n">a</span> <span class="n">title</span> <span class="ow">and</span> <span class="n">news</span> <span class="n">link</span> <span class="n">to</span> <span class="n">the</span> <span class="n">given</span> <span class="n">channel</span><span class="o">.</span> <span class="n">The</span> <span class="n">rate</span> <span class="n">of</span>
|
||
<span class="n">updating</span> <span class="ow">is</span> <span class="nb">set</span> <span class="k">with</span> <span class="n">the</span> <span class="n">RSS_UPDATE_INTERVAL</span> <span class="n">variable</span> <span class="ow">in</span> <span class="n">settings</span> <span class="p">(</span><span class="n">default</span>
|
||
<span class="ow">is</span> <span class="n">every</span> <span class="mi">10</span> <span class="n">minutes</span><span class="p">)</span><span class="o">.</span>
|
||
|
||
<span class="n">When</span> <span class="n">disconnecting</span> <span class="n">you</span> <span class="n">need</span> <span class="n">to</span> <span class="n">supply</span> <span class="n">both</span> <span class="n">the</span> <span class="n">channel</span> <span class="ow">and</span> <span class="n">url</span> <span class="n">again</span> <span class="n">so</span> <span class="k">as</span>
|
||
<span class="n">to</span> <span class="n">identify</span> <span class="n">the</span> <span class="n">connection</span> <span class="n">uniquely</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>rss2chan</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:serversetting(RSS_ENABLED) and pperm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Comms”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdRSS2Chan</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/comms.py">comms.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="general-py">
|
||
<h3><code class="docutils literal notranslate"><span class="pre">general.py</span></code><a class="headerlink" href="#general-py" title="Permalink to this headline">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">View general.py
|
||
source</a></p>
|
||
<div class="section" id="access-cmdaccess">
|
||
<h4>access (CmdAccess)<a class="headerlink" href="#access-cmdaccess" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">show</span> <span class="n">your</span> <span class="n">current</span> <span class="n">game</span> <span class="n">access</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">access</span>
|
||
|
||
<span class="n">This</span> <span class="n">command</span> <span class="n">shows</span> <span class="n">you</span> <span class="n">the</span> <span class="n">permission</span> <span class="n">hierarchy</span> <span class="ow">and</span>
|
||
<span class="n">which</span> <span class="n">permission</span> <span class="n">groups</span> <span class="n">you</span> <span class="n">are</span> <span class="n">a</span> <span class="n">member</span> <span class="n">of</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>access</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>groups</em>, <em>hierarchy</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdAccess</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="drop-cmddrop">
|
||
<h4>drop (CmdDrop)<a class="headerlink" href="#drop-cmddrop" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">drop</span> <span class="n">something</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">drop</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span>
|
||
|
||
<span class="n">Lets</span> <span class="n">you</span> <span class="n">drop</span> <span class="n">an</span> <span class="nb">object</span> <span class="kn">from</span> <span class="nn">your</span> <span class="n">inventory</span> <span class="n">into</span> <span class="n">the</span>
|
||
<span class="n">location</span> <span class="n">you</span> <span class="n">are</span> <span class="n">currently</span> <span class="ow">in</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>drop</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdDrop</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="get-cmdget">
|
||
<h4>get (CmdGet)<a class="headerlink" href="#get-cmdget" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">pick</span> <span class="n">up</span> <span class="n">something</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">get</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span>
|
||
|
||
<span class="n">Picks</span> <span class="n">up</span> <span class="n">an</span> <span class="nb">object</span> <span class="kn">from</span> <span class="nn">your</span> <span class="n">location</span> <span class="ow">and</span> <span class="n">puts</span> <span class="n">it</span> <span class="ow">in</span>
|
||
<span class="n">your</span> <span class="n">inventory</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>get</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>grab</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdGet</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="give-cmdgive">
|
||
<h4>give (CmdGive)<a class="headerlink" href="#give-cmdgive" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">give</span> <span class="n">away</span> <span class="n">something</span> <span class="n">to</span> <span class="n">someone</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">give</span> <span class="o"><</span><span class="n">inventory</span> <span class="n">obj</span><span class="o">></span> <span class="o"><</span><span class="n">to</span><span class="o">||=></span> <span class="o"><</span><span class="n">target</span><span class="o">></span>
|
||
|
||
<span class="n">Gives</span> <span class="n">an</span> <span class="n">items</span> <span class="kn">from</span> <span class="nn">your</span> <span class="n">inventory</span> <span class="n">to</span> <span class="n">another</span> <span class="n">character</span><span class="p">,</span>
|
||
<span class="n">placing</span> <span class="n">it</span> <span class="ow">in</span> <span class="n">their</span> <span class="n">inventory</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>give</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdGive</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="home-cmdhome">
|
||
<h4>home (CmdHome)<a class="headerlink" href="#home-cmdhome" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">move</span> <span class="n">to</span> <span class="n">your</span> <span class="n">character</span><span class="s1">'s home location</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">home</span>
|
||
|
||
<span class="n">Teleports</span> <span class="n">you</span> <span class="n">to</span> <span class="n">your</span> <span class="n">home</span> <span class="n">location</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>home</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(home) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdHome</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="inventory-cmdinventory">
|
||
<h4>inventory (CmdInventory)<a class="headerlink" href="#inventory-cmdinventory" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">view</span> <span class="n">inventory</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">inventory</span>
|
||
<span class="n">inv</span>
|
||
|
||
<span class="n">Shows</span> <span class="n">your</span> <span class="n">inventory</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>inventory</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>i</em>, <em>inv</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdInventory</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="look-cmdlook">
|
||
<h4>look (CmdLook)<a class="headerlink" href="#look-cmdlook" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">look</span> <span class="n">at</span> <span class="n">location</span> <span class="ow">or</span> <span class="nb">object</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">look</span>
|
||
<span class="n">look</span> <span class="o"><</span><span class="n">obj</span><span class="o">></span>
|
||
<span class="n">look</span> <span class="o">*<</span><span class="n">account</span><span class="o">></span>
|
||
|
||
<span class="n">Observes</span> <span class="n">your</span> <span class="n">location</span> <span class="ow">or</span> <span class="n">objects</span> <span class="ow">in</span> <span class="n">your</span> <span class="n">vicinity</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>look</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>l</em>, <em>ls</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdLook</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="nick-cmdnick">
|
||
<h4>nick (CmdNick)<a class="headerlink" href="#nick-cmdnick" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> define a personal alias/nick by defining a string to
|
||
match and replace it with another on the fly
|
||
|
||
Usage:
|
||
nick[/switches] <string> [= [replacement_string]]
|
||
nick[/switches] <template> = <replacement_template>
|
||
nick/delete <string> or number
|
||
nicks
|
||
|
||
Switches:
|
||
inputline - replace on the inputline (default)
|
||
object - replace on object-lookup
|
||
account - replace on account-lookup
|
||
list - show all defined aliases (also "nicks" works)
|
||
delete - remove nick by index in /list
|
||
clearall - clear all nicks
|
||
|
||
Examples:
|
||
nick hi = say Hello, I'm Sarah!
|
||
nick/object tom = the tall man
|
||
nick build $1 $2 = create/drop $1;$2
|
||
nick tell $1 $2=page $1=$2
|
||
nick tm?$1=page tallman=$1
|
||
nick tm\=$1=page tallman=$1
|
||
|
||
A 'nick' is a personal string replacement. Use $1, $2, ... to catch arguments.
|
||
Put the last $-marker without an ending space to catch all remaining text. You
|
||
can also use unix-glob matching for the left-hand side <string>:
|
||
|
||
* - matches everything
|
||
? - matches 0 or 1 single characters
|
||
[abcd] - matches these chars in any order
|
||
[!abcd] - matches everything not among these chars
|
||
\= - escape literal '=' you want in your <string>
|
||
|
||
Note that no objects are actually renamed or changed by this command - your nicks
|
||
are only available to you. If you want to permanently add keywords to an object
|
||
for everyone to use, you need build privileges and the alias command.
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>nick</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>nicks</em>, <em>nickname</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdNick</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="pose-cmdpose">
|
||
<h4>pose (CmdPose)<a class="headerlink" href="#pose-cmdpose" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">strike</span> <span class="n">a</span> <span class="n">pose</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">pose</span> <span class="o"><</span><span class="n">pose</span> <span class="n">text</span><span class="o">></span>
|
||
<span class="n">pose</span><span class="s1">'s <pose text></span>
|
||
|
||
<span class="n">Example</span><span class="p">:</span>
|
||
<span class="n">pose</span> <span class="ow">is</span> <span class="n">standing</span> <span class="n">by</span> <span class="n">the</span> <span class="n">wall</span><span class="p">,</span> <span class="n">smiling</span><span class="o">.</span>
|
||
<span class="o">-></span> <span class="n">others</span> <span class="n">will</span> <span class="n">see</span><span class="p">:</span>
|
||
<span class="n">Tom</span> <span class="ow">is</span> <span class="n">standing</span> <span class="n">by</span> <span class="n">the</span> <span class="n">wall</span><span class="p">,</span> <span class="n">smiling</span><span class="o">.</span>
|
||
|
||
<span class="n">Describe</span> <span class="n">an</span> <span class="n">action</span> <span class="n">being</span> <span class="n">taken</span><span class="o">.</span> <span class="n">The</span> <span class="n">pose</span> <span class="n">text</span> <span class="n">will</span>
|
||
<span class="n">automatically</span> <span class="n">begin</span> <span class="k">with</span> <span class="n">your</span> <span class="n">name</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>pose</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>:</em>, <em>emote</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdPose</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="say-cmdsay">
|
||
<h4>say (CmdSay)<a class="headerlink" href="#say-cmdsay" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">speak</span> <span class="k">as</span> <span class="n">your</span> <span class="n">character</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">say</span> <span class="o"><</span><span class="n">message</span><span class="o">></span>
|
||
|
||
<span class="n">Talk</span> <span class="n">to</span> <span class="n">those</span> <span class="ow">in</span> <span class="n">your</span> <span class="n">current</span> <span class="n">location</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>say</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>‘</em>, <em>“</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdSay</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="setdesc-cmdsetdesc">
|
||
<h4>setdesc (CmdSetDesc)<a class="headerlink" href="#setdesc-cmdsetdesc" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">describe</span> <span class="n">yourself</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">setdesc</span> <span class="o"><</span><span class="n">description</span><span class="o">></span>
|
||
|
||
<span class="n">Add</span> <span class="n">a</span> <span class="n">description</span> <span class="n">to</span> <span class="n">yourself</span><span class="o">.</span> <span class="n">This</span>
|
||
<span class="n">will</span> <span class="n">be</span> <span class="n">visible</span> <span class="n">to</span> <span class="n">people</span> <span class="n">when</span> <span class="n">they</span>
|
||
<span class="n">look</span> <span class="n">at</span> <span class="n">you</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>setdesc</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdSetDesc</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="whisper-cmdwhisper">
|
||
<h4>whisper (CmdWhisper)<a class="headerlink" href="#whisper-cmdwhisper" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">Speak</span> <span class="n">privately</span> <span class="k">as</span> <span class="n">your</span> <span class="n">character</span> <span class="n">to</span> <span class="n">another</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">whisper</span> <span class="o"><</span><span class="n">character</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">message</span><span class="o">></span>
|
||
<span class="n">whisper</span> <span class="o"><</span><span class="n">char1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">char2</span><span class="o">></span> <span class="o">=</span> <span class="o"><</span><span class="n">message</span><span class="o">></span>
|
||
|
||
<span class="n">Talk</span> <span class="n">privately</span> <span class="n">to</span> <span class="n">one</span> <span class="ow">or</span> <span class="n">more</span> <span class="n">characters</span> <span class="ow">in</span> <span class="n">your</span> <span class="n">current</span> <span class="n">location</span><span class="p">,</span> <span class="n">without</span>
|
||
<span class="n">others</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">room</span> <span class="n">being</span> <span class="n">informed</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>whisper</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdWhisper</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/general.py">general.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="help-py">
|
||
<h3><code class="docutils literal notranslate"><span class="pre">help.py</span></code><a class="headerlink" href="#help-py" title="Permalink to this headline">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/help.py">View help.py
|
||
source</a></p>
|
||
<div class="section" id="help-cmdhelp">
|
||
<h4>help (CmdHelp)<a class="headerlink" href="#help-cmdhelp" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">View</span> <span class="n">help</span> <span class="ow">or</span> <span class="n">a</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">topics</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">help</span> <span class="o"><</span><span class="n">topic</span> <span class="ow">or</span> <span class="n">command</span><span class="o">></span>
|
||
<span class="n">help</span> <span class="nb">list</span>
|
||
<span class="n">help</span> <span class="nb">all</span>
|
||
|
||
<span class="n">This</span> <span class="n">will</span> <span class="n">search</span> <span class="k">for</span> <span class="n">help</span> <span class="n">on</span> <span class="n">commands</span> <span class="ow">and</span> <span class="n">other</span>
|
||
<span class="n">topics</span> <span class="n">related</span> <span class="n">to</span> <span class="n">the</span> <span class="n">game</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>help</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>?</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdHelp</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/help.py">help.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="sethelp-cmdsethelp">
|
||
<h4>sethelp (CmdSetHelp)<a class="headerlink" href="#sethelp-cmdsethelp" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">Edit</span> <span class="n">the</span> <span class="n">help</span> <span class="n">database</span><span class="o">.</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">help</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="o"><</span><span class="n">topic</span><span class="o">></span><span class="p">[[;</span><span class="n">alias</span><span class="p">;</span><span class="n">alias</span><span class="p">][,</span><span class="n">category</span><span class="p">[,</span><span class="n">locks</span><span class="p">]]</span> <span class="p">[</span><span class="o">=</span> <span class="o"><</span><span class="n">text</span><span class="o">></span><span class="p">]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">edit</span> <span class="o">-</span> <span class="nb">open</span> <span class="n">a</span> <span class="n">line</span> <span class="n">editor</span> <span class="n">to</span> <span class="n">edit</span> <span class="n">the</span> <span class="n">topic</span><span class="s1">'s help text.</span>
|
||
<span class="n">replace</span> <span class="o">-</span> <span class="n">overwrite</span> <span class="n">existing</span> <span class="n">help</span> <span class="n">topic</span><span class="o">.</span>
|
||
<span class="n">append</span> <span class="o">-</span> <span class="n">add</span> <span class="n">text</span> <span class="n">to</span> <span class="n">the</span> <span class="n">end</span> <span class="n">of</span> <span class="n">existing</span> <span class="n">topic</span> <span class="k">with</span> <span class="n">a</span> <span class="n">newline</span> <span class="n">between</span><span class="o">.</span>
|
||
<span class="n">extend</span> <span class="o">-</span> <span class="k">as</span> <span class="n">append</span><span class="p">,</span> <span class="n">but</span> <span class="n">don</span><span class="s1">'t add a newline.</span>
|
||
<span class="n">delete</span> <span class="o">-</span> <span class="n">remove</span> <span class="n">help</span> <span class="n">topic</span><span class="o">.</span>
|
||
|
||
<span class="n">Examples</span><span class="p">:</span>
|
||
<span class="n">sethelp</span> <span class="n">throw</span> <span class="o">=</span> <span class="n">This</span> <span class="n">throws</span> <span class="n">something</span> <span class="n">at</span> <span class="o">...</span>
|
||
<span class="n">sethelp</span><span class="o">/</span><span class="n">append</span> <span class="n">pickpocketing</span><span class="p">,</span><span class="n">Thievery</span> <span class="o">=</span> <span class="n">This</span> <span class="n">steals</span> <span class="o">...</span>
|
||
<span class="n">sethelp</span><span class="o">/</span><span class="n">replace</span> <span class="n">pickpocketing</span><span class="p">,</span> <span class="p">,</span><span class="n">attr</span><span class="p">(</span><span class="n">is_thief</span><span class="p">)</span> <span class="o">=</span> <span class="n">This</span> <span class="n">steals</span> <span class="o">...</span>
|
||
<span class="n">sethelp</span><span class="o">/</span><span class="n">edit</span> <span class="n">thievery</span>
|
||
|
||
<span class="n">This</span> <span class="n">command</span> <span class="n">manipulates</span> <span class="n">the</span> <span class="n">help</span> <span class="n">database</span><span class="o">.</span> <span class="n">A</span> <span class="n">help</span> <span class="n">entry</span> <span class="n">can</span> <span class="n">be</span> <span class="n">created</span><span class="p">,</span>
|
||
<span class="n">appended</span><span class="o">/</span><span class="n">merged</span> <span class="n">to</span> <span class="ow">and</span> <span class="n">deleted</span><span class="o">.</span> <span class="n">If</span> <span class="n">you</span> <span class="n">don</span><span class="s1">'t assign a category, the</span>
|
||
<span class="s2">"General"</span> <span class="n">category</span> <span class="n">will</span> <span class="n">be</span> <span class="n">used</span><span class="o">.</span> <span class="n">If</span> <span class="n">no</span> <span class="n">lockstring</span> <span class="ow">is</span> <span class="n">specified</span><span class="p">,</span> <span class="n">default</span>
|
||
<span class="ow">is</span> <span class="n">to</span> <span class="n">let</span> <span class="n">everyone</span> <span class="n">read</span> <span class="n">the</span> <span class="n">help</span> <span class="n">file</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>sethelp</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(Helper)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“Building”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdSetHelp</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/help.py">help.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="system-py">
|
||
<h3><code class="docutils literal notranslate"><span class="pre">system.py</span></code><a class="headerlink" href="#system-py" title="Permalink to this headline">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">View system.py
|
||
source</a></p>
|
||
<div class="section" id="about-cmdabout">
|
||
<h4>about (CmdAbout)<a class="headerlink" href="#about-cmdabout" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">show</span> <span class="n">Evennia</span> <span class="n">info</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">about</span>
|
||
|
||
<span class="n">Display</span> <span class="n">info</span> <span class="n">about</span> <span class="n">the</span> <span class="n">game</span> <span class="n">engine</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>about</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>version</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“System”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdAbout</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">system.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="objects-cmdobjects">
|
||
<h4>objects (CmdObjects)<a class="headerlink" href="#objects-cmdobjects" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">statistics</span> <span class="n">on</span> <span class="n">objects</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">database</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">objects</span> <span class="p">[</span><span class="o"><</span><span class="n">nr</span><span class="o">></span><span class="p">]</span>
|
||
|
||
<span class="n">Gives</span> <span class="n">statictics</span> <span class="n">on</span> <span class="n">objects</span> <span class="ow">in</span> <span class="n">database</span> <span class="k">as</span> <span class="n">well</span> <span class="k">as</span>
|
||
<span class="n">a</span> <span class="nb">list</span> <span class="n">of</span> <span class="o"><</span><span class="n">nr</span><span class="o">></span> <span class="n">latest</span> <span class="n">objects</span> <span class="ow">in</span> <span class="n">database</span><span class="o">.</span> <span class="n">If</span> <span class="ow">not</span>
|
||
<span class="n">given</span><span class="p">,</span> <span class="o"><</span><span class="n">nr</span><span class="o">></span> <span class="n">defaults</span> <span class="n">to</span> <span class="mf">10.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>objects</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>db</em>, <em>listobjs</em>, <em>stats</em>, <em>listobjects</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(listobjects) or perm(Builder)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“System”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdObjects</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">system.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="py-cmdpy">
|
||
<h4>py (CmdPy)<a class="headerlink" href="#py-cmdpy" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> execute a snippet of python code
|
||
|
||
Usage:
|
||
py [cmd]
|
||
py/edit
|
||
py/time <cmd>
|
||
py/clientraw <cmd>
|
||
py/noecho
|
||
|
||
Switches:
|
||
time - output an approximate execution time for <cmd>
|
||
edit - open a code editor for multi-line code experimentation
|
||
clientraw - turn off all client-specific escaping. Note that this may
|
||
lead to different output depending on prototocol (such as angular brackets
|
||
being parsed as HTML in the webclient but not in telnet clients)
|
||
noecho - in Python console mode, turn off the input echo (e.g. if your client
|
||
does this for you already)
|
||
|
||
Without argument, open a Python console in-game. This is a full console,
|
||
accepting multi-line Python code for testing and debugging. Type `exit()` to
|
||
return to the game. If Evennia is reloaded, the console will be closed.
|
||
|
||
Enter a line of instruction after the 'py' command to execute it
|
||
immediately. Separate multiple commands by ';' or open the code editor
|
||
using the /edit switch (all lines added in editor will be executed
|
||
immediately when closing or using the execute command in the editor).
|
||
|
||
A few variables are made available for convenience in order to offer access
|
||
to the system (you can import more at execution time).
|
||
|
||
Available variables in py environment:
|
||
self, me : caller
|
||
here : caller.location
|
||
evennia : the evennia API
|
||
inherits_from(obj, parent) : check object inheritance
|
||
|
||
You can explore The evennia API from inside the game by calling
|
||
the `__doc__` property on entities:
|
||
py evennia.__doc__
|
||
py evennia.managers.__doc__
|
||
|
||
|rNote: In the wrong hands this command is a severe security risk. It
|
||
should only be accessible by trusted server admins/superusers.|n
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>py</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>!</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(py) or perm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“System”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdPy</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">system.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="reload-cmdreload">
|
||
<h4>reload (CmdReload)<a class="headerlink" href="#reload-cmdreload" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">reload</span> <span class="n">the</span> <span class="n">server</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">reload</span> <span class="p">[</span><span class="n">reason</span><span class="p">]</span>
|
||
|
||
<span class="n">This</span> <span class="n">restarts</span> <span class="n">the</span> <span class="n">server</span><span class="o">.</span> <span class="n">The</span> <span class="n">Portal</span> <span class="ow">is</span> <span class="ow">not</span>
|
||
<span class="n">affected</span><span class="o">.</span> <span class="n">Non</span><span class="o">-</span><span class="n">persistent</span> <span class="n">scripts</span> <span class="n">will</span> <span class="n">survive</span> <span class="n">a</span> <span class="n">reload</span> <span class="p">(</span><span class="n">use</span>
|
||
<span class="n">reset</span> <span class="n">to</span> <span class="n">purge</span><span class="p">)</span> <span class="ow">and</span> <span class="n">at_reload</span><span class="p">()</span> <span class="n">hooks</span> <span class="n">will</span> <span class="n">be</span> <span class="n">called</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>reload</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>restart</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(reload) or perm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“System”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdReload</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">system.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="reset-cmdreset">
|
||
<h4>reset (CmdReset)<a class="headerlink" href="#reset-cmdreset" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">reset</span> <span class="ow">and</span> <span class="n">reboot</span> <span class="n">the</span> <span class="n">server</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">reset</span>
|
||
|
||
<span class="n">Notes</span><span class="p">:</span>
|
||
<span class="n">For</span> <span class="n">normal</span> <span class="n">updating</span> <span class="n">you</span> <span class="n">are</span> <span class="n">recommended</span> <span class="n">to</span> <span class="n">use</span> <span class="n">reload</span> <span class="n">rather</span>
|
||
<span class="n">than</span> <span class="n">this</span> <span class="n">command</span><span class="o">.</span> <span class="n">Use</span> <span class="n">shutdown</span> <span class="k">for</span> <span class="n">a</span> <span class="n">complete</span> <span class="n">stop</span> <span class="n">of</span>
|
||
<span class="n">everything</span><span class="o">.</span>
|
||
|
||
<span class="n">This</span> <span class="n">emulates</span> <span class="n">a</span> <span class="n">cold</span> <span class="n">reboot</span> <span class="n">of</span> <span class="n">the</span> <span class="n">Server</span> <span class="n">component</span> <span class="n">of</span> <span class="n">Evennia</span><span class="o">.</span>
|
||
<span class="n">The</span> <span class="n">difference</span> <span class="n">to</span> <span class="n">shutdown</span> <span class="ow">is</span> <span class="n">that</span> <span class="n">the</span> <span class="n">Server</span> <span class="n">will</span> <span class="n">auto</span><span class="o">-</span><span class="n">reboot</span>
|
||
<span class="ow">and</span> <span class="n">that</span> <span class="n">it</span> <span class="n">does</span> <span class="ow">not</span> <span class="n">affect</span> <span class="n">the</span> <span class="n">Portal</span><span class="p">,</span> <span class="n">so</span> <span class="n">no</span> <span class="n">users</span> <span class="n">will</span> <span class="n">be</span>
|
||
<span class="n">disconnected</span><span class="o">.</span> <span class="n">Contrary</span> <span class="n">to</span> <span class="n">reload</span> <span class="n">however</span><span class="p">,</span> <span class="nb">all</span> <span class="n">shutdown</span> <span class="n">hooks</span> <span class="n">will</span>
|
||
<span class="n">be</span> <span class="n">called</span> <span class="ow">and</span> <span class="nb">any</span> <span class="n">non</span><span class="o">-</span><span class="n">database</span> <span class="n">saved</span> <span class="n">scripts</span><span class="p">,</span> <span class="n">ndb</span><span class="o">-</span><span class="n">attributes</span><span class="p">,</span>
|
||
<span class="n">cmdsets</span> <span class="n">etc</span> <span class="n">will</span> <span class="n">be</span> <span class="n">wiped</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>reset</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>reboot</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(reload) or perm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“System”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdReset</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">system.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="scripts-cmdscripts">
|
||
<h4>scripts (CmdScripts)<a class="headerlink" href="#scripts-cmdscripts" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nb">list</span> <span class="ow">and</span> <span class="n">manage</span> <span class="nb">all</span> <span class="n">running</span> <span class="n">scripts</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">scripts</span><span class="p">[</span><span class="o">/</span><span class="n">switches</span><span class="p">]</span> <span class="p">[</span><span class="c1">#dbref, key, script.path or <obj>]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">start</span> <span class="o">-</span> <span class="n">start</span> <span class="n">a</span> <span class="n">script</span> <span class="p">(</span><span class="n">must</span> <span class="n">supply</span> <span class="n">a</span> <span class="n">script</span> <span class="n">path</span><span class="p">)</span>
|
||
<span class="n">stop</span> <span class="o">-</span> <span class="n">stops</span> <span class="n">an</span> <span class="n">existing</span> <span class="n">script</span>
|
||
<span class="n">kill</span> <span class="o">-</span> <span class="n">kills</span> <span class="n">a</span> <span class="n">script</span> <span class="o">-</span> <span class="n">without</span> <span class="n">running</span> <span class="n">its</span> <span class="n">cleanup</span> <span class="n">hooks</span>
|
||
<span class="n">validate</span> <span class="o">-</span> <span class="n">run</span> <span class="n">a</span> <span class="n">validation</span> <span class="n">on</span> <span class="n">the</span> <span class="n">script</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
|
||
|
||
<span class="n">If</span> <span class="n">no</span> <span class="n">switches</span> <span class="n">are</span> <span class="n">given</span><span class="p">,</span> <span class="n">this</span> <span class="n">command</span> <span class="n">just</span> <span class="n">views</span> <span class="nb">all</span> <span class="n">active</span>
|
||
<span class="n">scripts</span><span class="o">.</span> <span class="n">The</span> <span class="n">argument</span> <span class="n">can</span> <span class="n">be</span> <span class="n">either</span> <span class="n">an</span> <span class="nb">object</span><span class="p">,</span> <span class="n">at</span> <span class="n">which</span> <span class="n">point</span> <span class="n">it</span>
|
||
<span class="n">will</span> <span class="n">be</span> <span class="n">searched</span> <span class="k">for</span> <span class="nb">all</span> <span class="n">scripts</span> <span class="n">defined</span> <span class="n">on</span> <span class="n">it</span><span class="p">,</span> <span class="ow">or</span> <span class="n">a</span> <span class="n">script</span> <span class="n">name</span>
|
||
<span class="ow">or</span> <span class="c1">#dbref. For using the /stop switch, a unique script #dbref is</span>
|
||
<span class="n">required</span> <span class="n">since</span> <span class="n">whole</span> <span class="n">classes</span> <span class="n">of</span> <span class="n">scripts</span> <span class="n">often</span> <span class="n">have</span> <span class="n">the</span> <span class="n">same</span> <span class="n">name</span><span class="o">.</span>
|
||
|
||
<span class="n">Use</span> <span class="n">script</span> <span class="k">for</span> <span class="n">managing</span> <span class="n">commands</span> <span class="n">on</span> <span class="n">objects</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>scripts</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>globalscript</em>, <em>listscripts</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(listscripts) or perm(Admin)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“System”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdScripts</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">system.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="server-cmdserverload">
|
||
<h4>server (CmdServerLoad)<a class="headerlink" href="#server-cmdserverload" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">show</span> <span class="n">server</span> <span class="n">load</span> <span class="ow">and</span> <span class="n">memory</span> <span class="n">statistics</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">server</span><span class="p">[</span><span class="o">/</span><span class="n">mem</span><span class="p">]</span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="n">mem</span> <span class="o">-</span> <span class="k">return</span> <span class="n">only</span> <span class="n">a</span> <span class="n">string</span> <span class="n">of</span> <span class="n">the</span> <span class="n">current</span> <span class="n">memory</span> <span class="n">usage</span>
|
||
<span class="n">flushmem</span> <span class="o">-</span> <span class="n">flush</span> <span class="n">the</span> <span class="n">idmapper</span> <span class="n">cache</span>
|
||
|
||
<span class="n">This</span> <span class="n">command</span> <span class="n">shows</span> <span class="n">server</span> <span class="n">load</span> <span class="n">statistics</span> <span class="ow">and</span> <span class="n">dynamic</span> <span class="n">memory</span>
|
||
<span class="n">usage</span><span class="o">.</span> <span class="n">It</span> <span class="n">also</span> <span class="n">allows</span> <span class="n">to</span> <span class="n">flush</span> <span class="n">the</span> <span class="n">cache</span> <span class="n">of</span> <span class="n">accessed</span> <span class="n">database</span>
|
||
<span class="n">objects</span><span class="o">.</span>
|
||
|
||
<span class="n">Some</span> <span class="n">Important</span> <span class="n">statistics</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">table</span><span class="p">:</span>
|
||
|
||
<span class="o">|</span><span class="n">wServer</span> <span class="n">load</span><span class="o">|</span><span class="n">n</span> <span class="ow">is</span> <span class="n">an</span> <span class="n">average</span> <span class="n">of</span> <span class="n">processor</span> <span class="n">usage</span><span class="o">.</span> <span class="n">It</span><span class="s1">'s usually</span>
|
||
<span class="n">between</span> <span class="mi">0</span> <span class="p">(</span><span class="n">no</span> <span class="n">usage</span><span class="p">)</span> <span class="ow">and</span> <span class="mi">1</span> <span class="p">(</span><span class="mi">100</span><span class="o">%</span> <span class="n">usage</span><span class="p">),</span> <span class="n">but</span> <span class="n">may</span> <span class="n">also</span> <span class="n">be</span>
|
||
<span class="n">temporarily</span> <span class="n">higher</span> <span class="k">if</span> <span class="n">your</span> <span class="n">computer</span> <span class="n">has</span> <span class="n">multiple</span> <span class="n">CPU</span> <span class="n">cores</span><span class="o">.</span>
|
||
|
||
<span class="n">The</span> <span class="o">|</span><span class="n">wResident</span><span class="o">/</span><span class="n">Virtual</span> <span class="n">memory</span><span class="o">|</span><span class="n">n</span> <span class="n">displays</span> <span class="n">the</span> <span class="n">total</span> <span class="n">memory</span> <span class="n">used</span> <span class="n">by</span>
|
||
<span class="n">the</span> <span class="n">server</span> <span class="n">process</span><span class="o">.</span>
|
||
|
||
<span class="n">Evennia</span> <span class="o">|</span><span class="n">wcaches</span><span class="o">|</span><span class="n">n</span> <span class="nb">all</span> <span class="n">retrieved</span> <span class="n">database</span> <span class="n">entities</span> <span class="n">when</span> <span class="n">they</span> <span class="n">are</span>
|
||
<span class="n">loaded</span> <span class="n">by</span> <span class="n">use</span> <span class="n">of</span> <span class="n">the</span> <span class="n">idmapper</span> <span class="n">functionality</span><span class="o">.</span> <span class="n">This</span> <span class="n">allows</span> <span class="n">Evennia</span>
|
||
<span class="n">to</span> <span class="n">maintain</span> <span class="n">the</span> <span class="n">same</span> <span class="n">instances</span> <span class="n">of</span> <span class="n">an</span> <span class="n">entity</span> <span class="ow">and</span> <span class="n">allowing</span>
|
||
<span class="n">non</span><span class="o">-</span><span class="n">persistent</span> <span class="n">storage</span> <span class="n">schemes</span><span class="o">.</span> <span class="n">The</span> <span class="n">total</span> <span class="n">amount</span> <span class="n">of</span> <span class="n">cached</span> <span class="n">objects</span>
|
||
<span class="n">are</span> <span class="n">displayed</span> <span class="n">plus</span> <span class="n">a</span> <span class="n">breakdown</span> <span class="n">of</span> <span class="n">database</span> <span class="nb">object</span> <span class="n">types</span><span class="o">.</span>
|
||
|
||
<span class="n">The</span> <span class="o">|</span><span class="n">wflushmem</span><span class="o">|</span><span class="n">n</span> <span class="n">switch</span> <span class="n">allows</span> <span class="n">to</span> <span class="n">flush</span> <span class="n">the</span> <span class="nb">object</span> <span class="n">cache</span><span class="o">.</span> <span class="n">Please</span>
|
||
<span class="n">note</span> <span class="n">that</span> <span class="n">due</span> <span class="n">to</span> <span class="n">how</span> <span class="n">Python</span><span class="s1">'s memory management works, releasing</span>
|
||
<span class="n">caches</span> <span class="n">may</span> <span class="ow">not</span> <span class="n">show</span> <span class="n">you</span> <span class="n">a</span> <span class="n">lower</span> <span class="n">Residual</span><span class="o">/</span><span class="n">Virtual</span> <span class="n">memory</span> <span class="n">footprint</span><span class="p">,</span>
|
||
<span class="n">the</span> <span class="n">released</span> <span class="n">memory</span> <span class="n">will</span> <span class="n">instead</span> <span class="n">be</span> <span class="n">re</span><span class="o">-</span><span class="n">used</span> <span class="n">by</span> <span class="n">the</span> <span class="n">program</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>server</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>serverprocess</em>, <em>serverload</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(list) or perm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“System”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdServerLoad</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">system.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="service-cmdservice">
|
||
<h4>service (CmdService)<a class="headerlink" href="#service-cmdservice" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">manage</span> <span class="n">system</span> <span class="n">services</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">service</span><span class="p">[</span><span class="o">/</span><span class="n">switch</span><span class="p">]</span> <span class="o"><</span><span class="n">service</span><span class="o">></span>
|
||
|
||
<span class="n">Switches</span><span class="p">:</span>
|
||
<span class="nb">list</span> <span class="o">-</span> <span class="n">shows</span> <span class="nb">all</span> <span class="n">available</span> <span class="n">services</span> <span class="p">(</span><span class="n">default</span><span class="p">)</span>
|
||
<span class="n">start</span> <span class="o">-</span> <span class="n">activates</span> <span class="ow">or</span> <span class="n">reactivate</span> <span class="n">a</span> <span class="n">service</span>
|
||
<span class="n">stop</span> <span class="o">-</span> <span class="n">stops</span><span class="o">/</span><span class="n">inactivate</span> <span class="n">a</span> <span class="n">service</span> <span class="p">(</span><span class="n">can</span> <span class="n">often</span> <span class="n">be</span> <span class="n">restarted</span><span class="p">)</span>
|
||
<span class="n">delete</span> <span class="o">-</span> <span class="n">tries</span> <span class="n">to</span> <span class="n">permanently</span> <span class="n">remove</span> <span class="n">a</span> <span class="n">service</span>
|
||
|
||
<span class="n">Service</span> <span class="n">management</span> <span class="n">system</span><span class="o">.</span> <span class="n">Allows</span> <span class="k">for</span> <span class="n">the</span> <span class="n">listing</span><span class="p">,</span>
|
||
<span class="n">starting</span><span class="p">,</span> <span class="ow">and</span> <span class="n">stopping</span> <span class="n">of</span> <span class="n">services</span><span class="o">.</span> <span class="n">If</span> <span class="n">no</span> <span class="n">switches</span>
|
||
<span class="n">are</span> <span class="n">given</span><span class="p">,</span> <span class="n">services</span> <span class="n">will</span> <span class="n">be</span> <span class="n">listed</span><span class="o">.</span> <span class="n">Note</span> <span class="n">that</span> <span class="n">to</span> <span class="n">operate</span> <span class="n">on</span> <span class="n">the</span>
|
||
<span class="n">service</span> <span class="n">you</span> <span class="n">have</span> <span class="n">to</span> <span class="n">supply</span> <span class="n">the</span> <span class="n">full</span> <span class="p">(</span><span class="n">green</span> <span class="ow">or</span> <span class="n">red</span><span class="p">)</span> <span class="n">name</span> <span class="k">as</span> <span class="n">given</span>
|
||
<span class="ow">in</span> <span class="n">the</span> <span class="nb">list</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>service</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>services</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(service) or perm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“System”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdService</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">system.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="shutdown-cmdshutdown">
|
||
<h4>shutdown (CmdShutdown)<a class="headerlink" href="#shutdown-cmdshutdown" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">stop</span> <span class="n">the</span> <span class="n">server</span> <span class="n">completely</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">shutdown</span> <span class="p">[</span><span class="n">announcement</span><span class="p">]</span>
|
||
|
||
<span class="n">Gracefully</span> <span class="n">shut</span> <span class="n">down</span> <span class="n">both</span> <span class="n">Server</span> <span class="ow">and</span> <span class="n">Portal</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>shutdown</em></p></li>
|
||
<li><p><strong>aliases:</strong></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(shutdown) or perm(Developer)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“System”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdShutdown</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">system.py</a>.
|
||
Belongs to command set <em>‘DefaultAccount’</em> of class <code class="docutils literal notranslate"><span class="pre">AccountCmdSet</span></code> in [cmdset_account.py](https://gi
|
||
thub.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_account.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="time-cmdtime">
|
||
<h4>time (CmdTime)<a class="headerlink" href="#time-cmdtime" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">show</span> <span class="n">server</span> <span class="n">time</span> <span class="n">statistics</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">time</span>
|
||
|
||
<span class="n">List</span> <span class="n">Server</span> <span class="n">time</span> <span class="n">statistics</span> <span class="n">such</span> <span class="k">as</span> <span class="n">uptime</span>
|
||
<span class="ow">and</span> <span class="n">the</span> <span class="n">current</span> <span class="n">time</span> <span class="n">stamp</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>time</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>uptime</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:perm(time) or perm(Player)”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“System”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdTime</span></code> in
|
||
<a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/system.py">system.py</a>.
|
||
Belongs to command set <em>‘DefaultCharacter’</em> of class <code class="docutils literal notranslate"><span class="pre">CharacterCmdSet</span></code> in [cmdset_character.py](http
|
||
s://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_character.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="unloggedin-py">
|
||
<h3><code class="docutils literal notranslate"><span class="pre">unloggedin.py</span></code><a class="headerlink" href="#unloggedin-py" title="Permalink to this headline">¶</a></h3>
|
||
<p><a class="reference external" href="https://github.com/evennia/evennia/tree/master/evennia/commands/default/unloggedin.py">View unloggedin.py
|
||
source</a></p>
|
||
<div class="section" id="unloggedin-look-command-cmdunconnectedlook">
|
||
<h4>__unloggedin_look_command (CmdUnconnectedLook)<a class="headerlink" href="#unloggedin-look-command-cmdunconnectedlook" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">look</span> <span class="n">when</span> <span class="ow">in</span> <span class="n">unlogged</span><span class="o">-</span><span class="ow">in</span> <span class="n">state</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">look</span>
|
||
|
||
<span class="n">This</span> <span class="ow">is</span> <span class="n">an</span> <span class="n">unconnected</span> <span class="n">version</span> <span class="n">of</span> <span class="n">the</span> <span class="n">look</span> <span class="n">command</span> <span class="k">for</span> <span class="n">simplicity</span><span class="o">.</span>
|
||
|
||
<span class="n">This</span> <span class="ow">is</span> <span class="n">called</span> <span class="n">by</span> <span class="n">the</span> <span class="n">server</span> <span class="ow">and</span> <span class="n">kicks</span> <span class="n">everything</span> <span class="ow">in</span> <span class="n">gear</span><span class="o">.</span>
|
||
<span class="n">All</span> <span class="n">it</span> <span class="n">does</span> <span class="ow">is</span> <span class="n">display</span> <span class="n">the</span> <span class="n">connect</span> <span class="n">screen</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>__unloggedin_look_command</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>l</em>, <em>look</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdUnconnectedLook</span></code> in [unloggedin.py](https://github.com/evennia/evennia/tree/
|
||
master/evennia/commands/default/unloggedin.py).
|
||
Belongs to command set <em>‘DefaultUnloggedin’</em> of class <code class="docutils literal notranslate"><span class="pre">UnloggedinCmdSet</span></code> in [cmdset_unloggedin.py](h
|
||
ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).</p></li>
|
||
</ul>
|
||
<p><em>OBS: This is a [[System Command|Commands]]. System commands have fixed keys and are called by the
|
||
server in specific situations.</em></p>
|
||
</div>
|
||
<div class="section" id="connect-cmdunconnectedconnect">
|
||
<h4>connect (CmdUnconnectedConnect)<a class="headerlink" href="#connect-cmdunconnectedconnect" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">connect</span> <span class="n">to</span> <span class="n">the</span> <span class="n">game</span>
|
||
|
||
<span class="n">Usage</span> <span class="p">(</span><span class="n">at</span> <span class="n">login</span> <span class="n">screen</span><span class="p">):</span>
|
||
<span class="n">connect</span> <span class="n">accountname</span> <span class="n">password</span>
|
||
<span class="n">connect</span> <span class="s2">"account name"</span> <span class="s2">"pass word"</span>
|
||
|
||
<span class="n">Use</span> <span class="n">the</span> <span class="n">create</span> <span class="n">command</span> <span class="n">to</span> <span class="n">first</span> <span class="n">create</span> <span class="n">an</span> <span class="n">account</span> <span class="n">before</span> <span class="n">logging</span> <span class="ow">in</span><span class="o">.</span>
|
||
|
||
<span class="n">If</span> <span class="n">you</span> <span class="n">have</span> <span class="n">spaces</span> <span class="ow">in</span> <span class="n">your</span> <span class="n">name</span><span class="p">,</span> <span class="n">enclose</span> <span class="n">it</span> <span class="ow">in</span> <span class="n">double</span> <span class="n">quotes</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>connect</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>con</em>, <em>conn</em>, <em>co</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdUnconnectedConnect</span></code> in [unloggedin.py](https://github.com/evennia/evennia/tr
|
||
ee/master/evennia/commands/default/unloggedin.py).
|
||
Belongs to command set <em>‘DefaultUnloggedin’</em> of class <code class="docutils literal notranslate"><span class="pre">UnloggedinCmdSet</span></code> in [cmdset_unloggedin.py](h
|
||
ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="create-cmdunconnectedcreate">
|
||
<h4>create (CmdUnconnectedCreate)<a class="headerlink" href="#create-cmdunconnectedcreate" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">create</span> <span class="n">a</span> <span class="n">new</span> <span class="n">account</span> <span class="n">account</span>
|
||
|
||
<span class="n">Usage</span> <span class="p">(</span><span class="n">at</span> <span class="n">login</span> <span class="n">screen</span><span class="p">):</span>
|
||
<span class="n">create</span> <span class="o"><</span><span class="n">accountname</span><span class="o">></span> <span class="o"><</span><span class="n">password</span><span class="o">></span>
|
||
<span class="n">create</span> <span class="s2">"account name"</span> <span class="s2">"pass word"</span>
|
||
|
||
<span class="n">This</span> <span class="n">creates</span> <span class="n">a</span> <span class="n">new</span> <span class="n">account</span> <span class="n">account</span><span class="o">.</span>
|
||
|
||
<span class="n">If</span> <span class="n">you</span> <span class="n">have</span> <span class="n">spaces</span> <span class="ow">in</span> <span class="n">your</span> <span class="n">name</span><span class="p">,</span> <span class="n">enclose</span> <span class="n">it</span> <span class="ow">in</span> <span class="n">double</span> <span class="n">quotes</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>create</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>cre</em>, <em>cr</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdUnconnectedCreate</span></code> in [unloggedin.py](https://github.com/evennia/evennia/tre
|
||
e/master/evennia/commands/default/unloggedin.py).
|
||
Belongs to command set <em>‘DefaultUnloggedin’</em> of class <code class="docutils literal notranslate"><span class="pre">UnloggedinCmdSet</span></code> in [cmdset_unloggedin.py](h
|
||
ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="help-cmdunconnectedhelp">
|
||
<h4>help (CmdUnconnectedHelp)<a class="headerlink" href="#help-cmdunconnectedhelp" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">get</span> <span class="n">help</span> <span class="n">when</span> <span class="ow">in</span> <span class="n">unconnected</span><span class="o">-</span><span class="ow">in</span> <span class="n">state</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">help</span>
|
||
|
||
<span class="n">This</span> <span class="ow">is</span> <span class="n">an</span> <span class="n">unconnected</span> <span class="n">version</span> <span class="n">of</span> <span class="n">the</span> <span class="n">help</span> <span class="n">command</span><span class="p">,</span>
|
||
<span class="k">for</span> <span class="n">simplicity</span><span class="o">.</span> <span class="n">It</span> <span class="n">shows</span> <span class="n">a</span> <span class="n">pane</span> <span class="n">of</span> <span class="n">info</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>help</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>?</em>, <em>h</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdUnconnectedHelp</span></code> in [unloggedin.py](https://github.com/evennia/evennia/tree/
|
||
master/evennia/commands/default/unloggedin.py).
|
||
Belongs to command set <em>‘DefaultUnloggedin’</em> of class <code class="docutils literal notranslate"><span class="pre">UnloggedinCmdSet</span></code> in [cmdset_unloggedin.py](h
|
||
ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="quit-cmdunconnectedquit">
|
||
<h4>quit (CmdUnconnectedQuit)<a class="headerlink" href="#quit-cmdunconnectedquit" title="Permalink to this headline">¶</a></h4>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">quit</span> <span class="n">when</span> <span class="ow">in</span> <span class="n">unlogged</span><span class="o">-</span><span class="ow">in</span> <span class="n">state</span>
|
||
|
||
<span class="n">Usage</span><span class="p">:</span>
|
||
<span class="n">quit</span>
|
||
|
||
<span class="n">We</span> <span class="n">maintain</span> <span class="n">a</span> <span class="n">different</span> <span class="n">version</span> <span class="n">of</span> <span class="n">the</span> <span class="n">quit</span> <span class="n">command</span>
|
||
<span class="n">here</span> <span class="k">for</span> <span class="n">unconnected</span> <span class="n">accounts</span> <span class="k">for</span> <span class="n">the</span> <span class="n">sake</span> <span class="n">of</span> <span class="n">simplicity</span><span class="o">.</span> <span class="n">The</span> <span class="n">logged</span> <span class="ow">in</span>
|
||
<span class="n">version</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">bit</span> <span class="n">more</span> <span class="n">complicated</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p><strong>key:</strong> <em>quit</em></p></li>
|
||
<li><p><strong>aliases:</strong> <em>qu</em>, <em>q</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Locks.html"><span class="doc">locks</span></a>:</strong> <em>“cmd:all()”</em></p></li>
|
||
<li><p><strong><a class="reference internal" href="Help-System.html"><span class="doc">help_category</span></a>:</strong> <em>“General”</em></p></li>
|
||
<li><p><strong>Source:</strong> class <code class="docutils literal notranslate"><span class="pre">CmdUnconnectedQuit</span></code> in [unloggedin.py](https://github.com/evennia/evennia/tree/
|
||
master/evennia/commands/default/unloggedin.py).
|
||
Belongs to command set <em>‘DefaultUnloggedin’</em> of class <code class="docutils literal notranslate"><span class="pre">UnloggedinCmdSet</span></code> in [cmdset_unloggedin.py](h
|
||
ttps://github.com/evennia/evennia/tree/master/evennia/commands/default/cmdset_unloggedin.py).</p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<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>
|
||
<p><h3><a href="index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Default Command Help</a><ul>
|
||
<li><a class="reference internal" href="#a-z">A-Z</a></li>
|
||
<li><a class="reference internal" href="#a-z-by-source-file">A-Z by source file</a></li>
|
||
<li><a class="reference internal" href="#command-details">Command details</a><ul>
|
||
<li><a class="reference internal" href="#account-py"><code class="docutils literal notranslate"><span class="pre">account.py</span></code></a><ul>
|
||
<li><a class="reference internal" href="#charcreate-cmdcharcreate">charcreate (CmdCharCreate)</a></li>
|
||
<li><a class="reference internal" href="#chardelete-cmdchardelete">chardelete (CmdCharDelete)</a></li>
|
||
<li><a class="reference internal" href="#color-cmdcolortest">color (CmdColorTest)</a></li>
|
||
<li><a class="reference internal" href="#ic-cmdic">ic (CmdIC)</a></li>
|
||
<li><a class="reference internal" href="#look-cmdooclook">look (CmdOOCLook)</a></li>
|
||
<li><a class="reference internal" href="#ooc-cmdooc">ooc (CmdOOC)</a></li>
|
||
<li><a class="reference internal" href="#option-cmdoption">option (CmdOption)</a></li>
|
||
<li><a class="reference internal" href="#password-cmdpassword">password (CmdPassword)</a></li>
|
||
<li><a class="reference internal" href="#quell-cmdquell">quell (CmdQuell)</a></li>
|
||
<li><a class="reference internal" href="#quit-cmdquit">quit (CmdQuit)</a></li>
|
||
<li><a class="reference internal" href="#sessions-cmdsessions">sessions (CmdSessions)</a></li>
|
||
<li><a class="reference internal" href="#style-cmdstyle">style (CmdStyle)</a></li>
|
||
<li><a class="reference internal" href="#who-cmdwho">who (CmdWho)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#admin-py"><code class="docutils literal notranslate"><span class="pre">admin.py</span></code></a><ul>
|
||
<li><a class="reference internal" href="#ban-cmdban">ban (CmdBan)</a></li>
|
||
<li><a class="reference internal" href="#boot-cmdboot">boot (CmdBoot)</a></li>
|
||
<li><a class="reference internal" href="#emit-cmdemit">emit (CmdEmit)</a></li>
|
||
<li><a class="reference internal" href="#force-cmdforce">force (CmdForce)</a></li>
|
||
<li><a class="reference internal" href="#perm-cmdperm">perm (CmdPerm)</a></li>
|
||
<li><a class="reference internal" href="#unban-cmdunban">unban (CmdUnban)</a></li>
|
||
<li><a class="reference internal" href="#userpassword-cmdnewpassword">userpassword (CmdNewPassword)</a></li>
|
||
<li><a class="reference internal" href="#wall-cmdwall">wall (CmdWall)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#batchprocess-py"><code class="docutils literal notranslate"><span class="pre">batchprocess.py</span></code></a><ul>
|
||
<li><a class="reference internal" href="#batchcode-cmdbatchcode">batchcode (CmdBatchCode)</a></li>
|
||
<li><a class="reference internal" href="#batchcommands-cmdbatchcommands">batchcommands (CmdBatchCommands)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#building-py"><code class="docutils literal notranslate"><span class="pre">building.py</span></code></a><ul>
|
||
<li><a class="reference internal" href="#alias-cmdsetobjalias">alias (CmdSetObjAlias)</a></li>
|
||
<li><a class="reference internal" href="#cmdsets-cmdlistcmdsets">cmdsets (CmdListCmdSets)</a></li>
|
||
<li><a class="reference internal" href="#command-objmanipcommand">command (ObjManipCommand)</a></li>
|
||
<li><a class="reference internal" href="#copy-cmdcopy">copy (CmdCopy)</a></li>
|
||
<li><a class="reference internal" href="#cpattr-cmdcpattr">cpattr (CmdCpAttr)</a></li>
|
||
<li><a class="reference internal" href="#create-cmdcreate">create (CmdCreate)</a></li>
|
||
<li><a class="reference internal" href="#desc-cmddesc">desc (CmdDesc)</a></li>
|
||
<li><a class="reference internal" href="#destroy-cmddestroy">destroy (CmdDestroy)</a></li>
|
||
<li><a class="reference internal" href="#dig-cmddig">dig (CmdDig)</a></li>
|
||
<li><a class="reference internal" href="#examine-cmdexamine">examine (CmdExamine)</a></li>
|
||
<li><a class="reference internal" href="#find-cmdfind">find (CmdFind)</a></li>
|
||
<li><a class="reference internal" href="#link-cmdlink">link (CmdLink)</a></li>
|
||
<li><a class="reference internal" href="#lock-cmdlock">lock (CmdLock)</a></li>
|
||
<li><a class="reference internal" href="#mvattr-cmdmvattr">mvattr (CmdMvAttr)</a></li>
|
||
<li><a class="reference internal" href="#name-cmdname">name (CmdName)</a></li>
|
||
<li><a class="reference internal" href="#open-cmdopen">open (CmdOpen)</a></li>
|
||
<li><a class="reference internal" href="#script-cmdscript">script (CmdScript)</a></li>
|
||
<li><a class="reference internal" href="#set-cmdsetattribute">set (CmdSetAttribute)</a></li>
|
||
<li><a class="reference internal" href="#sethome-cmdsethome">sethome (CmdSetHome)</a></li>
|
||
<li><a class="reference internal" href="#spawn-cmdspawn">spawn (CmdSpawn)</a></li>
|
||
<li><a class="reference internal" href="#tag-cmdtag">tag (CmdTag)</a></li>
|
||
<li><a class="reference internal" href="#tel-cmdteleport">tel (CmdTeleport)</a></li>
|
||
<li><a class="reference internal" href="#tunnel-cmdtunnel">tunnel (CmdTunnel)</a></li>
|
||
<li><a class="reference internal" href="#typeclass-cmdtypeclass">typeclass (CmdTypeclass)</a></li>
|
||
<li><a class="reference internal" href="#unlink-cmdunlink">unlink (CmdUnLink)</a></li>
|
||
<li><a class="reference internal" href="#wipe-cmdwipe">wipe (CmdWipe)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#comms-py"><code class="docutils literal notranslate"><span class="pre">comms.py</span></code></a><ul>
|
||
<li><a class="reference internal" href="#addcom-cmdaddcom">addcom (CmdAddCom)</a></li>
|
||
<li><a class="reference internal" href="#allcom-cmdallcom">allcom (CmdAllCom)</a></li>
|
||
<li><a class="reference internal" href="#cboot-cmdcboot">cboot (CmdCBoot)</a></li>
|
||
<li><a class="reference internal" href="#ccreate-cmdchannelcreate">ccreate (CmdChannelCreate)</a></li>
|
||
<li><a class="reference internal" href="#cdesc-cmdcdesc">cdesc (CmdCdesc)</a></li>
|
||
<li><a class="reference internal" href="#cdestroy-cmdcdestroy">cdestroy (CmdCdestroy)</a></li>
|
||
<li><a class="reference internal" href="#cemit-cmdcemit">cemit (CmdCemit)</a></li>
|
||
<li><a class="reference internal" href="#channels-cmdchannels">channels (CmdChannels)</a></li>
|
||
<li><a class="reference internal" href="#clock-cmdclock">clock (CmdClock)</a></li>
|
||
<li><a class="reference internal" href="#cwho-cmdcwho">cwho (CmdCWho)</a></li>
|
||
<li><a class="reference internal" href="#delcom-cmddelcom">delcom (CmdDelCom)</a></li>
|
||
<li><a class="reference internal" href="#irc2chan-cmdirc2chan">irc2chan (CmdIRC2Chan)</a></li>
|
||
<li><a class="reference internal" href="#page-cmdpage">page (CmdPage)</a></li>
|
||
<li><a class="reference internal" href="#rss2chan-cmdrss2chan">rss2chan (CmdRSS2Chan)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#general-py"><code class="docutils literal notranslate"><span class="pre">general.py</span></code></a><ul>
|
||
<li><a class="reference internal" href="#access-cmdaccess">access (CmdAccess)</a></li>
|
||
<li><a class="reference internal" href="#drop-cmddrop">drop (CmdDrop)</a></li>
|
||
<li><a class="reference internal" href="#get-cmdget">get (CmdGet)</a></li>
|
||
<li><a class="reference internal" href="#give-cmdgive">give (CmdGive)</a></li>
|
||
<li><a class="reference internal" href="#home-cmdhome">home (CmdHome)</a></li>
|
||
<li><a class="reference internal" href="#inventory-cmdinventory">inventory (CmdInventory)</a></li>
|
||
<li><a class="reference internal" href="#look-cmdlook">look (CmdLook)</a></li>
|
||
<li><a class="reference internal" href="#nick-cmdnick">nick (CmdNick)</a></li>
|
||
<li><a class="reference internal" href="#pose-cmdpose">pose (CmdPose)</a></li>
|
||
<li><a class="reference internal" href="#say-cmdsay">say (CmdSay)</a></li>
|
||
<li><a class="reference internal" href="#setdesc-cmdsetdesc">setdesc (CmdSetDesc)</a></li>
|
||
<li><a class="reference internal" href="#whisper-cmdwhisper">whisper (CmdWhisper)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#help-py"><code class="docutils literal notranslate"><span class="pre">help.py</span></code></a><ul>
|
||
<li><a class="reference internal" href="#help-cmdhelp">help (CmdHelp)</a></li>
|
||
<li><a class="reference internal" href="#sethelp-cmdsethelp">sethelp (CmdSetHelp)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#system-py"><code class="docutils literal notranslate"><span class="pre">system.py</span></code></a><ul>
|
||
<li><a class="reference internal" href="#about-cmdabout">about (CmdAbout)</a></li>
|
||
<li><a class="reference internal" href="#objects-cmdobjects">objects (CmdObjects)</a></li>
|
||
<li><a class="reference internal" href="#py-cmdpy">py (CmdPy)</a></li>
|
||
<li><a class="reference internal" href="#reload-cmdreload">reload (CmdReload)</a></li>
|
||
<li><a class="reference internal" href="#reset-cmdreset">reset (CmdReset)</a></li>
|
||
<li><a class="reference internal" href="#scripts-cmdscripts">scripts (CmdScripts)</a></li>
|
||
<li><a class="reference internal" href="#server-cmdserverload">server (CmdServerLoad)</a></li>
|
||
<li><a class="reference internal" href="#service-cmdservice">service (CmdService)</a></li>
|
||
<li><a class="reference internal" href="#shutdown-cmdshutdown">shutdown (CmdShutdown)</a></li>
|
||
<li><a class="reference internal" href="#time-cmdtime">time (CmdTime)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#unloggedin-py"><code class="docutils literal notranslate"><span class="pre">unloggedin.py</span></code></a><ul>
|
||
<li><a class="reference internal" href="#unloggedin-look-command-cmdunconnectedlook">__unloggedin_look_command (CmdUnconnectedLook)</a></li>
|
||
<li><a class="reference internal" href="#connect-cmdunconnectedconnect">connect (CmdUnconnectedConnect)</a></li>
|
||
<li><a class="reference internal" href="#create-cmdunconnectedcreate">create (CmdUnconnectedCreate)</a></li>
|
||
<li><a class="reference internal" href="#help-cmdunconnectedhelp">help (CmdUnconnectedHelp)</a></li>
|
||
<li><a class="reference internal" href="#quit-cmdunconnectedquit">quit (CmdUnconnectedQuit)</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/Default-Command-Help.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="../1.0-dev/index.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="Default-Command-Help.html">0.9.5 (master 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="">Default Command Help</a></li>
|
||
</ul>
|
||
<div class="develop">develop branch</div>
|
||
</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> |