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

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-10-15 01:31:30 +02:00
parent dc00b6bf65
commit edf9ca4c4b
1252 changed files with 40437 additions and 27044 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/1.0-dev/api/evennia.contrib.tutorial_examples.bodyfunctions.html
View file

@ -1,9 +1,10 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.contrib.tutorial_examples.bodyfunctions &#8212; Evennia 1.0-dev documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -25,7 +26,8 @@
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorial_examples.bodyfunctions</a></li>
</ul>
</div>
@ -44,47 +46,47 @@ character make observations and notices at irregular intervals.</p>
</dl>
<p>The script will only send messages to the object it is stored on, so
make sure to put it on yourself or you won’t see any messages!</p>
<dl class="class">
<dl class="py class">
<dt id="evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.bodyfunctions.</code><code class="sig-name descname">BodyFunctions</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/bodyfunctions.html#BodyFunctions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.bodyfunctions.</code><code class="sig-name descname">BodyFunctions</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</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/contrib/tutorial_examples/bodyfunctions.html#BodyFunctions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript</span></code></a></p>
<p>This class defines the script itself</p>
<dl class="method">
<dl class="py method">
<dt id="evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.at_script_creation">
<code class="sig-name descname">at_script_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/bodyfunctions.html#BodyFunctions.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.at_script_creation" title="Permalink to this definition"></a></dt>
<dd><p>Only called once, when script is first created.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.at_repeat">
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/bodyfunctions.html#BodyFunctions.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.at_repeat" title="Permalink to this definition"></a></dt>
<dd><p>This gets called every self.interval seconds. We make
a random check here so as to only return 33% of the time.</p>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.send_random_message">
<code class="sig-name descname">send_random_message</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/bodyfunctions.html#BodyFunctions.send_random_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.send_random_message" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="exception">
<dl class="py exception">
<dt id="evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DoesNotExist</span></code></p>
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
</dd></dl>
<dl class="exception">
<dl class="py exception">
<dt id="evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.MultipleObjectsReturned</span></code></p>
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'BodyFunctions'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
@ -94,6 +96,7 @@ a random check here so as to only return 33% of the time.</p>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
@ -138,12 +141,13 @@ a random check here so as to only return 33% of the time.</p>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorial_examples.bodyfunctions</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>