Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-27 10:16:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.contrib.base_systems.ingame_python.utils.html

310 lines
20 KiB
HTML
Raw Normal View History

Updated HTML docs.
2025-08-15 18:14:21 +00:00
<!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.base_systems.ingame_python.utils &#8212; 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.base_systems.ingame_reports" href="evennia.contrib.base_systems.ingame_reports.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_python.typeclasses" href="evennia.contrib.base_systems.ingame_python.typeclasses.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.base_systems.ingame_reports.html" title="evennia.contrib.base_systems.ingame_reports"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.typeclasses.html" title="evennia.contrib.base_systems.ingame_python.typeclasses"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.base_systems.html" >evennia.contrib.base_systems</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.base_systems.ingame_python.html" accesskey="U">evennia.contrib.base_systems.ingame_python</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.utils</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.base_systems.ingame_python.utils">
<span id="evennia-contrib-base-systems-ingame-python-utils"></span><h1>evennia.contrib.base_systems.ingame_python.utils<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_python.utils" title="Link to this heading"></a></h1>
<p>Functions to extend the event system.</p>
<p>These functions are to be used by developers to customize events and callbacks.</p>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.utils.get_event_handler">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_python.utils.</span></span><span class="sig-name descname"><span class="pre">get_event_handler</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#get_event_handler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.get_event_handler" title="Link to this definition"></a></dt>
<dd><p>Return the event handler or None.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.utils.register_events">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_python.utils.</span></span><span class="sig-name descname"><span class="pre">register_events</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path_or_typeclass</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#register_events"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.register_events" title="Link to this definition"></a></dt>
<dd><p>Register the events in this typeclass.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>path_or_typeclass</strong> (<em>str</em><em> or </em><em>type</em>) – the Python path leading to the
class containing events, or the class itself.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The typeclass itself.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This function will read events from the <strong>_events</strong> class variable
defined in the typeclass given in parameters. It will add
the events, either to the script if it exists, or to some
temporary storage, waiting for the script to be initialized.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.utils.get_next_wait">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_python.utils.</span></span><span class="sig-name descname"><span class="pre">get_next_wait</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">format</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#get_next_wait"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.get_next_wait" title="Link to this definition"></a></dt>
<dd><p>Get the length of time in seconds before format.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>format</strong> (<em>str</em>) – a time format matching the set calendar.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>until (int or float)</em> – the number of seconds until the event.
usual (int or float): the usual number of seconds between events.
format (str): a string format representing the time.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The time format could be something like “2018-01-08 12:00”. The
number of units set in the calendar affects the way seconds are
calculated.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.utils.time_event">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_python.utils.</span></span><span class="sig-name descname"><span class="pre">time_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">number</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#time_event"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.time_event" title="Link to this definition"></a></dt>
<dd><p>Create a time-related event.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>obj</strong> (<em>Object</em>) – the object on which sits the event.</p></li>
<li><p><strong>event_name</strong> (<em>str</em>) – the event’s name.</p></li>
<li><p><strong>number</strong> (<em>int</em>) – the number of the event.</p></li>
<li><p><strong>parameters</strong> (<em>str</em>) – the parameter of the event.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.utils.keyword_event">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_python.utils.</span></span><span class="sig-name descname"><span class="pre">keyword_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callbacks</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#keyword_event"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.keyword_event" title="Link to this definition"></a></dt>
<dd><p>Custom call for events with keywords (like push, or pull, or turn…).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>callbacks</strong> (<em>list</em><em> of </em><em>dict</em>) – the list of callbacks to be called.</p></li>
<li><p><strong>parameters</strong> (<em>str</em>) – the actual parameters entered to trigger the callback.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list containing the callback dictionaries to be called.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This function should be imported and added as a custom_call
parameter to add the event when the event supports keywords
as parameters. Keywords in parameters are one or more words
separated by a comma. For instance, a ‘push 1, one’ callback can
be set to trigger when the player ‘push 1’ or ‘push one’.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.utils.phrase_event">
<span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_python.utils.</span></span><span class="sig-name descname"><span class="pre">phrase_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callbacks</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#phrase_event"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.phrase_event" title="Link to this definition"></a></dt>
<dd><p>Custom call for events with keywords in sentences (like say or whisper).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>callbacks</strong> (<em>list</em><em> of </em><em>dict</em>) – the list of callbacks to be called.</p></li>
<li><p><strong>parameters</strong> (<em>str</em>) – the actual parameters entered to trigger the callback.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list containing the callback dictionaries to be called.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This function should be imported and added as a custom_call
parameter to add the event when the event supports keywords
in phrases as parameters. Keywords in parameters are one or more
words separated by a comma. For instance, a ‘say yes, okay’ callback
can be set to trigger when the player says something containing
either “yes” or “okay” (maybe ‘say I don’t like it, but okay’).</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.utils.InterruptEvent">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.base_systems.ingame_python.utils.</span></span><span class="sig-name descname"><span class="pre">InterruptEvent</span></span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/utils.html#InterruptEvent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.utils.InterruptEvent" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeError</span></code></p>
<p>Interrupt the current event.</p>
<p>You shouldn’t have to use this exception directly, probably use the
<strong>deny()</strong> function that handles it instead.</p>
</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.base_systems.ingame_python.utils</a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.utils.get_event_handler"><code class="docutils literal notranslate"><span class="pre">get_event_handler()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.utils.register_events"><code class="docutils literal notranslate"><span class="pre">register_events()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.utils.get_next_wait"><code class="docutils literal notranslate"><span class="pre">get_next_wait()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.utils.time_event"><code class="docutils literal notranslate"><span class="pre">time_event()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.utils.keyword_event"><code class="docutils literal notranslate"><span class="pre">keyword_event()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.utils.phrase_event"><code class="docutils literal notranslate"><span class="pre">phrase_event()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.utils.InterruptEvent"><code class="docutils literal notranslate"><span class="pre">InterruptEvent</span></code></a></li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_python.typeclasses.html"
title="previous chapter">evennia.contrib.base_systems.ingame_python.typeclasses</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_reports.html"
title="next chapter">evennia.contrib.base_systems.ingame_reports</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.base_systems.ingame_python.utils.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>
Updated HTML docs.
2026-02-15 18:13:08 +00:00
<li>
<a href="https://www.evennia.com/docs/6.x/index.html">v6.0.0 branch (outdated)</a>
</li>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<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.base_systems.ingame_reports.html" title="evennia.contrib.base_systems.ingame_reports"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.typeclasses.html" title="evennia.contrib.base_systems.ingame_python.typeclasses"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.base_systems.html" >evennia.contrib.base_systems</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.base_systems.ingame_python.html" >evennia.contrib.base_systems.ingame_python</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.utils</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in a new issue Copy permalink