Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-22 15:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/6.x/api/evennia.help.html
Griatch 9e122e89ca Update with 6.x branch docs
2026-02-15 19:06:04 +01:00

389 lines
No EOL
48 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.help &#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.help.filehelp" href="evennia.help.filehelp.html" />
<link rel="prev" title="evennia.contrib.utils.tree_select.tree_select" href="evennia.contrib.utils.tree_select.tree_select.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.help.filehelp.html" title="evennia.help.filehelp"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.tree_select.tree_select.html" title="evennia.contrib.utils.tree_select.tree_select"
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" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.help</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.help">
<span id="evennia-help"></span><h1>evennia.help<a class="headerlink" href="#module-evennia.help" title="Link to this heading"></a></h1>
<p>This sub-package defines the help system of Evennia. It is pretty
simple, mainly consisting of a database model to hold help entries.
The auto-cmd-help is rather handled by the default ‘help’ command
itself.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.help.filehelp.html">evennia.help.filehelp</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.key"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.key</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.aliases"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.aliases</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.help_category"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.help_category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.entrytext"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.entrytext</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.lock_storage"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.lock_storage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.search_index_entry"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.search_index_entry</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.locks"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.locks</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.web_get_detail_url"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.web_get_detail_url()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.web_get_admin_url"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.web_get_admin_url()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.access"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.access()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.__init__"><code class="docutils literal notranslate"><span class="pre">FileHelpEntry.__init__()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpStorageHandler"><code class="docutils literal notranslate"><span class="pre">FileHelpStorageHandler</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpStorageHandler.__init__"><code class="docutils literal notranslate"><span class="pre">FileHelpStorageHandler.__init__()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpStorageHandler.load"><code class="docutils literal notranslate"><span class="pre">FileHelpStorageHandler.load()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.filehelp.html#evennia.help.filehelp.FileHelpStorageHandler.all"><code class="docutils literal notranslate"><span class="pre">FileHelpStorageHandler.all()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.help.manager.html">evennia.help.manager</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.HelpEntryManager"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.HelpEntryManager.find_topicmatch"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.find_topicmatch()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.HelpEntryManager.find_apropos"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.find_apropos()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.HelpEntryManager.find_topicsuggestions"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.find_topicsuggestions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.HelpEntryManager.find_topics_with_category"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.find_topics_with_category()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.HelpEntryManager.get_all_topics"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.get_all_topics()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.HelpEntryManager.get_all_categories"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.get_all_categories()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.HelpEntryManager.all_to_category"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.all_to_category()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.HelpEntryManager.search_help"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.search_help()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.HelpEntryManager.create_help"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.create_help()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.IntegrityError"><code class="docutils literal notranslate"><span class="pre">IntegrityError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.create_tag"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.create_tag()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.dbref"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.dbref()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.dbref_search"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.dbref_search()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_alias"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_alias()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_attribute"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_attribute()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_by_alias"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_by_alias()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_by_attribute"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_by_attribute()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_by_nick"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_by_nick()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_by_permission"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_by_permission()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_by_tag"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_by_tag()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_dbref_range"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_dbref_range()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_id"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_id()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_nick"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_nick()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_permission"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_permission()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_tag"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_tag()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.get_typeclass_totals"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.get_typeclass_totals()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.object_totals"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.object_totals()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.search_dbref"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.search_dbref()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.TypedObjectManager.typeclass_search"><code class="docutils literal notranslate"><span class="pre">TypedObjectManager.typeclass_search()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.manager.html#evennia.help.manager.make_iter"><code class="docutils literal notranslate"><span class="pre">make_iter()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.help.models.html">evennia.help.models</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry"><code class="docutils literal notranslate"><span class="pre">HelpEntry</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.db_key"><code class="docutils literal notranslate"><span class="pre">HelpEntry.db_key</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.db_help_category"><code class="docutils literal notranslate"><span class="pre">HelpEntry.db_help_category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.db_entrytext"><code class="docutils literal notranslate"><span class="pre">HelpEntry.db_entrytext</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.db_lock_storage"><code class="docutils literal notranslate"><span class="pre">HelpEntry.db_lock_storage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.db_tags"><code class="docutils literal notranslate"><span class="pre">HelpEntry.db_tags</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.db_date_created"><code class="docutils literal notranslate"><span class="pre">HelpEntry.db_date_created</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.objects"><code class="docutils literal notranslate"><span class="pre">HelpEntry.objects</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.locks"><code class="docutils literal notranslate"><span class="pre">HelpEntry.locks</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.tags"><code class="docutils literal notranslate"><span class="pre">HelpEntry.tags</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.aliases"><code class="docutils literal notranslate"><span class="pre">HelpEntry.aliases</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.date_created"><code class="docutils literal notranslate"><span class="pre">HelpEntry.date_created</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.access"><code class="docutils literal notranslate"><span class="pre">HelpEntry.access()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.search_index_entry"><code class="docutils literal notranslate"><span class="pre">HelpEntry.search_index_entry</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.web_get_admin_url"><code class="docutils literal notranslate"><span class="pre">HelpEntry.web_get_admin_url()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.web_get_create_url"><code class="docutils literal notranslate"><span class="pre">HelpEntry.web_get_create_url()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.web_get_detail_url"><code class="docutils literal notranslate"><span class="pre">HelpEntry.web_get_detail_url()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.web_get_update_url"><code class="docutils literal notranslate"><span class="pre">HelpEntry.web_get_update_url()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.web_get_delete_url"><code class="docutils literal notranslate"><span class="pre">HelpEntry.web_get_delete_url()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.get_absolute_url"><code class="docutils literal notranslate"><span class="pre">HelpEntry.get_absolute_url()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">HelpEntry.DoesNotExist</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">HelpEntry.MultipleObjectsReturned</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.entrytext"><code class="docutils literal notranslate"><span class="pre">HelpEntry.entrytext</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.get_next_by_db_date_created"><code class="docutils literal notranslate"><span class="pre">HelpEntry.get_next_by_db_date_created()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.get_previous_by_db_date_created"><code class="docutils literal notranslate"><span class="pre">HelpEntry.get_previous_by_db_date_created()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.help_category"><code class="docutils literal notranslate"><span class="pre">HelpEntry.help_category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.id"><code class="docutils literal notranslate"><span class="pre">HelpEntry.id</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.key"><code class="docutils literal notranslate"><span class="pre">HelpEntry.key</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.lock_storage"><code class="docutils literal notranslate"><span class="pre">HelpEntry.lock_storage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.path"><code class="docutils literal notranslate"><span class="pre">HelpEntry.path</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry.typename"><code class="docutils literal notranslate"><span class="pre">HelpEntry.typename</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.AliasHandler"><code class="docutils literal notranslate"><span class="pre">AliasHandler</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType"><code class="docutils literal notranslate"><span class="pre">ContentType</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">ContentType.DoesNotExist</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">ContentType.MultipleObjectsReturned</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.app_label"><code class="docutils literal notranslate"><span class="pre">ContentType.app_label</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.app_labeled_name"><code class="docutils literal notranslate"><span class="pre">ContentType.app_labeled_name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.get_all_objects_for_this_type"><code class="docutils literal notranslate"><span class="pre">ContentType.get_all_objects_for_this_type()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.get_object_for_this_type"><code class="docutils literal notranslate"><span class="pre">ContentType.get_object_for_this_type()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.id"><code class="docutils literal notranslate"><span class="pre">ContentType.id</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.logentry_set"><code class="docutils literal notranslate"><span class="pre">ContentType.logentry_set</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.model"><code class="docutils literal notranslate"><span class="pre">ContentType.model</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.model_class"><code class="docutils literal notranslate"><span class="pre">ContentType.model_class()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.name"><code class="docutils literal notranslate"><span class="pre">ContentType.name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.natural_key"><code class="docutils literal notranslate"><span class="pre">ContentType.natural_key()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.objects"><code class="docutils literal notranslate"><span class="pre">ContentType.objects</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.ContentType.permission_set"><code class="docutils literal notranslate"><span class="pre">ContentType.permission_set</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntryManager"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntryManager.all_to_category"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.all_to_category()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntryManager.create_help"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.create_help()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntryManager.find_apropos"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.find_apropos()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntryManager.find_topicmatch"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.find_topicmatch()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntryManager.find_topics_with_category"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.find_topics_with_category()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntryManager.find_topicsuggestions"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.find_topicsuggestions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntryManager.get_all_categories"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.get_all_categories()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntryManager.get_all_topics"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.get_all_topics()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntryManager.search_help"><code class="docutils literal notranslate"><span class="pre">HelpEntryManager.search_help()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler"><code class="docutils literal notranslate"><span class="pre">LockHandler</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.__init__"><code class="docutils literal notranslate"><span class="pre">LockHandler.__init__()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.add"><code class="docutils literal notranslate"><span class="pre">LockHandler.add()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.all"><code class="docutils literal notranslate"><span class="pre">LockHandler.all()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.append"><code class="docutils literal notranslate"><span class="pre">LockHandler.append()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.cache_lock_bypass"><code class="docutils literal notranslate"><span class="pre">LockHandler.cache_lock_bypass()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.check"><code class="docutils literal notranslate"><span class="pre">LockHandler.check()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.check_lockstring"><code class="docutils literal notranslate"><span class="pre">LockHandler.check_lockstring()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.clear"><code class="docutils literal notranslate"><span class="pre">LockHandler.clear()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.delete"><code class="docutils literal notranslate"><span class="pre">LockHandler.delete()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.get"><code class="docutils literal notranslate"><span class="pre">LockHandler.get()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.remove"><code class="docutils literal notranslate"><span class="pre">LockHandler.remove()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.replace"><code class="docutils literal notranslate"><span class="pre">LockHandler.replace()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.reset"><code class="docutils literal notranslate"><span class="pre">LockHandler.reset()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.LockHandler.validate"><code class="docutils literal notranslate"><span class="pre">LockHandler.validate()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.Meta"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.Meta</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.Meta.abstract"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.Meta.abstract</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.at_idmapper_flush"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.at_idmapper_flush()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.cache_instance"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.cache_instance()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.delete"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.delete()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.flush_cached_instance"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.flush_cached_instance()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.flush_from_cache"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.flush_from_cache()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.flush_instance_cache"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.flush_instance_cache()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.get_all_cached_instances"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.get_all_cached_instances()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.get_cached_instance"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.get_cached_instance()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.objects"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.objects</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.path"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.path</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.save"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.save()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.SharedMemoryModel.typename"><code class="docutils literal notranslate"><span class="pre">SharedMemoryModel.typename</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag"><code class="docutils literal notranslate"><span class="pre">Tag</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Tag.DoesNotExist</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Tag.MultipleObjectsReturned</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.accountdb_set"><code class="docutils literal notranslate"><span class="pre">Tag.accountdb_set</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.channeldb_set"><code class="docutils literal notranslate"><span class="pre">Tag.channeldb_set</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.db_category"><code class="docutils literal notranslate"><span class="pre">Tag.db_category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.db_data"><code class="docutils literal notranslate"><span class="pre">Tag.db_data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.db_key"><code class="docutils literal notranslate"><span class="pre">Tag.db_key</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.db_model"><code class="docutils literal notranslate"><span class="pre">Tag.db_model</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.db_tagtype"><code class="docutils literal notranslate"><span class="pre">Tag.db_tagtype</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.helpentry_set"><code class="docutils literal notranslate"><span class="pre">Tag.helpentry_set</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.id"><code class="docutils literal notranslate"><span class="pre">Tag.id</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.msg_set"><code class="docutils literal notranslate"><span class="pre">Tag.msg_set</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.objectdb_set"><code class="docutils literal notranslate"><span class="pre">Tag.objectdb_set</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.objects"><code class="docutils literal notranslate"><span class="pre">Tag.objects</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.Tag.scriptdb_set"><code class="docutils literal notranslate"><span class="pre">Tag.scriptdb_set</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler"><code class="docutils literal notranslate"><span class="pre">TagHandler</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler.__init__"><code class="docutils literal notranslate"><span class="pre">TagHandler.__init__()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler.add"><code class="docutils literal notranslate"><span class="pre">TagHandler.add()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler.all"><code class="docutils literal notranslate"><span class="pre">TagHandler.all()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler.batch_add"><code class="docutils literal notranslate"><span class="pre">TagHandler.batch_add()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler.batch_remove"><code class="docutils literal notranslate"><span class="pre">TagHandler.batch_remove()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler.clear"><code class="docutils literal notranslate"><span class="pre">TagHandler.clear()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler.get"><code class="docutils literal notranslate"><span class="pre">TagHandler.get()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler.has"><code class="docutils literal notranslate"><span class="pre">TagHandler.has()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler.remove"><code class="docutils literal notranslate"><span class="pre">TagHandler.remove()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.TagHandler.reset_cache"><code class="docutils literal notranslate"><span class="pre">TagHandler.reset_cache()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.lazy_property"><code class="docutils literal notranslate"><span class="pre">lazy_property</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.lazy_property.__init__"><code class="docutils literal notranslate"><span class="pre">lazy_property.__init__()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.reverse"><code class="docutils literal notranslate"><span class="pre">reverse()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.models.html#evennia.help.models.slugify"><code class="docutils literal notranslate"><span class="pre">slugify()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.help.utils.html">evennia.help.utils</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.utils.html#evennia.help.utils.wildcard_stemmer"><code class="docutils literal notranslate"><span class="pre">wildcard_stemmer()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.utils.html#evennia.help.utils.LunrSearch"><code class="docutils literal notranslate"><span class="pre">LunrSearch</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.utils.html#evennia.help.utils.LunrSearch.index"><code class="docutils literal notranslate"><span class="pre">LunrSearch.index()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.utils.html#evennia.help.utils.help_search_with_index"><code class="docutils literal notranslate"><span class="pre">help_search_with_index()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.help.utils.html#evennia.help.utils.parse_entry_for_subcategories"><code class="docutils literal notranslate"><span class="pre">parse_entry_for_subcategories()</span></code></a></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.utils.tree_select.tree_select.html"
title="previous chapter">evennia.contrib.utils.tree_select.tree_select</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.help.filehelp.html"
title="next chapter">evennia.help.filehelp</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.help.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/6.x/index.html">v6.0.0 branch (outdated)</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.help.filehelp.html" title="evennia.help.filehelp"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.tree_select.tree_select.html" title="evennia.contrib.utils.tree_select.tree_select"
>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-this"><a href="">evennia.help</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