Updated HTML docs.

This commit is contained in:
Evennia docbuilder action 2023-04-08 16:20:21 +00:00
parent c2adb35cf8
commit 3fffc502a4
32 changed files with 171 additions and 101 deletions

View file

@ -115,9 +115,11 @@
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Cannot set a class property&quot;</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="n">name</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="n">owner</span><span class="p">,</span> <span class="s2">&quot;_class_components&quot;</span><span class="p">,</span> <span class="kc">None</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">&quot;_class_components&quot;</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="n">class_components</span> <span class="o">=</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">&quot;_class_components&quot;</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">&quot;_class_components&quot;</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>

View file

@ -121,6 +121,10 @@
<span class="n">test_b</span> <span class="o">=</span> <span class="n">ComponentProperty</span><span class="p">(</span><span class="s2">&quot;test_b&quot;</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>
<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>
<span class="n">test_c</span> <span class="o">=</span> <span class="n">ComponentProperty</span><span class="p">(</span><span class="s2">&quot;test_c&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="TestComponents"><a class="viewcode-back" href="../../../../../api/evennia.contrib.base_systems.components.tests.html#evennia.contrib.base_systems.components.tests.TestComponents">[docs]</a><span class="k">class</span> <span class="nc">TestComponents</span><span class="p">(</span><span class="n">EvenniaTest</span><span class="p">):</span>
<span class="n">character_typeclass</span> <span class="o">=</span> <span class="n">CharacterWithComponents</span>
@ -128,6 +132,14 @@
<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>
<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">&quot;char_with_c&quot;</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="s1">&#39;test_c&#39;</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>
<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>