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

295 lines
23 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.commands &#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.eventfuncs" href="evennia.contrib.base_systems.ingame_python.eventfuncs.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_python.callbackhandler" href="evennia.contrib.base_systems.ingame_python.callbackhandler.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.eventfuncs.html" title="evennia.contrib.base_systems.ingame_python.eventfuncs"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.callbackhandler.html" title="evennia.contrib.base_systems.ingame_python.callbackhandler"
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.commands</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.commands">
<span id="evennia-contrib-base-systems-ingame-python-commands"></span><h1>evennia.contrib.base_systems.ingame_python.commands<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_python.commands" title="Link to this heading"></a></h1>
<p>Module containing the commands of the in-game Python system.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback">
<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.commands.</span></span><span class="sig-name descname"><span class="pre">CmdCallback</span></span><span class="sig-paren">(</span><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/commands.html#CmdCallback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">MuxCommand</span></code></a></p>
<p>Command to edit callbacks.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'&#64;call'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases">
Updated HTML docs.
2026-01-12 16:26:53 +00:00
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['&#64;calls',</span> <span class="pre">'&#64;callbacks',</span> <span class="pre">'&#64;callback']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases" title="Link to this definition"></a></dt>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.locks">
<span class="sig-name descname"><span class="pre">locks</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:perm(developer)'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'building'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.help_category" 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.commands.CmdCallback.get_help">
<span class="sig-name descname"><span class="pre">get_help</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdset</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.get_help"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.get_help" title="Link to this definition"></a></dt>
<dd><p>Return the help message for this command and this caller.</p>
<p>The help text of this specific command will vary depending
on user permission.</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>caller</strong> (<em>Object</em><em> or </em><em>Account</em>) – the caller asking for help on the command.</p></li>
<li><p><strong>cmdset</strong> (<a class="reference internal" href="evennia.commands.cmdhandler.html#evennia.commands.cmdhandler.CmdSet" title="evennia.commands.cmdhandler.CmdSet"><em>CmdSet</em></a>) – the command set (if you need additional commands).</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><em>docstring (str)</em> – the help text to provide the caller for this command.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.func">
<span class="sig-name descname"><span class="pre">func</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.func" title="Link to this definition"></a></dt>
<dd><p>Command body.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.list_callbacks">
<span class="sig-name descname"><span class="pre">list_callbacks</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.list_callbacks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.list_callbacks" title="Link to this definition"></a></dt>
<dd><p>Display the list of callbacks connected to the object.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.add_callback">
<span class="sig-name descname"><span class="pre">add_callback</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.add_callback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.add_callback" title="Link to this definition"></a></dt>
<dd><p>Add a callback.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.edit_callback">
<span class="sig-name descname"><span class="pre">edit_callback</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.edit_callback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.edit_callback" title="Link to this definition"></a></dt>
<dd><p>Edit a callback.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.del_callback">
<span class="sig-name descname"><span class="pre">del_callback</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.del_callback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.del_callback" title="Link to this definition"></a></dt>
<dd><p>Delete a callback.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.accept_callback">
<span class="sig-name descname"><span class="pre">accept_callback</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.accept_callback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.accept_callback" title="Link to this definition"></a></dt>
<dd><p>Accept a callback.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.list_tasks">
<span class="sig-name descname"><span class="pre">list_tasks</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/commands.html#CmdCallback.list_tasks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.list_tasks" title="Link to this definition"></a></dt>
<dd><p>List the active tasks.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:perm(developer)'</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry">
Updated HTML docs.
2026-01-12 16:26:53 +00:00
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'&#64;calls</span> <span class="pre">&#64;callbacks</span> <span class="pre">&#64;callback',</span> <span class="pre">'category':</span> <span class="pre">'building',</span> <span class="pre">'key':</span> <span class="pre">'&#64;call',</span> <span class="pre">'no_prefix':</span> <span class="pre">'call</span> <span class="pre">calls</span> <span class="pre">callbacks</span> <span class="pre">callback',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nCommand</span> <span class="pre">to</span> <span class="pre">edit</span> <span class="pre">callbacks.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry" title="Link to this definition"></a></dt>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<dd></dd></dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.contrib.base_systems.ingame_python.commands</a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback"><code class="docutils literal notranslate"><span class="pre">CmdCallback</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.key"><code class="docutils literal notranslate"><span class="pre">CmdCallback.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases"><code class="docutils literal notranslate"><span class="pre">CmdCallback.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.locks"><code class="docutils literal notranslate"><span class="pre">CmdCallback.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.help_category"><code class="docutils literal notranslate"><span class="pre">CmdCallback.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.get_help"><code class="docutils literal notranslate"><span class="pre">CmdCallback.get_help()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.func"><code class="docutils literal notranslate"><span class="pre">CmdCallback.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.list_callbacks"><code class="docutils literal notranslate"><span class="pre">CmdCallback.list_callbacks()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.add_callback"><code class="docutils literal notranslate"><span class="pre">CmdCallback.add_callback()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.edit_callback"><code class="docutils literal notranslate"><span class="pre">CmdCallback.edit_callback()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.del_callback"><code class="docutils literal notranslate"><span class="pre">CmdCallback.del_callback()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.accept_callback"><code class="docutils literal notranslate"><span class="pre">CmdCallback.accept_callback()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.list_tasks"><code class="docutils literal notranslate"><span class="pre">CmdCallback.list_tasks()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdCallback.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdCallback.search_index_entry</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.callbackhandler.html"
title="previous chapter">evennia.contrib.base_systems.ingame_python.callbackhandler</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_python.eventfuncs.html"
title="next chapter">evennia.contrib.base_systems.ingame_python.eventfuncs</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.commands.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Doc Versions</h3>
<ul>
<li>
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.eventfuncs.html" title="evennia.contrib.base_systems.ingame_python.eventfuncs"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.callbackhandler.html" title="evennia.contrib.base_systems.ingame_python.callbackhandler"
>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.commands</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