Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-06 07:57:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-06-16 22:49:43 +02:00
parent f505351730
commit a551188691
1002 changed files with 30387 additions and 9820 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/1.0-dev/api/evennia-api.html
View file

@ -7,11 +7,13 @@
<title>evennia &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia</a></li>
</ul>
</div>
@ -279,7 +284,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.accounts.html
View file

@ -7,11 +7,13 @@
<title>evennia.accounts package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.accounts package</a></li>
</ul>
</div>
@ -2477,7 +2482,10 @@ class built by <code class="docutils literal notranslate"><span class="pre">crea
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.accounts package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

130
docs/1.0-dev/api/evennia.commands.default.html
View file

@ -7,11 +7,13 @@
<title>evennia.commands.default package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.commands.default package</a></li>
</ul>
</div>
@ -68,7 +73,7 @@ method. Otherwise all text will be returned to all connected sessions.</p>
<p>Look in the ooc state.</p>
<dl class="attribute">
<dt id="evennia.commands.default.account.CmdOOCLook._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'ls', 'l')</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', 'ls', 'look')</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -83,7 +88,7 @@ method. Otherwise all text will be returned to all connected sessions.</p>
<dl class="attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -114,7 +119,7 @@ method. Otherwise all text will be returned to all connected sessions.</p>
<dl class="attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -201,7 +206,7 @@ as you the account have access right to puppet it.</p>
<p>This will leave your current character and put you in a incorporeal OOC state.</p>
<dl class="attribute">
<dt id="evennia.commands.default.account.CmdOOC._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('unpuppet', 'ooc')</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOC._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('ooc', 'unpuppet')</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOC._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -469,7 +474,7 @@ settings. Note that saved options may not be able to be used if
later connecting with a client with different capabilities.</p>
<dl class="attribute">
<dt id="evennia.commands.default.account.CmdOption._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('option', 'options')</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('options', 'option')</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -602,7 +607,7 @@ doing</p>
also for those with all permissions.</p>
<dl class="attribute">
<dt id="evennia.commands.default.account.CmdWho._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('doing', 'who')</em><a class="headerlink" href="#evennia.commands.default.account.CmdWho._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('who', 'doing')</em><a class="headerlink" href="#evennia.commands.default.account.CmdWho._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -766,7 +771,7 @@ use a higher-permission Character to escalate their permission level.
Use the unquell command to revert back to normal operation.</p>
<dl class="attribute">
<dt id="evennia.commands.default.account.CmdQuell._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('unquell', 'quell')</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('quell', 'unquell')</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1054,7 +1059,7 @@ accidentally block innocent users connecting from the same country
or region.</p>
<dl class="attribute">
<dt id="evennia.commands.default.admin.CmdBan._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('ban', 'bans')</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('bans', 'ban')</em><a class="headerlink" href="#evennia.commands.default.admin.CmdBan._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1196,7 +1201,7 @@ limited forms of emit, for sending to rooms and
to accounts respectively.</p>
<dl class="attribute">
<dt id="evennia.commands.default.admin.CmdEmit._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('pemit', 'emit', 'remit')</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('emit', 'pemit', 'remit')</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1322,7 +1327,7 @@ account - set permission on an account (same as adding * to name)</p>
or account. If no permission is given, list all permissions on &lt;object&gt;.</p>
<dl class="attribute">
<dt id="evennia.commands.default.admin.CmdPerm._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('setperm', 'perm')</em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('perm', 'setperm')</em><a class="headerlink" href="#evennia.commands.default.admin.CmdPerm._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1540,7 +1545,7 @@ skipping, reloading etc.</p>
<dl class="attribute">
<dt id="evennia.commands.default.batchprocess.CmdBatchCommands.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['batchcmd', 'batchcommand']</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['batchcommand', 'batchcmd']</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -1571,7 +1576,7 @@ skipping, reloading etc.</p>
<dl class="attribute">
<dt id="evennia.commands.default.batchprocess.CmdBatchCommands.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'batchcmd batchcommand', 'category': 'building', 'key': 'batchcommands', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] &lt;python.path.to.file&gt;\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n\n Runs batches of commands from a batch-cmd text file (*.ev).\n\n '}</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'batchcommand batchcmd', 'category': 'building', 'key': 'batchcommands', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] &lt;python.path.to.file&gt;\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n\n Runs batches of commands from a batch-cmd text file (*.ev).\n\n '}</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1603,7 +1608,7 @@ object copies behind when testing out the script.</p>
<p>Runs batches of commands from a batch-code text file (<a href="#id9"><span class="problematic" id="id10">*</span></a>.py).</p>
<dl class="attribute">
<dt id="evennia.commands.default.batchprocess.CmdBatchCode._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('batchcodes', 'batchcode')</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCode._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('batchcode', 'batchcodes')</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCode._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1746,7 +1751,7 @@ changing the object in question, making those aliases usable
by everyone.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdSetObjAlias._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('setobjalias', 'alias')</em><a class="headerlink" href="#evennia.commands.default.building.CmdSetObjAlias._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('alias', 'setobjalias')</em><a class="headerlink" href="#evennia.commands.default.building.CmdSetObjAlias._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2131,7 +2136,7 @@ object of this type like this:</p>
describe the current room.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdDesc._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('describe', 'desc')</em><a class="headerlink" href="#evennia.commands.default.building.CmdDesc._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('desc', 'describe')</em><a class="headerlink" href="#evennia.commands.default.building.CmdDesc._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2712,7 +2717,7 @@ to a user. Defaults to yourself.</p>
rename an account.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdName._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('rename', 'name')</em><a class="headerlink" href="#evennia.commands.default.building.CmdName._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('name', 'rename')</em><a class="headerlink" href="#evennia.commands.default.building.CmdName._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3046,7 +3051,7 @@ module is searched from the default typeclass directory, as defined in the
server settings.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdTypeclass._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('swap', 'type', 'parent', 'update', 'typeclass')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('typeclass', 'parent', 'type', 'update', 'swap')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3056,7 +3061,7 @@ server settings.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdTypeclass.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['swap', 'type', 'parent', 'update']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['swap', 'type', 'update', 'parent']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -3087,7 +3092,7 @@ server settings.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdTypeclass.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'swap type parent update', 'category': 'building', 'key': 'typeclass', 'tags': '', 'text': &quot;\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] &lt;object&gt; [= typeclass.path]\n typeclass/prototype &lt;object&gt; = prototype_key\n\n typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object.\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'swap type update parent', 'category': 'building', 'key': 'typeclass', 'tags': '', 'text': &quot;\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] &lt;object&gt; [= typeclass.path]\n typeclass/prototype &lt;object&gt; = prototype_key\n\n typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object.\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3260,7 +3265,7 @@ If object is not specified, the current location is examined.</p>
<p>Append a * before the search string to examine an account.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdExamine._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('examine', 'exam', 'ex')</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('exam', 'examine', 'ex')</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3360,7 +3365,7 @@ limits matches to within the given dbrefs range, or above/below if only
one is given.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdFind._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('locate', 'search', 'find')</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('find', 'locate', 'search')</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3370,7 +3375,7 @@ one is given.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdFind.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['locate', 'search']</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['search', 'locate']</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -3401,7 +3406,7 @@ one is given.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdFind.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'locate search', 'category': 'building', 'key': 'find', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] &lt;name or dbref or *account&gt; [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'search locate', 'category': 'building', 'key': 'find', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] &lt;name or dbref or *account&gt; [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3443,7 +3448,7 @@ reference. A puppeted object cannot be moved to None.</p>
teleported to the target location.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdTeleport._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('teleport', 'tel')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTeleport._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('tel', 'teleport')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTeleport._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3520,7 +3525,7 @@ object without specifying a script key/path will start/stop ALL scripts on
the object.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdScript._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('script', 'addscript')</em><a class="headerlink" href="#evennia.commands.default.building.CmdScript._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('addscript', 'script')</em><a class="headerlink" href="#evennia.commands.default.building.CmdScript._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3596,7 +3601,7 @@ should be used with restrain - tags on their own are usually
enough to for most grouping schemes.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdTag._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('tags', 'tag')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTag._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('tag', 'tags')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTag._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3748,7 +3753,7 @@ prototype-details.</p></li>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdSpawn._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('spawn', 'olc')</em><a class="headerlink" href="#evennia.commands.default.building.CmdSpawn._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('olc', 'spawn')</em><a class="headerlink" href="#evennia.commands.default.building.CmdSpawn._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -4011,7 +4016,7 @@ name. Subsequent calls of this command can be used to add multiple
aliases to an already joined channel.</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdAddCom._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('addcom', 'chanalias', 'aliaschan')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('chanalias', 'aliaschan', 'addcom')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4078,7 +4083,7 @@ unsubscribe. If the ‘all’ switch is used, remove all aliases
for that channel.</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdDelCom._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('delchanalias', 'delcom', 'delaliaschan')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('delcom', 'delchanalias', 'delaliaschan')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4211,7 +4216,7 @@ Use ‘comlist’ to only view your current channel subscriptions.
Use addcom/delcom to join and leave channels</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdChannels._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('clist', 'channels', 'comlist', 'channellist', 'chanlist', 'all channels')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('comlist', 'clist', 'channellist', 'chanlist', 'channels', 'all channels')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4226,7 +4231,7 @@ Use addcom/delcom to join and leave channels</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdChannels.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['clist', 'comlist', 'channellist', 'chanlist', 'all channels']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['comlist', 'clist', 'channellist', 'chanlist', 'all channels']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -4257,7 +4262,7 @@ Use addcom/delcom to join and leave channels</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdChannels.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'clist comlist channellist chanlist all channels', 'category': 'comms', 'key': 'channels', 'tags': '', 'text': &quot;\n list all channels available to you\n\n Usage:\n channels\n clist\n comlist\n\n Lists all channels available to you, whether you listen to them or not.\n Use 'comlist' to only view your current channel subscriptions.\n Use addcom/delcom to join and leave channels\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'comlist clist channellist chanlist all channels', 'category': 'comms', 'key': 'channels', 'tags': '', 'text': &quot;\n list all channels available to you\n\n Usage:\n channels\n clist\n comlist\n\n Lists all channels available to you, whether you listen to them or not.\n Use 'comlist' to only view your current channel subscriptions.\n Use addcom/delcom to join and leave channels\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -4412,7 +4417,7 @@ they control it. It does not show the user’s name unless they
provide the /sendername switch.</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdCemit._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('cmsg', 'cemit')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('cemit', 'cmsg')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5056,7 +5061,7 @@ look <a href="#id101"><span class="problematic" id="id102">*</span></a>&lt;accou
<p>Observes your location or objects in your vicinity.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdLook._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'ls', 'l')</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', 'ls', 'look')</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5066,7 +5071,7 @@ look <a href="#id101"><span class="problematic" id="id102">*</span></a>&lt;accou
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5102,7 +5107,7 @@ look <a href="#id101"><span class="problematic" id="id102">*</span></a>&lt;accou
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look &lt;obj&gt;\n look *&lt;account&gt;\n\n Observes your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look &lt;obj&gt;\n look *&lt;account&gt;\n\n Observes your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -5154,7 +5159,7 @@ 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.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdNick._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('nick', 'nicks', 'nickname')</em><a class="headerlink" href="#evennia.commands.default.general.CmdNick._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('nicks', 'nickname', 'nick')</em><a class="headerlink" href="#evennia.commands.default.general.CmdNick._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5224,7 +5229,7 @@ inv</p>
<p>Shows your inventory.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdInventory._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('inventory', 'i', 'inv')</em><a class="headerlink" href="#evennia.commands.default.general.CmdInventory._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('i', 'inv', 'inventory')</em><a class="headerlink" href="#evennia.commands.default.general.CmdInventory._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5549,7 +5554,7 @@ placing it in their inventory.</p>
<p>Talk to those in your current location.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdSay._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&quot;', 'say', &quot;'&quot;)</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('say', '&quot;', &quot;'&quot;)</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5675,7 +5680,7 @@ pose’s &lt;pose text&gt;</p>
automatically begin with your name.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdPose._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = (':', 'pose', 'emote')</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = (':', 'emote', 'pose')</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5744,7 +5749,7 @@ space.</p>
which permission groups you are a member of.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdAccess._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('access', 'hierarchy', 'groups')</em><a class="headerlink" href="#evennia.commands.default.general.CmdAccess._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('hierarchy', 'access', 'groups')</em><a class="headerlink" href="#evennia.commands.default.general.CmdAccess._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6609,7 +6614,7 @@ affected. Non-persistent scripts will survive a reload (use
reset to purge) and at_reload() hooks will be called.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdReload._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('reload', 'restart')</em><a class="headerlink" href="#evennia.commands.default.system.CmdReload._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('restart', 'reload')</em><a class="headerlink" href="#evennia.commands.default.system.CmdReload._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6676,7 +6681,7 @@ be called and any non-database saved scripts, ndb-attributes,
cmdsets etc will be wiped.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdReset._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('reboot', 'reset')</em><a class="headerlink" href="#evennia.commands.default.system.CmdReset._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('reset', 'reboot')</em><a class="headerlink" href="#evennia.commands.default.system.CmdReset._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6831,7 +6836,7 @@ py evennia.managers.__doc__</p>
should only be accessible by trusted server admins/superusers.|n</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdPy._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('py', '!')</em><a class="headerlink" href="#evennia.commands.default.system.CmdPy._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('!', 'py')</em><a class="headerlink" href="#evennia.commands.default.system.CmdPy._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6904,7 +6909,7 @@ required since whole classes of scripts often have the same name.</p>
<p>Use script for managing commands on objects.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdScripts._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('scripts', 'listscripts', 'globalscript')</em><a class="headerlink" href="#evennia.commands.default.system.CmdScripts._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('globalscript', 'listscripts', 'scripts')</em><a class="headerlink" href="#evennia.commands.default.system.CmdScripts._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6914,7 +6919,7 @@ required since whole classes of scripts often have the same name.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdScripts.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['listscripts', 'globalscript']</em><a class="headerlink" href="#evennia.commands.default.system.CmdScripts.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['globalscript', 'listscripts']</em><a class="headerlink" href="#evennia.commands.default.system.CmdScripts.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6950,7 +6955,7 @@ required since whole classes of scripts often have the same name.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdScripts.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'listscripts globalscript', 'category': 'system', 'key': 'scripts', 'tags': '', 'text': '\n list and manage all running scripts\n\n Usage:\n scripts[/switches] [#dbref, key, script.path or &lt;obj&gt;]\n\n Switches:\n start - start a script (must supply a script path)\n stop - stops an existing script\n kill - kills a script - without running its cleanup hooks\n validate - run a validation on the script(s)\n\n If no switches are given, this command just views all active\n scripts. The argument can be either an object, at which point it\n will be searched for all scripts defined on it, or a script name\n or #dbref. For using the /stop switch, a unique script #dbref is\n required since whole classes of scripts often have the same name.\n\n Use script for managing commands on objects.\n '}</em><a class="headerlink" href="#evennia.commands.default.system.CmdScripts.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'globalscript listscripts', 'category': 'system', 'key': 'scripts', 'tags': '', 'text': '\n list and manage all running scripts\n\n Usage:\n scripts[/switches] [#dbref, key, script.path or &lt;obj&gt;]\n\n Switches:\n start - start a script (must supply a script path)\n stop - stops an existing script\n kill - kills a script - without running its cleanup hooks\n validate - run a validation on the script(s)\n\n If no switches are given, this command just views all active\n scripts. The argument can be either an object, at which point it\n will be searched for all scripts defined on it, or a script name\n or #dbref. For using the /stop switch, a unique script #dbref is\n required since whole classes of scripts often have the same name.\n\n Use script for managing commands on objects.\n '}</em><a class="headerlink" href="#evennia.commands.default.system.CmdScripts.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6974,7 +6979,7 @@ a list of &lt;nr&gt; latest objects in database. If not
given, &lt;nr&gt; defaults to 10.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdObjects._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('listobjects', 'objects', 'stats', 'listobjs', 'db')</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('stats', 'db', 'listobjects', 'listobjs', 'objects')</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6984,7 +6989,7 @@ given, &lt;nr&gt; defaults to 10.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdObjects.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['stats', 'listobjects', 'db', 'listobjs']</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['db', 'stats', 'listobjects', 'listobjs']</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -7015,7 +7020,7 @@ given, &lt;nr&gt; defaults to 10.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdObjects.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'stats listobjects db listobjs', 'category': 'system', 'key': 'objects', 'tags': '', 'text': '\n statistics on objects in the database\n\n Usage:\n objects [&lt;nr&gt;]\n\n Gives statictics on objects in database as well as\n a list of &lt;nr&gt; latest objects in database. If not\n given, &lt;nr&gt; defaults to 10.\n '}</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'db stats listobjects listobjs', 'category': 'system', 'key': 'objects', 'tags': '', 'text': '\n statistics on objects in the database\n\n Usage:\n objects [&lt;nr&gt;]\n\n Gives statictics on objects in database as well as\n a list of &lt;nr&gt; latest objects in database. If not\n given, &lt;nr&gt; defaults to 10.\n '}</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -7241,7 +7246,7 @@ caches may not show you a lower Residual/Virtual memory footprint,
the released memory will instead be re-used by the program.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdServerLoad._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('serverprocess', 'server', 'serverload')</em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('serverload', 'serverprocess', 'server')</em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7251,7 +7256,7 @@ the released memory will instead be re-used by the program.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdServerLoad.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['serverprocess', 'serverload']</em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['serverload', 'serverprocess']</em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -7282,7 +7287,7 @@ the released memory will instead be re-used by the program.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdServerLoad.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'serverprocess serverload', 'category': 'system', 'key': 'server', 'tags': '', 'text': &quot;\n show server load and memory statistics\n\n Usage:\n server[/mem]\n\n Switches:\n mem - return only a string of the current memory usage\n flushmem - flush the idmapper cache\n\n This command shows server load statistics and dynamic memory\n usage. It also allows to flush the cache of accessed database\n objects.\n\n Some Important statistics in the table:\n\n |wServer load|n is an average of processor usage. It's usually\n between 0 (no usage) and 1 (100% usage), but may also be\n temporarily higher if your computer has multiple CPU cores.\n\n The |wResident/Virtual memory|n displays the total memory used by\n the server process.\n\n Evennia |wcaches|n all retrieved database entities when they are\n loaded by use of the idmapper functionality. This allows Evennia\n to maintain the same instances of an entity and allowing\n non-persistent storage schemes. The total amount of cached objects\n are displayed plus a breakdown of database object types.\n\n The |wflushmem|n switch allows to flush the object cache. Please\n note that due to how Python's memory management works, releasing\n caches may not show you a lower Residual/Virtual memory footprint,\n the released memory will instead be re-used by the program.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'serverload serverprocess', 'category': 'system', 'key': 'server', 'tags': '', 'text': &quot;\n show server load and memory statistics\n\n Usage:\n server[/mem]\n\n Switches:\n mem - return only a string of the current memory usage\n flushmem - flush the idmapper cache\n\n This command shows server load statistics and dynamic memory\n usage. It also allows to flush the cache of accessed database\n objects.\n\n Some Important statistics in the table:\n\n |wServer load|n is an average of processor usage. It's usually\n between 0 (no usage) and 1 (100% usage), but may also be\n temporarily higher if your computer has multiple CPU cores.\n\n The |wResident/Virtual memory|n displays the total memory used by\n the server process.\n\n Evennia |wcaches|n all retrieved database entities when they are\n loaded by use of the idmapper functionality. This allows Evennia\n to maintain the same instances of an entity and allowing\n non-persistent storage schemes. The total amount of cached objects\n are displayed plus a breakdown of database object types.\n\n The |wflushmem|n switch allows to flush the object cache. Please\n note that due to how Python's memory management works, releasing\n caches may not show you a lower Residual/Virtual memory footprint,\n the released memory will instead be re-used by the program.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.system.CmdServerLoad.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7934,7 +7939,7 @@ connect “account name” “pass word”</p>
<p>If you have spaces in your name, enclose it in double quotes.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('conn', 'co', 'connect', 'con')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('connect', 'co', 'con', 'conn')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7944,7 +7949,7 @@ connect “account name” “pass word”</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'conn', 'con']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'con', 'conn']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7984,7 +7989,7 @@ there is no object yet before the account has logged in)</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect &quot;account name&quot; &quot;pass word&quot;\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'co con conn', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect &quot;account name&quot; &quot;pass word&quot;\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -8128,7 +8133,7 @@ version is a bit more complicated.</p>
All it does is display the connect screen.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'l', '__unloggedin_look_command')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', '__unloggedin_look_command', 'look')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -8138,7 +8143,7 @@ All it does is display the connect screen.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'look']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -8169,7 +8174,7 @@ All it does is display the connect screen.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -8305,7 +8310,10 @@ for simplicity. It shows a pane of info.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.commands.default package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.commands.html
View file

