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.callbackhandler.html

443 lines
34 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.callbackhandler &#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_python.commands" href="evennia.contrib.base_systems.ingame_python.commands.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_python" href="evennia.contrib.base_systems.ingame_python.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_python.commands.html" title="evennia.contrib.base_systems.ingame_python.commands"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.html" title="evennia.contrib.base_systems.ingame_python"
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.callbackhandler</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.callbackhandler">
<span id="evennia-contrib-base-systems-ingame-python-callbackhandler"></span><h1>evennia.contrib.base_systems.ingame_python.callbackhandler<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_python.callbackhandler" title="Link to this heading"></a></h1>
<p>Module containing the CallbackHandler for individual objects.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler">
<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.base_systems.ingame_python.callbackhandler.</span></span><span class="sig-name descname"><span class="pre">CallbackHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The callback handler for a specific object.</p>
<p>The script that contains all callbacks will be reached through this
handler. This handler is therefore a shortcut to be used by
developers. This handler (accessible through <strong>obj.callbacks</strong>) is a
shortcut to manipulating callbacks within this object, getting,
adding, editing, deleting and calling them.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.script">
<span class="sig-name descname"><span class="pre">script</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.script" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.all">
<span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.all"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.all" title="Link to this definition"></a></dt>
<dd><p>Return all callbacks linked to this object.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>All callbacks in a dictionary callback_name</em> – callback}. The callback
is returned as a namedtuple to simplify manipulation.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.get" title="Link to this definition"></a></dt>
<dd><p>Return the callbacks associated with this name.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>callback_name</strong> (<em>str</em>) – the name of the callback.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of callbacks associated with this object and of this name.</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This method returns a list of callback objects (namedtuple
representations). If the callback name cannot be found in the
object’s callbacks, return an empty list.</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.get_variable">
<span class="sig-name descname"><span class="pre">get_variable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">variable_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.get_variable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.get_variable" title="Link to this definition"></a></dt>
<dd><p>Return the variable value or None.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>variable_name</strong> (<em>str</em>) – the name of the variable.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Either the variable’s value or None.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">author</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.add"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.add" title="Link to this definition"></a></dt>
<dd><p>Add a new callback for this object.</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>callback_name</strong> (<em>str</em>) – the name of the callback to add.</p></li>
<li><p><strong>code</strong> (<em>str</em>) – the Python code associated with this callback.</p></li>
<li><p><strong>author</strong> (<em>Character</em><em> or </em><em>Account</em><em>, </em><em>optional</em>) – the author of the callback.</p></li>
<li><p><strong>valid</strong> (<em>bool</em><em>, </em><em>optional</em>) – should the callback be connected?</p></li>
<li><p><strong>parameters</strong> (<em>str</em><em>, </em><em>optional</em>) – optional parameters.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The callback definition that was added or None.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.edit">
<span class="sig-name descname"><span class="pre">edit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback_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">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">author</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.edit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.edit" title="Link to this definition"></a></dt>
<dd><p>Edit an existing callback bound to this object.</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>callback_name</strong> (<em>str</em>) – the name of the callback to edit.</p></li>
<li><p><strong>number</strong> (<em>int</em>) – the callback number to be changed.</p></li>
<li><p><strong>code</strong> (<em>str</em>) – the Python code associated with this callback.</p></li>
<li><p><strong>author</strong> (<em>Character</em><em> or </em><em>Account</em><em>, </em><em>optional</em>) – the author of the callback.</p></li>
<li><p><strong>valid</strong> (<em>bool</em><em>, </em><em>optional</em>) – should the callback be connected?</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The callback definition that was edited or None.</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>RuntimeError if the callback is locked.</strong> – </p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.remove">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">number</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.remove"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.remove" title="Link to this definition"></a></dt>
<dd><p>Delete the specified callback bound to this object.</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>callback_name</strong> (<em>str</em>) – the name of the callback to delete.</p></li>
<li><p><strong>number</strong> (<em>int</em>) – the number of the callback to delete.</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>RuntimeError if the callback is locked.</strong> – </p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.call">
<span class="sig-name descname"><span class="pre">call</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback_name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.call"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.call" title="Link to this definition"></a></dt>
<dd><p>Call the specified callback(s) bound to this object.</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>callback_name</strong> (<em>str</em>) – the callback name to call.</p></li>
<li><p><strong>*args</strong> – additional variables for this callback.</p></li>
</ul>
</dd>
<dt class="field-even">Keyword Arguments<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>number</strong> (<em>int</em><em>, </em><em>optional</em>) – call just a specific callback.</p></li>
<li><p><strong>parameters</strong> (<em>str</em><em>, </em><em>optional</em>) – call a callback with parameters.</p></li>
<li><p><strong>locals</strong> (<em>dict</em><em>, </em><em>optional</em>) – a locals replacement.</p></li>
</ul>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>True to report the callback was called without interruption,
False otherwise. If the callbackHandler isn’t found, return
None.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.format_callback">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">format_callback</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/callbackhandler.html#CallbackHandler.format_callback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.format_callback" title="Link to this definition"></a></dt>
<dd><p>Return the callback namedtuple to represent the specified callback.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>callback</strong> (<em>dict</em>) – the callback definition.</p>
</dd>
</dl>
<p>The callback given in argument should be a dictionary containing
the expected fields for a callback (code, author, valid…).</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback">
<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.base_systems.ingame_python.callbackhandler.</span></span><span class="sig-name descname"><span class="pre">Callback</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">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">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">author</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">created_on</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated_by</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated_on</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.author">
<span class="sig-name descname"><span class="pre">author</span></span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.author" title="Link to this definition"></a></dt>
<dd><p>Alias for field number 4</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.code">
<span class="sig-name descname"><span class="pre">code</span></span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.code" title="Link to this definition"></a></dt>
<dd><p>Alias for field number 3</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.created_on">
<span class="sig-name descname"><span class="pre">created_on</span></span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.created_on" title="Link to this definition"></a></dt>
<dd><p>Alias for field number 7</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.name" title="Link to this definition"></a></dt>
<dd><p>Alias for field number 1</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.number">
<span class="sig-name descname"><span class="pre">number</span></span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.number" title="Link to this definition"></a></dt>
<dd><p>Alias for field number 2</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.obj">
<span class="sig-name descname"><span class="pre">obj</span></span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.obj" title="Link to this definition"></a></dt>
<dd><p>Alias for field number 0</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.parameters">
<span class="sig-name descname"><span class="pre">parameters</span></span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.parameters" title="Link to this definition"></a></dt>
<dd><p>Alias for field number 6</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.updated_by">
<span class="sig-name descname"><span class="pre">updated_by</span></span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.updated_by" title="Link to this definition"></a></dt>
<dd><p>Alias for field number 8</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.updated_on">
<span class="sig-name descname"><span class="pre">updated_on</span></span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.updated_on" title="Link to this definition"></a></dt>
<dd><p>Alias for field number 9</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.valid">
<span class="sig-name descname"><span class="pre">valid</span></span><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.valid" title="Link to this definition"></a></dt>
<dd><p>Alias for field number 5</p>
</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.base_systems.ingame_python.callbackhandler</a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler"><code class="docutils literal notranslate"><span class="pre">CallbackHandler</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.script"><code class="docutils literal notranslate"><span class="pre">CallbackHandler.script</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.__init__"><code class="docutils literal notranslate"><span class="pre">CallbackHandler.__init__()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.all"><code class="docutils literal notranslate"><span class="pre">CallbackHandler.all()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.get"><code class="docutils literal notranslate"><span class="pre">CallbackHandler.get()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.get_variable"><code class="docutils literal notranslate"><span class="pre">CallbackHandler.get_variable()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.add"><code class="docutils literal notranslate"><span class="pre">CallbackHandler.add()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.edit"><code class="docutils literal notranslate"><span class="pre">CallbackHandler.edit()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.remove"><code class="docutils literal notranslate"><span class="pre">CallbackHandler.remove()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.call"><code class="docutils literal notranslate"><span class="pre">CallbackHandler.call()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.CallbackHandler.format_callback"><code class="docutils literal notranslate"><span class="pre">CallbackHandler.format_callback()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback"><code class="docutils literal notranslate"><span class="pre">Callback</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.author"><code class="docutils literal notranslate"><span class="pre">Callback.author</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.code"><code class="docutils literal notranslate"><span class="pre">Callback.code</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.created_on"><code class="docutils literal notranslate"><span class="pre">Callback.created_on</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.name"><code class="docutils literal notranslate"><span class="pre">Callback.name</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.number"><code class="docutils literal notranslate"><span class="pre">Callback.number</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.obj"><code class="docutils literal notranslate"><span class="pre">Callback.obj</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.parameters"><code class="docutils literal notranslate"><span class="pre">Callback.parameters</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.updated_by"><code class="docutils literal notranslate"><span class="pre">Callback.updated_by</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.updated_on"><code class="docutils literal notranslate"><span class="pre">Callback.updated_on</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.valid"><code class="docutils literal notranslate"><span class="pre">Callback.valid</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_python.html"
title="previous chapter">evennia.contrib.base_systems.ingame_python</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_python.commands.html"
title="next chapter">evennia.contrib.base_systems.ingame_python.commands</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.callbackhandler.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_python.commands.html" title="evennia.contrib.base_systems.ingame_python.commands"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.html" title="evennia.contrib.base_systems.ingame_python"
>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.callbackhandler</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