Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-26 01:36:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
evennia/docs/latest/api/evennia.contrib.utils.html
Evennia docbuilder action 243d596662 Updated HTML docs.
2025-08-15 18:14:21 +00:00

390 lines
No EOL
46 KiB
HTML
Raw Blame History

<!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.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.utils.auditing" href="evennia.contrib.utils.auditing.html" />
<link rel="prev" title="evennia.contrib.tutorials.tutorial_world.tests" href="evennia.contrib.tutorials.tutorial_world.tests.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.utils.auditing.html" title="evennia.contrib.utils.auditing"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.tutorial_world.tests.html" title="evennia.contrib.tutorials.tutorial_world.tests"
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" accesskey="U">evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.utils">
<span id="evennia-contrib-utils"></span><h1>evennia.contrib.utils<a class="headerlink" href="#module-evennia.contrib.utils" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.auditing.html">evennia.contrib.utils.auditing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.auditing.outputs.html">evennia.contrib.utils.auditing.outputs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.auditing.outputs.html#evennia.contrib.utils.auditing.outputs.to_file"><code class="docutils literal notranslate"><span class="pre">to_file()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.auditing.outputs.html#evennia.contrib.utils.auditing.outputs.to_syslog"><code class="docutils literal notranslate"><span class="pre">to_syslog()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.auditing.server.html">evennia.contrib.utils.auditing.server</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.auditing.server.html#evennia.contrib.utils.auditing.server.AuditedServerSession"><code class="docutils literal notranslate"><span class="pre">AuditedServerSession</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.auditing.server.html#evennia.contrib.utils.auditing.server.AuditedServerSession.audit"><code class="docutils literal notranslate"><span class="pre">AuditedServerSession.audit()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.auditing.server.html#evennia.contrib.utils.auditing.server.AuditedServerSession.mask"><code class="docutils literal notranslate"><span class="pre">AuditedServerSession.mask()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.auditing.server.html#evennia.contrib.utils.auditing.server.AuditedServerSession.data_out"><code class="docutils literal notranslate"><span class="pre">AuditedServerSession.data_out()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.auditing.server.html#evennia.contrib.utils.auditing.server.AuditedServerSession.data_in"><code class="docutils literal notranslate"><span class="pre">AuditedServerSession.data_in()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.auditing.tests.html">evennia.contrib.utils.auditing.tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.auditing.tests.html#evennia.contrib.utils.auditing.tests.AuditingTest"><code class="docutils literal notranslate"><span class="pre">AuditingTest</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.auditing.tests.html#evennia.contrib.utils.auditing.tests.AuditingTest.setup_session"><code class="docutils literal notranslate"><span class="pre">AuditingTest.setup_session()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.auditing.tests.html#evennia.contrib.utils.auditing.tests.AuditingTest.test_mask"><code class="docutils literal notranslate"><span class="pre">AuditingTest.test_mask()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.auditing.tests.html#evennia.contrib.utils.auditing.tests.AuditingTest.test_audit"><code class="docutils literal notranslate"><span class="pre">AuditingTest.test_audit()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.debugpy.html">evennia.contrib.utils.debugpy</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.debugpy.cmd.html">evennia.contrib.utils.debugpy.cmd</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.debugpy.cmd.html#evennia.contrib.utils.debugpy.cmd.CmdDebugPy"><code class="docutils literal notranslate"><span class="pre">CmdDebugPy</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.debugpy.cmd.html#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.key"><code class="docutils literal notranslate"><span class="pre">CmdDebugPy.key</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.debugpy.cmd.html#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.locks"><code class="docutils literal notranslate"><span class="pre">CmdDebugPy.locks</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.debugpy.cmd.html#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.func"><code class="docutils literal notranslate"><span class="pre">CmdDebugPy.func()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.debugpy.cmd.html#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.aliases"><code class="docutils literal notranslate"><span class="pre">CmdDebugPy.aliases</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.debugpy.cmd.html#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.help_category"><code class="docutils literal notranslate"><span class="pre">CmdDebugPy.help_category</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.debugpy.cmd.html#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdDebugPy.lock_storage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.debugpy.cmd.html#evennia.contrib.utils.debugpy.cmd.CmdDebugPy.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdDebugPy.search_index_entry</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.fieldfill.html">evennia.contrib.utils.fieldfill</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html">evennia.contrib.utils.fieldfill.fieldfill</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.FieldEvMenu"><code class="docutils literal notranslate"><span class="pre">FieldEvMenu</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.FieldEvMenu.node_formatter"><code class="docutils literal notranslate"><span class="pre">FieldEvMenu.node_formatter()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.init_fill_field"><code class="docutils literal notranslate"><span class="pre">init_fill_field()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.menunode_fieldfill"><code class="docutils literal notranslate"><span class="pre">menunode_fieldfill()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.form_template_to_dict"><code class="docutils literal notranslate"><span class="pre">form_template_to_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.display_formdata"><code class="docutils literal notranslate"><span class="pre">display_formdata()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.verify_online_player"><code class="docutils literal notranslate"><span class="pre">verify_online_player()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.CmdTestMenu"><code class="docutils literal notranslate"><span class="pre">CmdTestMenu</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.CmdTestMenu.key"><code class="docutils literal notranslate"><span class="pre">CmdTestMenu.key</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.CmdTestMenu.func"><code class="docutils literal notranslate"><span class="pre">CmdTestMenu.func()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.CmdTestMenu.aliases"><code class="docutils literal notranslate"><span class="pre">CmdTestMenu.aliases</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.CmdTestMenu.help_category"><code class="docutils literal notranslate"><span class="pre">CmdTestMenu.help_category</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.CmdTestMenu.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdTestMenu.lock_storage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.CmdTestMenu.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdTestMenu.search_index_entry</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.sendmessage"><code class="docutils literal notranslate"><span class="pre">sendmessage()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.fieldfill.fieldfill.html#evennia.contrib.utils.fieldfill.fieldfill.init_delayed_message"><code class="docutils literal notranslate"><span class="pre">init_delayed_message()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.git_integration.html">evennia.contrib.utils.git_integration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html">evennia.contrib.utils.git_integration.git_integration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand"><code class="docutils literal notranslate"><span class="pre">GitCommand</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.parse"><code class="docutils literal notranslate"><span class="pre">GitCommand.parse()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.short_sha"><code class="docutils literal notranslate"><span class="pre">GitCommand.short_sha()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.get_status"><code class="docutils literal notranslate"><span class="pre">GitCommand.get_status()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.get_branches"><code class="docutils literal notranslate"><span class="pre">GitCommand.get_branches()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.checkout"><code class="docutils literal notranslate"><span class="pre">GitCommand.checkout()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.pull"><code class="docutils literal notranslate"><span class="pre">GitCommand.pull()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.func"><code class="docutils literal notranslate"><span class="pre">GitCommand.func()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.aliases"><code class="docutils literal notranslate"><span class="pre">GitCommand.aliases</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.help_category"><code class="docutils literal notranslate"><span class="pre">GitCommand.help_category</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.key"><code class="docutils literal notranslate"><span class="pre">GitCommand.key</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.lock_storage"><code class="docutils literal notranslate"><span class="pre">GitCommand.lock_storage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCommand.search_index_entry"><code class="docutils literal notranslate"><span class="pre">GitCommand.search_index_entry</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.key"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.key</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.locks"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.locks</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.help_category"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.help_category</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.directory"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.directory</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.repo_type"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.repo_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.remote_link"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.remote_link</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.aliases"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.aliases</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.lock_storage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.search_index_entry</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit"><code class="docutils literal notranslate"><span class="pre">CmdGit</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit.key"><code class="docutils literal notranslate"><span class="pre">CmdGit.key</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit.locks"><code class="docutils literal notranslate"><span class="pre">CmdGit.locks</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit.help_category"><code class="docutils literal notranslate"><span class="pre">CmdGit.help_category</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit.directory"><code class="docutils literal notranslate"><span class="pre">CmdGit.directory</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit.repo_type"><code class="docutils literal notranslate"><span class="pre">CmdGit.repo_type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit.remote_link"><code class="docutils literal notranslate"><span class="pre">CmdGit.remote_link</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit.aliases"><code class="docutils literal notranslate"><span class="pre">CmdGit.aliases</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdGit.lock_storage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdGit.search_index_entry</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCmdSet"><code class="docutils literal notranslate"><span class="pre">GitCmdSet</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCmdSet.at_cmdset_creation"><code class="docutils literal notranslate"><span class="pre">GitCmdSet.at_cmdset_creation()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.GitCmdSet.path"><code class="docutils literal notranslate"><span class="pre">GitCmdSet.path</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.git_integration.tests.html">evennia.contrib.utils.git_integration.tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.git_integration.tests.html#evennia.contrib.utils.git_integration.tests.TestGitIntegration"><code class="docutils literal notranslate"><span class="pre">TestGitIntegration</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.tests.html#evennia.contrib.utils.git_integration.tests.TestGitIntegration.setUp"><code class="docutils literal notranslate"><span class="pre">TestGitIntegration.setUp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.tests.html#evennia.contrib.utils.git_integration.tests.TestGitIntegration.test_git_status"><code class="docutils literal notranslate"><span class="pre">TestGitIntegration.test_git_status()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.tests.html#evennia.contrib.utils.git_integration.tests.TestGitIntegration.test_git_branch"><code class="docutils literal notranslate"><span class="pre">TestGitIntegration.test_git_branch()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.tests.html#evennia.contrib.utils.git_integration.tests.TestGitIntegration.test_git_checkout"><code class="docutils literal notranslate"><span class="pre">TestGitIntegration.test_git_checkout()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.git_integration.tests.html#evennia.contrib.utils.git_integration.tests.TestGitIntegration.test_git_pull"><code class="docutils literal notranslate"><span class="pre">TestGitIntegration.test_git_pull()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.name_generator.html">evennia.contrib.utils.name_generator</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.name_generator.namegen.html">evennia.contrib.utils.name_generator.namegen</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.name_generator.namegen.html#evennia.contrib.utils.name_generator.namegen.fantasy_name"><code class="docutils literal notranslate"><span class="pre">fantasy_name()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.name_generator.namegen.html#evennia.contrib.utils.name_generator.namegen.first_name"><code class="docutils literal notranslate"><span class="pre">first_name()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.name_generator.namegen.html#evennia.contrib.utils.name_generator.namegen.last_name"><code class="docutils literal notranslate"><span class="pre">last_name()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.name_generator.namegen.html#evennia.contrib.utils.name_generator.namegen.full_name"><code class="docutils literal notranslate"><span class="pre">full_name()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html">evennia.contrib.utils.name_generator.tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html#evennia.contrib.utils.name_generator.tests.TestNameGenerator"><code class="docutils literal notranslate"><span class="pre">TestNameGenerator</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html#evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_fantasy_name"><code class="docutils literal notranslate"><span class="pre">TestNameGenerator.test_fantasy_name()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html#evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_structure_validation"><code class="docutils literal notranslate"><span class="pre">TestNameGenerator.test_structure_validation()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html#evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_first_name"><code class="docutils literal notranslate"><span class="pre">TestNameGenerator.test_first_name()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html#evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_last_name"><code class="docutils literal notranslate"><span class="pre">TestNameGenerator.test_last_name()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.name_generator.tests.html#evennia.contrib.utils.name_generator.tests.TestNameGenerator.test_full_name"><code class="docutils literal notranslate"><span class="pre">TestNameGenerator.test_full_name()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.html">evennia.contrib.utils.random_string_generator</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html">evennia.contrib.utils.random_string_generator.random_string_generator</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RejectedRegex"><code class="docutils literal notranslate"><span class="pre">RejectedRegex</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.ExhaustedGenerator"><code class="docutils literal notranslate"><span class="pre">ExhaustedGenerator</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGeneratorScript"><code class="docutils literal notranslate"><span class="pre">RandomStringGeneratorScript</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGeneratorScript.at_script_creation"><code class="docutils literal notranslate"><span class="pre">RandomStringGeneratorScript.at_script_creation()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGeneratorScript.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">RandomStringGeneratorScript.DoesNotExist</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGeneratorScript.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">RandomStringGeneratorScript.MultipleObjectsReturned</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGeneratorScript.path"><code class="docutils literal notranslate"><span class="pre">RandomStringGeneratorScript.path</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGeneratorScript.typename"><code class="docutils literal notranslate"><span class="pre">RandomStringGeneratorScript.typename</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGenerator"><code class="docutils literal notranslate"><span class="pre">RandomStringGenerator</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGenerator.script"><code class="docutils literal notranslate"><span class="pre">RandomStringGenerator.script</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGenerator.__init__"><code class="docutils literal notranslate"><span class="pre">RandomStringGenerator.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGenerator.all"><code class="docutils literal notranslate"><span class="pre">RandomStringGenerator.all()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGenerator.get"><code class="docutils literal notranslate"><span class="pre">RandomStringGenerator.get()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGenerator.remove"><code class="docutils literal notranslate"><span class="pre">RandomStringGenerator.remove()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.random_string_generator.html#evennia.contrib.utils.random_string_generator.random_string_generator.RandomStringGenerator.clear"><code class="docutils literal notranslate"><span class="pre">RandomStringGenerator.clear()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.tests.html">evennia.contrib.utils.random_string_generator.tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.tests.html#evennia.contrib.utils.random_string_generator.tests.TestRandomStringGenerator"><code class="docutils literal notranslate"><span class="pre">TestRandomStringGenerator</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.random_string_generator.tests.html#evennia.contrib.utils.random_string_generator.tests.TestRandomStringGenerator.test_generate"><code class="docutils literal notranslate"><span class="pre">TestRandomStringGenerator.test_generate()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.utils.tree_select.html">evennia.contrib.utils.tree_select</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.tree_select.tests.html">evennia.contrib.utils.tree_select.tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tests.html#evennia.contrib.utils.tree_select.tests.TestTreeSelectFunc"><code class="docutils literal notranslate"><span class="pre">TestTreeSelectFunc</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.tree_select.tests.html#evennia.contrib.utils.tree_select.tests.TestTreeSelectFunc.test_tree_functions"><code class="docutils literal notranslate"><span class="pre">TestTreeSelectFunc.test_tree_functions()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tests.html#evennia.contrib.utils.tree_select.tests.TestFieldFillFunc"><code class="docutils literal notranslate"><span class="pre">TestFieldFillFunc</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.tree_select.tests.html#evennia.contrib.utils.tree_select.tests.TestFieldFillFunc.test_field_functions"><code class="docutils literal notranslate"><span class="pre">TestFieldFillFunc.test_field_functions()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html">evennia.contrib.utils.tree_select.tree_select</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.init_tree_selection"><code class="docutils literal notranslate"><span class="pre">init_tree_selection()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.dashcount"><code class="docutils literal notranslate"><span class="pre">dashcount()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.is_category"><code class="docutils literal notranslate"><span class="pre">is_category()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.parse_opts"><code class="docutils literal notranslate"><span class="pre">parse_opts()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.index_to_selection"><code class="docutils literal notranslate"><span class="pre">index_to_selection()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.go_up_one_category"><code class="docutils literal notranslate"><span class="pre">go_up_one_category()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.optlist_to_menuoptions"><code class="docutils literal notranslate"><span class="pre">optlist_to_menuoptions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.menunode_treeselect"><code class="docutils literal notranslate"><span class="pre">menunode_treeselect()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.CmdNameColor"><code class="docutils literal notranslate"><span class="pre">CmdNameColor</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.CmdNameColor.key"><code class="docutils literal notranslate"><span class="pre">CmdNameColor.key</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.CmdNameColor.func"><code class="docutils literal notranslate"><span class="pre">CmdNameColor.func()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.CmdNameColor.aliases"><code class="docutils literal notranslate"><span class="pre">CmdNameColor.aliases</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.CmdNameColor.help_category"><code class="docutils literal notranslate"><span class="pre">CmdNameColor.help_category</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.CmdNameColor.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdNameColor.lock_storage</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.CmdNameColor.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdNameColor.search_index_entry</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.utils.tree_select.tree_select.html#evennia.contrib.utils.tree_select.tree_select.change_name_color"><code class="docutils literal notranslate"><span class="pre">change_name_color()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</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>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.tutorials.tutorial_world.tests.html"
title="previous chapter">evennia.contrib.tutorials.tutorial_world.tests</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.utils.auditing.html"
title="next chapter">evennia.contrib.utils.auditing</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.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>
<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.utils.auditing.html" title="evennia.contrib.utils.auditing"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.tutorials.tutorial_world.tests.html" title="evennia.contrib.tutorials.tutorial_world.tests"
>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-this"><a href="">evennia.contrib.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 View git blame Copy permalink