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

Updated HTML docs

Browse source
This commit is contained in:
Evennia docbuilder action 2022-10-23 09:04:07 +00:00
parent 478c0b6473
commit 0e0cd24694
958 changed files with 41858 additions and 39649 deletions
Download patch file Download diff file Expand all files Collapse all files

64
docs/1.0-dev/api/evennia.contrib.tutorials.evadventure.utils.html
View file

@ -48,38 +48,8 @@
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.tutorials.evadventure.utils">
<span id="evennia-contrib-tutorials-evadventure-utils"></span><h1>evennia.contrib.tutorials.evadventure.utils<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.utils" title="Permalink to this headline"></a></h1>
<p>Various utilities.</p>
<dl class="py function">
<dt id="evennia.contrib.tutorials.evadventure.utils.get_obj_stats">
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.utils.</code><code class="sig-name descname">get_obj_stats</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">owner</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/utils.html#get_obj_stats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.utils.get_obj_stats" title="Permalink to this definition"></a></dt>
<dd><p>Get a string of stats about the object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – The object to get stats for.</p></li>
<li><p><strong>owner</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.characters.html#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter" title="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter"><em>EvAdventureCharacter</em></a><em>, </em><em>optional</em>) – If given, it allows us to
also get information about if the item is currently worn/wielded.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>str</em> – A stat string to show about the object.</p>
</dd>
</dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
@ -126,7 +96,37 @@ also get information about if the item is currently worn/wielded.</p></li>
</div>
</div>
<div class="clearer"></div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.tutorials.evadventure.utils">
<span id="evennia-contrib-tutorials-evadventure-utils"></span><h1>evennia.contrib.tutorials.evadventure.utils<a class="headerlink" href="#module-evennia.contrib.tutorials.evadventure.utils" title="Permalink to this headline"></a></h1>
<p>Various utilities.</p>
<dl class="py function">
<dt id="evennia.contrib.tutorials.evadventure.utils.get_obj_stats">
<code class="sig-prename descclassname">evennia.contrib.tutorials.evadventure.utils.</code><code class="sig-name descname">get_obj_stats</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">owner</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/evadventure/utils.html#get_obj_stats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.utils.get_obj_stats" title="Permalink to this definition"></a></dt>
<dd><p>Get a string of stats about the object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>obj</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.objects.html#evennia.contrib.tutorials.evadventure.objects.EvAdventureObject" title="evennia.contrib.tutorials.evadventure.objects.EvAdventureObject"><em>EvAdventureObject</em></a>) – The object to get stats for.</p></li>
<li><p><strong>owner</strong> (<a class="reference internal" href="evennia.contrib.tutorials.evadventure.characters.html#evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter" title="evennia.contrib.tutorials.evadventure.characters.EvAdventureCharacter"><em>EvAdventureCharacter</em></a><em>, </em><em>optional</em>) – If given, it allows us to
also get information about if the item is currently worn/wielded.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>str</em> – A stat string to show about the object.</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>