@ -7,11 +7,13 @@
<title>evennia.commands package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.commands package</a></li>
</ul>
</div>
@ -2728,7 +2733,10 @@ replace this without disabling auto_help.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.commands package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.comms.html
View file

@ -7,11 +7,13 @@
<title>evennia.comms package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.comms package</a></li>
</ul>
</div>
@ -2398,7 +2403,10 @@ object the first time, the query is executed.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.comms package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.contrib.awsstorage.html
View file

@ -7,11 +7,13 @@
<title>evennia.contrib.awsstorage package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.awsstorage package</a></li>
</ul>
</div>
@ -915,7 +920,10 @@ it will return a default.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.awsstorage package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

66
docs/1.0-dev/api/evennia.contrib.html
View file

@ -7,11 +7,13 @@
<title>evennia.contrib package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib package</a></li>
</ul>
</div>
@ -222,7 +227,7 @@ your mind as long as the other party has not yet accepted. You can inspect
the current offer using the ‘offers’ command.</p>
<dl class="attribute">
<dt id="evennia.contrib.barter.CmdAccept._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('agree', 'accept')</em><a class="headerlink" href="#evennia.contrib.barter.CmdAccept._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('accept', 'agree')</em><a class="headerlink" href="#evennia.contrib.barter.CmdAccept._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -342,7 +347,7 @@ decline the old offer.</p>
determine if it’s worth your while.</p>
<dl class="attribute">
<dt id="evennia.contrib.barter.CmdEvaluate._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('eval', 'evaluate')</em><a class="headerlink" href="#evennia.contrib.barter.CmdEvaluate._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('evaluate', 'eval')</em><a class="headerlink" href="#evennia.contrib.barter.CmdEvaluate._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -401,7 +406,7 @@ finish trade [:say]</p>
<p>This ends the trade prematurely. No trade will take place.</p>
<dl class="attribute">
<dt id="evennia.contrib.barter.CmdFinish._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('end trade', 'finish trade')</em><a class="headerlink" href="#evennia.contrib.barter.CmdFinish._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('finish trade', 'end trade')</em><a class="headerlink" href="#evennia.contrib.barter.CmdFinish._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -523,7 +528,7 @@ change your deal. You might also want to use ‘say’, ‘emote’ etc to
try to influence the other part in the deal.</p>
<dl class="attribute">
<dt id="evennia.contrib.barter.CmdStatus._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('offers', 'status', 'deal')</em><a class="headerlink" href="#evennia.contrib.barter.CmdStatus._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('status', 'offers', 'deal')</em><a class="headerlink" href="#evennia.contrib.barter.CmdStatus._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -588,7 +593,7 @@ optional say part works like the say command and allows you to add
info to your choice.</p>
<dl class="attribute">
<dt id="evennia.contrib.barter.CmdTrade._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('trade', 'barter')</em><a class="headerlink" href="#evennia.contrib.barter.CmdTrade._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('barter', 'trade')</em><a class="headerlink" href="#evennia.contrib.barter.CmdTrade._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2092,7 +2097,7 @@ have an in-game existence, there is no concept of location or
at them with this command.</p>
<dl class="attribute">
<dt id="evennia.contrib.chargen.CmdOOCLook._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'ls', 'l')</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', 'ls', 'look')</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2102,7 +2107,7 @@ at them with this command.</p>
<dl class="attribute">
<dt id="evennia.contrib.chargen.CmdOOCLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -2139,7 +2144,7 @@ that is checked by the &#64;ic command directly.</p>
<dl class="attribute">
<dt id="evennia.contrib.chargen.CmdOOCLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n ooc look\n\n Usage:\n look\n look &lt;character&gt;\n\n This is an OOC version of the look command. Since an Account doesn\'t\n have an in-game existence, there is no concept of location or\n &quot;self&quot;.\n\n If any characters are available for you to control, you may look\n at them with this command.\n '}</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n ooc look\n\n Usage:\n look\n look &lt;character&gt;\n\n This is an OOC version of the look command. Since an Account doesn\'t\n have an in-game existence, there is no concept of location or\n &quot;self&quot;.\n\n If any characters are available for you to control, you may look\n at them with this command.\n '}</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -2588,7 +2593,7 @@ inv</p>
<p>Shows your inventory.</p>
<dl class="attribute">
<dt id="evennia.contrib.clothing.CmdInventory._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('inventory', 'i', 'inv')</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('i', 'inv', 'inventory')</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3405,7 +3410,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.</p>
<p>Use the create command to first create an account before logging in.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('conn', 'co', 'connect', 'con')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('connect', 'co', 'con', 'conn')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3415,7 +3420,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'conn', 'con']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'con', 'conn']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -3450,7 +3455,7 @@ there is no object yet before the account has logged in)</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect &lt;email&gt; &lt;password&gt;\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'co con conn', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect &lt;email&gt; &lt;password&gt;\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -3587,7 +3592,7 @@ version is a bit more complicated.</p>
All it does is display the connect screen.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedLook._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'l', '__unloggedin_look_command')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', '__unloggedin_look_command', 'look')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3597,7 +3602,7 @@ All it does is display the connect screen.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'look']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -3628,7 +3633,7 @@ All it does is display the connect screen.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -3791,7 +3796,7 @@ timeslot. The available times are night, morning, afternoon and evening.</p>
version of the <cite>desc</cite> command.</p>
<dl class="attribute">
<dt id="evennia.contrib.extended_room.CmdExtendedRoomDesc._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('describe', 'desc')</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('desc', 'describe')</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomDesc._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3989,7 +3994,7 @@ look <a href="#id64"><span class="problematic" id="id65">*</span></a>&lt;account
<p>Observes your location, details at your location or objects in your vicinity.</p>
<dl class="attribute">
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'ls', 'l')</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', 'ls', 'look')</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3999,7 +4004,7 @@ look <a href="#id64"><span class="problematic" id="id65">*</span></a>&lt;account
<dl class="attribute">
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -4025,7 +4030,7 @@ look <a href="#id64"><span class="problematic" id="id65">*</span></a>&lt;account
<dl class="attribute">
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look &lt;obj&gt;\n look &lt;room detail&gt;\n look *&lt;account&gt;\n\n Observes your location, details at your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look &lt;obj&gt;\n look &lt;room detail&gt;\n look *&lt;account&gt;\n\n Observes your location, details at your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -5529,7 +5534,7 @@ as plain text. Use e.g. ansi line break ||/ to add a new
paragraph and + + or ansi space ||_ to add extra whitespace.</p>
<dl class="attribute">
<dt id="evennia.contrib.multidescer.CmdMultiDesc._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('+desc', 'desc')</em><a class="headerlink" href="#evennia.contrib.multidescer.CmdMultiDesc._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('desc', '+desc')</em><a class="headerlink" href="#evennia.contrib.multidescer.CmdMultiDesc._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5762,7 +5767,7 @@ these objects are not needed anymore and can be deleted. Components of the puzzl
will be re-created by use of the <cite>&#64;armpuzzle</cite> command later.</p>
<dl class="attribute">
<dt id="evennia.contrib.puzzles.CmdCreatePuzzleRecipe._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;puzzle', '&#64;puzzlerecipe')</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;puzzlerecipe', '&#64;puzzle')</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6068,7 +6073,7 @@ to all the variables defined therein.</p>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.puzzles.CmdUsePuzzleParts._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('use', 'combine')</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdUsePuzzleParts._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('combine', 'use')</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdUsePuzzleParts._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7130,7 +7135,7 @@ forget griatch</p>
Using the command without arguments will list all current recogs.</p>
<dl class="attribute">
<dt id="evennia.contrib.rpsystem.CmdRecog._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('recog', 'forget', 'recognize')</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdRecog._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('recognize', 'forget', 'recog')</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdRecog._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7140,7 +7145,7 @@ Using the command without arguments will list all current recogs.</p>
<dl class="attribute">
<dt id="evennia.contrib.rpsystem.CmdRecog.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['forget', 'recognize']</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdRecog.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['recognize', 'forget']</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdRecog.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -7172,7 +7177,7 @@ Using the command without arguments will list all current recogs.</p>
<dl class="attribute">
<dt id="evennia.contrib.rpsystem.CmdRecog.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'forget recognize', 'category': 'general', 'key': 'recog', 'tags': '', 'text': '\n Recognize another person in the same room.\n\n Usage:\n recog\n recog sdesc as alias\n forget alias\n\n Example:\n recog tall man as Griatch\n forget griatch\n\n This will assign a personal alias for a person, or forget said alias.\n Using the command without arguments will list all current recogs.\n\n '}</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdRecog.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'recognize forget', 'category': 'general', 'key': 'recog', 'tags': '', 'text': '\n Recognize another person in the same room.\n\n Usage:\n recog\n recog sdesc as alias\n forget alias\n\n Example:\n recog tall man as Griatch\n forget griatch\n\n This will assign a personal alias for a person, or forget said alias.\n Using the command without arguments will list all current recogs.\n\n '}</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdRecog.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -7189,7 +7194,7 @@ Using the command without arguments will list all current recogs.</p>
<p>Talk to those in your current location.</p>
<dl class="attribute">
<dt id="evennia.contrib.rpsystem.CmdSay._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&quot;', 'say', &quot;'&quot;)</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('say', '&quot;', &quot;'&quot;)</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -8239,7 +8244,7 @@ close &lt;door&gt;</p>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.simpledoor.CmdOpenCloseDoor._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('close', 'open')</em><a class="headerlink" href="#evennia.contrib.simpledoor.CmdOpenCloseDoor._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('open', 'close')</em><a class="headerlink" href="#evennia.contrib.simpledoor.CmdOpenCloseDoor._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -12666,7 +12671,10 @@ default one</p></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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

