Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-03 22:47:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/api/evennia.help.manager.html

232 lines
12 KiB
HTML
Raw Normal View History

Updated HTML docs
2020-07-14 00:21:00 +02:00
<!DOCTYPE html>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<html xmlns="http://www.w3.org/1999/xhtml">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<head>
<meta charset="utf-8" />
<title>evennia.help.manager &#8212; Evennia 1.0-dev documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<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>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
Updated HTML docs
2020-07-14 00:21:00 +02:00
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-evennia.help.manager">
<span id="evennia-help-manager"></span><h1>evennia.help.manager<a class="headerlink" href="#module-evennia.help.manager" title="Permalink to this headline"></a></h1>
<p>Custom manager for HelpEntry objects.</p>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<dl class="class">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.help.manager.HelpEntryManager">
Updated HTML docs
2020-10-11 22:19:29 +02:00
<em class="property">class </em><code class="sig-prename descclassname">evennia.help.manager.</code><code class="sig-name descname">HelpEntryManager</code><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.managers.html#evennia.typeclasses.managers.TypedObjectManager" title="evennia.typeclasses.managers.TypedObjectManager"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.managers.TypedObjectManager</span></code></a></p>
<p>This HelpEntryManager implements methods for searching
and manipulating HelpEntries directly from the database.</p>
<p>These methods will all return database objects
(or QuerySets) directly.</p>
<p>Evennia-specific:
find_topicmatch
find_apropos
find_topicsuggestions
find_topics_with_category
all_to_category
search_help (equivalent to evennia.search_helpentry)</p>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<dl class="method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.help.manager.HelpEntryManager.find_topicmatch">
Updated HTML docs
2020-10-11 22:19:29 +02:00
<code class="sig-name descname">find_topicmatch</code><span class="sig-paren">(</span><em class="sig-param">topicstr</em>, <em class="sig-param">exact=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.find_topicmatch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.find_topicmatch" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Searches for matching topics or aliases based on player’s
input.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>topcistr</strong> (<em>str</em>) – Help topic to search for.</p></li>
<li><p><strong>exact</strong> (<em>bool</em><em>, </em><em>optional</em>) – Require exact match
(non-case-sensitive). If <strong>False</strong> (default), match
sub-parts of the string.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>matches (HelpEntries)</em> – Query results.</p>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<dl class="method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.help.manager.HelpEntryManager.find_apropos">
Updated HTML docs
2020-10-11 22:19:29 +02:00
<code class="sig-name descname">find_apropos</code><span class="sig-paren">(</span><em class="sig-param">topicstr</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.find_apropos"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.find_apropos" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Do a very loose search, returning all help entries containing
the search criterion in their titles.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>topicstr</strong> (<em>str</em>) – Search criterion.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>matches (HelpEntries)</em> – Query results.</p>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<dl class="method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.help.manager.HelpEntryManager.find_topicsuggestions">
Updated HTML docs
2020-10-11 22:19:29 +02:00
<code class="sig-name descname">find_topicsuggestions</code><span class="sig-paren">(</span><em class="sig-param">topicstr</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.find_topicsuggestions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.find_topicsuggestions" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Do a fuzzy match, preferably within the category of the
current topic.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>topicstr</strong> (<em>str</em>) – Search criterion.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>matches (Helpentries)</em> – Query results.</p>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<dl class="method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.help.manager.HelpEntryManager.find_topics_with_category">
Updated HTML docs
2020-10-11 22:19:29 +02:00
<code class="sig-name descname">find_topics_with_category</code><span class="sig-paren">(</span><em class="sig-param">help_category</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.find_topics_with_category"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.find_topics_with_category" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Search topics having a particular category.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>help_category</strong> (<em>str</em>) – Category query criterion.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>matches (HelpEntries)</em> – Query results.</p>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<dl class="method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.help.manager.HelpEntryManager.get_all_topics">
<code class="sig-name descname">get_all_topics</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.get_all_topics"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.get_all_topics" title="Permalink to this definition"></a></dt>
<dd><p>Get all topics.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><em>all (HelpEntries)</em> – All topics.</p>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<dl class="method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.help.manager.HelpEntryManager.get_all_categories">
<code class="sig-name descname">get_all_categories</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.get_all_categories"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.get_all_categories" title="Permalink to this definition"></a></dt>
<dd><p>Return all defined category names with at least one topic in
them.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><p><em>matches (list)</em> –</p>
<dl class="simple">
<dt>Unique list of category names across all</dt><dd><p>topics.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<dl class="method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.help.manager.HelpEntryManager.all_to_category">
Updated HTML docs
2020-10-11 22:19:29 +02:00
<code class="sig-name descname">all_to_category</code><span class="sig-paren">(</span><em class="sig-param">default_category</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.all_to_category"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.all_to_category" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Shifts all help entries in database to default_category. This
action cannot be reverted. It is used primarily by the engine
when importing a default help database, making sure this ends
up in one easily separated category.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>default_category</strong> (<em>str</em>) – Category to move entries to.</p>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<dl class="method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.help.manager.HelpEntryManager.search_help">
Updated HTML docs
2020-10-11 22:19:29 +02:00
<code class="sig-name descname">search_help</code><span class="sig-paren">(</span><em class="sig-param">ostring</em>, <em class="sig-param">help_category=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/manager.html#HelpEntryManager.search_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.manager.HelpEntryManager.search_help" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Retrieve a search entry object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ostring</strong> (<em>str</em>) – The help topic to look for.</p></li>
<li><p><strong>category</strong> (<em>str</em>) – Limit the search to a particular help topic</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div 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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.help.manager.rst.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div>
<h3>Versions</h3>
<ul>
<li><a href="evennia.help.manager.html">1.0-dev (develop branch)</a></li>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<li><a href="../../0.9.5/api/evennia.help.manager.html">0.9.5 (master branch)</a></li>
Updated HTML docs
2020-07-14 00:21:00 +02:00
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
Updated HTML docs
2020-07-14 00:21:00 +02:00
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Updated HTML docs
2020-10-11 22:19:29 +02:00
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
Updated HTML docs
2020-07-14 00:21:00 +02:00
</div>
</body>
</html>
Reference in a new issue Copy permalink