Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-04 23:17:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs.

Browse source
This commit is contained in:
Evennia docbuilder action 2024-03-09 19:07:54 +00:00
parent 04735271b7
commit 312e3c17df
46 changed files with 350 additions and 228 deletions
Download patch file Download diff file Expand all files Collapse all files

69
docs/latest/api/evennia.objects.objects.html
View file

@ -244,7 +244,7 @@ without <strong>obj.save()</strong> having to be called explicitly.</p>
<dl class="py attribute">
<dt id="evennia.objects.objects.DefaultObject.appearance_template">
<code class="sig-name descname">appearance_template</code><em class="property"> = '\n{header}\n|c{name}|n\n{desc}\n{exits}{characters}{things}\n{footer}\n '</em><a class="headerlink" href="#evennia.objects.objects.DefaultObject.appearance_template" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">appearance_template</code><em class="property"> = '\n{header}\n|c{name}{extra_name_info}|n\n{desc}\n{exits}{characters}{things}\n{footer}\n '</em><a class="headerlink" href="#evennia.objects.objects.DefaultObject.appearance_template" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -329,30 +329,6 @@ and filtering.</p>
<dd><p>You cannot replace this property</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.objects.objects.DefaultObject.contents">
<em class="property">property </em><code class="sig-name descname">contents</code><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>exclude</strong> (<em>Object</em>) – 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>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>contents (list)</em> – List of contents of this Object.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Also available as the <strong>contents</strong> property, minus exclusion
and filtering.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.objects.objects.DefaultObject.exits">
<em class="property">property </em><code class="sig-name descname">exits</code><a class="headerlink" href="#evennia.objects.objects.DefaultObject.exits" title="Permalink to this definition"></a></dt>
@ -691,6 +667,19 @@ will be treated as send-command names and their arguments
All extra kwargs will be passed on to the protocol.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.objects.objects.DefaultObject.get_contents_unique">
<code class="sig-name descname">get_contents_unique</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</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/objects.html#DefaultObject.get_contents_unique"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_contents_unique" title="Permalink to this definition"></a></dt>
<dd><p>Get a mapping of contents that are visually unique to the caller, along with
how many of each there are.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>caller</strong> (<em>Object</em><em>, </em><em>optional</em>) – The object to check visibility from. If not given,
the current object will be used.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="evennia.objects.objects.DefaultObject.for_contents">
<code class="sig-name descname">for_contents</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">func</span></em>, <em class="sig-param"><span class="n">exclude</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#DefaultObject.for_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.for_contents" title="Permalink to this definition"></a></dt>
@ -1009,6 +998,28 @@ but be wary. This function does not change an object’s keys or aliases when se
and is expected to produce something useful for builders.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.objects.objects.DefaultObject.get_extra_display_name_info">
<code class="sig-name descname">get_extra_display_name_info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">looker</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#DefaultObject.get_extra_display_name_info"><span class="viewcode-link">[source]</span></a><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>looker</strong> (<em>Object</em>) – The object looking at this object.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p><em>str</em> –</p>
<dl class="simple">
<dt>The dbref of this object, if the looker has permission to see it. Otherwise, an</dt><dd><p>empty string is returned.</p>
</dd>
</dl>
</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>By default, this becomes a string (#dbref) attached to the object’s name.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.objects.objects.DefaultObject.get_numbered_name">
<code class="sig-name descname">get_numbered_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">count</span></em>, <em class="sig-param"><span class="n">looker</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/objects/objects.html#DefaultObject.get_numbered_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.objects.objects.DefaultObject.get_numbered_name" title="Permalink to this definition"></a></dt>
@ -1025,8 +1036,12 @@ from this method.</p>
</ul>
</dd>
<dt class="field-even">Keyword Arguments</dt>
<dd class="field-even"><p><strong>key</strong> (<em>str</em>) – Optional key to pluralize. If not given, the object’s <strong>.name</strong> property is
used.</p>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong> (<em>str</em>) – Optional key to pluralize. If not given, the object’s <strong>.get_display_name()</strong>
method is used.</p></li>
<li><p><strong>return_string</strong> (<em>bool</em>) – If <strong>True</strong>, return only the singular form if count is 0,1 or
the plural form otherwise. If <strong>False</strong> (default), return both forms as a tuple.</p></li>
</ul>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><p><em>tuple</em> –</p>