Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-20 14:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/api/evennia.server.profiling.dummyrunner_settings.html

283 lines
20 KiB
HTML
Raw Normal View History

Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<!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.server.profiling.dummyrunner_settings &#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" />
<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>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.server.profiling.memplot" href="evennia.server.profiling.memplot.html" />
<link rel="prev" title="evennia.server.profiling.dummyrunner" href="evennia.server.profiling.dummyrunner.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="right" >
<a href="evennia.server.profiling.memplot.html" title="evennia.server.profiling.memplot"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.server.profiling.dummyrunner.html" title="evennia.server.profiling.dummyrunner"
accesskey="P">previous</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-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.server.html" >evennia.server</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.server.profiling.html" accesskey="U">evennia.server.profiling</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server.profiling.dummyrunner_settings</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<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>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.server.profiling.dummyrunner.html"
title="previous chapter">evennia.server.profiling.dummyrunner</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.server.profiling.memplot.html"
title="next chapter">evennia.server.profiling.memplot</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.server.profiling.dummyrunner_settings.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="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Versions</h3>
<ul>
<li><a href="evennia.server.profiling.dummyrunner_settings.html">1.0-dev (develop branch)</a></li>
Updated HTML docs.
2022-11-15 20:29:38 +00:00
<ul>
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.server.profiling.dummyrunner_settings">
<span id="evennia-server-profiling-dummyrunner-settings"></span><h1>evennia.server.profiling.dummyrunner_settings<a class="headerlink" href="#module-evennia.server.profiling.dummyrunner_settings" title="Permalink to this headline"></a></h1>
<p>Settings and actions for the dummyrunner</p>
<p>This module defines dummyrunner settings and sets up
the actions available to dummy accounts.</p>
<p>The settings are global variables:</p>
<ul class="simple">
<li><p>TIMESTEP - time in seconds between each ‘tick’. 1 is a good start.</p></li>
<li><p>CHANCE_OF_ACTION - chance 0-1 of action happening. Default is 0.5.</p></li>
<li><p>CHANCE_OF_LOGIN - chance 0-1 of login happening. 0.01 is a good number.</p></li>
<li><p>TELNET_PORT - port to use, defaults to settings.TELNET_PORT</p></li>
<li><p>ACTIONS - see below</p></li>
</ul>
<p>ACTIONS is a tuple</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">login_func</span><span class="p">,</span> <span class="n">logout_func</span><span class="p">,</span> <span class="p">(</span><span class="mf">0.3</span><span class="p">,</span> <span class="n">func1</span><span class="p">),</span> <span class="p">(</span><span class="mf">0.1</span><span class="p">,</span> <span class="n">func2</span><span class="p">)</span> <span class="o">...</span> <span class="p">)</span>
</pre></div>
</div>
<p>where the first entry is the function to call on first connect, with a
chance of occurring given by CHANCE_OF_LOGIN. This function is usually
responsible for logging in the account. The second entry is always
called when the dummyrunner disconnects from the server and should
thus issue a logout command. The other entries are tuples (chance,
func). They are picked randomly, their commonality based on the
cumulative chance given (the chance is normalized between all options
so if will still work also if the given chances don’t add up to 1).</p>
<p>The PROFILE variable define pre-made ACTION tuples for convenience.</p>
<p>Each function should return an iterable of one or more command-call
strings (like “look here”), so each can group multiple command operations.</p>
<p>An action-function is called with a “client” argument which is a
reference to the dummy client currently performing the action.</p>
<p>The client object has the following relevant properties and methods:</p>
<ul class="simple">
<li><p>key - an optional client key. This is only used for dummyrunner output.
Default is “Dummy-&lt;cid&gt;”</p></li>
<li><p>cid - client id</p></li>
<li><p>gid - globally unique id, hashed with time stamp</p></li>
<li><p>istep - the current step</p></li>
<li><p>exits - an empty list. Can be used to store exit names</p></li>
<li><p>objs - an empty list. Can be used to store object names</p></li>
<li><p>counter() - returns a unique increasing id, hashed with time stamp
to make it unique also between dummyrunner instances.</p></li>
</ul>
<p>The return should either be a single command string or a tuple of
command strings. This list of commands will always be executed every
TIMESTEP with a chance given by CHANCE_OF_ACTION by in the order given
(no randomness) and allows for setting up a more complex chain of
commands (such as creating an account and logging in).</p>
<hr class="docutils" />
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_login">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_login</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_login" title="Permalink to this definition"></a></dt>
<dd><p>logins to the game</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_login_nodig">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_login_nodig</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_login_nodig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_login_nodig" title="Permalink to this definition"></a></dt>
<dd><p>logins, don’t dig its own room</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_logout">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_logout</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_logout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_logout" title="Permalink to this definition"></a></dt>
<dd><p>logouts of the game</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_looks">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_looks</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_looks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_looks" title="Permalink to this definition"></a></dt>
<dd><p>looks at various objects</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_examines">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_examines</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_examines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_examines" title="Permalink to this definition"></a></dt>
<dd><p>examines various objects</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_idles">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_idles</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_idles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_idles" title="Permalink to this definition"></a></dt>
<dd><p>idles</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_help">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_help</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_help" title="Permalink to this definition"></a></dt>
<dd><p>reads help files</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_digs">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_digs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_digs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_digs" title="Permalink to this definition"></a></dt>
<dd><p>digs a new room, storing exit names on client</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_creates_obj">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_creates_obj</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_creates_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_creates_obj" title="Permalink to this definition"></a></dt>
<dd><p>creates normal objects, storing their name on client</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_creates_button">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_creates_button</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_creates_button"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_creates_button" title="Permalink to this definition"></a></dt>
<dd><p>creates example button, storing name on client</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_socialize">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_socialize</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_socialize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_socialize" title="Permalink to this definition"></a></dt>
<dd><p>socializechats on channel</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_moves">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_moves</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_moves"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_moves" title="Permalink to this definition"></a></dt>
<dd><p>moves to a previously created room, using the stored exits</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_moves_n">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_moves_n</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_moves_n"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_moves_n" title="Permalink to this definition"></a></dt>
<dd><p>move through north exit if available</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_moves_s">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_moves_s</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_moves_s"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_moves_s" title="Permalink to this definition"></a></dt>
<dd><p>move through south exit if available</p>
</dd></dl>
<dl class="py function">
<dt id="evennia.server.profiling.dummyrunner_settings.c_measure_lag">
<code class="sig-prename descclassname">evennia.server.profiling.dummyrunner_settings.</code><code class="sig-name descname">c_measure_lag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">client</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/profiling/dummyrunner_settings.html#c_measure_lag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.profiling.dummyrunner_settings.c_measure_lag" title="Permalink to this definition"></a></dt>
<dd><p>Special dummyrunner command, injected in c_login. It measures
response time. Including this in the ACTION tuple will give more
dummyrunner output about just how fast commands are being processed.</p>
<p>The dummyrunner will treat this special and inject the
{timestamp} just before sending.</p>
</dd></dl>
</section>
</div>
</div>
</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="right" >
<a href="evennia.server.profiling.memplot.html" title="evennia.server.profiling.memplot"
>next</a> |</li>
<li class="right" >
<a href="evennia.server.profiling.dummyrunner.html" title="evennia.server.profiling.dummyrunner"
>previous</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-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.server.html" >evennia.server</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.server.profiling.html" >evennia.server.profiling</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server.profiling.dummyrunner_settings</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
Updated HTML docs.
2022-11-15 19:52:44 +00:00
&#169; Copyright 2022, The Evennia developer community.
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue Copy permalink