Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-30 12:37:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-06-13 00:57:51 +02:00
parent 41c1a2cd29
commit eae81d5549
17 changed files with 256 additions and 257 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/0.9.1/.buildinfo
View file

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 295015d8a4fc970787fc1883ce23db71
config: 88ec82837d54b21403a1ded540df1766
tags: 645f666f9bcd5a90fca523b33c5a78b7

98
docs/0.9.1/api/evennia.commands.default.html
View file

@ -79,7 +79,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"> = ['l', 'ls']</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"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -110,7 +110,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': '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>
<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>
<dd></dd></dl>
</dd></dl>
@ -465,7 +465,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"> = ('options', 'option')</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"> = ('option', 'options')</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -762,7 +762,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"> = ('quell', 'unquell')</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"> = ('unquell', 'quell')</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1526,7 +1526,7 @@ skipping, reloading etc.</p>
<p>Runs batches of commands from a batch-cmd text file (<a href="#id7"><span class="problematic" id="id8">*</span></a>.ev).</p>
<dl class="attribute">
<dt id="evennia.commands.default.batchprocess.CmdBatchCommands._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('batchcommands', 'batchcmd', 'batchcommand')</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('batchcommand', 'batchcommands', 'batchcmd')</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1536,7 +1536,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">
@ -1567,7 +1567,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">
@ -1599,7 +1599,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">
@ -2127,7 +2127,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"> = ('desc', 'describe')</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"> = ('describe', 'desc')</em><a class="headerlink" href="#evennia.commands.default.building.CmdDesc._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2208,7 +2208,7 @@ displays a confirmation before destroying, to make sure of your choice.
You can specify the /force switch to bypass this confirmation.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdDestroy._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('destroy', 'delete', 'del')</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('del', 'destroy', 'delete')</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2218,7 +2218,7 @@ You can specify the /force switch to bypass this confirmation.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdDestroy.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['delete', 'del']</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['del', 'delete']</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2259,7 +2259,7 @@ You can specify the /force switch to bypass this confirmation.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdDestroy.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'delete del', 'category': 'building', 'key': 'destroy', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'del delete', 'category': 'building', 'key': 'destroy', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2382,7 +2382,7 @@ created back from the new room unless the /oneway switch is given.
For more flexibility and power in creating rooms, use dig.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdTunnel._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('tun', 'tunnel')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTunnel._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('tunnel', 'tun')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTunnel._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2708,7 +2708,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"> = ('name', 'rename')</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"> = ('rename', 'name')</em><a class="headerlink" href="#evennia.commands.default.building.CmdName._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3042,7 +3042,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"> = ('typeclass', 'update', 'type', 'parent', 'swap')</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"> = ('parent', 'typeclass', 'swap', 'type', 'update')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3052,7 +3052,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"> = ['parent', 'update', 'swap', 'type']</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"> = ['type', 'update', 'swap', '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">
@ -3083,7 +3083,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': 'parent update swap type', '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': 'type update swap 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">
@ -3191,7 +3191,7 @@ them by ‘;’, i.e:</p>
</div></blockquote>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdLock._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('locks', 'lock')</em><a class="headerlink" href="#evennia.commands.default.building.CmdLock._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('lock', 'locks')</em><a class="headerlink" href="#evennia.commands.default.building.CmdLock._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3256,7 +3256,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"> = ('ex', 'exam', 'examine')</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', 'ex', 'examine')</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3439,7 +3439,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">
@ -4007,7 +4007,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', 'addcom', 'aliaschan')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4074,7 +4074,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"> = ('delcom', 'delchanalias', '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"> = ('delchanalias', 'delcom', '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">
@ -4207,7 +4207,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"> = ('all channels', 'channels', 'chanlist', 'clist', 'comlist', 'channellist')</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"> = ('channellist', 'channels', 'clist', 'comlist', 'all channels', 'chanlist')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4222,7 +4222,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"> = ['all channels', 'chanlist', 'clist', 'comlist', 'channellist']</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"> = ['channellist', 'clist', 'comlist', 'all channels', 'chanlist']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -4253,7 +4253,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': 'all channels chanlist clist comlist channellist', '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': 'channellist clist comlist all channels chanlist', '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>
@ -4539,7 +4539,7 @@ provide the /sendername switch.</p>
<p>Creates a new channel owned by you.</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdChannelCreate._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('ccreate', 'channelcreate')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('channelcreate', 'ccreate')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4736,7 +4736,7 @@ list - show your last &lt;number&gt; of tells/pages (default)</p>
argument is given, you will get a list of your latest messages.</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdPage._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('tell', 'page')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('page', 'tell')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5062,7 +5062,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"> = ['l', 'ls']</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"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5098,7 +5098,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': '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>
<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>
<dd></dd></dl>
</dd></dl>
@ -5220,7 +5220,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"> = ('inv', 'i', '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">
@ -5349,7 +5349,7 @@ look at you.</p>
your inventory.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdGet._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('get', 'grab')</em><a class="headerlink" href="#evennia.commands.default.general.CmdGet._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('grab', 'get')</em><a class="headerlink" href="#evennia.commands.default.general.CmdGet._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5545,7 +5545,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"> = ('say', '&quot;', &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"> = (&quot;'&quot;, '&quot;', 'say')</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5555,7 +5555,7 @@ placing it in their inventory.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdSay.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&quot;', &quot;'&quot;]</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = [&quot;'&quot;, '&quot;']</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -5586,7 +5586,7 @@ placing it in their inventory.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdSay.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&quot; \'', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '\' &quot;', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -5740,7 +5740,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"> = ('groups', 'access', 'hierarchy')</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"> = ('access', 'hierarchy', '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">
@ -6827,7 +6827,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">
@ -6970,7 +6970,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"> = ('objects', 'listobjs', 'db', 'listobjects', 'stats')</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"> = ('listobjects', 'stats', 'listobjs', 'objects', 'db')</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6980,7 +6980,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"> = ['listobjs', 'listobjects', 'db', 'stats']</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"> = ['listobjects', 'db', 'listobjs', 'stats']</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -7011,7 +7011,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': 'listobjs listobjects db stats', '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': 'listobjects db listobjs stats', '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>
@ -7159,7 +7159,7 @@ in the list.</p>
and the current time stamp.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdTime._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('uptime', 'time')</em><a class="headerlink" href="#evennia.commands.default.system.CmdTime._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('time', 'uptime')</em><a class="headerlink" href="#evennia.commands.default.system.CmdTime._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7237,7 +7237,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"> = ('serverload', 'server', 'serverprocess')</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">
@ -7930,7 +7930,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"> = ('connect', 'co', 'conn', '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', 'con', 'co', '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">
@ -7940,7 +7940,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"> = ['con', 'conn', 'co']</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">
@ -7980,7 +7980,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': 'con conn co', '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>
@ -7999,7 +7999,7 @@ create “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.CmdUnconnectedCreate._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('cr', 'cre', 'create')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('cre', 'cr', 'create')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -8064,7 +8064,7 @@ here for unconnected accounts for the sake of simplicity. The logged in
version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('quit', 'qu', 'q')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('quit', 'q', 'qu')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -8074,7 +8074,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'qu']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -8105,7 +8105,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -8124,7 +8124,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"> = ('__unloggedin_look_command', 'l', 'look')</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"> = ('look', '__unloggedin_look_command', 'l')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">

