Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-27 18:26:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.objects.models.html

746 lines
58 KiB
HTML
Raw Normal View History

Updated HTML docs.
2025-08-15 18:14:21 +00:00
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>evennia.objects.models &#8212; Evennia latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.objects.objects" href="evennia.objects.objects.html" />
<link rel="prev" title="evennia.objects.manager" href="evennia.objects.manager.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.objects.objects.html" title="evennia.objects.objects"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.objects.manager.html" title="evennia.objects.manager"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.objects.html" accesskey="U">evennia.objects</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.objects.models</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.objects.models">
<span id="evennia-objects-models"></span><h1>evennia.objects.models<a class="headerlink" href="#module-evennia.objects.models" title="Link to this heading"></a></h1>
<p>This module defines the database models for all in-game objects, that
is, all objects that has an actual existence in-game.</p>
<p>Each database object is ‘decorated’ with a ‘typeclass’, a normal
python class that implements all the various logics needed by the game
in question. Objects created of this class transparently communicate
with its related database object for storing all attributes. The
admin should usually not have to deal directly with this database
object layer.</p>
<p>Attributes are separate objects that store values persistently onto
the database object. Like everything else, they can be accessed
transparently through the decorating TypeClass.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.objects.models.ContentsHandler">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.objects.models.</span></span><span class="sig-name descname"><span class="pre">ContentsHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/models.html#ContentsHandler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ContentsHandler" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Handles and caches the contents of an object to avoid excessive
lookups (this is done very often due to cmdhandler needing to look
for object-cmdsets). It is stored on the ‘contents_cache’ property
of the ObjectDB.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.objects.models.ContentsHandler.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/models.html#ContentsHandler.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ContentsHandler.__init__" title="Link to this definition"></a></dt>
<dd><p>Sets up the contents handler.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>obj</strong> (<em>Object</em>) – The object on which the
handler is defined</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This was changed from using <strong>set</strong> to using <strong>dict</strong> internally
in order to retain insertion order.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.objects.models.ContentsHandler.load">
<span class="sig-name descname"><span class="pre">load</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/models.html#ContentsHandler.load"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ContentsHandler.load" title="Link to this definition"></a></dt>
<dd><p>Retrieves all objects from database. Used for initializing.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Objects (list of ObjectDB)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.objects.models.ContentsHandler.init">
<span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/models.html#ContentsHandler.init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ContentsHandler.init" title="Link to this definition"></a></dt>
<dd><p>Re-initialize the content cache</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.objects.models.ContentsHandler.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/models.html#ContentsHandler.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ContentsHandler.get" title="Link to this definition"></a></dt>
<dd><p>Return the contents of the cache.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>exclude</strong> (<em>Object</em><em> or </em><em>list</em><em> of </em><em>Object</em>) – object(s) to ignore</p></li>
<li><p><strong>content_type</strong> (<em>str</em><em> or </em><em>None</em>) – Filter list by a content-type. If None, don’t filter.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>objects (list)</em> – the Objects inside this location</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.objects.models.ContentsHandler.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/models.html#ContentsHandler.add"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ContentsHandler.add" title="Link to this definition"></a></dt>
<dd><p>Add a new object to this location</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>obj</strong> (<em>Object</em>) – object to add</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.objects.models.ContentsHandler.remove">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/models.html#ContentsHandler.remove"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ContentsHandler.remove" title="Link to this definition"></a></dt>
<dd><p>Remove object from this location</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>obj</strong> (<em>Object</em>) – object to remove</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.objects.models.ContentsHandler.clear">
<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/models.html#ContentsHandler.clear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ContentsHandler.clear" title="Link to this definition"></a></dt>
<dd><p>Clear the contents cache and re-initialize</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.objects.models.</span></span><span class="sig-name descname"><span class="pre">ObjectDB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/models.html#ObjectDB"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ObjectDB" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypedObject</span></code></a></p>
<p>All objects in the game use the ObjectDB model to store
data in the database. This is handled transparently through
the typeclass system.</p>
<p>Note that the base objectdb is very simple, with
few defined fields. Use attributes to extend your
type class with new database-stored variables.</p>
<p>The TypedObject supplies the following (inherited) properties:</p>
<blockquote>
<div><ul class="simple">
<li><p>key - main name</p></li>
<li><p>name - alias for key</p></li>
<li><p>db_typeclass_path - the path to the decorating typeclass</p></li>
<li><p>db_date_created - time stamp of object creation</p></li>
<li><p>permissions - perm strings</p></li>
<li><p>locks - lock definitions (handler)</p></li>
<li><p>dbref - #id of object</p></li>
<li><p>db - persistent attribute storage</p></li>
<li><p>ndb - non-persistent attribute storage</p></li>
</ul>
</div></blockquote>
<p>The ObjectDB adds the following properties:</p>
<blockquote>
<div><ul class="simple">
<li><p>account - optional connected account (always together with sessid)</p></li>
<li><p>sessid - optional connection session id (always together with account)</p></li>
<li><p>location - in-game location of object</p></li>
<li><p>home - safety location for object (handler)</p></li>
<li><p>scripts - scripts assigned to object (handler from typeclass)</p></li>
<li><p>cmdset - active cmdset on object (handler from typeclass)</p></li>
<li><p>aliases - aliases for this object (property)</p></li>
<li><p>nicks - nicknames for <em>other</em> things in Evennia (handler)</p></li>
<li><p>sessions - sessions connected to this object (see also account)</p></li>
<li><p>has_account - bool if an active account is currently connected</p></li>
<li><p>contents - other objects having this object as location</p></li>
<li><p>exits - exits from this object</p></li>
</ul>
</div></blockquote>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_account">
<span class="sig-name descname"><span class="pre">db_account</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_account" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
one-to-one (via ForwardOneToOneDescriptor subclass) relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Child.parent**</strong> is a <strong>**ForwardManyToOneDescriptor**</strong> instance.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_sessid">
<span class="sig-name descname"><span class="pre">db_sessid</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_sessid" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_location">
<span class="sig-name descname"><span class="pre">db_location</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_location" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
one-to-one (via ForwardOneToOneDescriptor subclass) relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Child.parent**</strong> is a <strong>**ForwardManyToOneDescriptor**</strong> instance.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_home">
<span class="sig-name descname"><span class="pre">db_home</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_home" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
one-to-one (via ForwardOneToOneDescriptor subclass) relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Child.parent**</strong> is a <strong>**ForwardManyToOneDescriptor**</strong> instance.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_destination">
<span class="sig-name descname"><span class="pre">db_destination</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_destination" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
one-to-one (via ForwardOneToOneDescriptor subclass) relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Child.parent**</strong> is a <strong>**ForwardManyToOneDescriptor**</strong> instance.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_cmdset_storage">
<span class="sig-name descname"><span class="pre">db_cmdset_storage</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_cmdset_storage" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.objects">
<span class="sig-name descname"><span class="pre">objects</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;evennia.objects.manager.ObjectDBManager</span> <span class="pre">object&gt;</span></em><a class="headerlink" href="#evennia.objects.models.ObjectDB.objects" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.contents_cache">
<span class="sig-name descname"><span class="pre">contents_cache</span></span><a class="reference internal" href="../_modules/evennia/objects/models.html#ObjectDB.contents_cache"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ObjectDB.contents_cache" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.cmdset_storage">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cmdset_storage</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.cmdset_storage" title="Link to this definition"></a></dt>
<dd><p>getter</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.location">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">location</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.location" title="Link to this definition"></a></dt>
<dd><p>Get location</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.at_db_location_postsave">
<span class="sig-name descname"><span class="pre">at_db_location_postsave</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/models.html#ObjectDB.at_db_location_postsave"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.objects.models.ObjectDB.at_db_location_postsave" title="Link to this definition"></a></dt>
<dd><p>This is called automatically after the location field was
saved, no matter how. It checks for a variable
_safe_contents_update to know if the save was triggered via
the location handler (which updates the contents cache) or
not.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>new</strong> (<em>bool</em>) – Set if this location has not yet been saved before.</p>
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.DoesNotExist">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DoesNotExist</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.DoesNotExist" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.dbserialize.html#evennia.utils.dbserialize.ObjectDoesNotExist" title="django.core.exceptions.ObjectDoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectDoesNotExist</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.MultipleObjectsReturned">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MultipleObjectsReturned</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.MultipleObjectsReturned" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></p>
</dd></dl>
Updated HTML docs.
2026-02-15 17:42:43 +00:00
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.NotUpdated">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">NotUpdated</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.NotUpdated" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectNotUpdated</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DatabaseError</span></code></p>
</dd></dl>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<dl class="py property">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.account">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">account</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.account" title="Link to this definition"></a></dt>
<dd><p>A wrapper for getting database field <strong>db_account</strong>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_account_id">
<span class="sig-name descname"><span class="pre">db_account_id</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_account_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_attributes">
<span class="sig-name descname"><span class="pre">db_attributes</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_attributes" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_date_created">
<span class="sig-name descname"><span class="pre">db_date_created</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_date_created" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_destination_id">
<span class="sig-name descname"><span class="pre">db_destination_id</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_destination_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_home_id">
<span class="sig-name descname"><span class="pre">db_home_id</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_home_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_key">
<span class="sig-name descname"><span class="pre">db_key</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_key" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_location_id">
<span class="sig-name descname"><span class="pre">db_location_id</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_location_id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_lock_storage">
<span class="sig-name descname"><span class="pre">db_lock_storage</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_lock_storage" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_tags">
<span class="sig-name descname"><span class="pre">db_tags</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_tags" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.db_typeclass_path">
<span class="sig-name descname"><span class="pre">db_typeclass_path</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.db_typeclass_path" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.destination">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">destination</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.destination" title="Link to this definition"></a></dt>
<dd><p>A wrapper for getting database field <strong>db_destination</strong>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.destinations_set">
<span class="sig-name descname"><span class="pre">destinations_set</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.destinations_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
many-to-one relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Parent.children**</strong> is a <strong>**ReverseManyToOneDescriptor**</strong> instance.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
Updated HTML docs.
2026-02-15 17:42:43 +00:00
class built by <strong>**create_reverse_many_to_one_manager()**</strong> defined below.</p>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.get_next_by_db_date_created">
<span class="sig-name descname"><span class="pre">get_next_by_db_date_created</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field=&lt;django.db.models.fields.DateTimeField:</span> <span class="pre">db_date_created&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_next=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.objects.models.ObjectDB.get_next_by_db_date_created" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.get_previous_by_db_date_created">
<span class="sig-name descname"><span class="pre">get_previous_by_db_date_created</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field=&lt;django.db.models.fields.DateTimeField:</span> <span class="pre">db_date_created&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_next=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.objects.models.ObjectDB.get_previous_by_db_date_created" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.hide_from_objects_set">
<span class="sig-name descname"><span class="pre">hide_from_objects_set</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.hide_from_objects_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.home">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">home</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.home" title="Link to this definition"></a></dt>
<dd><p>A wrapper for getting database field <strong>db_home</strong>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.homes_set">
<span class="sig-name descname"><span class="pre">homes_set</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.homes_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
many-to-one relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Parent.children**</strong> is a <strong>**ReverseManyToOneDescriptor**</strong> instance.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
Updated HTML docs.
2026-02-15 17:42:43 +00:00
class built by <strong>**create_reverse_many_to_one_manager()**</strong> defined below.</p>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.id">
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.id" title="Link to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
object the first time, the query is executed.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.locations_set">
<span class="sig-name descname"><span class="pre">locations_set</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.locations_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
many-to-one relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Parent.children**</strong> is a <strong>**ReverseManyToOneDescriptor**</strong> instance.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
Updated HTML docs.
2026-02-15 17:42:43 +00:00
class built by <strong>**create_reverse_many_to_one_manager()**</strong> defined below.</p>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.object_subscription_set">
<span class="sig-name descname"><span class="pre">object_subscription_set</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.object_subscription_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.objects.models.ObjectDB'</span></em><a class="headerlink" href="#evennia.objects.models.ObjectDB.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.receiver_object_set">
<span class="sig-name descname"><span class="pre">receiver_object_set</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.receiver_object_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.scriptdb_set">
<span class="sig-name descname"><span class="pre">scriptdb_set</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.scriptdb_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
many-to-one relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Child</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">ForeignKey</span><span class="p">(</span><span class="n">Parent</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;children&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Parent.children**</strong> is a <strong>**ReverseManyToOneDescriptor**</strong> instance.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
Updated HTML docs.
2026-02-15 17:42:43 +00:00
class built by <strong>**create_reverse_many_to_one_manager()**</strong> defined below.</p>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.sender_object_set">
<span class="sig-name descname"><span class="pre">sender_object_set</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.sender_object_set" title="Link to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
a many-to-many relation.</p>
<p>In the example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">Pizza</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
<span class="n">toppings</span> <span class="o">=</span> <span class="n">ManyToManyField</span><span class="p">(</span><span class="n">Topping</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s1">&#39;pizzas&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p><strong>**Pizza.toppings**</strong> and <strong>**Topping.pizzas**</strong> are <strong>**ManyToManyDescriptor**</strong>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <strong>**create_forward_many_to_many_manager()**</strong> defined below.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.sessid">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sessid</span></span><a class="headerlink" href="#evennia.objects.models.ObjectDB.sessid" title="Link to this definition"></a></dt>
<dd><p>A wrapper for getting database field <strong>db_sessid</strong>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.objects.models.ObjectDB.typename">
<span class="sig-name descname"><span class="pre">typename</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'SharedMemoryModelBase'</span></em><a class="headerlink" href="#evennia.objects.models.ObjectDB.typename" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.objects.models</a><ul>
<li><a class="reference internal" href="#evennia.objects.models.ContentsHandler"><code class="docutils literal notranslate"><span class="pre">ContentsHandler</span></code></a><ul>
<li><a class="reference internal" href="#evennia.objects.models.ContentsHandler.__init__"><code class="docutils literal notranslate"><span class="pre">ContentsHandler.__init__()</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ContentsHandler.load"><code class="docutils literal notranslate"><span class="pre">ContentsHandler.load()</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ContentsHandler.init"><code class="docutils literal notranslate"><span class="pre">ContentsHandler.init()</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ContentsHandler.get"><code class="docutils literal notranslate"><span class="pre">ContentsHandler.get()</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ContentsHandler.add"><code class="docutils literal notranslate"><span class="pre">ContentsHandler.add()</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ContentsHandler.remove"><code class="docutils literal notranslate"><span class="pre">ContentsHandler.remove()</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ContentsHandler.clear"><code class="docutils literal notranslate"><span class="pre">ContentsHandler.clear()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB"><code class="docutils literal notranslate"><span class="pre">ObjectDB</span></code></a><ul>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_account"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_account</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_sessid"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_sessid</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_location"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_location</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_home"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_home</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_destination"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_destination</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_cmdset_storage"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_cmdset_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.objects"><code class="docutils literal notranslate"><span class="pre">ObjectDB.objects</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.contents_cache"><code class="docutils literal notranslate"><span class="pre">ObjectDB.contents_cache</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.cmdset_storage"><code class="docutils literal notranslate"><span class="pre">ObjectDB.cmdset_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.location"><code class="docutils literal notranslate"><span class="pre">ObjectDB.location</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.at_db_location_postsave"><code class="docutils literal notranslate"><span class="pre">ObjectDB.at_db_location_postsave()</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">ObjectDB.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">ObjectDB.MultipleObjectsReturned</span></code></a></li>
Updated HTML docs.
2026-02-15 17:42:43 +00:00
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.NotUpdated"><code class="docutils literal notranslate"><span class="pre">ObjectDB.NotUpdated</span></code></a></li>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.account"><code class="docutils literal notranslate"><span class="pre">ObjectDB.account</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_account_id"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_account_id</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_attributes"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_attributes</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_date_created"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_date_created</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_destination_id"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_destination_id</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_home_id"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_home_id</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_key"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_key</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_location_id"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_location_id</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_lock_storage"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_tags"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_tags</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.db_typeclass_path"><code class="docutils literal notranslate"><span class="pre">ObjectDB.db_typeclass_path</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.destination"><code class="docutils literal notranslate"><span class="pre">ObjectDB.destination</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.destinations_set"><code class="docutils literal notranslate"><span class="pre">ObjectDB.destinations_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.get_next_by_db_date_created"><code class="docutils literal notranslate"><span class="pre">ObjectDB.get_next_by_db_date_created()</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.get_previous_by_db_date_created"><code class="docutils literal notranslate"><span class="pre">ObjectDB.get_previous_by_db_date_created()</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.hide_from_objects_set"><code class="docutils literal notranslate"><span class="pre">ObjectDB.hide_from_objects_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.home"><code class="docutils literal notranslate"><span class="pre">ObjectDB.home</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.homes_set"><code class="docutils literal notranslate"><span class="pre">ObjectDB.homes_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.id"><code class="docutils literal notranslate"><span class="pre">ObjectDB.id</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.locations_set"><code class="docutils literal notranslate"><span class="pre">ObjectDB.locations_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.object_subscription_set"><code class="docutils literal notranslate"><span class="pre">ObjectDB.object_subscription_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.path"><code class="docutils literal notranslate"><span class="pre">ObjectDB.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.receiver_object_set"><code class="docutils literal notranslate"><span class="pre">ObjectDB.receiver_object_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.scriptdb_set"><code class="docutils literal notranslate"><span class="pre">ObjectDB.scriptdb_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.sender_object_set"><code class="docutils literal notranslate"><span class="pre">ObjectDB.sender_object_set</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.sessid"><code class="docutils literal notranslate"><span class="pre">ObjectDB.sessid</span></code></a></li>
<li><a class="reference internal" href="#evennia.objects.models.ObjectDB.typename"><code class="docutils literal notranslate"><span class="pre">ObjectDB.typename</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.objects.manager.html"
title="previous chapter">evennia.objects.manager</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.objects.objects.html"
title="next chapter">evennia.objects.objects</a></p>
</div>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.objects.models.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Doc Versions</h3>
<ul>
<li>
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.objects.objects.html" title="evennia.objects.objects"
>next</a> |</li>
<li class="right" >
<a href="evennia.objects.manager.html" title="evennia.objects.manager"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.objects.html" >evennia.objects</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.objects.models</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in a new issue Copy permalink