<spanid="evennia-objects-objects"></span><h1>evennia.objects.objects<aclass="headerlink"href="#module-evennia.objects.objects"title="Permalink to this headline">¶</a></h1>
<p>This module defines the basic <strong>DefaultObject</strong> and its children
<strong>DefaultCharacter</strong>, <strong>DefaultAccount</strong>, <strong>DefaultRoom</strong> and <strong>DefaultExit</strong>.
These are the (default) starting points for all in-game visible
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.objects.objects.</code><codeclass="sig-name descname">ObjectSessionHandler</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#ObjectSessionHandler"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ObjectSessionHandler"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">__init__</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#ObjectSessionHandler.__init__"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ObjectSessionHandler.__init__"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>obj</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object on which the handler is defined.</p>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">sessid</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#ObjectSessionHandler.get"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ObjectSessionHandler.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the sessions linked to this Object.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>sessid</strong> (<em>int</em><em>, </em><em>optional</em>) – A specific session id.</p>
<codeclass="sig-name descname">all</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#ObjectSessionHandler.all"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ObjectSessionHandler.all"title="Permalink to this definition">¶</a></dt>
<dd><p>Alias to get(), returning all sessions.</p>
<codeclass="sig-name descname">add</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">session</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#ObjectSessionHandler.add"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ObjectSessionHandler.add"title="Permalink to this definition">¶</a></dt>
<dd><p>Add session to handler.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>session</strong> (<aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a><em> or </em><em>int</em>) – Session or session id to add.</p>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>We will only add a session/sessid if this actually also exists
<codeclass="sig-name descname">remove</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">session</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#ObjectSessionHandler.remove"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ObjectSessionHandler.remove"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>or int</strong> (<aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a>) – Session or session id to remove.</p>
<codeclass="sig-name descname">clear</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#ObjectSessionHandler.clear"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ObjectSessionHandler.clear"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">count</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#ObjectSessionHandler.count"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ObjectSessionHandler.count"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.objects.objects.</code><codeclass="sig-name descname">DefaultObject</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject"title="Permalink to this definition">¶</a></dt>
<dt>at_object_post_creation() - only called once, when object is first created.</dt><dd><p>Additional setup involving e.g. prototype-set attributes can go here.</p>
at_object_receive(obj, source_location, move_type=”move”, <ahref="#id59"><spanclass="problematic"id="id60">**</span></a>kwargs) - called when this object</p>
<dt>at_traverse(traversing_object, target_location, <ahref="#id63"><spanclass="problematic"id="id64">**</span></a>kwargs) - (exit-objects only)</dt><dd><p>handles all moving across the exit, including
calling the other exit hooks. Use super() to retain
the default functionality.</p>
</dd>
<dt>at_post_traverse(traversing_object, source_location) - (exit-objects only)</dt><dd><p>called just after a traversal has happened.</p>
</dd>
<dt>at_failed_traverse(traversing_object) - (exit-objects only) called if</dt><dd><p>traversal fails and property err_traverse is not defined.</p>
</dd>
<dt>at_msg_receive(self, msg, from_obj=None, <ahref="#id65"><spanclass="problematic"id="id66">**</span></a>kwargs) - called when a message</dt><dd><p>(via self.msg()) is sent to this obj.
If returns false, aborts send.</p>
</dd>
<dt>at_msg_send(self, msg, to_obj=None, <ahref="#id67"><spanclass="problematic"id="id68">**</span></a>kwargs) - called when this objects</dt><dd><p>sends a message to someone via self.msg().</p>
</dd>
<dt>return_appearance(looker) - describes this object. Used by “look”</dt><dd><p>command by default</p>
</dd>
<dt>at_desc(looker=None) - called by ‘look’ whenever the</dt><dd><p>appearance is requested.</p>
<codeclass="sig-name descname">cmdset_provider_order</code><emclass="property"> = 100</em><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.cmdset_provider_order"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">cmdset_provider_error_order</code><emclass="property"> = 100</em><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.cmdset_provider_error_order"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">cmdset_provider_type</code><emclass="property"> = 'object'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.cmdset_provider_type"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">objects</code><emclass="property"> = <evennia.objects.manager.ObjectManager object></em><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.objects"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">appearance_template</code><emclass="property"> = '\n{header}\n|c{name}{extra_name_info}|n\n{desc}\n{exits}\n{characters}\n{things}\n{footer}\n '</em><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.appearance_template"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">plural_category</code><emclass="property"> = 'plural_key'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.plural_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">cmdset</code><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.cmdset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.cmdset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">scripts</code><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.scripts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.scripts"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">nicks</code><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.nicks"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.nicks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">sessions</code><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.sessions"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.sessions"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">is_connected</code><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.is_connected"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">has_account</code><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.has_account"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get_cmdset_providers</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span>→ dict<aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_cmdset_providers"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_cmdset_providers"title="Permalink to this definition">¶</a></dt>
<dd><p>Overrideable method which returns a dictionary of every kind of object which
has a cmdsethandler linked to this Object, and should participate in cmdset
merging.</p>
<p>Objects might be aware of an Account. Otherwise, just themselves, by default.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><em>dict[str, CmdSetProvider]</em>– The CmdSetProviders linked to this Object.</p>
<emclass="property">property </em><codeclass="sig-name descname">is_superuser</code><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.is_superuser"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">contents_get</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">exclude</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">content_type</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.contents_get"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.contents_get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the contents of this object, i.e. all
<li><p><strong>exclude</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Object to exclude from returned
<codeclass="sig-name descname">contents_set</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.contents_set"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.contents_set"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">contents</code><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.contents"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the contents of this object, i.e. all
objects that has this object set as its location.
This should be publically available.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>exclude</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Object to exclude from returned
contents list</p></li>
<li><p><strong>content_type</strong> (<em>str</em>) – A content_type to filter by. None for no
filtering.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>list</em>– List of contents of this Object.</p>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>Also available as the <strong>.contents</strong> property, but that doesn’t allow for exclusion and
<emclass="property">property </em><codeclass="sig-name descname">exits</code><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.exits"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns all exits from this object, i.e. all objects at this
<codeclass="sig-name descname">get_search_query_replacement</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">searchdata</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_search_query_replacement"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_search_query_replacement"title="Permalink to this definition">¶</a></dt>
<dd><p>This method is called by the search method to allow for direct
replacements of the search string before it is used in the search.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>searchdata</strong> (<em>str</em>) – The search string to replace.</p></li>
<li><p><strong>**kwargs</strong> (<em>any</em>) – These are the same as passed to the <strong>search</strong> method.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>str</em>– The (potentially modified) search string.</p>
<codeclass="sig-name descname">get_search_direct_match</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">searchdata</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_search_direct_match"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_search_direct_match"title="Permalink to this definition">¶</a></dt>
<dd><p>This method is called by the search method to allow for direct
replacements, such as ‘me’ always being an alias for this object.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>searchdata</strong> (<em>str</em>) – The search string to replace.</p></li>
<li><p><strong>**kwargs</strong> (<em>any</em>) – These are the same as passed to the <strong>search</strong> method.</p></li>
<codeclass="sig-name descname">get_search_candidates</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">searchdata</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_search_candidates"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_search_candidates"title="Permalink to this definition">¶</a></dt>
<li><p><strong>attribute_name</strong> (<em>str</em>) – The attribute to search on (default is <ahref="#id85"><spanclass="problematic"id="id86">**</span></a>.</p></li>
<codeclass="sig-name descname">get_stacked_results</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">results</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_stacked_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_stacked_results"title="Permalink to this definition">¶</a></dt>
<dd><p>This method is called by the search method to allow for handling of multi-match
results that should be stacked.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>results</strong> (<em>list</em>) – The list of results from the search.</p>
<codeclass="sig-name descname">handle_search_results</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">searchdata</span></em>, <emclass="sig-param"><spanclass="n">results</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.handle_search_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.handle_search_results"title="Permalink to this definition">¶</a></dt>
<dd><p>This method is called by the search method to allow for handling of the final search result.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>searchdata</strong> (<em>str</em>) – The original search criterion (potentially modified by
<codeclass="sig-name descname">search</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">searchdata</span></em>, <emclass="sig-param"><spanclass="n">global_search</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">use_nicks</span><spanclass="o">=</span><spanclass="default_value">True</span></em>, <emclass="sig-param"><spanclass="n">typeclass</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">location</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">attribute_name</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">quiet</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">exact</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">candidates</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">use_locks</span><spanclass="o">=</span><spanclass="default_value">True</span></em>, <emclass="sig-param"><spanclass="n">nofound_string</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">multimatch_string</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">use_dbref</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">tags</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">stacked</span><spanclass="o">=</span><spanclass="default_value">0</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.search"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.search"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an Object matching a search string/condition</p>
<p>Perform a standard object search in the database, handling
multiple results and lack thereof gracefully. By default, only
objects in the current <strong>location</strong> of <strong>self</strong> or its inventory are searched for.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>searchdata</strong> (<em>str</em><em> or </em><em>obj</em>) –<p>Primary search criterion. Will be matched
against <strong>object.key</strong> (with <strong>object.aliases</strong> second) unless
the keyword attribute_name specifies otherwise.</p>
<p>Special keywords:</p>
<ul>
<li><p><strong>#<num></strong>: search by unique dbref. This is always a global search.</p></li>
<li><p><strong>me,self</strong>: self-reference to this object</p></li>
<li><dlclass="simple">
<dt><strong><num>-<string></strong> - can be used to differentiate</dt><dd><p>between multiple same-named matches. The exact form of this input
is given by <strong>settings.SEARCH_MULTIMATCH_REGEX</strong>.</p>
</dd>
</dl>
</li>
</ul>
</p></li>
<li><p><strong>global_search</strong> (<em>bool</em>) – Search all objects globally. This overrules ‘location’ data.</p></li>
<li><p><strong>use_nicks</strong> (<em>bool</em>) – Use nickname-replace (nicktype “object”) on <strong>searchdata</strong>.</p></li>
<li><p><strong>typeclass</strong> (<em>str</em><em> or </em><em>Typeclass</em><em>, or </em><em>list of either</em>) – Limit search only
to <strong>Objects</strong> with this typeclass. May be a list of typeclasses
for a broader search.</p></li>
<li><p><strong>location</strong> (<em>Object</em><em> or </em><em>list</em>) – Specify a location or multiple locations
to search. Note that this is used to query the <em>contents</em> of a
location and will not match for the location itself -
if you want that, don’t set this or use <strong>candidates</strong> to specify
exactly which objects should be searched. If this nor candidates are
given, candidates will include caller’s inventory, current location and
all objects in the current location.</p></li>
<li><p><strong>attribute_name</strong> (<em>str</em>) – Define which property to search. If set, no
key+alias search will be performed. This can be used
to search database fields (<ahref="#id1"><spanclass="problematic"id="id2">db_</span></a> will be automatically
prepended), and if that fails, it will try to return
objects having Attributes with this name and value
equal to searchdata. A special use is to search for
“key” here if you want to do a key-search without
including aliases.</p></li>
<li><p><strong>quiet</strong> (<em>bool</em>) – don’t display default error messages - this tells the
search method that the user wants to handle all errors
themselves. It also changes the return value type, see
below.</p></li>
<li><p><strong>exact</strong> (<em>bool</em>) – if unset (default) - prefers to match to beginning of
string rather than not matching at all. If set, requires
exact matching of entire string.</p></li>
<li><p><strong>candidates</strong> (<em>list of objects</em>) – this is an optional custom list of objects
to search (filter) between. It is ignored if <strong>global_search</strong>
is given. If not set, this list will automatically be defined
to include the location, the contents of location and the
caller’s contents (inventory).</p></li>
<li><p><strong>use_locks</strong> (<em>bool</em>) – If True (default) - removes search results which
fail the “search” lock.</p></li>
<li><p><strong>nofound_string</strong> (<em>str</em>) – optional custom string for not-found error message.</p></li>
<li><p><strong>multimatch_string</strong> (<em>str</em>) – optional custom string for multimatch error header.</p></li>
<li><p><strong>use_dbref</strong> (<em>bool</em><em> or </em><em>None</em><em>, </em><em>optional</em>) – If <strong>True</strong>, allow to enter e.g. a query “#123”
to find an object (globally) by its database-id 123. If <strong>False</strong>, the string “#123”
will be treated like a normal string. If <strong>None</strong> (default), the ability to query by
#dbref is turned on if <strong>self</strong> has the permission ‘Builder’ and is turned off
otherwise.</p></li>
<li><p><strong>tags</strong> (<em>list</em><em> or </em><em>tuple</em>) – Find objects matching one or more Tags. This should be one or
more tag definitions on the form <strong>tagname</strong> or <strong>(tagname, tagcategory)</strong>.</p></li>
<li><p><strong>stacked</strong> (<em>int</em><em>, </em><em>optional</em>) – If > 0, multimatches will be analyzed to determine if they
only contains identical objects; these are then assumed ‘stacked’ and no multi-match
<ddclass="field-even"><p><em>Object, None or list</em>– Will return an <strong>Object</strong> or <strong>None</strong> if <strong>quiet=False</strong>. Will return
a <strong>list</strong> with 0, 1 or more matches if <strong>quiet=True</strong>. If <strong>stacked</strong> is a positive integer,
this list may contain all stacked identical matches.</p>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>To find Accounts, use eg. <strong>evennia.account_search</strong>. If
<strong>quiet=False</strong>, error messages will be handled by
<strong>settings.SEARCH_AT_RESULT</strong> and echoed automatically (on
error, return will be <strong>None</strong>). If <strong>quiet=True</strong>, the error
messaging is assumed to be handled by the caller.</p>
<codeclass="sig-name descname">search_account</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">searchdata</span></em>, <emclass="sig-param"><spanclass="n">quiet</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.search_account"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.search_account"title="Permalink to this definition">¶</a></dt>
<dd><p>Simple shortcut wrapper to search for accounts, not characters.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>searchdata</strong> (<em>str</em>) – Search criterion - the key or dbref of the account
to search for. If this is “here” or “me”, search
for the account connected to this object.</p></li>
<li><p><strong>quiet</strong> (<em>bool</em>) – Returns the results as a list rather than
echo eventual standard error messages. Default <strong>False</strong>.</p></li>
<codeclass="sig-name descname">execute_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">raw_string</span></em>, <emclass="sig-param"><spanclass="n">session</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.execute_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.execute_cmd"title="Permalink to this definition">¶</a></dt>
<dd><p>Do something as this object. This is never called normally,
it’s only used when wanting specifically to let an object be
the caller of a command. It makes use of nicks of eventual
connected accounts as well.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>raw_string</strong> (<em>string</em>) – Raw command input</p></li>
<li><p><strong>session</strong> (<aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a><em>, </em><em>optional</em>) – Session to
return results to</p></li>
</ul>
</dd>
<dtclass="field-even">Keyword Arguments</dt>
<ddclass="field-even"><ulclass="simple">
<li><p><strong>keyword arguments will be added to the found command</strong> (<em>Other</em>) –</p></li>
<li><p><strong>instace as variables before it executes. This is</strong> (<aclass="reference internal"href="evennia.scripts.models.html#evennia.scripts.models.ScriptDB.object"title="evennia.scripts.models.ScriptDB.object"><em>object</em></a>) –</p></li>
<li><p><strong>by default Evennia but may be used to set flags and</strong> (<em>unused</em>) –</p></li>
<li><p><strong>operating paramaters for commands at run-time.</strong> (<em>change</em>) –</p></li>
<codeclass="sig-name descname">msg</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">from_obj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">session</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">options</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.msg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.msg"title="Permalink to this definition">¶</a></dt>
<dd><p>Emits something to a session attached to the object.</p>
<li><p><strong>from_obj</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a><em>, </em><aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a><em>, </em><aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a><em>, or </em><aclass="reference internal"href="evennia.contrib.game_systems.barter.barter.html#evennia.contrib.game_systems.barter.barter.TradeHandler.list"title="evennia.contrib.game_systems.barter.barter.TradeHandler.list"><em>list</em></a>) – object that is sending. If
<li><p><strong>session</strong> (<aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a><em> or </em><aclass="reference internal"href="evennia.contrib.game_systems.barter.barter.html#evennia.contrib.game_systems.barter.barter.TradeHandler.list"title="evennia.contrib.game_systems.barter.barter.TradeHandler.list"><em>list</em></a>) – Session or list of
<codeclass="sig-name descname">for_contents</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">func</span></em>, <emclass="sig-param"><spanclass="n">exclude</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.for_contents"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.for_contents"title="Permalink to this definition">¶</a></dt>
<dd><p>Runs a function on every object contained within this one.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>func</strong> (<em>callable</em>) – Function to call. This must have the
formal call sign func(obj, <strong>kwargs), where obj is the
object currently being processed and ****kwargs</strong> are
passed on from the call to <strong>for_contents</strong>.</p></li>
<li><p><strong>exclude</strong> (<em>list</em><em>, </em><em>optional</em>) – A list of object not to call the
function on.</p></li>
</ul>
</dd>
<dtclass="field-even">Keyword Arguments</dt>
<ddclass="field-even"><p><strong>arguments will be passed to the function for all objects.</strong> (<em>Keyword</em>) –</p>
<li><p><strong>destination</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Reference to the object to move to. This
<codeclass="sig-name descname">clear_exits</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.clear_exits"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.clear_exits"title="Permalink to this definition">¶</a></dt>
<dd><p>Destroys all of the exits and any exits pointing to this
<codeclass="sig-name descname">clear_contents</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.clear_contents"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.clear_contents"title="Permalink to this definition">¶</a></dt>
<dd><p>Moves all objects (accounts/things) to their home location or
<emclass="property">classmethod </em><codeclass="sig-name descname">get_default_lockstring</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">account</span><spanclass="p">:</span><spanclass="n">DefaultAccount</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">caller</span><spanclass="p">:</span><spanclass="n"><aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject">DefaultObject</a></span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_default_lockstring"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_default_lockstring"title="Permalink to this definition">¶</a></dt>
<dd><p>Classmethod called during .create() to determine default locks for the object.</p>
<li><p><strong>account</strong> (<aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a>) – Account to attribute this object to.</p></li>
<li><p><strong>caller</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object which is creating this one.</p></li>
<li><p><strong>account</strong> (<aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a>) – Account to attribute this object to.</p></li>
<li><p><strong>caller</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object which is creating this one.</p></li>
<li><p><strong>description</strong> (<em>str</em>) – Brief description for this object.</p></li>
<li><p><strong>ip</strong> (<em>str</em>) – IP address of creator (for object auditing).</p></li>
<li><p><strong>method</strong> (<em>str</em>) – The method of creation. Defaults to “create”.</p></li>
<codeclass="sig-name descname">copy</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">new_key</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.copy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.copy"title="Permalink to this definition">¶</a></dt>
<dd><p>Makes an identical copy of this object, identical except for a
new dbref in the database. If you want to customize the copy
by changing some settings, use ObjectDB.object.copy_object()
directly.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>new_key</strong> (<em>string</em>) – New key/name of copied object. If new_key is not
specified, the copy will be named <old_key>_copy by default.</p>
<codeclass="sig-name descname">at_object_post_copy</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">new_obj</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_object_post_copy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_object_post_copy"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by DefaultObject.copy(). Meant to be overloaded. In case there’s extra data not
covered by .copy(), this can be used to deal with it.</p>
<ddclass="field-odd"><p><strong>new_obj</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The new Copy of this object.</p>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.delete"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes this object. Before deletion, this method makes sure
to move all contained objects to their respective home
locations, as well as clean up all exits to/from the object.</p>
<codeclass="sig-name descname">access</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">access_type</span><spanclass="o">=</span><spanclass="default_value">'read'</span></em>, <emclass="sig-param"><spanclass="n">default</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">no_superuser_bypass</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.access"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.access"title="Permalink to this definition">¶</a></dt>
<dd><p>Determines if another object has permission to access this object
<li><p><strong>accessing_obj</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Object trying to access this one.</p></li>
<codeclass="sig-name descname">filter_visible</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj_list</span></em>, <emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.filter_visible"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.filter_visible"title="Permalink to this definition">¶</a></dt>
<dd><p>Filter a list of objects to only include those that are visible to the looker.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>obj_list</strong> (<em>list</em>) – List of objects to filter.</p></li>
<codeclass="sig-name descname">get_display_name</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_display_name"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_display_name"title="Permalink to this definition">¶</a></dt>
<dd><p>Displays the name of the object in a viewer-aware manner.</p>
<ddclass="field-odd"><p><strong>looker</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object or account that is looking at or getting information
<codeclass="sig-name descname">get_extra_display_name_info</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_extra_display_name_info"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_extra_display_name_info"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds any extra display information to the object’s name. By default this is is the
object’s dbref in parentheses, if the looker has permission to see it.</p>
<ddclass="field-odd"><p><strong>looker</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object looking at this object.</p>
<codeclass="sig-name descname">get_numbered_name</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">count</span></em>, <emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_numbered_name"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_numbered_name"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the numbered (singular, plural) forms of this object’s key. This is by default called
by return_appearance and is used for grouping multiple same-named of this object. Note that
this will be called on <em>every</em> member of a group even though the plural name will be only
shown once. Also the singular display version, such as ‘an apple’, ‘a tree’ is determined
from this method.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>count</strong> (<em>int</em>) – Number of objects of this type</p></li>
<li><p><strong>looker</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Onlooker. Not used by default.</p></li>
<codeclass="sig-name descname">get_display_header</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_display_header"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_display_header"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the ‘header’ component of the object description. Called by <strong>return_appearance</strong>.</p>
<codeclass="sig-name descname">get_display_desc</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_display_desc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_display_desc"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the ‘desc’ component of the object description. Called by <strong>return_appearance</strong>.</p>
<codeclass="sig-name descname">get_display_exits</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_display_exits"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_display_exits"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the ‘exits’ component of the object description. Called by <strong>return_appearance</strong>.</p>
<codeclass="sig-name descname">get_display_characters</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_display_characters"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_display_characters"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the ‘characters’ component of the object description. Called by <strong>return_appearance</strong>.</p>
<codeclass="sig-name descname">get_display_things</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_display_things"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_display_things"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the ‘things’ component of the object description. Called by <strong>return_appearance</strong>.</p>
<codeclass="sig-name descname">get_display_footer</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_display_footer"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_display_footer"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the ‘footer’ component of the object description. Called by <strong>return_appearance</strong>.</p>
<codeclass="sig-name descname">format_appearance</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">appearance</span></em>, <emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.format_appearance"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.format_appearance"title="Permalink to this definition">¶</a></dt>
<dd><p>Final processing of the entire appearance string. Called by <strong>return_appearance</strong>.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>appearance</strong> (<em>str</em>) – The compiled appearance string.</p></li>
<codeclass="sig-name descname">return_appearance</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.return_appearance"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.return_appearance"title="Permalink to this definition">¶</a></dt>
<dd><p>Main callback used by ‘look’ for the object to describe itself.
This formats a description. By default, this looks for the <strong>appearance_template</strong>
<li><p><strong>looker</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Object doing the looking. Passed into all helper methods.</p></li>
<codeclass="sig-name descname">at_first_save</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_first_save"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_first_save"title="Permalink to this definition">¶</a></dt>
<dd><p>This is called by the typeclass system whenever an instance of
this class is saved for the first time. It is a generic hook
for calling the startup hooks for the various game entities.
When overloading you generally don’t overload this but
<codeclass="sig-name descname">basetype_setup</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.basetype_setup"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.basetype_setup"title="Permalink to this definition">¶</a></dt>
<dd><p>This sets up the default properties of an Object, just before
the more general at_object_creation.</p>
<p>You normally don’t need to change this unless you change some
fundamental things like names of permission groups.</p>
<codeclass="sig-name descname">basetype_posthook_setup</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.basetype_posthook_setup"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.basetype_posthook_setup"title="Permalink to this definition">¶</a></dt>
<dd><p>Called once, after basetype_setup and at_object_creation. This
should generally not be overloaded unless you are redefining
how a room/exit/object works. It allows for basetype-like
setup after the object is created. An example of this is
EXITs, who need to know keys, aliases, locks etc to set up
<codeclass="sig-name descname">at_object_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_object_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_object_creation"title="Permalink to this definition">¶</a></dt>
<dd><p>Called once, when this object is first created. This is the
normal hook to overload for most object types.</p>
<codeclass="sig-name descname">at_object_post_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_object_post_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_object_post_creation"title="Permalink to this definition">¶</a></dt>
<dd><p>Called once, when this object is first created and after any attributes, tags, etc.
that were passed to the <strong>create_object</strong> function or defined in a prototype have been
<codeclass="sig-name descname">at_object_delete</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_object_delete"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_object_delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before the database object is persistently
delete()d from the database. If this method returns False,
<codeclass="sig-name descname">at_object_post_spawn</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">prototype</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_object_post_spawn"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_object_post_spawn"title="Permalink to this definition">¶</a></dt>
<dd><p>Called when this object is spawned or updated from a prototype, after all other
hooks have been run.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Keyword Arguments</dt>
<ddclass="field-odd"><p><strong>prototype</strong> (<em>dict</em>) – The prototype that was used to spawn or update this object.</p>
<codeclass="sig-name descname">at_init</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_init"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_init"title="Permalink to this definition">¶</a></dt>
<dd><p>This is always called whenever this object is initiated –
that is, whenever it its typeclass is cached from memory. This
happens on-demand first time the object is used or activated
in some way after being created but also after each server
<codeclass="sig-name descname">at_cmdset_get</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/objects/objects.html#DefaultObject.at_cmdset_get"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_cmdset_get"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before cmdsets on this object are requested by the
command handler. If changes need to be done on the fly to the
cmdset before passing them on to the cmdhandler, this is the
place to do it. This is called also if the object currently
<li><p><strong>caller</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a><em>, </em><aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a><em> or </em><aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a>) – The object requesting the cmdsets.</p></li>
<li><p><strong>current</strong> (<aclass="reference internal"href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet"title="evennia.commands.cmdset.CmdSet"><em>CmdSet</em></a>) – The current merged cmdset.</p></li>
<li><p><strong>force_init</strong> (<em>bool</em>) – If <strong>True</strong>, force a re-build of the cmdset. (seems unused)</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary input for overloads.</p></li>
<codeclass="sig-name descname">get_cmdsets</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caller</span></em>, <emclass="sig-param"><spanclass="n">current</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_cmdsets"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_cmdsets"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the CommandHandler to get a list of cmdsets to merge.</p>
<li><p><strong>caller</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object requesting the cmdsets.</p></li>
<codeclass="sig-name descname">at_pre_puppet</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">account</span></em>, <emclass="sig-param"><spanclass="n">session</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_pre_puppet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_pre_puppet"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before an Account connects to this object to puppet
<li><p><strong>account</strong> (<aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a>) – This is the connecting account.</p></li>
<codeclass="sig-name descname">at_post_puppet</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/objects/objects.html#DefaultObject.at_post_puppet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_post_puppet"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just after puppeting has been completed and all
Account<->Object links have been established.</p>
<codeclass="sig-name descname">at_pre_unpuppet</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/objects/objects.html#DefaultObject.at_pre_unpuppet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_pre_unpuppet"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before beginning to un-connect a puppeting from
<codeclass="sig-name descname">at_post_unpuppet</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">account</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">session</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_post_unpuppet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_post_unpuppet"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just after the Account successfully disconnected from
<li><p><strong>account</strong> (<aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a>) – The account object that just disconnected
from this object. This can be <strong>None</strong> if this is called
automatically (such as after a cleanup operation).</p></li>
<li><p><strong>session</strong> (<aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a>) – Session id controlling the connection that
<codeclass="sig-name descname">at_server_reload</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_server_reload"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_server_reload"title="Permalink to this definition">¶</a></dt>
<dd><p>This hook is called whenever the server is shutting down for
restart/reboot. If you want to, for example, save non-persistent
properties across a restart, this is the place to do it.</p>
<codeclass="sig-name descname">at_server_shutdown</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_server_shutdown"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_server_shutdown"title="Permalink to this definition">¶</a></dt>
<dd><p>This hook is called whenever the server is shutting down fully
<codeclass="sig-name descname">at_access</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">result</span></em>, <emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">access_type</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_access"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_access"title="Permalink to this definition">¶</a></dt>
<dd><p>This is called with the result of an access call, along with
any kwargs used for that call. The return of this method does
not affect the result of the lock check. It can be used e.g. to
customize error messages in a central location or other effects
based on the access result.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>result</strong> (<em>bool</em>) – The outcome of the access call.</p></li>
<li><p><strong>accessing_obj</strong> (<em>Object</em><em> or </em><em>Account</em>) – The entity trying to gain access.</p></li>
<li><p><strong>access_type</strong> (<em>str</em>) – The type of access that was requested.</p></li>
<codeclass="sig-name descname">at_pre_move</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">destination</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_pre_move"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_pre_move"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before starting to move this object to
<li><p><strong>destination</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object we are moving to</p></li>
<codeclass="sig-name descname">at_pre_object_leave</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">leaving_object</span></em>, <emclass="sig-param"><spanclass="n">destination</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_pre_object_leave"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_pre_object_leave"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before this object is about lose an object that was
previously ‘inside’ it. Return False to abort move.</p>
<li><p><strong>leaving_object</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object that is about to leave.</p></li>
<li><p><strong>destination</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Where object is going to.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_pre_object_receive</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">arriving_object</span></em>, <emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_pre_object_receive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_pre_object_receive"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before this object received another object. If this
method returns <strong>False</strong>, the move is aborted and the moved entity
<li><p><strong>arriving_object</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object moved into this one</p></li>
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Where <strong>moved_object</strong> came from.
<codeclass="sig-name descname">at_before_move</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">destination</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_before_move"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before starting to move this object to
<li><p><strong>destination</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object we are moving to</p></li>
<codeclass="sig-name descname">announce_move_from</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">destination</span></em>, <emclass="sig-param"><spanclass="n">msg</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">mapping</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.announce_move_from"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.announce_move_from"title="Permalink to this definition">¶</a></dt>
<dd><p>Called if the move is to be announced. This is
<li><p><strong>destination</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The place we are going to.</p></li>
<codeclass="sig-name descname">announce_move_to</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">msg</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">mapping</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.announce_move_to"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.announce_move_to"title="Permalink to this definition">¶</a></dt>
<dd><p>Called after the move if the move was not quiet. At this point
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The place we came from</p></li>
<codeclass="sig-name descname">at_post_move</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_post_move"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_post_move"title="Permalink to this definition">¶</a></dt>
<dd><p>Called after move has completed, regardless of quiet mode or
not. Allows changes to the object due to the location it is
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Where we came from. This may be <strong>None</strong>.</p></li>
<codeclass="sig-name descname">at_after_move</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_after_move"title="Permalink to this definition">¶</a></dt>
<dd><p>Called after move has completed, regardless of quiet mode or
not. Allows changes to the object due to the location it is
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Where we came from. This may be <strong>None</strong>.</p></li>
<codeclass="sig-name descname">at_object_leave</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">moved_obj</span></em>, <emclass="sig-param"><spanclass="n">target_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_object_leave"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_object_leave"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before an object leaves from inside this object</p>
<li><p><strong>moved_obj</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object leaving</p></li>
<li><p><strong>target_location</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Where <strong>moved_obj</strong> is going.</p></li>
<codeclass="sig-name descname">at_object_receive</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">moved_obj</span></em>, <emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_object_receive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_object_receive"title="Permalink to this definition">¶</a></dt>
<dd><p>Called after an object has been moved into this object.</p>
<li><p><strong>moved_obj</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object moved into this one</p></li>
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Where <strong>moved_object</strong> came from.
<codeclass="sig-name descname">at_traverse</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">traversing_object</span></em>, <emclass="sig-param"><spanclass="n">target_location</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_traverse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_traverse"title="Permalink to this definition">¶</a></dt>
<dd><p>This hook is responsible for handling the actual traversal,
normally by calling
<strong>traversing_object.move_to(target_location)</strong>. It is normally
only implemented by Exit objects. If it returns False (usually
because <strong>move_to</strong> returned False), <strong>at_post_traverse</strong> below
should not be called and instead <strong>at_failed_traverse</strong> should be
<li><p><strong>target_location</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Where target is going.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_post_traverse</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">traversing_object</span></em>, <emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_post_traverse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_post_traverse"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just after an object successfully used this object to
traverse to another object (i.e. this object is a type of
<li><p><strong>traversing_object</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object traversing us.</p></li>
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Where <strong>traversing_object</strong> came from.</p></li>
<codeclass="sig-name descname">at_after_traverse</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">traversing_object</span></em>, <emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_after_traverse"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just after an object successfully used this object to
traverse to another object (i.e. this object is a type of
<li><p><strong>traversing_object</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object traversing us.</p></li>
<li><p><strong>source_location</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Where <strong>traversing_object</strong> came from.</p></li>
<codeclass="sig-name descname">at_failed_traverse</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">traversing_object</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_failed_traverse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_failed_traverse"title="Permalink to this definition">¶</a></dt>
<dd><p>This is called if an object fails to traverse this object for
<li><p><strong>traversing_object</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object that failed traversing us.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_msg_receive</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">from_obj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_msg_receive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_msg_receive"title="Permalink to this definition">¶</a></dt>
<dd><p>This hook is called whenever someone sends a message to this
object using the <strong>msg</strong> method.</p>
<p>Note that from_obj may be None if the sender did not include
itself as an argument to the obj.msg() call - so you have to
check for this. .</p>
<p>Consider this a pre-processing method before msg is passed on
to the user session. If this method returns False, the msg
will not be passed on.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>text</strong> (<em>str</em><em>, </em><em>optional</em>) – The message received.</p></li>
<li><p><strong>from_obj</strong> (<em>any</em><em>, </em><em>optional</em>) – The object sending the message.</p></li>
<codeclass="sig-name descname">at_msg_send</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">to_obj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_msg_send"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_msg_send"title="Permalink to this definition">¶</a></dt>
<dd><p>This is a hook that is called when <em>this</em> object sends a
message to another object with <strong>obj.msg(text, to_obj=obj)</strong>.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>text</strong> (<em>str</em><em>, </em><em>optional</em>) – Text to send.</p></li>
<li><p><strong>to_obj</strong> (<em>any</em><em>, </em><em>optional</em>) – The object to send to.</p></li>
<codeclass="sig-name descname">get_visible_contents</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_visible_contents"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_visible_contents"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get_content_names</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.get_content_names"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.get_content_names"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_look</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">target</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_look"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_look"title="Permalink to this definition">¶</a></dt>
<dd><p>Called when this object performs a look. It allows to
customize just what this means. It will not itself
<li><p><strong>target</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The target being looked at. This is
<codeclass="sig-name descname">at_desc</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">looker</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_desc"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_desc"title="Permalink to this definition">¶</a></dt>
<dd><p>This is called whenever someone looks at this object.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>looker</strong> (<em>Object</em><em>, </em><em>optional</em>) – The object requesting the description.</p></li>
<codeclass="sig-name descname">at_pre_get</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">getter</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_pre_get"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_pre_get"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the default <strong>get</strong> command before this object has been
<li><p><strong>getter</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object about to get this object.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_before_get</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">getter</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_before_get"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the default <strong>get</strong> command before this object has been
<li><p><strong>getter</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object about to get this object.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_get</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">getter</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_get"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_get"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the default <strong>get</strong> command when this object has been
<li><p><strong>getter</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object getting this object.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_pre_give</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">giver</span></em>, <emclass="sig-param"><spanclass="n">getter</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_pre_give"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_pre_give"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the default <strong>give</strong> command before this object has been
<li><p><strong>giver</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object about to give this object.</p></li>
<li><p><strong>getter</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object about to get this object.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_before_give</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">giver</span></em>, <emclass="sig-param"><spanclass="n">getter</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_before_give"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the default <strong>give</strong> command before this object has been
<li><p><strong>giver</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object about to give this object.</p></li>
<li><p><strong>getter</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object about to get this object.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_give</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">giver</span></em>, <emclass="sig-param"><spanclass="n">getter</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_give"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_give"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the default <strong>give</strong> command when this object has been
<li><p><strong>giver</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object giving this object.</p></li>
<li><p><strong>getter</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object getting this object.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_pre_drop</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">dropper</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_pre_drop"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_pre_drop"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the default <strong>drop</strong> command before this object has been
<li><p><strong>dropper</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object which will drop this object.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_before_drop</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">dropper</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_before_drop"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the default <strong>drop</strong> command before this object has been
<li><p><strong>dropper</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object which will drop this object.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_drop</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">dropper</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_drop"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_drop"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the default <strong>drop</strong> command when this object has been
<li><p><strong>dropper</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object which just dropped this object.</p></li>
<li><p><strong>**kwargs</strong>– Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_pre_say</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">message</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_pre_say"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_pre_say"title="Permalink to this definition">¶</a></dt>
<dd><p>Before the object says something.</p>
<p>This hook is by default used by the ‘say’ and ‘whisper’
commands as used by this command it is called before the text
is said/whispered and can be used to customize the outgoing
text from the object. Returning <strong>None</strong> aborts the command.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>message</strong> (<em>str</em>) – The suggested say/whisper text spoken by self.</p>
</dd>
<dtclass="field-even">Keyword Arguments</dt>
<ddclass="field-even"><ulclass="simple">
<li><p><strong>whisper</strong> (<em>bool</em>) – If True, this is a whisper rather than
a say. This is sent by the whisper command by default.
Other verbal commands could use this hook in similar
<li><p><strong>receivers</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a><em> or </em><em>iterable</em>) – If set, this is the target or targets for the
<codeclass="sig-name descname">at_before_say</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">message</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_before_say"title="Permalink to this definition">¶</a></dt>
<dd><p>Before the object says something.</p>
<p>This hook is by default used by the ‘say’ and ‘whisper’
commands as used by this command it is called before the text
is said/whispered and can be used to customize the outgoing
text from the object. Returning <strong>None</strong> aborts the command.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>message</strong> (<em>str</em>) – The suggested say/whisper text spoken by self.</p>
</dd>
<dtclass="field-even">Keyword Arguments</dt>
<ddclass="field-even"><ulclass="simple">
<li><p><strong>whisper</strong> (<em>bool</em>) – If True, this is a whisper rather than
a say. This is sent by the whisper command by default.
Other verbal commands could use this hook in similar
<li><p><strong>receivers</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a><em> or </em><em>iterable</em>) – If set, this is the target or targets for the
<codeclass="sig-name descname">at_say</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">message</span></em>, <emclass="sig-param"><spanclass="n">msg_self</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">msg_location</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">receivers</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">msg_receivers</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_say"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_say"title="Permalink to this definition">¶</a></dt>
<dd><p>Display the actual say (or whisper) of self.</p>
<p>This hook should display the actual say/whisper of the object in its
location. It should both alert the object (self) and its
location that some text is spoken. The overriding of messages or
<strong>mapping</strong> allows for simple customization of the hook without
re-writing it completely.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>message</strong> (<em>str</em>) – The message to convey.</p></li>
<li><p><strong>msg_self</strong> (<em>bool</em><em> or </em><em>str</em><em>, </em><em>optional</em>) – If boolean True, echo <strong>message</strong> to self. If a string,
return that message. If False or unset, don’t echo to self.</p></li>
<li><p><strong>msg_location</strong> (<em>str</em><em>, </em><em>optional</em>) – The message to echo to self’s location.</p></li>
<li><p><strong>receivers</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a><em> or </em><em>iterable</em><em>, </em><em>optional</em>) – An eventual receiver or receivers of the
<codeclass="sig-name descname">at_rename</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">oldname</span></em>, <emclass="sig-param"><spanclass="n">newname</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultObject.at_rename"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.at_rename"title="Permalink to this definition">¶</a></dt>
<dd><p>This Hook is called by @name on a successful rename.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>oldname</strong> (<em>str</em>) – The instance’s original name.</p></li>
<li><p><strong>newname</strong> (<em>str</em>) – The new name for the instance.</p></li>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.objects.objects.DefaultObject'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'DefaultObject'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultObject.typename"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="evennia.objects.objects.DefaultCharacter">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.objects.objects.</code><codeclass="sig-name descname">DefaultCharacter</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultCharacter"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lockstring</code><emclass="property"> = 'puppet:id({character_id}) or pid({account_id}) or perm(Developer) or pperm(Developer);delete:id({account_id}) or perm(Admin);edit:pid({account_id}) or perm(Admin)'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.lockstring"title="Permalink to this definition">¶</a></dt>
<emclass="property">classmethod </em><codeclass="sig-name descname">get_default_lockstring</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">account</span><spanclass="p">:</span><spanclass="n">DefaultAccount</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">caller</span><spanclass="p">:</span><spanclass="n"><aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject">DefaultObject</a></span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultCharacter.get_default_lockstring"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.get_default_lockstring"title="Permalink to this definition">¶</a></dt>
<dd><p>Classmethod called during .create() to determine default locks for the object.</p>
<li><p><strong>account</strong> (<aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a>) – Account to attribute this object to.</p></li>
<li><p><strong>caller</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object which is creating this one.</p></li>
<dd><p>Creates a basic Character with default parameters, unless otherwise
specified or extended.</p>
<p>Provides a friendlier interface to the utils.create_character() function.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>key</strong> (<em>str</em>) – Name of the new Character.</p></li>
<li><p><strong>account</strong> (<em>obj</em><em>, </em><em>optional</em>) – Account to associate this Character with.
If unset supplying None– it will
change the default lockset and skip creator attribution.</p></li>
</ul>
</dd>
<dtclass="field-even">Keyword Arguments</dt>
<ddclass="field-even"><ulclass="simple">
<li><p><strong>description</strong> (<em>str</em>) – Brief description for this object.</p></li>
<li><p><strong>ip</strong> (<em>str</em>) – IP address of creator (for object auditing).</p></li>
<li><p><strong>other kwargs will be passed into the create_object call.</strong> (<em>All</em>) –</p></li>
</ul>
</dd>
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><em>tuple</em>–<strong>(new_character, errors)</strong>. On error, the <strong>new_character</strong> is <strong>None</strong> and
<strong>errors</strong> is a <strong>list</strong> of error strings (an empty list otherwise).</p>
<emclass="property">classmethod </em><codeclass="sig-name descname">normalize_name</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">name</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultCharacter.normalize_name"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.normalize_name"title="Permalink to this definition">¶</a></dt>
<emclass="property">classmethod </em><codeclass="sig-name descname">validate_name</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">name</span></em>, <emclass="sig-param"><spanclass="n">account</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span>→ Optional<spanclass="p">[</span>str<spanclass="p">, </span>None<spanclass="p">]</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultCharacter.validate_name"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.validate_name"title="Permalink to this definition">¶</a></dt>
<dd><p>Validate the character name prior to creating. Overload this function to add custom validators</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>name</strong> (<em>str</em>) – The name of the character</p>
<ddclass="field-even"><p><strong>account</strong> (<aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a><em>, </em><em>optional</em>) – The account creating the character.</p>
<codeclass="sig-name descname">basetype_setup</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultCharacter.basetype_setup"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.basetype_setup"title="Permalink to this definition">¶</a></dt>
<dd><p>Setup character-specific security.</p>
<p>You should normally not need to overload this, but if you do,
make sure to reproduce at least the two last commands in this
method (unless you want to fundamentally change how a
<codeclass="sig-name descname">at_post_move</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultCharacter.at_post_move"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.at_post_move"title="Permalink to this definition">¶</a></dt>
<dd><p>We make sure to look around after a move.</p>
<codeclass="sig-name descname">at_after_move</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">source_location</span></em>, <emclass="sig-param"><spanclass="n">move_type</span><spanclass="o">=</span><spanclass="default_value">'move'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.at_after_move"title="Permalink to this definition">¶</a></dt>
<dd><p>We make sure to look around after a move.</p>
<codeclass="sig-name descname">at_pre_puppet</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">account</span></em>, <emclass="sig-param"><spanclass="n">session</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultCharacter.at_pre_puppet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.at_pre_puppet"title="Permalink to this definition">¶</a></dt>
<dd><p>Return the character from storage in None location in <strong>at_post_unpuppet</strong>.
<codeclass="sig-name descname">at_post_puppet</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/objects/objects.html#DefaultCharacter.at_post_puppet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.at_post_puppet"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just after puppeting has been completed and all
Account<->Object links have been established.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_post_unpuppet</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">account</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">session</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultCharacter.at_post_unpuppet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.at_post_unpuppet"title="Permalink to this definition">¶</a></dt>
<dd><p>We stove away the character when the account goes ooc/logs off,
otherwise the character object will remain in the room also
after the account logged off (“headless”, so to say).</p>
<li><p><strong>account</strong> (<aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a>) – The account object that just disconnected
<li><p><strong>session</strong> (<aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a>) – Session controlling the connection that
just disconnected.</p></li>
</ul>
</dd>
<dtclass="field-even">Keyword Arguments</dt>
<ddclass="field-even"><ulclass="simple">
<li><p><strong>reason</strong> (<em>str</em>) – If given, adds a reason for the unpuppet. This
is set when the user is auto-unpuppeted due to being link-dead.</p></li>
<emclass="property">property </em><codeclass="sig-name descname">idle_time</code><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.idle_time"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the idle time of the least idle session in seconds. If
<emclass="property">property </em><codeclass="sig-name descname">connection_time</code><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.connection_time"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the maximum connection time of all connected sessions
in seconds. Returns nothing if there are no sessions.</p>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.objects.objects.DefaultCharacter'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'DefaultCharacter'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultCharacter.typename"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="evennia.objects.objects.DefaultRoom">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.objects.objects.</code><codeclass="sig-name descname">DefaultRoom</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultRoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultRoom"title="Permalink to this definition">¶</a></dt>
<emclass="property">classmethod </em><codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">key</span><spanclass="p">:</span><spanclass="n">str</span></em>, <emclass="sig-param"><spanclass="n">account</span><spanclass="p">:</span><spanclass="n">DefaultAccount</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">caller</span><spanclass="p">:</span><spanclass="n"><aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject">evennia.objects.objects.DefaultObject</a></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">'create'</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultRoom.create"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultRoom.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a basic Room with default parameters, unless otherwise
specified or extended.</p>
<p>Provides a friendlier interface to the utils.create_object() function.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>key</strong> (<em>str</em>) – Name of the new Room.</p>
</dd>
<dtclass="field-even">Keyword Arguments</dt>
<ddclass="field-even"><ulclass="simple">
<li><p><strong>account</strong> (<aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a><em>, </em><em>optional</em>) – Account to associate this Room with. If
given, it will be given specific control/edit permissions to this
object (along with normal Admin perms). If not given, default</p></li>
<li><p><strong>caller</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object which is creating this one.</p></li>
<li><p><strong>description</strong> (<em>str</em>) – Brief description for this object.</p></li>
<li><p><strong>ip</strong> (<em>str</em>) – IP address of creator (for object auditing).</p></li>
<li><p><strong>method</strong> (<em>str</em>) – The method used to create the room. Defaults to “create”.</p></li>
<codeclass="sig-name descname">basetype_setup</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultRoom.basetype_setup"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultRoom.basetype_setup"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.objects.objects.DefaultRoom.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.objects.objects.DefaultRoom.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.objects.objects.DefaultRoom'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultRoom.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'DefaultRoom'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultRoom.typename"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="evennia.objects.objects.ExitCommand">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.objects.objects.</code><codeclass="sig-name descname">ExitCommand</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/objects/objects.html#ExitCommand"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ExitCommand"title="Permalink to this definition">¶</a></dt>
<p>This is a command that simply cause the caller to traverse
the object it is attached to.</p>
<dlclass="py attribute">
<dtid="evennia.objects.objects.ExitCommand.obj">
<codeclass="sig-name descname">obj</code><emclass="property"> = None</em><aclass="headerlink"href="#evennia.objects.objects.ExitCommand.obj"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="evennia.objects.objects.ExitCommand.func">
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#ExitCommand.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ExitCommand.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Default exit traverse if no syscommand is defined.</p>
<codeclass="sig-name descname">get_extra_info</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">caller</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#ExitCommand.get_extra_info"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.ExitCommand.get_extra_info"title="Permalink to this definition">¶</a></dt>
<dd><p>Shows a bit of information on where the exit leads.</p>
<li><p><strong>caller</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object (usually a character) that entered an ambiguous command.</p></li>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.objects.objects.ExitCommand.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.objects.objects.ExitCommand.help_category"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py attribute">
<dtid="evennia.objects.objects.ExitCommand.key">
<codeclass="sig-name descname">key</code><emclass="property"> = 'command'</em><aclass="headerlink"href="#evennia.objects.objects.ExitCommand.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.objects.objects.ExitCommand.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 command that simply cause the caller to traverse\n the object it is attached to.\n\n '}</em><aclass="headerlink"href="#evennia.objects.objects.ExitCommand.search_index_entry"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="evennia.objects.objects.DefaultExit">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.objects.objects.</code><codeclass="sig-name descname">DefaultExit</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultExit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultExit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">exit_command</code><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.exit_command"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="#evennia.objects.objects.ExitCommand"title="evennia.objects.objects.ExitCommand"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExitCommand</span></code></a></p>
<codeclass="sig-name descname">priority</code><emclass="property"> = 101</em><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.priority"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">create_exit_cmdset</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">exidbobj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultExit.create_exit_cmdset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.create_exit_cmdset"title="Permalink to this definition">¶</a></dt>
<dd><p>Helper function for creating an exit command set + command.</p>
<p>The command of this cmdset has the same name as the Exit
object and allows the exit to react when the account enter the
exit’s name, triggering the movement between rooms.</p>
<ddclass="field-odd"><p><strong>exidbobj</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The DefaultExit object to base the command on.</p>
<li><p><strong>account</strong> (<em>DefaultAccountDB</em>) – Account to associate this Exit with.</p></li>
<li><p><strong>caller</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The Object creating this Object.</p></li>
<codeclass="sig-name descname">basetype_setup</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultExit.basetype_setup"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.basetype_setup"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_get</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/objects/objects.html#DefaultExit.at_cmdset_get"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.at_cmdset_get"title="Permalink to this definition">¶</a></dt>
<dd><p>Called just before cmdsets on this object are requested by the
command handler. If changes need to be done on the fly to the
cmdset before passing them on to the cmdhandler, this is the
place to do it. This is called also if the object currently
<li><p><strong>caller</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a><em>, </em><aclass="reference internal"href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount"title="evennia.accounts.accounts.DefaultAccount"><em>DefaultAccount</em></a><em> or </em><aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a>) – The object requesting the cmdsets.</p></li>
<li><p><strong>current</strong> (<aclass="reference internal"href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet"title="evennia.commands.cmdset.CmdSet"><em>CmdSet</em></a>) – The current merged cmdset.</p></li>
<li><p><strong>force_init</strong> (<em>bool</em>) – If <strong>True</strong>, force a re-build of the cmdset
<codeclass="sig-name descname">at_init</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultExit.at_init"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.at_init"title="Permalink to this definition">¶</a></dt>
<dd><p>This is called when this objects is re-loaded from cache. When
that happens, we make sure to remove any old ExitCmdSet cmdset
(this most commonly occurs when renaming an existing exit)</p>
<codeclass="sig-name descname">at_traverse</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">traversing_object</span></em>, <emclass="sig-param"><spanclass="n">target_location</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultExit.at_traverse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.at_traverse"title="Permalink to this definition">¶</a></dt>
<dd><p>This implements the actual traversal. The traverse lock has
already been checked (in the Exit command) at this point.</p>
<li><p><strong>target_location</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – Where target is going.</p></li>
<codeclass="sig-name descname">at_failed_traverse</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">traversing_object</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultExit.at_failed_traverse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.at_failed_traverse"title="Permalink to this definition">¶</a></dt>
<dd><p>Overloads the default hook to implement a simple default error message.</p>
<li><p><strong>traversing_object</strong> (<aclass="reference internal"href="#evennia.objects.objects.DefaultObject"title="evennia.objects.objects.DefaultObject"><em>DefaultObject</em></a>) – The object that failed traversing us.</p></li>
<codeclass="sig-name descname">get_return_exit</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">return_all</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/objects/objects.html#DefaultExit.get_return_exit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.get_return_exit"title="Permalink to this definition">¶</a></dt>
<dd><p>Get the exits that pair with this one in its destination room
(i.e. returns to its location)</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>return_all</strong> (<em>bool</em>) – Whether to return available results as a
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.objects.objects.DefaultExit'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'DefaultExit'</em><aclass="headerlink"href="#evennia.objects.objects.DefaultExit.typename"title="Permalink to this definition">¶</a></dt>