52
docs/0.9.1/api/evennia.contrib.html
View file

@ -212,7 +212,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">
@ -2092,7 +2092,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"> = ['l', 'ls']</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"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -2129,7 +2129,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': '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>
<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>
<dd></dd></dl>
</dd></dl>
@ -2578,7 +2578,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"> = ('inv', 'i', 'inventory')</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3237,7 +3237,7 @@ with. The hidden/secret switches will hide all or parts of the roll from
everyone but the person rolling.</p>
<dl class="attribute">
<dt id="evennia.contrib.dice.CmdDice._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('dice', '&#64;dice', 'roll')</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('roll', '&#64;dice', 'dice')</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3247,7 +3247,7 @@ everyone but the person rolling.</p>
<dl class="attribute">
<dt id="evennia.contrib.dice.CmdDice.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;dice', 'roll']</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['roll', '&#64;dice']</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -3278,7 +3278,7 @@ everyone but the person rolling.</p>
<dl class="attribute">
<dt id="evennia.contrib.dice.CmdDice.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;dice roll', 'category': 'general', 'key': 'dice', 'tags': '', 'text': &quot;\n roll dice\n\n Usage:\n dice[/switch] &lt;nr&gt;d&lt;sides&gt; [modifier] [success condition]\n\n Switch:\n hidden - tell the room the roll is being done, but don't show the result\n secret - don't inform the room about neither roll nor result\n\n Examples:\n dice 3d6 + 4\n dice 1d100 - 2 &lt; 50\n\n This will roll the given number of dice with given sides and modifiers.\n So e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\n then add 3 to the total'.\n Accepted modifiers are +, -, * and /.\n A success condition is given as normal Python conditionals\n (&lt;,&gt;,&lt;=,&gt;=,==,!=). So e.g. 2d6 + 3 &gt; 10 means that the roll will succeed\n only if the final result is above 8. If a success condition is given, the\n outcome (pass/fail) will be echoed along with how much it succeeded/failed\n with. The hidden/secret switches will hide all or parts of the roll from\n everyone but the person rolling.\n &quot;}</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'roll &#64;dice', 'category': 'general', 'key': 'dice', 'tags': '', 'text': &quot;\n roll dice\n\n Usage:\n dice[/switch] &lt;nr&gt;d&lt;sides&gt; [modifier] [success condition]\n\n Switch:\n hidden - tell the room the roll is being done, but don't show the result\n secret - don't inform the room about neither roll nor result\n\n Examples:\n dice 3d6 + 4\n dice 1d100 - 2 &lt; 50\n\n This will roll the given number of dice with given sides and modifiers.\n So e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\n then add 3 to the total'.\n Accepted modifiers are +, -, * and /.\n A success condition is given as normal Python conditionals\n (&lt;,&gt;,&lt;=,&gt;=,==,!=). So e.g. 2d6 + 3 &gt; 10 means that the roll will succeed\n only if the final result is above 8. If a success condition is given, the\n outcome (pass/fail) will be echoed along with how much it succeeded/failed\n with. The hidden/secret switches will hide all or parts of the roll from\n everyone but the person rolling.\n &quot;}</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -3395,7 +3395,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"> = ('connect', 'co', 'conn', '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', 'con', 'co', '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">
@ -3405,7 +3405,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"> = ['con', 'conn', 'co']</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">
@ -3440,7 +3440,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': 'con conn co', '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>
@ -3457,7 +3457,7 @@ there is no object yet before the account has logged in)</p>
<p>This creates a new account account.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('cr', 'cre', 'create')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('cre', 'cr', 'create')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3522,7 +3522,7 @@ here for unconnected accounts for the sake of simplicity. The logged in
version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('quit', 'qu', 'q')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('quit', 'q', 'qu')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3532,7 +3532,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'qu']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -3563,7 +3563,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -3577,7 +3577,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"> = ('__unloggedin_look_command', 'l', 'look')</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"> = ('look', '__unloggedin_look_command', 'l')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3781,7 +3781,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"> = ('desc', 'describe')</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"> = ('describe', 'desc')</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 +3989,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"> = ['l', 'ls']</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"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -4015,7 +4015,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': '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>
<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>
<dd></dd></dl>
</dd></dl>
@ -4713,7 +4713,7 @@ All extra kwargs will be passed on to the protocol.</p>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.gendersub.SetGender._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;gender', '&#64;sex')</em><a class="headerlink" href="#evennia.contrib.gendersub.SetGender._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;sex', '&#64;gender')</em><a class="headerlink" href="#evennia.contrib.gendersub.SetGender._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4916,7 +4916,7 @@ reply - Replies to a received message, appending the original message to the b
&#64;mail/reply 9=Thanks for the info!</p>
<dl class="attribute">
<dt id="evennia.contrib.mail.CmdMail._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('mail', '&#64;mail')</em><a class="headerlink" href="#evennia.contrib.mail.CmdMail._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;mail', 'mail')</em><a class="headerlink" href="#evennia.contrib.mail.CmdMail._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5067,7 +5067,7 @@ reply - Replies to a received message, appending the original message to the b
&#64;mail/reply 9=Thanks for the info!</p>
<dl class="attribute">
<dt id="evennia.contrib.mail.CmdMailCharacter._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('mail', '&#64;mail')</em><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;mail', 'mail')</em><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5752,7 +5752,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;puzzlerecipe', '&#64;puzzle')</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;puzzle', '&#64;puzzlerecipe')</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7120,7 +7120,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"> = ('forget', 'recognize', 'recog')</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdRecog._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7179,7 +7179,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"> = ('say', '&quot;', &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"> = (&quot;'&quot;, '&quot;', 'say')</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7189,7 +7189,7 @@ Using the command without arguments will list all current recogs.</p>
<dl class="attribute">
<dt id="evennia.contrib.rpsystem.CmdSay.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&quot;', &quot;'&quot;]</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = [&quot;'&quot;, '&quot;']</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -7220,7 +7220,7 @@ Using the command without arguments will list all current recogs.</p>
<dl class="attribute">
<dt id="evennia.contrib.rpsystem.CmdSay.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&quot; \'', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '\' &quot;', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

2
docs/0.9.1/api/evennia.contrib.ingame_python.html
View file

@ -320,7 +320,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;callback', '&#64;call', '&#64;calls', '&#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;call', '&#64;callbacks', '&#64;calls', '&#64;callback')</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">

20
docs/0.9.1/api/evennia.contrib.turnbattle.html
View file

@ -226,7 +226,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"> = ('spare', 'disengage')</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"> = ('disengage', 'spare')</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">
@ -335,7 +335,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"> = ('pass', 'hold', 'wait')</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"> = ('wait', 'pass', 'hold')</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">
@ -1041,7 +1041,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"> = ('spare', 'disengage')</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"> = ('disengage', 'spare')</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">
@ -1260,7 +1260,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"> = ('pass', 'hold', 'wait')</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"> = ('wait', 'pass', 'hold')</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">
@ -2202,7 +2202,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"> = ('spare', 'disengage')</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"> = ('disengage', 'spare')</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">
@ -2311,7 +2311,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"> = ('pass', 'hold', 'wait')</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"> = ('wait', 'pass', 'hold')</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">
@ -3365,7 +3365,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"> = ('spare', 'disengage')</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"> = ('disengage', 'spare')</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">
@ -3542,7 +3542,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"> = ('pass', 'hold', 'wait')</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"> = ('wait', 'pass', 'hold')</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">
@ -4454,7 +4454,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"> = ('spare', 'disengage')</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"> = ('disengage', 'spare')</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">
@ -4563,7 +4563,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"> = ('pass', 'hold', 'wait')</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"> = ('wait', 'pass', 'hold')</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">

24
docs/0.9.1/api/evennia.contrib.tutorial_examples.html
View file

@ -214,7 +214,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"> = ('examine', 'get', 'listen', 'look', 'feel', 'l', 'ex')</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"> = ('get', 'examine', 'ex', 'l', 'look', 'listen', 'feel')</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">
@ -224,7 +224,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"> = ['examine', 'get', 'listen', 'feel', 'l', 'ex']</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"> = ['get', 'examine', 'ex', 'l', 'listen', 'feel']</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">
@ -255,7 +255,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': 'examine get listen feel l 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>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'get examine ex l listen feel', '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>
@ -272,7 +272,7 @@ the button is pushed.</p>
<p>Closes the lid of the red button.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('close', 'close lid')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('close lid', 'close')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -331,7 +331,7 @@ the button is pushed.</p>
push the lid of the button away.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('nudge', 'nudge lid')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('nudge lid', 'nudge')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -388,7 +388,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 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>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('open button', 'open', 'open lid')</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">
@ -445,7 +445,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', 'press', 'push button')</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', 'push', 'press button', 'push button')</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">
@ -455,7 +455,7 @@ push the lid of the button away.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['press', 'push', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['push', 'press button', 'press']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -491,7 +491,7 @@ lid-state respectively.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push press button press', 'category': 'general', 'key': 'push button', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -508,7 +508,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"> = ('break lid', 'smash glass', 'smash', 'smash 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', 'break lid', 'smash lid', 'smash glass')</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">
@ -518,7 +518,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"> = ['break lid', 'smash', 'smash 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"> = ['break lid', 'smash lid', 'smash']</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">
@ -550,7 +550,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': 'break lid smash smash 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': 'break lid smash lid smash', '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>

38
docs/0.9.1/api/evennia.contrib.tutorial_world.html
View file

@ -57,7 +57,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"> = ('moboff', 'mobon')</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"> = ('mobon', 'moboff')</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">
@ -370,7 +370,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"> = ('parry', 'thrust', 'stab', 'fight', 'pierce', 'slash', 'defend', 'attack', 'kill', 'hit', 'chop')</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"> = ('fight', 'stab', 'kill', 'defend', 'slash', 'chop', 'thrust', 'parry', 'hit', 'pierce', '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">
@ -380,7 +380,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"> = ['parry', 'thrust', 'stab', 'fight', 'pierce', 'slash', 'defend', 'kill', 'hit', 'chop']</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"> = ['fight', 'stab', 'kill', 'slash', 'chop', 'thrust', 'parry', 'hit', 'pierce', 'defend']</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">
@ -411,7 +411,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': 'parry thrust stab fight pierce slash defend kill hit chop', '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': 'fight stab kill slash chop thrust parry hit pierce defend', '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>
@ -539,7 +539,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"> = ('on', 'burn', 'light')</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"> = ('on', 'light', '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">
@ -549,7 +549,7 @@ itself handle all messages.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['burn', 'light']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['light', 'burn']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -581,7 +581,7 @@ to sit on a “lightable” object, we operate only on self.obj.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'burn light', 'category': 'tutorialworld', 'key': 'on', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'light burn', 'category': 'tutorialworld', 'key': 'on', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -593,7 +593,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 button', 'button', 'press', 'push 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"> = ('push button', 'press button', 'button', 'press')</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">
@ -603,7 +603,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"> = ['push button', 'press button', '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', 'button', 'push 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">
@ -634,7 +634,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': 'push button press 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>
<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>
<dd></dd></dl>
</dd></dl>
@ -844,7 +844,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"> = ('move', 'push', 'pull', 'shiftroot', 'shift')</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"> = ('push', 'shiftroot', 'pull', 'move', 'shift')</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">
@ -854,7 +854,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"> = ['push', 'pull', 'shiftroot', 'move']</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"> = ['pull', 'move', 'push', 'shiftroot']</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">
@ -895,7 +895,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': 'push pull shiftroot move', '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': 'pull move push shiftroot', '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>
@ -1676,7 +1676,7 @@ on the bridge, 0 - 4.</p></li>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('e', 'east')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('east', 'e')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1794,7 +1794,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"> = ('search', 'look', 'fiddle', 'feel around', 'feel', 'l')</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', 'look', 'feel around', 'search', 'fiddle', 'feel')</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">
@ -1804,7 +1804,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"> = ['search', 'l', 'fiddle', 'feel', 'feel around']</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 around', 'search', 'fiddle', 'feel']</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">
@ -1837,7 +1837,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': 'search l fiddle feel feel around', '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 around search fiddle feel', '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>
@ -1932,7 +1932,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"> = ['l', 'ls']</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"> = ['ls', 'l']</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">
@ -1959,7 +1959,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': '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>
<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>
<dd></dd></dl>
</dd></dl>

20
docs/0.9.1/api/evennia.utils.html
View file

@ -1898,7 +1898,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"> = (':&lt;', ':fd', ':u', ':h', '::', ':echo', ':dw', ':dd', ':DD', ':x', ':editor_command_group', ':q!', ':fi', ':q', ':s', ':&gt;', ':=', ':', ':::', ':j', ':I', ':S', ':p', ':!', ':y', ':wq', ':uu', ':UU', ':w', ':r', ':i', ':A', ':f')</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"> = (':q', ':u', ':echo', ':!', ':dw', ':j', ':f', ':fi', ':p', ':&lt;', ':=', ':w', ':I', ':::', ':r', ':i', ':editor_command_group', ':', ':S', ':s', ':h', ':&gt;', ':UU', '::', ':dd', ':x', ':q!', ':DD', ':y', ':fd', ':A', ':uu', ':wq')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1908,7 +1908,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"> = [':&lt;', ':fd', ':h', '::', ':echo', ':dw', ':dd', ':DD', ':x', ':q!', ':fi', ':q', ':s', ':&gt;', ':=', ':', ':::', ':j', ':I', ':S', ':p', ':!', ':y', ':wq', ':uu', ':UU', ':w', ':r', ':i', ':A', ':f', ':u']</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"> = [':q', ':u', ':echo', ':!', ':dw', ':j', ':f', ':fi', ':p', ':&lt;', ':=', ':w', ':I', ':::', ':r', ':i', ':', ':S', ':s', ':h', ':&gt;', ':UU', '::', ':dd', ':x', ':q!', ':DD', ':y', ':fd', ':A', ':uu', ':wq']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1941,7 +1941,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': ':&lt; :fd :h :: :echo :dw :dd :DD :x :q! :fi :q :s :&gt; := : ::: :j :I :S :p :! :y :wq :uu :UU :w :r :i :A :f :u', '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': ':q :u :echo :! :dw :j :f :fi :p :&lt; := :w :I ::: :r :i : :S :s :h :&gt; :UU :: :dd :x :q! :DD :y :fd :A :uu :wq', '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>
@ -1953,7 +1953,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"> = ('__noinput_command', '__nomatch_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"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdLineInput._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2005,7 +2005,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"> = ('__noinput_command', '__nomatch_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"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdSaveYesNo._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2720,7 +2720,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"> = ('__noinput_command', '__nomatch_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"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.evmenu.CmdEvMenuNode._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2773,7 +2773,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"> = ('__noinput_command', '__nomatch_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"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.evmenu.CmdGetInput._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3570,7 +3570,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"> = ('next', 'a', 'back', 'end', 'quit', 'n', 't', 'abort', 'q', 'top', '__noinput_command', 'e', 'b')</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"> = ('t', 'b', 'n', 'top', 'abort', 'q', 'quit', 'end', '__noinput_command', 'a', 'back', 'e', 'next')</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3580,7 +3580,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"> = ['q', 'top', 'end', 'quit', 'n', 't', 'abort', 'next', 'back', 'b', 'e', '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"> = ['t', 'b', 'n', 'top', 'back', 'abort', 'q', 'end', 'a', 'quit', 'e', 'next']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3611,7 +3611,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': 'q top end quit n t abort next back b e 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': 't b n top back abort q end a quit e next', '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>

2
docs/1.0-dev/.buildinfo
View file

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 77c8e498bec040719715c92a38f8cf74
config: fb5faa3318ca9ff5a6ee9e46389c8af4
tags: 645f666f9bcd5a90fca523b33c5a78b7

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

@ -79,7 +79,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"> = ['l', 'ls']</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"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -110,7 +110,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': '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>
<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>
<dd></dd></dl>
</dd></dl>
@ -465,7 +465,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"> = ('options', 'option')</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"> = ('option', 'options')</em><a class="headerlink" href="#evennia.commands.default.account.CmdOption._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -762,7 +762,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"> = ('quell', 'unquell')</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"> = ('unquell', 'quell')</em><a class="headerlink" href="#evennia.commands.default.account.CmdQuell._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1526,7 +1526,7 @@ skipping, reloading etc.</p>
<p>Runs batches of commands from a batch-cmd text file (<a href="#id7"><span class="problematic" id="id8">*</span></a>.ev).</p>
<dl class="attribute">
<dt id="evennia.commands.default.batchprocess.CmdBatchCommands._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('batchcommands', 'batchcmd', 'batchcommand')</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('batchcommand', 'batchcommands', 'batchcmd')</em><a class="headerlink" href="#evennia.commands.default.batchprocess.CmdBatchCommands._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1536,7 +1536,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">
@ -1567,7 +1567,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">
@ -1599,7 +1599,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">
@ -2127,7 +2127,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"> = ('desc', 'describe')</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"> = ('describe', 'desc')</em><a class="headerlink" href="#evennia.commands.default.building.CmdDesc._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2208,7 +2208,7 @@ displays a confirmation before destroying, to make sure of your choice.
You can specify the /force switch to bypass this confirmation.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdDestroy._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('destroy', 'delete', 'del')</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('del', 'destroy', 'delete')</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2218,7 +2218,7 @@ You can specify the /force switch to bypass this confirmation.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdDestroy.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['delete', 'del']</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['del', 'delete']</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2259,7 +2259,7 @@ You can specify the /force switch to bypass this confirmation.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdDestroy.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'delete del', 'category': 'building', 'key': 'destroy', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'del delete', 'category': 'building', 'key': 'destroy', 'tags': '', 'text': '\n permanently delete objects\n\n Usage:\n destroy[/switches] [obj, obj2, obj3, [dbref-dbref], ...]\n\n Switches:\n override - The destroy command will usually avoid accidentally\n destroying account objects. This switch overrides this safety.\n force - destroy without confirmation.\n Examples:\n destroy house, roof, door, 44-78\n destroy 5-10, flower, 45\n destroy/force north\n\n Destroys one or many objects. If dbrefs are used, a range to delete can be\n given, e.g. 4-10. Also the end points will be deleted. This command\n displays a confirmation before destroying, to make sure of your choice.\n You can specify the /force switch to bypass this confirmation.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdDestroy.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2382,7 +2382,7 @@ created back from the new room unless the /oneway switch is given.
For more flexibility and power in creating rooms, use dig.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdTunnel._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('tun', 'tunnel')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTunnel._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('tunnel', 'tun')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTunnel._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2708,7 +2708,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"> = ('name', 'rename')</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"> = ('rename', 'name')</em><a class="headerlink" href="#evennia.commands.default.building.CmdName._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3042,7 +3042,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"> = ('typeclass', 'update', 'type', 'parent', 'swap')</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"> = ('parent', 'typeclass', 'swap', 'type', 'update')</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3052,7 +3052,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"> = ['parent', 'update', 'swap', 'type']</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"> = ['type', 'update', 'swap', '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">
@ -3083,7 +3083,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': 'parent update swap type', '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': 'type update swap 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">
@ -3191,7 +3191,7 @@ them by ‘;’, i.e:</p>
</div></blockquote>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdLock._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('locks', 'lock')</em><a class="headerlink" href="#evennia.commands.default.building.CmdLock._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('lock', 'locks')</em><a class="headerlink" href="#evennia.commands.default.building.CmdLock._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3256,7 +3256,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"> = ('ex', 'exam', 'examine')</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', 'ex', 'examine')</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3439,7 +3439,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">
@ -4007,7 +4007,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', 'addcom', 'aliaschan')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4074,7 +4074,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"> = ('delcom', 'delchanalias', '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"> = ('delchanalias', 'delcom', '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">
@ -4207,7 +4207,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"> = ('all channels', 'channels', 'chanlist', 'clist', 'comlist', 'channellist')</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"> = ('channellist', 'channels', 'clist', 'comlist', 'all channels', 'chanlist')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4222,7 +4222,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"> = ['all channels', 'chanlist', 'clist', 'comlist', 'channellist']</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"> = ['channellist', 'clist', 'comlist', 'all channels', 'chanlist']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -4253,7 +4253,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': 'all channels chanlist clist comlist channellist', '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': 'channellist clist comlist all channels chanlist', '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>
@ -4539,7 +4539,7 @@ provide the /sendername switch.</p>
<p>Creates a new channel owned by you.</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdChannelCreate._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('ccreate', 'channelcreate')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('channelcreate', 'ccreate')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4736,7 +4736,7 @@ list - show your last &lt;number&gt; of tells/pages (default)</p>
argument is given, you will get a list of your latest messages.</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdPage._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('tell', 'page')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('page', 'tell')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5062,7 +5062,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"> = ['l', 'ls']</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"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5098,7 +5098,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': '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>
<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>
<dd></dd></dl>
</dd></dl>
@ -5220,7 +5220,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"> = ('inv', 'i', '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">
@ -5349,7 +5349,7 @@ look at you.</p>
your inventory.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdGet._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('get', 'grab')</em><a class="headerlink" href="#evennia.commands.default.general.CmdGet._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('grab', 'get')</em><a class="headerlink" href="#evennia.commands.default.general.CmdGet._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5545,7 +5545,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"> = ('say', '&quot;', &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"> = (&quot;'&quot;, '&quot;', 'say')</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5555,7 +5555,7 @@ placing it in their inventory.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdSay.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&quot;', &quot;'&quot;]</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = [&quot;'&quot;, '&quot;']</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -5586,7 +5586,7 @@ placing it in their inventory.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdSay.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&quot; \'', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '\' &quot;', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -5740,7 +5740,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"> = ('groups', 'access', 'hierarchy')</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"> = ('access', 'hierarchy', '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">
@ -6827,7 +6827,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">
@ -6970,7 +6970,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"> = ('objects', 'listobjs', 'db', 'listobjects', 'stats')</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"> = ('listobjects', 'stats', 'listobjs', 'objects', 'db')</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -6980,7 +6980,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"> = ['listobjs', 'listobjects', 'db', 'stats']</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"> = ['listobjects', 'db', 'listobjs', 'stats']</em><a class="headerlink" href="#evennia.commands.default.system.CmdObjects.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -7011,7 +7011,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': 'listobjs listobjects db stats', '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': 'listobjects db listobjs stats', '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>
@ -7159,7 +7159,7 @@ in the list.</p>
and the current time stamp.</p>
<dl class="attribute">
<dt id="evennia.commands.default.system.CmdTime._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('uptime', 'time')</em><a class="headerlink" href="#evennia.commands.default.system.CmdTime._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('time', 'uptime')</em><a class="headerlink" href="#evennia.commands.default.system.CmdTime._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7237,7 +7237,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"> = ('serverload', 'server', 'serverprocess')</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">
@ -7930,7 +7930,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"> = ('connect', 'co', 'conn', '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', 'con', 'co', '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">
@ -7940,7 +7940,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"> = ['con', 'conn', 'co']</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">
@ -7980,7 +7980,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': 'con conn co', '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>
@ -7999,7 +7999,7 @@ create “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.CmdUnconnectedCreate._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('cr', 'cre', 'create')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('cre', 'cr', 'create')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -8064,7 +8064,7 @@ here for unconnected accounts for the sake of simplicity. The logged in
version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('quit', 'qu', 'q')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('quit', 'q', 'qu')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -8074,7 +8074,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'qu']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -8105,7 +8105,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -8124,7 +8124,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"> = ('__unloggedin_look_command', 'l', 'look')</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"> = ('look', '__unloggedin_look_command', 'l')</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">

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

@ -212,7 +212,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">
@ -2092,7 +2092,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"> = ['l', 'ls']</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"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -2129,7 +2129,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': '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>
<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>
<dd></dd></dl>
</dd></dl>
@ -2578,7 +2578,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"> = ('inv', 'i', 'inventory')</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3237,7 +3237,7 @@ with. The hidden/secret switches will hide all or parts of the roll from
everyone but the person rolling.</p>
<dl class="attribute">
<dt id="evennia.contrib.dice.CmdDice._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('dice', '&#64;dice', 'roll')</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('roll', '&#64;dice', 'dice')</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3247,7 +3247,7 @@ everyone but the person rolling.</p>
<dl class="attribute">
<dt id="evennia.contrib.dice.CmdDice.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&#64;dice', 'roll']</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['roll', '&#64;dice']</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -3278,7 +3278,7 @@ everyone but the person rolling.</p>
<dl class="attribute">
<dt id="evennia.contrib.dice.CmdDice.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;dice roll', 'category': 'general', 'key': 'dice', 'tags': '', 'text': &quot;\n roll dice\n\n Usage:\n dice[/switch] &lt;nr&gt;d&lt;sides&gt; [modifier] [success condition]\n\n Switch:\n hidden - tell the room the roll is being done, but don't show the result\n secret - don't inform the room about neither roll nor result\n\n Examples:\n dice 3d6 + 4\n dice 1d100 - 2 &lt; 50\n\n This will roll the given number of dice with given sides and modifiers.\n So e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\n then add 3 to the total'.\n Accepted modifiers are +, -, * and /.\n A success condition is given as normal Python conditionals\n (&lt;,&gt;,&lt;=,&gt;=,==,!=). So e.g. 2d6 + 3 &gt; 10 means that the roll will succeed\n only if the final result is above 8. If a success condition is given, the\n outcome (pass/fail) will be echoed along with how much it succeeded/failed\n with. The hidden/secret switches will hide all or parts of the roll from\n everyone but the person rolling.\n &quot;}</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'roll &#64;dice', 'category': 'general', 'key': 'dice', 'tags': '', 'text': &quot;\n roll dice\n\n Usage:\n dice[/switch] &lt;nr&gt;d&lt;sides&gt; [modifier] [success condition]\n\n Switch:\n hidden - tell the room the roll is being done, but don't show the result\n secret - don't inform the room about neither roll nor result\n\n Examples:\n dice 3d6 + 4\n dice 1d100 - 2 &lt; 50\n\n This will roll the given number of dice with given sides and modifiers.\n So e.g. 2d6 + 3 means to 'roll a 6-sided die 2 times and add the result,\n then add 3 to the total'.\n Accepted modifiers are +, -, * and /.\n A success condition is given as normal Python conditionals\n (&lt;,&gt;,&lt;=,&gt;=,==,!=). So e.g. 2d6 + 3 &gt; 10 means that the roll will succeed\n only if the final result is above 8. If a success condition is given, the\n outcome (pass/fail) will be echoed along with how much it succeeded/failed\n with. The hidden/secret switches will hide all or parts of the roll from\n everyone but the person rolling.\n &quot;}</em><a class="headerlink" href="#evennia.contrib.dice.CmdDice.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -3395,7 +3395,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"> = ('connect', 'co', 'conn', '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', 'con', 'co', '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">
@ -3405,7 +3405,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"> = ['con', 'conn', 'co']</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">
@ -3440,7 +3440,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': 'con conn co', '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>
@ -3457,7 +3457,7 @@ there is no object yet before the account has logged in)</p>
<p>This creates a new account account.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('cr', 'cre', 'create')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('cre', 'cr', 'create')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3522,7 +3522,7 @@ here for unconnected accounts for the sake of simplicity. The logged in
version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('quit', 'qu', 'q')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('quit', 'q', 'qu')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3532,7 +3532,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'qu']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -3563,7 +3563,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n We maintain a different version of the `quit` command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -3577,7 +3577,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"> = ('__unloggedin_look_command', 'l', 'look')</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"> = ('look', '__unloggedin_look_command', 'l')</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedLook._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3781,7 +3781,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"> = ('desc', 'describe')</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"> = ('describe', 'desc')</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 +3989,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"> = ['l', 'ls']</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"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -4015,7 +4015,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': '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>
<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>
<dd></dd></dl>
</dd></dl>
@ -4713,7 +4713,7 @@ All extra kwargs will be passed on to the protocol.</p>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.gendersub.SetGender._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;gender', '&#64;sex')</em><a class="headerlink" href="#evennia.contrib.gendersub.SetGender._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;sex', '&#64;gender')</em><a class="headerlink" href="#evennia.contrib.gendersub.SetGender._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -4916,7 +4916,7 @@ reply - Replies to a received message, appending the original message to the b
&#64;mail/reply 9=Thanks for the info!</p>
<dl class="attribute">
<dt id="evennia.contrib.mail.CmdMail._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('mail', '&#64;mail')</em><a class="headerlink" href="#evennia.contrib.mail.CmdMail._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;mail', 'mail')</em><a class="headerlink" href="#evennia.contrib.mail.CmdMail._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5067,7 +5067,7 @@ reply - Replies to a received message, appending the original message to the b
&#64;mail/reply 9=Thanks for the info!</p>
<dl class="attribute">
<dt id="evennia.contrib.mail.CmdMailCharacter._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('mail', '&#64;mail')</em><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('&#64;mail', 'mail')</em><a class="headerlink" href="#evennia.contrib.mail.CmdMailCharacter._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -5752,7 +5752,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;puzzlerecipe', '&#64;puzzle')</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;puzzle', '&#64;puzzlerecipe')</em><a class="headerlink" href="#evennia.contrib.puzzles.CmdCreatePuzzleRecipe._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7120,7 +7120,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"> = ('forget', 'recognize', 'recog')</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdRecog._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7179,7 +7179,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"> = ('say', '&quot;', &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"> = (&quot;'&quot;, '&quot;', 'say')</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -7189,7 +7189,7 @@ Using the command without arguments will list all current recogs.</p>
<dl class="attribute">
<dt id="evennia.contrib.rpsystem.CmdSay.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['&quot;', &quot;'&quot;]</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = [&quot;'&quot;, '&quot;']</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -7220,7 +7220,7 @@ Using the command without arguments will list all current recogs.</p>
<dl class="attribute">
<dt id="evennia.contrib.rpsystem.CmdSay.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&quot; \'', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '\' &quot;', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say &lt;message&gt;\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.contrib.rpsystem.CmdSay.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

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