18
docs/1.0-dev/api/evennia.contrib.ingame_python.html
View file

@ -7,11 +7,13 @@
<title>evennia.contrib.ingame_python package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.ingame_python package</a></li>
</ul>
</div>
@ -324,7 +329,7 @@ object’s callbacks, return an empty list.</p>
<p>Command to edit callbacks.</p>
<dl class="attribute">
<dt id="evennia.contrib.ingame_python.commands.CmdCallback._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;call', '&#64;calls', '&#64;callback', '&#64;callbacks')</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;calls', '&#64;call', '&#64;callback', '&#64;callbacks')</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -346,7 +351,7 @@ object’s callbacks, return an empty list.</p>
<dl class="attribute">
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;calls', '&#64;callbacks', '&#64;callback']</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;calls', '&#64;callback', '&#64;callbacks']</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -423,7 +428,7 @@ on user permission.</p>
<dl class="attribute">
<dt id="evennia.contrib.ingame_python.commands.CmdCallback.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;calls &#64;callbacks &#64;callback', 'category': 'building', 'key': '&#64;call', 'tags': '', 'text': '\n Command to edit callbacks.\n '}</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;calls &#64;callback &#64;callbacks', 'category': 'building', 'key': '&#64;call', 'tags': '', 'text': '\n Command to edit callbacks.\n '}</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -1667,7 +1672,10 @@ temporary storage, waiting for the script to be initialized.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.ingame_python package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.contrib.security.auditing.html
View file

