mirror of
https://github.com/evennia/evennia.git
synced 2026-04-01 05:27:17 +02:00
Updated HTML docs
This commit is contained in:
Evennia docbuilder action
parent
478c0b6473
commit
0e0cd24694
958 changed files with 41858 additions and 39649 deletions
|
|
@ -46,57 +46,8 @@
|
|||
</div>
|
||||
|
||||
<div class="document">
|
||||
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.server.manager">
|
||||
<span id="evennia-server-manager"></span><h1>evennia.server.manager<a class="headerlink" href="#module-evennia.server.manager" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Custom manager for ServerConfig objects.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.server.manager.ServerConfigManager">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.manager.</code><code class="sig-name descname">ServerConfigManager</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/manager.html#ServerConfigManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.manager.ServerConfigManager" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.db.models.manager.Manager</span></code></p>
|
||||
<p>This ServerConfigManager implements methods for searching and
|
||||
manipulating ServerConfigs directly from the database.</p>
|
||||
<p>These methods will all return database objects (or QuerySets)
|
||||
directly.</p>
|
||||
<p>ServerConfigs are used to store certain persistent settings for
|
||||
the server at run-time.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.server.manager.ServerConfigManager.conf">
|
||||
<code class="sig-name descname">conf</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">delete</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/manager.html#ServerConfigManager.conf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.manager.ServerConfigManager.conf" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add, retrieve and manipulate config values.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>key</strong> (<em>str</em><em>, </em><em>optional</em>) – Name of config.</p></li>
|
||||
<li><p><strong>value</strong> (<em>str</em><em>, </em><em>optional</em>) – Data to store in this config value.</p></li>
|
||||
<li><p><strong>delete</strong> (<em>bool</em><em>, </em><em>optional</em>) – If <strong>True</strong>, delete config with <strong>key</strong>.</p></li>
|
||||
<li><p><strong>default</strong> (<em>str</em><em>, </em><em>optional</em>) – Use when retrieving a config value
|
||||
by a key that does not exist.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>all (list)</em> – If <strong>key</strong> was not given - all stored config values.
|
||||
value (str): If <strong>key</strong> was given, this is the stored value, or</p>
|
||||
<blockquote>
|
||||
<div><p><strong>default</strong> if no matching <strong>key</strong> was found.</p>
|
||||
</div></blockquote>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<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">
|
||||
|
|
@ -143,7 +94,56 @@ value (str): If <strong>key</strong> was given, this is the stored value, or</p>
|
|||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="module-evennia.server.manager">
|
||||
<span id="evennia-server-manager"></span><h1>evennia.server.manager<a class="headerlink" href="#module-evennia.server.manager" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Custom manager for ServerConfig objects.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.server.manager.ServerConfigManager">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.manager.</code><code class="sig-name descname">ServerConfigManager</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/manager.html#ServerConfigManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.manager.ServerConfigManager" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.db.models.manager.Manager</span></code></p>
|
||||
<p>This ServerConfigManager implements methods for searching and
|
||||
manipulating ServerConfigs directly from the database.</p>
|
||||
<p>These methods will all return database objects (or QuerySets)
|
||||
directly.</p>
|
||||
<p>ServerConfigs are used to store certain persistent settings for
|
||||
the server at run-time.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.server.manager.ServerConfigManager.conf">
|
||||
<code class="sig-name descname">conf</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">value</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">delete</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/manager.html#ServerConfigManager.conf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.manager.ServerConfigManager.conf" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add, retrieve and manipulate config values.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>key</strong> (<em>str</em><em>, </em><em>optional</em>) – Name of config.</p></li>
|
||||
<li><p><strong>value</strong> (<em>str</em><em>, </em><em>optional</em>) – Data to store in this config value.</p></li>
|
||||
<li><p><strong>delete</strong> (<em>bool</em><em>, </em><em>optional</em>) – If <strong>True</strong>, delete config with <strong>key</strong>.</p></li>
|
||||
<li><p><strong>default</strong> (<em>str</em><em>, </em><em>optional</em>) – Use when retrieving a config value
|
||||
by a key that does not exist.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>all (list)</em> – If <strong>key</strong> was not given - all stored config values.
|
||||
value (str): If <strong>key</strong> was given, this is the stored value, or</p>
|
||||
<blockquote>
|
||||
<div><p><strong>default</strong> if no matching <strong>key</strong> was found.</p>
|
||||
</div></blockquote>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue