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

244 lines
15 KiB
HTML
Raw Normal View History

Updated HTML docs
2021-05-15 00:35:21 +02:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
Updated HTML docs
2021-05-16 00:06:01 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
Updated HTML docs
2021-05-15 00:35:21 +02:00
<title>evennia.help.filehelp &#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>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.help.filehelp</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
Updated HTML docs
2021-05-16 00:06:01 +02:00
<section id="module-evennia.help.filehelp">
Updated HTML docs
2021-05-15 00:35:21 +02:00
<span id="evennia-help-filehelp"></span><h1>evennia.help.filehelp<a class="headerlink" href="#module-evennia.help.filehelp" title="Permalink to this headline"></a></h1>
<p>The filehelp-system allows for defining help files outside of the game. These
will be treated as non-command help entries and displayed in the same way as
help entries created using the <strong>sethelp</strong> default command. After changing an
entry on-disk you need to reload the server to have the change show in-game.</p>
Updated HTML docs
2021-05-29 13:55:45 +02:00
<p>An filehelp file is a regular python module with dicts representing each help
Updated HTML docs
2021-05-15 00:35:21 +02:00
entry. If a list <strong>HELP_ENTRY_DICTS</strong> is found in the module, this should be a list of
dicts. Otherwise <em>all</em> top-level dicts in the module will be assumed to be a
help-entry dict.</p>
<p>Each help-entry dict is on the form</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">&#39;key&#39;</span><span class="p">:</span> <span class="o">&lt;</span><span class="nb">str</span><span class="o">&gt;</span><span class="p">,</span>
<span class="s1">&#39;category&#39;</span><span class="p">:</span> <span class="o">&lt;</span><span class="nb">str</span><span class="o">&gt;</span><span class="p">,</span> <span class="c1"># optional, otherwise settings.DEFAULT_HELP_CATEGORY</span>
<span class="s1">&#39;aliases&#39;</span><span class="p">:</span> <span class="o">&lt;</span><span class="nb">list</span><span class="o">&gt;</span><span class="p">,</span> <span class="c1"># optional</span>
Updated HTML docs
2021-05-29 13:55:45 +02:00
<span class="s1">&#39;text&#39;</span><span class="p">:</span> <span class="o">&lt;</span><span class="nb">str</span><span class="o">&gt;</span><span class="p">}</span>
Updated HTML docs
2021-05-15 00:35:21 +02:00
</pre></div>
</div>
Updated HTML docs
2021-05-29 13:55:45 +02:00
<p>where the <strong>category</strong> is optional and the <strong>text**</strong> should be formatted on the
Updated HTML docs
2021-05-15 00:35:21 +02:00
same form as other help entry-texts and contain <strong>**# subtopics**</strong> as normal.</p>
<p>New help-entry modules are added to the system by providing the python-path to
the module to <strong>settings.FILE_HELP_ENTRY_MODULES</strong>. Note that if same-key entries are
added, entries in latter modules will override that of earlier ones. Use
Updated HTML docs
2021-05-29 13:55:45 +02:00
<strong>settings.DEFAULT_HELP_CATEGORY**</strong> to customize what category is used if
Updated HTML docs
2021-05-15 00:35:21 +02:00
not set explicitly.</p>
<p>An example of the contents of a module:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">help_entry1</span> <span class="o">=</span> <span class="p">{</span>
Updated HTML docs
2021-05-29 13:55:45 +02:00
<span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="s2">&quot;The Gods&quot;</span><span class="p">,</span> <span class="c1"># case-insensitive, also partial-matching (&#39;gods&#39;) works</span>
<span class="s2">&quot;aliases&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;pantheon&#39;</span><span class="p">,</span> <span class="s1">&#39;religion&#39;</span><span class="p">],</span>
Updated HTML docs
2021-05-15 00:35:21 +02:00
<span class="s2">&quot;category&quot;</span><span class="p">:</span> <span class="s2">&quot;Lore&quot;</span><span class="p">,</span>
<span class="s2">&quot;text&quot;</span><span class="p">:</span> <span class="s1">&#39;&#39;&#39;</span>
<span class="s1"> The gods formed the world ...</span>
<span class="s1"> # Subtopics</span>
<span class="s1"> ## Pantheon</span>
<span class="s1"> ...</span>
<span class="s1"> ### God of love</span>
<span class="s1"> ...</span>
<span class="s1"> ### God of war</span>
<span class="s1"> ...</span>
<span class="s1"> &#39;&#39;&#39;</span>
<span class="p">}</span>
<span class="n">HELP_ENTRY_DICTS</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">help_entry1</span><span class="p">,</span>
<span class="o">...</span>
<span class="p">]</span>
</pre></div>
</div>
<hr class="docutils" />
<dl class="py class">
<dt id="evennia.help.filehelp.FileHelpEntry">
<em class="property">class </em><code class="sig-prename descclassname">evennia.help.filehelp.</code><code class="sig-name descname">FileHelpEntry</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="p">:</span> <span class="n">list</span></em>, <em class="sig-param"><span class="n">help_category</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">entrytext</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/filehelp.html#FileHelpEntry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.filehelp.FileHelpEntry" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Represents a help entry read from file. This mimics the api of the
database-bound HelpEntry so that they can be used interchangeably in the
help command.</p>
<dl class="py attribute">
<dt id="evennia.help.filehelp.FileHelpEntry.key">
<code class="sig-name descname">key</code><em class="property">: str</em><a class="headerlink" href="#evennia.help.filehelp.FileHelpEntry.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.help.filehelp.FileHelpEntry.aliases">
<code class="sig-name descname">aliases</code><em class="property">: list</em><a class="headerlink" href="#evennia.help.filehelp.FileHelpEntry.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.help.filehelp.FileHelpEntry.help_category">
<code class="sig-name descname">help_category</code><em class="property">: str</em><a class="headerlink" href="#evennia.help.filehelp.FileHelpEntry.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.help.filehelp.FileHelpEntry.entrytext">
<code class="sig-name descname">entrytext</code><em class="property">: str</em><a class="headerlink" href="#evennia.help.filehelp.FileHelpEntry.entrytext" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.help.filehelp.FileHelpEntry.search_index_entry">
<em class="property">property </em><code class="sig-name descname">search_index_entry</code><a class="headerlink" href="#evennia.help.filehelp.FileHelpEntry.search_index_entry" title="Permalink to this definition"></a></dt>
<dd><p>Property for easily retaining a search index entry for this object.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.help.filehelp.FileHelpEntry.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">aliases</span><span class="p">:</span> <span class="n">list</span></em>, <em class="sig-param"><span class="n">help_category</span><span class="p">:</span> <span class="n">str</span></em>, <em class="sig-param"><span class="n">entrytext</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#evennia.help.filehelp.FileHelpEntry.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.help.filehelp.FileHelpStorageHandler">
<em class="property">class </em><code class="sig-prename descclassname">evennia.help.filehelp.</code><code class="sig-name descname">FileHelpStorageHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">help_file_modules</span><span class="o">=</span><span class="default_value">['world.help_entries']</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/filehelp.html#FileHelpStorageHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.filehelp.FileHelpStorageHandler" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This reads and stores help entries for quick access. By default
it reads modules from <strong>settings.FILE_HELP_ENTRY_MODULES</strong>.</p>
<p>Note that this is not meant to any searching/lookup - that is all handled
by the help command.</p>
<dl class="py method">
<dt id="evennia.help.filehelp.FileHelpStorageHandler.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">help_file_modules</span><span class="o">=</span><span class="default_value">['world.help_entries']</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/filehelp.html#FileHelpStorageHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.filehelp.FileHelpStorageHandler.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Initialize the storage.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.help.filehelp.FileHelpStorageHandler.load">
<code class="sig-name descname">load</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/filehelp.html#FileHelpStorageHandler.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.filehelp.FileHelpStorageHandler.load" title="Permalink to this definition"></a></dt>
<dd><p>Load/reload file-based help-entries from file.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.help.filehelp.FileHelpStorageHandler.all">
<code class="sig-name descname">all</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">return_dict</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/help/filehelp.html#FileHelpStorageHandler.all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.help.filehelp.FileHelpStorageHandler.all" title="Permalink to this definition"></a></dt>
<dd><p>Get all help entries.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>return_dict</strong> (<em>bool</em>) – Return a dict <strong>**{key: FileHelpEntry,…}**</strong>. Otherwise,
return a list of <strong>**FileHelpEntry</strong>.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>dict or list</em> – Depending on the setting of <strong>**return_dict**</strong>.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Updated HTML docs
2021-05-16 00:06:01 +02:00
</section>
Updated HTML docs
2021-05-15 00:35:21 +02:00
<div class="clearer"></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.filehelp.rst.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>
<li><a href="evennia.help.filehelp.html">1.0-dev (develop branch)</a></li>
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</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>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.help.filehelp</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue Copy permalink