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

Updated HTML docs.

Browse source
This commit is contained in:
Evennia docbuilder action 2024-04-07 08:20:49 +00:00
parent 307495c7d9
commit 5e617c5a46
32 changed files with 151 additions and 101 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1075,10 +1075,20 @@ including the count.</p>
<li><p><strong>**kwargs</strong> – Arbitrary data for use when overriding.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>str</em> – The exits display data.</p>
<dt class="field-even">Keyword Arguments</dt>
<dd class="field-even"><p><strong>exit_order</strong> (<em>iterable of str</em>) – The order in which exits should be listed, with
unspecified exits appearing at the end, alphabetically.</p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><em>str</em> – The exits display data.</p>
</dd>
</dl>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">For</span> <span class="n">a</span> <span class="n">room</span> <span class="k">with</span> <span class="n">exits</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">order</span> <span class="s1">&#39;portal&#39;</span><span class="p">,</span> <span class="s1">&#39;south&#39;</span><span class="p">,</span> <span class="s1">&#39;north&#39;</span><span class="p">,</span> <span class="ow">and</span> <span class="s1">&#39;out&#39;</span><span class="p">:</span>
<span class="n">obj</span><span class="o">.</span><span class="n">get_display_name</span><span class="p">(</span><span class="n">looker</span><span class="p">,</span> <span class="n">exit_order</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;north&#39;</span><span class="p">,</span> <span class="s1">&#39;south&#39;</span><span class="p">))</span>
<span class="o">-&gt;</span> <span class="s2">&quot;Exits: north, south, out, and portal.&quot;</span> <span class="p">(</span><span class="n">markup</span> <span class="ow">not</span> <span class="n">shown</span> <span class="n">here</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">