Updated HTML docs.

This commit is contained in:
Evennia docbuilder action 2026-02-15 17:42:43 +00:00
parent d35cbb8f68
commit 4544902e08
199 changed files with 3931 additions and 855 deletions

View file

@ -297,6 +297,12 @@ could be used).</p>
<dd><p>Bases: <a class="reference internal" href="#evennia.scripts.scripts.ScriptBase.MultipleObjectsReturned" title="evennia.scripts.scripts.ScriptBase.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.scripts.scripts.DefaultScript.NotUpdated">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">NotUpdated</span></span><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.NotUpdated" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.scripts.scripts.ScriptBase.NotUpdated" title="evennia.scripts.scripts.ScriptBase.NotUpdated"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotUpdated</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.scripts.scripts.DefaultScript.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.scripts.scripts.DefaultScript'</span></em><a class="headerlink" href="#evennia.scripts.scripts.DefaultScript.path" title="Link to this definition"></a></dt>
@ -332,6 +338,12 @@ could be used).</p>
<dd><p>Bases: <a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.scripts.scripts.DoNothing.NotUpdated">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">NotUpdated</span></span><a class="headerlink" href="#evennia.scripts.scripts.DoNothing.NotUpdated" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.NotUpdated" title="evennia.scripts.scripts.DefaultScript.NotUpdated"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotUpdated</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.scripts.scripts.DoNothing.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.scripts.scripts.DoNothing'</span></em><a class="headerlink" href="#evennia.scripts.scripts.DoNothing.path" title="Link to this definition"></a></dt>
@ -367,6 +379,12 @@ could be used).</p>
<dd><p>Bases: <a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned" title="evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.scripts.scripts.Store.NotUpdated">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">NotUpdated</span></span><a class="headerlink" href="#evennia.scripts.scripts.Store.NotUpdated" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.NotUpdated" title="evennia.scripts.scripts.DefaultScript.NotUpdated"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotUpdated</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.scripts.scripts.Store.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.scripts.scripts.Store'</span></em><a class="headerlink" href="#evennia.scripts.scripts.Store.path" title="Link to this definition"></a></dt>
@ -1168,6 +1186,12 @@ had fired normally.</p>
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.models.html#evennia.scripts.models.ScriptDB.MultipleObjectsReturned" title="evennia.scripts.models.ScriptDB.MultipleObjectsReturned"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></a></p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.scripts.scripts.ScriptBase.NotUpdated">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">NotUpdated</span></span><a class="headerlink" href="#evennia.scripts.scripts.ScriptBase.NotUpdated" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.scripts.models.html#evennia.scripts.models.ScriptDB.NotUpdated" title="evennia.scripts.models.ScriptDB.NotUpdated"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotUpdated</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.scripts.scripts.ScriptBase.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.scripts.scripts.ScriptBase'</span></em><a class="headerlink" href="#evennia.scripts.scripts.ScriptBase.path" title="Link to this definition"></a></dt>
@ -1218,6 +1242,12 @@ is_active - bool if script is currently running</p>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleObjectsReturned</span></code></p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="evennia.scripts.scripts.ScriptDB.NotUpdated">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">NotUpdated</span></span><a class="headerlink" href="#evennia.scripts.scripts.ScriptDB.NotUpdated" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectNotUpdated</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">DatabaseError</span></code></p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.scripts.scripts.ScriptDB.account">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">account</span></span><a class="headerlink" href="#evennia.scripts.scripts.ScriptDB.account" title="Link to this definition"></a></dt>
@ -1558,6 +1588,7 @@ necessary.</p>
<li><a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.at_server_start"><code class="docutils literal notranslate"><span class="pre">DefaultScript.at_server_start()</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">DefaultScript.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">DefaultScript.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.NotUpdated"><code class="docutils literal notranslate"><span class="pre">DefaultScript.NotUpdated</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.path"><code class="docutils literal notranslate"><span class="pre">DefaultScript.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.DefaultScript.typename"><code class="docutils literal notranslate"><span class="pre">DefaultScript.typename</span></code></a></li>
</ul>
@ -1566,6 +1597,7 @@ necessary.</p>
<li><a class="reference internal" href="#evennia.scripts.scripts.DoNothing.at_script_creation"><code class="docutils literal notranslate"><span class="pre">DoNothing.at_script_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.DoNothing.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">DoNothing.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.DoNothing.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">DoNothing.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.DoNothing.NotUpdated"><code class="docutils literal notranslate"><span class="pre">DoNothing.NotUpdated</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.DoNothing.path"><code class="docutils literal notranslate"><span class="pre">DoNothing.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.DoNothing.typename"><code class="docutils literal notranslate"><span class="pre">DoNothing.typename</span></code></a></li>
</ul>
@ -1574,6 +1606,7 @@ necessary.</p>
<li><a class="reference internal" href="#evennia.scripts.scripts.Store.at_script_creation"><code class="docutils literal notranslate"><span class="pre">Store.at_script_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.Store.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">Store.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.Store.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">Store.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.Store.NotUpdated"><code class="docutils literal notranslate"><span class="pre">Store.NotUpdated</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.Store.path"><code class="docutils literal notranslate"><span class="pre">Store.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.Store.typename"><code class="docutils literal notranslate"><span class="pre">Store.typename</span></code></a></li>
</ul>
@ -1645,6 +1678,7 @@ necessary.</p>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptBase.force_repeat"><code class="docutils literal notranslate"><span class="pre">ScriptBase.force_repeat()</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptBase.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">ScriptBase.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptBase.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">ScriptBase.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptBase.NotUpdated"><code class="docutils literal notranslate"><span class="pre">ScriptBase.NotUpdated</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptBase.path"><code class="docutils literal notranslate"><span class="pre">ScriptBase.path</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptBase.typename"><code class="docutils literal notranslate"><span class="pre">ScriptBase.typename</span></code></a></li>
</ul>
@ -1652,6 +1686,7 @@ necessary.</p>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptDB"><code class="docutils literal notranslate"><span class="pre">ScriptDB</span></code></a><ul>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptDB.DoesNotExist"><code class="docutils literal notranslate"><span class="pre">ScriptDB.DoesNotExist</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptDB.MultipleObjectsReturned"><code class="docutils literal notranslate"><span class="pre">ScriptDB.MultipleObjectsReturned</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptDB.NotUpdated"><code class="docutils literal notranslate"><span class="pre">ScriptDB.NotUpdated</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptDB.account"><code class="docutils literal notranslate"><span class="pre">ScriptDB.account</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptDB.db_account"><code class="docutils literal notranslate"><span class="pre">ScriptDB.db_account</span></code></a></li>
<li><a class="reference internal" href="#evennia.scripts.scripts.ScriptDB.db_account_id"><code class="docutils literal notranslate"><span class="pre">ScriptDB.db_account_id</span></code></a></li>