Updated HTML docs

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

View file

@ -48,56 +48,8 @@
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.tutorials.bodyfunctions.tests">
<span id="evennia-contrib-tutorials-bodyfunctions-tests"></span><h1>evennia.contrib.tutorials.bodyfunctions.tests<a class="headerlink" href="#module-evennia.contrib.tutorials.bodyfunctions.tests" title="Permalink to this headline"></a></h1>
<p>Tests for the bodyfunctions.</p>
<dl class="py class">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.bodyfunctions.tests.</code><code class="sig-name descname">TestBodyFunctions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/bodyfunctions/tests.html#TestBodyFunctions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.script_typeclass">
<code class="sig-name descname">script_typeclass</code><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.script_typeclass" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.contrib.tutorials.bodyfunctions.bodyfunctions.html#evennia.contrib.tutorials.bodyfunctions.bodyfunctions.BodyFunctions" title="evennia.contrib.tutorials.bodyfunctions.bodyfunctions.BodyFunctions"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.bodyfunctions.bodyfunctions.BodyFunctions</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.setUp">
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/bodyfunctions/tests.html#TestBodyFunctions.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.setUp" title="Permalink to this definition"></a></dt>
<dd><p>Sets up testing environment</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.tearDown">
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/bodyfunctions/tests.html#TestBodyFunctions.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.tearDown" title="Permalink to this definition"></a></dt>
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.test_at_repeat">
<code class="sig-name descname">test_at_repeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_random</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/bodyfunctions/tests.html#TestBodyFunctions.test_at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.test_at_repeat" title="Permalink to this definition"></a></dt>
<dd><p>test that no message will be sent when below the 66% threshold</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.test_send_random_message">
<code class="sig-name descname">test_send_random_message</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_random</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/bodyfunctions/tests.html#TestBodyFunctions.test_send_random_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.test_send_random_message" title="Permalink to this definition"></a></dt>
<dd><p>Test that correct message is sent for each random value</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">
@ -144,7 +96,55 @@
</div>
</div>
<div class="clearer"></div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.tutorials.bodyfunctions.tests">
<span id="evennia-contrib-tutorials-bodyfunctions-tests"></span><h1>evennia.contrib.tutorials.bodyfunctions.tests<a class="headerlink" href="#module-evennia.contrib.tutorials.bodyfunctions.tests" title="Permalink to this headline"></a></h1>
<p>Tests for the bodyfunctions.</p>
<dl class="py class">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorials.bodyfunctions.tests.</code><code class="sig-name descname">TestBodyFunctions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/bodyfunctions/tests.html#TestBodyFunctions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
<dl class="py attribute">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.script_typeclass">
<code class="sig-name descname">script_typeclass</code><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.script_typeclass" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.contrib.tutorials.bodyfunctions.bodyfunctions.html#evennia.contrib.tutorials.bodyfunctions.bodyfunctions.BodyFunctions" title="evennia.contrib.tutorials.bodyfunctions.bodyfunctions.BodyFunctions"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorials.bodyfunctions.bodyfunctions.BodyFunctions</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.setUp">
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/bodyfunctions/tests.html#TestBodyFunctions.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.setUp" title="Permalink to this definition"></a></dt>
<dd><p>Sets up testing environment</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.tearDown">
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/bodyfunctions/tests.html#TestBodyFunctions.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.tearDown" title="Permalink to this definition"></a></dt>
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.test_at_repeat">
<code class="sig-name descname">test_at_repeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_random</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/bodyfunctions/tests.html#TestBodyFunctions.test_at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.test_at_repeat" title="Permalink to this definition"></a></dt>
<dd><p>test that no message will be sent when below the 66% threshold</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.test_send_random_message">
<code class="sig-name descname">test_send_random_message</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">mock_random</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorials/bodyfunctions/tests.html#TestBodyFunctions.test_send_random_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorials.bodyfunctions.tests.TestBodyFunctions.test_send_random_message" title="Permalink to this definition"></a></dt>
<dd><p>Test that correct message is sent for each random value</p>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>