@ -7,11 +7,13 @@
<title>evennia.contrib.security.auditing package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.security.auditing package</a></li>
</ul>
</div>
@ -254,7 +259,10 @@ information from strings.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.security.auditing package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.contrib.security.html
View file

@ -7,11 +7,13 @@
<title>evennia.contrib.security package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.security package</a></li>
</ul>
</div>
@ -105,7 +110,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.security package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

52
docs/1.0-dev/api/evennia.contrib.turnbattle.html
View file

@ -7,11 +7,13 @@
<title>evennia.contrib.turnbattle package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.turnbattle package</a></li>
</ul>
</div>
@ -230,7 +235,7 @@ the fight. If all participants in a fight disengage, the
fight ends.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_basic.CmdDisengage._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('disengage', 'spare')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdDisengage._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('spare', 'disengage')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdDisengage._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -339,7 +344,7 @@ When it’s your turn, you can attack other characters.</p>
if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_basic.CmdPass._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('wait', 'hold', 'pass')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('hold', 'wait', 'pass')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -349,7 +354,7 @@ if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_basic.CmdPass.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -375,7 +380,7 @@ if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_basic.CmdPass.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_basic.CmdPass.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -1045,7 +1050,7 @@ the fight. If all participants in a fight disengage, the
fight ends.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_equip.CmdDisengage._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('disengage', 'spare')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_equip.CmdDisengage._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('spare', 'disengage')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_equip.CmdDisengage._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1264,7 +1269,7 @@ When it’s your turn, you can attack other characters.</p>
if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_equip.CmdPass._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('wait', 'hold', 'pass')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_equip.CmdPass._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('hold', 'wait', 'pass')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_equip.CmdPass._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1274,7 +1279,7 @@ if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_equip.CmdPass.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_equip.CmdPass.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_equip.CmdPass.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -1300,7 +1305,7 @@ if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_equip.CmdPass.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_equip.CmdPass.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_equip.CmdPass.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -2206,7 +2211,7 @@ the fight. If all participants in a fight disengage, the
fight ends.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_items.CmdDisengage._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('disengage', 'spare')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdDisengage._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('spare', 'disengage')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdDisengage._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2315,7 +2320,7 @@ When it’s your turn, you can attack other characters.</p>
if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_items.CmdPass._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('wait', 'hold', 'pass')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('hold', 'wait', 'pass')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2325,7 +2330,7 @@ if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_items.CmdPass.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -2351,7 +2356,7 @@ if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_items.CmdPass.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_items.CmdPass.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -3369,7 +3374,7 @@ the fight. If all participants in a fight disengage, the
fight ends.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_magic.CmdDisengage._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('disengage', 'spare')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdDisengage._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('spare', 'disengage')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdDisengage._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3546,7 +3551,7 @@ When it’s your turn, you can attack other characters.</p>
if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_magic.CmdPass._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('wait', 'hold', 'pass')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('hold', 'wait', 'pass')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3556,7 +3561,7 @@ if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_magic.CmdPass.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -3582,7 +3587,7 @@ if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_magic.CmdPass.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_magic.CmdPass.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -4458,7 +4463,7 @@ the fight. If all participants in a fight disengage, the
fight ends.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_range.CmdDisengage._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('disengage', 'spare')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdDisengage._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('spare', 'disengage')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdDisengage._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4567,7 +4572,7 @@ When it’s your turn, you can attack other characters.</p>
if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_range.CmdPass._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('wait', 'hold', 'pass')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('hold', 'wait', 'pass')</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4577,7 +4582,7 @@ if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_range.CmdPass.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -4603,7 +4608,7 @@ if there are still any actions you can take.</p>
<dl class="attribute">
<dt id="evennia.contrib.turnbattle.tb_range.CmdPass.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.turnbattle.tb_range.CmdPass.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -5574,7 +5579,10 @@ withdrawing - they can be considered to be moving to open space.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.turnbattle package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

32
docs/1.0-dev/api/evennia.contrib.tutorial_examples.html
View file

@ -7,11 +7,13 @@
<title>evennia.contrib.tutorial_examples package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.tutorial_examples package</a></li>
</ul>
</div>
@ -218,7 +223,7 @@ the button is pushed.</p>
<p>… not that there’s much to see in the dark.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('feel', 'ex', 'look', 'get', 'l', 'listen', 'examine')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', 'feel', 'get', 'examine', 'look', 'listen', 'ex')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -228,7 +233,7 @@ the button is pushed.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['feel', 'ex', 'get', 'l', 'listen', 'examine']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'feel', 'get', 'examine', 'listen', 'ex']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -259,7 +264,7 @@ the button is pushed.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'feel ex get l listen examine', 'category': 'general', 'key': 'look', 'tags': '', 'text': &quot;\n Looking around in darkness\n\n Usage:\n look &lt;obj&gt;\n\n ... not that there's much to see in the dark.\n\n &quot;}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l feel get examine listen ex', 'category': 'general', 'key': 'look', 'tags': '', 'text': &quot;\n Looking around in darkness\n\n Usage:\n look &lt;obj&gt;\n\n ... not that there's much to see in the dark.\n\n &quot;}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -392,7 +397,7 @@ push the lid of the button away.</p>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('open', 'open button', 'open lid')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('open button', 'open lid', 'open')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -402,7 +407,7 @@ push the lid of the button away.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['open', 'open button']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['open button', 'open']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -433,7 +438,7 @@ push the lid of the button away.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'open open button', 'category': 'general', 'key': 'open lid', 'tags': '', 'text': '\n open lid\n\n Usage:\n open lid\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'open button open', 'category': 'general', 'key': 'open lid', 'tags': '', 'text': '\n open lid\n\n Usage:\n open lid\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -449,7 +454,7 @@ push the lid of the button away.</p>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('press button', 'push button', 'push', 'press')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('press button', 'press', 'push button', 'push')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -512,7 +517,7 @@ lid-state respectively.</p>
<p>Try to smash the glass of the button.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('smash', 'smash glass', 'smash lid', 'break lid')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('smash glass', 'smash lid', 'smash', 'break lid')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -522,7 +527,7 @@ lid-state respectively.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['smash', 'smash lid', 'break lid']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['smash lid', 'smash', 'break lid']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -554,7 +559,7 @@ of causing the lamp to break.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'smash smash lid break lid', 'category': 'general', 'key': 'smash glass', 'tags': '', 'text': '\n smash glass\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'smash lid smash break lid', 'category': 'general', 'key': 'smash glass', 'tags': '', 'text': '\n smash glass\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -1240,7 +1245,10 @@ self.obj is the red_button on which this script is defined.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.tutorial_examples package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

