Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-02 22:17:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/api/evennia.commands.cmdparser.html

301 lines
18 KiB
HTML
Raw Normal View History

Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<!DOCTYPE html>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<html lang="en" data-content_root="../">
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<head>
<meta charset="utf-8" />
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<title>evennia.commands.cmdparser &#8212; Evennia latest documentation</title>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../_static/favicon.ico"/>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.commands.cmdset" href="evennia.commands.cmdset.html" />
<link rel="prev" title="evennia.commands.cmdhandler" href="evennia.commands.cmdhandler.html" />
</head><body>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<div class="related" role="navigation" aria-label="Related">
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<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="right" >
<a href="evennia.commands.cmdset.html" title="evennia.commands.cmdset"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.commands.cmdhandler.html" title="evennia.commands.cmdhandler"
accesskey="P">previous</a> |</li>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.commands.html" accesskey="U">evennia.commands</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.commands.cmdparser</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.commands.cmdparser">
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<span id="evennia-commands-cmdparser"></span><h1>evennia.commands.cmdparser<a class="headerlink" href="#module-evennia.commands.cmdparser" title="Link to this heading"></a></h1>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<p>The default command parser. Use your own by assigning
<strong>settings.COMMAND_PARSER</strong> to a Python path to a module containing the
replacing cmdparser function. The replacement parser must accept the
same inputs as the default one.</p>
<dl class="py function">
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="sig sig-object py" id="evennia.commands.cmdparser.create_match">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.cmdparser.</span></span><span class="sig-name descname"><span class="pre">create_match</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdobj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_cmdname</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/cmdparser.html#create_match"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdparser.create_match" title="Link to this definition"></a></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd><p>Builds a command match by splitting the incoming string and
evaluating the quality of the match.</p>
<dl class="field-list simple">
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd class="field-odd"><ul class="simple">
<li><p><strong>cmdname</strong> (<em>str</em>) – Name of command to check for.</p></li>
<li><p><strong>string</strong> (<em>str</em>) – The string to match against.</p></li>
<li><p><strong>cmdobj</strong> (<em>str</em>) – The full Command instance.</p></li>
<li><p><strong>raw_cmdname</strong> (<em>str</em><em>, </em><em>optional</em>) – If CMD_IGNORE_PREFIX is set and the cmdname starts with
one of the prefixes to ignore, this contains the raw, unstripped cmdname,
otherwise it is None.</p></li>
</ul>
</dd>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd class="field-even"><p><p><em>match (tuple)</em> –</p>
<dl class="simple">
<dt>This is on the form (cmdname, args, cmdobj, cmdlen, mratio, raw_cmdname),</dt><dd><p>where <strong>cmdname</strong> is the command’s name and <strong>args</strong> is the rest of the incoming
string, without said command name. <strong>cmdobj</strong> is
the Command instance, the cmdlen is the same as len(cmdname) and mratio
is a measure of how big a part of the full input string the cmdname
takes up - an exact match would be 1.0. Finally, the <strong>raw_cmdname</strong> is
the cmdname unmodified by eventual prefix-stripping.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="sig sig-object py" id="evennia.commands.cmdparser.build_matches">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.cmdparser.</span></span><span class="sig-name descname"><span class="pre">build_matches</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_prefixes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/cmdparser.html#build_matches"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdparser.build_matches" title="Link to this definition"></a></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd><p>Build match tuples by matching raw_string against available commands.</p>
<dl class="field-list simple">
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd class="field-odd"><ul class="simple">
<li><p><strong>raw_string</strong> (<em>str</em>) – Input string that can look in any way; the only assumption is
that the sought command’s name/alias must be <em>first</em> in the string.</p></li>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<li><p><strong>cmdset</strong> (<a class="reference internal" href="evennia.commands.cmdhandler.html#evennia.commands.cmdhandler.CmdSet" title="evennia.commands.cmdhandler.CmdSet"><em>CmdSet</em></a>) – The current cmdset to pick Commands from.</p></li>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<li><p><strong>include_prefixes</strong> (<em>bool</em>) – If set, include prefixes like &#64;, ! etc (specified in settings)
in the match, otherwise strip them before matching.</p></li>
</ul>
</dd>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd class="field-even"><p>matches (list) A list of match tuples created by <strong>cmdparser.create_match</strong>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="sig sig-object py" id="evennia.commands.cmdparser.try_num_differentiators">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.cmdparser.</span></span><span class="sig-name descname"><span class="pre">try_num_differentiators</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_string</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/cmdparser.html#try_num_differentiators"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdparser.try_num_differentiators" title="Link to this definition"></a></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd><p>Test if user tried to separate multi-matches with a number separator
(default 1-name, 2-name etc). This is usually called last, if no other
match was found.</p>
<dl class="field-list simple">
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd class="field-odd"><p><strong>raw_string</strong> (<em>str</em>) – The user input to parse.</p>
</dd>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd class="field-even"><p><p><em>mindex, new_raw_string (tuple)</em> –</p>
<dl class="simple">
<dt>If a multimatch-separator was detected,</dt><dd><p>this is stripped out as an integer to separate between the matches. The
new_raw_string is the result of stripping out that identifier. If no
such form was found, returns (None, None).</p>
</dd>
</dl>
</p>
</dd>
</dl>
<p class="rubric">Example</p>
<p>In the default configuration, entering 2-ball (e.g. in a room will more
than one ‘ball’ object), will lead to a multimatch and this function
will parse <strong>“2-ball”</strong> and return <strong>(2, “ball”)</strong>.</p>
</dd></dl>
<dl class="py function">
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="sig sig-object py" id="evennia.commands.cmdparser.cmdparser">
<span class="sig-prename descclassname"><span class="pre">evennia.commands.cmdparser.</span></span><span class="sig-name descname"><span class="pre">cmdparser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cmdset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">caller</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">match_index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/cmdparser.html#cmdparser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.commands.cmdparser.cmdparser" title="Link to this definition"></a></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd><p>This function is called by the cmdhandler once it has
gathered and merged all valid cmdsets valid for this particular parsing.</p>
<dl class="field-list simple">
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd class="field-odd"><ul class="simple">
<li><p><strong>raw_string</strong> (<em>str</em>) – The unparsed text entered by the caller.</p></li>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<li><p><strong>cmdset</strong> (<a class="reference internal" href="evennia.commands.cmdhandler.html#evennia.commands.cmdhandler.CmdSet" title="evennia.commands.cmdhandler.CmdSet"><em>CmdSet</em></a>) – The merged, currently valid cmdset</p></li>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<li><p><strong>caller</strong> (<a class="reference internal" href="evennia.server.session.html#evennia.server.session.Session" title="evennia.server.session.Session"><em>Session</em></a><em>, </em><em>Account</em><em> or </em><em>Object</em>) – The caller triggering this parsing.</p></li>
<li><p><strong>match_index</strong> (<em>int</em><em>, </em><em>optional</em>) – Index to pick a given match in a
list of same-named command matches. If this is given, it suggests
this is not the first time this function was called: normally
the first run resulted in a multimatch, and the index is given
to select between the results for the second run.</p></li>
</ul>
</dd>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<dt class="field-even">Returns<span class="colon">:</span></dt>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<dd class="field-even"><p><p><em>matches (list)</em> –</p>
<dl class="simple">
<dt>This is a list of match-tuples as returned by <strong>create_match</strong>.</dt><dd><p>If no matches were found, this is an empty list.</p>
</dd>
</dl>
</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The cmdparser understand the following command combinations (where
[] marks optional parts.</p>
<p>[cmdname[ cmdname2 cmdname3 …] [the rest]</p>
<p>A command may consist of any number of space-separated words of any
length, and contain any character. It may also be empty.</p>
<p>The parser makes use of the cmdset to find command candidates. The
parser return a list of matches. Each match is a tuple with its
first three elements being the parsed cmdname (lower case),
the remaining arguments, and the matched cmdobject from the cmdset.</p>
</dd></dl>
</section>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<div class="clearer"></div>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
</div>
</div>
</div>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.commands.cmdparser</a><ul>
<li><a class="reference internal" href="#evennia.commands.cmdparser.create_match"><code class="docutils literal notranslate"><span class="pre">create_match()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.cmdparser.build_matches"><code class="docutils literal notranslate"><span class="pre">build_matches()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.cmdparser.try_num_differentiators"><code class="docutils literal notranslate"><span class="pre">try_num_differentiators()</span></code></a></li>
<li><a class="reference internal" href="#evennia.commands.cmdparser.cmdparser"><code class="docutils literal notranslate"><span class="pre">cmdparser()</span></code></a></li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.commands.cmdhandler.html"
title="previous chapter">evennia.commands.cmdhandler</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.commands.cmdset.html"
title="next chapter">evennia.commands.cmdset</a></p>
</div>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.commands.cmdparser.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><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="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
Updated HTML docs.
2025-08-15 16:53:30 +00:00
</div>
</div>
<div class="clearer"></div>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
</div>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<div class="related" role="navigation" aria-label="Related">
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<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="right" >
<a href="evennia.commands.cmdset.html" title="evennia.commands.cmdset"
>next</a> |</li>
<li class="right" >
<a href="evennia.commands.cmdhandler.html" title="evennia.commands.cmdhandler"
>previous</a> |</li>
Updated HTML docs.
2025-08-15 16:53:30 +00:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.commands.html" >evennia.commands</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.commands.cmdparser</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
Updated HTML docs.
2025-08-15 16:53:30 +00:00
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
Add 'latest' as the bleeding edge docs
2023-12-20 18:49:25 +01:00
</div>
</body>
</html>
Reference in a new issue Copy permalink