Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-22 15:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-10-11 22:19:29 +02:00
parent 885c0d65fb
commit d885333616
1664 changed files with 63394 additions and 54245 deletions
Download patch file Download diff file Expand all files Collapse all files

122
docs/1.0-dev/api/evennia.scripts.scripts.html
View file

@ -1,10 +1,9 @@
<!DOCTYPE html>
<html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>evennia.scripts.scripts &#8212; Evennia 1.0-dev documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -26,8 +25,7 @@
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.scripts.scripts</a></li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
</ul>
</div>
@ -41,16 +39,16 @@
<p>This module defines Scripts, out-of-character entities that can store
data both on themselves and on other objects while also having the
ability to run timers.</p>
<dl class="py class">
<dl class="class">
<dt id="evennia.scripts.scripts.DefaultScript">
<em class="property">class </em><code class="sig-prename descclassname">evennia.scripts.scripts.</code><code class="sig-name descname">DefaultScript</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">evennia.scripts.scripts.</code><code class="sig-name descname">DefaultScript</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/scripts/scripts.html#DefaultScript"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript" 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.ScriptBase</span></code></p>
<p>This is the base TypeClass for all Scripts. Scripts describe
events, timers and states in game, they can have a time component
or describe a state that changes under certain conditions.</p>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.create">
<em class="property">classmethod </em><code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.create" title="Permalink to this definition"></a></dt>
<em class="property">classmethod </em><code class="sig-name descname">create</code><span class="sig-paren">(</span><em class="sig-param">key</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.create" title="Permalink to this definition"></a></dt>
<dd><p>Provides a passthrough interface to the utils.create_script() function.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -63,13 +61,13 @@ errors (list): A list of errors in string form, if any.</p>
</dl>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.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/scripts/scripts.html#DefaultScript.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_script_creation" title="Permalink to this definition"></a></dt>
<dd><p>Only called once, when script is first created.</p>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.time_until_next_repeat">
<code class="sig-name descname">time_until_next_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.time_until_next_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.time_until_next_repeat" title="Permalink to this definition"></a></dt>
<dd><p>Get time until the script fires it <strong>at_repeat</strong> hook again.</p>
@ -89,7 +87,7 @@ system; it’s only here for the user to be able to check in
on their scripts and when they will next be run.</p>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.remaining_repeats">
<code class="sig-name descname">remaining_repeats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.remaining_repeats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.remaining_repeats" title="Permalink to this definition"></a></dt>
<dd><p>Get the number of returning repeats for limited Scripts.</p>
@ -106,15 +104,15 @@ if it has unlimited repeats.</p>
</dl>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.at_idmapper_flush">
<code class="sig-name descname">at_idmapper_flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_idmapper_flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_idmapper_flush" title="Permalink to this definition"></a></dt>
<dd><p>If we’re flushing this object, make sure the LoopingCall is gone too</p>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">force_restart</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.start" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">start</code><span class="sig-paren">(</span><em class="sig-param">force_restart=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.start" title="Permalink to this definition"></a></dt>
<dd><p>Called every time the script is started (for persistent
scripts, this is usually once every server start)</p>
<dl class="field-list simple">
@ -135,9 +133,9 @@ the script, regardless of if it has started before.</p>
</dl>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.stop">
<code class="sig-name descname">stop</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">kill</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.stop" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">stop</code><span class="sig-paren">(</span><em class="sig-param">kill=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.stop" title="Permalink to this definition"></a></dt>
<dd><p>Called to stop the script from running. This also deletes the
script.</p>
<dl class="field-list simple">
@ -159,16 +157,16 @@ script.</p>
</dl>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.pause">
<code class="sig-name descname">pause</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">manual_pause</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.pause"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.pause" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">pause</code><span class="sig-paren">(</span><em class="sig-param">manual_pause=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.pause"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.pause" title="Permalink to this definition"></a></dt>
<dd><p>This stops a running script and stores its active state.
It WILL NOT call the <strong>at_stop()</strong> hook.</p>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.unpause">
<code class="sig-name descname">unpause</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">manual_unpause</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.unpause"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.unpause" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">unpause</code><span class="sig-paren">(</span><em class="sig-param">manual_unpause=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.unpause"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.unpause" title="Permalink to this definition"></a></dt>
<dd><p>Restart a paused script. This WILL call the <strong>at_start()</strong> hook.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -186,9 +184,9 @@ and so should not the auto-unpaused.</p>
</dl>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.restart">
<code class="sig-name descname">restart</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">interval</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">repeats</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_delay</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.restart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.restart" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">restart</code><span class="sig-paren">(</span><em class="sig-param">interval=None</em>, <em class="sig-param">repeats=None</em>, <em class="sig-param">start_delay=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.restart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.restart" title="Permalink to this definition"></a></dt>
<dd><p>Restarts an already existing/running Script from the
beginning, optionally using different settings. This will
first call the stop hooks, and then the start hooks again.
@ -208,9 +206,9 @@ before starting or not. If <strong>None</strong>, re-use the previous setting.</
</dl>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.reset_callcount">
<code class="sig-name descname">reset_callcount</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.reset_callcount"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.reset_callcount" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">reset_callcount</code><span class="sig-paren">(</span><em class="sig-param">value=0</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.reset_callcount"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.reset_callcount" title="Permalink to this definition"></a></dt>
<dd><p>Reset the count of the number of calls done.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -222,7 +220,7 @@ is to set it all the way back to 0.</p>
<p>This is only useful if repeats != 0.</p>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.force_repeat">
<code class="sig-name descname">force_repeat</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.force_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.force_repeat" title="Permalink to this definition"></a></dt>
<dd><p>Fire a premature triggering of the script callback. This
@ -230,7 +228,7 @@ will reset the timer and count down repeats as if the script
had fired normally.</p>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.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/scripts/scripts.html#DefaultScript.is_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.is_valid" title="Permalink to this definition"></a></dt>
<dd><p>Is called to check if the script is valid to run at this time.
@ -238,9 +236,9 @@ Should return a boolean. The method is assumed to collect all
needed information from its related self.obj.</p>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.at_start">
<code class="sig-name descname">at_start</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_start" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">at_start</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_start" title="Permalink to this definition"></a></dt>
<dd><p>Called whenever the script is started, which for persistent
scripts is at least once every server start. It will also be
called when starting again after a pause (such as after a
@ -253,9 +251,9 @@ overriding the call (unused by default).</p>
</dl>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.at_repeat">
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_repeat" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">at_repeat</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_repeat" title="Permalink to this definition"></a></dt>
<dd><p>Called repeatedly if this Script is set to repeat regularly.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -265,9 +263,9 @@ overriding the call (unused by default).</p>
</dl>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.at_stop">
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_stop" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">at_stop</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_stop" title="Permalink to this definition"></a></dt>
<dd><p>Called whenever when it’s time for this script to stop (either
because is_valid returned False or it runs out of iterations)</p>
<dl class="simple">
@ -279,7 +277,7 @@ because is_valid returned False or it runs out of iterations)</p>
</dl>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.at_server_reload">
<code class="sig-name descname">at_server_reload</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_server_reload"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_server_reload" title="Permalink to this definition"></a></dt>
<dd><p>This hook is called whenever the server is shutting down for
@ -288,101 +286,101 @@ non-persistent properties across a restart, this is the place
to do it.</p>
</dd></dl>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DefaultScript.at_server_shutdown">
<code class="sig-name descname">at_server_shutdown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_server_shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_server_shutdown" title="Permalink to this definition"></a></dt>
<dd><p>This hook is called whenever the server is shutting down fully
(i.e. not for a restart).</p>
</dd></dl>
<dl class="py exception">
<dl class="exception">
<dt id="evennia.scripts.scripts.DefaultScript.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.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.ScriptBase.DoesNotExist</span></code></p>
<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="py exception">
<dl class="exception">
<dt id="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.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.ScriptBase.MultipleObjectsReturned</span></code></p>
<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="py attribute">
<dl class="attribute">
<dt id="evennia.scripts.scripts.DefaultScript.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.scripts.scripts.DefaultScript'</em><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dl class="attribute">
<dt id="evennia.scripts.scripts.DefaultScript.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'DefaultScript'</em><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="evennia.scripts.scripts.DoNothing">
<em class="property">class </em><code class="sig-prename descclassname">evennia.scripts.scripts.</code><code class="sig-name descname">DoNothing</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DoNothing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DoNothing" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">evennia.scripts.scripts.</code><code class="sig-name descname">DoNothing</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/scripts/scripts.html#DoNothing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DoNothing" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#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>A script that does nothing. Used as default fallback.</p>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.DoNothing.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/scripts/scripts.html#DoNothing.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DoNothing.at_script_creation" title="Permalink to this definition"></a></dt>
<dd><p>Setup the script</p>
</dd></dl>
<dl class="py exception">
<dl class="exception">
<dt id="evennia.scripts.scripts.DoNothing.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.scripts.scripts.DoNothing.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
<dd><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="py exception">
<dl class="exception">
<dt id="evennia.scripts.scripts.DoNothing.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.scripts.scripts.DoNothing.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
<dd><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="py attribute">
<dl class="attribute">
<dt id="evennia.scripts.scripts.DoNothing.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.scripts.scripts.DoNothing'</em><a class="headerlink" href="#evennia.scripts.scripts.DoNothing.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dl class="attribute">
<dt id="evennia.scripts.scripts.DoNothing.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'DoNothing'</em><a class="headerlink" href="#evennia.scripts.scripts.DoNothing.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dl class="class">
<dt id="evennia.scripts.scripts.Store">
<em class="property">class </em><code class="sig-prename descclassname">evennia.scripts.scripts.</code><code class="sig-name descname">Store</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#Store"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.Store" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">evennia.scripts.scripts.</code><code class="sig-name descname">Store</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/scripts/scripts.html#Store"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.Store" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#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>Simple storage script</p>
<dl class="py method">
<dl class="method">
<dt id="evennia.scripts.scripts.Store.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/scripts/scripts.html#Store.at_script_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.Store.at_script_creation" title="Permalink to this definition"></a></dt>
<dd><p>Setup the script</p>
</dd></dl>
<dl class="py exception">
<dl class="exception">
<dt id="evennia.scripts.scripts.Store.DoesNotExist">
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.scripts.scripts.Store.DoesNotExist" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.DoesNotExist</span></code></a></p>
<dd><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="py exception">
<dl class="exception">
<dt id="evennia.scripts.scripts.Store.MultipleObjectsReturned">
<em class="property">exception </em><code class="sig-name descname">MultipleObjectsReturned</code><a class="headerlink" href="#evennia.scripts.scripts.Store.MultipleObjectsReturned" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned</span></code></a></p>
<dd><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="py attribute">
<dl class="attribute">
<dt id="evennia.scripts.scripts.Store.path">
<code class="sig-name descname">path</code><em class="property"> = 'evennia.scripts.scripts.Store'</em><a class="headerlink" href="#evennia.scripts.scripts.Store.path" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dl class="attribute">
<dt id="evennia.scripts.scripts.Store.typename">
<code class="sig-name descname">typename</code><em class="property"> = 'Store'</em><a class="headerlink" href="#evennia.scripts.scripts.Store.typename" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
@ -392,7 +390,6 @@ to do it.</p>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
@ -421,7 +418,7 @@ to do it.</p>
<h3>Versions</h3>
<ul>
<li><a href="evennia.scripts.scripts.html">1.0-dev (develop branch)</a></li>
<li><a href="../../0.9.1/api/evennia.scripts.scripts.html">0.9.1 (master branch)</a></li>
<li><a href="../../0.9.5/api/evennia.scripts.scripts.html">0.9.5 (master branch)</a></li>
</ul>
</div>
@ -437,13 +434,12 @@ to do it.</p>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.scripts.scripts</a></li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.1.1.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
</div>
</body>
</html>