mirror of
https://github.com/evennia/evennia.git
synced 2026-04-04 06:57:16 +02:00
366 lines
No EOL
20 KiB
HTML
366 lines
No EOL
20 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>evennia.commands.default.syscommands — Evennia 1.0-dev documentation</title>
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../../../../_static/favicon.ico"/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="index" title="Index"
|
|
href="../../../../genindex.html"/>
|
|
<link rel="search" title="Search" href="../../../../search.html"/>
|
|
<link rel="top" title="Evennia 1.0-dev documentation" href="../../../../index.html"/>
|
|
<link rel="up" title="evennia" href="../../../evennia.html"/>
|
|
|
|
|
|
<script src="../../../../_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="../../../../index.html" class="icon icon-home"> Evennia
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
<!-- Local TOC -->
|
|
<div class="local-toc"></div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../../../../index.html">Evennia</a>
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="../../../../index.html">Docs</a> »</li>
|
|
|
|
<li><a href="../../../index.html">Module code</a> »</li>
|
|
|
|
<li><a href="../../../evennia.html">evennia</a> »</li>
|
|
|
|
<li>evennia.commands.default.syscommands</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<h1>Source code for evennia.commands.default.syscommands</h1><div class="highlight"><pre>
|
|
<span></span><span class="sd">"""</span>
|
|
<span class="sd">System commands</span>
|
|
|
|
<span class="sd">These are the default commands called by the system commandhandler</span>
|
|
<span class="sd">when various exceptions occur. If one of these commands are not</span>
|
|
<span class="sd">implemented and part of the current cmdset, the engine falls back</span>
|
|
<span class="sd">to a default solution instead.</span>
|
|
|
|
<span class="sd">Some system commands are shown in this module</span>
|
|
<span class="sd">as a REFERENCE only (they are not all added to Evennia's</span>
|
|
<span class="sd">default cmdset since they don't currently do anything differently from the</span>
|
|
<span class="sd">default backup systems hard-wired in the engine).</span>
|
|
|
|
<span class="sd">Overloading these commands in a cmdset can be used to create</span>
|
|
<span class="sd">interesting effects. An example is using the NoMatch system command</span>
|
|
<span class="sd">to implement a line-editor where you don't have to start each</span>
|
|
<span class="sd">line with a command (if there is no match to a known command,</span>
|
|
<span class="sd">the line is just added to the editor buffer).</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">evennia.comms.models</span> <span class="k">import</span> <span class="n">ChannelDB</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="k">import</span> <span class="n">create</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="k">import</span> <span class="n">at_search_result</span>
|
|
|
|
<span class="c1"># The command keys the engine is calling</span>
|
|
<span class="c1"># (the actual names all start with __)</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.commands.cmdhandler</span> <span class="k">import</span> <span class="n">CMD_NOINPUT</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.commands.cmdhandler</span> <span class="k">import</span> <span class="n">CMD_NOMATCH</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.commands.cmdhandler</span> <span class="k">import</span> <span class="n">CMD_MULTIMATCH</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.commands.cmdhandler</span> <span class="k">import</span> <span class="n">CMD_CHANNEL</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="k">import</span> <span class="n">utils</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="k">import</span> <span class="n">settings</span>
|
|
|
|
<span class="n">COMMAND_DEFAULT_CLASS</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">class_from_module</span><span class="p">(</span><span class="n">settings</span><span class="o">.</span><span class="n">COMMAND_DEFAULT_CLASS</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Command called when there is no input at line</span>
|
|
<span class="c1"># (i.e. an lone return key)</span>
|
|
|
|
|
|
<div class="viewcode-block" id="SystemNoInput"><a class="viewcode-back" href="../../../../api/evennia.commands.default.html#evennia.commands.default.syscommands.SystemNoInput">[docs]</a><span class="k">class</span> <span class="nc">SystemNoInput</span><span class="p">(</span><span class="n">COMMAND_DEFAULT_CLASS</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> This is called when there is no input given</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">key</span> <span class="o">=</span> <span class="n">CMD_NOINPUT</span>
|
|
<span class="n">locks</span> <span class="o">=</span> <span class="s2">"cmd:all()"</span>
|
|
|
|
<div class="viewcode-block" id="SystemNoInput.func"><a class="viewcode-back" href="../../../../api/evennia.commands.default.html#evennia.commands.default.syscommands.SystemNoInput.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="s2">"Do nothing."</span>
|
|
<span class="k">pass</span></div></div>
|
|
|
|
|
|
<span class="c1">#</span>
|
|
<span class="c1"># Command called when there was no match to the</span>
|
|
<span class="c1"># command name</span>
|
|
<span class="c1">#</span>
|
|
<div class="viewcode-block" id="SystemNoMatch"><a class="viewcode-back" href="../../../../api/evennia.commands.default.html#evennia.commands.default.syscommands.SystemNoMatch">[docs]</a><span class="k">class</span> <span class="nc">SystemNoMatch</span><span class="p">(</span><span class="n">COMMAND_DEFAULT_CLASS</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> No command was found matching the given input.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">key</span> <span class="o">=</span> <span class="n">CMD_NOMATCH</span>
|
|
<span class="n">locks</span> <span class="o">=</span> <span class="s2">"cmd:all()"</span>
|
|
|
|
<div class="viewcode-block" id="SystemNoMatch.func"><a class="viewcode-back" href="../../../../api/evennia.commands.default.html#evennia.commands.default.syscommands.SystemNoMatch.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">"""</span>
|
|
<span class="sd"> This is given the failed raw string as input.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">"Huh?"</span><span class="p">)</span></div></div>
|
|
|
|
|
|
<span class="c1">#</span>
|
|
<span class="c1"># Command called when there were mulitple matches to the command.</span>
|
|
<span class="c1">#</span>
|
|
<div class="viewcode-block" id="SystemMultimatch"><a class="viewcode-back" href="../../../../api/evennia.commands.default.html#evennia.commands.default.syscommands.SystemMultimatch">[docs]</a><span class="k">class</span> <span class="nc">SystemMultimatch</span><span class="p">(</span><span class="n">COMMAND_DEFAULT_CLASS</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Multiple command matches.</span>
|
|
|
|
<span class="sd"> The cmdhandler adds a special attribute 'matches' to this</span>
|
|
<span class="sd"> system command.</span>
|
|
|
|
<span class="sd"> matches = [(cmdname, args, cmdobj, cmdlen, mratio, raw_cmdname) , (cmdname, ...), ...]</span>
|
|
|
|
<span class="sd"> Here, `cmdname` is the command's name and `args` the rest of the incoming string,</span>
|
|
<span class="sd"> without said command name. `cmdobj` is the Command instance, the cmdlen is</span>
|
|
<span class="sd"> the same as len(cmdname) and mratio is a measure of how big a part of the</span>
|
|
<span class="sd"> full input string the cmdname takes up - an exact match would be 1.0. Finally,</span>
|
|
<span class="sd"> the `raw_cmdname` is the cmdname unmodified by eventual prefix-stripping.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">key</span> <span class="o">=</span> <span class="n">CMD_MULTIMATCH</span>
|
|
<span class="n">locks</span> <span class="o">=</span> <span class="s2">"cmd:all()"</span>
|
|
|
|
<div class="viewcode-block" id="SystemMultimatch.func"><a class="viewcode-back" href="../../../../api/evennia.commands.default.html#evennia.commands.default.syscommands.SystemMultimatch.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">"""</span>
|
|
<span class="sd"> Handle multiple-matches by using the at_search_result default handler.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="c1"># this was set by the cmdparser and is a tuple</span>
|
|
<span class="c1"># (cmdname, args, cmdobj, cmdlen, mratio, raw_cmdname). See</span>
|
|
<span class="c1"># evennia.commands.cmdparse.create_match for more details.</span>
|
|
<span class="n">matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">matches</span>
|
|
<span class="c1"># at_search_result will itself msg the multimatch options to the caller.</span>
|
|
<span class="n">at_search_result</span><span class="p">([</span><span class="n">match</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="n">matches</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="n">matches</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span></div></div>
|
|
|
|
|
|
<span class="c1"># Command called when the command given at the command line</span>
|
|
<span class="c1"># was identified as a channel name, like there existing a</span>
|
|
<span class="c1"># channel named 'ooc' and the user wrote</span>
|
|
<span class="c1"># > ooc Hello!</span>
|
|
|
|
|
|
<div class="viewcode-block" id="SystemSendToChannel"><a class="viewcode-back" href="../../../../api/evennia.commands.default.html#evennia.commands.default.syscommands.SystemSendToChannel">[docs]</a><span class="k">class</span> <span class="nc">SystemSendToChannel</span><span class="p">(</span><span class="n">COMMAND_DEFAULT_CLASS</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> This is a special command that the cmdhandler calls</span>
|
|
<span class="sd"> when it detects that the command given matches</span>
|
|
<span class="sd"> an existing Channel object key (or alias).</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">key</span> <span class="o">=</span> <span class="n">CMD_CHANNEL</span>
|
|
<span class="n">locks</span> <span class="o">=</span> <span class="s2">"cmd:all()"</span>
|
|
|
|
<div class="viewcode-block" id="SystemSendToChannel.parse"><a class="viewcode-back" href="../../../../api/evennia.commands.default.html#evennia.commands.default.syscommands.SystemSendToChannel.parse">[docs]</a> <span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="n">channelname</span><span class="p">,</span> <span class="n">msg</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">split</span><span class="p">(</span><span class="s2">":"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">args</span> <span class="o">=</span> <span class="n">channelname</span><span class="o">.</span><span class="n">strip</span><span class="p">(),</span> <span class="n">msg</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span></div>
|
|
|
|
<div class="viewcode-block" id="SystemSendToChannel.func"><a class="viewcode-back" href="../../../../api/evennia.commands.default.html#evennia.commands.default.syscommands.SystemSendToChannel.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">"""</span>
|
|
<span class="sd"> Create a new message and send it to channel, using</span>
|
|
<span class="sd"> the already formatted input.</span>
|
|
<span class="sd"> """</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">channelkey</span><span class="p">,</span> <span class="n">msg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">args</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">msg</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">"Say what?"</span><span class="p">)</span>
|
|
<span class="k">return</span>
|
|
<span class="n">channel</span> <span class="o">=</span> <span class="n">ChannelDB</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get_channel</span><span class="p">(</span><span class="n">channelkey</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">channel</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">"Channel '</span><span class="si">%s</span><span class="s2">' not found."</span> <span class="o">%</span> <span class="n">channelkey</span><span class="p">)</span>
|
|
<span class="k">return</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">channel</span><span class="o">.</span><span class="n">has_connection</span><span class="p">(</span><span class="n">caller</span><span class="p">):</span>
|
|
<span class="n">string</span> <span class="o">=</span> <span class="s2">"You are not connected to channel '</span><span class="si">%s</span><span class="s2">'."</span>
|
|
<span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="n">string</span> <span class="o">%</span> <span class="n">channelkey</span><span class="p">)</span>
|
|
<span class="k">return</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">channel</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="s2">"send"</span><span class="p">):</span>
|
|
<span class="n">string</span> <span class="o">=</span> <span class="s2">"You are not permitted to send to channel '</span><span class="si">%s</span><span class="s2">'."</span>
|
|
<span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="n">string</span> <span class="o">%</span> <span class="n">channelkey</span><span class="p">)</span>
|
|
<span class="k">return</span>
|
|
<span class="n">msg</span> <span class="o">=</span> <span class="s2">"[</span><span class="si">%s</span><span class="s2">] </span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">channel</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> <span class="n">caller</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
|
|
<span class="n">msgobj</span> <span class="o">=</span> <span class="n">create</span><span class="o">.</span><span class="n">create_message</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">msg</span><span class="p">,</span> <span class="n">channels</span><span class="o">=</span><span class="p">[</span><span class="n">channel</span><span class="p">])</span>
|
|
<span class="n">channel</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="n">msgobj</span><span class="p">)</span></div></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2020, The Evennia developer community.
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> and ❤️ using a custom <a href="https://github.com/LinxiFan/Sphinx-theme">theme</a> based on <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'../../../../',
|
|
VERSION:'1.0-dev',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true,
|
|
SOURCELINK_SUFFIX: '.txt'
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
|
|
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |