Updated HTML docs

This commit is contained in:
Evennia docbuilder action 2022-11-01 22:34:03 +00:00
parent 44455e811a
commit f01d69229f
49 changed files with 159 additions and 154 deletions

View file

@ -226,11 +226,12 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">from</span> <span class="nn">string</span> <span class="kn">import</span> <span class="n">punctuation</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="kn">from</span> <span class="nn">evennia.objects.objects</span> <span class="kn">import</span> <span class="n">DefaultObject</span><span class="p">,</span> <span class="n">DefaultCharacter</span>
<span class="kn">from</span> <span class="nn">evennia.objects.models</span> <span class="kn">import</span> <span class="n">ObjectDB</span>
<span class="kn">from</span> <span class="nn">evennia.commands.command</span> <span class="kn">import</span> <span class="n">Command</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.commands.command</span> <span class="kn">import</span> <span class="n">Command</span>
<span class="kn">from</span> <span class="nn">evennia.objects.models</span> <span class="kn">import</span> <span class="n">ObjectDB</span>
<span class="kn">from</span> <span class="nn">evennia.objects.objects</span> <span class="kn">import</span> <span class="n">DefaultCharacter</span><span class="p">,</span> <span class="n">DefaultObject</span>
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="kn">import</span> <span class="n">ansi</span><span class="p">,</span> <span class="n">logger</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">lazy_property</span><span class="p">,</span> <span class="n">make_iter</span><span class="p">,</span> <span class="n">variable_from_module</span>
@ -395,7 +396,9 @@
<span class="k">return</span> <span class="n">emote</span><span class="p">,</span> <span class="n">mapping</span></div>
<div class="viewcode-block" id="parse_sdescs_and_recogs"><a class="viewcode-back" href="../../../../../api/evennia.contrib.rpg.rpsystem.rpsystem.html#evennia.contrib.rpg.rpsystem.rpsystem.parse_sdescs_and_recogs">[docs]</a><span class="k">def</span> <span class="nf">parse_sdescs_and_recogs</span><span class="p">(</span><span class="n">sender</span><span class="p">,</span> <span class="n">candidates</span><span class="p">,</span> <span class="n">string</span><span class="p">,</span> <span class="n">search_mode</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">case_sensitive</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">fallback</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<div class="viewcode-block" id="parse_sdescs_and_recogs"><a class="viewcode-back" href="../../../../../api/evennia.contrib.rpg.rpsystem.rpsystem.html#evennia.contrib.rpg.rpsystem.rpsystem.parse_sdescs_and_recogs">[docs]</a><span class="k">def</span> <span class="nf">parse_sdescs_and_recogs</span><span class="p">(</span>
<span class="n">sender</span><span class="p">,</span> <span class="n">candidates</span><span class="p">,</span> <span class="n">string</span><span class="p">,</span> <span class="n">search_mode</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">case_sensitive</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">fallback</span><span class="o">=</span><span class="kc">None</span>
<span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Read a raw emote and parse it into an intermediary</span>
<span class="sd"> format for distributing to all observers.</span>
@ -414,7 +417,8 @@
<span class="sd"> a little more to learn for players. If disabled, the original sdesc case</span>
<span class="sd"> is always kept and are inserted as-is.</span>
<span class="sd"> fallback (string, optional): If set, any references that don&#39;t match a target</span>
<span class="sd"> will be replaced with the fallback string.</span>
<span class="sd"> will be replaced with the fallback string. If `None` (default), the</span>
<span class="sd"> parsing will fail and give a warning about the missing reference.</span>
<span class="sd"> Returns:</span>
<span class="sd"> (emote, mapping) (tuple): If `search_mode` is `False`</span>
@ -1207,7 +1211,7 @@
<span class="n">all_recogs</span> <span class="o">=</span> <span class="n">caller</span><span class="o">.</span><span class="n">recog</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">all_recogs</span><span class="p">:</span>
<span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span>
<span class="s2">&quot;You recognize no-one. &quot;</span> <span class="s2">&quot;(Use &#39;recog &lt;sdesc&gt; as &lt;alias&gt;&#39; to recognize people.&quot;</span>
<span class="s2">&quot;You recognize no-one. (Use &#39;recog &lt;sdesc&gt; as &lt;alias&gt;&#39; to recognize people.&quot;</span>
<span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># note that we don&#39;t skip those failing enable_recog lock here,</span>
@ -1217,7 +1221,7 @@
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">all_recogs</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
<span class="p">)</span>
<span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;Currently recognized (use &#39;recog &lt;sdesc&gt; as &lt;alias&gt;&#39; to add &quot;</span>
<span class="s2">&quot;Currently recognized (use &#39;recog &lt;sdesc&gt; as &lt;alias&gt;&#39; to add &quot;</span>
<span class="sa">f</span><span class="s2">&quot;new and &#39;forget &lt;alias&gt;&#39; to remove):</span><span class="se">\n</span><span class="si">{</span><span class="n">lst</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="p">)</span>
<span class="k">return</span>

View file

@ -172,7 +172,7 @@
<span class="n">recog02</span> <span class="o">=</span> <span class="s2">&quot;Mr Receiver2&quot;</span>
<span class="n">recog10</span> <span class="o">=</span> <span class="s2">&quot;Mr Sender&quot;</span>
<span class="n">emote</span> <span class="o">=</span> <span class="s1">&#39;With a flair, /me looks at /first and /colliding sdesc-guy. She says &quot;This is a test.&quot;&#39;</span>
<span class="n">fallback_emote</span> <span class="o">=</span> <span class="s1">&#39;/Me is distracted from /first by /nomatch.&#39;</span>
<span class="n">fallback_emote</span> <span class="o">=</span> <span class="s2">&quot;/Me is distracted from /first by /nomatch.&quot;</span>
<span class="n">case_emote</span> <span class="o">=</span> <span class="s2">&quot;/Me looks at /first. Then, /me looks at /FIRST, /First and /Colliding twice.&quot;</span>
<span class="n">poss_emote</span> <span class="o">=</span> <span class="s2">&quot;/Me frowns at /first for trying to steal /me&#39;s test.&quot;</span>