50
docs/1.0-dev/api/evennia.contrib.tutorial_world.html
View file

@ -7,11 +7,13 @@
<title>evennia.contrib.tutorial_world package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.tutorial_world package</a></li>
</ul>
</div>
@ -61,7 +66,7 @@ building to activate the mob once it’s
prepared.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.mob.CmdMobOnOff._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('mobon', 'moboff')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('moboff', 'mobon')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.mob.CmdMobOnOff._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -374,7 +379,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
</div></blockquote>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('chop', 'defend', 'attack', 'hit', 'thrust', 'pierce', 'kill', 'stab', 'fight', 'parry', 'slash')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('chop', 'pierce', 'parry', 'hit', 'slash', 'kill', 'stab', 'thrust', 'defend', 'fight', 'attack')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -384,7 +389,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['defend', 'hit', 'thrust', 'pierce', 'kill', 'stab', 'parry', 'fight', 'chop', 'slash']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['chop', 'pierce', 'parry', 'hit', 'defend', 'slash', 'kill', 'thrust', 'stab', 'fight']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -415,7 +420,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdAttack.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'defend hit thrust pierce kill stab parry fight chop slash', 'category': 'tutorialworld', 'key': 'attack', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab &lt;enemy&gt;\n slash &lt;enemy&gt;\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'chop pierce parry hit defend slash kill thrust stab fight', 'category': 'tutorialworld', 'key': 'attack', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab &lt;enemy&gt;\n slash &lt;enemy&gt;\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -543,7 +548,7 @@ itself handle all messages.</p>
<p>Creates light where there was none. Something to burn.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('burn', 'light', 'on')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('light', 'on', 'burn')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -597,7 +602,7 @@ to sit on a “lightable” object, we operate only on self.obj.</p>
<p>Presses a button.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('press', 'press button', 'push button', 'button')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('press button', 'press', 'push button', 'button')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -607,7 +612,7 @@ to sit on a “lightable” object, we operate only on self.obj.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'button', 'push button']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'push button', 'button']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -638,7 +643,7 @@ to sit on a “lightable” object, we operate only on self.obj.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdPressButton.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button button push button', 'category': 'tutorialworld', 'key': 'press', 'tags': '', 'text': '\n Presses a button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button push button button', 'category': 'tutorialworld', 'key': 'press', 'tags': '', 'text': '\n Presses a button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdPressButton.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -848,7 +853,7 @@ shift green root up/down</p>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('pull', 'move', 'shift', 'shiftroot', 'push')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('move', 'shift', 'pull', 'push', 'shiftroot')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -858,7 +863,7 @@ shift green root up/down</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['pull', 'move', 'shiftroot', 'push']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['shiftroot', 'push', 'move', 'pull']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -899,7 +904,7 @@ yellow/green - horizontal roots</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdShiftRoot.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'pull move shiftroot push', 'category': 'tutorialworld', 'key': 'shift', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'shiftroot push move pull', 'category': 'tutorialworld', 'key': 'shift', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -1739,7 +1744,7 @@ if they fall off the bridge.</p>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookBridge._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'l')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', 'look')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookBridge._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1798,7 +1803,7 @@ if they fall off the bridge.</p>
to find something.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('feel around', 'feel', 'fiddle', 'look', 'l', 'search')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', 'feel', 'feel around', 'search', 'look', 'fiddle')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1808,7 +1813,7 @@ to find something.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['feel around', 'feel', 'fiddle', 'l', 'search']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'feel', 'feel around', 'search', 'fiddle']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -1841,7 +1846,7 @@ random chance of eventually finding a light source.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdLookDark.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'feel around feel fiddle l search', 'category': 'tutorialworld', 'key': 'look', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l feel feel around search fiddle', 'category': 'tutorialworld', 'key': 'look', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -1926,7 +1931,7 @@ actually having to be actual database objects. It uses the
return_detail() hook on TutorialRooms for this.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'ls', 'l')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', 'ls', 'look')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1936,7 +1941,7 @@ return_detail() hook on TutorialRooms for this.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -1963,7 +1968,7 @@ code except for adding in the details.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdTutorialLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'tutorialworld', 'key': 'look', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look &lt;obj&gt;\n look &lt;room detail&gt;\n look *&lt;account&gt;\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at &quot;details&quot; in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'tutorialworld', 'key': 'look', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look &lt;obj&gt;\n look &lt;room detail&gt;\n look *&lt;account&gt;\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at &quot;details&quot; in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdTutorialLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -2063,7 +2068,7 @@ on the bridge, 0 - 4.</p></li>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdWest._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('w', 'west')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('west', 'w')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdWest._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2633,7 +2638,10 @@ even though we don’t actually use them in this example)</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.tutorial_world package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.game_template.commands.html
View file

