mirror of
https://github.com/evennia/evennia.git
synced 2026-03-19 06:16:31 +01:00
167 lines
10 KiB
HTML
167 lines
10 KiB
HTML
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
|
|||
|
|
<html>
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" />
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|||
|
|
|
|||
|
|
<title>evennia.contrib.tutorial_examples.bodyfunctions — Evennia 0.9.5 documentation</title>
|
|||
|
|
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|||
|
|
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|||
|
|
<script src="../_static/jquery.js"></script>
|
|||
|
|
<script src="../_static/underscore.js"></script>
|
|||
|
|
<script src="../_static/doctools.js"></script>
|
|||
|
|
<script src="../_static/language_data.js"></script>
|
|||
|
|
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|||
|
|
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
|
|||
|
|
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
|||
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="../search.html" />
|
|||
|
|
</head><body>
|
|||
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|||
|
|
<h3>Navigation</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li class="right" style="margin-right: 10px">
|
|||
|
|
<a href="../genindex.html" title="General Index"
|
|||
|
|
accesskey="I">index</a></li>
|
|||
|
|
<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 0.9.5</a> »</li>
|
|||
|
|
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorial_examples.bodyfunctions</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="document">
|
|||
|
|
<div class="documentwrapper">
|
|||
|
|
<div class="bodywrapper">
|
|||
|
|
<div class="body" role="main">
|
|||
|
|
|
|||
|
|
<section id="module-evennia.contrib.tutorial_examples.bodyfunctions">
|
|||
|
|
<span id="evennia-contrib-tutorial-examples-bodyfunctions"></span><h1>evennia.contrib.tutorial_examples.bodyfunctions<a class="headerlink" href="#module-evennia.contrib.tutorial_examples.bodyfunctions" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<p>Example script for testing. This adds a simple timer that has your
|
|||
|
|
character make observations and notices at irregular intervals.</p>
|
|||
|
|
<dl class="simple">
|
|||
|
|
<dt>To test, use</dt><dd><p>@script me = tutorial_examples.bodyfunctions.BodyFunctions</p>
|
|||
|
|
</dd>
|
|||
|
|
</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="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"><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="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="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="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="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: <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="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: <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="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="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>
|
|||
|
|
|
|||
|
|
</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">
|
|||
|
|
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
|||
|
|
</a></p>
|
|||
|
|
<div id="searchbox" style="display: none" role="search">
|
|||
|
|
<h3 id="searchlabel">Quick search</h3>
|
|||
|
|
<div class="searchformwrapper">
|
|||
|
|
<form class="search" action="../search.html" method="get">
|
|||
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|||
|
|
<input type="submit" value="Go" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<script>$('#searchbox').show(0);</script>
|
|||
|
|
<div role="note" aria-label="source link">
|
|||
|
|
<!--h3>This Page</h3-->
|
|||
|
|
<ul class="this-page-menu">
|
|||
|
|
<li><a href="../_sources/api/evennia.contrib.tutorial_examples.bodyfunctions.md.txt"
|
|||
|
|
rel="nofollow">Show Page Source</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div><h3>Links</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="https://www.evennia.com">Home page</a> </li>
|
|||
|
|
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
|
|||
|
|
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
|||
|
|
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
|
|||
|
|
<a href="https://discord.gg/NecFePw">Discord</a> -
|
|||
|
|
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
|
|||
|
|
</li>
|
|||
|
|
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
|||
|
|
</ul>
|
|||
|
|
<h3>Versions</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="../../1.0-dev/index.html">1.0-dev (develop branch)</a></li>
|
|||
|
|
<li><a href="evennia.contrib.tutorial_examples.bodyfunctions.html">0.9.5 (v0.9.5 branch)</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="clearer"></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|||
|
|
<h3>Navigation</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li class="right" style="margin-right: 10px">
|
|||
|
|
<a href="../genindex.html" title="General Index"
|
|||
|
|
>index</a></li>
|
|||
|
|
<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 0.9.5</a> »</li>
|
|||
|
|
<li class="nav-item nav-item-this"><a href="">evennia.contrib.tutorial_examples.bodyfunctions</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
<div class="footer" role="contentinfo">
|
|||
|
|
© Copyright 2020, The Evennia developer community.
|
|||
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|