Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-02 22:17:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-10-19 08:58:16 +02:00
parent 88483fc3fa
commit 8936980973
297 changed files with 5517 additions and 23708 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/1.0-dev/api/evennia.utils.optionclasses.html
View file

@ -38,6 +38,8 @@
<div class="section" id="module-evennia.utils.optionclasses">
<span id="evennia-utils-optionclasses"></span><h1>evennia.utils.optionclasses<a class="headerlink" href="#module-evennia.utils.optionclasses" title="Permalink to this headline"></a></h1>
<p>Option classes store user- or server Options in a generic way
while also providing validation.</p>
<dl class="py class">
<dt id="evennia.utils.optionclasses.BaseOption">
<em class="property">class </em><code class="sig-prename descclassname">evennia.utils.optionclasses.</code><code class="sig-name descname">BaseOption</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">handler</span></em>, <em class="sig-param"><span class="n">key</span></em>, <em class="sig-param"><span class="n">description</span></em>, <em class="sig-param"><span class="n">default</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/utils/optionclasses.html#BaseOption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.optionclasses.BaseOption" title="Permalink to this definition"></a></dt>
@ -114,8 +116,8 @@ passing extra instructions into the validator.</p>
<dt id="evennia.utils.optionclasses.BaseOption.save">
<code class="sig-name descname">save</code><span class="sig-paren">(</span><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/utils/optionclasses.html#BaseOption.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.utils.optionclasses.BaseOption.save" title="Permalink to this definition"></a></dt>
<dd><p>Stores the current value using <strong>.handler.save_handler(self.key, value, **kwargs)</strong>
where <strong>kwargs</strong> are a combination of those passed into this function and
the ones specified by the <strong>OptionHandler</strong>.</p>
where kwargs are a combination of those passed into this function and the
ones specified by the OptionHandler.</p>
<dl class="field-list simple">
<dt class="field-odd">Keyword Arguments</dt>
<dd class="field-odd"><p><strong>any</strong> (<em>any</em>) – Not used by default. These are passed in from self.set