mirror of
https://github.com/evennia/evennia.git
synced 2026-03-19 14:26:30 +01:00
1250 lines
No EOL
105 KiB
HTML
1250 lines
No EOL
105 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<title>evennia.contrib.tutorial_examples package — Evennia 1.0-dev documentation</title>
|
||
<link rel="stylesheet" href="../_static/alabaster.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="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
|
||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
|
||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||
|
||
</head><body>
|
||
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="module-evennia.contrib.tutorial_examples">
|
||
<span id="evennia-contrib-tutorial-examples-package"></span><h1>evennia.contrib.tutorial_examples package<a class="headerlink" href="#module-evennia.contrib.tutorial_examples" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-evennia.contrib.tutorial_examples.bodyfunctions">
|
||
<span id="evennia-contrib-tutorial-examples-bodyfunctions-module"></span><h2>evennia.contrib.tutorial_examples.bodyfunctions module<a class="headerlink" href="#module-evennia.contrib.tutorial_examples.bodyfunctions" title="Permalink to this headline">¶</a></h2>
|
||
<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="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>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.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="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></dl>
|
||
|
||
<dl class="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></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for BodyFunctions></em><a class="headerlink" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="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">
|
||
<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="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="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="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>
|
||
|
||
</div>
|
||
<div class="section" id="module-evennia.contrib.tutorial_examples.cmdset_red_button">
|
||
<span id="evennia-contrib-tutorial-examples-cmdset-red-button-module"></span><h2>evennia.contrib.tutorial_examples.cmdset_red_button module<a class="headerlink" href="#module-evennia.contrib.tutorial_examples.cmdset_red_button" title="Permalink to this headline">¶</a></h2>
|
||
<p>This defines the cmdset for the red_button. Here we have defined
|
||
the commands and the cmdset in the same module, but if you
|
||
have many different commands to merge it is often better
|
||
to define the cmdset separately, picking and choosing from
|
||
among the available commands as to what should be included in the
|
||
cmdset - this way you can often re-use the commands too.</p>
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">BlindCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#BlindCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||
<p>This is the cmdset added to the <em>account</em> when
|
||
the button is pushed.</p>
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.at_cmdset_creation">
|
||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#BlindCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Setup the blind cmdset</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'BlindCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.mergetype">
|
||
<code class="sig-name descname">mergetype</code><em class="property"> = 'Replace'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.mergetype" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.no_exits">
|
||
<code class="sig-name descname">no_exits</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.no_exits" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.no_objs">
|
||
<code class="sig-name descname">no_objs</code><em class="property"> = True</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.no_objs" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.BlindCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">CmdBlindHelp</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdBlindHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Help function while in the blinded state</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>help</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp._keyaliases">
|
||
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('help', 'h')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp._keyaliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp._matchset">
|
||
<code class="sig-name descname">_matchset</code><em class="property"> = {'h', 'help'}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp._matchset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['h']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdBlindHelp.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Give a message.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'help'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'h', 'category': 'general', 'key': 'help', 'tags': '', 'text': '\n Help function while in the blinded state\n\n Usage:\n help\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">CmdBlindLook</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdBlindLook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Looking around in darkness</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>look <obj></p>
|
||
</dd>
|
||
</dl>
|
||
<p>… not that there’s much to see in the dark.</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook._keyaliases">
|
||
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('get', 'feel', 'examine', 'listen', 'ex', 'l', 'look')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook._keyaliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook._matchset">
|
||
<code class="sig-name descname">_matchset</code><em class="property"> = {'ex', 'examine', 'feel', 'get', 'l', 'listen', 'look'}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook._matchset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['get', 'feel', 'examine', 'listen', 'ex', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdBlindLook.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This replaces all the senses when blinded.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'look'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'get feel examine listen ex l', 'category': 'general', 'key': 'look', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">CmdCloseLid</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdCloseLid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>close the lid</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>close lid</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Closes the lid of the red button.</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid._keyaliases">
|
||
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('close lid', 'close')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid._keyaliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid._matchset">
|
||
<code class="sig-name descname">_matchset</code><em class="property"> = {'close', 'close lid'}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid._matchset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['close']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdCloseLid.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Close the lid</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'close lid'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'close', 'category': 'general', 'key': 'close lid', 'tags': '', 'text': '\n close the lid\n\n Usage:\n close lid\n\n Closes the lid of the red button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdCloseLid.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">CmdNudge</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdNudge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Try to nudge the button’s lid</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>nudge lid</p>
|
||
</dd>
|
||
</dl>
|
||
<p>This command will have you try to
|
||
push the lid of the button away.</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge._keyaliases">
|
||
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('nudge lid', 'nudge')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge._keyaliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge._matchset">
|
||
<code class="sig-name descname">_matchset</code><em class="property"> = {'nudge', 'nudge lid'}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge._matchset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['nudge']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdNudge.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>nudge the lid. Random chance of success to open it.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'nudge lid'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'nudge', 'category': 'general', 'key': 'nudge lid', 'tags': '', 'text': "\n Try to nudge the button's lid\n\n Usage:\n nudge lid\n\n This command will have you try to\n push the lid of the button away.\n "}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdNudge.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">CmdOpenLid</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdOpenLid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>open lid</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>open lid</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid._keyaliases">
|
||
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('open lid', 'open', 'open button')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid._keyaliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid._matchset">
|
||
<code class="sig-name descname">_matchset</code><em class="property"> = {'open', 'open button', 'open lid'}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid._matchset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['open', 'open button']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdOpenLid.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>simply call the right function.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'open lid'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'open open button', 'category': 'general', 'key': 'open lid', 'tags': '', 'text': '\n open lid\n\n Usage:\n open lid\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdOpenLid.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">CmdPush</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdPush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>Push the red button</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>push button</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush._keyaliases">
|
||
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('press', 'push', 'push button', 'press button')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush._keyaliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush._matchset">
|
||
<code class="sig-name descname">_matchset</code><em class="property"> = {'press', 'press button', 'push', 'push button'}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush._matchset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['press', 'push', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdPush.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Note that we choose to implement this with checking for
|
||
if the lid is open/closed. This is because this command
|
||
is likely to be tried regardless of the state of the lid.</p>
|
||
<p>An alternative would be to make two versions of this command
|
||
and tuck them into the cmdset linked to the Open and Closed
|
||
lid-state respectively.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'push button'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdPush.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">CmdSmashGlass</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdSmashGlass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.command.Command" title="evennia.commands.command.Command"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.command.Command</span></code></a></p>
|
||
<p>smash glass</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>smash glass</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Try to smash the glass of the button.</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass._keyaliases">
|
||
<code class="sig-name descname">_keyaliases</code><em class="property"> = ('break lid', 'smash glass', 'smash lid', 'smash')</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass._keyaliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass._matchset">
|
||
<code class="sig-name descname">_matchset</code><em class="property"> = {'break lid', 'smash', 'smash glass', 'smash lid'}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass._matchset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['break lid', 'smash lid', 'smash']</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#CmdSmashGlass.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The lid won’t open, but there is a small chance
|
||
of causing the lamp to break.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'smash glass'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'break lid smash lid smash', 'category': 'general', 'key': 'smash glass', 'tags': '', 'text': '\n smash glass\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.CmdSmashGlass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">DefaultCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#DefaultCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||
<p>The default cmdset always sits
|
||
on the button object and whereas other
|
||
command sets may be added/merge onto it
|
||
and hide it, removing them will always
|
||
bring it back. It’s added to the object
|
||
using obj.cmdset.add_default().</p>
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet.at_cmdset_creation">
|
||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#DefaultCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Init the cmdset</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'RedButtonDefault'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet.mergetype">
|
||
<code class="sig-name descname">mergetype</code><em class="property"> = 'Union'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet.mergetype" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.DefaultCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">LidClosedCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#LidClosedCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||
<p>A simple cmdset tied to the redbutton object.</p>
|
||
<p>It contains the commands that launches the other
|
||
command sets, making the red button a self-contained
|
||
item (i.e. you don’t have to manually add any
|
||
scripts etc to it when creating it).</p>
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet.at_cmdset_creation">
|
||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#LidClosedCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Populates the cmdset when it is instantiated.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'LidClosedCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet.key_mergetype">
|
||
<code class="sig-name descname">key_mergetype</code><em class="property"> = {'LidOpenCmdSet': 'Replace'}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet.key_mergetype" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.LidClosedCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.cmdset_red_button.</code><code class="sig-name descname">LidOpenCmdSet</code><span class="sig-paren">(</span><em class="sig-param">cmdsetobj=None</em>, <em class="sig-param">key=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#LidOpenCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||
<p>This is the opposite of the Closed cmdset.</p>
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet.at_cmdset_creation">
|
||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/cmdset_red_button.html#LidOpenCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>setup the cmdset (just one command)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'LidOpenCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet.key_mergetype">
|
||
<code class="sig-name descname">key_mergetype</code><em class="property"> = {'LidClosedCmdSet': 'Replace'}</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet.key_mergetype" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.cmdset_red_button.LidOpenCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="evennia-contrib-tutorial-examples-example-batch-code-module">
|
||
<h2>evennia.contrib.tutorial_examples.example_batch_code module<a class="headerlink" href="#evennia-contrib-tutorial-examples-example-batch-code-module" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-evennia.contrib.tutorial_examples.red_button">
|
||
<span id="evennia-contrib-tutorial-examples-red-button-module"></span><h2>evennia.contrib.tutorial_examples.red_button module<a class="headerlink" href="#module-evennia.contrib.tutorial_examples.red_button" title="Permalink to this headline">¶</a></h2>
|
||
<p>This is a more advanced example object. It combines functions from
|
||
script.examples as well as commands.examples to make an interactive
|
||
button typeclass.</p>
|
||
<p>Create this button with</p>
|
||
<blockquote>
|
||
<div><p>@create/drop examples.red_button.RedButton</p>
|
||
</div></blockquote>
|
||
<p>Note that you must drop the button before you can see its messages!</p>
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.red_button.</code><code class="sig-name descname">RedButton</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/red_button.html#RedButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||
<p>This class describes an evil red button. It will use the script
|
||
definition in contrib/examples/red_button_scripts to blink at regular
|
||
intervals. It also uses a series of script and commands to handle
|
||
pushing the button and causing effects when doing so.</p>
|
||
<dl class="simple">
|
||
<dt>The following attributes can be set on the button:</dt><dd><p>desc_lid_open - description when lid is open
|
||
desc_lid_closed - description when lid is closed
|
||
desc_lamp_broken - description when lamp is broken</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DoesNotExist</span></code></p>
|
||
</dd></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton.MultipleObjectsReturned" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.MultipleObjectsReturned</span></code></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for RedButton></em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton.at_object_creation">
|
||
<code class="sig-name descname">at_object_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button.html#RedButton.at_object_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton.at_object_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This function is called when object is created. Use this
|
||
instead of e.g. __init__.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton.blink">
|
||
<code class="sig-name descname">blink</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button.html#RedButton.blink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton.blink" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The script system will regularly call this
|
||
function to make the button blink. Now and then
|
||
it won’t blink at all though, to add some randomness
|
||
to how often the message is echoed.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton.break_lamp">
|
||
<code class="sig-name descname">break_lamp</code><span class="sig-paren">(</span><em class="sig-param">feedback=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button.html#RedButton.break_lamp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton.break_lamp" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Breaks the lamp in the button, stopping it from blinking.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>feedback</strong> (<em>bool</em>) – Show a message about breaking the lamp.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton.close_lid">
|
||
<code class="sig-name descname">close_lid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button.html#RedButton.close_lid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton.close_lid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Close the glass lid. This validates all scripts on the button,
|
||
which means that scripts only being valid when the lid is open
|
||
will go away automatically.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton.open_lid">
|
||
<code class="sig-name descname">open_lid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button.html#RedButton.open_lid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton.open_lid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Opens the glass lid and start the timer so it will soon close
|
||
again.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.red_button.RedButton'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton.press_button">
|
||
<code class="sig-name descname">press_button</code><span class="sig-paren">(</span><em class="sig-param">pobject</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button.html#RedButton.press_button"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton.press_button" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Someone was foolish enough to press the button!</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>pobject</strong> (<em>Object</em>) – The person pressing the button</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button.RedButton.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'RedButton'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button.RedButton.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-evennia.contrib.tutorial_examples.red_button_scripts">
|
||
<span id="evennia-contrib-tutorial-examples-red-button-scripts-module"></span><h2>evennia.contrib.tutorial_examples.red_button_scripts module<a class="headerlink" href="#module-evennia.contrib.tutorial_examples.red_button_scripts" title="Permalink to this headline">¶</a></h2>
|
||
<p>Example of scripts.</p>
|
||
<p>These are scripts intended for a particular object - the
|
||
red_button object type in contrib/examples. A few variations
|
||
on uses of scripts are included.</p>
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlindedState">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.red_button_scripts.</code><code class="sig-name descname">BlindedState</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/red_button_scripts.html#BlindedState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlindedState" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.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 is a timed state.</p>
|
||
<p>This adds a (very limited) cmdset TO THE ACCOUNT, during a certain time,
|
||
after which the script will close and all functions are
|
||
restored. It’s up to the function starting the script to actually
|
||
set it on the right account object.</p>
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.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></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.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></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlindedState._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for BlindedState></em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlindedState._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.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/red_button_scripts.html#BlindedState.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>We set up the script here.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.at_start">
|
||
<code class="sig-name descname">at_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#BlindedState.at_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.at_start" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>We want to add the cmdset to the linked object.</p>
|
||
<p>Note that the RedButtonBlind cmdset is defined to completly
|
||
replace the other cmdsets on the stack while it is active
|
||
(this means that while blinded, only operations in this cmdset
|
||
will be possible for the account to perform). It is however
|
||
not persistent, so should there be a bug in it, we just need
|
||
to restart the server to clear out of it during development.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.at_stop">
|
||
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#BlindedState.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.at_stop" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>It’s important that we clear out that blinded cmdset
|
||
when we are done!</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.red_button_scripts.BlindedState'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'BlindedState'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlindedState.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.red_button_scripts.</code><code class="sig-name descname">BlinkButtonEvent</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/red_button_scripts.html#BlinkButtonEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.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 timed script lets the button flash at regular intervals.</p>
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.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></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.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></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for BlinkButtonEvent></em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.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/red_button_scripts.html#BlinkButtonEvent.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called every self.interval seconds. Makes the lamp in
|
||
the button blink.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.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/red_button_scripts.html#BlinkButtonEvent.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets things up. We want the button’s lamp to blink at
|
||
regular intervals, unless it’s broken (can happen
|
||
if you try to smash the glass, say).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.is_valid">
|
||
<code class="sig-name descname">is_valid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#BlinkButtonEvent.is_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.is_valid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Button will keep blinking unless it is broken.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'BlinkButtonEvent'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.BlinkButtonEvent.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.red_button_scripts.</code><code class="sig-name descname">CloseLidEvent</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/red_button_scripts.html#CloseLidEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.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 event closes the glass lid over the button
|
||
some time after it was opened. It’s a one-off
|
||
script that should be started/created when the
|
||
lid is opened.</p>
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.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></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.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></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for CloseLidEvent></em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.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/red_button_scripts.html#CloseLidEvent.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called after self.interval seconds. It closes the lid. Before this method is
|
||
called, self.is_valid() is automatically checked, so there is no need to
|
||
check this manually.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.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/red_button_scripts.html#CloseLidEvent.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called when script object is first created. Sets things up.
|
||
We want to have a lid on the button that the user can pull
|
||
aside in order to make the button ‘pressable’. But after a set
|
||
time that lid should auto-close again, making the button safe
|
||
from pressing (and deleting this command).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.is_valid">
|
||
<code class="sig-name descname">is_valid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#CloseLidEvent.is_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.is_valid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This script can only operate if the lid is open; if it
|
||
is already closed, the script is clearly invalid.</p>
|
||
<p>Note that we are here relying on an self.obj being
|
||
defined (and being a RedButton object) - this we should be able to
|
||
expect since this type of script is always tied to one individual
|
||
red button object and not having it would be an error.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'CloseLidEvent'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.CloseLidEvent.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.red_button_scripts.</code><code class="sig-name descname">ClosedLidState</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/red_button_scripts.html#ClosedLidState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.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 manages the cmdset for the “closed” button state. What this
|
||
means is that while this script is valid, we add the RedButtonClosed
|
||
cmdset to it (with commands like open, nudge lid etc)</p>
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.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></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.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></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for ClosedLidState></em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.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/red_button_scripts.html#ClosedLidState.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called when script first created.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.at_start">
|
||
<code class="sig-name descname">at_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#ClosedLidState.at_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.at_start" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This is called once every server restart, so we want to add the
|
||
(memory-resident) cmdset to the object here. is_valid is automatically
|
||
checked so we don’t need to worry about adding the script to an
|
||
open lid.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.at_stop">
|
||
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#ClosedLidState.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.at_stop" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When the script stops we must make sure to clean up after us.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.is_valid">
|
||
<code class="sig-name descname">is_valid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#ClosedLidState.is_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.is_valid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The script is only valid while the lid is closed.
|
||
self.obj is the red_button on which this script is defined.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'ClosedLidState'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.ClosedLidState.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.red_button_scripts.</code><code class="sig-name descname">DeactivateButtonEvent</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/red_button_scripts.html#DeactivateButtonEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.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 deactivates the button for a short while (it won’t blink, won’t
|
||
close its lid etc). It is meant to be called when the button is pushed
|
||
and run as long as the blinded effect lasts. We cannot put these methods
|
||
in the AddBlindedCmdSet script since that script is defined on the <em>account</em>
|
||
whereas this one must be defined on the <em>button</em>.</p>
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.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></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.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></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for DeactivateButtonEvent></em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.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/red_button_scripts.html#DeactivateButtonEvent.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.at_repeat" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When this is called, reset the functionality of the button.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.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/red_button_scripts.html#DeactivateButtonEvent.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets things up.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.at_start">
|
||
<code class="sig-name descname">at_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#DeactivateButtonEvent.at_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.at_start" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Deactivate the button. Observe that this method is always
|
||
called directly, regardless of the value of self.start_delay
|
||
(that just controls when at_repeat() is called)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'DeactivateButtonEvent'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.DeactivateButtonEvent.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.red_button_scripts.</code><code class="sig-name descname">OpenLidState</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/red_button_scripts.html#OpenLidState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.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 manages the cmdset for the “open” button state. This will add
|
||
the RedButtonOpen</p>
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.DoesNotExist">
|
||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.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></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.MultipleObjectsReturned">
|
||
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.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></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <Options for OpenLidState></em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.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/red_button_scripts.html#OpenLidState.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.at_script_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called when script first created.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.at_start">
|
||
<code class="sig-name descname">at_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#OpenLidState.at_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.at_start" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This is called once every server restart, so we want to add the
|
||
(memory-resident) cmdset to the object here. is_valid is
|
||
automatically checked, so we don’t need to worry about
|
||
adding the cmdset to a closed lid-button.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.at_stop">
|
||
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#OpenLidState.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.at_stop" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When the script stops (like if the lid is closed again)
|
||
we must make sure to clean up after us.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.is_valid">
|
||
<code class="sig-name descname">is_valid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/red_button_scripts.html#OpenLidState.is_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.is_valid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The script is only valid while the lid is open.
|
||
self.obj is the red_button on which this script is defined.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.typename">
|
||
<code class="sig-name descname">typename</code><em class="property"> = 'OpenLidState'</em><a class="headerlink" href="#evennia.contrib.tutorial_examples.red_button_scripts.OpenLidState.typename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-evennia.contrib.tutorial_examples.tests">
|
||
<span id="evennia-contrib-tutorial-examples-tests-module"></span><h2>evennia.contrib.tutorial_examples.tests module<a class="headerlink" href="#module-evennia.contrib.tutorial_examples.tests" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="evennia.contrib.tutorial_examples.tests.TestBodyFunctions">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.tutorial_examples.tests.</code><code class="sig-name descname">TestBodyFunctions</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/tests.html#TestBodyFunctions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.tests.TestBodyFunctions" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.html#evennia.utils.test_resources.EvenniaTest" title="evennia.utils.test_resources.EvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaTest</span></code></a></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.contrib.tutorial_examples.tests.TestBodyFunctions.script_typeclass">
|
||
<code class="sig-name descname">script_typeclass</code><a class="headerlink" href="#evennia.contrib.tutorial_examples.tests.TestBodyFunctions.script_typeclass" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="#evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions" title="evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.tutorial_examples.bodyfunctions.BodyFunctions</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.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/tutorial_examples/tests.html#TestBodyFunctions.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.tests.TestBodyFunctions.setUp" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets up testing environment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.contrib.tutorial_examples.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/tutorial_examples/tests.html#TestBodyFunctions.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.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="method">
|
||
<dt id="evennia.contrib.tutorial_examples.tests.TestBodyFunctions.test_at_repeat">
|
||
<code class="sig-name descname">test_at_repeat</code><span class="sig-paren">(</span><em class="sig-param">mock_random</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/tests.html#TestBodyFunctions.test_at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.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="method">
|
||
<dt id="evennia.contrib.tutorial_examples.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">mock_random</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/tutorial_examples/tests.html#TestBodyFunctions.test_send_random_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.tutorial_examples.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>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<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>
|
||
<p><h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">evennia.contrib.tutorial_examples package</a><ul>
|
||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.contrib.tutorial_examples.bodyfunctions">evennia.contrib.tutorial_examples.bodyfunctions module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.contrib.tutorial_examples.cmdset_red_button">evennia.contrib.tutorial_examples.cmdset_red_button module</a></li>
|
||
<li><a class="reference internal" href="#evennia-contrib-tutorial-examples-example-batch-code-module">evennia.contrib.tutorial_examples.example_batch_code module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.contrib.tutorial_examples.red_button">evennia.contrib.tutorial_examples.red_button module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.contrib.tutorial_examples.red_button_scripts">evennia.contrib.tutorial_examples.red_button_scripts module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.contrib.tutorial_examples.tests">evennia.contrib.tutorial_examples.tests module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="../index.html">Documentation overview</a><ul>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<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.rst.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="evennia.contrib.tutorial_examples.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="../../../versions/0.9.1/api/evennia.contrib.tutorial_examples.html">0.9.1 (master branch)</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2020, The Evennia developer community.
|
||
|
||
|
|
||
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
|
||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||
|
||
|
|
||
<a href="../_sources/api/evennia.contrib.tutorial_examples.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |