2020-07-14 00:21:00 +02:00
<!DOCTYPE html>
2020-10-15 01:31:30 +02:00
< html >
2020-07-14 00:21:00 +02:00
< head >
< meta charset = "utf-8" / >
2021-05-16 00:06:01 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.17.1: http://docutils.sourceforge.net/" / >
2022-01-08 16:38:41 +01:00
< title > evennia.contrib.full_systems.evscaperoom.scripts — Evennia 1.0-dev documentation< / title >
2020-07-14 00:21:00 +02:00
< 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 >
2021-10-26 21:41:11 +02:00
< script async = "async" src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML" > < / script >
< script type = "text/x-mathjax-config" > MathJax . Hub . Config ( { "tex2jax" : { "processClass" : "tex2jax_process|mathjax_process|math|output_area" } } ) < / script >
2020-07-14 00:21:00 +02:00
< link rel = "shortcut icon" href = "../_static/favicon.ico" / >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.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 >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 1.0-dev< / a > » < / li >
2022-01-08 16:38:41 +01:00
< li class = "nav-item nav-item-this" > < a href = "" > evennia.contrib.full_systems.evscaperoom.scripts< / a > < / li >
2020-07-14 00:21:00 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-07-14 00:21:00 +02:00
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2022-01-08 16:38:41 +01:00
< 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 = "Permalink to this headline" > ¶< / a > < / h1 >
< p > A simple cleanup script to wipe empty rooms< / p >
< p > (This can happen if users leave ‘ ’
window)< / p >
< p > Just start this global script manually or at server creation.< / p >
2020-10-15 01:31:30 +02:00
< dl class = "py class" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript" >
< em class = "property" > class < / em > < code class = "sig-prename descclassname" > evennia.contrib.full_systems.evscaperoom.scripts.< / code > < code class = "sig-name descname" > CleanupScript< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > id< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_key< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_typeclass_path< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_date_created< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_lock_storage< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_desc< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_obj< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_account< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_interval< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_start_delay< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_repeats< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_persistent< / span > < / em > , < em class = "sig-param" > < span class = "n" > db_is_active< / 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" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-07-14 00:21:00 +02:00
< 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" > evennia.scripts.scripts.DefaultScript< / span > < / code > < / a > < / p >
2020-10-15 01:31:30 +02:00
< dl class = "py method" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.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/full_systems/evscaperoom/scripts.html#CleanupScript.at_script_creation" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.at_script_creation" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-07-14 00:21:00 +02:00
< dd > < p > Only called once, when script is first created.< / p >
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py method" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.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/full_systems/evscaperoom/scripts.html#CleanupScript.at_repeat" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.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 > ) –
overriding the call (unused by default).< / p >
< / dd >
< / dl >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py exception" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.DoesNotExist" >
< em class = "property" > exception < / em > < code class = "sig-name descname" > DoesNotExist< / code > < a class = "headerlink" href = "#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.DoesNotExist" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-10-15 01:31:30 +02:00
< 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" > evennia.scripts.scripts.DefaultScript.DoesNotExist< / span > < / code > < / a > < / p >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py exception" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.MultipleObjectsReturned" >
< em class = "property" > exception < / em > < code class = "sig-name descname" > MultipleObjectsReturned< / code > < a class = "headerlink" href = "#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.MultipleObjectsReturned" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-10-15 01:31:30 +02:00
< 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" > evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned< / span > < / code > < / a > < / p >
2020-07-14 00:21:00 +02:00
< / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.path" >
< code class = "sig-name descname" > path< / code > < em class = "property" > = 'evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript'< / em > < a class = "headerlink" href = "#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.path" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-07-14 00:21:00 +02:00
< dd > < / dd > < / dl >
2020-10-15 01:31:30 +02:00
< dl class = "py attribute" >
2022-01-08 16:38:41 +01:00
< dt id = "evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.typename" >
< code class = "sig-name descname" > typename< / code > < em class = "property" > = 'CleanupScript'< / em > < a class = "headerlink" href = "#evennia.contrib.full_systems.evscaperoom.scripts.CleanupScript.typename" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-07-14 00:21:00 +02:00
< dd > < / dd > < / dl >
< / dd > < / dl >
2021-05-16 00:06:01 +02:00
< / section >
2020-07-14 00:21:00 +02:00
2020-10-15 01:31:30 +02:00
< div class = "clearer" > < / div >
2020-07-14 00:21:00 +02:00
< / div >
< / div >
< / div >
< 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 >
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
2022-01-08 16:38:41 +01:00
< li > < a href = "../_sources/api/evennia.contrib.full_systems.evscaperoom.scripts.md.txt"
2020-07-14 00:21:00 +02:00
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
2021-03-06 01:37:43 +01:00
< / div > < h3 > Links< / h3 >
< ul >
< li > < a href = "https://www.evennia.com" > Home page< / a > < / li >
< li > < a href = "https://github.com/evennia/evennia" > Evennia Github< / a > < / li >
< li > < a href = "http://games.evennia.com" > Game Index< / a > < / li >
2021-08-06 00:47:51 +02:00
< li >
< a href = "https://discord.gg/AJJpcRUhtF" > Discord< / a > -
< a href = "https://github.com/evennia/evennia/discussions" > Discussions< / a > -
2021-08-06 00:53:44 +02:00
< a href = "https://evennia.blogspot.com/" > Blog< / a >
2021-03-06 01:37:43 +01:00
< / li >
< / ul >
2020-07-14 00:21:00 +02:00
< h3 > Versions< / h3 >
< ul >
2022-01-08 16:38:41 +01:00
< li > < a href = "evennia.contrib.full_systems.evscaperoom.scripts.html" > 1.0-dev (develop branch)< / a > < / li >
2020-07-14 00:21:00 +02:00
< / ul >
< / div >
< / div >
< div class = "clearer" > < / 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 >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 1.0-dev< / a > » < / li >
2022-01-08 16:38:41 +01:00
< li class = "nav-item nav-item-this" > < a href = "" > evennia.contrib.full_systems.evscaperoom.scripts< / a > < / li >
2020-07-14 00:21:00 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-07-14 00:21:00 +02:00
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright 2020, The Evennia developer community.
2020-10-15 01:31:30 +02:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
2020-07-14 00:21:00 +02:00
< / div >
< / body >
< / html >
