Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-05 23:47:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-07-14 00:21:00 +02:00
parent a551188691
commit 781788f2e5
2063 changed files with 215958 additions and 250783 deletions
Download patch file Download diff file Expand all files Collapse all files

58
docs/1.0-dev/_modules/evennia/contrib/ingame_python/scripts.html
View file

@ -1,19 +1,18 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>evennia.contrib.ingame_python.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" />
<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" />
@ -27,12 +26,10 @@
<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 documentation</a> &#187;</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-1"><a href="../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../../evennia.html" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.ingame_python.scripts</a></li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.scripts</a></li>
</ul>
</div>
@ -66,7 +63,7 @@
<span class="n">RE_LINE_ERROR</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s1">&#39;^ File &quot;\&lt;string\&gt;&quot;, line (\d+)&#39;</span><span class="p">)</span>
<div class="viewcode-block" id="EventHandler"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler">[docs]</a><span class="k">class</span> <span class="nc">EventHandler</span><span class="p">(</span><span class="n">DefaultScript</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler">[docs]</a><span class="k">class</span> <span class="nc">EventHandler</span><span class="p">(</span><span class="n">DefaultScript</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> The event handler that contains all events in a global script.</span>
@ -78,7 +75,7 @@
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="EventHandler.at_script_creation"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.at_script_creation">[docs]</a> <span class="k">def</span> <span class="nf">at_script_creation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.at_script_creation"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.at_script_creation">[docs]</a> <span class="k">def</span> <span class="nf">at_script_creation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Hook called when the script is created.&quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="s2">&quot;event_handler&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">desc</span> <span class="o">=</span> <span class="s2">&quot;Global event handler&quot;</span>
@ -92,7 +89,7 @@
<span class="c1"># Tasks</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">tasks</span> <span class="o">=</span> <span class="p">{}</span></div>
<div class="viewcode-block" id="EventHandler.at_start"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.at_start">[docs]</a> <span class="k">def</span> <span class="nf">at_start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.at_start"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.at_start">[docs]</a> <span class="k">def</span> <span class="nf">at_start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Set up the event system when starting.</span>
<span class="sd"> Note that this hook is called every time the server restarts</span>
@ -145,7 +142,7 @@
<span class="n">locks</span><span class="o">=</span><span class="s2">&quot;control:false();listen:perm(Builders);send:false()&quot;</span><span class="p">,</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="EventHandler.get_events"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.get_events">[docs]</a> <span class="k">def</span> <span class="nf">get_events</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.get_events"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.get_events">[docs]</a> <span class="k">def</span> <span class="nf">get_events</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return a dictionary of events on this object.</span>
@ -192,7 +189,7 @@
<span class="k">return</span> <span class="n">events</span></div>
<div class="viewcode-block" id="EventHandler.get_variable"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.get_variable">[docs]</a> <span class="k">def</span> <span class="nf">get_variable</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">variable_name</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.get_variable"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.get_variable">[docs]</a> <span class="k">def</span> <span class="nf">get_variable</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">variable_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return the variable defined in the locals.</span>
@ -217,7 +214,7 @@
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ndb</span><span class="o">.</span><span class="n">current_locals</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">variable_name</span><span class="p">)</span></div>
<div class="viewcode-block" id="EventHandler.get_callbacks"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.get_callbacks">[docs]</a> <span class="k">def</span> <span class="nf">get_callbacks</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.get_callbacks"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.get_callbacks">[docs]</a> <span class="k">def</span> <span class="nf">get_callbacks</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return a dictionary of the object&#39;s callbacks.</span>
@ -248,7 +245,7 @@
<span class="k">return</span> <span class="n">callbacks</span></div>
<div class="viewcode-block" id="EventHandler.add_callback"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.add_callback">[docs]</a> <span class="k">def</span> <span class="nf">add_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">author</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">valid</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.add_callback"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.add_callback">[docs]</a> <span class="k">def</span> <span class="nf">add_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">author</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">valid</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Add the specified callback.</span>
@ -301,7 +298,7 @@
<span class="n">definition</span><span class="p">[</span><span class="s2">&quot;number&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">callbacks</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">definition</span></div>
<div class="viewcode-block" id="EventHandler.edit_callback"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.edit_callback">[docs]</a> <span class="k">def</span> <span class="nf">edit_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">author</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">valid</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.edit_callback"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.edit_callback">[docs]</a> <span class="k">def</span> <span class="nf">edit_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">author</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">valid</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Edit the specified callback.</span>
@ -352,7 +349,7 @@
<span class="n">definition</span><span class="p">[</span><span class="s2">&quot;number&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">number</span>
<span class="k">return</span> <span class="n">definition</span></div>
<div class="viewcode-block" id="EventHandler.del_callback"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.del_callback">[docs]</a> <span class="k">def</span> <span class="nf">del_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.del_callback"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.del_callback">[docs]</a> <span class="k">def</span> <span class="nf">del_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Delete the specified callback.</span>
@ -414,7 +411,7 @@
<span class="k">elif</span> <span class="n">script</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">number</span> <span class="o">&gt;</span> <span class="n">number</span><span class="p">:</span>
<span class="n">script</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">number</span> <span class="o">-=</span> <span class="mi">1</span></div>
<div class="viewcode-block" id="EventHandler.accept_callback"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.accept_callback">[docs]</a> <span class="k">def</span> <span class="nf">accept_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.accept_callback"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.accept_callback">[docs]</a> <span class="k">def</span> <span class="nf">accept_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Valid a callback.</span>
@ -432,7 +429,7 @@
<span class="k">if</span> <span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">to_valid</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">to_valid</span><span class="o">.</span><span class="n">remove</span><span class="p">((</span><span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">))</span></div>
<div class="viewcode-block" id="EventHandler.call"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.call">[docs]</a> <span class="k">def</span> <span class="nf">call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.call"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.call">[docs]</a> <span class="k">def</span> <span class="nf">call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Call the connected callbacks.</span>
@ -441,7 +438,7 @@
<span class="sd"> callback_name (str): the callback name to call.</span>
<span class="sd"> *args: additional variables for this callback.</span>
<span class="sd"> Kwargs:</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> number (int, optional): call just a specific callback.</span>
<span class="sd"> parameters (str, optional): call a callback with parameters.</span>
<span class="sd"> locals (dict, optional): a locals replacement.</span>
@ -512,7 +509,7 @@
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="EventHandler.handle_error"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.handle_error">[docs]</a> <span class="k">def</span> <span class="nf">handle_error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">trace</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.handle_error"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.handle_error">[docs]</a> <span class="k">def</span> <span class="nf">handle_error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="n">trace</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Handle an error in a callback.</span>
@ -571,7 +568,7 @@
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ndb</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="n">err_msg</span><span class="p">)</span></div>
<div class="viewcode-block" id="EventHandler.add_event"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.add_event">[docs]</a> <span class="k">def</span> <span class="nf">add_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">typeclass</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">variables</span><span class="p">,</span> <span class="n">help_text</span><span class="p">,</span> <span class="n">custom_call</span><span class="p">,</span> <span class="n">custom_add</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.add_event"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.add_event">[docs]</a> <span class="k">def</span> <span class="nf">add_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">typeclass</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">variables</span><span class="p">,</span> <span class="n">help_text</span><span class="p">,</span> <span class="n">custom_call</span><span class="p">,</span> <span class="n">custom_add</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Add a new event for a defined typeclass.</span>
@ -593,7 +590,7 @@
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">events</span><span class="p">:</span>
<span class="n">events</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">variables</span><span class="p">,</span> <span class="n">help_text</span><span class="p">,</span> <span class="n">custom_call</span><span class="p">,</span> <span class="n">custom_add</span><span class="p">)</span></div>
<div class="viewcode-block" id="EventHandler.set_task"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.EventHandler.set_task">[docs]</a> <span class="k">def</span> <span class="nf">set_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">seconds</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">):</span>
<div class="viewcode-block" id="EventHandler.set_task"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.EventHandler.set_task">[docs]</a> <span class="k">def</span> <span class="nf">set_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">seconds</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Set and schedule a task to run.</span>
@ -638,11 +635,11 @@
<span class="c1"># Script to call time-related events</span>
<div class="viewcode-block" id="TimeEventScript"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.TimeEventScript">[docs]</a><span class="k">class</span> <span class="nc">TimeEventScript</span><span class="p">(</span><span class="n">DefaultScript</span><span class="p">):</span>
<div class="viewcode-block" id="TimeEventScript"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.TimeEventScript">[docs]</a><span class="k">class</span> <span class="nc">TimeEventScript</span><span class="p">(</span><span class="n">DefaultScript</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Gametime-sensitive script.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="TimeEventScript.at_script_creation"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.TimeEventScript.at_script_creation">[docs]</a> <span class="k">def</span> <span class="nf">at_script_creation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<div class="viewcode-block" id="TimeEventScript.at_script_creation"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.TimeEventScript.at_script_creation">[docs]</a> <span class="k">def</span> <span class="nf">at_script_creation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;The script is created.&quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">start_delay</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">persistent</span> <span class="o">=</span> <span class="kc">True</span>
@ -652,7 +649,7 @@
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">event_name</span> <span class="o">=</span> <span class="s2">&quot;time&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">number</span> <span class="o">=</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="TimeEventScript.at_repeat"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.TimeEventScript.at_repeat">[docs]</a> <span class="k">def</span> <span class="nf">at_repeat</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<div class="viewcode-block" id="TimeEventScript.at_repeat"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.TimeEventScript.at_repeat">[docs]</a> <span class="k">def</span> <span class="nf">at_repeat</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Call the event and reset interval.</span>
@ -687,7 +684,7 @@
<span class="c1"># Functions to manipulate tasks</span>
<div class="viewcode-block" id="complete_task"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.scripts.complete_task">[docs]</a><span class="k">def</span> <span class="nf">complete_task</span><span class="p">(</span><span class="n">task_id</span><span class="p">):</span>
<div class="viewcode-block" id="complete_task"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.scripts.html#evennia.contrib.ingame_python.scripts.complete_task">[docs]</a><span class="k">def</span> <span class="nf">complete_task</span><span class="p">(</span><span class="n">task_id</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Mark the task in the event handler as complete.</span>
@ -712,6 +709,7 @@
<span class="n">script</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="nb">locals</span><span class="o">=</span><span class="nb">locals</span><span class="p">)</span></div>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
@ -749,17 +747,15 @@
<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 documentation</a> &#187;</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-1"><a href="../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../../evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">evennia.contrib.ingame_python.scripts</a></li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.ingame_python.scripts</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.1.1.
</div>
</body>
</html>