@ -7,11 +7,13 @@
<title>evennia.game_template.commands package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.commands package</a></li>
</ul>
</div>
@ -280,7 +285,10 @@ holds commands like creating a new account, logging in, etc.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.commands package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.game_template.html
View file

@ -7,11 +7,13 @@
<title>evennia.game_template package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template package</a></li>
</ul>
</div>
@ -153,7 +158,10 @@ folder.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.game_template.server.conf.html
View file

@ -7,11 +7,13 @@
<title>evennia.game_template.server.conf package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.server.conf package</a></li>
</ul>
</div>
@ -544,7 +549,10 @@ web_root.putChild(“mypage”, my_page)</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.server.conf package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.game_template.server.html
View file

@ -7,11 +7,13 @@
<title>evennia.game_template.server package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.server package</a></li>
</ul>
</div>
@ -117,7 +122,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.server package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.game_template.typeclasses.html
View file

@ -7,11 +7,13 @@
<title>evennia.game_template.typeclasses package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.typeclasses package</a></li>
</ul>
</div>
@ -122,7 +127,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.typeclasses package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.game_template.web.html
View file

@ -7,11 +7,13 @@
<title>evennia.game_template.web package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.web package</a></li>
</ul>
</div>
@ -101,7 +106,10 @@ help.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.web package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.game_template.world.html
View file

@ -7,11 +7,13 @@
<title>evennia.game_template.world package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.world package</a></li>
</ul>
</div>
@ -128,7 +133,10 @@ any other keywords are interpreted as Attributes and their values.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.game_template.world package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.help.html
View file

@ -7,11 +7,13 @@
<title>evennia.help package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.help package</a></li>
</ul>
</div>
@ -735,7 +740,10 @@ responsibility.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.help package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.html
View file

@ -7,11 +7,13 @@
<title>evennia package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia package</a></li>
</ul>
</div>
@ -653,7 +658,10 @@ always be sure of what you have changed and what is default behaviour.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.locks.html
View file

@ -7,11 +7,13 @@
<title>evennia.locks package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.locks package</a></li>
</ul>
</div>
@ -1129,7 +1134,10 @@ the stability and integrity of the codebase during updates.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.locks package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.objects.html
View file

@ -7,11 +7,13 @@
<title>evennia.objects package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.objects package</a></li>
</ul>
</div>
@ -3073,7 +3078,10 @@ in the the core sessionhandler.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.objects package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.prototypes.html
View file

@ -7,11 +7,13 @@
<title>evennia.prototypes package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.prototypes package</a></li>
</ul>
</div>
@ -2066,7 +2071,10 @@ custom <cite>prototype_parents</cite> are given to this function.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.prototypes package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.scripts.html
View file

@ -7,11 +7,13 @@
<title>evennia.scripts package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.scripts package</a></li>
</ul>
</div>
@ -1838,7 +1843,10 @@ interval.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.scripts package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.server.game_index_client.html
View file

@ -7,11 +7,13 @@
<title>evennia.server.game_index_client package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.server.game_index_client package</a></li>
</ul>
</div>
@ -257,7 +262,10 @@ Stop the service so we’re not wasting resources.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.server.game_index_client package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.server.html
View file

@ -7,11 +7,13 @@
<title>evennia.server package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.server package</a></li>
</ul>
</div>
@ -3348,7 +3353,10 @@ so as to register correctly with the twisted daemon.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.server package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.server.portal.html
View file

@ -7,11 +7,13 @@
<title>evennia.server.portal package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.server.portal package</a></li>
</ul>
</div>
@ -3862,7 +3867,10 @@ implement default like this:</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.server.portal package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.server.profiling.html
View file

@ -7,11 +7,13 @@
<title>evennia.server.profiling package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.server.profiling package</a></li>
</ul>
</div>
@ -615,7 +620,10 @@ This message will get attached time stamp.</p></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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.server.profiling package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.server.tests.html
View file

@ -7,11 +7,13 @@
<title>evennia.server.tests package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.server.tests package</a></li>
</ul>
</div>
@ -447,7 +452,10 @@ If not given, a subset of settings.INSTALLED_APPS will be used.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.server.tests package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.typeclasses.html
View file

@ -7,11 +7,13 @@
<title>evennia.typeclasses package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.typeclasses package</a></li>
</ul>
</div>
@ -3883,7 +3888,10 @@ as .clear().</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.typeclasses package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

34
docs/1.0-dev/api/evennia.utils.html
View file

