Updated HTML docs

2026-04-01 21:47:17 +02:00 · 2020-10-15 01:31:30 +02:00 · 2020-10-15 01:31:30 +02:00 · edf9ca4c4b
commit edf9ca4c4b
parent dc00b6bf65
1252 changed files with 40437 additions and 27044 deletions
--- a/docs/1.0-dev/api/evennia.contrib.ingame_python.commands.html
+++ b/docs/1.0-dev/api/evennia.contrib.ingame_python.commands.html
@ -1,9 +1,10 @@

 <!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.commands &#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" />
@ -25,7 +26,8 @@
        <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</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-this"><a href="">evennia.contrib.ingame_python.commands</a></li> 
      </ul>
    </div>  

@ -37,34 +39,34 @@
  <div class="section" id="module-evennia.contrib.ingame_python.commands">
 <span id="evennia-contrib-ingame-python-commands"></span><h1>evennia.contrib.ingame_python.commands<a class="headerlink" href="#module-evennia.contrib.ingame_python.commands" title="Permalink to this headline">¶</a></h1>
 <p>Module containing the commands of the in-game Python system.</p>
-<dl class="class">
+<dl class="py class">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback">
-<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.ingame_python.commands.</code><code class="sig-name descname">CmdCallback</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.ingame_python.commands.</code><code class="sig-name descname">CmdCallback</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback" title="Permalink 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">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
 <p>Command to edit callbacks.</p>
-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.key">
 <code class="sig-name descname">key</code><em class="property"> = '&#64;call'</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.key" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.aliases">
 <code class="sig-name descname">aliases</code><em class="property"> = ['&#64;callback', '&#64;callbacks', '&#64;calls']</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.aliases" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.locks">
 <code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(developer)'</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.locks" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.help_category">
 <code class="sig-name descname">help_category</code><em class="property"> = 'building'</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.help_category" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.get_help">
-<code class="sig-name descname">get_help</code><span class="sig-paren">(</span><em class="sig-param">caller</em>, <em class="sig-param">cmdset</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.get_help" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname">get_help</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">caller</span></em>, <em class="sig-param"><span class="n">cmdset</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.get_help" title="Permalink 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>
@ -81,54 +83,54 @@ on user permission.</p>
 </dl>
 </dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.func">
 <code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.func" title="Permalink to this definition">¶</a></dt>
 <dd><p>Command body.</p>
 </dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.list_callbacks">
 <code class="sig-name descname">list_callbacks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.list_callbacks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.list_callbacks" title="Permalink to this definition">¶</a></dt>
 <dd><p>Display the list of callbacks connected to the object.</p>
 </dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.add_callback">
 <code class="sig-name descname">add_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.add_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.add_callback" title="Permalink to this definition">¶</a></dt>
 <dd><p>Add a callback.</p>
 </dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.edit_callback">
 <code class="sig-name descname">edit_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.edit_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.edit_callback" title="Permalink to this definition">¶</a></dt>
 <dd><p>Edit a callback.</p>
 </dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.del_callback">
 <code class="sig-name descname">del_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.del_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.del_callback" title="Permalink to this definition">¶</a></dt>
 <dd><p>Delete a callback.</p>
 </dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.accept_callback">
 <code class="sig-name descname">accept_callback</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.accept_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.accept_callback" title="Permalink to this definition">¶</a></dt>
 <dd><p>Accept a callback.</p>
 </dd></dl>

-<dl class="method">
+<dl class="py method">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.list_tasks">
 <code class="sig-name descname">list_tasks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/ingame_python/commands.html#CmdCallback.list_tasks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.list_tasks" title="Permalink to this definition">¶</a></dt>
 <dd><p>List the active tasks.</p>
 </dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.lock_storage">
 <code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(developer)'</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.lock_storage" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

-<dl class="attribute">
+<dl class="py attribute">
 <dt id="evennia.contrib.ingame_python.commands.CmdCallback.search_index_entry">
 <code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '&#64;callback &#64;callbacks &#64;calls', 'category': 'building', 'key': '&#64;call', 'tags': '', 'text': '\n    Command to edit callbacks.\n    '}</em><a class="headerlink" href="#evennia.contrib.ingame_python.commands.CmdCallback.search_index_entry" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
@ -138,6 +140,7 @@ on user permission.</p>
 </div>


+            <div class="clearer"></div>
          </div>
        </div>
      </div>
@ -182,12 +185,13 @@ on user permission.</p>
        <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</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-this"><a href="">evennia.contrib.ingame_python.commands</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.2.1.
    </div>
  </body>
 </html>