Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-27 02:06:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
evennia/docs/1.0-dev/_modules/evennia/contrib/multidescer.html
Griatch 2909e32ee1 Updated HTML docs
2020-06-15 21:52:33 +02:00

359 lines
No EOL
40 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>evennia.contrib.multidescer &#8212; Evennia 1.0-dev 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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../evennia.html" accesskey="U">evennia</a> &#187;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for evennia.contrib.multidescer</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Evennia Mutltidescer</span>
<span class="sd">Contrib - Griatch 2016</span>
<span class="sd">A &quot;multidescer&quot; is a concept from the MUSH world. It allows for</span>
<span class="sd">creating, managing and switching between multiple character</span>
<span class="sd">descriptions. This multidescer will not require any changes to the</span>
<span class="sd">Character class, rather it will use the `multidescs` Attribute (a</span>
<span class="sd">list) and create it if it does not exist.</span>
<span class="sd">This contrib also works well together with the rpsystem contrib (which</span>
<span class="sd">also adds the short descriptions and the `sdesc` command).</span>
<span class="sd">Installation:</span>
<span class="sd">Edit `mygame/commands/default_cmdsets.py` and add</span>
<span class="sd">`from evennia.contrib.multidescer import CmdMultiDesc` to the top.</span>
<span class="sd">Next, look up the `at_cmdset_create` method of the `CharacterCmdSet`</span>
<span class="sd">class and add a line `self.add(CmdMultiDesc())` to the end</span>
<span class="sd">of it.</span>
<span class="sd">Reload the server and you should have the +desc command available (it</span>
<span class="sd">will replace the default `desc` command).</span>
<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">evennia</span> <span class="k">import</span> <span class="n">default_cmds</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="k">import</span> <span class="n">crop</span>
<span class="kn">from</span> <span class="nn">evennia.utils.eveditor</span> <span class="k">import</span> <span class="n">EvEditor</span>
<span class="c1"># regex for the set functionality</span>
<span class="n">_RE_KEYS</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;([\w\s]+)(?:\+*?)&quot;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">U</span> <span class="o">+</span> <span class="n">re</span><span class="o">.</span><span class="n">I</span><span class="p">)</span>
<span class="c1"># Helper functions for the Command</span>
<div class="viewcode-block" id="DescValidateError"><a class="viewcode-back" href="../../../api/evennia.contrib.html#evennia.contrib.multidescer.DescValidateError">[docs]</a><span class="k">class</span> <span class="nc">DescValidateError</span><span class="p">(</span><span class="ne">ValueError</span><span class="p">):</span>
<span class="s2">&quot;Used for tracebacks from desc systems&quot;</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="_update_store"><a class="viewcode-back" href="../../../api/evennia.contrib.html#evennia.contrib.multidescer._update_store">[docs]</a><span class="k">def</span> <span class="nf">_update_store</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">desc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">delete</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">swapkey</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Helper function for updating the database store.</span>
<span class="sd"> Args:</span>
<span class="sd"> caller (Object): The caller of the command.</span>
<span class="sd"> key (str): Description identifier</span>
<span class="sd"> desc (str): Description text.</span>
<span class="sd"> delete (bool): Delete given key.</span>
<span class="sd"> swapkey (str): Swap list positions of `key` and this key.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">:</span>
<span class="c1"># initialize the multidesc attribute</span>
<span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span> <span class="o">=</span> <span class="p">[(</span><span class="s2">&quot;caller&quot;</span><span class="p">,</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">desc</span> <span class="ow">or</span> <span class="s2">&quot;&quot;</span><span class="p">)]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">key</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">lokey</span> <span class="o">=</span> <span class="n">key</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="n">match</span> <span class="o">=</span> <span class="p">[</span><span class="n">ind</span> <span class="k">for</span> <span class="n">ind</span><span class="p">,</span> <span class="n">tup</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">)</span> <span class="k">if</span> <span class="n">tup</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">lokey</span><span class="p">]</span>
<span class="k">if</span> <span class="n">match</span><span class="p">:</span>
<span class="n">idesc</span> <span class="o">=</span> <span class="n">match</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">delete</span><span class="p">:</span>
<span class="c1"># delete entry</span>
<span class="k">del</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">[</span><span class="n">idesc</span><span class="p">]</span>
<span class="k">elif</span> <span class="n">swapkey</span><span class="p">:</span>
<span class="c1"># swap positions</span>
<span class="n">loswapkey</span> <span class="o">=</span> <span class="n">swapkey</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="n">swapmatch</span> <span class="o">=</span> <span class="p">[</span><span class="n">ind</span> <span class="k">for</span> <span class="n">ind</span><span class="p">,</span> <span class="n">tup</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">)</span> <span class="k">if</span> <span class="n">tup</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">loswapkey</span><span class="p">]</span>
<span class="k">if</span> <span class="n">swapmatch</span><span class="p">:</span>
<span class="n">iswap</span> <span class="o">=</span> <span class="n">swapmatch</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">idesc</span> <span class="o">==</span> <span class="n">iswap</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">DescValidateError</span><span class="p">(</span><span class="s2">&quot;Swapping a key with itself does nothing.&quot;</span><span class="p">)</span>
<span class="n">temp</span> <span class="o">=</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">[</span><span class="n">idesc</span><span class="p">]</span>
<span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">[</span><span class="n">idesc</span><span class="p">]</span> <span class="o">=</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">[</span><span class="n">iswap</span><span class="p">]</span>
<span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">[</span><span class="n">iswap</span><span class="p">]</span> <span class="o">=</span> <span class="n">temp</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">DescValidateError</span><span class="p">(</span><span class="s2">&quot;Description key &#39;|w</span><span class="si">%s</span><span class="s2">|n&#39; not found.&quot;</span> <span class="o">%</span> <span class="n">swapkey</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">desc</span><span class="p">:</span>
<span class="c1"># update in-place</span>
<span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">[</span><span class="n">idesc</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">lokey</span><span class="p">,</span> <span class="n">desc</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">DescValidateError</span><span class="p">(</span><span class="s2">&quot;No description was set.&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># no matching key</span>
<span class="k">if</span> <span class="n">delete</span> <span class="ow">or</span> <span class="n">swapkey</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">DescValidateError</span><span class="p">(</span><span class="s2">&quot;Description key &#39;|w</span><span class="si">%s</span><span class="s2">|n&#39; not found.&quot;</span> <span class="o">%</span> <span class="n">key</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">desc</span><span class="p">:</span>
<span class="c1"># insert new at the top of the stack</span>
<span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="p">(</span><span class="n">lokey</span><span class="p">,</span> <span class="n">desc</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">DescValidateError</span><span class="p">(</span><span class="s2">&quot;No description was set.&quot;</span><span class="p">)</span></div>
<span class="c1"># eveditor save/load/quit functions</span>
<div class="viewcode-block" id="_save_editor"><a class="viewcode-back" href="../../../api/evennia.contrib.html#evennia.contrib.multidescer._save_editor">[docs]</a><span class="k">def</span> <span class="nf">_save_editor</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">buffer</span><span class="p">):</span>
<span class="s2">&quot;Called when the editor saves its contents&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">_multidesc_editkey</span>
<span class="n">_update_store</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">buffer</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;Saved description to key &#39;</span><span class="si">%s</span><span class="s2">&#39;.&quot;</span> <span class="o">%</span> <span class="n">key</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="_load_editor"><a class="viewcode-back" href="../../../api/evennia.contrib.html#evennia.contrib.multidescer._load_editor">[docs]</a><span class="k">def</span> <span class="nf">_load_editor</span><span class="p">(</span><span class="n">caller</span><span class="p">):</span>
<span class="s2">&quot;Called when the editor loads contents&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">_multidesc_editkey</span>
<span class="n">match</span> <span class="o">=</span> <span class="p">[</span><span class="n">ind</span> <span class="k">for</span> <span class="n">ind</span><span class="p">,</span> <span class="n">tup</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">)</span> <span class="k">if</span> <span class="n">tup</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">key</span><span class="p">]</span>
<span class="k">if</span> <span class="n">match</span><span class="p">:</span>
<span class="k">return</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span><span class="p">[</span><span class="n">match</span><span class="p">[</span><span class="mi">0</span><span class="p">]][</span><span class="mi">1</span><span class="p">]</span>
<span class="k">return</span> <span class="s2">&quot;&quot;</span></div>
<div class="viewcode-block" id="_quit_editor"><a class="viewcode-back" href="../../../api/evennia.contrib.html#evennia.contrib.multidescer._quit_editor">[docs]</a><span class="k">def</span> <span class="nf">_quit_editor</span><span class="p">(</span><span class="n">caller</span><span class="p">):</span>
<span class="s2">&quot;Called when the editor quits&quot;</span>
<span class="k">del</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">_multidesc_editkey</span>
<span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;Exited editor.&quot;</span><span class="p">)</span></div>
<span class="c1"># The actual command class</span>
<div class="viewcode-block" id="CmdMultiDesc"><a class="viewcode-back" href="../../../api/evennia.contrib.html#evennia.contrib.multidescer.CmdMultiDesc">[docs]</a><span class="k">class</span> <span class="nc">CmdMultiDesc</span><span class="p">(</span><span class="n">default_cmds</span><span class="o">.</span><span class="n">MuxCommand</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Manage multiple descriptions</span>
<span class="sd"> Usage:</span>
<span class="sd"> +desc [key] - show current desc desc with &lt;key&gt;</span>
<span class="sd"> +desc &lt;key&gt; = &lt;text&gt; - add/replace desc with &lt;key&gt;</span>
<span class="sd"> +desc/list - list descriptions (abbreviated)</span>
<span class="sd"> +desc/list/full - list descriptions (full texts)</span>
<span class="sd"> +desc/edit &lt;key&gt; - add/edit desc &lt;key&gt; in line editor</span>
<span class="sd"> +desc/del &lt;key&gt; - delete desc &lt;key&gt;</span>
<span class="sd"> +desc/swap &lt;key1&gt;-&lt;key2&gt; - swap positions of &lt;key1&gt; and &lt;key2&gt; in list</span>
<span class="sd"> +desc/set &lt;key&gt; [+key+...] - set desc as default or combine multiple descs</span>
<span class="sd"> Notes:</span>
<span class="sd"> When combining multiple descs with +desc/set &lt;key&gt; + &lt;key2&gt; + ...,</span>
<span class="sd"> any keys not matching an actual description will be inserted</span>
<span class="sd"> as plain text. Use e.g. ansi line break ||/ to add a new</span>
<span class="sd"> paragraph and + + or ansi space ||_ to add extra whitespace.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="s2">&quot;+desc&quot;</span>
<span class="n">aliases</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;desc&quot;</span><span class="p">]</span>
<span class="n">locks</span> <span class="o">=</span> <span class="s2">&quot;cmd:all()&quot;</span>
<span class="n">help_category</span> <span class="o">=</span> <span class="s2">&quot;General&quot;</span>
<div class="viewcode-block" id="CmdMultiDesc.func"><a class="viewcode-back" href="../../../api/evennia.contrib.html#evennia.contrib.multidescer.CmdMultiDesc.func">[docs]</a> <span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Implements the multidescer. We will use `db.desc` for the</span>
<span class="sd"> description in use and `db.multidesc` to store all descriptions.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">caller</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">caller</span>
<span class="n">args</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="n">switches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">switches</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;list&quot;</span> <span class="ow">in</span> <span class="n">switches</span> <span class="ow">or</span> <span class="s2">&quot;all&quot;</span> <span class="ow">in</span> <span class="n">switches</span><span class="p">:</span>
<span class="c1"># list all stored descriptions, either in full or cropped.</span>
<span class="c1"># Note that we list starting from 1, not from 0.</span>
<span class="n">_update_store</span><span class="p">(</span><span class="n">caller</span><span class="p">)</span>
<span class="n">do_crop</span> <span class="o">=</span> <span class="s2">&quot;full&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">switches</span>
<span class="k">if</span> <span class="n">do_crop</span><span class="p">:</span>
<span class="n">outtext</span> <span class="o">=</span> <span class="p">[</span>
<span class="s2">&quot;|w</span><span class="si">%s</span><span class="s2">:|n </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">crop</span><span class="p">(</span><span class="n">desc</span><span class="p">))</span> <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">desc</span> <span class="ow">in</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span>
<span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">outtext</span> <span class="o">=</span> <span class="p">[</span>
<span class="s2">&quot;</span><span class="se">\n</span><span class="s2">|w</span><span class="si">%s</span><span class="s2">:|n|n</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">&quot;-&quot;</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">),</span> <span class="n">desc</span><span class="p">)</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">desc</span> <span class="ow">in</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</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;|wStored descs:|n</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">outtext</span><span class="p">))</span>
<span class="k">return</span>
<span class="k">elif</span> <span class="s2">&quot;edit&quot;</span> <span class="ow">in</span> <span class="n">switches</span><span class="p">:</span>
<span class="c1"># Use the eveditor to edit/create the named description</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">args</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;Usage: </span><span class="si">%s</span><span class="s2">/edit key&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
<span class="k">return</span>
<span class="c1"># this is used by the editor to know what to edit; it&#39;s deleted automatically</span>
<span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">_multidesc_editkey</span> <span class="o">=</span> <span class="n">args</span>
<span class="c1"># start the editor</span>
<span class="n">EvEditor</span><span class="p">(</span>
<span class="n">caller</span><span class="p">,</span>
<span class="n">loadfunc</span><span class="o">=</span><span class="n">_load_editor</span><span class="p">,</span>
<span class="n">savefunc</span><span class="o">=</span><span class="n">_save_editor</span><span class="p">,</span>
<span class="n">quitfunc</span><span class="o">=</span><span class="n">_quit_editor</span><span class="p">,</span>
<span class="n">key</span><span class="o">=</span><span class="s2">&quot;multidesc editor&quot;</span><span class="p">,</span>
<span class="n">persistent</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">elif</span> <span class="s2">&quot;delete&quot;</span> <span class="ow">in</span> <span class="n">switches</span> <span class="ow">or</span> <span class="s2">&quot;del&quot;</span> <span class="ow">in</span> <span class="n">switches</span><span class="p">:</span>
<span class="c1"># delete a multidesc entry.</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">args</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;Usage: </span><span class="si">%s</span><span class="s2">/delete key&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
<span class="k">return</span>
<span class="n">_update_store</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">delete</span><span class="o">=</span><span class="kc">True</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;Deleted description with key &#39;</span><span class="si">%s</span><span class="s2">&#39;.&quot;</span> <span class="o">%</span> <span class="n">args</span><span class="p">)</span>
<span class="k">elif</span> <span class="s2">&quot;swap&quot;</span> <span class="ow">in</span> <span class="n">switches</span> <span class="ow">or</span> <span class="s2">&quot;switch&quot;</span> <span class="ow">in</span> <span class="n">switches</span> <span class="ow">or</span> <span class="s2">&quot;reorder&quot;</span> <span class="ow">in</span> <span class="n">switches</span><span class="p">:</span>
<span class="c1"># Reorder list by swapping two entries. We expect numbers starting from 1</span>
<span class="n">keys</span> <span class="o">=</span> <span class="p">[</span><span class="n">arg</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;-&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">len</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</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;Usage: </span><span class="si">%s</span><span class="s2">/swap key1-key2&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
<span class="k">return</span>
<span class="n">key1</span><span class="p">,</span> <span class="n">key2</span> <span class="o">=</span> <span class="n">keys</span>
<span class="c1"># perform the swap</span>
<span class="n">_update_store</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">key1</span><span class="p">,</span> <span class="n">swapkey</span><span class="o">=</span><span class="n">key2</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;Swapped descs &#39;</span><span class="si">%s</span><span class="s2">&#39; and &#39;</span><span class="si">%s</span><span class="s2">&#39;.&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">key1</span><span class="p">,</span> <span class="n">key2</span><span class="p">))</span>
<span class="k">elif</span> <span class="s2">&quot;set&quot;</span> <span class="ow">in</span> <span class="n">switches</span><span class="p">:</span>
<span class="c1"># switches one (or more) of the multidescs to be the &quot;active&quot; description</span>
<span class="n">_update_store</span><span class="p">(</span><span class="n">caller</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">args</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;Usage: </span><span class="si">%s</span><span class="s2">/set key [+ key2 + key3 + ...]&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
<span class="k">return</span>
<span class="n">new_desc</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">multidesc</span> <span class="o">=</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">args</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;+&quot;</span><span class="p">):</span>
<span class="n">notfound</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">lokey</span> <span class="o">=</span> <span class="n">key</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">for</span> <span class="n">mkey</span><span class="p">,</span> <span class="n">desc</span> <span class="ow">in</span> <span class="n">multidesc</span><span class="p">:</span>
<span class="k">if</span> <span class="n">lokey</span> <span class="o">==</span> <span class="n">mkey</span><span class="p">:</span>
<span class="n">new_desc</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">desc</span><span class="p">)</span>
<span class="n">notfound</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">notfound</span><span class="p">:</span>
<span class="c1"># if we get here, there is no desc match, we add it as a normal string</span>
<span class="n">new_desc</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="n">new_desc</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">new_desc</span><span class="p">)</span>
<span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">desc</span> <span class="o">=</span> <span class="n">new_desc</span>
<span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="se">\n\n</span><span class="s2">|wThe above was set as the current description.|n&quot;</span> <span class="o">%</span> <span class="n">new_desc</span><span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">rhs</span> <span class="ow">or</span> <span class="s2">&quot;add&quot;</span> <span class="ow">in</span> <span class="n">switches</span><span class="p">:</span>
<span class="c1"># add text directly to a new entry or an existing one.</span>
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lhs</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">rhs</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;Usage: </span><span class="si">%s</span><span class="s2">/add key = description&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
<span class="k">return</span>
<span class="n">key</span><span class="p">,</span> <span class="n">desc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">lhs</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">rhs</span>
<span class="n">_update_store</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">desc</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;Stored description &#39;</span><span class="si">%s</span><span class="s2">&#39;: </span><span class="se">\&quot;</span><span class="si">%s</span><span class="se">\&quot;</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">crop</span><span class="p">(</span><span class="n">desc</span><span class="p">)))</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># display the current description or a numbered description</span>
<span class="n">_update_store</span><span class="p">(</span><span class="n">caller</span><span class="p">)</span>
<span class="k">if</span> <span class="n">args</span><span class="p">:</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="n">multidesc</span> <span class="o">=</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">multidesc</span>
<span class="k">for</span> <span class="n">mkey</span><span class="p">,</span> <span class="n">desc</span> <span class="ow">in</span> <span class="n">multidesc</span><span class="p">:</span>
<span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="n">mkey</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;|wDecsription </span><span class="si">%s</span><span class="s2">:|n</span><span class="se">\n</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">desc</span><span class="p">))</span>
<span class="k">return</span>
<span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;Description key &#39;</span><span class="si">%s</span><span class="s2">&#39; not found.&quot;</span> <span class="o">%</span> <span class="n">key</span><span class="p">)</span>
<span class="k">else</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;|wCurrent desc:|n</span><span class="se">\n</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">caller</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">desc</span><span class="p">)</span>
<span class="k">except</span> <span class="n">DescValidateError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="c1"># This is triggered by _key_to_index</span>
<span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="n">err</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
</div>
<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>Versions</h3>
<ul>
<li><a href="multidescer.html">1.0-dev (develop branch)</a></li>
<li><a href="../../../../0.9.1/index.html">0.9.1 (master branch)</a></li>
</ul>
</div>
</div>
<div class="clearer"></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 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../evennia.html" >evennia</a> &#187;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink