mirror of
https://github.com/evennia/evennia.git
synced 2026-03-30 04:27:16 +02:00
Updated HTML docs.
This commit is contained in:
parent
d75134ec08
commit
817fe7cb41
52 changed files with 1027 additions and 627 deletions
|
|
@ -1,4 +1,4 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: c0742352c51ea20dbac6882aade6f727
|
||||
config: bee62a60e87a7d499134e040f17e1f7a
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
|
|
|||
|
|
@ -200,6 +200,14 @@ erroring out on setting it would make it even less useful (Griatch).</p></li>
|
|||
<li><p>[Fix] <code class="docutils literal notranslate"><span class="pre">services</span></code> command with no args would traceback (regression) (Griatch)</p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/evennia/evennia/pull/3412">Feature</a>: Make it possible to add custom webclient css in
|
||||
<code class="docutils literal notranslate"><span class="pre">webclient/css/custom.css</span></code>, same as for website (InspectorCaracal)</p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/evennia/evennia/pull/3423">Fix</a>: Fix wilderness contrib error moving to an already existing
|
||||
wilderness room (InspectorCaracal)</p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/evennia/evennia/pull/3425">Fix</a>: Don’t always include example the crafting recipe when
|
||||
using the crafting contrib (InspectorCaracal)</p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/evennia/evennia/pull/3426">pull3426</a>: Traceback banning a channel using with only one nick
|
||||
(InspectorCaracal)</p></li>
|
||||
<li><p><a class="reference external" href="https://github.com/evennia/evennia/pull/3434">pull3434</a>: Adjust lunr search weights to void clashing of cmd-aliases over
|
||||
keys which caused some help entries to shadow others (InspectorCaracal)</p></li>
|
||||
<li><p>Doc fixes (InspectorCaracal, Griatch)</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -70,6 +70,7 @@
|
|||
<li><a class="reference internal" href="#pros">Pros</a></li>
|
||||
<li><a class="reference internal" href="#cons">Cons</a></li>
|
||||
<li><a class="reference internal" href="#how-to-install">How to install</a></li>
|
||||
<li><a class="reference internal" href="#known-issues">Known Issues</a></li>
|
||||
<li><a class="reference internal" href="#full-example">Full Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -155,11 +156,19 @@ import and inherit the ComponentHolderMixin, similar to this</p>
|
|||
<span class="c1"># ...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Components need to inherit the Component class directly and require a name.</p>
|
||||
<p>Components need to inherit the Component class and require a unique name.
|
||||
Components may inherit from other components but must specify another name.
|
||||
You can assign the same ‘slot’ to both components to have alternative implementations.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.components</span> <span class="kn">import</span> <span class="n">Component</span>
|
||||
|
||||
|
||||
<span class="k">class</span> <span class="nc">Health</span><span class="p">(</span><span class="n">Component</span><span class="p">):</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s2">"health"</span>
|
||||
|
||||
|
||||
<span class="k">class</span> <span class="nc">ItemHealth</span><span class="p">(</span><span class="n">Health</span><span class="p">):</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s2">"item_health"</span>
|
||||
<span class="n">slot</span> <span class="o">=</span> <span class="s2">"health"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Components may define DBFields or NDBFields at the class level.
|
||||
|
|
@ -215,7 +224,10 @@ Example</p>
|
|||
|
||||
<span class="o">...</span>
|
||||
|
||||
<span class="n">vampirism_from_elsewhere</span> <span class="o">=</span> <span class="n">character</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"vampirism"</span><span class="p">)</span>
|
||||
<span class="n">vampirism</span> <span class="o">=</span> <span class="n">character</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"vampirism"</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># Alternatively</span>
|
||||
<span class="n">vampirism</span> <span class="o">=</span> <span class="n">character</span><span class="o">.</span><span class="n">cmp</span><span class="o">.</span><span class="n">vampirism</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Keep in mind that all components must be imported to be visible in the listing.
|
||||
|
|
@ -239,6 +251,14 @@ You only need to import each module/file from there but importing the right clas
|
|||
</div>
|
||||
<p>Both of the above examples will work.</p>
|
||||
</section>
|
||||
<section id="known-issues">
|
||||
<h2>Known Issues<a class="headerlink" href="#known-issues" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Assigning mutable default values such as a list to a DBField will share it across instances.
|
||||
To avoid this, you must set autocreate=True on the field, like this.</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">health</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="p">[],</span> <span class="n">autocreate</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="full-example">
|
||||
<h2>Full Example<a class="headerlink" href="#full-example" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">evennia.contrib.base_systems</span> <span class="kn">import</span> <span class="n">components</span>
|
||||
|
|
|
|||
|
|
@ -717,7 +717,7 @@
|
|||
<span class="c1"># find all of target's nicks linked to this channel and delete them</span>
|
||||
<span class="k">for</span> <span class="n">nick</span> <span class="ow">in</span> <span class="p">[</span>
|
||||
<span class="n">nick</span>
|
||||
<span class="k">for</span> <span class="n">nick</span> <span class="ow">in</span> <span class="n">target</span><span class="o">.</span><span class="n">nicks</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">category</span><span class="o">=</span><span class="s2">"channel"</span><span class="p">)</span> <span class="ow">or</span> <span class="p">[]</span>
|
||||
<span class="k">for</span> <span class="n">nick</span> <span class="ow">in</span> <span class="n">target</span><span class="o">.</span><span class="n">nicks</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">category</span><span class="o">=</span><span class="s2">"channel"</span><span class="p">,</span> <span class="n">return_tuple</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="ow">or</span> <span class="p">[]</span>
|
||||
<span class="k">if</span> <span class="n">nick</span><span class="o">.</span><span class="n">value</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">channel</span><span class="o">.</span><span class="n">key</span>
|
||||
<span class="p">]:</span>
|
||||
<span class="n">nick</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
|
||||
|
|
|
|||
|
|
@ -570,9 +570,9 @@
|
|||
<span class="c1"># lunr search fields/boosts</span>
|
||||
<span class="n">search_fields</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">10</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"aliases"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">9</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"no_prefix"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">8</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"category"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">7</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"aliases"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">7</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"no_prefix"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">6</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"category"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">5</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"tags"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">1</span><span class="p">},</span> <span class="c1"># tags are not used by default</span>
|
||||
<span class="p">]</span>
|
||||
<span class="n">match</span><span class="p">,</span> <span class="n">suggestions</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span>
|
||||
|
|
|
|||
|
|
@ -1,150 +0,0 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>evennia.contrib.base_systems.components — Evennia latest 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 latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../evennia.html" accesskey="U">evennia</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
|
||||
<div class="documentwrapper">
|
||||
<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><h3>Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
|
||||
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
||||
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
|
||||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||||
<li>
|
||||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Doc Versions</h3>
|
||||
<ul>
|
||||
|
||||
<li><a href="components.html">latest (main branch)</a></li>
|
||||
|
||||
<li><a href="../../3.x/index.html">v3.0.0 branch (outdated)</a></li>
|
||||
|
||||
<li><a href="../../2.x/index.html">v2.0.0 branch (outdated)</a></li>
|
||||
|
||||
<li><a href="../../1.x/index.html">v1.0.0 branch (outdated)</a></li>
|
||||
|
||||
<li><a href="../../0.x/index.html">v0.9.5 branch (outdated)</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for evennia.contrib.base_systems.components</h1><div class="highlight"><pre>
|
||||
<span></span><span class="sd">"""</span>
|
||||
<span class="sd">Components - ChrisLR 2022</span>
|
||||
|
||||
<span class="sd">This is a basic Component System.</span>
|
||||
<span class="sd">It allows you to use components on typeclasses using a simple syntax.</span>
|
||||
<span class="sd">This helps writing isolated code and reusing it over multiple objects.</span>
|
||||
|
||||
<span class="sd">See the docs for more information.</span>
|
||||
<span class="sd">"""</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.components.component</span> <span class="kn">import</span> <span class="n">Component</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.components.dbfield</span> <span class="kn">import</span> <span class="n">DBField</span><span class="p">,</span> <span class="n">NDBField</span><span class="p">,</span> <span class="n">TagField</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.components.holder</span> <span class="kn">import</span> <span class="p">(</span>
|
||||
<span class="n">ComponentHolderMixin</span><span class="p">,</span>
|
||||
<span class="n">ComponentProperty</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="get_component_class"><a class="viewcode-back" href="../../../../api/evennia.contrib.base_systems.components.html#evennia.contrib.base_systems.components.get_component_class">[docs]</a><span class="k">def</span> <span class="nf">get_component_class</span><span class="p">(</span><span class="n">component_name</span><span class="p">):</span>
|
||||
<span class="n">subclasses</span> <span class="o">=</span> <span class="n">Component</span><span class="o">.</span><span class="n">__subclasses__</span><span class="p">()</span>
|
||||
<span class="n">component_class</span> <span class="o">=</span> <span class="nb">next</span><span class="p">((</span><span class="n">sc</span> <span class="k">for</span> <span class="n">sc</span> <span class="ow">in</span> <span class="n">subclasses</span> <span class="k">if</span> <span class="n">sc</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">component_name</span><span class="p">),</span> <span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">component_class</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="n">message</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="sa">f</span><span class="s2">"Component named </span><span class="si">{</span><span class="n">component_name</span><span class="si">}</span><span class="s2"> has not been found. "</span>
|
||||
<span class="sa">f</span><span class="s2">"Make sure it has been imported before being used."</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">component_class</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</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 latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2023, The Evennia developer community.
|
||||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -32,8 +32,7 @@
|
|||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="../components.html" accesskey="U">evennia.contrib.base_systems.components</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" accesskey="U">evennia</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components.component</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -94,10 +93,41 @@
|
|||
|
||||
<span class="sd">This file contains the base class to inherit for creating new components.</span>
|
||||
<span class="sd">"""</span>
|
||||
<span class="kn">import</span> <span class="nn">itertools</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">evennia.commands.cmdset</span> <span class="kn">import</span> <span class="n">CmdSet</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.components</span> <span class="kn">import</span> <span class="n">COMPONENT_LISTING</span><span class="p">,</span> <span class="n">exceptions</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Component"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component">[docs]</a><span class="k">class</span> <span class="nc">Component</span><span class="p">:</span>
|
||||
<div class="viewcode-block" id="BaseComponent"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.BaseComponent">[docs]</a><span class="k">class</span> <span class="nc">BaseComponent</span><span class="p">(</span><span class="nb">type</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> This is the metaclass for components,</span>
|
||||
<span class="sd"> responsible for registering components to the listing.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="nd">@classmethod</span>
|
||||
<span class="k">def</span> <span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Every class that uses this metaclass will be registered</span>
|
||||
<span class="sd"> as a component in the Component Listing using its name.</span>
|
||||
<span class="sd"> All of them require a unique name.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">new_type</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">new_type</span><span class="o">.</span><span class="n">__base__</span> <span class="o">==</span> <span class="nb">object</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">new_type</span>
|
||||
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">new_type</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">name</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Component </span><span class="si">{</span><span class="n">new_type</span><span class="si">}</span><span class="s2"> requires a name."</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">existing_type</span> <span class="o">:=</span> <span class="n">COMPONENT_LISTING</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">str</span><span class="p">(</span><span class="n">new_type</span><span class="p">)</span> <span class="o">==</span> <span class="nb">str</span><span class="p">(</span><span class="n">existing_type</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Component name </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> is a duplicate, must be unique."</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">COMPONENT_LISTING</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_type</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">new_type</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Component"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component">[docs]</a><span class="k">class</span> <span class="nc">Component</span><span class="p">(</span><span class="n">metaclass</span><span class="o">=</span><span class="n">BaseComponent</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> This is the base class for components.</span>
|
||||
<span class="sd"> Any component must inherit from this class to be considered for usage.</span>
|
||||
|
|
@ -105,10 +135,15 @@
|
|||
<span class="sd"> Each Component must supply the name, it is used as a slot name but also part of the attribute key.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'host'</span><span class="p">,)</span>
|
||||
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s2">""</span>
|
||||
<span class="n">slot</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
|
||||
<span class="n">_fields</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
|
||||
<div class="viewcode-block" id="Component.__init__"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"All Components must have a Name"</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"All Components must have a name"</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="n">host</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Component.default_create"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.default_create">[docs]</a> <span class="nd">@classmethod</span>
|
||||
|
|
@ -152,8 +187,8 @@
|
|||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> This deletes all component attributes from the host's db</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">for</span> <span class="n">attribute</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_all_db_field_names</span><span class="p">:</span>
|
||||
<span class="nb">delattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attribute</span><span class="p">)</span></div>
|
||||
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fields</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
|
||||
<span class="nb">delattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Component.load"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.load">[docs]</a> <span class="nd">@classmethod</span>
|
||||
<span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
|
||||
|
|
@ -168,7 +203,6 @@
|
|||
<span class="sd"> Component: The loaded instance of the component</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">host</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Component.at_added"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.at_added">[docs]</a> <span class="k">def</span> <span class="nf">at_added</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
|
||||
|
|
@ -179,12 +213,8 @@
|
|||
<span class="sd"> host (object): The host typeclass instance</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">==</span> <span class="n">host</span><span class="p">:</span>
|
||||
<span class="k">return</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="n">ComponentRegisterError</span><span class="p">(</span><span class="s2">"Components must not register twice!"</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">!=</span> <span class="n">host</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">InvalidComponentError</span><span class="p">(</span><span class="s2">"Components must not register twice!"</span><span class="p">)</span>
|
||||
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="n">host</span></div>
|
||||
|
||||
|
|
@ -197,7 +227,8 @@
|
|||
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">if</span> <span class="n">host</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="n">ComponentRegisterError</span><span class="p">(</span><span class="s2">"Component attempted to remove from the wrong host."</span><span class="p">)</span>
|
||||
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Component attempted to remove from the wrong host."</span><span class="p">)</span>
|
||||
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="kc">None</span></div>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
|
|
@ -222,28 +253,17 @@
|
|||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">nattributes</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">_all_db_field_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">itertools</span><span class="o">.</span><span class="n">chain</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_field_names</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">ndb_field_names</span><span class="p">)</span>
|
||||
<div class="viewcode-block" id="Component.add_field"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.add_field">[docs]</a> <span class="nd">@classmethod</span>
|
||||
<span class="k">def</span> <span class="nf">add_field</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">field</span><span class="p">):</span>
|
||||
<span class="bp">cls</span><span class="o">.</span><span class="n">_fields</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">field</span></div>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">db_field_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">db_fields</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"_db_fields"</span><span class="p">,</span> <span class="p">{})</span>
|
||||
<span class="k">return</span> <span class="n">db_fields</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
|
||||
<div class="viewcode-block" id="Component.get_fields"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.get_fields">[docs]</a> <span class="nd">@classmethod</span>
|
||||
<span class="k">def</span> <span class="nf">get_fields</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">_fields</span><span class="o">.</span><span class="n">values</span><span class="p">())</span></div>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">ndb_field_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">ndb_fields</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"_ndb_fields"</span><span class="p">,</span> <span class="p">{})</span>
|
||||
<span class="k">return</span> <span class="n">ndb_fields</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">tag_field_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">tag_fields</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"_tag_fields"</span><span class="p">,</span> <span class="p">{})</span>
|
||||
<span class="k">return</span> <span class="n">tag_fields</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ComponentRegisterError"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.ComponentRegisterError">[docs]</a><span class="k">class</span> <span class="nc">ComponentRegisterError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
|
||||
<span class="k">pass</span></div>
|
||||
<div class="viewcode-block" id="Component.get_component_slot"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.get_component_slot">[docs]</a> <span class="nd">@classmethod</span>
|
||||
<span class="k">def</span> <span class="nf">get_component_slot</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">slot</span> <span class="ow">or</span> <span class="bp">cls</span><span class="o">.</span><span class="n">name</span></div></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
|
|
@ -263,7 +283,6 @@
|
|||
<li class="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="../components.html" >evennia.contrib.base_systems.components</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components.component</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -32,8 +32,7 @@
|
|||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="../components.html" accesskey="U">evennia.contrib.base_systems.components</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" accesskey="U">evennia</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components.dbfield</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -94,8 +93,13 @@
|
|||
|
||||
<span class="sd">This file contains the Descriptors used to set Fields in Components</span>
|
||||
<span class="sd">"""</span>
|
||||
<span class="kn">import</span> <span class="nn">typing</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">evennia.typeclasses.attributes</span> <span class="kn">import</span> <span class="n">AttributeProperty</span><span class="p">,</span> <span class="n">NAttributeProperty</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">typing</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.components</span> <span class="kn">import</span> <span class="n">Component</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="DBField"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.DBField">[docs]</a><span class="k">class</span> <span class="nc">DBField</span><span class="p">(</span><span class="n">AttributeProperty</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
|
@ -104,21 +108,40 @@
|
|||
<span class="sd"> It uses AttributeProperty under the hood but prefixes the key with the component name.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__set_name__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">owner</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="DBField.__init__"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.DBField.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">autocreate</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="n">default</span><span class="p">,</span> <span class="n">autocreate</span><span class="o">=</span><span class="n">autocreate</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__set_name__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">owner</span><span class="p">:</span> <span class="s1">'Component'</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Called when descriptor is first assigned to the class.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> owner (object): The component classF on which this is set</span>
|
||||
<span class="sd"> owner (Component): The component classF on which this is set</span>
|
||||
<span class="sd"> name (str): The name that was used to set the DBField.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">owner</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">::</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">"</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_key</span> <span class="o">=</span> <span class="n">key</span>
|
||||
<span class="n">db_fields</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">owner</span><span class="p">,</span> <span class="s2">"_db_fields"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">db_fields</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="n">db_fields</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
<span class="nb">setattr</span><span class="p">(</span><span class="n">owner</span><span class="p">,</span> <span class="s2">"_db_fields"</span><span class="p">,</span> <span class="n">db_fields</span><span class="p">)</span>
|
||||
<span class="n">db_fields</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">owner</span><span class="o">.</span><span class="n">get_component_slot</span><span class="p">()</span><span class="si">}</span><span class="s2">::</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">"</span>
|
||||
<span class="n">owner</span><span class="o">.</span><span class="n">add_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="DBField.at_added"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.DBField.at_added">[docs]</a> <span class="k">def</span> <span class="nf">at_added</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Called when the parent component is added to a host.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> component (Component): The component instance being added.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_autocreate</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="fm">__get__</span><span class="p">(</span><span class="n">component</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">component</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="DBField.at_removed"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.DBField.at_removed">[docs]</a> <span class="k">def</span> <span class="nf">at_removed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Called when the parent component is removed from a host.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> component (Component): The component instance being removed.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="bp">self</span><span class="o">.</span><span class="fm">__delete__</span><span class="p">(</span><span class="n">component</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="NDBField"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.NDBField">[docs]</a><span class="k">class</span> <span class="nc">NDBField</span><span class="p">(</span><span class="n">NAttributeProperty</span><span class="p">):</span>
|
||||
|
|
@ -128,21 +151,35 @@
|
|||
<span class="sd"> It uses NAttributeProperty under the hood but prefixes the key with the component name.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__set_name__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">owner</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">__set_name__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">owner</span><span class="p">:</span> <span class="s1">'Component'</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Called when descriptor is first assigned to the class.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> owner (object): The component class on which this is set</span>
|
||||
<span class="sd"> owner (Component): The component class on which this is set</span>
|
||||
<span class="sd"> name (str): The name that was used to set the DBField.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">owner</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">::</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">"</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_key</span> <span class="o">=</span> <span class="n">key</span>
|
||||
<span class="n">ndb_fields</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">owner</span><span class="p">,</span> <span class="s2">"_ndb_fields"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">ndb_fields</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="n">ndb_fields</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
<span class="nb">setattr</span><span class="p">(</span><span class="n">owner</span><span class="p">,</span> <span class="s2">"_ndb_fields"</span><span class="p">,</span> <span class="n">ndb_fields</span><span class="p">)</span>
|
||||
<span class="n">ndb_fields</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">owner</span><span class="o">.</span><span class="n">get_component_slot</span><span class="p">()</span><span class="si">}</span><span class="s2">::</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">"</span>
|
||||
<span class="n">owner</span><span class="o">.</span><span class="n">add_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="NDBField.at_added"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.NDBField.at_added">[docs]</a> <span class="k">def</span> <span class="nf">at_added</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Called when the parent component is added to a host.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> component (Component): The component instance being added.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_autocreate</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="fm">__set__</span><span class="p">(</span><span class="n">component</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="NDBField.at_removed"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.NDBField.at_removed">[docs]</a> <span class="k">def</span> <span class="nf">at_removed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Called when the parent component is removed from a host.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> component (Component): The component instance being removed.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="fm">__delete__</span><span class="p">(</span><span class="n">component</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="TagField"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.TagField">[docs]</a><span class="k">class</span> <span class="nc">TagField</span><span class="p">:</span>
|
||||
|
|
@ -161,17 +198,13 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">_default</span> <span class="o">=</span> <span class="n">default</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_enforce_single</span> <span class="o">=</span> <span class="n">enforce_single</span></div>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__set_name__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">owner</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">__set_name__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">owner</span><span class="p">:</span> <span class="s1">'Component'</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Called when TagField is first assigned to the class.</span>
|
||||
<span class="sd"> It is called with the component class and the name of the field.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_category_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">owner</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">::</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">"</span>
|
||||
<span class="n">tag_fields</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">owner</span><span class="p">,</span> <span class="s2">"_tag_fields"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">tag_fields</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="n">tag_fields</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
<span class="nb">setattr</span><span class="p">(</span><span class="n">owner</span><span class="p">,</span> <span class="s2">"_tag_fields"</span><span class="p">,</span> <span class="n">tag_fields</span><span class="p">)</span>
|
||||
<span class="n">tag_fields</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_category_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">owner</span><span class="o">.</span><span class="n">get_component_slot</span><span class="p">()</span><span class="si">}</span><span class="s2">::</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">"</span>
|
||||
<span class="n">owner</span><span class="o">.</span><span class="n">add_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__get__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">owner</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
|
@ -204,7 +237,26 @@
|
|||
<span class="sd"> Used when 'del' is called on the TagField.</span>
|
||||
<span class="sd"> It is called with the component instance.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">instance</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">clear</span><span class="p">(</span><span class="n">category</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_category_key</span><span class="p">)</span></div>
|
||||
<span class="n">instance</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">clear</span><span class="p">(</span><span class="n">category</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_category_key</span><span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="TagField.at_added"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.TagField.at_added">[docs]</a> <span class="k">def</span> <span class="nf">at_added</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Called when the parent component is added to a host.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> component (Component): The component instance being added.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="fm">__set__</span><span class="p">(</span><span class="n">component</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TagField.at_removed"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.TagField.at_removed">[docs]</a> <span class="k">def</span> <span class="nf">at_removed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Called when the parent component is removed from a host.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> component (Component): The component instance being removed.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="fm">__delete__</span><span class="p">(</span><span class="n">component</span><span class="p">)</span></div></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
|
|
@ -224,7 +276,6 @@
|
|||
<li class="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="../components.html" >evennia.contrib.base_systems.components</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components.dbfield</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -32,8 +32,7 @@
|
|||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="../components.html" accesskey="U">evennia.contrib.base_systems.components</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" accesskey="U">evennia</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components.holder</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -96,7 +95,7 @@
|
|||
<span class="sd">"""</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">evennia.contrib.base_systems</span> <span class="kn">import</span> <span class="n">components</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.components</span> <span class="kn">import</span> <span class="n">signals</span>
|
||||
<span class="kn">from</span> <span class="nn">evennia.contrib.base_systems.components</span> <span class="kn">import</span> <span class="n">signals</span><span class="p">,</span> <span class="n">exceptions</span><span class="p">,</span> <span class="n">get_component_class</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ComponentProperty"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentProperty">[docs]</a><span class="k">class</span> <span class="nc">ComponentProperty</span><span class="p">:</span>
|
||||
|
|
@ -108,19 +107,26 @@
|
|||
<span class="sd"> Defaults can be overridden for this typeclass by passing kwargs</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<div class="viewcode-block" id="ComponentProperty.__init__"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentProperty.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component_name</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="ComponentProperty.__init__"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentProperty.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Initializes the descriptor</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> component_name (str): The name of the component</span>
|
||||
<span class="sd"> name (str): The name of the component</span>
|
||||
<span class="sd"> **kwargs (any): Key=Values overriding default values of the component</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">component_name</span> <span class="o">=</span> <span class="n">component_name</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">values</span> <span class="o">=</span> <span class="n">kwargs</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">values</span> <span class="o">=</span> <span class="n">kwargs</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">component_class</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">slot_name</span> <span class="o">=</span> <span class="kc">None</span></div>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__get__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">owner</span><span class="p">):</span>
|
||||
<span class="n">component</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">component_name</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">component_class</span><span class="p">:</span>
|
||||
<span class="n">component_class</span> <span class="o">=</span> <span class="n">get_component_class</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">component_class</span> <span class="o">=</span> <span class="n">component_class</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">slot_name</span> <span class="o">=</span> <span class="n">component_class</span><span class="o">.</span><span class="n">get_component_slot</span><span class="p">()</span>
|
||||
|
||||
<span class="n">component</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">slot_name</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">component</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__set__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||
|
|
@ -128,13 +134,11 @@
|
|||
|
||||
<span class="k">def</span> <span class="nf">__set_name__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">owner</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="c1"># Retrieve the class_components set on the direct class only</span>
|
||||
<span class="n">class_components</span> <span class="o">=</span> <span class="n">owner</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"_class_components"</span><span class="p">)</span>
|
||||
<span class="n">class_components</span> <span class="o">=</span> <span class="n">owner</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"_class_components"</span><span class="p">,</span> <span class="p">[])</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">class_components</span><span class="p">:</span>
|
||||
<span class="c1"># Create a new list, including inherited class components</span>
|
||||
<span class="n">class_components</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">owner</span><span class="p">,</span> <span class="s2">"_class_components"</span><span class="p">,</span> <span class="p">[]))</span>
|
||||
<span class="nb">setattr</span><span class="p">(</span><span class="n">owner</span><span class="p">,</span> <span class="s2">"_class_components"</span><span class="p">,</span> <span class="n">class_components</span><span class="p">)</span>
|
||||
|
||||
<span class="n">class_components</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">component_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="p">))</span></div>
|
||||
<span class="n">class_components</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">values</span><span class="p">))</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ComponentHandler"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler">[docs]</a><span class="k">class</span> <span class="nc">ComponentHandler</span><span class="p">:</span>
|
||||
|
|
@ -148,7 +152,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="n">host</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_loaded_components</span> <span class="o">=</span> <span class="p">{}</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ComponentHandler.add"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="ComponentHandler.add"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">:</span> <span class="n">components</span><span class="o">.</span><span class="n">Component</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Method to add a Component to a host.</span>
|
||||
<span class="sd"> It caches the loaded component and appends its name to the host's component name list.</span>
|
||||
|
|
@ -158,16 +162,19 @@
|
|||
<span class="sd"> component (object): The 'loaded' component instance to add.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">component_name</span> <span class="o">=</span> <span class="n">component</span><span class="o">.</span><span class="n">name</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">db_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">component_name</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">component_name</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_set_component</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">db_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">component</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_add_component_tags</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
|
||||
<span class="n">component</span><span class="o">.</span><span class="n">at_added</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_object_listeners_and_responders</span><span class="p">(</span><span class="n">component</span><span class="p">)</span></div>
|
||||
<span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">component</span><span class="o">.</span><span class="n">get_fields</span><span class="p">():</span>
|
||||
<span class="n">field</span><span class="o">.</span><span class="n">at_added</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
|
||||
|
||||
<span class="n">component</span><span class="o">.</span><span class="n">at_added</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ComponentHandler.add_default"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler.add_default">[docs]</a> <span class="k">def</span> <span class="nf">add_default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Method to add a Component initialized to default values on a host.</span>
|
||||
<span class="sd"> It will retrieve the proper component and instanciate it with 'default_create'.</span>
|
||||
<span class="sd"> It will retrieve the proper component and instantiate it with 'default_create'.</span>
|
||||
<span class="sd"> It will cache this new component and add it to its list.</span>
|
||||
<span class="sd"> It will also call the component's 'at_added' method, passing its host.</span>
|
||||
|
||||
|
|
@ -175,33 +182,11 @@
|
|||
<span class="sd"> name (str): The name of the component class to add.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">component</span> <span class="o">=</span> <span class="n">components</span><span class="o">.</span><span class="n">get_component_class</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">component</span><span class="p">:</span>
|
||||
<span class="k">raise</span> <span class="n">ComponentDoesNotExist</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Component </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> does not exist."</span><span class="p">)</span>
|
||||
<span class="n">component_class</span> <span class="o">=</span> <span class="n">components</span><span class="o">.</span><span class="n">get_component_class</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="n">component_instance</span> <span class="o">=</span> <span class="n">component_class</span><span class="o">.</span><span class="n">default_create</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">component_instance</span><span class="p">)</span></div>
|
||||
|
||||
<span class="n">new_component</span> <span class="o">=</span> <span class="n">component</span><span class="o">.</span><span class="n">default_create</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_set_component</span><span class="p">(</span><span class="n">new_component</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">db_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_add_component_tags</span><span class="p">(</span><span class="n">new_component</span><span class="p">)</span>
|
||||
<span class="n">new_component</span><span class="o">.</span><span class="n">at_added</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_object_listeners_and_responders</span><span class="p">(</span><span class="n">new_component</span><span class="p">)</span></div>
|
||||
|
||||
<span class="k">def</span> <span class="nf">_add_component_tags</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Private method that adds the Tags set on a Component via TagFields</span>
|
||||
<span class="sd"> It will also add the name of the component so objects can be filtered</span>
|
||||
<span class="sd"> by the components the implement.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> component (object): The component instance that is added.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">component</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="k">for</span> <span class="n">tag_field_name</span> <span class="ow">in</span> <span class="n">component</span><span class="o">.</span><span class="n">tag_field_names</span><span class="p">:</span>
|
||||
<span class="n">default_tag</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">component</span><span class="p">)</span><span class="o">.</span><span class="vm">__dict__</span><span class="p">[</span><span class="n">tag_field_name</span><span class="p">]</span><span class="o">.</span><span class="n">_default</span>
|
||||
<span class="k">if</span> <span class="n">default_tag</span><span class="p">:</span>
|
||||
<span class="nb">setattr</span><span class="p">(</span><span class="n">component</span><span class="p">,</span> <span class="n">tag_field_name</span><span class="p">,</span> <span class="n">default_tag</span><span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="ComponentHandler.remove"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler.remove">[docs]</a> <span class="k">def</span> <span class="nf">remove</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="ComponentHandler.remove"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler.remove">[docs]</a> <span class="k">def</span> <span class="nf">remove</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">:</span> <span class="n">components</span><span class="o">.</span><span class="n">Component</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Method to remove a component instance from a host.</span>
|
||||
<span class="sd"> It removes the component from the cache and listing.</span>
|
||||
|
|
@ -211,18 +196,24 @@
|
|||
<span class="sd"> component (object): The component instance to remove.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">component_name</span> <span class="o">=</span> <span class="n">component</span><span class="o">.</span><span class="n">name</span>
|
||||
<span class="k">if</span> <span class="n">component_name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_components</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_remove_component_tags</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
|
||||
<span class="n">component</span><span class="o">.</span><span class="n">at_removed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">db_names</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">component_name</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">remove_object_listeners_and_responders</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
|
||||
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_components</span><span class="p">[</span><span class="n">component_name</span><span class="p">]</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="n">component</span><span class="o">.</span><span class="n">name</span>
|
||||
<span class="n">slot_name</span> <span class="o">=</span> <span class="n">component</span><span class="o">.</span><span class="n">get_component_slot</span><span class="p">()</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">slot_name</span><span class="p">):</span>
|
||||
<span class="n">message</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="sa">f</span><span class="s2">"Cannot remove </span><span class="si">{</span><span class="n">component_name</span><span class="si">}</span><span class="s2"> from </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2"> as it is not registered."</span>
|
||||
<span class="sa">f</span><span class="s2">"Cannot remove </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> from </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2"> as it is not registered."</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">raise</span> <span class="n">ComponentIsNotRegistered</span><span class="p">(</span><span class="n">message</span><span class="p">)</span></div>
|
||||
<span class="k">raise</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">ComponentIsNotRegistered</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
|
||||
|
||||
<span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">component</span><span class="o">.</span><span class="n">get_fields</span><span class="p">():</span>
|
||||
<span class="n">field</span><span class="o">.</span><span class="n">at_removed</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
|
||||
|
||||
<span class="n">component</span><span class="o">.</span><span class="n">at_removed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||||
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">component</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">remove_object_listeners_and_responders</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
|
||||
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">db_names</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_components</span><span class="p">[</span><span class="n">slot_name</span><span class="p">]</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ComponentHandler.remove_by_name"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler.remove_by_name">[docs]</a> <span class="k">def</span> <span class="nf">remove_by_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
|
@ -231,49 +222,25 @@
|
|||
<span class="sd"> It will call the component's 'at_removed' method.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> name (str): The name of the component to remove.</span>
|
||||
<span class="sd"> name (str): The name of the component to remove or its slot.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">instance</span><span class="p">:</span>
|
||||
<span class="n">message</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Cannot remove </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> from </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2"> as it is not registered."</span>
|
||||
<span class="k">raise</span> <span class="n">ComponentIsNotRegistered</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
|
||||
<span class="k">raise</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">ComponentIsNotRegistered</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
|
||||
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_remove_component_tags</span><span class="p">(</span><span class="n">instance</span><span class="p">)</span>
|
||||
<span class="n">instance</span><span class="o">.</span><span class="n">at_removed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">remove_object_listeners_and_responders</span><span class="p">(</span><span class="n">instance</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">db_names</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">instance</span><span class="p">)</span></div>
|
||||
|
||||
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_components</span><span class="p">[</span><span class="n">name</span><span class="p">]</span></div>
|
||||
|
||||
<span class="k">def</span> <span class="nf">_remove_component_tags</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Private method that will remove the Tags set on a Component via TagFields</span>
|
||||
<span class="sd"> It will also remove the component name tag.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> component (object): The component instance that is removed.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">component</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="k">for</span> <span class="n">tag_field_name</span> <span class="ow">in</span> <span class="n">component</span><span class="o">.</span><span class="n">tag_field_names</span><span class="p">:</span>
|
||||
<span class="nb">delattr</span><span class="p">(</span><span class="n">component</span><span class="p">,</span> <span class="n">tag_field_name</span><span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="ComponentHandler.get"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Method to retrieve a cached Component instance by its name.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> name (str): The name of the component to retrieve.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<div class="viewcode-block" id="ComponentHandler.get"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">components</span><span class="o">.</span><span class="n">Component</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ComponentHandler.has"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler.has">[docs]</a> <span class="k">def</span> <span class="nf">has</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="ComponentHandler.has"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler.has">[docs]</a> <span class="k">def</span> <span class="nf">has</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Method to check if a component is registered and ready.</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> name (str): The name of the component.</span>
|
||||
<span class="sd"> name (str): The name of the component or the slot.</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loaded_components</span></div>
|
||||
|
|
@ -294,26 +261,35 @@
|
|||
<span class="k">if</span> <span class="n">component</span><span class="p">:</span>
|
||||
<span class="n">component_instance</span> <span class="o">=</span> <span class="n">component</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_set_component</span><span class="p">(</span><span class="n">component_instance</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_object_listeners_and_responders</span><span class="p">(</span><span class="n">component_instance</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">message</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<span class="sa">f</span><span class="s2">"Could not initialize runtime component </span><span class="si">{</span><span class="n">component_name</span><span class="si">}</span><span class="s2"> of </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">"</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">raise</span> <span class="n">ComponentDoesNotExist</span><span class="p">(</span><span class="n">message</span><span class="p">)</span></div>
|
||||
<span class="k">raise</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">ComponentDoesNotExist</span><span class="p">(</span><span class="n">message</span><span class="p">)</span></div>
|
||||
|
||||
<span class="k">def</span> <span class="nf">_set_component</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">component</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_loaded_components</span><span class="p">[</span><span class="n">component</span><span class="o">.</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">component</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Sets the loaded component in this instance.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">slot_name</span> <span class="o">=</span> <span class="n">component</span><span class="o">.</span><span class="n">get_component_slot</span><span class="p">()</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_loaded_components</span><span class="p">[</span><span class="n">slot_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">component</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_object_listeners_and_responders</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">db_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Property shortcut to retrieve the registered component names</span>
|
||||
<span class="sd"> Property shortcut to retrieve the registered component keys</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> component_names (iterable): The name of each component that is registered</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">attributes</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"component_names"</span><span class="p">)</span>
|
||||
<span class="n">names</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">attributes</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"component_names"</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">names</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">component_names</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
<span class="n">names</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">component_names</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">names</span>
|
||||
|
||||
<span class="k">def</span> <span class="fm">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></div>
|
||||
|
|
@ -327,7 +303,6 @@
|
|||
<span class="sd"> All registered components are initialized on the typeclass.</span>
|
||||
<span class="sd"> They will be of None value if not present in the class components or runtime components.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<div class="viewcode-block" id="ComponentHolderMixin.at_init"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHolderMixin.at_init">[docs]</a> <span class="k">def</span> <span class="nf">at_init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Method that initializes the ComponentHandler.</span>
|
||||
|
|
@ -352,28 +327,16 @@
|
|||
<span class="sd"> components that were set on the typeclass using ComponentProperty.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">basetype_setup</span><span class="p">()</span>
|
||||
<span class="n">component_names</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"_component_handler"</span><span class="p">,</span> <span class="n">ComponentHandler</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
|
||||
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"_signal_handler"</span><span class="p">,</span> <span class="n">signals</span><span class="o">.</span><span class="n">SignalsHandler</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
|
||||
<span class="n">class_components</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"_class_components"</span><span class="p">,</span> <span class="p">())</span>
|
||||
<span class="n">class_components</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_class_components</span><span class="p">()</span>
|
||||
<span class="k">for</span> <span class="n">component_name</span><span class="p">,</span> <span class="n">values</span> <span class="ow">in</span> <span class="n">class_components</span><span class="p">:</span>
|
||||
<span class="n">component_class</span> <span class="o">=</span> <span class="n">components</span><span class="o">.</span><span class="n">get_component_class</span><span class="p">(</span><span class="n">component_name</span><span class="p">)</span>
|
||||
<span class="n">component</span> <span class="o">=</span> <span class="n">component_class</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">values</span><span class="p">)</span>
|
||||
<span class="n">component_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">component_name</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">_loaded_components</span><span class="p">[</span><span class="n">component_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">component</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_object_listeners_and_responders</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
|
||||
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">component_names</span> <span class="o">=</span> <span class="n">component_names</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">trigger</span><span class="p">(</span><span class="s2">"at_basetype_setup"</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ComponentHolderMixin.basetype_posthook_setup"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHolderMixin.basetype_posthook_setup">[docs]</a> <span class="k">def</span> <span class="nf">basetype_posthook_setup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Method that add component related tags that were set using ComponentProperty.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">basetype_posthook_setup</span><span class="p">()</span>
|
||||
<span class="k">for</span> <span class="n">component</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">_loaded_components</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">_add_component_tags</span><span class="p">(</span><span class="n">component</span><span class="p">)</span></div>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">components</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">ComponentHandler</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
|
|
@ -394,15 +357,32 @@
|
|||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">signals</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">signals</span><span class="o">.</span><span class="n">SignalsHandler</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"_signal_handler"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
|
||||
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"_signal_handler"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">_get_class_components</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">class_components</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
|
||||
<div class="viewcode-block" id="ComponentDoesNotExist"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentDoesNotExist">[docs]</a><span class="k">class</span> <span class="nc">ComponentDoesNotExist</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
|
||||
<span class="k">pass</span></div>
|
||||
<span class="k">def</span> <span class="nf">base_type_iterator</span><span class="p">():</span>
|
||||
<span class="n">base_stack</span> <span class="o">=</span> <span class="p">[</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)]</span>
|
||||
<span class="k">while</span> <span class="n">base_stack</span><span class="p">:</span>
|
||||
<span class="n">_base_type</span> <span class="o">=</span> <span class="n">base_stack</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
|
||||
<span class="k">yield</span> <span class="n">_base_type</span>
|
||||
<span class="n">base_stack</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">_base_type</span><span class="o">.</span><span class="vm">__bases__</span><span class="p">)</span>
|
||||
|
||||
<span class="k">for</span> <span class="n">base_type</span> <span class="ow">in</span> <span class="n">base_type_iterator</span><span class="p">():</span>
|
||||
<span class="n">base_class_components</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">base_type</span><span class="p">,</span> <span class="s2">"_class_components"</span><span class="p">,</span> <span class="p">())</span>
|
||||
<span class="k">for</span> <span class="n">cmp_name</span><span class="p">,</span> <span class="n">cmp_values</span> <span class="ow">in</span> <span class="n">base_class_components</span><span class="p">:</span>
|
||||
<span class="n">cmp_class</span> <span class="o">=</span> <span class="n">get_component_class</span><span class="p">(</span><span class="n">cmp_name</span><span class="p">)</span>
|
||||
<span class="n">cmp_slot</span> <span class="o">=</span> <span class="n">cmp_class</span><span class="o">.</span><span class="n">get_component_slot</span><span class="p">()</span>
|
||||
<span class="n">class_components</span><span class="p">[</span><span class="n">cmp_slot</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">cmp_name</span><span class="p">,</span> <span class="n">cmp_values</span><span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="ComponentIsNotRegistered"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentIsNotRegistered">[docs]</a><span class="k">class</span> <span class="nc">ComponentIsNotRegistered</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
|
||||
<span class="k">pass</span></div>
|
||||
<span class="n">instance_components</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"_class_components"</span><span class="p">,</span> <span class="p">())</span>
|
||||
<span class="k">for</span> <span class="n">cmp_name</span><span class="p">,</span> <span class="n">cmp_values</span> <span class="ow">in</span> <span class="n">instance_components</span><span class="p">:</span>
|
||||
<span class="n">cmp_class</span> <span class="o">=</span> <span class="n">get_component_class</span><span class="p">(</span><span class="n">cmp_name</span><span class="p">)</span>
|
||||
<span class="n">cmp_slot</span> <span class="o">=</span> <span class="n">cmp_class</span><span class="o">.</span><span class="n">get_component_slot</span><span class="p">()</span>
|
||||
<span class="n">class_components</span><span class="p">[</span><span class="n">cmp_slot</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">cmp_name</span><span class="p">,</span> <span class="n">cmp_values</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">class_components</span><span class="o">.</span><span class="n">values</span><span class="p">())</span></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
|
|
@ -422,7 +402,6 @@
|
|||
<li class="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="../components.html" >evennia.contrib.base_systems.components</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components.holder</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -32,8 +32,7 @@
|
|||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="../components.html" accesskey="U">evennia.contrib.base_systems.components</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" accesskey="U">evennia</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components.signals</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -270,8 +269,15 @@
|
|||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> obj (object): The instance of an object to connect to this handler.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">type_host</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
|
||||
<span class="k">for</span> <span class="n">att_name</span><span class="p">,</span> <span class="n">att_obj</span> <span class="ow">in</span> <span class="n">type_host</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
||||
<span class="n">obj_type</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
|
||||
<span class="k">for</span> <span class="n">att_name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">obj_type</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="n">att_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"__"</span><span class="p">):</span>
|
||||
<span class="k">continue</span>
|
||||
|
||||
<span class="n">att_obj</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj_type</span><span class="p">,</span> <span class="n">att_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">att_obj</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">continue</span>
|
||||
|
||||
<span class="n">listener_signal_name</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">att_obj</span><span class="p">,</span> <span class="s2">"_listener_signal_name"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">listener_signal_name</span><span class="p">:</span>
|
||||
<span class="n">callback</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">att_name</span><span class="p">)</span>
|
||||
|
|
@ -289,8 +295,14 @@
|
|||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> obj (object): The instance of an object to disconnect from this handler.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">type_host</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
|
||||
<span class="k">for</span> <span class="n">att_name</span><span class="p">,</span> <span class="n">att_obj</span> <span class="ow">in</span> <span class="n">type_host</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
||||
<span class="k">for</span> <span class="n">att_name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="n">att_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"__"</span><span class="p">):</span>
|
||||
<span class="k">continue</span>
|
||||
|
||||
<span class="n">att_obj</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">att_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">att_obj</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">continue</span>
|
||||
|
||||
<span class="n">listener_signal_name</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">att_obj</span><span class="p">,</span> <span class="s2">"_listener_signal_name"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">listener_signal_name</span><span class="p">:</span>
|
||||
<span class="n">callback</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">att_name</span><span class="p">)</span>
|
||||
|
|
@ -319,7 +331,6 @@
|
|||
<li class="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="../components.html" >evennia.contrib.base_systems.components</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components.signals</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -32,8 +32,7 @@
|
|||
>modules</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="../components.html" accesskey="U">evennia.contrib.base_systems.components</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" accesskey="U">evennia</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -108,13 +107,32 @@
|
|||
<div class="viewcode-block" id="ComponentTestA"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestA">[docs]</a><span class="k">class</span> <span class="nc">ComponentTestA</span><span class="p">(</span><span class="n">Component</span><span class="p">):</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s2">"test_a"</span>
|
||||
<span class="n">my_int</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
|
||||
<span class="n">my_list</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="p">[])</span></div>
|
||||
<span class="n">my_list</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="p">[],</span> <span class="n">autocreate</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ShadowedComponentTestA"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ShadowedComponentTestA">[docs]</a><span class="k">class</span> <span class="nc">ShadowedComponentTestA</span><span class="p">(</span><span class="n">ComponentTestA</span><span class="p">):</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s2">"shadowed_test_a"</span>
|
||||
<span class="n">slot</span> <span class="o">=</span> <span class="s1">'ic_a'</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="InheritedComponentTestA"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.InheritedComponentTestA">[docs]</a><span class="k">class</span> <span class="nc">InheritedComponentTestA</span><span class="p">(</span><span class="n">ComponentTestA</span><span class="p">):</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s2">"inherited_test_a"</span>
|
||||
<span class="n">slot</span> <span class="o">=</span> <span class="s1">'ic_a'</span>
|
||||
|
||||
<span class="n">my_other_int</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ReplacementComponentTestA"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA">[docs]</a><span class="k">class</span> <span class="nc">ReplacementComponentTestA</span><span class="p">(</span><span class="n">InheritedComponentTestA</span><span class="p">):</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s2">"replacement_inherited_test_a"</span>
|
||||
<span class="n">slot</span> <span class="o">=</span> <span class="s2">"ic_a"</span>
|
||||
|
||||
<span class="n">replacement_field</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ComponentTestB"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestB">[docs]</a><span class="k">class</span> <span class="nc">ComponentTestB</span><span class="p">(</span><span class="n">Component</span><span class="p">):</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s2">"test_b"</span>
|
||||
<span class="n">my_int</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
|
||||
<span class="n">my_list</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="p">[])</span>
|
||||
<span class="n">my_list</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="p">[],</span> <span class="n">autocreate</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="n">default_tag</span> <span class="o">=</span> <span class="n">TagField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"initial_value"</span><span class="p">)</span>
|
||||
<span class="n">single_tag</span> <span class="o">=</span> <span class="n">TagField</span><span class="p">(</span><span class="n">enforce_single</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="n">multiple_tags</span> <span class="o">=</span> <span class="n">TagField</span><span class="p">()</span>
|
||||
|
|
@ -124,13 +142,31 @@
|
|||
<div class="viewcode-block" id="RuntimeComponentTestC"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.RuntimeComponentTestC">[docs]</a><span class="k">class</span> <span class="nc">RuntimeComponentTestC</span><span class="p">(</span><span class="n">Component</span><span class="p">):</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s2">"test_c"</span>
|
||||
<span class="n">my_int</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>
|
||||
<span class="n">my_dict</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="p">{})</span>
|
||||
<span class="n">my_dict</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="p">{},</span> <span class="n">autocreate</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="n">added_tag</span> <span class="o">=</span> <span class="n">TagField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"added_value"</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="CharacterWithComponents"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.CharacterWithComponents">[docs]</a><span class="k">class</span> <span class="nc">CharacterWithComponents</span><span class="p">(</span><span class="n">ComponentHolderMixin</span><span class="p">,</span> <span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="ComponentTestD"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestD">[docs]</a><span class="k">class</span> <span class="nc">ComponentTestD</span><span class="p">(</span><span class="n">Component</span><span class="p">):</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="s2">"test_d"</span>
|
||||
|
||||
<span class="n">mixed_in</span> <span class="o">=</span> <span class="n">DBField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="mi">8</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ShadowedCharacterMixin"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin">[docs]</a><span class="k">class</span> <span class="nc">ShadowedCharacterMixin</span><span class="p">:</span>
|
||||
<span class="n">ic_a</span> <span class="o">=</span> <span class="n">ComponentProperty</span><span class="p">(</span><span class="s2">"shadowed_test_a"</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="CharacterMixinWithComponents"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents">[docs]</a><span class="k">class</span> <span class="nc">CharacterMixinWithComponents</span><span class="p">:</span>
|
||||
<span class="n">ic_a</span> <span class="o">=</span> <span class="n">ComponentProperty</span><span class="p">(</span><span class="s2">"inherited_test_a"</span><span class="p">,</span> <span class="n">my_other_int</span><span class="o">=</span><span class="mi">33</span><span class="p">)</span>
|
||||
<span class="n">test_d</span> <span class="o">=</span> <span class="n">ComponentProperty</span><span class="p">(</span><span class="s1">'test_d'</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="CharacterWithComponents"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.CharacterWithComponents">[docs]</a><span class="k">class</span> <span class="nc">CharacterWithComponents</span><span class="p">(</span>
|
||||
<span class="n">ComponentHolderMixin</span><span class="p">,</span> <span class="n">ShadowedCharacterMixin</span><span class="p">,</span> <span class="n">CharacterMixinWithComponents</span><span class="p">,</span> <span class="n">DefaultCharacter</span>
|
||||
<span class="p">):</span>
|
||||
<span class="n">test_a</span> <span class="o">=</span> <span class="n">ComponentProperty</span><span class="p">(</span><span class="s2">"test_a"</span><span class="p">)</span>
|
||||
<span class="n">test_b</span> <span class="o">=</span> <span class="n">ComponentProperty</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">,</span> <span class="n">my_int</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">my_list</span><span class="o">=</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span></div>
|
||||
<span class="n">test_b</span> <span class="o">=</span> <span class="n">ComponentProperty</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">,</span> <span class="n">my_int</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">my_list</span><span class="o">=</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span>
|
||||
<span class="n">ic_a</span> <span class="o">=</span> <span class="n">ComponentProperty</span><span class="p">(</span><span class="s2">"inherited_test_a"</span><span class="p">,</span> <span class="n">my_other_int</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="InheritedTCWithComponents"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.InheritedTCWithComponents">[docs]</a><span class="k">class</span> <span class="nc">InheritedTCWithComponents</span><span class="p">(</span><span class="n">CharacterWithComponents</span><span class="p">):</span>
|
||||
|
|
@ -141,53 +177,69 @@
|
|||
<span class="n">character_typeclass</span> <span class="o">=</span> <span class="n">CharacterWithComponents</span>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_character_has_class_components"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_character_has_class_components">[docs]</a> <span class="k">def</span> <span class="nf">test_character_has_class_components</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_b</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_b</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_inherited_typeclass_does_not_include_child_class_components"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_inherited_typeclass_does_not_include_child_class_components">[docs]</a> <span class="k">def</span> <span class="nf">test_inherited_typeclass_does_not_include_child_class_components</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">char_with_c</span> <span class="o">=</span> <span class="n">create</span><span class="o">.</span><span class="n">create_object</span><span class="p">(</span>
|
||||
<span class="n">InheritedTCWithComponents</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="s2">"char_with_c"</span><span class="p">,</span> <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">room1</span><span class="p">,</span> <span class="n">home</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">room1</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">cmp</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="n">char_with_c</span><span class="o">.</span><span class="n">test_c</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">cmp</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">char_with_c</span><span class="o">.</span><span class="n">test_c</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_character_instances_components_properly"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_character_instances_components_properly">[docs]</a> <span class="k">def</span> <span class="nf">test_character_instances_components_properly</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span><span class="p">,</span> <span class="n">ComponentTestA</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_b</span><span class="p">,</span> <span class="n">ComponentTestB</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIsInstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span><span class="p">,</span> <span class="n">ComponentTestA</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIsInstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_b</span><span class="p">,</span> <span class="n">ComponentTestB</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_character_assigns_default_value"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_character_assigns_default_value">[docs]</a> <span class="k">def</span> <span class="nf">test_character_assigns_default_value</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span><span class="o">.</span><span class="n">my_int</span> <span class="o">==</span> <span class="mi">1</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span><span class="o">.</span><span class="n">my_list</span> <span class="o">==</span> <span class="p">[]</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span><span class="o">.</span><span class="n">my_int</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span><span class="o">.</span><span class="n">my_list</span><span class="p">,</span> <span class="p">[])</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_character_assigns_default_provided_values"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_character_assigns_default_provided_values">[docs]</a> <span class="k">def</span> <span class="nf">test_character_assigns_default_provided_values</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_b</span><span class="o">.</span><span class="n">my_int</span> <span class="o">==</span> <span class="mi">3</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_b</span><span class="o">.</span><span class="n">my_list</span> <span class="o">==</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_b</span><span class="o">.</span><span class="n">my_int</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_b</span><span class="o">.</span><span class="n">my_list</span><span class="p">,</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_character_has_autocreated_values"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_character_has_autocreated_values">[docs]</a> <span class="k">def</span> <span class="nf">test_character_has_autocreated_values</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">att_name</span> <span class="o">=</span> <span class="s2">"test_b::my_list"</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">attributes</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">att_name</span><span class="p">),</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_component_inheritance_properly_overrides_slots"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_component_inheritance_properly_overrides_slots">[docs]</a> <span class="k">def</span> <span class="nf">test_component_inheritance_properly_overrides_slots</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">ic_a</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"inherited_test_a"</span><span class="p">)</span>
|
||||
<span class="n">component_names</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">c</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">_get_class_components</span><span class="p">())</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertNotIn</span><span class="p">(</span><span class="s2">"shadowed_test_a"</span><span class="p">,</span> <span class="n">component_names</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_component_inheritance_assigns_proper_values"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_component_inheritance_assigns_proper_values">[docs]</a> <span class="k">def</span> <span class="nf">test_component_inheritance_assigns_proper_values</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">ic_a</span><span class="o">.</span><span class="n">my_int</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">ic_a</span><span class="o">.</span><span class="n">my_other_int</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_host_mixins_assigns_components"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_host_mixins_assigns_components">[docs]</a> <span class="k">def</span> <span class="nf">test_host_mixins_assigns_components</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_d</span><span class="o">.</span><span class="n">mixed_in</span><span class="p">,</span> <span class="mi">8</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_character_can_register_runtime_component"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_character_can_register_runtime_component">[docs]</a> <span class="k">def</span> <span class="nf">test_character_can_register_runtime_component</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">rct</span> <span class="o">=</span> <span class="n">RuntimeComponentTestC</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rct</span><span class="p">)</span>
|
||||
<span class="n">test_c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="n">test_c</span>
|
||||
<span class="k">assert</span> <span class="n">test_c</span><span class="o">.</span><span class="n">my_int</span> <span class="o">==</span> <span class="mi">6</span>
|
||||
<span class="k">assert</span> <span class="n">test_c</span><span class="o">.</span><span class="n">my_dict</span> <span class="o">==</span> <span class="p">{}</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">test_c</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="n">test_c</span><span class="o">.</span><span class="n">my_int</span><span class="p">,</span> <span class="mi">6</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="n">test_c</span><span class="o">.</span><span class="n">my_dict</span><span class="p">,</span> <span class="p">{})</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_handler_can_add_default_component"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_handler_can_add_default_component">[docs]</a> <span class="k">def</span> <span class="nf">test_handler_can_add_default_component</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">add_default</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span>
|
||||
<span class="n">test_c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="n">test_c</span>
|
||||
<span class="k">assert</span> <span class="n">test_c</span><span class="o">.</span><span class="n">my_int</span> <span class="o">==</span> <span class="mi">6</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">test_c</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="n">test_c</span><span class="o">.</span><span class="n">my_int</span><span class="p">,</span> <span class="mi">6</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_handler_has_returns_true_for_any_components"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_handler_has_returns_true_for_any_components">[docs]</a> <span class="k">def</span> <span class="nf">test_handler_has_returns_true_for_any_components</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">rct</span> <span class="o">=</span> <span class="n">RuntimeComponentTestC</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="p">)</span>
|
||||
<span class="n">handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span>
|
||||
<span class="n">handler</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rct</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_a"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_a"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_can_remove_component"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_can_remove_component">[docs]</a> <span class="k">def</span> <span class="nf">test_can_remove_component</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">rct</span> <span class="o">=</span> <span class="n">RuntimeComponentTestC</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="p">)</span>
|
||||
|
|
@ -195,9 +247,9 @@
|
|||
<span class="n">handler</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rct</span><span class="p">)</span>
|
||||
<span class="n">handler</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">rct</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_a"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_a"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_can_remove_component_by_name"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_can_remove_component_by_name">[docs]</a> <span class="k">def</span> <span class="nf">test_can_remove_component_by_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">rct</span> <span class="o">=</span> <span class="n">RuntimeComponentTestC</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="p">)</span>
|
||||
|
|
@ -205,9 +257,9 @@
|
|||
<span class="n">handler</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rct</span><span class="p">)</span>
|
||||
<span class="n">handler</span><span class="o">.</span><span class="n">remove_by_name</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_a"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_a"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_cannot_replace_component"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_cannot_replace_component">[docs]</a> <span class="k">def</span> <span class="nf">test_cannot_replace_component</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">assertRaises</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
|
||||
|
|
@ -218,76 +270,76 @@
|
|||
<span class="n">handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span>
|
||||
<span class="n">handler</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rct</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="n">handler</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span> <span class="ow">is</span> <span class="n">rct</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIs</span><span class="p">(</span><span class="n">handler</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">),</span> <span class="n">rct</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_can_access_component_regular_get"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_can_access_component_regular_get">[docs]</a> <span class="k">def</span> <span class="nf">test_can_access_component_regular_get</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">cmp</span><span class="o">.</span><span class="n">test_a</span> <span class="ow">is</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_a"</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIs</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">cmp</span><span class="o">.</span><span class="n">test_a</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_a"</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_returns_none_with_regular_get_when_no_attribute"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_returns_none_with_regular_get_when_no_attribute">[docs]</a> <span class="k">def</span> <span class="nf">test_returns_none_with_regular_get_when_no_attribute</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">cmp</span><span class="o">.</span><span class="n">does_not_exist</span> <span class="ow">is</span> <span class="kc">None</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIs</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">cmp</span><span class="o">.</span><span class="n">does_not_exist</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_host_has_class_component_tags"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_host_has_class_component_tags">[docs]</a> <span class="k">def</span> <span class="nf">test_host_has_class_component_tags</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_a"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_b"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"initial_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::default_tag"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_b</span><span class="o">.</span><span class="n">default_tag</span> <span class="o">==</span> <span class="s2">"initial_value"</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">category</span><span class="o">=</span><span class="s2">"test_b::single_tag"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">category</span><span class="o">=</span><span class="s2">"test_b::multiple_tags"</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_a"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_b"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"initial_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::default_tag"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_b</span><span class="o">.</span><span class="n">default_tag</span> <span class="o">==</span> <span class="s2">"initial_value"</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">category</span><span class="o">=</span><span class="s2">"test_b::single_tag"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">category</span><span class="o">=</span><span class="s2">"test_b::multiple_tags"</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_host_has_added_component_tags"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_host_has_added_component_tags">[docs]</a> <span class="k">def</span> <span class="nf">test_host_has_added_component_tags</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">rct</span> <span class="o">=</span> <span class="n">RuntimeComponentTestC</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rct</span><span class="p">)</span>
|
||||
<span class="n">test_c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"added_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_c::added_tag"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="n">test_c</span><span class="o">.</span><span class="n">added_tag</span> <span class="o">==</span> <span class="s2">"added_value"</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"added_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_c::added_tag"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="n">test_c</span><span class="o">.</span><span class="n">added_tag</span><span class="p">,</span> <span class="s2">"added_value"</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_host_has_added_default_component_tags"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_host_has_added_default_component_tags">[docs]</a> <span class="k">def</span> <span class="nf">test_host_has_added_default_component_tags</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">add_default</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span>
|
||||
<span class="n">test_c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"added_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_c::added_tag"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="n">test_c</span><span class="o">.</span><span class="n">added_tag</span> <span class="o">==</span> <span class="s2">"added_value"</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"added_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_c::added_tag"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="n">test_c</span><span class="o">.</span><span class="n">added_tag</span><span class="p">,</span> <span class="s2">"added_value"</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_host_remove_component_tags"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_host_remove_component_tags">[docs]</a> <span class="k">def</span> <span class="nf">test_host_remove_component_tags</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">rct</span> <span class="o">=</span> <span class="n">RuntimeComponentTestC</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="p">)</span>
|
||||
<span class="n">handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span>
|
||||
<span class="n">handler</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rct</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">))</span>
|
||||
<span class="n">handler</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">rct</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"added_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_c::added_tag"</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"added_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_c::added_tag"</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_host_remove_by_name_component_tags"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_host_remove_by_name_component_tags">[docs]</a> <span class="k">def</span> <span class="nf">test_host_remove_by_name_component_tags</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">rct</span> <span class="o">=</span> <span class="n">RuntimeComponentTestC</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="p">)</span>
|
||||
<span class="n">handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span>
|
||||
<span class="n">handler</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rct</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">))</span>
|
||||
<span class="n">handler</span><span class="o">.</span><span class="n">remove_by_name</span><span class="p">(</span><span class="s2">"test_c"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"added_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_c::added_tag"</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"test_c"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"components"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"added_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_c::added_tag"</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_component_tags_only_hold_one_value_when_enforce_single"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_component_tags_only_hold_one_value_when_enforce_single">[docs]</a> <span class="k">def</span> <span class="nf">test_component_tags_only_hold_one_value_when_enforce_single</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">test_b</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">)</span>
|
||||
<span class="n">test_b</span><span class="o">.</span><span class="n">single_tag</span> <span class="o">=</span> <span class="s2">"first_value"</span>
|
||||
<span class="n">test_b</span><span class="o">.</span><span class="n">single_tag</span> <span class="o">=</span> <span class="s2">"second value"</span>
|
||||
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"second value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::single_tag"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="n">test_b</span><span class="o">.</span><span class="n">single_tag</span> <span class="o">==</span> <span class="s2">"second value"</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"first_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::single_tag"</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"second value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::single_tag"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="n">test_b</span><span class="o">.</span><span class="n">single_tag</span><span class="p">,</span> <span class="s2">"second value"</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"first_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::single_tag"</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_component_tags_default_value_is_overridden_when_enforce_single"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_component_tags_default_value_is_overridden_when_enforce_single">[docs]</a> <span class="k">def</span> <span class="nf">test_component_tags_default_value_is_overridden_when_enforce_single</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">test_b</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">)</span>
|
||||
<span class="n">test_b</span><span class="o">.</span><span class="n">default_single_tag</span> <span class="o">=</span> <span class="s2">"second value"</span>
|
||||
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"second value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::default_single_tag"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="n">test_b</span><span class="o">.</span><span class="n">default_single_tag</span> <span class="o">==</span> <span class="s2">"second value"</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"first_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::default_single_tag"</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"second value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::default_single_tag"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">test_b</span><span class="o">.</span><span class="n">default_single_tag</span> <span class="o">==</span> <span class="s2">"second value"</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"first_value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::default_single_tag"</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_component_tags_support_multiple_values_by_default"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_component_tags_support_multiple_values_by_default">[docs]</a> <span class="k">def</span> <span class="nf">test_component_tags_support_multiple_values_by_default</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">test_b</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"test_b"</span><span class="p">)</span>
|
||||
|
|
@ -295,12 +347,20 @@
|
|||
<span class="n">test_b</span><span class="o">.</span><span class="n">multiple_tags</span> <span class="o">=</span> <span class="s2">"second value"</span>
|
||||
<span class="n">test_b</span><span class="o">.</span><span class="n">multiple_tags</span> <span class="o">=</span> <span class="s2">"third value"</span>
|
||||
|
||||
<span class="k">assert</span> <span class="nb">all</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="nb">all</span><span class="p">(</span>
|
||||
<span class="n">val</span> <span class="ow">in</span> <span class="n">test_b</span><span class="o">.</span><span class="n">multiple_tags</span> <span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"first value"</span><span class="p">,</span> <span class="s2">"second value"</span><span class="p">,</span> <span class="s2">"third value"</span><span class="p">)</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"first value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::multiple_tags"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"second value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::multiple_tags"</span><span class="p">)</span>
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"third value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::multiple_tags"</span><span class="p">)</span></div></div>
|
||||
<span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"first value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::multiple_tags"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"second value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::multiple_tags"</span><span class="p">))</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">has</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">"third value"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="s2">"test_b::multiple_tags"</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_mutables_are_not_shared_when_autocreate"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_mutables_are_not_shared_when_autocreate">[docs]</a> <span class="k">def</span> <span class="nf">test_mutables_are_not_shared_when_autocreate</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span><span class="o">.</span><span class="n">my_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertNotEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">test_a</span><span class="o">.</span><span class="n">my_list</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">char2</span><span class="o">.</span><span class="n">test_a</span><span class="o">.</span><span class="n">my_list</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponents.test_replacing_class_component_slot_with_runtime_component"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_replacing_class_component_slot_with_runtime_component">[docs]</a> <span class="k">def</span> <span class="nf">test_replacing_class_component_slot_with_runtime_component</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">add_default</span><span class="p">(</span><span class="s2">"replacement_inherited_test_a"</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">ic_a</span><span class="o">.</span><span class="n">replacement_field</span><span class="p">,</span> <span class="mi">6</span><span class="p">)</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="CharWithSignal"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.CharWithSignal">[docs]</a><span class="k">class</span> <span class="nc">CharWithSignal</span><span class="p">(</span><span class="n">ComponentHolderMixin</span><span class="p">,</span> <span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
|
|
@ -356,14 +416,14 @@
|
|||
<div class="viewcode-block" id="TestComponentSignals.test_host_can_register_as_listener"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_host_can_register_as_listener">[docs]</a> <span class="k">def</span> <span class="nf">test_host_can_register_as_listener</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">trigger</span><span class="p">(</span><span class="s2">"my_signal"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">my_signal_is_called</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="p">,</span> <span class="s2">"my_other_signal_is_called"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">my_signal_is_called</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="p">,</span> <span class="s2">"my_other_signal_is_called"</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_host_can_register_as_responder"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_host_can_register_as_responder">[docs]</a> <span class="k">def</span> <span class="nf">test_host_can_register_as_responder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">responses</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"my_response"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="mi">1</span> <span class="ow">in</span> <span class="n">responses</span>
|
||||
<span class="k">assert</span> <span class="mi">2</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">responses</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIn</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">responses</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertNotIn</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="n">responses</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_component_can_register_as_listener"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_component_can_register_as_listener">[docs]</a> <span class="k">def</span> <span class="nf">test_component_can_register_as_listener</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">char</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span>
|
||||
|
|
@ -371,16 +431,16 @@
|
|||
<span class="n">char</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">trigger</span><span class="p">(</span><span class="s2">"my_signal"</span><span class="p">)</span>
|
||||
|
||||
<span class="n">component</span> <span class="o">=</span> <span class="n">char</span><span class="o">.</span><span class="n">cmp</span><span class="o">.</span><span class="n">test_signal_a</span>
|
||||
<span class="k">assert</span> <span class="n">component</span><span class="o">.</span><span class="n">my_signal_is_called</span>
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">component</span><span class="p">,</span> <span class="s2">"my_other_signal_is_called"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">component</span><span class="o">.</span><span class="n">my_signal_is_called</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">component</span><span class="p">,</span> <span class="s2">"my_other_signal_is_called"</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_component_can_register_as_responder"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_component_can_register_as_responder">[docs]</a> <span class="k">def</span> <span class="nf">test_component_can_register_as_responder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">char</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span>
|
||||
<span class="n">char</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">ComponentWithSignal</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">char</span><span class="p">))</span>
|
||||
<span class="n">responses</span> <span class="o">=</span> <span class="n">char</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"my_response"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="mi">1</span> <span class="ow">in</span> <span class="n">responses</span>
|
||||
<span class="k">assert</span> <span class="mi">2</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">responses</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIn</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">responses</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertNotIn</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="n">responses</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_signals_can_add_listener"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_signals_can_add_listener">[docs]</a> <span class="k">def</span> <span class="nf">test_signals_can_add_listener</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
|
|
@ -391,7 +451,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_listener</span><span class="p">(</span><span class="s2">"my_fake_signal"</span><span class="p">,</span> <span class="n">my_fake_listener</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">trigger</span><span class="p">(</span><span class="s2">"my_fake_signal"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="n">result</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_signals_can_add_responder"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_signals_can_add_responder">[docs]</a> <span class="k">def</span> <span class="nf">test_signals_can_add_responder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">my_fake_responder</span><span class="p">():</span>
|
||||
|
|
@ -400,7 +460,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_responder</span><span class="p">(</span><span class="s2">"my_fake_response"</span><span class="p">,</span> <span class="n">my_fake_responder</span><span class="p">)</span>
|
||||
<span class="n">responses</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"my_fake_response"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="mi">1</span> <span class="ow">in</span> <span class="n">responses</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIn</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">responses</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_signals_can_remove_listener"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_signals_can_remove_listener">[docs]</a> <span class="k">def</span> <span class="nf">test_signals_can_remove_listener</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
|
|
@ -412,7 +472,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">remove_listener</span><span class="p">(</span><span class="s2">"my_fake_signal"</span><span class="p">,</span> <span class="n">my_fake_listener</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">trigger</span><span class="p">(</span><span class="s2">"my_fake_signal"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="n">result</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_signals_can_remove_responder"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_signals_can_remove_responder">[docs]</a> <span class="k">def</span> <span class="nf">test_signals_can_remove_responder</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">my_fake_responder</span><span class="p">():</span>
|
||||
|
|
@ -422,7 +482,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">remove_responder</span><span class="p">(</span><span class="s2">"my_fake_response"</span><span class="p">,</span> <span class="n">my_fake_responder</span><span class="p">)</span>
|
||||
<span class="n">responses</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"my_fake_response"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="n">responses</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">responses</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_signals_can_trigger_with_args"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_signals_can_trigger_with_args">[docs]</a> <span class="k">def</span> <span class="nf">test_signals_can_trigger_with_args</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
|
|
@ -433,7 +493,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_listener</span><span class="p">(</span><span class="s2">"my_fake_signal"</span><span class="p">,</span> <span class="n">my_fake_listener</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">trigger</span><span class="p">(</span><span class="s2">"my_fake_signal"</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">kwarg1</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="ow">in</span> <span class="n">result</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIn</span><span class="p">((</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_signals_can_query_with_args"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_signals_can_query_with_args">[docs]</a> <span class="k">def</span> <span class="nf">test_signals_can_query_with_args</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">my_fake_responder</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">kwarg1</span><span class="p">):</span>
|
||||
|
|
@ -442,7 +502,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_responder</span><span class="p">(</span><span class="s2">"my_fake_response"</span><span class="p">,</span> <span class="n">my_fake_responder</span><span class="p">)</span>
|
||||
<span class="n">responses</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"my_fake_response"</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">kwarg1</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="ow">in</span> <span class="n">responses</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIn</span><span class="p">((</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">responses</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_signals_trigger_does_not_fail_without_listener"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_signals_trigger_does_not_fail_without_listener">[docs]</a> <span class="k">def</span> <span class="nf">test_signals_trigger_does_not_fail_without_listener</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">trigger</span><span class="p">(</span><span class="s2">"some_unknown_signal"</span><span class="p">)</span></div>
|
||||
|
|
@ -457,7 +517,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_responder</span><span class="p">(</span><span class="s2">"my_fake_response"</span><span class="p">,</span> <span class="n">my_fake_responder</span><span class="p">)</span>
|
||||
<span class="n">responses</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"my_fake_response"</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">kwarg1</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="ow">in</span> <span class="n">responses</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIn</span><span class="p">((</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">responses</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_signals_can_add_object_listeners_and_responders"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_signals_can_add_object_listeners_and_responders">[docs]</a> <span class="k">def</span> <span class="nf">test_signals_can_add_object_listeners_and_responders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
|
|
@ -470,7 +530,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">add_object_listeners_and_responders</span><span class="p">(</span><span class="n">FakeObj</span><span class="p">())</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">trigger</span><span class="p">(</span><span class="s2">"my_signal"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="n">result</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertTrue</span><span class="p">(</span><span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_signals_can_remove_object_listeners_and_responders"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_signals_can_remove_object_listeners_and_responders">[docs]</a> <span class="k">def</span> <span class="nf">test_signals_can_remove_object_listeners_and_responders</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">result</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
|
|
@ -485,14 +545,14 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">remove_object_listeners_and_responders</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">char1</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">trigger</span><span class="p">(</span><span class="s2">"my_signal"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="n">result</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">result</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_component_handler_signals_connected_when_adding_default_component"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_component_handler_signals_connected_when_adding_default_component">[docs]</a> <span class="k">def</span> <span class="nf">test_component_handler_signals_connected_when_adding_default_component</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">char</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span>
|
||||
<span class="n">char</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">add_default</span><span class="p">(</span><span class="s2">"test_signal_a"</span><span class="p">)</span>
|
||||
<span class="n">responses</span> <span class="o">=</span> <span class="n">char</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"my_component_response"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="mi">3</span> <span class="ow">in</span> <span class="n">responses</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertIn</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="n">responses</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_component_handler_signals_disconnected_when_removing_component"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_component_handler_signals_disconnected_when_removing_component">[docs]</a> <span class="k">def</span> <span class="nf">test_component_handler_signals_disconnected_when_removing_component</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">char</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span>
|
||||
|
|
@ -501,7 +561,7 @@
|
|||
<span class="n">char</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">comp</span><span class="p">)</span>
|
||||
<span class="n">responses</span> <span class="o">=</span> <span class="n">char</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"my_component_response"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="n">responses</span></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">responses</span><span class="p">)</span></div>
|
||||
|
||||
<div class="viewcode-block" id="TestComponentSignals.test_component_handler_signals_disconnected_when_removing_component_by_name"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_component_handler_signals_disconnected_when_removing_component_by_name">[docs]</a> <span class="k">def</span> <span class="nf">test_component_handler_signals_disconnected_when_removing_component_by_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="n">char</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">char1</span>
|
||||
|
|
@ -509,7 +569,7 @@
|
|||
<span class="n">char</span><span class="o">.</span><span class="n">components</span><span class="o">.</span><span class="n">remove_by_name</span><span class="p">(</span><span class="s2">"test_signal_a"</span><span class="p">)</span>
|
||||
<span class="n">responses</span> <span class="o">=</span> <span class="n">char</span><span class="o">.</span><span class="n">signals</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"my_component_response"</span><span class="p">)</span>
|
||||
|
||||
<span class="k">assert</span> <span class="ow">not</span> <span class="n">responses</span></div></div>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">responses</span><span class="p">)</span></div></div>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
|
|
@ -529,7 +589,6 @@
|
|||
<li class="nav-item nav-item-0"><a href="../../../../../index.html">Evennia latest</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="../../../../index.html" >Module code</a> »</li>
|
||||
<li class="nav-item nav-item-2"><a href="../../../../evennia.html" >evennia</a> »</li>
|
||||
<li class="nav-item nav-item-3"><a href="../components.html" >evennia.contrib.base_systems.components</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.components.tests</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -178,8 +178,8 @@
|
|||
<span class="k">if</span> <span class="ow">not</span> <span class="n">fields</span><span class="p">:</span>
|
||||
<span class="n">fields</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">10</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"aliases"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">9</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"category"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">8</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"aliases"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">7</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"category"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">6</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s2">"field_name"</span><span class="p">:</span> <span class="s2">"tags"</span><span class="p">,</span> <span class="s2">"boost"</span><span class="p">:</span> <span class="mi">5</span><span class="p">},</span>
|
||||
<span class="p">]</span>
|
||||
|
||||
|
|
|
|||
|
|
@ -125,13 +125,12 @@
|
|||
<li><a href="evennia/contrib/base_systems/building_menu/building_menu.html">evennia.contrib.base_systems.building_menu.building_menu</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/building_menu/tests.html">evennia.contrib.base_systems.building_menu.tests</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/color_markups/tests.html">evennia.contrib.base_systems.color_markups.tests</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/components.html">evennia.contrib.base_systems.components</a></li>
|
||||
<ul><li><a href="evennia/contrib/base_systems/components/component.html">evennia.contrib.base_systems.components.component</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/components/component.html">evennia.contrib.base_systems.components.component</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/components/dbfield.html">evennia.contrib.base_systems.components.dbfield</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/components/holder.html">evennia.contrib.base_systems.components.holder</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/components/signals.html">evennia.contrib.base_systems.components.signals</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/components/tests.html">evennia.contrib.base_systems.components.tests</a></li>
|
||||
</ul><li><a href="evennia/contrib/base_systems/custom_gametime/custom_gametime.html">evennia.contrib.base_systems.custom_gametime.custom_gametime</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/custom_gametime/custom_gametime.html">evennia.contrib.base_systems.custom_gametime.custom_gametime</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/custom_gametime/tests.html">evennia.contrib.base_systems.custom_gametime.tests</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/email_login/email_login.html">evennia.contrib.base_systems.email_login.email_login</a></li>
|
||||
<li><a href="evennia/contrib/base_systems/email_login/tests.html">evennia.contrib.base_systems.email_login.tests</a></li>
|
||||
|
|
|
|||
|
|
@ -9,9 +9,21 @@
|
|||
- [Fix] `services` command with no args would traceback (regression) (Griatch)
|
||||
- [Feature][pull3412]: Make it possible to add custom webclient css in
|
||||
`webclient/css/custom.css`, same as for website (InspectorCaracal)
|
||||
- [Fix][pull3423]: Fix wilderness contrib error moving to an already existing
|
||||
wilderness room (InspectorCaracal)
|
||||
- [Fix][pull3425]: Don't always include example the crafting recipe when
|
||||
using the crafting contrib (InspectorCaracal)
|
||||
- [pull3426]: Traceback banning a channel using with only one nick
|
||||
(InspectorCaracal)
|
||||
- [pull3434]: Adjust lunr search weights to void clashing of cmd-aliases over
|
||||
keys which caused some help entries to shadow others (InspectorCaracal)
|
||||
- Doc fixes (InspectorCaracal, Griatch)
|
||||
|
||||
[pull3412]: https://github.com/evennia/evennia/pull/3412
|
||||
[pull3423]: https://github.com/evennia/evennia/pull/3423
|
||||
[pull3425]: https://github.com/evennia/evennia/pull/3425
|
||||
[pull3426]: https://github.com/evennia/evennia/pull/3426
|
||||
[pull3434]: https://github.com/evennia/evennia/pull/3434
|
||||
|
||||
## Evennia 3.1.1
|
||||
|
||||
|
|
|
|||
|
|
@ -30,12 +30,20 @@ class Character(ComponentHolderMixin, DefaultCharacter):
|
|||
# ...
|
||||
```
|
||||
|
||||
Components need to inherit the Component class directly and require a name.
|
||||
Components need to inherit the Component class and require a unique name.
|
||||
Components may inherit from other components but must specify another name.
|
||||
You can assign the same 'slot' to both components to have alternative implementations.
|
||||
```python
|
||||
from evennia.contrib.base_systems.components import Component
|
||||
|
||||
|
||||
class Health(Component):
|
||||
name = "health"
|
||||
|
||||
|
||||
class ItemHealth(Health):
|
||||
name = "item_health"
|
||||
slot = "health"
|
||||
```
|
||||
|
||||
Components may define DBFields or NDBFields at the class level.
|
||||
|
|
@ -103,7 +111,10 @@ character.components.add(vampirism)
|
|||
|
||||
...
|
||||
|
||||
vampirism_from_elsewhere = character.components.get("vampirism")
|
||||
vampirism = character.components.get("vampirism")
|
||||
|
||||
# Alternatively
|
||||
vampirism = character.cmp.vampirism
|
||||
```
|
||||
|
||||
Keep in mind that all components must be imported to be visible in the listing.
|
||||
|
|
@ -128,6 +139,14 @@ from typeclasses.components import health
|
|||
```
|
||||
Both of the above examples will work.
|
||||
|
||||
## Known Issues
|
||||
|
||||
Assigning mutable default values such as a list to a DBField will share it across instances.
|
||||
To avoid this, you must set autocreate=True on the field, like this.
|
||||
```python
|
||||
health = DBField(default=[], autocreate=True)
|
||||
```
|
||||
|
||||
## Full Example
|
||||
```python
|
||||
from evennia.contrib.base_systems import components
|
||||
|
|
|
|||
|
|
@ -145,7 +145,7 @@ method. Otherwise all text will be returned to all connected sessions.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.account.CmdOOCLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -176,7 +176,7 @@ method. Otherwise all text will be returned to all connected sessions.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.account.CmdOOCLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -329,7 +329,7 @@ to accounts respectively.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.admin.CmdEmit.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['pemit', 'remit']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['remit', 'pemit']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -360,7 +360,7 @@ to accounts respectively.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.admin.CmdEmit.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'pemit remit', 'category': 'admin', 'key': 'emit', 'no_prefix': ' pemit remit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [<obj>, <obj>, ... =] <message>\n remit [<obj>, <obj>, ... =] <message>\n pemit [<obj>, <obj>, ... =] <message>\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'remit pemit', 'category': 'admin', 'key': 'emit', 'no_prefix': ' remit pemit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [<obj>, <obj>, ... =] <message>\n remit [<obj>, <obj>, ... =] <message>\n pemit [<obj>, <obj>, ... =] <message>\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -1409,7 +1409,7 @@ server settings.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdTypeclass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@type', '@typeclasses', '@parent', '@swap', '@update']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@type', '@swap', '@typeclasses', '@parent', '@update']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -1440,7 +1440,7 @@ server settings.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdTypeclass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@type @typeclasses @parent @swap @update', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass type typeclasses parent swap update', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@type @swap @typeclasses @parent @update', 'category': 'building', 'key': '@typeclass', 'no_prefix': 'typeclass type swap typeclasses parent update', 'tags': '', 'text': "\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] <object> [= typeclass.path]\n typeclass/prototype <object> = prototype_key\n\n typeclasses or typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object. This will also\n reset cmdsets!\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n "}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -1595,7 +1595,7 @@ If object is not specified, the current location is examined.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdExamine.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@ex', '@exam']</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@exam', '@ex']</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -1868,7 +1868,7 @@ the cases, see the module doc.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdExamine.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@ex @exam', 'category': 'building', 'key': '@examine', 'no_prefix': 'examine ex exam', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [<object>[/attrname]]\n examine [*<account>[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n script - examine a Script\n channel - examine a Channel\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@exam @ex', 'category': 'building', 'key': '@examine', 'no_prefix': 'examine exam ex', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [<object>[/attrname]]\n examine [*<account>[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n script - examine a Script\n channel - examine a Channel\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -1902,7 +1902,7 @@ one is given.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdFind.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@search', '@locate']</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@locate', '@search']</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -1933,7 +1933,7 @@ one is given.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.building.CmdFind.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@search @locate', 'category': 'building', 'key': '@find', 'no_prefix': 'find search locate', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@locate @search', 'category': 'building', 'key': '@find', 'no_prefix': 'find locate search', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] <name or dbref or *account> [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -187,7 +187,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -218,7 +218,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -610,7 +610,7 @@ placing it in their inventory.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdSay.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['"', "'"]</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ["'", '"']</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -641,7 +641,7 @@ placing it in their inventory.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdSay.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '" \'', 'category': 'general', 'key': 'say', 'no_prefix': ' " \'', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '\' "', 'category': 'general', 'key': 'say', 'no_prefix': ' \' "', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdSay.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -721,7 +721,7 @@ automatically begin with your name.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdPose.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['emote', ':']</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':', 'emote']</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -762,7 +762,7 @@ space.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.general.CmdPose.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'emote :', 'category': 'general', 'key': 'pose', 'no_prefix': ' emote :', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ': emote', 'category': 'general', 'key': 'pose', 'no_prefix': ' : emote', 'tags': '', 'text': "\n strike a pose\n\n Usage:\n pose <pose text>\n pose's <pose text>\n\n Example:\n pose is standing by the wall, smiling.\n -> others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n "}</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -695,7 +695,7 @@ See <a href="#id11"><span class="problematic" id="id12">|</span></a>luhttps://ww
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.system.CmdTasks.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@delays', '@task']</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@task', '@delays']</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -741,7 +741,7 @@ to all the variables defined therein.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.system.CmdTasks.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@delays @task', 'category': 'system', 'key': '@tasks', 'no_prefix': 'tasks delays task', 'tags': '', 'text': "\n Display or terminate active tasks (delays).\n\n Usage:\n tasks[/switch] [task_id or function_name]\n\n Switches:\n pause - Pause the callback of a task.\n unpause - Process all callbacks made since pause() was called.\n do_task - Execute the task (call its callback).\n call - Call the callback of this task.\n remove - Remove a task without executing it.\n cancel - Stop a task from automatically executing.\n\n Notes:\n A task is a single use method of delaying the call of a function. Calls are created\n in code, using `evennia.utils.delay`.\n See |luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.\n\n By default, tasks that are canceled and never called are cleaned up after one minute.\n\n Examples:\n - `tasks/cancel move_callback` - Cancels all movement delays from the slow_exit contrib.\n In this example slow exits creates it's tasks with\n `utils.delay(move_delay, move_callback)`\n - `tasks/cancel 2` - Cancel task id 2.\n\n "}</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@task @delays', 'category': 'system', 'key': '@tasks', 'no_prefix': 'tasks task delays', 'tags': '', 'text': "\n Display or terminate active tasks (delays).\n\n Usage:\n tasks[/switch] [task_id or function_name]\n\n Switches:\n pause - Pause the callback of a task.\n unpause - Process all callbacks made since pause() was called.\n do_task - Execute the task (call its callback).\n call - Call the callback of this task.\n remove - Remove a task without executing it.\n cancel - Stop a task from automatically executing.\n\n Notes:\n A task is a single use method of delaying the call of a function. Calls are created\n in code, using `evennia.utils.delay`.\n See |luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.\n\n By default, tasks that are canceled and never called are cleaned up after one minute.\n\n Examples:\n - `tasks/cancel move_callback` - Cancels all movement delays from the slow_exit contrib.\n In this example slow exits creates it's tasks with\n `utils.delay(move_delay, move_callback)`\n - `tasks/cancel 2` - Cancel task id 2.\n\n "}</em><a class="headerlink" href="#evennia.commands.default.system.CmdTasks.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -973,7 +973,7 @@ main test suite started with</p>
|
|||
<p>Test the batch processor.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.tests.TestBatchProcess.red_button">
|
||||
<code class="sig-name descname">red_button</code><em class="property"> = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmpuchruimt/772d4c21b5716c3f29d3307f2a078439169ae53c/evennia/contrib/tutorials/red_button/red_button.py'></em><a class="headerlink" href="#evennia.commands.default.tests.TestBatchProcess.red_button" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">red_button</code><em class="property"> = <module 'evennia.contrib.tutorials.red_button.red_button' from '/tmp/tmppnsswh9b/0edcebea0fdd67c4ba5c58f3b0d589b02a6bea3e/evennia/contrib/tutorials/red_button/red_button.py'></em><a class="headerlink" href="#evennia.commands.default.tests.TestBatchProcess.red_button" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
|
|||
|
|
@ -134,7 +134,7 @@ connect “account name” “pass word”</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['con', 'conn', 'co']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'conn', 'con']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -169,7 +169,7 @@ there is no object yet before the account has logged in)</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'con conn co', 'category': 'general', 'key': 'connect', 'no_prefix': ' con conn co', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'no_prefix': ' co conn con', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name" "pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -193,7 +193,7 @@ create “account name” “pass word”</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['cr', 'cre']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['cre', 'cr']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -230,7 +230,7 @@ create “account name” “pass word”</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cr cre', 'category': 'general', 'key': 'create', 'no_prefix': ' cr cre', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create <accountname> <password>\n create "account name" "pass word"\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cre cr', 'category': 'general', 'key': 'create', 'no_prefix': ' cre cr', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create <accountname> <password>\n create "account name" "pass word"\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -304,7 +304,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'look']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -330,7 +330,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' look l', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -353,7 +353,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?', 'h']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['h', '?']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -379,7 +379,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -117,6 +117,14 @@
|
|||
<span id="evennia-contrib-base-systems-components-component"></span><h1>evennia.contrib.base_systems.components.component<a class="headerlink" href="#module-evennia.contrib.base_systems.components.component" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Components - ChrisLR 2022</p>
|
||||
<p>This file contains the base class to inherit for creating new components.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.component.BaseComponent">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.component.</code><code class="sig-name descname">BaseComponent</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/component.html#BaseComponent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.component.BaseComponent" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></p>
|
||||
<p>This is the metaclass for components,
|
||||
responsible for registering components to the listing.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.component.</code><code class="sig-name descname">Component</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/component.html#Component"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -129,12 +137,22 @@ Any component must inherit from this class to be considered for usage.</p>
|
|||
<code class="sig-name descname">name</code><em class="property"> = ''</em><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component.slot">
|
||||
<code class="sig-name descname">slot</code><em class="property"> = None</em><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/component.html#Component.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component.host">
|
||||
<code class="sig-name descname">host</code><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.host" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component.default_create">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">default_create</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/component.html#Component.default_create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.default_create" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -238,28 +256,22 @@ To persist the value, the key must correspond to a DBField.</p></li>
|
|||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component.db_field_names">
|
||||
<em class="property">property </em><code class="sig-name descname">db_field_names</code><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.db_field_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component.add_field">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">add_field</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">field</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/component.html#Component.add_field"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.add_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component.ndb_field_names">
|
||||
<em class="property">property </em><code class="sig-name descname">ndb_field_names</code><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.ndb_field_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component.get_fields">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">get_fields</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/component.html#Component.get_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.get_fields" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component.tag_field_names">
|
||||
<em class="property">property </em><code class="sig-name descname">tag_field_names</code><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.tag_field_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dt id="evennia.contrib.base_systems.components.component.Component.get_component_slot">
|
||||
<em class="property">classmethod </em><code class="sig-name descname">get_component_slot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/component.html#Component.get_component_slot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.component.Component.get_component_slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.base_systems.components.component.ComponentRegisterError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.component.</code><code class="sig-name descname">ComponentRegisterError</code><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/component.html#ComponentRegisterError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.component.ComponentRegisterError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -119,11 +119,70 @@
|
|||
<p>This file contains the Descriptors used to set Fields in Components</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.dbfield.DBField">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.dbfield.</code><code class="sig-name descname">DBField</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">category</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">strattr</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">lockstring</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">autocreate</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/dbfield.html#DBField"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.dbfield.DBField" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.dbfield.</code><code class="sig-name descname">DBField</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">autocreate</span><span class="o">=</span><span class="default_value">False</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/contrib/base_systems/components/dbfield.html#DBField"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.dbfield.DBField" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.typeclasses.attributes.html#evennia.typeclasses.attributes.AttributeProperty" title="evennia.typeclasses.attributes.AttributeProperty"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.attributes.AttributeProperty</span></code></a></p>
|
||||
<p>Component Attribute Descriptor.
|
||||
Allows you to set attributes related to a component on the class.
|
||||
It uses AttributeProperty under the hood but prefixes the key with the component name.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.dbfield.DBField.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">default</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">autocreate</span><span class="o">=</span><span class="default_value">False</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/contrib/base_systems/components/dbfield.html#DBField.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.dbfield.DBField.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Allows for specifying Attributes as Django-like ‘fields’ on the class level. Note that while
|
||||
one can set a lock on the Attribute, there is no way to <em>check</em> said lock when accessing via
|
||||
the property - use the full <strong>AttributeHandler</strong> if you need to do access checks. Note however
|
||||
that if you use the full <strong>AttributeHandler</strong> to access this Attribute, the <strong>at_get/at_set</strong>
|
||||
methods on this class will _not_ fire (because you are bypassing the <strong>AttributeProperty</strong>
|
||||
entirely in that case).</p>
|
||||
<p>Initialize an Attribute as a property descriptor.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Keyword Arguments</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>default</strong> (<em>any</em>) – A default value if the attr is not set. If a callable, this will be
|
||||
run without any arguments and is expected to return the default value.</p></li>
|
||||
<li><p><strong>category</strong> (<em>str</em>) – The attribute’s category. If unset, use class default.</p></li>
|
||||
<li><p><strong>strattr</strong> (<em>bool</em>) – If set, this Attribute <em>must</em> be a simple string, and will be
|
||||
stored more efficiently.</p></li>
|
||||
<li><p><strong>lockstring</strong> (<em>str</em>) – This is not itself useful with the property, but only if
|
||||
using the full AttributeHandler.get(accessing_obj=…) to access the
|
||||
Attribute.</p></li>
|
||||
<li><p><strong>autocreate</strong> (<em>bool</em>) – True by default; this means Evennia makes sure to create a new
|
||||
copy of the Attribute (with the default value) whenever a new object with this
|
||||
property is created. If <strong>False</strong>, no Attribute will be created until the property
|
||||
is explicitly assigned a value. This makes it more efficient while it retains
|
||||
its default (there’s no db access), but without an actual Attribute generated,
|
||||
one cannot access it via .db, the AttributeHandler or see it with <strong>examine</strong>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Character</span><span class="p">(</span><span class="n">DefaultCharacter</span><span class="p">):</span>
|
||||
<span class="n">foo</span> <span class="o">=</span> <span class="n">AttributeProperty</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s2">"Bar"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.dbfield.DBField.at_added">
|
||||
<code class="sig-name descname">at_added</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/dbfield.html#DBField.at_added"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.dbfield.DBField.at_added" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when the parent component is added to a host.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>component</strong> (<a class="reference internal" href="evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component" title="evennia.contrib.base_systems.components.component.Component"><em>Component</em></a>) – The component instance being added.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.dbfield.DBField.at_removed">
|
||||
<code class="sig-name descname">at_removed</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/dbfield.html#DBField.at_removed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.dbfield.DBField.at_removed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when the parent component is removed from a host.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>component</strong> (<a class="reference internal" href="evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component" title="evennia.contrib.base_systems.components.component.Component"><em>Component</em></a>) – The component instance being removed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
|
|
@ -133,6 +192,28 @@ It uses AttributeProperty under the hood but prefixes the key with the component
|
|||
<p>Component In-Memory Attribute Descriptor.
|
||||
Allows you to set in-memory attributes related to a component on the class.
|
||||
It uses NAttributeProperty under the hood but prefixes the key with the component name.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.dbfield.NDBField.at_added">
|
||||
<code class="sig-name descname">at_added</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/dbfield.html#NDBField.at_added"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.dbfield.NDBField.at_added" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when the parent component is added to a host.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>component</strong> (<a class="reference internal" href="evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component" title="evennia.contrib.base_systems.components.component.Component"><em>Component</em></a>) – The component instance being added.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.dbfield.NDBField.at_removed">
|
||||
<code class="sig-name descname">at_removed</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/dbfield.html#NDBField.at_removed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.dbfield.NDBField.at_removed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when the parent component is removed from a host.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>component</strong> (<a class="reference internal" href="evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component" title="evennia.contrib.base_systems.components.component.Component"><em>Component</em></a>) – The component instance being removed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
|
|
@ -151,6 +232,28 @@ Tags are removed if the component itself is removed.</p>
|
|||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.dbfield.TagField.at_added">
|
||||
<code class="sig-name descname">at_added</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/dbfield.html#TagField.at_added"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.dbfield.TagField.at_added" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when the parent component is added to a host.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>component</strong> (<a class="reference internal" href="evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component" title="evennia.contrib.base_systems.components.component.Component"><em>Component</em></a>) – The component instance being added.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.dbfield.TagField.at_removed">
|
||||
<code class="sig-name descname">at_removed</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/dbfield.html#TagField.at_removed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.dbfield.TagField.at_removed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Called when the parent component is removed from a host.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>component</strong> (<a class="reference internal" href="evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component" title="evennia.contrib.base_systems.components.component.Component"><em>Component</em></a>) – The component instance being removed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -119,7 +119,7 @@
|
|||
<p>This file contains the classes that allow a typeclass to use components.</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentProperty">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.holder.</code><code class="sig-name descname">ComponentProperty</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component_name</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/contrib/base_systems/components/holder.html#ComponentProperty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentProperty" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.holder.</code><code class="sig-name descname">ComponentProperty</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</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/contrib/base_systems/components/holder.html#ComponentProperty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentProperty" 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 allows you to register a component on a typeclass.
|
||||
Components registered with this property are automatically added
|
||||
|
|
@ -127,12 +127,12 @@ to any instance of this typeclass.</p>
|
|||
<p>Defaults can be overridden for this typeclass by passing kwargs</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentProperty.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component_name</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/contrib/base_systems/components/holder.html#ComponentProperty.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentProperty.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</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/contrib/base_systems/components/holder.html#ComponentProperty.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentProperty.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initializes the descriptor</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>component_name</strong> (<em>str</em>) – The name of the component</p></li>
|
||||
<li><p><strong>name</strong> (<em>str</em>) – The name of the component</p></li>
|
||||
<li><p><strong>**kwargs</strong> (<em>any</em>) – Key=Values overriding default values of the component</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
@ -156,7 +156,7 @@ It stores the list of registered components on the host .db with component_names
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentHandler.add">
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHandler.add" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span><span class="p">:</span> <span class="n"><a class="reference internal" href="evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component" title="evennia.contrib.base_systems.components.component.Component">evennia.contrib.base_systems.components.component.Component</a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHandler.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Method to add a Component to a host.
|
||||
It caches the loaded component and appends its name to the host’s component name list.
|
||||
It will also call the component’s ‘at_added’ method, passing its host.</p>
|
||||
|
|
@ -171,7 +171,7 @@ It will also call the component’s ‘at_added’ method, passing its host.</p>
|
|||
<dt id="evennia.contrib.base_systems.components.holder.ComponentHandler.add_default">
|
||||
<code class="sig-name descname">add_default</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentHandler.add_default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHandler.add_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Method to add a Component initialized to default values on a host.
|
||||
It will retrieve the proper component and instanciate it with ‘default_create’.
|
||||
It will retrieve the proper component and instantiate it with ‘default_create’.
|
||||
It will cache this new component and add it to its list.
|
||||
It will also call the component’s ‘at_added’ method, passing its host.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -183,7 +183,7 @@ It will also call the component’s ‘at_added’ method, passing its host.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentHandler.remove">
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentHandler.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHandler.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span><span class="p">:</span> <span class="n"><a class="reference internal" href="evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component" title="evennia.contrib.base_systems.components.component.Component">evennia.contrib.base_systems.components.component.Component</a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentHandler.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHandler.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Method to remove a component instance from a host.
|
||||
It removes the component from the cache and listing.
|
||||
It will call the component’s ‘at_removed’ method.</p>
|
||||
|
|
@ -202,29 +202,23 @@ It removes the component from the cache and listing.
|
|||
It will call the component’s ‘at_removed’ method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – The name of the component to remove.</p>
|
||||
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – The name of the component to remove or its slot.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentHandler.get">
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentHandler.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHandler.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Method to retrieve a cached Component instance by its name.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – The name of the component to retrieve.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> → evennia.contrib.base_systems.components.component.Component | None<a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentHandler.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHandler.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentHandler.has">
|
||||
<code class="sig-name descname">has</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentHandler.has"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHandler.has" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">has</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="p">:</span> <span class="n">str</span></em><span class="sig-paren">)</span> → bool<a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentHandler.has"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHandler.has" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Method to check if a component is registered and ready.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – The name of the component.</p>
|
||||
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – The name of the component or the slot.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -240,7 +234,7 @@ prototype class that can be found from this listing.</p>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentHandler.db_names">
|
||||
<em class="property">property </em><code class="sig-name descname">db_names</code><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHandler.db_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Property shortcut to retrieve the registered component names</p>
|
||||
<dd><p>Property shortcut to retrieve the registered component keys</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>component_names (iterable)</em> – The name of each component that is registered</p>
|
||||
|
|
@ -281,12 +275,6 @@ They will be of None value if not present in the class components or runtime com
|
|||
components that were set on the typeclass using ComponentProperty.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentHolderMixin.basetype_posthook_setup">
|
||||
<code class="sig-name descname">basetype_posthook_setup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentHolderMixin.basetype_posthook_setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHolderMixin.basetype_posthook_setup" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Method that add component related tags that were set using ComponentProperty.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentHolderMixin.components">
|
||||
<em class="property">property </em><code class="sig-name descname">components</code><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentHolderMixin.components" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -308,18 +296,6 @@ components that were set on the typeclass using ComponentProperty.</p>
|
|||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentDoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.holder.</code><code class="sig-name descname">ComponentDoesNotExist</code><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentDoesNotExist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentDoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.base_systems.components.holder.ComponentIsNotRegistered">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.holder.</code><code class="sig-name descname">ComponentIsNotRegistered</code><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/holder.html#ComponentIsNotRegistered"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.holder.ComponentIsNotRegistered" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -119,11 +119,6 @@
|
|||
It allows you to use components on typeclasses using a simple syntax.
|
||||
This helps writing isolated code and reusing it over multiple objects.</p>
|
||||
<p>See the docs for more information.</p>
|
||||
<dl class="py function">
|
||||
<dt id="evennia.contrib.base_systems.components.get_component_class">
|
||||
<code class="sig-prename descclassname">evennia.contrib.base_systems.components.</code><code class="sig-name descname">get_component_class</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component_name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components.html#get_component_class"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.get_component_class" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.base_systems.components.component.html">evennia.contrib.base_systems.components.component</a></li>
|
||||
|
|
|
|||
|
|
@ -140,6 +140,90 @@ Allows you to set attributes related to a component on the class.
|
|||
It uses AttributeProperty under the hood but prefixes the key with the component name.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ComponentTestA.host">
|
||||
<code class="sig-name descname">host</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ComponentTestA.host" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ShadowedComponentTestA">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.tests.</code><code class="sig-name descname">ShadowedComponentTestA</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#ShadowedComponentTestA"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ShadowedComponentTestA" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.base_systems.components.tests.ComponentTestA" title="evennia.contrib.base_systems.components.tests.ComponentTestA"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.components.tests.ComponentTestA</span></code></a></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ShadowedComponentTestA.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'shadowed_test_a'</em><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ShadowedComponentTestA.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ShadowedComponentTestA.slot">
|
||||
<code class="sig-name descname">slot</code><em class="property"> = 'ic_a'</em><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ShadowedComponentTestA.slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ShadowedComponentTestA.host">
|
||||
<code class="sig-name descname">host</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ShadowedComponentTestA.host" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.InheritedComponentTestA">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.tests.</code><code class="sig-name descname">InheritedComponentTestA</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#InheritedComponentTestA"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.InheritedComponentTestA" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.base_systems.components.tests.ComponentTestA" title="evennia.contrib.base_systems.components.tests.ComponentTestA"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.components.tests.ComponentTestA</span></code></a></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.InheritedComponentTestA.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'inherited_test_a'</em><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.InheritedComponentTestA.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.InheritedComponentTestA.slot">
|
||||
<code class="sig-name descname">slot</code><em class="property"> = 'ic_a'</em><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.InheritedComponentTestA.slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.InheritedComponentTestA.my_other_int">
|
||||
<code class="sig-name descname">my_other_int</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.InheritedComponentTestA.my_other_int" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Component Attribute Descriptor.
|
||||
Allows you to set attributes related to a component on the class.
|
||||
It uses AttributeProperty under the hood but prefixes the key with the component name.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.InheritedComponentTestA.host">
|
||||
<code class="sig-name descname">host</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.InheritedComponentTestA.host" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ReplacementComponentTestA">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.tests.</code><code class="sig-name descname">ReplacementComponentTestA</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#ReplacementComponentTestA"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.base_systems.components.tests.InheritedComponentTestA" title="evennia.contrib.base_systems.components.tests.InheritedComponentTestA"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.components.tests.InheritedComponentTestA</span></code></a></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'replacement_inherited_test_a'</em><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.slot">
|
||||
<code class="sig-name descname">slot</code><em class="property"> = 'ic_a'</em><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.slot" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.replacement_field">
|
||||
<code class="sig-name descname">replacement_field</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.replacement_field" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Component Attribute Descriptor.
|
||||
Allows you to set attributes related to a component on the class.
|
||||
It uses AttributeProperty under the hood but prefixes the key with the component name.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.host">
|
||||
<code class="sig-name descname">host</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.host" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
|
|
@ -211,6 +295,11 @@ multiple tags or enforce a single one.</p>
|
|||
Tags are removed if the component itself is removed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ComponentTestB.host">
|
||||
<code class="sig-name descname">host</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ComponentTestB.host" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
|
|
@ -249,12 +338,80 @@ multiple tags or enforce a single one.</p>
|
|||
Tags are removed if the component itself is removed.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.RuntimeComponentTestC.host">
|
||||
<code class="sig-name descname">host</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.RuntimeComponentTestC.host" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ComponentTestD">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.tests.</code><code class="sig-name descname">ComponentTestD</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#ComponentTestD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ComponentTestD" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component" title="evennia.contrib.base_systems.components.component.Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.components.component.Component</span></code></a></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ComponentTestD.name">
|
||||
<code class="sig-name descname">name</code><em class="property"> = 'test_d'</em><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ComponentTestD.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ComponentTestD.mixed_in">
|
||||
<code class="sig-name descname">mixed_in</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ComponentTestD.mixed_in" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Component Attribute Descriptor.
|
||||
Allows you to set attributes related to a component on the class.
|
||||
It uses AttributeProperty under the hood but prefixes the key with the component name.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ComponentTestD.host">
|
||||
<code class="sig-name descname">host</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ComponentTestD.host" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.tests.</code><code class="sig-name descname">ShadowedCharacterMixin</code><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#ShadowedCharacterMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin" 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>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin.ic_a">
|
||||
<code class="sig-name descname">ic_a</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin.ic_a" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This allows you to register a component on a typeclass.
|
||||
Components registered with this property are automatically added
|
||||
to any instance of this typeclass.</p>
|
||||
<p>Defaults can be overridden for this typeclass by passing kwargs</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.tests.</code><code class="sig-name descname">CharacterMixinWithComponents</code><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#CharacterMixinWithComponents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents" 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>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents.ic_a">
|
||||
<code class="sig-name descname">ic_a</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents.ic_a" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This allows you to register a component on a typeclass.
|
||||
Components registered with this property are automatically added
|
||||
to any instance of this typeclass.</p>
|
||||
<p>Defaults can be overridden for this typeclass by passing kwargs</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents.test_d">
|
||||
<code class="sig-name descname">test_d</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents.test_d" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This allows you to register a component on a typeclass.
|
||||
Components registered with this property are automatically added
|
||||
to any instance of this typeclass.</p>
|
||||
<p>Defaults can be overridden for this typeclass by passing kwargs</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.CharacterWithComponents">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.components.tests.</code><code class="sig-name descname">CharacterWithComponents</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">db_key</span></em>, <em class="sig-param"><span class="n">db_typeclass_path</span></em>, <em class="sig-param"><span class="n">db_date_created</span></em>, <em class="sig-param"><span class="n">db_lock_storage</span></em>, <em class="sig-param"><span class="n">db_account</span></em>, <em class="sig-param"><span class="n">db_sessid</span></em>, <em class="sig-param"><span class="n">db_location</span></em>, <em class="sig-param"><span class="n">db_home</span></em>, <em class="sig-param"><span class="n">db_destination</span></em>, <em class="sig-param"><span class="n">db_cmdset_storage</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#CharacterWithComponents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.CharacterWithComponents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHolderMixin" title="evennia.contrib.base_systems.components.holder.ComponentHolderMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.components.holder.ComponentHolderMixin</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHolderMixin" title="evennia.contrib.base_systems.components.holder.ComponentHolderMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.components.holder.ComponentHolderMixin</span></code></a>, <a class="reference internal" href="#evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin" title="evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin</span></code></a>, <a class="reference internal" href="#evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents" title="evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents</span></code></a>, <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultCharacter</span></code></a></p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.CharacterWithComponents.test_a">
|
||||
<code class="sig-name descname">test_a</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.CharacterWithComponents.test_a" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -273,6 +430,15 @@ to any instance of this typeclass.</p>
|
|||
<p>Defaults can be overridden for this typeclass by passing kwargs</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.CharacterWithComponents.ic_a">
|
||||
<code class="sig-name descname">ic_a</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.CharacterWithComponents.ic_a" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This allows you to register a component on a typeclass.
|
||||
Components registered with this property are automatically added
|
||||
to any instance of this typeclass.</p>
|
||||
<p>Defaults can be overridden for this typeclass by passing kwargs</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py exception">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.CharacterWithComponents.DoesNotExist">
|
||||
<em class="property">exception </em><code class="sig-name descname">DoesNotExist</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.CharacterWithComponents.DoesNotExist" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -369,6 +535,26 @@ to any instance of this typeclass.</p>
|
|||
<code class="sig-name descname">test_character_assigns_default_provided_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#TestComponents.test_character_assigns_default_provided_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.TestComponents.test_character_assigns_default_provided_values" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.TestComponents.test_character_has_autocreated_values">
|
||||
<code class="sig-name descname">test_character_has_autocreated_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#TestComponents.test_character_has_autocreated_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.TestComponents.test_character_has_autocreated_values" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.TestComponents.test_component_inheritance_properly_overrides_slots">
|
||||
<code class="sig-name descname">test_component_inheritance_properly_overrides_slots</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#TestComponents.test_component_inheritance_properly_overrides_slots"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.TestComponents.test_component_inheritance_properly_overrides_slots" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.TestComponents.test_component_inheritance_assigns_proper_values">
|
||||
<code class="sig-name descname">test_component_inheritance_assigns_proper_values</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#TestComponents.test_component_inheritance_assigns_proper_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.TestComponents.test_component_inheritance_assigns_proper_values" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.TestComponents.test_host_mixins_assigns_components">
|
||||
<code class="sig-name descname">test_host_mixins_assigns_components</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#TestComponents.test_host_mixins_assigns_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.TestComponents.test_host_mixins_assigns_components" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.TestComponents.test_character_can_register_runtime_component">
|
||||
<code class="sig-name descname">test_character_can_register_runtime_component</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#TestComponents.test_character_can_register_runtime_component"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.TestComponents.test_character_can_register_runtime_component" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -454,6 +640,16 @@ to any instance of this typeclass.</p>
|
|||
<code class="sig-name descname">test_component_tags_support_multiple_values_by_default</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#TestComponents.test_component_tags_support_multiple_values_by_default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.TestComponents.test_component_tags_support_multiple_values_by_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.TestComponents.test_mutables_are_not_shared_when_autocreate">
|
||||
<code class="sig-name descname">test_mutables_are_not_shared_when_autocreate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#TestComponents.test_mutables_are_not_shared_when_autocreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.TestComponents.test_mutables_are_not_shared_when_autocreate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.TestComponents.test_replacing_class_component_slot_with_runtime_component">
|
||||
<code class="sig-name descname">test_replacing_class_component_slot_with_runtime_component</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#TestComponents.test_replacing_class_component_slot_with_runtime_component"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.TestComponents.test_replacing_class_component_slot_with_runtime_component" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
|
|
@ -538,6 +734,11 @@ to any instance of this typeclass.</p>
|
|||
<code class="sig-name descname">my_component_response</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/components/tests.html#ComponentWithSignal.my_component_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ComponentWithSignal.my_component_response" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.components.tests.ComponentWithSignal.host">
|
||||
<code class="sig-name descname">host</code><a class="headerlink" href="#evennia.contrib.base_systems.components.tests.ComponentWithSignal.host" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
|
|
|
|||
|
|
@ -151,7 +151,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['con', 'conn', 'co']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'conn', 'con']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -181,7 +181,7 @@ there is no object yet before the account has logged in)</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'con conn co', 'category': 'general', 'key': 'connect', 'no_prefix': ' con conn co', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'no_prefix': ' co conn con', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect <email> <password>\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -203,7 +203,7 @@ there is no object yet before the account has logged in)</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['cr', 'cre']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['cre', 'cr']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -239,7 +239,7 @@ name enclosed in quotes:</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cr cre', 'category': 'general', 'key': 'create', 'no_prefix': ' cr cre', 'tags': '', 'text': '\n Create a new account.\n\n Usage (at login screen):\n create "accountname" <email> <password>\n\n This creates a new account account.\n\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cre cr', 'category': 'general', 'key': 'create', 'no_prefix': ' cre cr', 'tags': '', 'text': '\n Create a new account.\n\n Usage (at login screen):\n create "accountname" <email> <password>\n\n This creates a new account account.\n\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -303,7 +303,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['look', 'l']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'look']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -329,7 +329,7 @@ All it does is display the connect screen.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'look l', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' look l', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'no_prefix': ' l look', 'tags': '', 'text': '\n This is an unconnected version of the `look` command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -347,7 +347,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?', 'h']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['h', '?']</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -373,7 +373,7 @@ for simplicity. It shows a pane of info.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '? h', 'category': 'general', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@calls', '@callback', '@callbacks']</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['@callbacks', '@calls', '@callback']</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -209,7 +209,7 @@ on user permission.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@calls @callback @callbacks', 'category': 'building', 'key': '@call', 'no_prefix': 'call calls callback callbacks', 'tags': '', 'text': '\n Command to edit callbacks.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@callbacks @calls @callback', 'category': 'building', 'key': '@call', 'no_prefix': 'call callbacks calls callback', 'tags': '', 'text': '\n Command to edit callbacks.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -172,7 +172,7 @@ aliases to an already joined channel.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['chanalias', 'aliaschan']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['aliaschan', 'chanalias']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -203,7 +203,7 @@ aliases to an already joined channel.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'chanalias aliaschan', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' chanalias aliaschan', 'tags': '', 'text': '\n Add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] <channel>\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'aliaschan chanalias', 'category': 'comms', 'key': 'addcom', 'no_prefix': ' aliaschan chanalias', 'tags': '', 'text': '\n Add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] <channel>\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -229,7 +229,7 @@ for that channel.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['delaliaschan', 'delchanalias']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['delchanalias', 'delaliaschan']</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -260,7 +260,7 @@ for that channel.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'delaliaschan delchanalias', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delaliaschan delchanalias', 'tags': '', 'text': "\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom <alias or channel>\n delcom/all <channel>\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n "}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'delchanalias delaliaschan', 'category': 'comms', 'key': 'delcom', 'no_prefix': ' delchanalias delaliaschan', 'tags': '', 'text': "\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom <alias or channel>\n delcom/all <channel>\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n "}</em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdDelCom.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -223,7 +223,7 @@ the operation will be general or on the room.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'chicken out', 'abort', 'quit']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['chicken out', 'abort', 'quit', 'q']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -247,7 +247,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'q chicken out abort quit', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' q chicken out abort quit', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'chicken out abort quit q', 'category': 'evscaperoom', 'key': 'give up', 'no_prefix': ' chicken out abort quit q', 'tags': '', 'text': '\n Give up\n\n Usage:\n give up\n\n Abandons your attempts at escaping and of ever winning the pie-eating contest.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -268,7 +268,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -302,7 +302,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'evscaperoom', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n Look at the room, an object or the currently focused object\n\n Usage:\n look [obj]\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'evscaperoom', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n Look at the room, an object or the currently focused object\n\n Usage:\n look [obj]\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -440,7 +440,7 @@ emote /me points to /box and /lever.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['pose', ':']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':', 'pose']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -479,7 +479,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'pose :', 'category': 'general', 'key': 'emote', 'no_prefix': ' pose :', 'tags': '', 'text': '\n Perform a free-form emote. Use /me to\n include yourself in the emote and /name\n to include other objects or characters.\n Use "..." to enact speech.\n\n Usage:\n emote <emote>\n :<emote\n\n Example:\n emote /me smiles at /peter\n emote /me points to /box and /lever.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ': pose', 'category': 'general', 'key': 'emote', 'no_prefix': ' : pose', 'tags': '', 'text': '\n Perform a free-form emote. Use /me to\n include yourself in the emote and /name\n to include other objects or characters.\n Use "..." to enact speech.\n\n Usage:\n emote <emote>\n :<emote\n\n Example:\n emote /me smiles at /peter\n emote /me points to /box and /lever.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdEmote.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -502,7 +502,7 @@ looks and what actions is available.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['e', 'unfocus', 'examine', 'ex']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['unfocus', 'examine', 'ex', 'e']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -531,7 +531,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'e unfocus examine ex', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' e unfocus examine ex', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'unfocus examine ex e', 'category': 'evscaperoom', 'key': 'focus', 'no_prefix': ' unfocus examine ex e', 'tags': '', 'text': '\n Focus your attention on a target.\n\n Usage:\n focus <obj>\n\n Once focusing on an object, use look to get more information about how it\n looks and what actions is available.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -593,7 +593,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['i', 'give', 'inventory', 'inv']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['give', 'i', 'inventory', 'inv']</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -617,7 +617,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'i give inventory inv', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' i give inventory inv', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'give i inventory inv', 'category': 'evscaperoom', 'key': 'get', 'no_prefix': ' give i inventory inv', 'tags': '', 'text': '\n Use focus / examine instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -757,7 +757,7 @@ try to influence the other part in the deal.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['offers', 'deal']</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['deal', 'offers']</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -783,7 +783,7 @@ try to influence the other part in the deal.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.barter.barter.CmdStatus.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'offers deal', 'category': 'trading', 'key': 'status', 'no_prefix': ' offers deal', 'tags': '', 'text': "\n show a list of the current deal\n\n Usage:\n status\n deal\n offers\n\n Shows the currently suggested offers on each sides of the deal. To\n accept the current deal, use the 'accept' command. Use 'offer' to\n change your deal. You might also want to use 'say', 'emote' etc to\n try to influence the other part in the deal.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'deal offers', 'category': 'trading', 'key': 'status', 'no_prefix': ' deal offers', 'tags': '', 'text': "\n show a list of the current deal\n\n Usage:\n status\n deal\n offers\n\n Shows the currently suggested offers on each sides of the deal. To\n accept the current deal, use the 'accept' command. Use 'offer' to\n change your deal. You might also want to use 'say', 'emote' etc to\n try to influence the other part in the deal.\n "}</em><a class="headerlink" href="#evennia.contrib.game_systems.barter.barter.CmdStatus.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -684,7 +684,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -710,7 +710,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -579,7 +579,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -599,7 +599,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -702,7 +702,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -722,7 +722,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -481,7 +481,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -501,7 +501,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -941,7 +941,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['wait', 'hold']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['hold', 'wait']</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -961,7 +961,7 @@ if there are still any actions you can take.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'wait hold', 'category': 'combat', 'key': 'pass', 'no_prefix': ' wait hold', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'hold wait', 'category': 'combat', 'key': 'pass', 'no_prefix': ' hold wait', 'tags': '', 'text': '\n Passes on your turn.\n\n Usage:\n pass\n\n When in a fight, you can use this command to end your turn early, even\n if there are still any actions you can take.\n '}</em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -655,7 +655,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -675,7 +675,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.contrib.grid.extended_room.extended_room.CmdExtendedRoomLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -734,7 +734,7 @@ commands the caller can use.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['"', "'"]</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ["'", '"']</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -765,7 +765,7 @@ commands the caller can use.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '" \'', 'category': 'general', 'key': 'say', 'no_prefix': ' " \'', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '\' "', 'category': 'general', 'key': 'say', 'no_prefix': ' \' "', 'tags': '', 'text': '\n speak as your character\n\n Usage:\n say <message>\n\n Talk to those in your current location.\n '}</em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -393,7 +393,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.combat_twitch.CmdLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_twitch.CmdLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_twitch.CmdLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -413,7 +413,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a><account&g
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.combat_twitch.CmdLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_twitch.CmdLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look <obj>\n look *<account>\n\n Observes your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_twitch.CmdLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -305,7 +305,7 @@ unwear <item></p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['unwield', 'unwear']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['unwear', 'unwield']</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
|
|
@ -329,7 +329,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'unwield unwear', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwield unwear', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove <item>\n unwield <item>\n unwear <item>\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'unwear unwield', 'category': 'general', 'key': 'remove', 'no_prefix': ' unwear unwield', 'tags': '', 'text': '\n Remove a remove a weapon/shield, armor or helmet.\n\n Usage:\n remove <item>\n unwield <item>\n unwear <item>\n\n To remove an item from the backpack, use |wdrop|n instead.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -165,7 +165,7 @@ such as when closing the lid and un-blinding a character.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'press', 'push']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press', 'push', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -194,7 +194,7 @@ check if the lid is open or closed.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button press push', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button press push', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'no_prefix': ' press push press button', 'tags': '', 'text': '\n Push the red button (lid closed)\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -264,7 +264,7 @@ check if the lid is open or closed.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['smash lid', 'break lid', 'smash']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['break lid', 'smash lid', 'smash']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -291,7 +291,7 @@ break.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'smash lid break lid smash', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' smash lid break lid smash', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'break lid smash lid smash', 'category': 'general', 'key': 'smash glass', 'no_prefix': ' break lid smash lid smash', 'tags': '', 'text': '\n Smash the protective glass.\n\n Usage:\n smash glass\n\n Try to smash the glass of the button.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdSmashGlass.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -391,7 +391,7 @@ be mutually exclusive.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'press', 'push']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press', 'push', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -420,7 +420,7 @@ set in self.parse())</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button press push', 'category': 'general', 'key': 'push button', 'no_prefix': ' press button press push', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press push press button', 'category': 'general', 'key': 'push button', 'no_prefix': ' press push press button', 'tags': '', 'text': '\n Push the red button\n\n Usage:\n push button\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -518,7 +518,7 @@ be mutually exclusive.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['feel', 'examine', 'listen', 'get', 'l', 'ex']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ex', 'l', 'get', 'examine', 'listen', 'feel']</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -544,7 +544,7 @@ be mutually exclusive.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'feel examine listen get l ex', 'category': 'general', 'key': 'look', 'no_prefix': ' feel examine listen get l ex', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ex l get examine listen feel', 'category': 'general', 'key': 'look', 'no_prefix': ' ex l get examine listen feel', 'tags': '', 'text': "\n Looking around in darkness\n\n Usage:\n look <obj>\n\n ... not that there's much to see in the dark.\n\n "}</em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -437,7 +437,7 @@ of the object. We overload it with our own version.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdLight.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['light', 'burn']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['burn', 'light']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -464,7 +464,7 @@ to sit on a “lightable” object, we operate only on self.obj.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdLight.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'light burn', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' light burn', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'burn light', 'category': 'tutorialworld', 'key': 'on', 'no_prefix': ' burn light', 'tags': '', 'text': '\n Creates light where there was none. Something to burn.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdLight.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -568,7 +568,7 @@ shift green root up/down</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['move', 'push', 'shiftroot', 'pull']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['pull', 'push', 'move', 'shiftroot']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -604,7 +604,7 @@ yellow/green - horizontal roots</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'move push shiftroot pull', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' move push shiftroot pull', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'pull push move shiftroot', 'category': 'tutorialworld', 'key': 'shift', 'no_prefix': ' pull push move shiftroot', 'tags': '', 'text': '\n Shifts roots around.\n\n Usage:\n shift blue root left/right\n shift red root left/right\n shift yellow root up/down\n shift green root up/down\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -621,7 +621,7 @@ yellow/green - horizontal roots</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['press button', 'button', 'push button']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['button', 'push button', 'press button']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -647,7 +647,7 @@ yellow/green - horizontal roots</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'press button button push button', 'category': 'tutorialworld', 'key': 'press', 'no_prefix': ' press button button push button', 'tags': '', 'text': '\n Presses a button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'button push button press button', 'category': 'tutorialworld', 'key': 'press', 'no_prefix': ' button push button press button', 'tags': '', 'text': '\n Presses a button.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -791,7 +791,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['bash', 'thrust', 'chop', 'hit', 'kill', 'slash', 'parry', 'defend', 'fight', 'stab', 'pierce']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['pierce', 'slash', 'fight', 'parry', 'defend', 'kill', 'chop', 'stab', 'thrust', 'bash', 'hit']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -817,7 +817,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'bash thrust chop hit kill slash parry defend fight stab pierce', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' bash thrust chop hit kill slash parry defend fight stab pierce', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'pierce slash fight parry defend kill chop stab thrust bash hit', 'category': 'tutorialworld', 'key': 'attack', 'no_prefix': ' pierce slash fight parry defend kill chop stab thrust bash hit', 'tags': '', 'text': '\n Attack the enemy. Commands:\n\n stab <enemy>\n slash <enemy>\n parry\n\n stab - (thrust) makes a lot of damage but is harder to hit with.\n slash - is easier to land, but does not make as much damage.\n parry - forgoes your attack but will make you harder to hit on next\n enemy attack.\n\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -260,7 +260,7 @@ code except for adding in the details.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -275,7 +275,7 @@ code except for adding in the details.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' ls l', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at "details" in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' l ls', 'tags': '', 'text': '\n looks at the room and on details\n\n Usage:\n look <obj>\n look <room detail>\n look *<account>\n\n Observes your location, details at your location or objects\n in your vicinity.\n\n Tutorial: This is a child of the default Look command, that also\n allows us to look at "details" in the room. These details are\n things to examine and offers some extra description without\n actually having to be actual database objects. It uses the\n return_detail() hook on TutorialRooms for this.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdTutorialLook.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -828,7 +828,7 @@ if they fall off the bridge.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['?', 'h']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['h', '?']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -854,7 +854,7 @@ if they fall off the bridge.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '? h', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' ? h', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'h ?', 'category': 'tutorial world', 'key': 'help', 'no_prefix': ' h ?', 'tags': '', 'text': '\n Overwritten help command while on the bridge.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -980,7 +980,7 @@ to find something.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['feel', 'fiddle', 'feel around', 'l', 'search']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['feel around', 'search', 'l', 'fiddle', 'feel']</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -1008,7 +1008,7 @@ random chance of eventually finding a light source.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'feel fiddle feel around l search', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' feel fiddle feel around l search', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'feel around search l fiddle feel', 'category': 'tutorialworld', 'key': 'look', 'no_prefix': ' feel around search l fiddle feel', 'tags': '', 'text': '\n Look around in darkness\n\n Usage:\n look\n\n Look around in the darkness, trying\n to find something.\n '}</em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdLookDark.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -220,7 +220,7 @@ git evennia pull - Pull the latest evennia code.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.directory">
|
||||
<code class="sig-name descname">directory</code><em class="property"> = '/tmp/tmpuchruimt/772d4c21b5716c3f29d3307f2a078439169ae53c/evennia'</em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.directory" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">directory</code><em class="property"> = '/tmp/tmppnsswh9b/0edcebea0fdd67c4ba5c58f3b0d589b02a6bea3e/evennia'</em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.directory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -281,7 +281,7 @@ git pull - Pull the latest code from your current branch.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.contrib.utils.git_integration.git_integration.CmdGit.directory">
|
||||
<code class="sig-name descname">directory</code><em class="property"> = '/tmp/tmpuchruimt/772d4c21b5716c3f29d3307f2a078439169ae53c/evennia/game_template'</em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.directory" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">directory</code><em class="property"> = '/tmp/tmppnsswh9b/0edcebea0fdd67c4ba5c58f3b0d589b02a6bea3e/evennia/game_template'</em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.directory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
|
|||
|
|
@ -348,7 +348,7 @@ indentation.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.eveditor.CmdEditorGroup.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':fi', ':echo', ':p', ':y', ':fd', ':A', ':r', ':UU', ':i', ':wq', ':', ':w', ':q', ':u', ':DD', ':uu', ':>', ':q!', ':dd', ':dw', ':x', ':j', ':s', ':S', ':::', ':h', ':!', ':f', ':<', ':I', ':=', '::']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = [':uu', ':>', ':q!', ':y', ':p', ':!', ':', ':i', ':u', ':DD', ':<', ':q', ':f', ':h', ':=', ':fi', ':w', ':s', ':x', ':j', ':S', ':dd', ':echo', ':r', '::', ':UU', ':A', ':I', ':::', ':dw', ':fd', ':wq']</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -376,7 +376,7 @@ efficient presentation.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.eveditor.CmdEditorGroup.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ':fi :echo :p :y :fd :A :r :UU :i :wq : :w :q :u :DD :uu :> :q! :dd :dw :x :j :s :S ::: :h :! :f :< :I := ::', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :fi :echo :p :y :fd :A :r :UU :i :wq : :w :q :u :DD :uu :> :q! :dd :dw :x :j :s :S ::: :h :! :f :< :I := ::', 'tags': '', 'text': '\n Commands for the editor\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ':uu :> :q! :y :p :! : :i :u :DD :< :q :f :h := :fi :w :s :x :j :S :dd :echo :r :: :UU :A :I ::: :dw :fd :wq', 'category': 'general', 'key': ':editor_command_group', 'no_prefix': ' :uu :> :q! :y :p :! : :i :u :DD :< :q :f :h := :fi :w :s :x :j :S :dd :echo :r :: :UU :A :I ::: :dw :fd :wq', 'tags': '', 'text': '\n Commands for the editor\n '}</em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -951,7 +951,7 @@ single question.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmenu.CmdYesNoQuestion.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['yes', 'abort', 'y', '__nomatch_command', 'no', 'a', 'n']</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['abort', 'no', '__nomatch_command', 'y', 'yes', 'a', 'n']</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -977,7 +977,7 @@ single question.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'yes abort y __nomatch_command no a n', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' yes abort y __nomatch_command no a n', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'abort no __nomatch_command y yes a n', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' abort no __nomatch_command y yes a n', 'tags': '', 'text': '\n Handle a prompt for yes or no. Press [return] for the default choice.\n\n '}</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -149,7 +149,7 @@ the <strong>caller.msg()</strong> construct every time the page is updated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmore.CmdMore.aliases">
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['next', 'quit', 'end', 'abort', 't', 'previous', 'top', 'q', 'e', 'a', 'p', 'n']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">aliases</code><em class="property"> = ['end', 'abort', 'quit', 'top', 't', 'q', 'e', 'p', 'next', 'previous', 'a', 'n']</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
|
|
@ -175,7 +175,7 @@ the <strong>caller.msg()</strong> construct every time the page is updated.</p>
|
|||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.utils.evmore.CmdMore.search_index_entry">
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'next quit end abort t previous top q e a p n', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' next quit end abort t previous top q e a p n', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'end abort quit top t q e p next previous a n', 'category': 'general', 'key': '__noinput_command', 'no_prefix': ' end abort quit top t q e p next previous a n', 'tags': '', 'text': '\n Manipulate the text paging. Catch no-input with aliases.\n '}</em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -143,6 +143,8 @@
|
|||
<li><a href="api/evennia.contrib.base_systems.building_menu.building_menu.html#evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch.__init__">(evennia.contrib.base_systems.building_menu.building_menu.CmdNoMatch method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.__init__">(evennia.contrib.base_systems.components.component.Component method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.DBField.__init__">(evennia.contrib.base_systems.components.dbfield.DBField method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.TagField.__init__">(evennia.contrib.base_systems.components.dbfield.TagField method)</a>
|
||||
</li>
|
||||
|
|
@ -756,6 +758,8 @@
|
|||
<li><a href="api/evennia.contrib.grid.extended_room.extended_room.html#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.add_detail">add_detail() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.ingame_python.scripts.html#evennia.contrib.base_systems.ingame_python.scripts.EventHandler.add_event">add_event() (evennia.contrib.base_systems.ingame_python.scripts.EventHandler method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.add_field">add_field() (evennia.contrib.base_systems.components.component.Component class method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.web.admin.accounts.html#evennia.web.admin.accounts.AccountAdmin.add_fieldsets">add_fieldsets (evennia.web.admin.accounts.AccountAdmin attribute)</a>
|
||||
|
||||
|
|
@ -1599,12 +1603,12 @@
|
|||
</li>
|
||||
<li><a href="api/evennia.contrib.tutorials.evadventure.chargen.html#evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet.apply">apply() (evennia.contrib.tutorials.evadventure.chargen.TemporaryCharacterSheet method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.contrib.game_systems.turnbattle.tb_basic.html#evennia.contrib.game_systems.turnbattle.tb_basic.BasicCombatRules.apply_damage">apply_damage() (evennia.contrib.game_systems.turnbattle.tb_basic.BasicCombatRules method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.game_systems.turnbattle.tb_items.html#evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter.apply_turn_conditions">apply_turn_conditions() (evennia.contrib.game_systems.turnbattle.tb_items.TBItemsCharacter method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.contrib.game_systems.turnbattle.tb_range.html#evennia.contrib.game_systems.turnbattle.tb_range.RangedCombatRules.approach">approach() (evennia.contrib.game_systems.turnbattle.tb_range.RangedCombatRules method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.commands.command.html#evennia.commands.command.Command.arg_regex">arg_regex (evennia.commands.command.Command attribute)</a>
|
||||
|
|
@ -1740,7 +1744,15 @@
|
|||
<li><a href="api/evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount.at_account_creation">at_account_creation() (evennia.accounts.accounts.DefaultAccount method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.at_added">at_added() (evennia.contrib.base_systems.components.component.Component method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.DBField.at_added">(evennia.contrib.base_systems.components.dbfield.DBField method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.NDBField.at_added">(evennia.contrib.base_systems.components.dbfield.NDBField method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.TagField.at_added">(evennia.contrib.base_systems.components.dbfield.TagField method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultCharacter.at_after_move">at_after_move() (evennia.objects.objects.DefaultCharacter method)</a>
|
||||
|
||||
<ul>
|
||||
|
|
@ -2554,7 +2566,15 @@
|
|||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.at_removed">at_removed() (evennia.contrib.base_systems.components.component.Component method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.DBField.at_removed">(evennia.contrib.base_systems.components.dbfield.DBField method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.NDBField.at_removed">(evennia.contrib.base_systems.components.dbfield.NDBField method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.dbfield.html#evennia.contrib.base_systems.components.dbfield.TagField.at_removed">(evennia.contrib.base_systems.components.dbfield.TagField method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject.at_rename">at_rename() (evennia.typeclasses.models.TypedObject method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.accounts.bots.html#evennia.accounts.bots.BotStarter.at_repeat">at_repeat() (evennia.accounts.bots.BotStarter method)</a>
|
||||
|
|
@ -2952,6 +2972,8 @@
|
|||
<li><a href="api/evennia.contrib.full_systems.evscaperoom.objects.html#evennia.contrib.full_systems.evscaperoom.objects.BaseApplicable.MultipleObjectsReturned">BaseApplicable.MultipleObjectsReturned</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.rpg.buffs.buff.html#evennia.contrib.rpg.buffs.buff.BaseBuff">BaseBuff (class in evennia.contrib.rpg.buffs.buff)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.BaseComponent">BaseComponent (class in evennia.contrib.base_systems.components.component)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.full_systems.evscaperoom.objects.html#evennia.contrib.full_systems.evscaperoom.objects.BaseConsumable">BaseConsumable (class in evennia.contrib.full_systems.evscaperoom.objects)</a>
|
||||
</li>
|
||||
|
|
@ -2991,12 +3013,8 @@
|
|||
</li>
|
||||
<li><a href="api/evennia.contrib.full_systems.evscaperoom.state.html#evennia.contrib.full_systems.evscaperoom.state.BaseState">BaseState (class in evennia.contrib.full_systems.evscaperoom.state)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHolderMixin.basetype_posthook_setup">basetype_posthook_setup() (evennia.contrib.base_systems.components.holder.ComponentHolderMixin method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject.basetype_posthook_setup">(evennia.objects.objects.DefaultObject method)</a>
|
||||
<li><a href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultObject.basetype_posthook_setup">basetype_posthook_setup() (evennia.objects.objects.DefaultObject method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount.basetype_setup">basetype_setup() (evennia.accounts.accounts.DefaultAccount method)</a>
|
||||
|
||||
<ul>
|
||||
|
|
@ -3434,6 +3452,8 @@
|
|||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.web.website.views.characters.html#evennia.web.website.views.characters.CharacterMixin">CharacterMixin (class in evennia.web.website.views.characters)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents">CharacterMixinWithComponents (class in evennia.contrib.base_systems.components.tests)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.web.website.tests.html#evennia.web.website.tests.CharacterPuppetView">CharacterPuppetView (class in evennia.web.website.tests)</a>
|
||||
|
||||
|
|
@ -4041,12 +4061,12 @@
|
|||
</li>
|
||||
<li><a href="api/evennia.commands.default.comms.html#evennia.commands.default.comms.CmdObjectChannel">CmdObjectChannel (class in evennia.commands.default.comms)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.commands.default.building.html#evennia.commands.default.building.CmdObjects">CmdObjects (class in evennia.commands.default.building)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.game_systems.barter.barter.html#evennia.contrib.game_systems.barter.barter.CmdOffer">CmdOffer (class in evennia.contrib.game_systems.barter.barter)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.commands.default.account.html#evennia.commands.default.account.CmdOOC">CmdOOC (class in evennia.commands.default.account)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.commands.default.account.html#evennia.commands.default.account.CmdOOCLook">CmdOOCLook (class in evennia.commands.default.account)</a>
|
||||
|
|
@ -4547,23 +4567,19 @@
|
|||
<li><a href="api/evennia.utils.logger.html#evennia.utils.logger.GetServerLogObserver.component_prefix">(evennia.utils.logger.GetServerLogObserver attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentDoesNotExist">ComponentDoesNotExist</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHandler">ComponentHandler (class in evennia.contrib.base_systems.components.holder)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHolderMixin">ComponentHolderMixin (class in evennia.contrib.base_systems.components.holder)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentIsNotRegistered">ComponentIsNotRegistered</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentProperty">ComponentProperty (class in evennia.contrib.base_systems.components.holder)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.ComponentRegisterError">ComponentRegisterError</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.holder.html#evennia.contrib.base_systems.components.holder.ComponentHolderMixin.components">components() (evennia.contrib.base_systems.components.holder.ComponentHolderMixin property)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestA">ComponentTestA (class in evennia.contrib.base_systems.components.tests)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestB">ComponentTestB (class in evennia.contrib.base_systems.components.tests)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestD">ComponentTestD (class in evennia.contrib.base_systems.components.tests)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentWithSignal">ComponentWithSignal (class in evennia.contrib.base_systems.components.tests)</a>
|
||||
</li>
|
||||
|
|
@ -5120,8 +5136,6 @@
|
|||
<li><a href="api/evennia.objects.models.html#evennia.objects.models.ObjectDB.db_destination_id">db_destination_id (evennia.objects.models.ObjectDB attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.help.models.html#evennia.help.models.HelpEntry.db_entrytext">db_entrytext (evennia.help.models.HelpEntry attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.db_field_names">db_field_names() (evennia.contrib.base_systems.components.component.Component property)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.comms.models.html#evennia.comms.models.Msg.db_header">db_header (evennia.comms.models.Msg attribute)</a>
|
||||
</li>
|
||||
|
|
@ -5457,10 +5471,10 @@
|
|||
</li>
|
||||
<li><a href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultRoom.DoesNotExist">DefaultRoom.DoesNotExist</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.objects.objects.html#evennia.objects.objects.DefaultRoom.MultipleObjectsReturned">DefaultRoom.MultipleObjectsReturned</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript">DefaultScript (class in evennia.scripts.scripts)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.scripts.scripts.html#evennia.scripts.scripts.DefaultScript.DoesNotExist">DefaultScript.DoesNotExist</a>
|
||||
|
|
@ -10588,7 +10602,7 @@
|
|||
<li><a href="api/evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand.get_command_info">(evennia.commands.default.muxcommand.MuxCommand method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.html#evennia.contrib.base_systems.components.get_component_class">get_component_class() (in module evennia.contrib.base_systems.components)</a>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.get_component_slot">get_component_slot() (evennia.contrib.base_systems.components.component.Component class method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.grid.xyzgrid.xymap.html#evennia.contrib.grid.xyzgrid.xymap.XYMap.get_components_with_symbol">get_components_with_symbol() (evennia.contrib.grid.xyzgrid.xymap.XYMap method)</a>
|
||||
</li>
|
||||
|
|
@ -10774,6 +10788,8 @@
|
|||
<li><a href="api/evennia.typeclasses.models.html#evennia.typeclasses.models.TypedObject.get_extra_info">(evennia.typeclasses.models.TypedObject method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.get_fields">get_fields() (evennia.contrib.base_systems.components.component.Component class method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.web.admin.objects.html#evennia.web.admin.objects.ObjectAdmin.get_fieldsets">get_fieldsets() (evennia.web.admin.objects.ObjectAdmin method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.web.admin.accounts.html#evennia.web.admin.accounts.AccountAdmin.get_form">get_form() (evennia.web.admin.accounts.AccountAdmin method)</a>
|
||||
|
|
@ -12016,6 +12032,26 @@
|
|||
</li>
|
||||
<li><a href="api/evennia.prototypes.prototypes.html#evennia.prototypes.prototypes.homogenize_prototype">homogenize_prototype() (in module evennia.prototypes.prototypes)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.host">host (evennia.contrib.base_systems.components.component.Component attribute)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestA.host">(evennia.contrib.base_systems.components.tests.ComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestB.host">(evennia.contrib.base_systems.components.tests.ComponentTestB attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestD.host">(evennia.contrib.base_systems.components.tests.ComponentTestD attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentWithSignal.host">(evennia.contrib.base_systems.components.tests.ComponentWithSignal attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.InheritedComponentTestA.host">(evennia.contrib.base_systems.components.tests.InheritedComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.host">(evennia.contrib.base_systems.components.tests.ReplacementComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.RuntimeComponentTestC.host">(evennia.contrib.base_systems.components.tests.RuntimeComponentTestC attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ShadowedComponentTestA.host">(evennia.contrib.base_systems.components.tests.ShadowedComponentTestA attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.utils.utils.html#evennia.utils.utils.host_os_is">host_os_is() (in module evennia.utils.utils)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.grid.extended_room.extended_room.html#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.hours_per_day">hours_per_day (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom attribute)</a>
|
||||
|
|
@ -12050,6 +12086,14 @@
|
|||
</li>
|
||||
<li><a href="api/evennia.typeclasses.attributes.html#evennia.typeclasses.attributes.IAttributeBackend">IAttributeBackend (class in evennia.typeclasses.attributes)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents.ic_a">ic_a (evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents attribute)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.CharacterWithComponents.ic_a">(evennia.contrib.base_systems.components.tests.CharacterWithComponents attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin.ic_a">(evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.accounts.models.html#evennia.accounts.models.AccountDB.id">id (evennia.accounts.models.AccountDB attribute)</a>
|
||||
|
||||
<ul>
|
||||
|
|
@ -12135,6 +12179,8 @@
|
|||
<li><a href="api/evennia.contrib.tutorials.talking_npc.talking_npc.html#evennia.contrib.tutorials.talking_npc.talking_npc.info3">info3() (in module evennia.contrib.tutorials.talking_npc.talking_npc)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.full_systems.evscaperoom.objects.html#evennia.contrib.full_systems.evscaperoom.objects.Mixable.ingredient_recipe">ingredient_recipe (evennia.contrib.full_systems.evscaperoom.objects.Mixable attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.InheritedComponentTestA">InheritedComponentTestA (class in evennia.contrib.base_systems.components.tests)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.InheritedTCWithComponents">InheritedTCWithComponents (class in evennia.contrib.base_systems.components.tests)</a>
|
||||
</li>
|
||||
|
|
@ -12234,10 +12280,10 @@
|
|||
<li><a href="api/evennia.web.admin.scripts.html#evennia.web.admin.scripts.ScriptAdmin.inlines">(evennia.web.admin.scripts.ScriptAdmin attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.web.admin.tags.html#evennia.web.admin.tags.InlineTagForm">InlineTagForm (class in evennia.web.admin.tags)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.web.admin.tags.html#evennia.web.admin.tags.InlineTagForm">InlineTagForm (class in evennia.web.admin.tags)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.web.admin.tags.html#evennia.web.admin.tags.InlineTagForm.Meta">InlineTagForm.Meta (class in evennia.web.admin.tags)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.typeclasses.attributes.html#evennia.typeclasses.attributes.InMemoryAttribute">InMemoryAttribute (class in evennia.typeclasses.attributes)</a>
|
||||
|
|
@ -14821,6 +14867,8 @@
|
|||
<li><a href="api/evennia.contrib.full_systems.evscaperoom.objects.html#evennia.contrib.full_systems.evscaperoom.objects.Mixable.DoesNotExist">Mixable.DoesNotExist</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.full_systems.evscaperoom.objects.html#evennia.contrib.full_systems.evscaperoom.objects.Mixable.MultipleObjectsReturned">Mixable.MultipleObjectsReturned</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestD.mixed_in">mixed_in (evennia.contrib.base_systems.components.tests.ComponentTestD attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.full_systems.evscaperoom.objects.html#evennia.contrib.full_systems.evscaperoom.objects.Mixable.mixer_flag">mixer_flag (evennia.contrib.full_systems.evscaperoom.objects.Mixable attribute)</a>
|
||||
</li>
|
||||
|
|
@ -15965,6 +16013,8 @@
|
|||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestB.my_list">(evennia.contrib.base_systems.components.tests.ComponentTestB attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.InheritedComponentTestA.my_other_int">my_other_int (evennia.contrib.base_systems.components.tests.InheritedComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.CharWithSignal.my_other_response">my_other_response() (evennia.contrib.base_systems.components.tests.CharWithSignal method)</a>
|
||||
|
||||
<ul>
|
||||
|
|
@ -16001,10 +16051,18 @@
|
|||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestA.name">(evennia.contrib.base_systems.components.tests.ComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestB.name">(evennia.contrib.base_systems.components.tests.ComponentTestB attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentTestD.name">(evennia.contrib.base_systems.components.tests.ComponentTestD attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ComponentWithSignal.name">(evennia.contrib.base_systems.components.tests.ComponentWithSignal attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.InheritedComponentTestA.name">(evennia.contrib.base_systems.components.tests.InheritedComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.name">(evennia.contrib.base_systems.components.tests.ReplacementComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.RuntimeComponentTestC.name">(evennia.contrib.base_systems.components.tests.RuntimeComponentTestC attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ShadowedComponentTestA.name">(evennia.contrib.base_systems.components.tests.ShadowedComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.ingame_python.callbackhandler.html#evennia.contrib.base_systems.ingame_python.callbackhandler.Callback.name">(evennia.contrib.base_systems.ingame_python.callbackhandler.Callback attribute)</a>
|
||||
</li>
|
||||
|
|
@ -16102,8 +16160,6 @@
|
|||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.server.serversession.html#evennia.server.serversession.ServerSession.ndb_del">ndb_del() (evennia.server.serversession.ServerSession method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.ndb_field_names">ndb_field_names() (evennia.contrib.base_systems.components.component.Component property)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.server.serversession.html#evennia.server.serversession.ServerSession.ndb_get">ndb_get() (evennia.server.serversession.ServerSession method)</a>
|
||||
</li>
|
||||
|
|
@ -16183,12 +16239,12 @@
|
|||
<li><a href="api/evennia.utils.evmenu.html#evennia.utils.evmenu.YesNoQuestionCmdSet.no_exits">(evennia.utils.evmenu.YesNoQuestionCmdSet attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.server.portal.telnet_oob.html#evennia.server.portal.telnet_oob.TelnetOOB.no_gmcp">no_gmcp() (evennia.server.portal.telnet_oob.TelnetOOB method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.server.portal.mccp.html#evennia.server.portal.mccp.Mccp.no_mccp">no_mccp() (evennia.server.portal.mccp.Mccp method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.server.portal.telnet_oob.html#evennia.server.portal.telnet_oob.TelnetOOB.no_msdp">no_msdp() (evennia.server.portal.telnet_oob.TelnetOOB method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.server.portal.mssp.html#evennia.server.portal.mssp.Mssp.no_mssp">no_mssp() (evennia.server.portal.mssp.Mssp method)</a>
|
||||
|
|
@ -18245,10 +18301,10 @@
|
|||
<li><a href="api/evennia.utils.utils.html#evennia.utils.utils.repeat">(in module evennia.utils.utils)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.contrib.grid.extended_room.extended_room.html#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.repeat_broadcast_message_to_room">repeat_broadcast_message_to_room() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.scripts.models.html#evennia.scripts.models.ScriptDB.repeats">repeats() (evennia.scripts.models.ScriptDB property)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.locks.lockhandler.html#evennia.locks.lockhandler.LockHandler.replace">replace() (evennia.locks.lockhandler.LockHandler method)</a>
|
||||
|
|
@ -18262,6 +18318,10 @@
|
|||
<li><a href="api/evennia.utils.evtable.html#evennia.utils.evtable.EvCell.replace_data">replace_data() (evennia.utils.evtable.EvCell method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.grid.extended_room.extended_room.html#evennia.contrib.grid.extended_room.extended_room.ExtendedRoom.replace_legacy_time_of_day_markup">replace_legacy_time_of_day_markup() (evennia.contrib.grid.extended_room.extended_room.ExtendedRoom method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.replacement_field">replacement_field (evennia.contrib.base_systems.components.tests.ReplacementComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA">ReplacementComponentTestA (class in evennia.contrib.base_systems.components.tests)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.utils.git_integration.git_integration.html#evennia.contrib.utils.git_integration.git_integration.CmdGit.repo_type">repo_type (evennia.contrib.utils.git_integration.git_integration.CmdGit attribute)</a>
|
||||
|
||||
|
|
@ -19627,8 +19687,6 @@
|
|||
<li><a href="api/evennia.utils.optionclasses.html#evennia.utils.optionclasses.Timezone.serialize">(evennia.utils.optionclasses.Timezone method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.web.admin.accounts.html#evennia.web.admin.accounts.AccountAdmin.serialized_string">serialized_string() (evennia.web.admin.accounts.AccountAdmin method)</a>
|
||||
|
||||
<ul>
|
||||
|
|
@ -19641,6 +19699,8 @@
|
|||
<li><a href="api/evennia.web.admin.scripts.html#evennia.web.admin.scripts.ScriptAdmin.serialized_string">(evennia.web.admin.scripts.ScriptAdmin method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.web.api.views.html#evennia.web.api.views.AccountDBViewSet.serializer_class">serializer_class (evennia.web.api.views.AccountDBViewSet attribute)</a>
|
||||
|
||||
<ul>
|
||||
|
|
@ -19959,6 +20019,10 @@
|
|||
<li><a href="api/evennia.utils.test_resources.html#evennia.utils.test_resources.EvenniaTestMixin.setup_session">(evennia.utils.test_resources.EvenniaTestMixin method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ShadowedCharacterMixin">ShadowedCharacterMixin (class in evennia.contrib.base_systems.components.tests)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ShadowedComponentTestA">ShadowedComponentTestA (class in evennia.contrib.base_systems.components.tests)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.web.api.serializers.html#evennia.web.api.serializers.TypeclassListSerializerMixin.shared_fields">shared_fields (evennia.web.api.serializers.TypeclassListSerializerMixin attribute)</a>
|
||||
|
||||
<ul>
|
||||
|
|
@ -20071,6 +20135,16 @@
|
|||
</li>
|
||||
<li><a href="api/evennia.commands.default.account.html#evennia.commands.default.account.CmdColorTest.slice_dark_fg">slice_dark_fg (evennia.commands.default.account.CmdColorTest attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.slot">slot (evennia.contrib.base_systems.components.component.Component attribute)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.InheritedComponentTestA.slot">(evennia.contrib.base_systems.components.tests.InheritedComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ReplacementComponentTestA.slot">(evennia.contrib.base_systems.components.tests.ReplacementComponentTestA attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.ShadowedComponentTestA.slot">(evennia.contrib.base_systems.components.tests.ShadowedComponentTestA attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="api/evennia.contrib.grid.slow_exit.slow_exit.html#evennia.contrib.grid.slow_exit.slow_exit.SlowExit">SlowExit (class in evennia.contrib.grid.slow_exit.slow_exit)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.grid.slow_exit.slow_exit.html#evennia.contrib.grid.slow_exit.slow_exit.SlowExit.DoesNotExist">SlowExit.DoesNotExist</a>
|
||||
|
|
@ -20672,8 +20746,6 @@
|
|||
<li><a href="api/evennia.contrib.full_systems.evscaperoom.room.html#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.tag_all_characters">tag_all_characters() (evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.full_systems.evscaperoom.room.html#evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom.tag_character">tag_character() (evennia.contrib.full_systems.evscaperoom.room.EvscapeRoom method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.component.html#evennia.contrib.base_systems.components.component.Component.tag_field_names">tag_field_names() (evennia.contrib.base_systems.components.component.Component property)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.web.api.filters.html#evennia.web.api.filters.AliasFilter.tag_type">tag_type (evennia.web.api.filters.AliasFilter attribute)</a>
|
||||
|
||||
|
|
@ -21234,6 +21306,8 @@
|
|||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_character_assigns_default_value">test_character_assigns_default_value() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_character_can_register_runtime_component">test_character_can_register_runtime_component() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_character_has_autocreated_values">test_character_has_autocreated_values() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_character_has_class_components">test_character_has_class_components() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
|
|
@ -21342,6 +21416,10 @@
|
|||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_component_handler_signals_disconnected_when_removing_component">test_component_handler_signals_disconnected_when_removing_component() (evennia.contrib.base_systems.components.tests.TestComponentSignals method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponentSignals.test_component_handler_signals_disconnected_when_removing_component_by_name">test_component_handler_signals_disconnected_when_removing_component_by_name() (evennia.contrib.base_systems.components.tests.TestComponentSignals method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_component_inheritance_assigns_proper_values">test_component_inheritance_assigns_proper_values() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_component_inheritance_properly_overrides_slots">test_component_inheritance_properly_overrides_slots() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_component_tags_default_value_is_overridden_when_enforce_single">test_component_tags_default_value_is_overridden_when_enforce_single() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
|
|
@ -21428,6 +21506,8 @@
|
|||
<li><a href="api/evennia.contrib.base_systems.custom_gametime.tests.html#evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime.test_custom_gametime">test_custom_gametime() (evennia.contrib.base_systems.custom_gametime.tests.TestCustomGameTime method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.mux_comms_cmds.tests.html#evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms.test_cwho">test_cwho() (evennia.contrib.base_systems.mux_comms_cmds.tests.TestLegacyMuxComms method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents.test_d">test_d (evennia.contrib.base_systems.components.tests.CharacterMixinWithComponents attribute)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.tutorials.tutorial_world.tests.html#evennia.contrib.tutorials.tutorial_world.tests.TestTutorialWorldRooms.test_darkroom">test_darkroom() (evennia.contrib.tutorials.tutorial_world.tests.TestTutorialWorldRooms method)</a>
|
||||
</li>
|
||||
|
|
@ -21880,6 +21960,8 @@
|
|||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_host_has_added_default_component_tags">test_host_has_added_default_component_tags() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_host_has_class_component_tags">test_host_has_class_component_tags() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_host_mixins_assigns_components">test_host_mixins_assigns_components() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_host_remove_by_name_component_tags">test_host_remove_by_name_component_tags() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
|
|
@ -22048,6 +22130,8 @@
|
|||
<li><a href="api/evennia.contrib.base_systems.building_menu.tests.html#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_multi_level">test_multi_level() (evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.commands.default.tests.html#evennia.commands.default.tests.TestSystemCommands.test_multimatch">test_multimatch() (evennia.commands.default.tests.TestSystemCommands method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_mutables_are_not_shared_when_autocreate">test_mutables_are_not_shared_when_autocreate() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.commands.default.tests.html#evennia.commands.default.tests.TestGeneral.test_mux_command">test_mux_command() (evennia.commands.default.tests.TestGeneral method)</a>
|
||||
</li>
|
||||
|
|
@ -22248,6 +22332,8 @@
|
|||
<li><a href="api/evennia.contrib.tutorials.evadventure.tests.test_equipment.html#evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment.test_remove__with_slot">test_remove__with_slot() (evennia.contrib.tutorials.evadventure.tests.test_equipment.TestEquipment method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.tutorials.evadventure.tests.test_combat.html#evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest.test_remove_combatant">test_remove_combatant() (evennia.contrib.tutorials.evadventure.tests.test_combat.EvAdventureTurnbasedCombatHandlerTest method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents.test_replacing_class_component_slot_with_runtime_component">test_replacing_class_component_slot_with_runtime_component() (evennia.contrib.base_systems.components.tests.TestComponents method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.rpg.traits.tests.html#evennia.contrib.rpg.traits.tests.TestTrait.test_repr">test_repr() (evennia.contrib.rpg.traits.tests.TestTrait method)</a>
|
||||
</li>
|
||||
|
|
@ -22337,6 +22423,8 @@
|
|||
</li>
|
||||
<li><a href="api/evennia.contrib.base_systems.building_menu.tests.html#evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu.test_setattr">test_setattr() (evennia.contrib.base_systems.building_menu.tests.TestBuildingMenu method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.contrib.game_systems.gendersub.tests.html#evennia.contrib.game_systems.gendersub.tests.TestGenderSub.test_setgender">test_setgender() (evennia.contrib.game_systems.gendersub.tests.TestGenderSub method)</a>
|
||||
</li>
|
||||
<li><a href="api/evennia.contrib.rpg.traits.tests.html#evennia.contrib.rpg.traits.tests.TraitHandlerTest.test_setting">test_setting() (evennia.contrib.rpg.traits.tests.TraitHandlerTest method)</a>
|
||||
|
|
@ -22365,8 +22453,6 @@
|
|||
<li><a href="api/evennia.contrib.grid.xyzgrid.tests.html#evennia.contrib.grid.xyzgrid.tests.TestXYZGridTransition.test_shortest_path">(evennia.contrib.grid.xyzgrid.tests.TestXYZGridTransition attribute)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api/evennia.contrib.grid.xyzgrid.tests.html#evennia.contrib.grid.xyzgrid.tests.TestMap10.test_shortest_path_0">test_shortest_path_0() (evennia.contrib.grid.xyzgrid.tests.TestMap10 method)</a>
|
||||
|
||||
<ul>
|
||||
|
|
|
|||
Binary file not shown.
File diff suppressed because one or more lines are too long
Loading…
Add table
Add a link
Reference in a new issue