<spanid="evennia-commands-default-package"></span><h1>evennia.commands.default package<aclass="headerlink"href="#module-evennia.commands.default"title="Permalink to this headline">¶</a></h1>
<p>This package contains all default commands of Evennia, grouped after category.</p>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="evennia-commands-default-account-module"></span><h2>evennia.commands.default.account module<aclass="headerlink"href="#module-evennia.commands.default.account"title="Permalink to this headline">¶</a></h2>
<p>Account (OOC) commands. These are stored on the Account object
and self.caller is thus always an Account, not an Object/Character.</p>
<p>These commands go in the AccountCmdset and are accessible also
when puppeting a Character (although with lower priority)</p>
<p>These commands use the account_caller property which tells the command
parent (MuxCommand, usually) to setup caller correctly. They use
self.account to make sure to always use the account object rather than
self.caller (which change depending on the level you are calling from)
The property self.character can be used to access the character when
these commands are triggered with a connected character (such as the
case of the <cite>ooc</cite> command), it is None if we are OOC.</p>
<p>Note that under MULTISESSION_MODE > 2, Account commands should use
self.msg() and similar methods to reroute returns to the correct
method. Otherwise all text will be returned to all connected sessions.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdOOCLook</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdOOCLook"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdOOCLook"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('look', 'ls', 'l')</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOCLook._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'l', 'look', 'ls'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOCLook._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOCLook.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['ls', 'l']</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOCLook.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdOOCLook.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdOOCLook.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOCLook.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'look'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOCLook.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOCLook.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOCLook.locks"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdIC</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdIC"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdIC"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('puppet', 'ic')</em><aclass="headerlink"href="#evennia.commands.default.account.CmdIC._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'ic', 'puppet'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdIC._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdIC.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['puppet']</em><aclass="headerlink"href="#evennia.commands.default.account.CmdIC.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdIC.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdIC.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdIC.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'ic'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdIC.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdIC.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdIC.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'puppet', 'category': 'general', 'key': 'ic', 'tags': '', 'text': '\n control an object you have permission to puppet\n\n Usage:\n ic <character>\n\n Go in-character (IC) as a given Character.\n\n This will attempt to "become" a different object assuming you have\n the right to do so. Note that it\'s the ACCOUNT character that puppets\n characters/objects and which needs to have the correct permission!\n\n You cannot become an object that is already controlled by another\n account. In principle <character> can be any in-game object as long\n as you the account have access right to puppet it.\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdIC.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.account.CmdOOC">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdOOC</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdOOC"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('unpuppet', 'ooc')</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'ooc', 'unpuppet'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['unpuppet']</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdOOC.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'ooc'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'unpuppet', 'category': 'general', 'key': 'ooc', 'tags': '', 'text': '\n stop puppeting and go ooc\n\n Usage:\n ooc\n\n Go out-of-character (OOC).\n\n This will leave your current character and put you in a incorporeal OOC state.\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOOC.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdPassword</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdPassword"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('password',)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'password'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdPassword.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'password'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'password', 'tags': '', 'text': '\n change your password\n\n Usage:\n password <old password> = <new password>\n\n Changes your password. Make sure to pick a safe one.\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdPassword.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.account.CmdQuit">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdQuit</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdQuit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('quit',)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'quit'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdQuit.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'quit'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n quit the game\n\n Usage:\n quit\n\n Switch:\n all - disconnect all connected sessions\n\n Gracefully disconnect your current session from the\n game. Use the /all switch to disconnect from all sessions.\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('all',)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuit.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdCharCreate</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdCharCreate"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('charcreate',)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'charcreate'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdCharCreate.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'charcreate'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'charcreate', 'tags': '', 'text': '\n create a new character\n\n Usage:\n charcreate <charname> [= desc]\n\n Create a new character, optionally giving it a description. You\n may use upper-case letters in the name - you will nevertheless\n always be able to access your character using lower-case letters\n if you want.\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharCreate.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdOption</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdOption"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdOption"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('option', 'options')</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOption._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'option', 'options'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOption._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOption.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['options']</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOption.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdOption.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdOption.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOption.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'option'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOption.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOption.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOption.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'options', 'category': 'general', 'key': 'option', 'tags': '', 'text': '\n Set an account option\n\n Usage:\n option[/save] [name = value]\n\n Switches:\n save - Save the current option settings for future logins.\n clear - Clear the saved options.\n\n This command allows for viewing and setting client interface\n settings. Note that saved options may not be able to be used if\n later connecting with a client with different capabilities.\n\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOption.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('save', 'clear')</em><aclass="headerlink"href="#evennia.commands.default.account.CmdOption.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdSessions</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdSessions"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('sessions',)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'sessions'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdSessions.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'sessions'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'sessions', 'tags': '', 'text': '\n check your connected session(s)\n\n Usage:\n sessions\n\n Lists the sessions currently connected to your account.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdSessions.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.account.CmdWho">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdWho</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdWho"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdWho"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('doing', 'who')</em><aclass="headerlink"href="#evennia.commands.default.account.CmdWho._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'doing', 'who'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdWho._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdWho.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['doing']</em><aclass="headerlink"href="#evennia.commands.default.account.CmdWho.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdWho.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdWho.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Get all connected accounts by polling session.</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdWho.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'who'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdWho.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdWho.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdWho.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'doing', 'category': 'general', 'key': 'who', 'tags': '', 'text': '\n list who is currently online\n\n Usage:\n who\n doing\n\n Shows who is currently online. Doing is an alias that limits info\n also for those with all permissions.\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdWho.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdColorTest</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdColorTest"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('color',)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'color'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdColorTest.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'color'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'color', 'tags': '', 'text': '\n testing which colors your client support\n\n Usage:\n color ansi||xterm256\n\n Prints a color map along with in-mud color codes to use to produce\n them. It also tests what is supported in your client. Choices are\n 16-color ansi (supported in most muds) or the 256-color xterm256\n standard. No checking is done to determine your client supports\n color - if not you will see rubbish appear.\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">slice_bright_bg</code><emclass="property"> = slice(None, None, None)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.slice_bright_bg"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">slice_bright_fg</code><emclass="property"> = slice(7, 15, None)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.slice_bright_fg"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">slice_dark_bg</code><emclass="property"> = slice(-8, None, None)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.slice_dark_bg"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">slice_dark_fg</code><emclass="property"> = slice(15, 23, None)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.slice_dark_fg"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">table_format</code><spanclass="sig-paren">(</span><emclass="sig-param">table</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdColorTest.table_format"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdColorTest.table_format"title="Permalink to this definition">¶</a></dt>
<dd><p>Helper method to format the ansi/xterm256 tables.
Takes a table of columns [[val,val,…],[val,val,…],…]</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdQuell</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdQuell"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('unquell', 'quell')</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'quell', 'unquell'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_recache_locks</code><spanclass="sig-paren">(</span><emclass="sig-param">account</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdQuell._recache_locks"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell._recache_locks"title="Permalink to this definition">¶</a></dt>
<dd><p>Helper method to reset the lockhandler on an already puppeted object</p>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['unquell']</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdQuell.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'quell'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'unquell', 'category': 'general', 'key': 'quell', 'tags': '', 'text': "\n use character's permissions instead of account's\n\n Usage:\n quell\n unquell\n\n Normally the permission level of the Account is used when puppeting a\n Character/Object to determine access. This command will switch the lock\n system to make use of the puppeted Object's permissions instead. This is\n useful mainly for testing.\n Hierarchical permission quelling only work downwards, thus an Account cannot\n use a higher-permission Character to escalate their permission level.\n Use the unquell command to revert back to normal operation.\n "}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdQuell.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdCharDelete</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdCharDelete"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdCharDelete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('chardelete',)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharDelete._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'chardelete'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharDelete._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharDelete.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdCharDelete.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdCharDelete.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharDelete.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'chardelete'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharDelete.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharDelete.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharDelete.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'chardelete', 'tags': '', 'text': '\n delete a character - this cannot be undone!\n\n Usage:\n chardelete <charname>\n\n Permanently deletes one of your characters.\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdCharDelete.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.account.</code><codeclass="sig-name descname">CmdStyle</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdStyle"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('style',)</em><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'style'}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdStyle.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle.func"title="Permalink to this definition">¶</a></dt>
<dd><p>This is the hook function that actually does all the work. It is called
by the cmdhandler right after self.parser() finishes, and so has access
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'style'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list_styles</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdStyle.list_styles"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle.list_styles"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'style', 'tags': '', 'text': '\n In-game style options\n\n Usage:\n style\n style <option> = <value>\n\n Configure stylings for in-game display elements like table borders, help\n entriest etc. Use without arguments to see all available options.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">set</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/account.html#CmdStyle.set"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle.set"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ['clear']</em><aclass="headerlink"href="#evennia.commands.default.account.CmdStyle.switch_options"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-admin-module"></span><h2>evennia.commands.default.admin module<aclass="headerlink"href="#module-evennia.commands.default.admin"title="Permalink to this headline">¶</a></h2>
<p>Admin commands</p>
<dlclass="class">
<dtid="evennia.commands.default.admin.CmdBoot">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.admin.</code><codeclass="sig-name descname">CmdBoot</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdBoot"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('boot',)</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'boot'}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdBoot.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'admin'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'boot'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(boot) or perm(Admin)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(boot) or perm(Admin)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'admin', 'key': 'boot', 'tags': '', 'text': '\n kick an account from the server.\n\n Usage\n boot[/switches] <account obj> [: reason]\n\n Switches:\n quiet - Silently boot without informing account\n sid - boot by session id instead of name or dbref\n\n Boot an account object from the server. If a reason is\n supplied it will be echoed to the user unless /quiet is set.\n '}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('quiet', 'sid')</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBoot.switch_options"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.admin.CmdBan">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.admin.</code><codeclass="sig-name descname">CmdBan</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdBan"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdBan"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('ban', 'bans')</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBan._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'ban', 'bans'}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBan._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['bans']</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBan.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdBan.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdBan.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Bans are stored in a serverconf db object as a list of
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'admin'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBan.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'ban'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBan.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(ban) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBan.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(ban) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBan.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'bans', 'category': 'admin', 'key': 'ban', 'tags': '', 'text': "\n ban an account from the server\n\n Usage:\n ban [<name or ip> [: reason]]\n\n Without any arguments, shows numbered list of active bans.\n\n This command bans a user from accessing the game. Supply an optional\n reason to be able to later remember why the ban was put in place.\n\n It is often preferable to ban an account from the server than to\n delete an account with accounts/delete. If banned by name, that account\n account can no longer be logged into.\n\n IP (Internet Protocol) address banning allows blocking all access\n from a specific address or subnet. Use an asterisk (*) as a\n wildcard.\n\n Examples:\n ban thomas - ban account 'thomas'\n ban/ip 134.233.2.111 - ban specific ip address\n ban/ip 134.233.2.* - ban all in a subnet\n ban/ip 134.233.*.* - even wider ban\n\n A single IP filter can be easy to circumvent by changing computers\n or requesting a new IP address. Setting a wide IP block filter with\n wildcards might be tempting, but remember that it may also\n accidentally block innocent users connecting from the same country\n or region.\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdBan.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.admin.CmdUnban">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.admin.</code><codeclass="sig-name descname">CmdUnban</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdUnban"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdUnban"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('unban',)</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdUnban._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'unban'}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdUnban._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdUnban.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdUnban.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdUnban.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'admin'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdUnban.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'unban'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdUnban.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(unban) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdUnban.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(unban) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdUnban.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'admin', 'key': 'unban', 'tags': '', 'text': '\n remove a ban from an account\n\n Usage:\n unban <banid>\n\n This will clear an account name/ip ban previously set with the ban\n command. Use this command without an argument to view a numbered\n list of bans. Use the numbers in this list to select which one to\n unban.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdUnban.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.admin.CmdEmit">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.admin.</code><codeclass="sig-name descname">CmdEmit</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdEmit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('pemit', 'emit', 'remit')</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'emit', 'pemit', 'remit'}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['pemit', 'remit']</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdEmit.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'admin'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'emit'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(emit) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(emit) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'pemit remit', 'category': 'admin', 'key': 'emit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [<obj>, <obj>, ... =] <message>\n remit [<obj>, <obj>, ... =] <message>\n pemit [<obj>, <obj>, ... =] <message>\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('room', 'accounts', 'contents')</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdEmit.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.admin.</code><codeclass="sig-name descname">CmdNewPassword</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdNewPassword"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdNewPassword"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('userpassword',)</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdNewPassword._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'userpassword'}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdNewPassword._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdNewPassword.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdNewPassword.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdNewPassword.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'admin'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdNewPassword.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'userpassword'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdNewPassword.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(newpassword) or perm(Admin)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdNewPassword.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(newpassword) or perm(Admin)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdNewPassword.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'admin', 'key': 'userpassword', 'tags': '', 'text': "\n change the password of an account\n\n Usage:\n userpassword <user obj> = <new password>\n\n Set an account's password.\n "}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdNewPassword.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.admin.CmdPerm">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.admin.</code><codeclass="sig-name descname">CmdPerm</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdPerm"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('setperm', 'perm')</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'perm', 'setperm'}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['setperm']</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdPerm.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'admin'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'perm'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(perm) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(perm) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'setperm', 'category': 'admin', 'key': 'perm', 'tags': '', 'text': '\n set the permissions of an account/object\n\n Usage:\n perm[/switch] <object> [= <permission>[,<permission>,...]]\n perm[/switch] *<account> [= <permission>[,<permission>,...]]\n\n Switches:\n del - delete the given permission from <object> or <account>.\n account - set permission on an account (same as adding * to name)\n\n This command sets/clears individual permission strings on an object\n or account. If no permission is given, list all permissions on <object>.\n '}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('del', 'account')</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdPerm.switch_options"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.admin.CmdWall">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.admin.</code><codeclass="sig-name descname">CmdWall</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdWall"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdWall"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('wall',)</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdWall._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'wall'}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdWall._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdWall.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdWall.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdWall.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'admin'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdWall.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'wall'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdWall.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(wall) or perm(Admin)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdWall.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(wall) or perm(Admin)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdWall.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'admin', 'key': 'wall', 'tags': '', 'text': '\n make an announcement to all\n\n Usage:\n wall <message>\n\n Announces a message to all connected sessions\n including all currently unlogged in.\n '}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdWall.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.admin.CmdForce">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.admin.</code><codeclass="sig-name descname">CmdForce</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdForce"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('force',)</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'force'}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/admin.html#CmdForce.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'force'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(spawn) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(spawn) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">perm_used</code><emclass="property"> = 'edit'</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce.perm_used"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'force', 'tags': '', 'text': '\n forces an object to execute a command\n\n Usage:\n force <object>=<command string>\n\n Example:\n force bob=get stick\n '}</em><aclass="headerlink"href="#evennia.commands.default.admin.CmdForce.search_index_entry"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-batchprocess-module"></span><h2>evennia.commands.default.batchprocess module<aclass="headerlink"href="#module-evennia.commands.default.batchprocess"title="Permalink to this headline">¶</a></h2>
<p>Batch processors</p>
<p>These commands implements the ‘batch-command’ and ‘batch-code’
processors, using the functionality in evennia.utils.batchprocessors.
They allow for offline world-building.</p>
<p>Batch-command is the simpler system. This reads a file (<ahref="#id3"><spanclass="problematic"id="id4">*</span></a>.ev)
containing a list of in-game commands and executes them in sequence as
if they had been entered in the game (including permission checks
etc).</p>
<p>Batch-code is a full-fledged python code interpreter that reads blocks
of python code (<ahref="#id5"><spanclass="problematic"id="id6">*</span></a>.py) and executes them in sequence. This allows for
much more power than Batch-command, but requires knowing Python and
the Evennia API. It is also a severe security risk and should
therefore always be limited to superusers only.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.batchprocess.</code><codeclass="sig-name descname">CmdBatchCommands</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/batchprocess.html#CmdBatchCommands"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('batchcommand', 'batchcmd', 'batchcommands')</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'batchcmd', 'batchcommand', 'batchcommands'}</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['batchcmd', 'batchcommand']</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/batchprocess.html#CmdBatchCommands.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'batchcommands'</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(batchcommands) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(batchcommands) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'batchcmd batchcommand', 'category': 'building', 'key': 'batchcommands', 'tags': '', 'text': '\n build from batch-command file\n\n Usage:\n batchcommands[/interactive] <python.path.to.file>\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><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('interactive',)</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCommands.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.batchprocess.</code><codeclass="sig-name descname">CmdBatchCode</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/batchprocess.html#CmdBatchCode"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('batchcodes', 'batchcode')</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'batchcode', 'batchcodes'}</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['batchcodes']</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/batchprocess.html#CmdBatchCode.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'batchcode'</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:superuser()'</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:superuser()'</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'batchcodes', 'category': 'building', 'key': 'batchcode', 'tags': '', 'text': '\n build from batch-code file\n\n Usage:\n batchcode[/interactive] <python path to file>\n\n Switch:\n interactive - this mode will offer more control when\n executing the batch file, like stepping,\n skipping, reloading etc.\n debug - auto-delete all objects that has been marked as\n deletable in the script file (see example files for\n syntax). This is useful so as to to not leave multiple\n object copies behind when testing out the script.\n\n Runs batches of commands from a batch-code text file (*.py).\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('interactive', 'debug')</em><aclass="headerlink"href="#evennia.commands.default.batchprocess.CmdBatchCode.switch_options"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-building-module"></span><h2>evennia.commands.default.building module<aclass="headerlink"href="#module-evennia.commands.default.building"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">ObjManipCommand</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#ObjManipCommand"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.ObjManipCommand"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('command',)</em><aclass="headerlink"href="#evennia.commands.default.building.ObjManipCommand._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'command'}</em><aclass="headerlink"href="#evennia.commands.default.building.ObjManipCommand._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.ObjManipCommand.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.building.ObjManipCommand.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'command'</em><aclass="headerlink"href="#evennia.commands.default.building.ObjManipCommand.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.commands.default.building.ObjManipCommand.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#ObjManipCommand.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.ObjManipCommand.parse"title="Permalink to this definition">¶</a></dt>
<dd><p>We need to expand the default parsing to get all
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'command', 'tags': '', 'text': "\n This is a parent class for some of the defining objmanip commands\n since they tend to have some more variables to define new objects.\n\n Each object definition can have several components. First is\n always a name, followed by an optional alias list and finally an\n some optional data, such as a typeclass or a location. A comma ','\n separates different objects. Like this:\n\n name1;alias;alias;alias:option, name2;alias;alias ...\n\n Spaces between all components are stripped.\n\n A second situation is attribute manipulation. Such commands\n are simpler and offer combinations\n\n objname/attr/attr/attr, objname/attr, ...\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.ObjManipCommand.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdSetObjAlias</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetObjAlias"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('setobjalias', 'alias')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'alias', 'setobjalias'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['setobjalias']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetObjAlias.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'alias'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(setobjalias) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(setobjalias) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'setobjalias', 'category': 'building', 'key': 'alias', 'tags': '', 'text': "\n adding permanent aliases for object\n\n Usage:\n alias <obj> [= [alias[,alias,alias,...]]]\n alias <obj> =\n alias/category <obj> = [alias[,alias,...]:<category>\n\n Switches:\n category - requires ending input with :category, to store the\n given aliases with the given category.\n\n Assigns aliases to an object so it can be referenced by more\n than one name. Assign empty to remove all aliases from object. If\n assigning a category, all aliases given will be using this category.\n\n Observe that this is not the same thing as personal aliases\n created with the 'nick' command! Aliases set with alias are\n changing the object in question, making those aliases usable\n by everyone.\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('category',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdCopy</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdCopy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdCopy"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('copy',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCopy._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'copy'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCopy._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCopy.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdCopy.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdCopy.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCopy.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'copy'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCopy.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(copy) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCopy.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(copy) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCopy.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'copy', 'tags': '', 'text': "\n copy an object and its properties\n\n Usage:\n copy <original obj> [= <new_name>][;alias;alias..]\n [:<new_location>] [,<new_name2> ...]\n\n Create one or more copies of an object. If you don't supply any targets,\n one exact copy of the original object will be created with the name *_copy.\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCopy.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdCpAttr</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdCpAttr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('cpattr',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'cpattr'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">check_from_attr</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">attr</em>, <emclass="sig-param">clear=False</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdCpAttr.check_from_attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.check_from_attr"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook for overriding on subclassed commands. Checks to make sure a
caller can copy the attr from the object in question. If not, return a
false value and the command will abort. An error message should be
provided by this function.</p>
<p>If clear is True, user is attempting to move the attribute.</p>
<codeclass="sig-name descname">check_has_attr</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">attr</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdCpAttr.check_has_attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.check_has_attr"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook for overriding on subclassed commands. Do any preprocessing
required and verify an object has an attribute.</p>
<codeclass="sig-name descname">check_to_attr</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">attr</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdCpAttr.check_to_attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.check_to_attr"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook for overriding on subclassed commands. Checks to make sure a
caller can write to the specified attribute on the specified object.
If not, return a false value and the attribute will be skipped. An
error message should be provided by this function.</p>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdCpAttr.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get_attr</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">attr</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdCpAttr.get_attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.get_attr"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook for overriding on subclassed commands. Do any preprocessing
required and get the attribute from the object.</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'cpattr'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(cpattr) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(cpattr) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'cpattr', 'tags': '', 'text': "\n copy attributes between objects\n\n Usage:\n cpattr[/switch] <obj>/<attr> = <obj1>/<attr1> [,<obj2>/<attr2>,<obj3>/<attr3>,...]\n cpattr[/switch] <obj>/<attr> = <obj1> [,<obj2>,<obj3>,...]\n cpattr[/switch] <attr> = <obj1>/<attr1> [,<obj2>/<attr2>,<obj3>/<attr3>,...]\n cpattr[/switch] <attr> = <obj1>[,<obj2>,<obj3>,...]\n\n Switches:\n move - delete the attribute from the source object after copying.\n\n Example:\n cpattr coolness = Anna/chillout, Anna/nicety, Tom/nicety\n ->\n copies the coolness attribute (defined on yourself), to attributes\n on Anna and Tom.\n\n Copy the attribute one object to one or more attributes on another object.\n If you don't supply a source object, yourself is used.\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('move',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdMvAttr</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdMvAttr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('mvattr',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'mvattr'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdMvAttr.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'mvattr'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(mvattr) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(mvattr) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'mvattr', 'tags': '', 'text': "\n move attributes between objects\n\n Usage:\n mvattr[/switch] <obj>/<attr> = <obj1>/<attr1> [,<obj2>/<attr2>,<obj3>/<attr3>,...]\n mvattr[/switch] <obj>/<attr> = <obj1> [,<obj2>,<obj3>,...]\n mvattr[/switch] <attr> = <obj1>/<attr1> [,<obj2>/<attr2>,<obj3>/<attr3>,...]\n mvattr[/switch] <attr> = <obj1>[,<obj2>,<obj3>,...]\n\n Switches:\n copy - Don't delete the original after moving.\n\n Move an attribute from one object to one or more attributes on another\n object. If you don't supply a source object, yourself is used.\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('copy',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdCreate</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdCreate"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('create',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'create'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdCreate.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'create'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(create) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(create) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">new_obj_lockstring</code><emclass="property"> = 'control:id({id}) or perm(Admin);delete:id({id}) or perm(Admin)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate.new_obj_lockstring"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'create', 'tags': '', 'text': "\n create new objects\n\n Usage:\n create[/drop] <objname>[;alias;alias...][:typeclass], <objname>...\n\n switch:\n drop - automatically drop the new object into your current\n location (this is not echoed). This also sets the new\n object's home to the current location rather than to you.\n\n Creates one or more new objects. If typeclass is given, the object\n is created as a child of this typeclass. The typeclass script is\n assumed to be located under types/ and any further\n directory structure is given in Python notation. So if you have a\n correct typeclass 'RedButton' defined in\n types/examples/red_button.py, you could create a new\n object of this type like this:\n\n create/drop button;red : examples.red_button.RedButton\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('drop',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdDesc</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdDesc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('describe', 'desc')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'desc', 'describe'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['describe']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">edit_handler</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdDesc.edit_handler"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.edit_handler"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdDesc.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'desc'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(desc) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(desc) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'describe', 'category': 'building', 'key': 'desc', 'tags': '', 'text': '\n describe an object or the current room.\n\n Usage:\n desc [<obj> =] <description>\n\n Switches:\n edit - Open up a line editor for more advanced editing.\n\n Sets the "desc" attribute on an object. If an object is not given,\n describe the current room.\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('edit',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdDestroy</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdDestroy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('destroy', 'delete', 'del')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'del', 'delete', 'destroy'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['delete', 'del']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">confirm</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.confirm"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">default_confirm</code><emclass="property"> = 'yes'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.default_confirm"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdDestroy.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'destroy'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(destroy) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(destroy) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="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><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('override', 'force')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.switch_options"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.building.CmdDig">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdDig</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdDig"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdDig"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('dig',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'dig'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdDig.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Do the digging. Inherits variables from ObjManipCommand.parse()</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'dig'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(dig) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(dig) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">new_room_lockstring</code><emclass="property"> = 'control:id({id}) or perm(Admin); delete:id({id}) or perm(Admin); edit:id({id}) or perm(Admin)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.new_room_lockstring"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'dig', 'tags': '', 'text': "\n build new rooms and connect them to the current location\n\n Usage:\n dig[/switches] <roomname>[;alias;alias...][:typeclass]\n [= <exit_to_there>[;alias][:typeclass]]\n [, <exit_to_here>[;alias][:typeclass]]\n\n Switches:\n tel or teleport - move yourself to the new room\n\n Examples:\n dig kitchen = north;n, south;s\n dig house:myrooms.MyHouseTypeclass\n dig sheer cliff;cliff;sheer = climb up, climb down\n\n This command is a convenient way to build rooms quickly; it creates the\n new room and you can optionally set up exits back and forth between your\n current room and the new one. You can add as many aliases as you\n like to the name of the room and the exits in question; an example\n would be 'north;no;n'.\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('teleport',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdTunnel</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdTunnel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel"title="Permalink to this definition">¶</a></dt>
<dt>Switches:</dt><dd><p>oneway - do not create an exit back to the current location
tel - teleport to the newly created room</p>
</dd>
</dl>
<pclass="rubric">Example</p>
<p>tunnel n
tunnel n = house;mike’s place;green building</p>
<dlclass="simple">
<dt>This is a simple way to build using pre-defined directions:</dt><dd><p><ahref="#id13"><spanclass="problematic"id="id14">|</span></a>wn,ne,e,se,s,sw,w,nw|n (north, northeast etc)
<ahref="#id15"><spanclass="problematic"id="id16">|</span></a>wu,d|n (up and down)
<ahref="#id17"><spanclass="problematic"id="id18">|</span></a>wi,o|n (in and out)</p>
</dd>
</dl>
<p>The full names (north, in, southwest, etc) will always be put as
main name for the exit, using the abbreviation as an alias (so an
exit will always be able to be used with both “north” as well as
“n” for example). Opposite directions will automatically be
created back from the new room unless the /oneway switch is given.
For more flexibility and power in creating rooms, use dig.</p>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('tunnel', 'tun')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'tun', 'tunnel'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['tun']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdTunnel.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'tunnel'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd: perm(tunnel) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd: perm(tunnel) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'tun', 'category': 'building', 'key': 'tunnel', 'tags': '', 'text': '\n create new rooms in cardinal directions only\n\n Usage:\n tunnel[/switch] <direction>[:typeclass] [= <roomname>[;alias;alias;...][:typeclass]]\n\n Switches:\n oneway - do not create an exit back to the current location\n tel - teleport to the newly created room\n\n Example:\n tunnel n\n tunnel n = house;mike\'s place;green building\n\n This is a simple way to build using pre-defined directions:\n |wn,ne,e,se,s,sw,w,nw|n (north, northeast etc)\n |wu,d|n (up and down)\n |wi,o|n (in and out)\n The full names (north, in, southwest, etc) will always be put as\n main name for the exit, using the abbreviation as an alias (so an\n exit will always be able to be used with both "north" as well as\n "n" for example). Opposite directions will automatically be\n created back from the new room unless the /oneway switch is given.\n For more flexibility and power in creating rooms, use dig.\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('oneway', 'tel')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdLink</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdLink"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdLink"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('link',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLink._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'link'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLink._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLink.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdLink.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdLink.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLink.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'link'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLink.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(link) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLink.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(link) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLink.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'link', 'tags': '', 'text': '\n link existing rooms together with exits\n\n Usage:\n link[/switches] <object> = <target>\n link[/switches] <object> =\n link[/switches] <object>\n\n Switch:\n twoway - connect two exits. For this to work, BOTH <object>\n and <target> must be exit objects.\n\n If <object> is an exit, set its destination to <target>. Two-way operation\n instead sets the destination to the *locations* of the respective given\n arguments.\n The second form (a lone =) sets the destination to None (same as\n the unlink command) and the third form (without =) just shows the\n currently set destination.\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLink.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdUnLink</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdUnLink"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('unlink',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'unlink'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdUnLink.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink.func"title="Permalink to this definition">¶</a></dt>
<dd><p>All we need to do here is to set the right command
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_key</code><emclass="property"> = 'Building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink.help_key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'unlink'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(unlink) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(unlink) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'unlink', 'tags': '', 'text': '\n remove exit-connections between rooms\n\n Usage:\n unlink <Object>\n\n Unlinks an object, for example an exit, disconnecting\n it from whatever it was connected to.\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdUnLink.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdSetHome</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetHome"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetHome"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('sethome',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetHome._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'sethome'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetHome._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetHome.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetHome.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetHome.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetHome.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'sethome'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetHome.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(sethome) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetHome.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(sethome) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetHome.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'sethome', 'tags': '', 'text': '\n set an object\'s home location\n\n Usage:\n sethome <obj> [= <home_location>]\n sethom <obj>\n\n The "home" location is a "safety" location for objects; they\n will be moved there if their current location ceases to exist. All\n objects should always have a home location for this reason.\n It is also a convenient target of the "home" command.\n\n If no location is given, just view the object\'s home location.\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetHome.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdListCmdSets</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdListCmdSets"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('cmdsets', 'listcmsets')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'cmdsets', 'listcmsets'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['listcmsets']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdListCmdSets.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'cmdsets'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(listcmdsets) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(listcmdsets) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'listcmsets', 'category': 'building', 'key': 'cmdsets', 'tags': '', 'text': '\n list command sets defined on an object\n\n Usage:\n cmdsets <obj>\n\n This displays all cmdsets assigned\n to a user. Defaults to yourself.\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdName</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdName"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdName"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('rename', 'name')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdName._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'name', 'rename'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdName._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['rename']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdName.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdName.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdName.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdName.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'name'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdName.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(rename) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdName.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(rename) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdName.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'rename', 'category': 'building', 'key': 'name', 'tags': '', 'text': '\n change the name and/or aliases of an object\n\n Usage:\n name <obj> = <newname>;alias1;alias2\n\n Rename an object to something new. Use *obj to\n rename an account.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdName.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdOpen</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdOpen"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('open',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'open'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">create_exit</code><spanclass="sig-paren">(</span><emclass="sig-param">exit_name</em>, <emclass="sig-param">location</em>, <emclass="sig-param">destination</em>, <emclass="sig-param">exit_aliases=None</em>, <emclass="sig-param">typeclass=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdOpen.create_exit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen.create_exit"title="Permalink to this definition">¶</a></dt>
<dd><p>Helper function to avoid code duplication.
At this point we know destination is a valid location</p>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdOpen.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen.func"title="Permalink to this definition">¶</a></dt>
<dd><p>This is where the processing starts.
Uses the ObjManipCommand.parser() for pre-processing
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'open'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(open) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(open) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'open', 'tags': '', 'text': '\n open a new exit from the current room\n\n Usage:\n open <new exit>[;alias;alias..][:typeclass] [,<return exit>[;alias;..][:typeclass]]] = <destination>\n\n Handles the creation of exits. If a destination is given, the exit\n will point there. The <return exit> argument sets up an exit at the\n destination leading back to the current room. Destination name\n can be given both as a #dbref and a name, if that name is globally\n unique.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdSetAttribute</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute"title="Permalink to this definition">¶</a></dt>
set <ahref="#id21"><spanclass="problematic"id="id22">*</span></a><account>/<attr> = <value></p>
</dd>
<dt>Switch:</dt><dd><p>edit: Open the line editor (string values only)
script: If we’re trying to set an attribute on a script
channel: If we’re trying to set an attribute on a channel
account: If we’re trying to set an attribute on an account
room: Setting an attribute on a room (global search)
exit: Setting an attribute on an exit (global search)
char: Setting an attribute on a character (global search)
character: Alias for char, as above.</p>
</dd>
</dl>
<p>Sets attributes on objects. The second example form above clears a
previously set attribute while the third form inspects the current value of
the attribute (if any). The last one (with the star) is a shortcut for
operating on a player Account rather than an Object.</p>
<p>The most common data to save with this command are strings and
numbers. You can however also set Python primitives such as lists,
dictionaries and tuples on objects (this might be important for
the functionality of certain custom objects). This is indicated
by you starting your value with one of <ahref="#id23"><spanclass="problematic"id="id24">|</span></a>c’<ahref="#id25"><spanclass="problematic"id="id26">|</span></a>n, <ahref="#id27"><spanclass="problematic"id="id28">|</span></a>c”<ahref="#id29"><spanclass="problematic"id="id30">|</span></a>n, <ahref="#id31"><spanclass="problematic"id="id32">|</span></a>c(<ahref="#id33"><spanclass="problematic"id="id34">|</span></a>n, <ahref="#id35"><spanclass="problematic"id="id36">|</span></a>c[<ahref="#id37"><spanclass="problematic"id="id38">|</span></a>n
or <ahref="#id39"><spanclass="problematic"id="id40">|</span></a>c{ <ahref="#id41"><spanclass="problematic"id="id42">|</span></a>n.</p>
<p>Once you have stored a Python primitive as noted above, you can include
<ahref="#id43"><spanclass="problematic"id="id44">|</span></a>c[<key>]|n in <attr> to reference nested values in e.g. a list or dict.</p>
<p>Remember that if you use Python primitives like this, you must
write proper Python syntax too - notably you must include quotes
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('set',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'set'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">check_attr</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">attr_name</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute.check_attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.check_attr"title="Permalink to this definition">¶</a></dt>
<dd><p>This may be overridden by subclasses in case restrictions need to be
placed on what attributes can be set by who beyond the normal lock.</p>
<p>This functions is expected to display its own error message. It is
run once for every attribute that is checked, blocking only those
attributes which are not permitted and letting the others through.</p>
<codeclass="sig-name descname">check_obj</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute.check_obj"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.check_obj"title="Permalink to this definition">¶</a></dt>
<dd><p>This may be overridden by subclasses in case restrictions need to be
placed on whether certain objects can have attributes set by certain
accounts.</p>
<p>This function is expected to display its own error message.</p>
<codeclass="sig-name descname">do_nested_lookup</code><spanclass="sig-paren">(</span><emclass="sig-param">value</em>, <emclass="sig-param">*keys</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute.do_nested_lookup"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.do_nested_lookup"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">edit_handler</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">attr</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute.edit_handler"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.edit_handler"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Implement the set attribute - a limited form of py.</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'set'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(set) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(set) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">nested_re</code><emclass="property"> = re.compile('\\[.*?\\]')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.nested_re"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">not_found</code><emclass="property"> = <object object></em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.not_found"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rm_attr</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">attr</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute.rm_attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.rm_attr"title="Permalink to this definition">¶</a></dt>
<dd><p>Remove an attribute from the object, or a nested data structure, and report back.</p>
<codeclass="sig-name descname">search_for_obj</code><spanclass="sig-paren">(</span><emclass="sig-param">objname</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute.search_for_obj"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.search_for_obj"title="Permalink to this definition">¶</a></dt>
<dd><p>Searches for an object matching objname. The object may be of different typeclasses.
:param objname: Name of the object we’re looking for</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p>A typeclassed object, or None if nothing is found.</p>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'set', 'tags': '', 'text': '\n set attribute on an object or account\n\n Usage:\n set <obj>/<attr> = <value>\n set <obj>/<attr> =\n set <obj>/<attr>\n set *<account>/<attr> = <value>\n\n Switch:\n edit: Open the line editor (string values only)\n script: If we\'re trying to set an attribute on a script\n channel: If we\'re trying to set an attribute on a channel\n account: If we\'re trying to set an attribute on an account\n room: Setting an attribute on a room (global search)\n exit: Setting an attribute on an exit (global search)\n char: Setting an attribute on a character (global search)\n character: Alias for char, as above.\n\n Sets attributes on objects. The second example form above clears a\n previously set attribute while the third form inspects the current value of\n the attribute (if any). The last one (with the star) is a shortcut for\n operating on a player Account rather than an Object.\n\n The most common data to save with this command are strings and\n numbers. You can however also set Python primitives such as lists,\n dictionaries and tuples on objects (this might be important for\n the functionality of certain custom objects). This is indicated\n by you starting your value with one of |c\'|n, |c"|n, |c(|n, |c[|n\n or |c{ |n.\n\n Once you have stored a Python primitive as noted above, you can include\n |c[<key>]|n in <attr> to reference nested values in e.g. a list or dict.\n\n Remember that if you use Python primitives like this, you must\n write proper Python syntax too - notably you must include quotes\n around your strings or you will get an error.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">set_attr</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">attr</em>, <emclass="sig-param">value</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute.set_attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.set_attr"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">split_nested_attr</code><spanclass="sig-paren">(</span><emclass="sig-param">attr</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute.split_nested_attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.split_nested_attr"title="Permalink to this definition">¶</a></dt>
<dd><p>Yields tuples of (possible attr name, nested keys on that attr).
For performance, this is biased to the deepest match, but allows compatability
with older attrs that might have been named with <cite>[]</cite>’s.</p>
<codeclass="sig-name descname">view_attr</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">attr</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSetAttribute.view_attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.view_attr"title="Permalink to this definition">¶</a></dt>
<dd><p>Look up the value of an attribute and return a string displaying it.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdTypeclass</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdTypeclass"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdTypeclass"title="Permalink to this definition">¶</a></dt>
swap - this is a shorthand for using /force/reset flags.
update - this is a shorthand for using the /force/reload flag.</p>
</dd>
<dt>Switch:</dt><dd><dlclass="simple">
<dt>show, examine - display the current typeclass of object (default) or, if</dt><dd><p>given a typeclass path, show the docstring of that typeclass.</p>
</dd>
<dt>update - <em>only</em> re-run at_object_creation on this object</dt><dd><p>meaning locks or other properties set later may remain.</p>
</dd>
<dt>reset - clean out <em>all</em> the attributes and properties on the</dt><dd><p>object - basically making this a new clean object.</p>
</dd>
<dt>force - change to the typeclass also if the object</dt><dd><p>already has a typeclass of the same name.</p>
</dd>
<dt>list - show available typeclasses. Only typeclasses in modules actually</dt><dd><p>imported or used from somewhere in the code will show up here
(those typeclasses are still available if you know the path)</p>
</dd>
<dt>prototype - clean and overwrite the object with the specified</dt><dd><p>prototype key - effectively making a whole new object.</p>
</dd>
</dl>
</dd>
</dl>
<pclass="rubric">Example</p>
<p>type button = examples.red_button.RedButton
type/prototype button=a red button</p>
<p>If the typeclass_path is not given, the current object’s typeclass is
assumed.</p>
<p>View or set an object’s typeclass. If setting, the creation hooks of the
new typeclass will be run on the object. If you have clashing properties on
the old class, use /reset. By default you are protected from changing to a
typeclass of the same name as the one you already have - use /force to
override this protection.</p>
<p>The given typeclass must be identified by its location using python
dot-notation pointing to the correct module and class. If no typeclass is
given (or a wrong typeclass is given). Errors in the path or new typeclass
will lead to the old typeclass being kept. The location of the typeclass
module is searched from the default typeclass directory, as defined in the
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['swap', 'type', 'parent', 'update']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTypeclass.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdTypeclass.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdTypeclass.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTypeclass.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'typeclass'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTypeclass.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(typeclass) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTypeclass.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(typeclass) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTypeclass.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'swap type parent update', 'category': 'building', 'key': 'typeclass', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = 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 "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTypeclass.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdWipe</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdWipe"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdWipe"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('wipe',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdWipe._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'wipe'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdWipe._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdWipe.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdWipe.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdWipe.func"title="Permalink to this definition">¶</a></dt>
<dd><p>inp is the dict produced in ObjManipCommand.parse()</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdWipe.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'wipe'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdWipe.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(wipe) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdWipe.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(wipe) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdWipe.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'wipe', 'tags': '', 'text': "\n clear all attributes from an object\n\n Usage:\n wipe <object>[/<attr>[/<attr>...]]\n\n Example:\n wipe box\n wipe box/colour\n\n Wipes all of an object's attributes, or optionally only those\n matching the given attribute-wildcard search string.\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdWipe.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdLock</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdLock"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdLock"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('lock', 'locks')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLock._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'lock', 'locks'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLock._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['locks']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLock.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdLock.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdLock.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLock.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'lock'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLock.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd: perm(locks) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLock.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd: perm(locks) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLock.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'locks', 'category': 'building', 'key': 'lock', 'tags': '', 'text': "\n assign a lock definition to an object\n\n Usage:\n lock <object or *account>[ = <lockstring>]\n or\n lock[/switch] <object or *account>/<access_type>\n\n Switch:\n del - delete given access type\n view - view lock associated with given access type (default)\n\n If no lockstring is given, shows all locks on\n object.\n\n Lockstring is of the form\n access_type:[NOT] func1(args)[ AND|OR][ NOT] func2(args) ...]\n Where func1, func2 ... valid lockfuncs with or without arguments.\n Separator expressions need not be capitalized.\n\n For example:\n 'get: id(25) or perm(Admin)'\n The 'get' lock access_type is checked e.g. by the 'get' command.\n An object locked with this example lock will only be possible to pick up\n by Admins or by an object with id=25.\n\n You can add several access_types after one another by separating\n them by ';', i.e:\n 'get:id(25); delete:perm(Builder)'\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdLock.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdExamine</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('examine', 'exam', 'ex')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'ex', 'exam', 'examine'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_mode</code><emclass="property"> = False</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.account_mode"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['exam', 'ex']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('(/\\w+?(\\s|$))|\\s|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_attributes</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">attrname=None</em>, <emclass="sig-param">crop=True</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_attributes"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_attributes"title="Permalink to this definition">¶</a></dt>
<dd><p>Helper function that returns info about attributes and/or
<codeclass="sig-name descname">format_output</code><spanclass="sig-paren">(</span><emclass="sig-param">obj</em>, <emclass="sig-param">avail_cmdset</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_output"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_output"title="Permalink to this definition">¶</a></dt>
<dd><p>Helper function that creates a nice report about an object.</p>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'examine'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list_attribute</code><spanclass="sig-paren">(</span><emclass="sig-param">crop</em>, <emclass="sig-param">attr</em>, <emclass="sig-param">category</em>, <emclass="sig-param">value</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.list_attribute"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.list_attribute"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(examine) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(examine) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'exam ex', 'category': 'building', 'key': 'examine', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [<object>[/attrname]]\n examine [*<account>[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdFind</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdFind"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdFind"title="Permalink to this definition">¶</a></dt>
<dt>Usage:</dt><dd><p>find[/switches] <name or dbref or <ahref="#id53"><spanclass="problematic"id="id54">*</span></a>account> [= dbrefmin[-dbrefmax]]
locate - this is a shorthand for using the /loc switch.</p>
</dd>
<dt>Switches:</dt><dd><p>room - only look for rooms (location=None)
exit - only look for exits (destination!=None)
char - only look for characters (BASE_CHARACTER_TYPECLASS)
exact - only exact matches are returned.
loc - display object location if exists and match has one result
startswith - search for names starting with the string, rather than containing</p>
</dd>
</dl>
<p>Searches the database for an object of a particular name or exact #dbref.
Use <ahref="#id55"><spanclass="problematic"id="id56">*</span></a>accountname to search for an account. The switches allows for
limiting object matches to certain game entities. Dbrefmin and dbrefmax
limits matches to within the given dbrefs range, or above/below if only
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('locate', 'search', 'find')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdFind._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'find', 'locate', 'search'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdFind._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['locate', 'search']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdFind.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdFind.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdFind.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdFind.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'find'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdFind.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(find) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdFind.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(find) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdFind.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'locate search', 'category': 'building', 'key': 'find', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdFind.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdTeleport</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdTeleport"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('teleport', 'tel')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'tel', 'teleport'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['teleport']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdTeleport.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'tel'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(teleport) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(teleport) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rhs_split</code><emclass="property"> = ('=', ' to ')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.rhs_split"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'teleport', 'category': 'building', 'key': 'tel', 'tags': '', 'text': "\n teleport object to another location\n\n Usage:\n tel/switch [<object> to||=] <target location>\n\n Examples:\n tel Limbo\n tel/quiet box = Limbo\n tel/tonone box\n\n Switches:\n quiet - don't echo leave/arrive messages to the source/target\n locations for the move.\n intoexit - if target is an exit, teleport INTO\n the exit object instead of to its destination\n tonone - if set, teleport the object to a None-location. If this\n switch is set, <target location> is ignored.\n Note that the only way to retrieve\n an object from a None location is by direct #dbref\n reference. A puppeted object cannot be moved to None.\n loc - teleport object to the target's location instead of its contents\n\n Teleports an object somewhere. If no object is given, you yourself are\n teleported to the target location.\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('quiet', 'intoexit', 'tonone', 'loc')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdScript</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdScript"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdScript"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('script', 'addscript')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScript._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'addscript', 'script'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScript._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['addscript']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScript.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdScript.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdScript.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScript.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'script'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScript.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(script) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScript.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(script) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScript.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'addscript', 'category': 'building', 'key': 'script', 'tags': '', 'text': '\n attach a script to an object\n\n Usage:\n script[/switch] <obj> [= script_path or <scriptkey>]\n\n Switches:\n start - start all non-running scripts on object, or a given script only\n stop - stop all scripts on objects, or a given script only\n\n If no script path/key is given, lists all scripts active on the given\n object.\n Script path can be given from the base location for scripts as given in\n settings. If adding a new script, it will be started automatically\n (no /start switch is needed). Using the /start or /stop switches on an\n object without specifying a script key/path will start/stop ALL scripts on\n the object.\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScript.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('start', 'stop')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScript.switch_options"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.building.CmdTag">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdTag</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdTag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdTag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('tags', 'tag')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTag._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'tag', 'tags'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTag._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['tags']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTag.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('(/\\w+?(\\s|$))|\\s|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTag.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdTag.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdTag.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTag.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'tag'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTag.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(tag) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTag.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(tag) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTag.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">options</code><emclass="property"> = ('search', 'del')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTag.options"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'tags', 'category': 'building', 'key': 'tag', 'tags': '', 'text': '\n handles the tags of an object\n\n Usage:\n tag[/del] <obj> [= <tag>[:<category>]]\n tag/search <tag>[:<category]\n\n Switches:\n search - return all objects with a given Tag\n del - remove the given tag. If no tag is specified,\n clear all tags on object.\n\n Manipulates and lists tags on objects. Tags allow for quick\n grouping of and searching for objects. If only <obj> is given,\n list all tags on the object. If /search is used, list objects\n with the given tag.\n The category can be used for grouping tags themselves, but it\n should be used with restrain - tags on their own are usually\n enough to for most grouping schemes.\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTag.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.building.</code><codeclass="sig-name descname">CmdSpawn</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSpawn"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn"title="Permalink to this definition">¶</a></dt>
<dt><ahref="#id57"><spanclass="problematic"id="id58">|</span></a>wprototype_parent <ahref="#id59"><spanclass="problematic"id="id60">|</span></a>n - name of parent prototype to use. Required if typeclass is</dt><dd><p>not set. Can be a path or a list for multiple inheritance (inherits
left to right). If set one of the parents must have a typeclass.</p>
</dd>
</dl>
<p><ahref="#id61"><spanclass="problematic"id="id62">|</span></a>wtypeclass <ahref="#id63"><spanclass="problematic"id="id64">|</span></a>n - string. Required if prototype_parent is not set.
<ahref="#id65"><spanclass="problematic"id="id66">|</span></a>wkey <ahref="#id67"><spanclass="problematic"id="id68">|</span></a>n - string, the main object identifier
<ahref="#id69"><spanclass="problematic"id="id70">|</span></a>wlocation <ahref="#id71"><spanclass="problematic"id="id72">|</span></a>n - this should be a valid object or #dbref
<ahref="#id73"><spanclass="problematic"id="id74">|</span></a>whome <ahref="#id75"><spanclass="problematic"id="id76">|</span></a>n - valid object or #dbref
<ahref="#id77"><spanclass="problematic"id="id78">|</span></a>wdestination|n - only valid for exits (object or dbref)
<ahref="#id79"><spanclass="problematic"id="id80">|</span></a>wpermissions|n - string or list of permission strings
<ahref="#id81"><spanclass="problematic"id="id82">|</span></a>wlocks <ahref="#id83"><spanclass="problematic"id="id84">|</span></a>n - a lock-string
<ahref="#id85"><spanclass="problematic"id="id86">|</span></a>waliases <ahref="#id87"><spanclass="problematic"id="id88">|</span></a>n - string or list of strings.
<ahref="#id89"><spanclass="problematic"id="id90">|</span></a>wndb_|n<name> - value of a nattribute (<ahref="#id113"><spanclass="problematic"id="id114">ndb_</span></a> is stripped)</p>
<dlclass="simple">
<dt><ahref="#id91"><spanclass="problematic"id="id92">|</span></a>wprototype_key|n - name of this prototype. Unique. Used to store/retrieve from db</dt><dd><p>and update existing prototyped objects if desired.</p>
</dd>
</dl>
<p><ahref="#id93"><spanclass="problematic"id="id94">|</span></a>wprototype_desc|n - desc of this prototype. Used in listings
<ahref="#id95"><spanclass="problematic"id="id96">|</span></a>wprototype_locks|n - locks of this prototype. Limits who may use prototype
<ahref="#id97"><spanclass="problematic"id="id98">|</span></a>wprototype_tags|n - tags of this prototype. Used to find prototype</p>
<p>any other keywords are interpreted as Attributes and their values.</p>
</dd>
</dl>
<p>The available prototypes are defined globally in modules set in
settings.PROTOTYPE_MODULES. If spawn is used without arguments it
<codeclass="sig-name descname">_get_prototype_detail</code><spanclass="sig-paren">(</span><emclass="sig-param">query=None</em>, <emclass="sig-param">prototypes=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSpawn._get_prototype_detail"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn._get_prototype_detail"title="Permalink to this definition">¶</a></dt>
<dd><p>Display the detailed specs of one or more prototypes.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>query</strong> (<em>str</em><em>, </em><em>optional</em>) – If this is given and <cite>prototypes</cite> is not, search for
the prototype(s) by this query. This may be a partial query which
may lead to multiple matches, all being displayed.</p></li>
<li><p><strong>prototypes</strong> (<em>list</em><em>, </em><em>optional</em>) – If given, ignore <cite>query</cite> and only show these
prototype-details.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><dlclass="simple">
<dt>A formatted string of one or more prototype details.</dt><dd><p>If None, the caller was already informed of the error.</p>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('spawn', 'olc')</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_list_prototypes</code><spanclass="sig-paren">(</span><emclass="sig-param">key=None</em>, <emclass="sig-param">tags=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSpawn._list_prototypes"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn._list_prototypes"title="Permalink to this definition">¶</a></dt>
<dd><p>Display prototypes as a list, optionally limited by key/tags.</p>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'olc', 'spawn'}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_parse_key_desc_tags</code><spanclass="sig-paren">(</span><emclass="sig-param">argstring</em>, <emclass="sig-param">desc=True</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSpawn._parse_key_desc_tags"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn._parse_key_desc_tags"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_parse_prototype</code><spanclass="sig-paren">(</span><emclass="sig-param">inp</em>, <emclass="sig-param">expect=<class 'dict'></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSpawn._parse_prototype"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn._parse_prototype"title="Permalink to this definition">¶</a></dt>
<dd><p>Parse a prototype dict or key from the input and convert it safely
into a dict if appropriate.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>inp</strong> (<em>str</em>) – The input from user.</p></li>
<codeclass="sig-name descname">_search_prototype</code><spanclass="sig-paren">(</span><emclass="sig-param">prototype_key</em>, <emclass="sig-param">quiet=False</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSpawn._search_prototype"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn._search_prototype"title="Permalink to this definition">¶</a></dt>
<dd><p>Search for prototype and handle no/multi-match and access.</p>
<p>Returns a single found prototype or None - in the
case, the caller has already been informed of the
search error we need not do any further action.</p>
<codeclass="sig-name descname">_update_existing_objects</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn._update_existing_objects"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['olc']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdSpawn.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'spawn'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(spawn) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(spawn) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'olc', 'category': 'building', 'key': 'spawn', 'tags': '', 'text': '\n spawn objects from prototype\n\n Usage:\n spawn[/noloc] <prototype_key>\n spawn[/noloc] <prototype_dict>\n\n spawn/search [prototype_keykey][;tag[,tag]]\n spawn/list [tag, tag, ...]\n spawn/show [<prototype_key>]\n spawn/update <prototype_key>\n\n spawn/save <prototype_dict>\n spawn/edit [<prototype_key>]\n olc - equivalent to spawn/edit\n\n Switches:\n noloc - allow location to be None if not specified explicitly. Otherwise,\n location will default to caller\'s current location.\n search - search prototype by name or tags.\n list - list available prototypes, optionally limit by tags.\n show, examine - inspect prototype by key. If not given, acts like list.\n raw - show the raw dict of the prototype as a one-line string for manual editing.\n save - save a prototype to the database. It will be listable by /list.\n delete - remove a prototype from database, if allowed to.\n update - find existing objects with the same prototype_key and update\n them with latest version of given prototype. If given with /save,\n will auto-update all objects with the old version of the prototype\n without asking first.\n edit, menu, olc - create/manipulate prototype in a menu interface.\n\n Example:\n spawn GOBLIN\n spawn {"key":"goblin", "typeclass":"monster.Monster", "location":"#2"}\n spawn/save {"key": "grunt", prototype: "goblin"};;mobs;edit:all()\n \x0c\n Dictionary keys:\n |wprototype_parent |n - name of parent prototype to use. Required if typeclass is\n not set. Can be a path or a list for multiple inheritance (inherits\n left to right). If set one of the parents must have a typeclass.\n |wtypeclass |n - string. Required if prototype_parent is not set.\n |wkey |n - string, the main object identifier\n |wlocation |n - this should be a valid object or #dbref\n |whome |n - valid object or #dbref\n |wdestination|n - only valid for exits (object or dbref)\n |wpermissions|n - string or list of permission strings\n |wlocks |n - a lock-string\n |waliases |n - string or list of strings.\n |wndb_|n<name> - value of a nattribute (ndb_ is stripped)\n\n |wprototype_key|n - name of this prototype. Unique. Used to store/retrieve from db\n and update existing prototyped objects if desired.\n |wprototype_desc|n - desc of this prototype. Used in listings\n |wprototype_locks|n - locks of this prototype. Limits who may use prototype\n |wprototype_tags|n - tags of this prototype. Used to find prototype\n\n any other keywords are interpreted as Attributes and their values.\n\n The available prototypes are defined globally in modules set in\n settings.PROTOTYPE_MODULES. If spawn is used without arguments it\n displays a list of available prototypes.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSpawn.search_index_entry"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-cmdset-account-module"></span><h2>evennia.commands.default.cmdset_account module<aclass="headerlink"href="#module-evennia.commands.default.cmdset_account"title="Permalink to this headline">¶</a></h2>
<p>This is the cmdset for Account (OOC) commands. These are
stored on the Account object and should thus be able to handle getting
an Account object as caller rather than a Character.</p>
<p>Note - in order for session-rerouting (in MULTISESSION_MODE=2) to
function, all commands in this cmdset should use the self.msg()
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.cmdset_account.</code><codeclass="sig-name descname">AccountCmdSet</code><spanclass="sig-paren">(</span><emclass="sig-param">cmdsetobj=None</em>, <emclass="sig-param">key=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/cmdset_account.html#AccountCmdSet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.cmdset_account.AccountCmdSet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/cmdset_account.html#AccountCmdSet.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.cmdset_account.AccountCmdSet.at_cmdset_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'DefaultAccount'</em><aclass="headerlink"href="#evennia.commands.default.cmdset_account.AccountCmdSet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.commands.default.cmdset_account.AccountCmdSet'</em><aclass="headerlink"href="#evennia.commands.default.cmdset_account.AccountCmdSet.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">priority</code><emclass="property"> = -10</em><aclass="headerlink"href="#evennia.commands.default.cmdset_account.AccountCmdSet.priority"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-cmdset-character-module"></span><h2>evennia.commands.default.cmdset_character module<aclass="headerlink"href="#module-evennia.commands.default.cmdset_character"title="Permalink to this headline">¶</a></h2>
<p>This module ties together all the commands default Character objects have
available (i.e. IC commands). Note that some commands, such as
communication-commands are instead put on the account level, in the
Account cmdset. Account commands remain available also to Characters.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.cmdset_character.</code><codeclass="sig-name descname">CharacterCmdSet</code><spanclass="sig-paren">(</span><emclass="sig-param">cmdsetobj=None</em>, <emclass="sig-param">key=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/cmdset_character.html#CharacterCmdSet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.cmdset_character.CharacterCmdSet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/cmdset_character.html#CharacterCmdSet.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.cmdset_character.CharacterCmdSet.at_cmdset_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'DefaultCharacter'</em><aclass="headerlink"href="#evennia.commands.default.cmdset_character.CharacterCmdSet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.commands.default.cmdset_character.CharacterCmdSet'</em><aclass="headerlink"href="#evennia.commands.default.cmdset_character.CharacterCmdSet.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">priority</code><emclass="property"> = 0</em><aclass="headerlink"href="#evennia.commands.default.cmdset_character.CharacterCmdSet.priority"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-cmdset-session-module"></span><h2>evennia.commands.default.cmdset_session module<aclass="headerlink"href="#module-evennia.commands.default.cmdset_session"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.cmdset_session.</code><codeclass="sig-name descname">SessionCmdSet</code><spanclass="sig-paren">(</span><emclass="sig-param">cmdsetobj=None</em>, <emclass="sig-param">key=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/cmdset_session.html#SessionCmdSet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.cmdset_session.SessionCmdSet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/cmdset_session.html#SessionCmdSet.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.cmdset_session.SessionCmdSet.at_cmdset_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'DefaultSession'</em><aclass="headerlink"href="#evennia.commands.default.cmdset_session.SessionCmdSet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.commands.default.cmdset_session.SessionCmdSet'</em><aclass="headerlink"href="#evennia.commands.default.cmdset_session.SessionCmdSet.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">priority</code><emclass="property"> = -20</em><aclass="headerlink"href="#evennia.commands.default.cmdset_session.SessionCmdSet.priority"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-cmdset-unloggedin-module"></span><h2>evennia.commands.default.cmdset_unloggedin module<aclass="headerlink"href="#module-evennia.commands.default.cmdset_unloggedin"title="Permalink to this headline">¶</a></h2>
<p>This module describes the unlogged state of the default game.
The setting STATE_UNLOGGED should be set to the python path
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.cmdset_unloggedin.</code><codeclass="sig-name descname">UnloggedinCmdSet</code><spanclass="sig-paren">(</span><emclass="sig-param">cmdsetobj=None</em>, <emclass="sig-param">key=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/cmdset_unloggedin.html#UnloggedinCmdSet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/cmdset_unloggedin.html#UnloggedinCmdSet.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet.at_cmdset_creation"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'DefaultUnloggedin'</em><aclass="headerlink"href="#evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet'</em><aclass="headerlink"href="#evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">priority</code><emclass="property"> = 0</em><aclass="headerlink"href="#evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet.priority"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-comms-module"></span><h2>evennia.commands.default.comms module<aclass="headerlink"href="#module-evennia.commands.default.comms"title="Permalink to this headline">¶</a></h2>
<p>Comsystem command module.</p>
<p>Comm commands are OOC commands and intended to be made available to
the Account at all times (they go into the AccountCmdSet). So we
make sure to homogenize self.caller to always be the account object
for easy handling.</p>
<dlclass="class">
<dtid="evennia.commands.default.comms.CmdAddCom">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdAddCom</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdAddCom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('addcom', 'chanalias', 'aliaschan')</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'addcom', 'aliaschan', 'chanalias'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['chanalias', 'aliaschan']</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdAddCom.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'addcom'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'chanalias aliaschan', 'category': 'comms', 'key': 'addcom', 'tags': '', 'text': '\n add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] <channel>\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAddCom.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdDelCom</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdDelCom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('delchanalias', 'delcom', 'delaliaschan')</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'delaliaschan', 'delchanalias', 'delcom'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['delchanalias', 'delaliaschan']</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdDelCom.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'delcom'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:not perm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:not perm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'delchanalias delaliaschan', 'category': 'comms', 'key': 'delcom', 'tags': '', 'text': "\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom <alias or channel>\n delcom/all <channel>\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n "}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdDelCom.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdAllCom</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdAllCom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('allcom',)</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'allcom'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdAllCom.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'allcom'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd: not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd: not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'comms', 'key': 'allcom', 'tags': '', 'text': "\n perform admin operations on all channels\n\n Usage:\n allcom [on | off | who | destroy]\n\n Allows the user to universally turn off or on all channels they are on, as\n well as perform a 'who' for all channels they are on. Destroy deletes all\n channels that you control.\n\n Without argument, works like comlist.\n "}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdAllCom.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdChannels</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdChannels"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannels"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannels.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdChannels.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannels.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannels.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'channels'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannels.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd: not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannels.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd: not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannels.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'clist comlist channellist chanlist all channels', 'category': 'comms', 'key': 'channels', 'tags': '', 'text': "\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 "}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannels.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdCdestroy</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdCdestroy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('cdestroy',)</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'cdestroy'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdCdestroy.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'cdestroy'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd: not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd: not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'comms', 'key': 'cdestroy', 'tags': '', 'text': '\n destroy a channel you created\n\n Usage:\n cdestroy <channel>\n\n Destroys a channel that you control.\n '}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdestroy.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.comms.CmdCBoot">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdCBoot</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdCBoot"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('cboot',)</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'cboot'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdCBoot.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'cboot'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd: not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd: not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'comms', 'key': 'cboot', 'tags': '', 'text': "\n kick an account from a channel you control\n\n Usage:\n cboot[/quiet] <channel> = <account> [:reason]\n\n Switch:\n quiet - don't notify the channel\n\n Kicks an account or object from a channel you control.\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('quiet',)</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCBoot.switch_options"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.comms.CmdCemit">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdCemit</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdCemit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('cmsg', 'cemit')</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'cemit', 'cmsg'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['cmsg']</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdCemit.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'cemit'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd: not pperm(channel_banned) and pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd: not pperm(channel_banned) and pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'cmsg', 'category': 'comms', 'key': 'cemit', 'tags': '', 'text': "\n send an admin message to a channel you control\n\n Usage:\n cemit[/switches] <channel> = <message>\n\n Switches:\n sendername - attach the sender's name before the message\n quiet - don't echo the message back to sender\n\n Allows the user to broadcast a message over a channel as long as\n they control it. It does not show the user's name unless they\n provide the /sendername switch.\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('sendername', 'quiet')</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCemit.switch_options"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.comms.CmdCWho">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdCWho</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdCWho"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('cwho',)</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'cwho'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdCWho.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'cwho'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd: not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd: not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'comms', 'key': 'cwho', 'tags': '', 'text': '\n show who is listening to a channel\n\n Usage:\n cwho <channel>\n\n List who is connected to a given channel you have access to.\n '}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCWho.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdChannelCreate</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdChannelCreate"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('ccreate', 'channelcreate')</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'ccreate', 'channelcreate'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['channelcreate']</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdChannelCreate.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'ccreate'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:not pperm(channel_banned) and pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:not pperm(channel_banned) and pperm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'channelcreate', 'category': 'comms', 'key': 'ccreate', 'tags': '', 'text': '\n create a new channel\n\n Usage:\n ccreate <new channel>[;alias;alias...] = description\n\n Creates a new channel owned by you.\n '}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdChannelCreate.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.comms.CmdClock">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdClock</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdClock"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('clock',)</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'clock'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdClock.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'clock'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'comms', 'key': 'clock', 'tags': '', 'text': '\n change channel locks of a channel you control\n\n Usage:\n clock <channel> [= <lockstring>]\n\n Changes the lock access restrictions of a channel. If no\n lockstring was given, view the current lock definitions.\n '}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdClock.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.comms.CmdCdesc">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdCdesc</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdCdesc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('cdesc',)</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'cdesc'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdCdesc.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'cdesc'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:not pperm(channel_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'comms', 'key': 'cdesc', 'tags': '', 'text': '\n describe a channel you control\n\n Usage:\n cdesc <channel> = <description>\n\n Changes the description of the channel as shown in\n channel lists.\n '}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdCdesc.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.comms.CmdPage">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdPage</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdPage"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('tell', 'page')</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'page', 'tell'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['tell']</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdPage.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Implement function using the Msg methods</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'page'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:not pperm(page_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:not pperm(page_banned)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'tell', 'category': 'comms', 'key': 'page', 'tags': '', 'text': "\n send a private message to another account\n\n Usage:\n page[/switches] [<account>,<account>,... = <message>]\n tell ''\n page <number>\n\n Switch:\n last - shows who you last messaged\n list - show your last <number> of tells/pages (default)\n\n Send a message to target user (if online). If no\n argument is given, you will get a list of your latest messages.\n "}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('last', 'list')</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdPage.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdIRC2Chan</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdIRC2Chan"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdIRC2Chan"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('irc2chan',)</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdIRC2Chan._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'irc2chan'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdIRC2Chan._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdIRC2Chan.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdIRC2Chan.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdIRC2Chan.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdIRC2Chan.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'irc2chan'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdIRC2Chan.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:serversetting(IRC_ENABLED) and pperm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdIRC2Chan.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:serversetting(IRC_ENABLED) and pperm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdIRC2Chan.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'comms', 'key': 'irc2chan', 'tags': '', 'text': '\n Link an evennia channel to an external IRC channel\n\n Usage:\n irc2chan[/switches] <evennia_channel> = <ircnetwork><port><#irchannel><botname>[:typeclass]\n irc2chan/delete botname|#dbid\n\n Switches:\n /delete - this will delete the bot and remove the irc connection\n to the channel. Requires the botname or #dbid as input.\n /remove - alias to /delete\n /disconnect - alias to /delete\n /list - show all irc<->evennia mappings\n /ssl - use an SSL-encrypted connection\n\n Example:\n irc2chan myircchan = irc.dalnet.net 6667 #mychannel evennia-bot\n irc2chan public = irc.freenode.net 6667 #evgaming #evbot:accounts.mybot.MyBot\n\n This creates an IRC bot that connects to a given IRC network and\n channel. If a custom typeclass path is given, this will be used\n instead of the default bot class.\n The bot will relay everything said in the evennia channel to the\n IRC channel and vice versa. The bot will automatically connect at\n server start, so this command need only be given once. The\n /disconnect switch will permanently delete the bot. To only\n temporarily deactivate it, use the |wservices|n command instead.\n Provide an optional bot class path to use a custom bot.\n '}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdIRC2Chan.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.comms.</code><codeclass="sig-name descname">CmdRSS2Chan</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdRSS2Chan"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('rss2chan',)</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'rss2chan'}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/comms.html#CmdRSS2Chan.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'comms'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'rss2chan'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:serversetting(RSS_ENABLED) and pperm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:serversetting(RSS_ENABLED) and pperm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'comms', 'key': 'rss2chan', 'tags': '', 'text': '\n link an evennia channel to an external RSS feed\n\n Usage:\n rss2chan[/switches] <evennia_channel> = <rss_url>\n\n Switches:\n /disconnect - this will stop the feed and remove the connection to the\n channel.\n /remove - "\n /list - show all rss->evennia mappings\n\n Example:\n rss2chan rsschan = http://code.google.com/feeds/p/evennia/updates/basic\n\n This creates an RSS reader that connects to a given RSS feed url. Updates\n will be echoed as a title and news link to the given channel. The rate of\n updating is set with the RSS_UPDATE_INTERVAL variable in settings (default\n is every 10 minutes).\n\n When disconnecting you need to supply both the channel and url again so as\n to identify the connection uniquely.\n '}</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('disconnect', 'remove', 'list')</em><aclass="headerlink"href="#evennia.commands.default.comms.CmdRSS2Chan.switch_options"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-general-module"></span><h2>evennia.commands.default.general module<aclass="headerlink"href="#module-evennia.commands.default.general"title="Permalink to this headline">¶</a></h2>
<p>General Character commands usually available to all characters</p>
<dlclass="class">
<dtid="evennia.commands.default.general.CmdHome">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdHome</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdHome"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdHome"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('home',)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdHome._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'home'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdHome._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.general.CmdHome.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdHome.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdHome.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdHome.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdHome.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'home'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdHome.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(home) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdHome.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(home) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdHome.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'home', 'tags': '', 'text': "\n move to your character's home location\n\n Usage:\n home\n\n Teleports you to your home location.\n "}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdHome.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.general.CmdLook">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdLook</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdLook"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdLook"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('look', 'ls', 'l')</em><aclass="headerlink"href="#evennia.commands.default.general.CmdLook._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'l', 'look', 'ls'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdLook._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['ls', 'l']</em><aclass="headerlink"href="#evennia.commands.default.general.CmdLook.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdLook.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdLook.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdLook.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdLook.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'look'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdLook.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdLook.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdLook.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdLook.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdNick</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdNick"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdNick"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('nick', 'nicks', 'nickname')</em><aclass="headerlink"href="#evennia.commands.default.general.CmdNick._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'nick', 'nickname', 'nicks'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdNick._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['nicks', 'nickname']</em><aclass="headerlink"href="#evennia.commands.default.general.CmdNick.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdNick.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdNick.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdNick.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'nick'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdNick.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdNick.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdNick.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdNick.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdNick.parse"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'nicks nickname', 'category': 'general', 'key': 'nick', 'tags': '', 'text': '\n define a personal alias/nick by defining a string to\n match and replace it with another on the fly\n\n Usage:\n nick[/switches] <string> [= [replacement_string]]\n nick[/switches] <template> = <replacement_template>\n nick/delete <string> or number\n nicks\n\n Switches:\n inputline - replace on the inputline (default)\n object - replace on object-lookup\n account - replace on account-lookup\n list - show all defined aliases (also "nicks" works)\n delete - remove nick by index in /list\n clearall - clear all nicks\n\n Examples:\n nick hi = say Hello, I\'m Sarah!\n nick/object tom = the tall man\n nick build $1 $2 = create/drop $1;$2\n nick tell $1 $2=page $1=$2\n nick tm?$1=page tallman=$1\n nick tm\\=$1=page tallman=$1\n\n A \'nick\' is a personal string replacement. Use $1, $2, ... to catch arguments.\n Put the last $-marker without an ending space to catch all remaining text. You\n can also use unix-glob matching for the left-hand side <string>:\n\n * - matches everything\n ? - matches 0 or 1 single characters\n [abcd] - matches these chars in any order\n [!abcd] - matches everything not among these chars\n \\= - escape literal \'=\' you want in your <string>\n\n Note that no objects are actually renamed or changed by this command - your nicks\n are only available to you. If you want to permanently add keywords to an object\n for everyone to use, you need build privileges and the alias command.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdNick.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdInventory</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdInventory"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdInventory"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('inventory', 'i', 'inv')</em><aclass="headerlink"href="#evennia.commands.default.general.CmdInventory._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'i', 'inv', 'inventory'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdInventory._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['i', 'inv']</em><aclass="headerlink"href="#evennia.commands.default.general.CmdInventory.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdInventory.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdInventory.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdInventory.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdInventory.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'inventory'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdInventory.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdInventory.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdInventory.locks"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdSetDesc</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdSetDesc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('setdesc',)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'setdesc'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdSetDesc.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'setdesc'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'setdesc', 'tags': '', 'text': '\n describe yourself\n\n Usage:\n setdesc <description>\n\n Add a description to yourself. This\n will be visible to people when they\n look at you.\n '}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSetDesc.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.general.CmdGet">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdGet</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdGet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdGet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('get', 'grab')</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGet._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'get', 'grab'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGet._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['grab']</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGet.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGet.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdGet.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdGet.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGet.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'get'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGet.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGet.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'grab', 'category': 'general', 'key': 'get', 'tags': '', 'text': '\n pick up something\n\n Usage:\n get <obj>\n\n Picks up an object from your location and puts it in\n your inventory.\n '}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGet.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.general.CmdDrop">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdDrop</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdDrop"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('drop',)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'drop'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdDrop.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'drop'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'drop', 'tags': '', 'text': '\n drop something\n\n Usage:\n drop <obj>\n\n Lets you drop an object from your inventory into the\n location you are currently in.\n '}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdDrop.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.general.CmdGive">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdGive</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdGive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdGive"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('give',)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGive._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'give'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGive._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGive.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGive.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdGive.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdGive.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGive.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'give'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGive.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGive.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGive.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">rhs_split</code><emclass="property"> = ('=', ' to ')</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGive.rhs_split"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'give', 'tags': '', 'text': '\n give away something to someone\n\n Usage:\n give <inventory obj><to||=><target>\n\n Gives an items from your inventory to another character,\n placing it in their inventory.\n '}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdGive.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.general.CmdSay">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdSay</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdSay"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdSay"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('"', 'say', "'")</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSay._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'"', "'", 'say'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSay._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['"', "'"]</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSay.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdSay.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdSay.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSay.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'say'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSay.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSay.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSay.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '" \'', 'category': 'general', 'key': 'say', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdSay.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdWhisper</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdWhisper"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdWhisper"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('whisper',)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdWhisper._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'whisper'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdWhisper._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.general.CmdWhisper.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdWhisper.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdWhisper.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdWhisper.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'whisper'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdWhisper.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdWhisper.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdWhisper.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'whisper', 'tags': '', 'text': '\n Speak privately as your character to another\n\n Usage:\n whisper <character> = <message>\n whisper <char1>, <char2> = <message>\n\n Talk privately to one or more characters in your current location, without\n others in the room being informed.\n '}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdWhisper.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.general.CmdPose">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdPose</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdPose"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdPose"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = (':', 'pose', 'emote')</em><aclass="headerlink"href="#evennia.commands.default.general.CmdPose._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {':', 'emote', 'pose'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdPose._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = [':', 'emote']</em><aclass="headerlink"href="#evennia.commands.default.general.CmdPose.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdPose.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdPose.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdPose.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'pose'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdPose.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdPose.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdPose.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdPose.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdPose.parse"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': ': emote', 'category': 'general', 'key': 'pose', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdPose.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.general.</code><codeclass="sig-name descname">CmdAccess</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdAccess"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('access', 'hierarchy', 'groups')</em><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'access', 'groups', 'hierarchy'}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['hierarchy', 'groups']</em><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/general.html#CmdAccess.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'access'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'hierarchy groups', 'category': 'general', 'key': 'access', 'tags': '', 'text': '\n show your current game access\n\n Usage:\n access\n\n This command shows you the permission hierarchy and\n which permission groups you are a member of.\n '}</em><aclass="headerlink"href="#evennia.commands.default.general.CmdAccess.search_index_entry"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-help-module"></span><h2>evennia.commands.default.help module<aclass="headerlink"href="#module-evennia.commands.default.help"title="Permalink to this headline">¶</a></h2>
<p>The help command. The basic idea is that help texts for commands
are best written by those that write the commands - the admins. So
command-help is all auto-loaded and searched from the current command
set. The normal, database-tied help system is used for collaborative
creation of other help topics such as RP help or game-world aides.</p>
<dlclass="class">
<dtid="evennia.commands.default.help.CmdHelp">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.help.</code><codeclass="sig-name descname">CmdHelp</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('?', 'help')</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'?', 'help'}</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['?']</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">check_show_help</code><spanclass="sig-paren">(</span><emclass="sig-param">cmd</em>, <emclass="sig-param">caller</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.check_show_help"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.check_show_help"title="Permalink to this definition">¶</a></dt>
<dd><p>Helper method. If this return True, the given cmd
auto-help will be viewable in the help listing.
Override this to easily select what is shown to
the account. Note that only commands available
in the caller’s merged cmdset are available.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cmd</strong> (<aclass="reference internal"href="evennia.commands.html#evennia.commands.command.Command"title="evennia.commands.command.Command"><em>Command</em></a>) – Command class from the merged cmdset</p></li>
<li><p><strong>caller</strong> (<em>Character</em><em>, </em><em>Account</em><em> or </em><aclass="reference internal"href="evennia.server.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a>) – The current caller
<emclass="property">static </em><codeclass="sig-name descname">format_help_entry</code><spanclass="sig-paren">(</span><emclass="sig-param">title</em>, <emclass="sig-param">help_text</em>, <emclass="sig-param">aliases=None</em>, <emclass="sig-param">suggested=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.format_help_entry"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.format_help_entry"title="Permalink to this definition">¶</a></dt>
<dd><p>This visually formats the help entry.
This method can be overriden to customize the way a help
entry is displayed.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>title</strong> (<em>str</em>) – the title of the help entry.</p></li>
<li><p><strong>help_text</strong> (<em>str</em>) – the text of the help entry.</p></li>
<li><p><strong>aliases</strong> (<em>list of str</em><em> or </em><em>None</em>) – the list of aliases.</p></li>
<li><p><strong>suggested</strong> (<em>list of str</em><em> or </em><em>None</em>) – suggested reading.</p></li>
</ul>
</dd>
</dl>
<p>Returns the formatted string, ready to be sent.</p>
<codeclass="sig-name descname">format_help_list</code><spanclass="sig-paren">(</span><emclass="sig-param">hdict_cmds</em>, <emclass="sig-param">hdict_db</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.format_help_list"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.format_help_list"title="Permalink to this definition">¶</a></dt>
<dd><p>Output a category-ordered list. The input are the
pre-loaded help files for commands and database-helpfiles
respectively. You can override this method to return a
custom display of the list of commands and topics.</p>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_more</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.help_more"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'help'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">msg_help</code><spanclass="sig-paren">(</span><emclass="sig-param">text</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.msg_help"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.msg_help"title="Permalink to this definition">¶</a></dt>
<dd><p>messages text to the caller, adding an extra oob argument to indicate
that this is a help command result and could be rendered in a separate
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.parse"title="Permalink to this definition">¶</a></dt>
<dd><p>input is a string containing the command or topic to match.</p>
<codeclass="sig-name descname">return_cmdset</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.return_cmdset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '?', 'category': 'general', 'key': 'help', 'tags': '', 'text': '\n View help or a list of topics\n\n Usage:\n help <topic or command>\n help list\n help all\n\n This will search for help on commands and other\n topics related to the game.\n '}</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">should_list_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param">cmd</em>, <emclass="sig-param">caller</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.should_list_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.should_list_cmd"title="Permalink to this definition">¶</a></dt>
<dd><p>Should the specified command appear in the help table?</p>
<p>This method only checks whether a specified command should
appear in the table of topics/commands. The command can be
used by the caller (see the ‘check_show_help’ method) and
the command will still be available, for instance, if a
character type ‘help name of the command’. However, if
you return False, the specified command will not appear in
the table. This is sometimes useful to “hide” commands in
the table, but still access them through the help system.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cmd</strong>– the command to be tested.</p></li>
<li><p><strong>caller</strong>– the caller of the help system.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p>the command should appear in the table.
False: the command shouldn’t appear in the table.</p>
<codeclass="sig-name descname">suggestion_cutoff</code><emclass="property"> = 0.6</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.suggestion_cutoff"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">suggestion_maxnum</code><emclass="property"> = 5</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.suggestion_maxnum"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.help.CmdSetHelp">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.help.</code><codeclass="sig-name descname">CmdSetHelp</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdSetHelp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('sethelp',)</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'sethelp'}</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdSetHelp.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'sethelp'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(Helper)'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(Helper)'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'sethelp', 'tags': '', 'text': '\n Edit the help database.\n\n Usage:\n help[/switches] <topic>[[;alias;alias][,category[,locks]] [= <text>]\n\n Switches:\n edit - open a line editor to edit the topic\'s help text.\n replace - overwrite existing help topic.\n append - add text to the end of existing topic with a newline between.\n extend - as append, but don\'t add a newline.\n delete - remove help topic.\n\n Examples:\n sethelp throw = This throws something at ...\n sethelp/append pickpocketing,Thievery = This steals ...\n sethelp/replace pickpocketing, ,attr(is_thief) = This steals ...\n sethelp/edit thievery\n\n This command manipulates the help database. A help entry can be created,\n appended/merged to and deleted. If you don\'t assign a category, the\n "General" category will be used. If no lockstring is specified, default\n is to let everyone read the help file.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.search_index_entry"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-muxcommand-module"></span><h2>evennia.commands.default.muxcommand module<aclass="headerlink"href="#module-evennia.commands.default.muxcommand"title="Permalink to this headline">¶</a></h2>
<p>The command template for the default MUX-style command set. There
is also an Account/OOC version that makes sure caller is an Account object.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.muxcommand.</code><codeclass="sig-name descname">MuxCommand</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/muxcommand.html#MuxCommand"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('command',)</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'command'}</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_post_cmd</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/muxcommand.html#MuxCommand.at_post_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.at_post_cmd"title="Permalink to this definition">¶</a></dt>
<dd><p>This hook is called after the command has finished executing
<codeclass="sig-name descname">at_pre_cmd</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/muxcommand.html#MuxCommand.at_pre_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.at_pre_cmd"title="Permalink to this definition">¶</a></dt>
<dd><p>This hook is called before self.parse() on all commands</p>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/muxcommand.html#MuxCommand.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.func"title="Permalink to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>This is the hook function that actually does all the work. It is called</dt><dd><p>by the cmdhandler right after self.parser() finishes, and so has access
<codeclass="sig-name descname">get_command_info</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/muxcommand.html#MuxCommand.get_command_info"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.get_command_info"title="Permalink to this definition">¶</a></dt>
<dd><p>Update of parent class’s get_command_info() for MuxCommand.</p>
<codeclass="sig-name descname">has_perm</code><spanclass="sig-paren">(</span><emclass="sig-param">srcobj</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/muxcommand.html#MuxCommand.has_perm"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.has_perm"title="Permalink to this definition">¶</a></dt>
<dd><p>This is called by the cmdhandler to determine
if srcobj is allowed to execute this command.
We just show it here for completeness - we
are satisfied using the default check in Command.</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'command'</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/muxcommand.html#MuxCommand.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.parse"title="Permalink to this definition">¶</a></dt>
<dd><p>This method is called by the cmdhandler once the command name
has been identified. It creates a new set of member variables
that can be later accessed from self.func() (see below)</p>
<p>The following variables are available for our use when entering this
method (from the command definition, and assigned on the fly by the
cmdhandler):</p>
<blockquote>
<div><p>self.key - the name of this command (‘look’)
self.aliases - the aliases of this cmd (‘l’)
self.permissions - permission string for this command
self.help_category - overall category of command</p>
<p>self.caller - the object calling this command
self.cmdstring - the actual command name used to call this</p>
<blockquote>
<div><dlclass="simple">
<dt>(this allows you to know which alias was used,</dt><dd><p>for example)</p>
</dd>
</dl>
</div></blockquote>
<p>self.args - the raw input; everything following self.cmdstring.
self.cmdset - the cmdset from which this command was picked. Not</p>
<blockquote>
<div><p>often used (useful for commands like ‘help’ or to
list all available commands etc)</p>
</div></blockquote>
<dlclass="simple">
<dt>self.obj - the object on which this command was defined. It is often</dt><dd><p>the same as self.caller.</p>
</dd>
</dl>
</div></blockquote>
<p>A MUX command has the following possible syntax:</p>
<blockquote>
<div><p>name[ with several words][/switch[/switch..]] arg1[,arg2,…] [[=|,] arg[,..]]</p>
</div></blockquote>
<p>The ‘name[ with several words]’ part is already dealt with by the
cmdhandler at this point, and stored in self.cmdname (we don’t use
it here). The rest of the command is stored in self.args, which can
start with the switch indicator /.</p>
<dlclass="simple">
<dt>Optional variables to aid in parsing, if set:</dt><dd><dlclass="simple">
<dt>self.switch_options - (tuple of valid /switches expected by this</dt><dd><p>command (without the /))</p>
</dd>
<dt>self.rhs_split - Alternate string delimiter or tuple of strings</dt><dd><p>to separate left/right hand sides. tuple form
gives priority split to first string delimiter.</p>
</dd>
</dl>
</dd>
</dl>
<p>This parser breaks self.args into its constituents and stores them in the
following variables:</p>
<blockquote>
<div><p>self.switches = [list of /switches (without the /)]
self.raw = This is the raw argument input, including switches
self.args = This is re-defined to be everything <em>except</em> the switches
self.lhs = Everything to the left of = (lhs:’left-hand side’). If</p>
<blockquote>
<div><p>no = is found, this is identical to self.args.</p>
</div></blockquote>
<dlclass="simple">
<dt>self.rhs: Everything to the right of = (rhs:’right-hand side’).</dt><dd><p>If no ‘=’ is found, this is None.</p>
</dd>
</dl>
<p>self.lhslist - [self.lhs split into a list by comma]
self.rhslist - [list of self.rhs split into a list by comma]
self.arglist = [list of space-separated args (stripped, including ‘=’ if it exists)]</p>
<p>All args and list members are stripped of excess whitespace around the
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'command', 'tags': '', 'text': "\n This sets up the basis for a MUX command. The idea\n is that most other Mux-related commands should just\n inherit from this and don't have to implement much\n parsing of their own unless they do something particularly\n advanced.\n\n Note that the class's __doc__ string (this text) is\n used by Evennia to create the automatic help entry for\n the command, so make sure to document consistently here.\n "}</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxCommand.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.muxcommand.</code><codeclass="sig-name descname">MuxAccountCommand</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/muxcommand.html#MuxAccountCommand"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxAccountCommand"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('command',)</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxAccountCommand._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'command'}</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxAccountCommand._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">account_caller</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxAccountCommand.account_caller"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxAccountCommand.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxAccountCommand.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'command'</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxAccountCommand.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxAccountCommand.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'command', 'tags': '', 'text': '\n This is an on-Account version of the MuxCommand. Since these commands sit\n on Accounts rather than on Characters/Objects, we need to check\n this in the parser.\n\n Account commands are available also when puppeting a Character, it\'s\n just that they are applied with a lower priority and are always\n available, also when disconnected from a character (i.e. "ooc").\n\n This class makes sure that caller is always an Account object, while\n creating a new property "character" that is set only if a\n character is actually attached to this Account and Session.\n '}</em><aclass="headerlink"href="#evennia.commands.default.muxcommand.MuxAccountCommand.search_index_entry"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-syscommands-module"></span><h2>evennia.commands.default.syscommands module<aclass="headerlink"href="#module-evennia.commands.default.syscommands"title="Permalink to this headline">¶</a></h2>
<p>System commands</p>
<p>These are the default commands called by the system commandhandler
when various exceptions occur. If one of these commands are not
implemented and part of the current cmdset, the engine falls back
to a default solution instead.</p>
<p>Some system commands are shown in this module
as a REFERENCE only (they are not all added to Evennia’s
default cmdset since they don’t currently do anything differently from the
default backup systems hard-wired in the engine).</p>
<p>Overloading these commands in a cmdset can be used to create
interesting effects. An example is using the NoMatch system command
to implement a line-editor where you don’t have to start each
line with a command (if there is no match to a known command,
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.syscommands.</code><codeclass="sig-name descname">SystemMultimatch</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/syscommands.html#SystemMultimatch"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemMultimatch"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('__multimatch_command',)</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemMultimatch._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'__multimatch_command'}</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemMultimatch._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemMultimatch.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/syscommands.html#SystemMultimatch.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemMultimatch.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Handle multiple-matches by using the at_search_result default handler.</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemMultimatch.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '__multimatch_command'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemMultimatch.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemMultimatch.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemMultimatch.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': '__multimatch_command', 'tags': '', 'text': "\n Multiple command matches.\n\n The cmdhandler adds a special attribute 'matches' to this\n system command.\n\n matches = [(cmdname, args, cmdobj, cmdlen, mratio, raw_cmdname) , (cmdname, ...), ...]\n\n Here, `cmdname` is the command's name and `args` the rest of the incoming string,\n without said command name. `cmdobj` is the Command instance, the cmdlen is\n the same as len(cmdname) and mratio is a measure of how big a part of the\n full input string the cmdname takes up - an exact match would be 1.0. Finally,\n the `raw_cmdname` is the cmdname unmodified by eventual prefix-stripping.\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemMultimatch.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.syscommands.</code><codeclass="sig-name descname">SystemNoInput</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/syscommands.html#SystemNoInput"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoInput"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('__noinput_command',)</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoInput._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'__noinput_command'}</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoInput._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoInput.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/syscommands.html#SystemNoInput.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoInput.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoInput.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '__noinput_command'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoInput.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoInput.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoInput.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': '__noinput_command', 'tags': '', 'text': '\n This is called when there is no input given\n '}</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoInput.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.syscommands.</code><codeclass="sig-name descname">SystemNoMatch</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/syscommands.html#SystemNoMatch"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoMatch"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('__nomatch_command',)</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoMatch._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'__nomatch_command'}</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoMatch._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoMatch.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/syscommands.html#SystemNoMatch.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoMatch.func"title="Permalink to this definition">¶</a></dt>
<dd><p>This is given the failed raw string as input.</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoMatch.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '__nomatch_command'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoMatch.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoMatch.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoMatch.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': '__nomatch_command', 'tags': '', 'text': '\n No command was found matching the given input.\n '}</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemNoMatch.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.syscommands.</code><codeclass="sig-name descname">SystemSendToChannel</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/syscommands.html#SystemSendToChannel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('__send_to_channel_command',)</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'__send_to_channel_command'}</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/syscommands.html#SystemSendToChannel.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new message and send it to channel, using
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '__send_to_channel_command'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/syscommands.html#SystemSendToChannel.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel.parse"title="Permalink to this definition">¶</a></dt>
<dd><p>This method is called by the cmdhandler once the command name
has been identified. It creates a new set of member variables
that can be later accessed from self.func() (see below)</p>
<p>The following variables are available for our use when entering this
method (from the command definition, and assigned on the fly by the
cmdhandler):</p>
<blockquote>
<div><p>self.key - the name of this command (‘look’)
self.aliases - the aliases of this cmd (‘l’)
self.permissions - permission string for this command
self.help_category - overall category of command</p>
<p>self.caller - the object calling this command
self.cmdstring - the actual command name used to call this</p>
<blockquote>
<div><dlclass="simple">
<dt>(this allows you to know which alias was used,</dt><dd><p>for example)</p>
</dd>
</dl>
</div></blockquote>
<p>self.args - the raw input; everything following self.cmdstring.
self.cmdset - the cmdset from which this command was picked. Not</p>
<blockquote>
<div><p>often used (useful for commands like ‘help’ or to
list all available commands etc)</p>
</div></blockquote>
<dlclass="simple">
<dt>self.obj - the object on which this command was defined. It is often</dt><dd><p>the same as self.caller.</p>
</dd>
</dl>
</div></blockquote>
<p>A MUX command has the following possible syntax:</p>
<blockquote>
<div><p>name[ with several words][/switch[/switch..]] arg1[,arg2,…] [[=|,] arg[,..]]</p>
</div></blockquote>
<p>The ‘name[ with several words]’ part is already dealt with by the
cmdhandler at this point, and stored in self.cmdname (we don’t use
it here). The rest of the command is stored in self.args, which can
start with the switch indicator /.</p>
<dlclass="simple">
<dt>Optional variables to aid in parsing, if set:</dt><dd><dlclass="simple">
<dt>self.switch_options - (tuple of valid /switches expected by this</dt><dd><p>command (without the /))</p>
</dd>
<dt>self.rhs_split - Alternate string delimiter or tuple of strings</dt><dd><p>to separate left/right hand sides. tuple form
gives priority split to first string delimiter.</p>
</dd>
</dl>
</dd>
</dl>
<p>This parser breaks self.args into its constituents and stores them in the
following variables:</p>
<blockquote>
<div><p>self.switches = [list of /switches (without the /)]
self.raw = This is the raw argument input, including switches
self.args = This is re-defined to be everything <em>except</em> the switches
self.lhs = Everything to the left of = (lhs:’left-hand side’). If</p>
<blockquote>
<div><p>no = is found, this is identical to self.args.</p>
</div></blockquote>
<dlclass="simple">
<dt>self.rhs: Everything to the right of = (rhs:’right-hand side’).</dt><dd><p>If no ‘=’ is found, this is None.</p>
</dd>
</dl>
<p>self.lhslist - [self.lhs split into a list by comma]
self.rhslist - [list of self.rhs split into a list by comma]
self.arglist = [list of space-separated args (stripped, including ‘=’ if it exists)]</p>
<p>All args and list members are stripped of excess whitespace around the
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': '__send_to_channel_command', 'tags': '', 'text': '\n This is a special command that the cmdhandler calls\n when it detects that the command given matches\n an existing Channel object key (or alias).\n '}</em><aclass="headerlink"href="#evennia.commands.default.syscommands.SystemSendToChannel.search_index_entry"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-system-module"></span><h2>evennia.commands.default.system module<aclass="headerlink"href="#module-evennia.commands.default.system"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.system.</code><codeclass="sig-name descname">CmdReload</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdReload"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdReload"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('reload', 'restart')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'reload', 'restart'}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['restart']</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdReload.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'reload'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(reload) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(reload) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'restart', 'category': 'system', 'key': 'reload', 'tags': '', 'text': '\n reload the server\n\n Usage:\n reload [reason]\n\n This restarts the server. The Portal is not\n affected. Non-persistent scripts will survive a reload (use\n reset to purge) and at_reload() hooks will be called.\n '}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.system.CmdReset">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.system.</code><codeclass="sig-name descname">CmdReset</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdReset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdReset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('reboot', 'reset')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'reboot', 'reset'}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['reboot']</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdReset.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'reset'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(reload) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(reload) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'reboot', 'category': 'system', 'key': 'reset', 'tags': '', 'text': '\n reset and reboot the server\n\n Usage:\n reset\n\n Notes:\n For normal updating you are recommended to use reload rather\n than this command. Use shutdown for a complete stop of\n everything.\n\n This emulates a cold reboot of the Server component of Evennia.\n The difference to shutdown is that the Server will auto-reboot\n and that it does not affect the Portal, so no users will be\n disconnected. Contrary to reload however, all shutdown hooks will\n be called and any non-database saved scripts, ndb-attributes,\n cmdsets etc will be wiped.\n\n '}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.system.</code><codeclass="sig-name descname">CmdShutdown</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdShutdown"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('shutdown',)</em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'shutdown'}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdShutdown.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'shutdown'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(shutdown) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(shutdown) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'system', 'key': 'shutdown', 'tags': '', 'text': '\n stop the server completely\n\n Usage:\n shutdown [announcement]\n\n Gracefully shut down both Server and Portal.\n '}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.system.CmdPy">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.system.</code><codeclass="sig-name descname">CmdPy</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdPy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdPy"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('py', '!')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'!', 'py'}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['!']</em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdPy.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'py'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(py) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(py) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '!', 'category': 'system', 'key': 'py', 'tags': '', 'text': "\n execute a snippet of python code\n\n Usage:\n py [cmd]\n py/edit\n py/time <cmd>\n py/clientraw <cmd>\n py/noecho\n\n Switches:\n time - output an approximate execution time for <cmd>\n edit - open a code editor for multi-line code experimentation\n clientraw - turn off all client-specific escaping. Note that this may\n lead to different output depending on prototocol (such as angular brackets\n being parsed as HTML in the webclient but not in telnet clients)\n noecho - in Python console mode, turn off the input echo (e.g. if your client\n does this for you already)\n\n Without argument, open a Python console in-game. This is a full console,\n accepting multi-line Python code for testing and debugging. Type `exit()` to\n return to the game. If Evennia is reloaded, the console will be closed.\n\n Enter a line of instruction after the 'py' command to execute it\n immediately. Separate multiple commands by ';' or open the code editor\n using the /edit switch (all lines added in editor will be executed\n immediately when closing or using the execute command in the editor).\n\n A few variables are made available for convenience in order to offer access\n to the system (you can import more at execution time).\n\n Available variables in py environment:\n self, me : caller\n here : caller.location\n evennia : the evennia API\n inherits_from(obj, parent) : check object inheritance\n\n You can explore The evennia API from inside the game by calling\n the `__doc__` property on entities:\n py evennia.__doc__\n py evennia.managers.__doc__\n\n |rNote: In the wrong hands this command is a severe security risk. It\n should only be accessible by trusted server admins/superusers.|n\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('time', 'edit', 'clientraw', 'noecho')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.system.</code><codeclass="sig-name descname">CmdScripts</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdScripts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('scripts', 'listscripts', 'globalscript')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'globalscript', 'listscripts', 'scripts'}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['listscripts', 'globalscript']</em><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">excluded_typeclass_paths</code><emclass="property"> = ['evennia.prototypes.prototypes.DbPrototype']</em><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts.excluded_typeclass_paths"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdScripts.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'scripts'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(listscripts) or perm(Admin)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(listscripts) or perm(Admin)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'listscripts globalscript', 'category': 'system', 'key': 'scripts', 'tags': '', 'text': '\n list and manage all running scripts\n\n Usage:\n scripts[/switches] [#dbref, key, script.path or <obj>]\n\n Switches:\n start - start a script (must supply a script path)\n stop - stops an existing script\n kill - kills a script - without running its cleanup hooks\n validate - run a validation on the script(s)\n\n If no switches are given, this command just views all active\n scripts. The argument can be either an object, at which point it\n will be searched for all scripts defined on it, or a script name\n or #dbref. For using the /stop switch, a unique script #dbref is\n required since whole classes of scripts often have the same name.\n\n Use script for managing commands on objects.\n '}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('start', 'stop', 'kill', 'validate')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdScripts.switch_options"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.system.</code><codeclass="sig-name descname">CmdObjects</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdObjects"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdObjects"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['stats', 'listobjects', 'db', 'listobjs']</em><aclass="headerlink"href="#evennia.commands.default.system.CmdObjects.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdObjects.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdObjects.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdObjects.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'objects'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdObjects.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(listobjects) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdObjects.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(listobjects) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdObjects.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'stats listobjects db listobjs', 'category': 'system', 'key': 'objects', 'tags': '', 'text': '\n statistics on objects in the database\n\n Usage:\n objects [<nr>]\n\n Gives statictics on objects in database as well as\n a list of <nr> latest objects in database. If not\n given, <nr> defaults to 10.\n '}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdObjects.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.system.</code><codeclass="sig-name descname">CmdService</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdService"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdService"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('services', 'service')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdService._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'service', 'services'}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdService._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['services']</em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdService.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdService.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'service'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(service) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(service) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'services', 'category': 'system', 'key': 'service', 'tags': '', 'text': '\n manage system services\n\n Usage:\n service[/switch] <service>\n\n Switches:\n list - shows all available services (default)\n start - activates or reactivate a service\n stop - stops/inactivate a service (can often be restarted)\n delete - tries to permanently remove a service\n\n Service management system. Allows for the listing,\n starting, and stopping of services. If no switches\n are given, services will be listed. Note that to operate on the\n service you have to supply the full (green or red) name as given\n in the list.\n '}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('list', 'start', 'stop', 'delete')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.switch_options"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.system.CmdAbout">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.system.</code><codeclass="sig-name descname">CmdAbout</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdAbout"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('about', 'version')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'about', 'version'}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['version']</em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdAbout.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Display information about server or target</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'about'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'version', 'category': 'system', 'key': 'about', 'tags': '', 'text': '\n show Evennia info\n\n Usage:\n about\n\n Display info about the game engine.\n '}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.system.CmdTime">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.system.</code><codeclass="sig-name descname">CmdTime</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdTime"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdTime"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('time', 'uptime')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'time', 'uptime'}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['uptime']</em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdTime.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'time'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(time) or perm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(time) or perm(Player)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'uptime', 'category': 'system', 'key': 'time', 'tags': '', 'text': '\n show server time statistics\n\n Usage:\n time\n\n List Server time statistics such as uptime\n and the current time stamp.\n '}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.system.</code><codeclass="sig-name descname">CmdServerLoad</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdServerLoad"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('serverprocess', 'server', 'serverload')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'server', 'serverload', 'serverprocess'}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['serverprocess', 'serverload']</em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdServerLoad.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'server'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(list) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(list) or perm(Developer)'</em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'serverprocess serverload', 'category': 'system', 'key': 'server', 'tags': '', 'text': "\n show server load and memory statistics\n\n Usage:\n server[/mem]\n\n Switches:\n mem - return only a string of the current memory usage\n flushmem - flush the idmapper cache\n\n This command shows server load statistics and dynamic memory\n usage. It also allows to flush the cache of accessed database\n objects.\n\n Some Important statistics in the table:\n\n |wServer load|n is an average of processor usage. It's usually\n between 0 (no usage) and 1 (100% usage), but may also be\n temporarily higher if your computer has multiple CPU cores.\n\n The |wResident/Virtual memory|n displays the total memory used by\n the server process.\n\n Evennia |wcaches|n all retrieved database entities when they are\n loaded by use of the idmapper functionality. This allows Evennia\n to maintain the same instances of an entity and allowing\n non-persistent storage schemes. The total amount of cached objects\n are displayed plus a breakdown of database object types.\n\n The |wflushmem|n switch allows to flush the object cache. Please\n note that due to how Python's memory management works, releasing\n caches may not show you a lower Residual/Virtual memory footprint,\n the released memory will instead be re-used by the program.\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.search_index_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">switch_options</code><emclass="property"> = ('mem', 'flushmem')</em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.switch_options"title="Permalink to this definition">¶</a></dt>
<h2>evennia.commands.default.tests module<aclass="headerlink"href="#evennia-commands-default-tests-module"title="Permalink to this headline">¶</a></h2>
<p>This is part of the Evennia unittest framework, for testing the
stability and integrity of the codebase during updates. This module
test the default command set. It is instantiated by the
evennia/objects/tests.py module, which in turn is run by as part of the
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">CmdInterrupt</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#CmdInterrupt"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.CmdInterrupt"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('interrupt',)</em><aclass="headerlink"href="#evennia.commands.default.tests.CmdInterrupt._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'interrupt'}</em><aclass="headerlink"href="#evennia.commands.default.tests.CmdInterrupt._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.tests.CmdInterrupt.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#CmdInterrupt.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.CmdInterrupt.func"title="Permalink to this definition">¶</a></dt>
<dd><p>This is the actual executing part of the command. It is
called directly after self.parse(). See the docstring of this
module for which object properties are available (beyond those
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.tests.CmdInterrupt.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'interrupt'</em><aclass="headerlink"href="#evennia.commands.default.tests.CmdInterrupt.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.commands.default.tests.CmdInterrupt.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#CmdInterrupt.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.CmdInterrupt.parse"title="Permalink to this definition">¶</a></dt>
<dd><p>Once the cmdhandler has identified this as the command we
want, this function is run. If many of your commands have a
similar syntax (for example ‘cmd arg1 = arg2’) you should
simply define this once and just let other commands of the
same form inherit from this. See the docstring of this module
for which object properties are available to use (notably
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'interrupt', 'tags': '', 'text': '\n Base command\n\n Usage:\n command [args]\n\n This is the base command class. Inherit from this\n to create new commands.\n\n The cmdhandler makes the following variables available to the\n command methods (so you can always assume them to be there):\n self.caller - the game object calling the command\n self.cmdstring - the command name used to trigger this command (allows\n you to know which alias was used, for example)\n cmd.args - everything supplied to the command following the cmdstring\n (this is usually what is parsed in self.parse())\n cmd.cmdset - the cmdset from which this command was matched (useful only\n seldomly, notably for help-type commands, to create dynamic\n help entries and lists)\n cmd.obj - the object on which this command is defined. If a default command,\n this is usually the same as caller.\n cmd.rawstring - the full raw string input, including any args and no parsing.\n\n The following class properties can/should be defined on your child class:\n\n key - identifier for command (e.g. "look")\n aliases - (optional) list of aliases (e.g. ["l", "loo"])\n locks - lock string (default is "cmd:all()")\n help_category - how to organize this help entry in help system\n (default is "General")\n auto_help - defaults to True. Allows for turning off auto-help generation\n arg_regex - (optional) raw string regex defining how the argument part of\n the command should look in order to match for this command\n (e.g. must it be a space between cmdname and arg?)\n\n (Note that if auto_help is on, this initial string is also used by the\n system to create the help entry for the command, so it\'s a good idea to\n format it similar to this one). This behavior can be changed by\n overriding the method \'get_help\' of a command: by default, this\n method returns cmd.__doc__ (that is, this very docstring, or\n the docstring of your command). You can, however, extend or\n replace this without disabling auto_help.\n '}</em><aclass="headerlink"href="#evennia.commands.default.tests.CmdInterrupt.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">CommandTest</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#CommandTest"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.CommandTest"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestAccount</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_char_create</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_char_create"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_char_create"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_char_delete</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_char_delete"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_char_delete"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_color_test</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_color_test"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_color_test"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_ic</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_ic"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_ic"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_ooc</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_ooc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_ooc"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_ooc_look</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_ooc_look"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_ooc_look"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_option</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_option"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_option"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_password</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_password"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_password"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_quell</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_quell"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_quell"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_quit</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_quit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_quit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_sessions</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_sessions"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_sessions"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_who</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAccount.test_who"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAccount.test_who"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.tests.TestAdmin">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestAdmin</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAdmin"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAdmin"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_ban</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAdmin.test_ban"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAdmin.test_ban"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_emit</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAdmin.test_emit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAdmin.test_emit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_force</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAdmin.test_force"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAdmin.test_force"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_perm</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAdmin.test_perm"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAdmin.test_perm"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_wall</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestAdmin.test_wall"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestAdmin.test_wall"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestBatchProcess</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBatchProcess"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBatchProcess"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_batch_commands</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBatchProcess.test_batch_commands"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBatchProcess.test_batch_commands"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestBuilding</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_attribute_commands</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_attribute_commands"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_attribute_commands"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_copy</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_copy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_copy"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_create</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_create"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_create"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_desc</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_desc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_desc"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_desc_default_to_room</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_desc_default_to_room"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_desc_default_to_room"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_destroy</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_destroy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_destroy"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_destroy_sequence</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_destroy_sequence"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_destroy_sequence"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_dig</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_dig"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_dig"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_do_nested_lookup</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_do_nested_lookup"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_do_nested_lookup"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_empty_desc</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_empty_desc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_empty_desc"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_examine</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_examine"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_examine"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_exit_commands</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_exit_commands"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_exit_commands"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_find</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_find"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_find"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_list_cmdsets</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_list_cmdsets"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_list_cmdsets"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_lock</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_lock"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_lock"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_name</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_name"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_name"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_nested_attribute_commands</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_nested_attribute_commands"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_nested_attribute_commands"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_script</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_script"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_script"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_set_home</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_set_home"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_set_home"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_set_obj_alias</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_set_obj_alias"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_set_obj_alias"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_spawn</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_spawn"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_spawn"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_split_nested_attr</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_split_nested_attr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_split_nested_attr"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_tag</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_tag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_tag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_teleport</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_teleport"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_teleport"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_tunnel</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_tunnel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_tunnel"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_tunnel_exit_typeclass</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_tunnel_exit_typeclass"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_tunnel_exit_typeclass"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_typeclass</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestBuilding.test_typeclass"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestBuilding.test_typeclass"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.tests.TestComms">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestComms</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">setUp</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.setUp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.setUp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_all_com</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.test_all_com"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.test_all_com"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_cboot</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.test_cboot"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.test_cboot"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_cdesc</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.test_cdesc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.test_cdesc"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_cdestroy</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.test_cdestroy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.test_cdestroy"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_cemit</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.test_cemit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.test_cemit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_channels</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.test_channels"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.test_channels"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_clock</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.test_clock"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.test_clock"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_cwho</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.test_cwho"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.test_cwho"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_page</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.test_page"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.test_page"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_toggle_com</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestComms.test_toggle_com"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestComms.test_toggle_com"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestGeneral</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_access</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_access"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_access"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_get_and_drop</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_get_and_drop"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_get_and_drop"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_give</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_give"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_give"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_home</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_home"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_home"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_inventory</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_inventory"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_inventory"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_look</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_look"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_look"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_mux_command</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_mux_command"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_mux_command"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_nick</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_nick"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_nick"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_pose</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_pose"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_pose"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_say</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_say"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_say"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_whisper</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestGeneral.test_whisper"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestGeneral.test_whisper"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="evennia.commands.default.tests.TestHelp">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestHelp</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestHelp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestHelp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">setUp</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestHelp.setUp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestHelp.setUp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">tearDown</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestHelp.tearDown"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestHelp.tearDown"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
<codeclass="sig-name descname">test_help</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestHelp.test_help"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestHelp.test_help"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_set_help</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestHelp.test_set_help"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestHelp.test_set_help"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestInterruptCommand</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestInterruptCommand"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestInterruptCommand"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_interrupt_command</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestInterruptCommand.test_interrupt_command"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestInterruptCommand.test_interrupt_command"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestSystem</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestSystem"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestSystem"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_about</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestSystem.test_about"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestSystem.test_about"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_objects</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestSystem.test_objects"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestSystem.test_objects"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_py</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestSystem.test_py"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestSystem.test_py"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_scripts</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestSystem.test_scripts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestSystem.test_scripts"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_server_load</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestSystem.test_server_load"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestSystem.test_server_load"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestSystemCommands</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestSystemCommands"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestSystemCommands"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_channelcommand</code><spanclass="sig-paren">(</span><emclass="sig-param">mock_channeldb</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestSystemCommands.test_channelcommand"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestSystemCommands.test_channelcommand"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_multimatch</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestSystemCommands.test_multimatch"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestSystemCommands.test_multimatch"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_simple_defaults</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestSystemCommands.test_simple_defaults"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestSystemCommands.test_simple_defaults"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.tests.</code><codeclass="sig-name descname">TestUnconnectedCommand</code><spanclass="sig-paren">(</span><emclass="sig-param">methodName='runTest'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestUnconnectedCommand"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestUnconnectedCommand"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">test_info_command</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/tests.html#TestUnconnectedCommand.test_info_command"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.tests.TestUnconnectedCommand.test_info_command"title="Permalink to this definition">¶</a></dt>
<spanid="evennia-commands-default-unloggedin-module"></span><h2>evennia.commands.default.unloggedin module<aclass="headerlink"href="#module-evennia.commands.default.unloggedin"title="Permalink to this headline">¶</a></h2>
<p>Commands that are available from the connect screen.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.unloggedin.</code><codeclass="sig-name descname">CmdUnconnectedConnect</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedConnect"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('conn', 'co', 'connect', 'con')</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'co', 'con', 'conn', 'connect'}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['co', 'conn', 'con']</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s.*?|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedConnect.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Uses the Django admin api. Note that unlogged-in commands
have a unique position in that their func() receives
a session object instead of a source_object like all
other types of logged-in commands (this is because
there is no object yet before the account has logged in)</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'connect'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name""pass word"\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><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.unloggedin.</code><codeclass="sig-name descname">CmdUnconnectedCreate</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedCreate"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('create', 'cre', 'cr')</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'cr', 'cre', 'create'}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['cre', 'cr']</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s.*?|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedCreate.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'create'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'cre cr', 'category': 'general', 'key': 'create', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create <accountname><password>\n create "account name""pass word"\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.unloggedin.</code><codeclass="sig-name descname">CmdUnconnectedQuit</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedQuit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('q', 'quit', 'qu')</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'q', 'qu', 'quit'}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['q', 'qu']</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedQuit.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'quit'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="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><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.unloggedin.</code><codeclass="sig-name descname">CmdUnconnectedLook</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedLook"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('look', 'l', '__unloggedin_look_command')</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'__unloggedin_look_command', 'l', 'look'}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['look', 'l']</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedLook.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '__unloggedin_look_command'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.unloggedin.</code><codeclass="sig-name descname">CmdUnconnectedHelp</code><spanclass="sig-paren">(</span><emclass="sig-param">**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedHelp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_keyaliases</code><emclass="property"> = ('h', '?', 'help')</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp._keyaliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">_matchset</code><emclass="property"> = {'?', 'h', 'help'}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp._matchset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['h', '?']</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedHelp.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'help'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry"title="Permalink to this definition">¶</a></dt>