@ -7,11 +7,13 @@
<title>evennia.utils package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.utils package</a></li>
</ul>
</div>
@ -1903,7 +1908,7 @@ txt - extra text (string), could be encased in quotes.</p>
<p>Commands for the editor</p>
<dl class="attribute">
<dt id="evennia.utils.eveditor.CmdEditorGroup._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = (':dd', ':I', ':S', ':A', ':dw', ':DD', ':wq', ':uu', ':echo', ':y', ':q!', ':x', ':', ':fi', '::', ':i', ':h', ':&lt;', ':!', ':&gt;', ':::', ':=', ':editor_command_group', ':w', ':j', ':q', ':UU', ':r', ':fd', ':s', ':u', ':f', ':p')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = (':', ':echo', ':&gt;', ':UU', ':r', ':h', ':dw', ':u', ':s', ':w', ':p', ':S', ':!', ':x', ':I', ':DD', ':dd', ':j', '::', ':i', ':q', ':editor_command_group', ':A', ':f', ':wq', ':=', ':fi', ':y', ':::', ':&lt;', ':q!', ':fd', ':uu')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1913,7 +1918,7 @@ txt - extra text (string), could be encased in quotes.</p>
<dl class="attribute">
<dt id="evennia.utils.eveditor.CmdEditorGroup.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = [':dd', ':I', ':S', ':A', ':dw', ':DD', ':wq', ':uu', ':echo', ':y', ':q!', ':x', ':', ':fi', '::', ':i', ':h', ':&lt;', ':!', ':&gt;', ':::', ':=', ':w', ':j', ':q', ':UU', ':r', ':fd', ':s', ':u', ':f', ':p']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = [':', ':echo', ':&gt;', ':UU', ':r', ':h', ':dw', ':u', ':s', ':w', ':p', ':S', ':!', ':uu', ':x', ':I', ':DD', ':dd', ':j', '::', ':i', ':q', ':A', ':f', ':wq', ':=', ':fi', ':fd', ':&lt;', ':q!', ':::', ':y']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1946,7 +1951,7 @@ efficient presentation.</p>
<dl class="attribute">
<dt id="evennia.utils.eveditor.CmdEditorGroup.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ':dd :I :S :A :dw :DD :wq :uu :echo :y :q! :x : :fi :: :i :h :&lt; :! :&gt; ::: := :w :j :q :UU :r :fd :s :u :f :p', 'category': 'general', 'key': ':editor_command_group', 'tags': '', 'text': '\n Commands for the editor\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ': :echo :&gt; :UU :r :h :dw :u :s :w :p :S :! :uu :x :I :DD :dd :j :: :i :q :A :f :wq := :fi :fd :&lt; :q! ::: :y', 'category': 'general', 'key': ':editor_command_group', 'tags': '', 'text': '\n Commands for the editor\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -1958,7 +1963,7 @@ efficient presentation.</p>
<p>No command match - Inputs line of text into buffer.</p>
<dl class="attribute">
<dt id="evennia.utils.eveditor.CmdLineInput._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdLineInput._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('__noinput_command', '__nomatch_command')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdLineInput._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2010,7 +2015,7 @@ nomatches (defaults to Yes), and avoid saves only if
command was given specifically as “no” or “n”.</p>
<dl class="attribute">
<dt id="evennia.utils.eveditor.CmdSaveYesNo._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdSaveYesNo._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('__noinput_command', '__nomatch_command')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdSaveYesNo._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2725,7 +2730,7 @@ evennia.utils.evmenu</cite>.</p>
<p>Menu options.</p>
<dl class="attribute">
<dt id="evennia.utils.evmenu.CmdEvMenuNode._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.evmenu.CmdEvMenuNode._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('__noinput_command', '__nomatch_command')</em><a class="headerlink" href="#evennia.utils.evmenu.CmdEvMenuNode._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2778,7 +2783,7 @@ evennia.utils.evmenu</cite>.</p>
<p>Enter your data and press return.</p>
<dl class="attribute">
<dt id="evennia.utils.evmenu.CmdGetInput._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.evmenu.CmdGetInput._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('__noinput_command', '__nomatch_command')</em><a class="headerlink" href="#evennia.utils.evmenu.CmdGetInput._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3575,7 +3580,7 @@ caller.msg() construct every time the page is updated.</p>
<p>Manipulate the text paging</p>
<dl class="attribute">
<dt id="evennia.utils.evmore.CmdMore._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('e', 'abort', 'q', 'next', 'n', 'b', 'end', 'back', 'top', 't', '__noinput_command', 'quit', 'a')</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('e', '__noinput_command', 'q', 'n', 't', 'back', 'top', 'next', 'end', 'abort', 'b', 'quit', 'a')</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3585,7 +3590,7 @@ caller.msg() construct every time the page is updated.</p>
<dl class="attribute">
<dt id="evennia.utils.evmore.CmdMore.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['e', 'abort', 'q', 'next', 'n', 'b', 'end', 'back', 'top', 't', 'quit', 'a']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['e', 'q', 'n', 't', 'back', 'top', 'next', 'end', 'abort', 'b', 'quit', 'a']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3616,7 +3621,7 @@ caller.msg() construct every time the page is updated.</p>
<dl class="attribute">
<dt id="evennia.utils.evmore.CmdMore.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'e abort q next n b end back top t quit a', 'category': 'general', 'key': '__noinput_command', 'tags': '', 'text': '\n Manipulate the text paging\n '}</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'e q n t back top next end abort b quit a', 'category': 'general', 'key': '__noinput_command', 'tags': '', 'text': '\n Manipulate the text paging\n '}</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -3628,7 +3633,7 @@ caller.msg() construct every time the page is updated.</p>
<p>Override look to display window and prevent OOCLook from firing</p>
<dl class="attribute">
<dt id="evennia.utils.evmore.CmdMoreLook._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('look', 'l')</em><a class="headerlink" href="#evennia.utils.evmore.CmdMoreLook._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('l', 'look')</em><a class="headerlink" href="#evennia.utils.evmore.CmdMoreLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -9587,7 +9592,10 @@ If neither one is provided, defaults to UTC.</p></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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.utils package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.utils.idmapper.html
View file

@ -7,11 +7,13 @@
<title>evennia.utils.idmapper package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.utils.idmapper package</a></li>
</ul>
</div>
@ -776,7 +781,10 @@ class built by <code class="docutils literal notranslate"><span class="pre">crea
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.utils.idmapper package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.utils.tests.data.html
View file

@ -7,11 +7,13 @@
<title>evennia.utils.tests.data package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.utils.tests.data package</a></li>
</ul>
</div>
@ -108,7 +113,10 @@ prototype dictionaries)</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.utils.tests.data package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.utils.tests.html
View file

@ -7,11 +7,13 @@
<title>evennia.utils.tests package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.utils.tests package</a></li>
</ul>
</div>
@ -1314,7 +1319,10 @@ time_format(seconds, style=0)</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.utils.tests package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.web.api.html
View file

@ -7,11 +7,13 @@
<title>evennia.web.api package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web.api package</a></li>
</ul>
</div>
@ -1135,7 +1140,10 @@ if no db_value is provided.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web.api package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.web.html
View file

@ -7,11 +7,13 @@
<title>evennia.web package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web package</a></li>
</ul>
</div>
@ -150,7 +155,10 @@ found under the <cite>server</cite> package).</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.web.utils.html
View file

@ -7,11 +7,13 @@
<title>evennia.web.utils package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web.utils package</a></li>
</ul>
</div>
@ -205,7 +210,10 @@ to webclient settings.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web.utils package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.web.webclient.html
View file

@ -7,11 +7,13 @@
<title>evennia.web.webclient package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web.webclient package</a></li>
</ul>
</div>
@ -112,7 +117,10 @@ page and serve it eventual static content.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web.webclient package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.web.website.html
View file

@ -7,11 +7,13 @@
<title>evennia.web.website package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web.website package</a></li>
</ul>
</div>
@ -1585,7 +1590,10 @@ implemented yet.</p>
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web.website package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">

12
docs/1.0-dev/api/evennia.web.website.templatetags.html
View file

@ -7,11 +7,13 @@
<title>evennia.web.website.templatetags package &#8212; Evennia 1.0-dev 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" />
@ -25,7 +27,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web.website.templatetags package</a></li>
</ul>
</div>
@ -103,7 +108,10 @@
<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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.web.website.templatetags package</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">