<spanid="evennia-commands-default-building"></span><h1>evennia.commands.default.building<aclass="headerlink"href="#module-evennia.commands.default.building"title="Permalink to this headline">¶</a></h1>
<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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">get_object_typeclass</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj_type</span><spanclass="p">:</span><spanclass="n">str</span><spanclass="o">=</span><spanclass="default_value">'object'</span></em>, <emclass="sig-param"><spanclass="n">typeclass</span><spanclass="p">:</span><spanclass="n">str</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">method</span><spanclass="p">:</span><spanclass="n">str</span><spanclass="o">=</span><spanclass="default_value">'cmd_create'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span>→ tuple<aclass="reference internal"href="../_modules/evennia/commands/default/building.html#ObjManipCommand.get_object_typeclass"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.ObjManipCommand.get_object_typeclass"title="Permalink to this definition">¶</a></dt>
<dd><p>This hook is called by build commands to determine which typeclass to use for a specific purpose. For instance,
when using dig, the system can use this to autodetect which kind of Room typeclass to use based on where the
builder is currently located.</p>
<dlclass="simple">
<dt>Note: Although intended to be used with typeclasses, as long as this hook returns a class with a create method,</dt><dd><p>which accepts the same API as DefaultObject.create(), build commands and other places should take it.</p>
</dd>
</dl>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>obj_type</strong> (<em>str</em><em>, </em><em>optional</em>) – The type of object that is being created. Defaults to “object”. Evennia provides
“room”, “exit”, and “character” by default, but this can be extended.</p></li>
<li><p><strong>typeclass</strong> (<em>str</em><em>, </em><em>optional</em>) – The typeclass that was requested by the player. Defaults to None.
Can also be an actual class.</p></li>
<li><p><strong>method</strong> (<em>str</em><em>, </em><em>optional</em>) – The method that is calling this hook. Defaults to “cmd_create”.
Others are “cmd_dig”, “cmd_open”, “cmd_tunnel”, etc.</p></li>
<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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'general', 'key': 'command', 'no_prefix': ' ', '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">switch_options</code><emclass="property"> = ('category',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias.switch_options"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">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">method_type</code><emclass="property"> = 'cmd_create'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdSetObjAlias.method_type"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">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">search_index_entry</code><emclass="property"> = {'aliases': 'setobjalias', 'category': 'building', 'key': '@alias', 'no_prefix': 'alias setobjalias', '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>
<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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@copy', 'no_prefix': '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">switch_options</code><emclass="property"> = ('move',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCpAttr.switch_options"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">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">check_from_attr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">attr</span></em>, <emclass="sig-param"><spanclass="n">clear</span><spanclass="o">=</span><spanclass="default_value">False</span></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_to_attr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">attr</span></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">check_has_attr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">attr</span></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">get_attr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">attr</span></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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@cpattr', 'no_prefix': '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>
<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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">switch_options</code><emclass="property"> = ('copy',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdMvAttr.switch_options"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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@mvattr', 'no_prefix': '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>
<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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">switch_options</code><emclass="property"> = ('drop',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdCreate.switch_options"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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@create', 'no_prefix': '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>
<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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">switch_options</code><emclass="property"> = ('edit',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.switch_options"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">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">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">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDesc.aliases"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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@desc', 'no_prefix': '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>
<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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">aliases</code><emclass="property"> = ['@del', '@delete']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDestroy.aliases"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>
<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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '@del @delete', 'category': 'building', 'key': '@destroy', 'no_prefix': 'destroy del delete', '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>
<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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">switch_options</code><emclass="property"> = ('teleport',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.switch_options"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">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">method_type</code><emclass="property"> = 'cmd_dig'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdDig.method_type"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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@dig', 'no_prefix': '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>
<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"><spanclass="o">**</span><spanclass="n">kwargs</span></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="#id3"><spanclass="problematic"id="id4">|</span></a>wn,ne,e,se,s,sw,w,nw|n (north, northeast etc)
<ahref="#id5"><spanclass="problematic"id="id6">|</span></a>wu,d|n (up and down)
<ahref="#id7"><spanclass="problematic"id="id8">|</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">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">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">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>
<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">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">method_type</code><emclass="property"> = 'cmd_tunnel'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTunnel.method_type"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">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">search_index_entry</code><emclass="property"> = {'aliases': '@tun', 'category': 'building', 'key': '@tunnel', 'no_prefix': 'tunnel tun', '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>
<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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@link', 'no_prefix': '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'unlink', 'no_prefix': ' ', '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@sethome', 'no_prefix': 'sethome ', 'tags': '', 'text': '\n set an object\'s home location\n\n Usage:\n sethome <obj> [= <home_location>]\n sethome <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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">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">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdListCmdSets.aliases"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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@cmdsets', 'no_prefix': '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '@rename', 'category': 'building', 'key': '@name', 'no_prefix': 'name rename', '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">method_type</code><emclass="property"> = 'cmd_open'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen.method_type"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.CmdOpen.new_obj_lockstring"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">create_exit</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">exit_name</span></em>, <emclass="sig-param"><spanclass="n">location</span></em>, <emclass="sig-param"><spanclass="n">destination</span></em>, <emclass="sig-param"><spanclass="n">exit_aliases</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">typeclass</span><spanclass="o">=</span><spanclass="default_value">None</span></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">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdOpen.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdOpen.parse"title="Permalink to this definition">¶</a></dt>
<dd><p>We need to expand the default parsing to get all
<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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@open', 'no_prefix': '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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>
<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>
<pclass="rubric">Example</p>
<p>set self/foo = “bar”
set/delete self/foo
set self/foo = $dbref(#53)</p>
<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>If you want <value> to be an object, use $dbef(#dbref) or
$search(key) to assign it. You need control or edit access to
the object you are adding.</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="#id13"><spanclass="problematic"id="id14">|</span></a>c’<ahref="#id15"><spanclass="problematic"id="id16">|</span></a>n, <ahref="#id17"><spanclass="problematic"id="id18">|</span></a>c”<ahref="#id19"><spanclass="problematic"id="id20">|</span></a>n, <ahref="#id21"><spanclass="problematic"id="id22">|</span></a>c(<ahref="#id23"><spanclass="problematic"id="id24">|</span></a>n, <ahref="#id25"><spanclass="problematic"id="id26">|</span></a>c[<ahref="#id27"><spanclass="problematic"id="id28">|</span></a>n
or <ahref="#id29"><spanclass="problematic"id="id30">|</span></a>c{ <ahref="#id31"><spanclass="problematic"id="id32">|</span></a>n.</p>
<p>Once you have stored a Python primitive as noted above, you can include
<ahref="#id33"><spanclass="problematic"id="id34">|</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">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">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">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">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">check_obj</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></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">check_attr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">attr_name</span></em>, <emclass="sig-param"><spanclass="n">category</span></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">split_nested_attr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">attr</span></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 compatibility
with older attrs that might have been named with <strong>[]</strong>’s.</p>
<codeclass="sig-name descname">do_nested_lookup</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">value</span></em>, <emclass="sig-param"><spanclass="o">*</span><spanclass="n">keys</span></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">view_attr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">attr</span></em>, <emclass="sig-param"><spanclass="n">category</span></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>
<codeclass="sig-name descname">rm_attr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">attr</span></em>, <emclass="sig-param"><spanclass="n">category</span></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">set_attr</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">attr</span></em>, <emclass="sig-param"><spanclass="n">value</span></em>, <emclass="sig-param"><spanclass="n">category</span></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">edit_handler</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.commands.default.building.CmdSetAttribute.edit_handler"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_for_obj</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">objname</span></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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@set', 'no_prefix': 'set ', 'tags': '', 'text': '\n set attribute on an object or account\n\n Usage:\n set[/switch] <obj>/<attr>[:category] = <value>\n set[/switch] <obj>/<attr>[:category] = # delete attribute\n set[/switch] <obj>/<attr>[:category] # view attribute\n set[/switch] *<account>/<attr>[:category] = <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 Example:\n set self/foo = "bar"\n set/delete self/foo\n set self/foo = $dbref(#53)\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 If you want <value> to be an object, use $dbef(#dbref) or\n $search(key) to assign it. You need control or edit access to\n the object you are adding.\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>
<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"><spanclass="o">**</span><spanclass="n">kwargs</span></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>
<p>typeclasses or typeclass/list/show [typeclass.path]
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. This will also
reset cmdsets!</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">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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '@type @typeclasses @update @parent @swap', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass type typeclasses update parent swap', '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 typeclasses or 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. This will also\n reset cmdsets!\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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': '@wipe', 'no_prefix': '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '@locks', 'category': 'building', 'key': '@lock', 'no_prefix': 'lock locks', '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">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">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">switch_options</code><emclass="property"> = ['account', 'object', 'script', 'channel']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.switch_options"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">object_type</code><emclass="property"> = 'object'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.object_type"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">detail_color</code><emclass="property"> = '|c'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.detail_color"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">header_color</code><emclass="property"> = '|w'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.header_color"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">quell_color</code><emclass="property"> = '|r'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.quell_color"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">separator</code><emclass="property"> = '-'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.separator"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">msg</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.msg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.msg"title="Permalink to this definition">¶</a></dt>
<dd><p>Central point for sending messages to the caller. This tags
the message as ‘examine’ for eventual custom markup in the client.</p>
<codeclass="sig-name descname">text</code><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.text"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_key</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_key"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_aliases</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_aliases"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_typeclass</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_typeclass"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_typeclass"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_sessions</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_sessions"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_sessions"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_email</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_email"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_email"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_last_login</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_last_login"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_last_login"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_account_key</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">account</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_account_key"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_account_key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_account_typeclass</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">account</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_account_typeclass"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_account_typeclass"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_account_permissions</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">account</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_account_permissions"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_account_permissions"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_location</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_location"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_location"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_home</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_home"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_home"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_destination</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_destination"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_destination"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_permissions</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_permissions"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_permissions"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_locks</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_locks"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_scripts</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_scripts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_scripts"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_single_tag</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">tag</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_single_tag"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_single_tag"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_tags</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_tags"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_tags"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_single_cmdset_options</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmdset</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_single_cmdset_options"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_single_cmdset_options"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_single_cmdset</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmdset</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_single_cmdset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_single_cmdset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_stored_cmdsets</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_stored_cmdsets"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_stored_cmdsets"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_merged_cmdsets</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">current_cmdset</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_merged_cmdsets"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_merged_cmdsets"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_current_cmds</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">current_cmdset</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_current_cmds"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_current_cmds"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_single_attribute_detail</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">attr</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_single_attribute_detail"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_single_attribute_detail"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_single_attribute</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">attr</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_single_attribute"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_single_attribute"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_attributes</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></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>
<codeclass="sig-name descname">format_nattributes</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_nattributes"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_nattributes"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_exits</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_exits"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_exits"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_chars</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_chars"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_chars"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_things</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_things"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_things"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_script_desc</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_script_desc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_script_desc"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_script_is_persistent</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_script_is_persistent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_script_is_persistent"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_script_timer_data</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_script_timer_data"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_script_timer_data"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_channel_sub_totals</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_channel_sub_totals"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_channel_sub_totals"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_channel_account_subs</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_channel_account_subs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_channel_account_subs"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_channel_object_subs</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.format_channel_object_subs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.format_channel_object_subs"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get_formatted_obj_data</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">current_cmdset</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.get_formatted_obj_data"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.get_formatted_obj_data"title="Permalink to this definition">¶</a></dt>
<dd><p>Calls all other <strong>format_*</strong> methods.</p>
<codeclass="sig-name descname">format_output</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">current_cmdset</span></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>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdExamine.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdExamine.parse"title="Permalink to this definition">¶</a></dt>
<dd><p>We need to expand the default parsing to get all
<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">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">search_index_entry</code><emclass="property"> = {'aliases': '@exam @ex', 'category': 'building', 'key': '@examine', 'no_prefix': 'examine exam ex', '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 script - examine a Script\n channel - examine a Channel\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"><spanclass="o">**</span><spanclass="n">kwargs</span></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="#id43"><spanclass="problematic"id="id44">*</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="#id45"><spanclass="problematic"id="id46">*</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">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">aliases</code><emclass="property"> = ['@search', '@locate']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdFind.aliases"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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '@search @locate', 'category': 'building', 'key': '@find', 'no_prefix': 'find search locate', '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">key</code><emclass="property"> = '@teleport'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['@tel']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.aliases"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>
<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">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">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">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdTeleport.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.parse"title="Permalink to this definition">¶</a></dt>
<dd><p>Breaking out searching here to make this easier to override.</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#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">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">search_index_entry</code><emclass="property"> = {'aliases': '@tel', 'category': 'building', 'key': '@teleport', 'no_prefix': 'teleport 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\n To lock an object from being teleported, set its `teleport` lock, it will be\n checked with the caller. To block\n a destination from being teleported to, set the destination's `teleport_here`\n lock - it will be checked with the thing being teleported. Admins and\n higher permissions can always teleport.\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdTeleport.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">CmdScripts</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdScripts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdScripts"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '@scripts'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScripts.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['@script']</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScripts.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(scripts) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScripts.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScripts.help_category"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.building.CmdScripts.excluded_typeclass_paths"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">hide_script_paths</code><emclass="property"> = ('evennia.prototypes.prototypes.DbPrototype',)</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScripts.hide_script_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/building.html#CmdScripts.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdScripts.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(scripts) or perm(Builder)'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScripts.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '@script', 'category': 'system', 'key': '@scripts', 'no_prefix': 'scripts script', 'tags': '', 'text': "\n List and manage all running scripts. Allows for creating new global\n scripts.\n\n Usage:\n script[/switches] [script-#dbref, key, script.path]\n script[/start||stop] <obj> = [<script.path or script-key>]\n\n Switches:\n start - start/unpause an existing script's timer.\n stop - stops an existing script's timer\n pause - pause a script's timer\n delete - deletes script. This will also stop the timer as needed\n\n Examples:\n script - list all scripts\n script foo.bar.Script - create a new global Script\n script/pause foo.bar.Script - pause global script\n script scriptname|#dbref - examine named existing global script\n script/delete #dbref[-#dbref] - delete script or range by #dbref\n\n script myobj = - list all scripts on object\n script myobj = foo.bar.Script - create and assign script to object\n script/stop myobj = name|#dbref - stop named script on object\n script/delete myobj = name|#dbref - delete script on object\n script/delete myobj = - delete ALL scripts on object\n\n When given with an `<obj>` as left-hand-side, this creates and\n assigns a new script to that object. Without an `<obj>`, this\n manages and inspects global scripts.\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 the `script` build-level command for managing scripts attached to\n objects.\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.building.CmdScripts.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">CmdObjects</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/building.html#CmdObjects"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdObjects"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '@objects'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdObjects.key"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.building.CmdObjects.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'system'</em><aclass="headerlink"href="#evennia.commands.default.building.CmdObjects.help_category"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#CmdObjects.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.building.CmdObjects.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.building.CmdObjects.aliases"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.building.CmdObjects.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'system', 'key': '@objects', 'no_prefix': '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.building.CmdObjects.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py 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"><spanclass="o">**</span><spanclass="n">kwargs</span></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">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">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">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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '@tags', 'category': 'building', 'key': '@tag', 'no_prefix': 'tag tags', '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"><spanclass="o">**</span><spanclass="n">kwargs</span></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="#id47"><spanclass="problematic"id="id48">|</span></a>wprototype_parent <ahref="#id49"><spanclass="problematic"id="id50">|</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="#id51"><spanclass="problematic"id="id52">|</span></a>wtypeclass <ahref="#id53"><spanclass="problematic"id="id54">|</span></a>n - string. Required if prototype_parent is not set.
<ahref="#id55"><spanclass="problematic"id="id56">|</span></a>wkey <ahref="#id57"><spanclass="problematic"id="id58">|</span></a>n - string, the main object identifier
<ahref="#id59"><spanclass="problematic"id="id60">|</span></a>wlocation <ahref="#id61"><spanclass="problematic"id="id62">|</span></a>n - this should be a valid object or #dbref
<ahref="#id63"><spanclass="problematic"id="id64">|</span></a>whome <ahref="#id65"><spanclass="problematic"id="id66">|</span></a>n - valid object or #dbref
<ahref="#id67"><spanclass="problematic"id="id68">|</span></a>wdestination|n - only valid for exits (object or dbref)
<ahref="#id69"><spanclass="problematic"id="id70">|</span></a>wpermissions|n - string or list of permission strings
<ahref="#id71"><spanclass="problematic"id="id72">|</span></a>wlocks <ahref="#id73"><spanclass="problematic"id="id74">|</span></a>n - a lock-string
<ahref="#id75"><spanclass="problematic"id="id76">|</span></a>waliases <ahref="#id77"><spanclass="problematic"id="id78">|</span></a>n - string or list of strings.
<ahref="#id79"><spanclass="problematic"id="id80">|</span></a>wndb_|n<name> - value of a nattribute (<ahref="#id1"><spanclass="problematic"id="id2">ndb_</span></a> is stripped)</p>
<dlclass="simple">
<dt><ahref="#id81"><spanclass="problematic"id="id82">|</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="#id83"><spanclass="problematic"id="id84">|</span></a>wprototype_desc|n - desc of this prototype. Used in listings
<ahref="#id85"><spanclass="problematic"id="id86">|</span></a>wprototype_locks|n - locks of this prototype. Limits who may use prototype
<ahref="#id87"><spanclass="problematic"id="id88">|</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">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">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">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">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">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">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">search_index_entry</code><emclass="property"> = {'aliases': '@olc', 'category': 'building', 'key': '@spawn', 'no_prefix': 'spawn olc', '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/list modules - list only module-based prototypes\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>
