mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
245 lines
No EOL
18 KiB
HTML
245 lines
No EOL
18 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>evennia.contrib.full_systems.evscaperoom.scripts — Evennia latest documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
|
||
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
|
||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<link rel="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.contrib.full_systems.evscaperoom.state" href="evennia.contrib.full_systems.evscaperoom.state.html" />
|
||
<link rel="prev" title="evennia.contrib.full_systems.evscaperoom.room" href="evennia.contrib.full_systems.evscaperoom.room.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<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.contrib.full_systems.evscaperoom.state.html" title="evennia.contrib.full_systems.evscaperoom.state"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.contrib.full_systems.evscaperoom.room.html" title="evennia.contrib.full_systems.evscaperoom.room"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</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.contrib.html" >evennia.contrib</a> »</li>
|
||
<li class="nav-item nav-item-5"><a href="evennia.contrib.full_systems.html" >evennia.contrib.full_systems</a> »</li>
|
||
<li class="nav-item nav-item-6"><a href="evennia.contrib.full_systems.evscaperoom.html" accesskey="U">evennia.contrib.full_systems.evscaperoom</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.scripts</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-evennia.contrib.full_systems.evscaperoom.scripts">
|
||
<span id="evennia-contrib-full-systems-evscaperoom-scripts"></span><h1>evennia.contrib.full_systems.evscaperoom.scripts<a class="headerlink" href="#module-evennia.contrib.full_systems.evscaperoom.scripts" title="Link to this heading">¶</a></h1>
|
||
<p>A simple cleanup script to wipe empty rooms</p>
|
||
<p>(This can happen if users leave ‘uncleanly’, such as by closing their browser
|
||
window)</p>
|
||
<p>Just start this global script manually or at server creation.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.full_systems.evscaperoom.scripts.</span></span><span class="sig-name descname"><span class="pre">CleanupScript</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_typeclass_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_date_created</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_lock_storage</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_desc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_obj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_account</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_interval</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_start_delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_repeats</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_persistent</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db_is_active</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/scripts.html#CleanupScript"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript" title="evennia.scripts.scripts.DefaultScript"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefaultScript</span></code></a></p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_script_creation">
|
||
<span class="sig-name descname"><span class="pre">at_script_creation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/scripts.html#CleanupScript.at_script_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_script_creation" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Only called once, when script is first created.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_repeat">
|
||
<span class="sig-name descname"><span class="pre">at_repeat</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/full_systems/evscaperoom/scripts.html#CleanupScript.at_repeat"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_repeat" title="Link 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<span class="colon">:</span></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 exception">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.DoesNotExist">
|
||
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DoesNotExist</span></span><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.DoesNotExist" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist" title="evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoesNotExist</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.MultipleObjectsReturned">
|
||
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MultipleObjectsReturned</span></span><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.MultipleObjectsReturned" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py exception">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.NotUpdated">
|
||
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">NotUpdated</span></span><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.NotUpdated" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.NotUpdated" title="evennia.scripts.scripts.DefaultScript.NotUpdated"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotUpdated</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.path">
|
||
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.path" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.typename">
|
||
<span class="sig-name descname"><span class="pre">typename</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CleanupScript'</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.typename" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
|
||
</a></p>
|
||
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">evennia.contrib.full_systems.evscaperoom.scripts</a><ul>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript"><code class="docutils literal notranslate"><span class="pre">CleanupScript</span></code></a><ul>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_script_creation"><code class="docutils literal notranslate"><span class="pre">CleanupScript.at_script_creation()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_repeat"><code class="docutils literal notranslate"><span class="pre">CleanupScript.at_repeat()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">CleanupScript.DoesNotExist</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">CleanupScript.MultipleObjectsReturned</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.NotUpdated"><code class="docutils literal notranslate"><span class="pre">CleanupScript.NotUpdated</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.path"><code class="docutils literal notranslate"><span class="pre">CleanupScript.path</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.typename"><code class="docutils literal notranslate"><span class="pre">CleanupScript.typename</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="evennia.contrib.full_systems.evscaperoom.room.html"
|
||
title="previous chapter">evennia.contrib.full_systems.evscaperoom.room</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="evennia.contrib.full_systems.evscaperoom.state.html"
|
||
title="next chapter">evennia.contrib.full_systems.evscaperoom.state</a></p>
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.contrib.full_systems.evscaperoom.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="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
|
||
</li>
|
||
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="Related">
|
||
<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.contrib.full_systems.evscaperoom.state.html" title="evennia.contrib.full_systems.evscaperoom.state"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.contrib.full_systems.evscaperoom.room.html" title="evennia.contrib.full_systems.evscaperoom.room"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</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.contrib.html" >evennia.contrib</a> »</li>
|
||
<li class="nav-item nav-item-5"><a href="evennia.contrib.full_systems.html" >evennia.contrib.full_systems</a> »</li>
|
||
<li class="nav-item nav-item-6"><a href="evennia.contrib.full_systems.evscaperoom.html" >evennia.contrib.full_systems.evscaperoom</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.full_systems.evscaperoom.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> 8.2.3.
|
||
</div>
|
||
</body>
|
||
</html> |