@ -320,7 +320,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;callback', '&#64;call', '&#64;calls', '&#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;call', '&#64;callbacks', '&#64;calls', '&#64;callback')</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">

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

@ -226,7 +226,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"> = ('spare', 'disengage')</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"> = ('disengage', 'spare')</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">
@ -335,7 +335,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"> = ('pass', 'hold', 'wait')</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"> = ('wait', 'pass', 'hold')</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">
@ -1041,7 +1041,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"> = ('spare', 'disengage')</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"> = ('disengage', 'spare')</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">
@ -1260,7 +1260,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"> = ('pass', 'hold', 'wait')</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"> = ('wait', 'pass', 'hold')</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">
@ -2202,7 +2202,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"> = ('spare', 'disengage')</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"> = ('disengage', 'spare')</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">
@ -2311,7 +2311,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"> = ('pass', 'hold', 'wait')</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"> = ('wait', 'pass', 'hold')</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">
@ -3365,7 +3365,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"> = ('spare', 'disengage')</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"> = ('disengage', 'spare')</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">
@ -3542,7 +3542,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"> = ('pass', 'hold', 'wait')</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"> = ('wait', 'pass', 'hold')</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">
@ -4454,7 +4454,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"> = ('spare', 'disengage')</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"> = ('disengage', 'spare')</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">
@ -4563,7 +4563,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"> = ('pass', 'hold', 'wait')</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"> = ('wait', 'pass', 'hold')</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">

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

@ -214,7 +214,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"> = ('examine', 'get', 'listen', 'look', 'feel', 'l', 'ex')</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"> = ('get', 'examine', 'ex', 'l', 'look', 'listen', 'feel')</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">
@ -224,7 +224,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"> = ['examine', 'get', 'listen', 'feel', 'l', 'ex']</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"> = ['get', 'examine', 'ex', 'l', 'listen', 'feel']</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">
@ -255,7 +255,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': 'examine get listen feel l 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>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'get examine ex l listen feel', '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>
@ -272,7 +272,7 @@ the button is pushed.</p>
<p>Closes the lid of the red button.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('close', 'close lid')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('close lid', 'close')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -331,7 +331,7 @@ the button is pushed.</p>
push the lid of the button away.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('nudge', 'nudge lid')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('nudge lid', 'nudge')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -388,7 +388,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 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>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('open button', 'open', 'open lid')</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">
@ -445,7 +445,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', 'press', 'push button')</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', 'push', 'press button', 'push button')</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">
@ -455,7 +455,7 @@ push the lid of the button away.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['press', 'push', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['push', 'press button', 'press']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -491,7 +491,7 @@ lid-state respectively.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'push press button press', 'category': 'general', 'key': 'push button', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -508,7 +508,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"> = ('break lid', 'smash glass', 'smash', 'smash 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', 'break lid', 'smash lid', 'smash glass')</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">
@ -518,7 +518,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"> = ['break lid', 'smash', 'smash 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"> = ['break lid', 'smash lid', 'smash']</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">
@ -550,7 +550,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': 'break lid smash smash 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': 'break lid smash lid smash', '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>

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

@ -57,7 +57,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"> = ('moboff', 'mobon')</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"> = ('mobon', 'moboff')</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">
@ -370,7 +370,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"> = ('parry', 'thrust', 'stab', 'fight', 'pierce', 'slash', 'defend', 'attack', 'kill', 'hit', 'chop')</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"> = ('fight', 'stab', 'kill', 'defend', 'slash', 'chop', 'thrust', 'parry', 'hit', 'pierce', '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">
@ -380,7 +380,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"> = ['parry', 'thrust', 'stab', 'fight', 'pierce', 'slash', 'defend', 'kill', 'hit', 'chop']</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"> = ['fight', 'stab', 'kill', 'slash', 'chop', 'thrust', 'parry', 'hit', 'pierce', 'defend']</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">
@ -411,7 +411,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': 'parry thrust stab fight pierce slash defend kill hit chop', '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': 'fight stab kill slash chop thrust parry hit pierce defend', '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>
@ -539,7 +539,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"> = ('on', 'burn', 'light')</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"> = ('on', 'light', '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">
@ -549,7 +549,7 @@ itself handle all messages.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['burn', 'light']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['light', 'burn']</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
@ -581,7 +581,7 @@ to sit on a “lightable” object, we operate only on self.obj.</p>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.objects.CmdLight.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'burn light', 'category': 'tutorialworld', 'key': 'on', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'light burn', 'category': 'tutorialworld', 'key': 'on', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_world.objects.CmdLight.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -593,7 +593,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 button', 'button', 'press', 'push 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"> = ('push button', 'press button', 'button', 'press')</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">
@ -603,7 +603,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"> = ['push button', 'press button', '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', 'button', 'push 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">
@ -634,7 +634,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': 'push button press 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>
<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>
<dd></dd></dl>
</dd></dl>
@ -844,7 +844,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"> = ('move', 'push', 'pull', 'shiftroot', 'shift')</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"> = ('push', 'shiftroot', 'pull', 'move', 'shift')</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">
@ -854,7 +854,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"> = ['push', 'pull', 'shiftroot', 'move']</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"> = ['pull', 'move', 'push', 'shiftroot']</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">
@ -895,7 +895,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': 'push pull shiftroot move', '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': 'pull move push shiftroot', '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>
@ -1676,7 +1676,7 @@ on the bridge, 0 - 4.</p></li>
</dl>
<dl class="attribute">
<dt id="evennia.contrib.tutorial_world.rooms.CmdEast._keyaliases">
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('e', 'east')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast._keyaliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('east', 'e')</em><a class="headerlink" href="#evennia.contrib.tutorial_world.rooms.CmdEast._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1794,7 +1794,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"> = ('search', 'look', 'fiddle', 'feel around', 'feel', 'l')</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', 'look', 'feel around', 'search', 'fiddle', 'feel')</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">
@ -1804,7 +1804,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"> = ['search', 'l', 'fiddle', 'feel', 'feel around']</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 around', 'search', 'fiddle', 'feel']</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">
@ -1837,7 +1837,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': 'search l fiddle feel feel around', '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 around search fiddle feel', '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>
@ -1932,7 +1932,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"> = ['l', 'ls']</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"> = ['ls', 'l']</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">
@ -1959,7 +1959,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': '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>
<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>
<dd></dd></dl>
</dd></dl>

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

@ -1899,7 +1899,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"> = (':&lt;', ':fd', ':u', ':h', '::', ':echo', ':dw', ':dd', ':DD', ':x', ':editor_command_group', ':q!', ':fi', ':q', ':s', ':&gt;', ':=', ':', ':::', ':j', ':I', ':S', ':p', ':!', ':y', ':wq', ':uu', ':UU', ':w', ':r', ':i', ':A', ':f')</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"> = (':q', ':u', ':echo', ':!', ':dw', ':j', ':f', ':fi', ':p', ':&lt;', ':=', ':w', ':I', ':::', ':r', ':i', ':editor_command_group', ':', ':S', ':s', ':h', ':&gt;', ':UU', '::', ':dd', ':x', ':q!', ':DD', ':y', ':fd', ':A', ':uu', ':wq')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1909,7 +1909,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"> = [':&lt;', ':fd', ':h', '::', ':echo', ':dw', ':dd', ':DD', ':x', ':q!', ':fi', ':q', ':s', ':&gt;', ':=', ':', ':::', ':j', ':I', ':S', ':p', ':!', ':y', ':wq', ':uu', ':UU', ':w', ':r', ':i', ':A', ':f', ':u']</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"> = [':q', ':u', ':echo', ':!', ':dw', ':j', ':f', ':fi', ':p', ':&lt;', ':=', ':w', ':I', ':::', ':r', ':i', ':', ':S', ':s', ':h', ':&gt;', ':UU', '::', ':dd', ':x', ':q!', ':DD', ':y', ':fd', ':A', ':uu', ':wq']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1942,7 +1942,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': ':&lt; :fd :h :: :echo :dw :dd :DD :x :q! :fi :q :s :&gt; := : ::: :j :I :S :p :! :y :wq :uu :UU :w :r :i :A :f :u', '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': ':q :u :echo :! :dw :j :f :fi :p :&lt; := :w :I ::: :r :i : :S :s :h :&gt; :UU :: :dd :x :q! :DD :y :fd :A :uu :wq', '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>
@ -1954,7 +1954,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"> = ('__noinput_command', '__nomatch_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"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdLineInput._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2006,7 +2006,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"> = ('__noinput_command', '__nomatch_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"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.eveditor.CmdSaveYesNo._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2721,7 +2721,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"> = ('__noinput_command', '__nomatch_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"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.evmenu.CmdEvMenuNode._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -2774,7 +2774,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"> = ('__noinput_command', '__nomatch_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"> = ('__nomatch_command', '__noinput_command')</em><a class="headerlink" href="#evennia.utils.evmenu.CmdGetInput._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3571,7 +3571,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"> = ('next', 'a', 'back', 'end', 'quit', 'n', 't', 'abort', 'q', 'top', '__noinput_command', 'e', 'b')</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"> = ('t', 'b', 'n', 'top', 'abort', 'q', 'quit', 'end', '__noinput_command', 'a', 'back', 'e', 'next')</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore._keyaliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3581,7 +3581,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"> = ['q', 'top', 'end', 'quit', 'n', 't', 'abort', 'next', 'back', 'b', 'e', '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"> = ['t', 'b', 'n', 'top', 'back', 'abort', 'q', 'end', 'a', 'quit', 'e', 'next']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -3612,7 +3612,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': 'q top end quit n t abort next back b e 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': 't b n top back abort q end a quit e next', '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>

1
docs/latest
View file

@ -1 +0,0 @@
1.0-dev