mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 13:56:30 +01:00
487 lines
No EOL
29 KiB
HTML
487 lines
No EOL
29 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<title>evennia.scripts.scripts — Evennia latest documentation</title>
|
||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/language_data.js"></script>
|
||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="evennia.scripts.taskhandler" href="evennia.scripts.taskhandler.html" />
|
||
<link rel="prev" title="evennia.scripts.scripthandler" href="evennia.scripts.scripthandler.html" />
|
||
</head><body>
|
||
|
||
|
||
|
||
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.scripts.taskhandler.html" title="evennia.scripts.taskhandler"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.scripts.scripthandler.html" title="evennia.scripts.scripthandler"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.scripts.html" accesskey="U">evennia.scripts</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.scripts.scripts</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
|
||
<div class="documentwrapper">
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||
</a></p>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="evennia.scripts.scripthandler.html"
|
||
title="previous chapter">evennia.scripts.scripthandler</a></p>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="evennia.scripts.taskhandler.html"
|
||
title="next chapter">evennia.scripts.taskhandler</a></p>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.scripts.scripts.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div><h3>Links</h3>
|
||
<ul>
|
||
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
|
||
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
||
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
|
||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||
<li>
|
||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||
</li>
|
||
</ul>
|
||
<h3>Doc Versions</h3>
|
||
<ul>
|
||
|
||
<li><a href="evennia.scripts.scripts.html">latest (main branch)</a></li>
|
||
|
||
<li><a href="../4.x/index.html">v4.0.0 branch (outdated)</a></li>
|
||
|
||
<li><a href="../3.x/index.html">v3.0.0 branch (outdated)</a></li>
|
||
|
||
<li><a href="../2.x/index.html">v2.0.0 branch (outdated)</a></li>
|
||
|
||
<li><a href="../1.x/index.html">v1.0.0 branch (outdated)</a></li>
|
||
|
||
<li><a href="../0.x/index.html">v0.9.5 branch (outdated)</a></li>
|
||
|
||
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-evennia.scripts.scripts">
|
||
<span id="evennia-scripts-scripts"></span><h1>evennia.scripts.scripts<a class="headerlink" href="#module-evennia.scripts.scripts" title="Permalink to this headline">¶</a></h1>
|
||
<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">
|
||
<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>
|
||
<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
|
||
all entities/systems without a physical existence in the game world
|
||
that require database storage (like an economic system or
|
||
combat tracker). They
|
||
can also have a timer/ticker component.</p>
|
||
<p>A script type is customized by redefining some or all of its hook
|
||
methods and variables.</p>
|
||
<ul class="simple">
|
||
<li><p>available properties (check docs for full listing, this could be
|
||
outdated).</p></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div><p>key (string) - name of object
|
||
name (string)- same as key
|
||
aliases (list of strings) - aliases to the object. Will be saved</p>
|
||
<blockquote>
|
||
<div><p>to database as AliasDB entries but returned as strings.</p>
|
||
</div></blockquote>
|
||
<p>dbref (int, read-only) - unique #id-number. Also “id” can be used.
|
||
date_created (string) - time stamp of object creation
|
||
permissions (list of strings) - list of permission strings</p>
|
||
<p>desc (string) - optional description of script, shown in listings
|
||
obj (Object) - optional object that this script is connected to</p>
|
||
<blockquote>
|
||
<div><p>and acts on (set automatically by obj.scripts.add())</p>
|
||
</div></blockquote>
|
||
<dl class="simple">
|
||
<dt>interval (int) - how often script should run, in seconds. <0 turns</dt><dd><p>off ticker</p>
|
||
</dd>
|
||
<dt>start_delay (bool) - if the script should start repeating right away or</dt><dd><p>wait self.interval seconds</p>
|
||
</dd>
|
||
<dt>repeats (int) - how many times the script should repeat before</dt><dd><p>stopping. 0 means infinite repeats</p>
|
||
</dd>
|
||
</dl>
|
||
<p>persistent (bool) - if script should survive a server shutdown or not
|
||
is_active (bool) - if script is currently running</p>
|
||
</div></blockquote>
|
||
<ul class="simple">
|
||
<li><p>Handlers</p></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div><p>locks - lock-handler: use locks.add() to add new lock strings
|
||
db - attribute-handler: store/retrieve database attributes on this</p>
|
||
<blockquote>
|
||
<div><p>self.db.myattr=val, val=self.db.myattr</p>
|
||
</div></blockquote>
|
||
<dl class="simple">
|
||
<dt>ndb - non-persistent attribute handler: same as db but does not</dt><dd><p>create a database entry when storing data</p>
|
||
</dd>
|
||
</dl>
|
||
</div></blockquote>
|
||
<ul class="simple">
|
||
<li><p>Helper methods</p></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div><p>create(key, <a href="#id1"><span class="problematic" id="id2">**</span></a>kwargs)
|
||
start() - start script (this usually happens automatically at creation</p>
|
||
<blockquote>
|
||
<div><p>and obj.script.add() etc)</p>
|
||
</div></blockquote>
|
||
<p>stop() - stop script, and delete it
|
||
pause() - put the script on hold, until unpause() is called. If script</p>
|
||
<blockquote>
|
||
<div><p>is persistent, the pause state will survive a shutdown.</p>
|
||
</div></blockquote>
|
||
<dl class="simple">
|
||
<dt>unpause() - restart a previously paused script. The script will continue</dt><dd><p>from the paused timer (but at_start() will be called).</p>
|
||
</dd>
|
||
<dt>time_until_next_repeat() - if a timed script (interval>0), returns time</dt><dd><p>until next tick</p>
|
||
</dd>
|
||
</dl>
|
||
</div></blockquote>
|
||
<ul class="simple">
|
||
<li><p>Hook methods (should also include self as the first argument):</p></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div><dl>
|
||
<dt>at_script_creation() - called only once, when an object of this</dt><dd><p>class is first created.</p>
|
||
</dd>
|
||
<dt>is_valid() - is called to check if the script is valid to be running</dt><dd><blockquote>
|
||
<div><p>at the current time. If is_valid() returns False, the running
|
||
script is stopped and removed from the game. You can use this
|
||
to check state changes (i.e. an script tracking some combat
|
||
stats at regular intervals is only valid to run while there is
|
||
actual combat going on).</p>
|
||
</div></blockquote>
|
||
<dl class="simple">
|
||
<dt>at_start() - Called every time the script is started, which for persistent</dt><dd><p>scripts is at least once every server start. Note that this is
|
||
unaffected by self.delay_start, which only delays the first
|
||
call to at_repeat().</p>
|
||
</dd>
|
||
<dt>at_repeat() - Called every self.interval seconds. It will be called</dt><dd><p>immediately upon launch unless self.delay_start is True, which
|
||
will delay the first call of this method by self.interval
|
||
seconds. If self.interval==0, this method will never
|
||
be called.</p>
|
||
</dd>
|
||
</dl>
|
||
<p>at_pause()
|
||
at_stop() - Called as the script object is stopped and is about to be</p>
|
||
<blockquote>
|
||
<div><p>removed from the game, e.g. because is_valid() returned False.</p>
|
||
</div></blockquote>
|
||
<p>at_script_delete()
|
||
at_server_reload() - Called when server reloads. Can be used to</p>
|
||
<blockquote>
|
||
<div><p>save temporary variables you want should survive a reload.</p>
|
||
</div></blockquote>
|
||
<p>at_server_shutdown() - called at a full server shutdown.
|
||
at_server_start()</p>
|
||
</dd>
|
||
</dl>
|
||
</div></blockquote>
|
||
<dl class="py 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>
|
||
<dd><p>Provides a passthrough interface to the utils.create_script() function.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>key</strong> (<em>str</em>) – Name of the new object.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><em>object (Object)</em> – A newly created object of the given typeclass.
|
||
errors (list): A list of errors in string form, if any.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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">
|
||
<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’s timer is valid to run at this time.
|
||
Should return a boolean. If False, the timer will be stopped.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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>
|
||
<dd><p>Called whenever the script timer is started, which for persistent
|
||
timed scripts is at least once every server start. It will also be
|
||
called when starting again after a pause (including after a
|
||
server reload).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||
overriding the call (unused by default).</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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>
|
||
<dd><p>Called repeatedly if this Script is set to repeat regularly.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||
overriding the call (unused by default).</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.scripts.scripts.DefaultScript.at_pause">
|
||
<code class="sig-name descname">at_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>, <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_pause"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_pause" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called when this script’s timer pauses.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>manual_pause</strong> (<em>bool</em>) – If set, pausing was done by a direct call. The
|
||
non-manual pause indicates the script was paused as part of
|
||
the server reload.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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>
|
||
<dd><p>Called whenever when it’s time for this script’s timer to stop (either
|
||
because is_valid returned False, it ran out of iterations or it was manuallys
|
||
stopped.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
|
||
overriding the call (unused by default).</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.scripts.scripts.DefaultScript.at_script_delete">
|
||
<code class="sig-name descname">at_script_delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_script_delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_script_delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Called when the Script is deleted, before stopping the timer.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p><em>bool</em> – If False, the deletion is aborted.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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
|
||
restart/reboot. If you want to, for example, save
|
||
non-persistent properties across a restart, this is the place
|
||
to do it.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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 method">
|
||
<dt id="evennia.scripts.scripts.DefaultScript.at_server_start">
|
||
<code class="sig-name descname">at_server_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/scripts/scripts.html#DefaultScript.at_server_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.at_server_start" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This hook is called after the server has started. It can be used to add
|
||
post-startup setup for Scripts without a timer component (for which at_start
|
||
could be used).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py 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></dl>
|
||
|
||
<dl class="py 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></dl>
|
||
|
||
<dl class="py 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">
|
||
<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">
|
||
<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>
|
||
<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">
|
||
<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">
|
||
<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></dl>
|
||
|
||
<dl class="py 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></dl>
|
||
|
||
<dl class="py 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">
|
||
<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">
|
||
<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>
|
||
<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">
|
||
<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">
|
||
<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></dl>
|
||
|
||
<dl class="py 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></dl>
|
||
|
||
<dl class="py 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">
|
||
<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>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="../genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.scripts.taskhandler.html" title="evennia.scripts.taskhandler"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.scripts.scripthandler.html" title="evennia.scripts.scripthandler"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.scripts.html" >evennia.scripts</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.scripts.scripts</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2024, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |