Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-21 23:36:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs.

Browse source
This commit is contained in:
Evennia docbuilder action 2024-03-21 21:21:07 +00:00
parent 5018fa9c38
commit c8a7741a3c
43 changed files with 195 additions and 152 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -246,7 +246,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}{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>
<code class="sig-name descname">appearance_template</code><em class="property"> = '\n{header}\n|c{name}{extra_name_info}|n\n{desc}\n{exits}\n{characters}\n{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">
@ -980,24 +980,16 @@ lock check for superuser (be careful with this one).</p></li>
<dd><p>Displays the name of the object in a viewer-aware manner.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>looker</strong> (<a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><em>TypedObject</em></a>) – The object or account that is looking
at/getting inforamtion for this object. If not given, <strong>.name</strong> will be
returned, which can in turn be used to display colored data.</p>
<dd class="field-odd"><p><strong>looker</strong> (<a class="reference internal" href="evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject" title="evennia.typeclasses.models.TypedObject"><em>TypedObject</em></a>) – The object or account that is looking at or getting information
for this object.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p><em>str</em> –</p>
<dl class="simple">
<dt>A name to display for this object. This can contain color codes and may</dt><dd><p>be customized based on <strong>looker</strong>. By default this contains the <strong>.key</strong> of the object,
followed by the DBREF if this user is privileged to control said object.</p>
</dd>
</dl>
</p>
<dd class="field-even"><p><em>str</em> – A name to display for this object. By default this returns the <strong>.name</strong> of the object.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This function could be extended to change how object names appear to users in character,
but be wary. This function does not change an object’s keys or aliases when searching,
and is expected to produce something useful for builders.</p>
<p>This function can be extended to change how object names appear to users in character,
but it does not change an object’s keys or aliases when searching.</p>
</dd></dl>
<dl class="py method">