Updated HTML docs

docs/1.0-dev/api/evennia.objects.manager.html

@@ -59,7 +59,7 @@ and manipulating Objects directly from the database.</p>
 lists of Typeclasses, whereas Django-general methods will return
 Querysets or database objects).</p>
 <p>dbref (converter)
-get_id (alias: dbref_search)
+dbref_search
 get_dbref_range
 object_totals
 typeclass_search
@@ -149,8 +149,12 @@ objects.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns</dt>
-<dd class="field-even"><p><em>matches (query)</em> – Objects fullfilling both the <strong>attribute_name</strong> and
-<strong>attribute_value</strong> criterions.</p>
+<dd class="field-even"><p><p><em>Queryset</em> –</p>
+<dl class="simple">
+<dt>Iterable with 0, 1 or more matches fullfilling both the <strong>attribute_name</strong> and</dt><dd><p><strong>attribute_value</strong> criterions.</p>
+</dd>
+</dl>
+</p>
 </dd>
 </dl>
 <p class="rubric">Notes</p>
@@ -189,6 +193,9 @@ cannot be indexed, searching by Attribute key is to be preferred whenever possib
 <li><p><strong>typeclasses</strong> (<em>list</em><em>, </em><em>optional</em>) – List of typeclass-path strings to restrict matches with</p></li>
 </ul>
 </dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p><em>Queryset</em> – Iterable with 0, 1 or more matches.</p>
+</dd>
 </dl>
 </dd></dl>
 
@@ -205,7 +212,7 @@ to exclude from the match.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns</dt>
-<dd class="field-even"><p><em>contents (query)</em> – Matching contents, without excludeobj, if given.</p>
+<dd class="field-even"><p><em>Queryset</em> – Iterable with 0, 1 or more matches.</p>
 </dd>
 </dl>
 </dd></dl>
@@ -225,7 +232,7 @@ using <strong>evennia.utils.utils.string_partial_matching</strong> algorithm.</p
 </ul>
 </dd>
 <dt class="field-even">Returns</dt>
-<dd class="field-even"><p><em>matches (query)</em> – A list of matches of length 0, 1 or more.</p>
+<dd class="field-even"><p><em>Queryset</em> – An iterable with 0, 1 or more matches.</p>
 </dd>
 </dl>
 </dd></dl>
@@ -403,6 +410,44 @@ arguments.  <strong>None</strong> if an error was encountered.</p>
 db_account field set.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt id="evennia.objects.manager.ObjectDBManager.create_object">
+<code class="sig-name descname">create_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">typeclass</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">location</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">home</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">permissions</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">locks</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tags</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">destination</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">report_to</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">nohome</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">attributes</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">nattributes</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/manager.html#ObjectDBManager.create_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.manager.ObjectDBManager.create_object" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a new in-game object.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Keyword Arguments</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>typeclass</strong> (<em>class</em><em> or </em><em>str</em>) – Class or python path to a typeclass.</p></li>
+<li><p><strong>key</strong> (<em>str</em>) – Name of the new object. If not set, a name of
+<strong>#dbref</strong> will be set.</p></li>
+<li><p><strong>location</strong> (<em>Object</em><em> or </em><em>str</em>) – Obj or #dbref to use as the location of the new object.</p></li>
+<li><p><strong>home</strong> (<em>Object</em><em> or </em><em>str</em>) – Obj or #dbref to use as the object’s home location.</p></li>
+<li><p><strong>permissions</strong> (<a class="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>) – A list of permission strings or tuples (permstring, category).</p></li>
+<li><p><strong>locks</strong> (<em>str</em>) – one or more lockstrings, separated by semicolons.</p></li>
+<li><p><strong>aliases</strong> (<a class="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>) – A list of alternative keys or tuples (aliasstring, category).</p></li>
+<li><p><strong>tags</strong> (<a class="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>) – List of tag keys or tuples (tagkey, category) or (tagkey, category, data).</p></li>
+<li><p><strong>destination</strong> (<em>Object</em><em> or </em><em>str</em>) – Obj or #dbref to use as an Exit’s target.</p></li>
+<li><p><strong>report_to</strong> (<em>Object</em>) – The object to return error messages to.</p></li>
+<li><p><strong>nohome</strong> (<em>bool</em>) – This allows the creation of objects without a
+default home location; only used when creating the default
+location itself or during unittests.</p></li>
+<li><p><strong>attributes</strong> (<a class="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>) – Tuples on the form (key, value) or (key, value, category),
+(key, value, lockstring) or (key, value, lockstring, default_access).
+to set as Attributes on the new object.</p></li>
+<li><p><strong>nattributes</strong> (<a class="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>) – Non-persistent tuples on the form (key, value). Note that
+adding this rarely makes sense since this data will not survive a reload.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p><em>object (Object)</em> – A newly created object of the given typeclass.</p>
+</dd>
+<dt class="field-odd">Raises</dt>
+<dd class="field-odd"><p><a class="reference internal" href="evennia.objects.models.html#evennia.objects.models.ObjectDB.DoesNotExist" title="evennia.objects.models.ObjectDB.DoesNotExist"><strong>ObjectDB.DoesNotExist</strong></a> – If trying to create an Object with
+<strong>location</strong> or <strong>home</strong> that can’t be found.</p>
+</dd>
+</dl>
+</dd></dl>
+
 </dd></dl>
 
 </section>