Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-05 15:37:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2021-05-29 13:55:45 +02:00
parent 1bbc93507a
commit 8c5212d5ff
409 changed files with 17441 additions and 15857 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/1.0-dev/api/evennia.utils.evmenu.html
View file

@ -760,10 +760,30 @@ given, the decorated node must itself provide a way to continue from the node!</
</dd>
</dl>
<p class="rubric">Example</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">list_node</span><span class="p">([</span><span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="s1">&#39;bar&#39;</span><span class="p">],</span> <span class="n">select</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">node_index</span><span class="p">(</span><span class="n">caller</span><span class="p">):</span>
<span class="n">text</span> <span class="o">=</span> <span class="s2">&quot;describing the list&quot;</span>
<span class="k">return</span> <span class="n">text</span><span class="p">,</span> <span class="p">[]</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">select</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">selection</span><span class="p">,</span> <span class="n">available_choices</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="s1">&#39;&#39;&#39;</span>
<span class="s1"> Args:</span>
<span class="s1"> caller (Object or Account): User of the menu.</span>
<span class="s1"> selection (str): What caller chose in the menu</span>
<span class="s1"> available_choices (list): The keys of elements available on the *current listing</span>
<span class="s1"> page*.</span>
<span class="s1"> **kwargs: Kwargs passed on from the node.</span>
<span class="s1"> Returns:</span>
<span class="s1"> tuple, str or None: A tuple (nextnodename, **kwargs) or just nextnodename. Return</span>
<span class="s1"> **None** to go back to the listnode.</span>
<span class="s1"> # (do something with **selection** here)</span>
<span class="s1"> return &quot;nextnode&quot;, **kwargs</span>
<span class="s1">@list_node([&#39;foo&#39;, &#39;bar&#39;], select)</span>
<span class="s1">def node_index(caller):</span>
<span class="s1"> text = &quot;describing the list&quot;</span>
<span class="s1"> # optional extra options in addition to the list-options</span>
<span class="s1"> extra_options = []</span>
<span class="s1"> return text, extra_options</span>
</pre></div>
</div>
<p class="rubric">Notes</p>
@ -921,7 +941,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"> = ['__nomatch_command', 'yes', 'no', 'abort', 'a', 'y', '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"> = ['__nomatch_command', 'a', 'abort', 'n', 'yes', 'no', 'y']</em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -947,7 +967,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': '__nomatch_command yes no abort a y n', 'category': 'general', 'key': '__noinput_command', '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': '__nomatch_command a abort n yes no y', 'category': 'general', 'key': '__noinput_command', '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>