Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 14:26:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/api/evennia.commands.default.comms.html
Griatch 2d53d75aea Updated HTML docs
2020-10-19 22:46:24 +02:00

1076 lines
No EOL
81 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.commands.default.comms &#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</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.commands.default.comms</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-evennia.commands.default.comms">
<span id="evennia-commands-default-comms"></span><h1>evennia.commands.default.comms<a class="headerlink" href="#module-evennia.commands.default.comms" title="Permalink to this headline"></a></h1>
<p>Comsystem command module.</p>
<p>Comm commands are OOC commands and intended to be made available to
the Account at all times (they go into the AccountCmdSet). So we
make sure to homogenize self.caller to always be the account object
for easy handling.</p>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdAddCom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdAddCom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdAddCom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>add a channel alias and/or subscribe to a channel</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>addcom [alias=] &lt;channel&gt;</p>
</dd>
</dl>
<p>Joins a given channel. If alias is given, this will allow you to
refer to the channel by this alias rather than the full channel
name. Subsequent calls of this command can be used to add multiple
aliases to an already joined channel.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAddCom.key">
<code class="sig-name descname">key</code><em class="property"> = 'addcom'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAddCom.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['chanalias', 'aliaschan']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAddCom.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAddCom.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAddCom.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdAddCom.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdAddCom.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom.func" title="Permalink to this definition"></a></dt>
<dd><p>Implement the command</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAddCom.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAddCom.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'chanalias aliaschan', 'category': 'comms', 'key': 'addcom', 'tags': '', 'text': '\n add a channel alias and/or subscribe to a channel\n\n Usage:\n addcom [alias=] &lt;channel&gt;\n\n Joins a given channel. If alias is given, this will allow you to\n refer to the channel by this alias rather than the full channel\n name. Subsequent calls of this command can be used to add multiple\n aliases to an already joined channel.\n '}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAddCom.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdDelCom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdDelCom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdDelCom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>remove a channel alias and/or unsubscribe from channel</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>delcom &lt;alias or channel&gt;
delcom/all &lt;channel&gt;</p>
</dd>
</dl>
<p>If the full channel name is given, unsubscribe from the
channel. If an alias is given, remove the alias but don’t
unsubscribe. If the ‘all’ switch is used, remove all aliases
for that channel.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdDelCom.key">
<code class="sig-name descname">key</code><em class="property"> = 'delcom'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdDelCom.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['delchanalias', 'delaliaschan']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdDelCom.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdDelCom.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not perm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdDelCom.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdDelCom.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdDelCom.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom.func" title="Permalink to this definition"></a></dt>
<dd><p>Implementing the command.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdDelCom.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not perm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdDelCom.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'delchanalias delaliaschan', 'category': 'comms', 'key': 'delcom', 'tags': '', 'text': &quot;\n remove a channel alias and/or unsubscribe from channel\n\n Usage:\n delcom &lt;alias or channel&gt;\n delcom/all &lt;channel&gt;\n\n If the full channel name is given, unsubscribe from the\n channel. If an alias is given, remove the alias but don't\n unsubscribe. If the 'all' switch is used, remove all aliases\n for that channel.\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdDelCom.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdAllCom">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdAllCom</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdAllCom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdAllCom" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>perform admin operations on all channels</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>allcom [on | off | who | destroy]</p>
</dd>
</dl>
<p>Allows the user to universally turn off or on all channels they are on, as
well as perform a ‘who’ for all channels they are on. Destroy deletes all
channels that you control.</p>
<p>Without argument, works like comlist.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAllCom.key">
<code class="sig-name descname">key</code><em class="property"> = 'allcom'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAllCom.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAllCom.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAllCom.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAllCom.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAllCom.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAllCom.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAllCom.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdAllCom.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdAllCom.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdAllCom.func" title="Permalink to this definition"></a></dt>
<dd><p>Runs the function</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAllCom.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAllCom.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAllCom.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAllCom.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdAllCom.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'allcom', 'tags': '', 'text': &quot;\n perform admin operations on all channels\n\n Usage:\n allcom [on | off | who | destroy]\n\n Allows the user to universally turn off or on all channels they are on, as\n well as perform a 'who' for all channels they are on. Destroy deletes all\n channels that you control.\n\n Without argument, works like comlist.\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdAllCom.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdChannels">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdChannels</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdChannels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>list all channels available to you</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>channels
clist
comlist</p>
</dd>
</dl>
<p>Lists all channels available to you, whether you listen to them or not.
Use ‘comlist’ to only view your current channel subscriptions.
Use addcom/delcom to join and leave channels</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannels.key">
<code class="sig-name descname">key</code><em class="property"> = 'channels'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannels.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['all channels', 'comlist', 'chanlist', 'clist', 'channellist']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannels.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannels.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannels.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdChannels.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdChannels.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.func" title="Permalink to this definition"></a></dt>
<dd><p>Implement function</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannels.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannels.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'all channels comlist chanlist clist channellist', 'category': 'comms', 'key': 'channels', 'tags': '', 'text': &quot;\n list all channels available to you\n\n Usage:\n channels\n clist\n comlist\n\n Lists all channels available to you, whether you listen to them or not.\n Use 'comlist' to only view your current channel subscriptions.\n Use addcom/delcom to join and leave channels\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdCdestroy">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdCdestroy</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdCdestroy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdCdestroy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>destroy a channel you created</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>cdestroy &lt;channel&gt;</p>
</dd>
</dl>
<p>Destroys a channel that you control.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdestroy.key">
<code class="sig-name descname">key</code><em class="property"> = 'cdestroy'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdestroy.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdestroy.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdestroy.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdestroy.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdestroy.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdestroy.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdestroy.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdCdestroy.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdCdestroy.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdCdestroy.func" title="Permalink to this definition"></a></dt>
<dd><p>Destroy objects cleanly.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdestroy.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdestroy.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdestroy.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdestroy.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdestroy.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'cdestroy', 'tags': '', 'text': '\n destroy a channel you created\n\n Usage:\n cdestroy &lt;channel&gt;\n\n Destroys a channel that you control.\n '}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdestroy.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdCBoot">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdCBoot</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdCBoot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdCBoot" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>kick an account from a channel you control</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>cboot[/quiet] &lt;channel&gt; = &lt;account&gt; [:reason]</p>
</dd>
<dt>Switch:</dt><dd><p>quiet - don’t notify the channel</p>
</dd>
</dl>
<p>Kicks an account or object from a channel you control.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCBoot.key">
<code class="sig-name descname">key</code><em class="property"> = 'cboot'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCBoot.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCBoot.switch_options">
<code class="sig-name descname">switch_options</code><em class="property"> = ('quiet',)</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCBoot.switch_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCBoot.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCBoot.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCBoot.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCBoot.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCBoot.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCBoot.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdCBoot.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdCBoot.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdCBoot.func" title="Permalink to this definition"></a></dt>
<dd><p>implement the function</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCBoot.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCBoot.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCBoot.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCBoot.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCBoot.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'cboot', 'tags': '', 'text': &quot;\n kick an account from a channel you control\n\n Usage:\n cboot[/quiet] &lt;channel&gt; = &lt;account&gt; [:reason]\n\n Switch:\n quiet - don't notify the channel\n\n Kicks an account or object from a channel you control.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCBoot.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdCemit">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdCemit</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdCemit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>send an admin message to a channel you control</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>cemit[/switches] &lt;channel&gt; = &lt;message&gt;</p>
</dd>
<dt>Switches:</dt><dd><p>sendername - attach the sender’s name before the message
quiet - don’t echo the message back to sender</p>
</dd>
</dl>
<p>Allows the user to broadcast a message over a channel as long as
they control it. It does not show the user’s name unless they
provide the /sendername switch.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCemit.key">
<code class="sig-name descname">key</code><em class="property"> = 'cemit'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCemit.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['cmsg']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCemit.switch_options">
<code class="sig-name descname">switch_options</code><em class="property"> = ('sendername', 'quiet')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit.switch_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCemit.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd: not pperm(channel_banned) and pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCemit.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCemit.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdCemit.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdCemit.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit.func" title="Permalink to this definition"></a></dt>
<dd><p>Implement function</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCemit.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd: not pperm(channel_banned) and pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCemit.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cmsg', 'category': 'comms', 'key': 'cemit', 'tags': '', 'text': &quot;\n send an admin message to a channel you control\n\n Usage:\n cemit[/switches] &lt;channel&gt; = &lt;message&gt;\n\n Switches:\n sendername - attach the sender's name before the message\n quiet - don't echo the message back to sender\n\n Allows the user to broadcast a message over a channel as long as\n they control it. It does not show the user's name unless they\n provide the /sendername switch.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCemit.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdCWho">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdCWho</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdCWho"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdCWho" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>show who is listening to a channel</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>cwho &lt;channel&gt;</p>
</dd>
</dl>
<p>List who is connected to a given channel you have access to.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCWho.key">
<code class="sig-name descname">key</code><em class="property"> = 'cwho'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCWho.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCWho.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCWho.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCWho.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCWho.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCWho.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCWho.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdCWho.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdCWho.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdCWho.func" title="Permalink to this definition"></a></dt>
<dd><p>implement function</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCWho.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCWho.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCWho.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd: not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCWho.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCWho.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'cwho', 'tags': '', 'text': '\n show who is listening to a channel\n\n Usage:\n cwho &lt;channel&gt;\n\n List who is connected to a given channel you have access to.\n '}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCWho.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdChannelCreate">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdChannelCreate</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdChannelCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>create a new channel</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>ccreate &lt;new channel&gt;[;alias;alias…] = description</p>
</dd>
</dl>
<p>Creates a new channel owned by you.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannelCreate.key">
<code class="sig-name descname">key</code><em class="property"> = 'ccreate'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannelCreate.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['channelcreate']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannelCreate.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not pperm(channel_banned) and pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannelCreate.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannelCreate.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdChannelCreate.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdChannelCreate.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate.func" title="Permalink to this definition"></a></dt>
<dd><p>Implement the command</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannelCreate.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not pperm(channel_banned) and pperm(Player)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdChannelCreate.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'channelcreate', 'category': 'comms', 'key': 'ccreate', 'tags': '', 'text': '\n create a new channel\n\n Usage:\n ccreate &lt;new channel&gt;[;alias;alias...] = description\n\n Creates a new channel owned by you.\n '}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannelCreate.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdClock">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdClock</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdClock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdClock" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>change channel locks of a channel you control</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>clock &lt;channel&gt; [= &lt;lockstring&gt;]</p>
</dd>
</dl>
<p>Changes the lock access restrictions of a channel. If no
lockstring was given, view the current lock definitions.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdClock.key">
<code class="sig-name descname">key</code><em class="property"> = 'clock'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdClock.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdClock.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdClock.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdClock.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.comms.CmdClock.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdClock.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdClock.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdClock.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdClock.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdClock.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdClock.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdClock.func" title="Permalink to this definition"></a></dt>
<dd><p>run the function</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdClock.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdClock.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdClock.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'clock', 'tags': '', 'text': '\n change channel locks of a channel you control\n\n Usage:\n clock &lt;channel&gt; [= &lt;lockstring&gt;]\n\n Changes the lock access restrictions of a channel. If no\n lockstring was given, view the current lock definitions.\n '}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdClock.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdCdesc">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdCdesc</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdCdesc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdCdesc" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>describe a channel you control</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>cdesc &lt;channel&gt; = &lt;description&gt;</p>
</dd>
</dl>
<p>Changes the description of the channel as shown in
channel lists.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdesc.key">
<code class="sig-name descname">key</code><em class="property"> = 'cdesc'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdesc.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdesc.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdesc.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdesc.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdesc.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdesc.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdesc.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdCdesc.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdCdesc.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdCdesc.func" title="Permalink to this definition"></a></dt>
<dd><p>Implement command</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdesc.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdesc.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdesc.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not pperm(channel_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdesc.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdCdesc.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'cdesc', 'tags': '', 'text': '\n describe a channel you control\n\n Usage:\n cdesc &lt;channel&gt; = &lt;description&gt;\n\n Changes the description of the channel as shown in\n channel lists.\n '}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdCdesc.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdPage">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdPage</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdPage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdPage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>send a private message to another account</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>page[/switches] [&lt;account&gt;,&lt;account&gt;,… = &lt;message&gt;]
tell ‘’
page &lt;number&gt;</p>
</dd>
<dt>Switch:</dt><dd><p>last - shows who you last messaged
list - show your last &lt;number&gt; of tells/pages (default)</p>
</dd>
</dl>
<p>Send a message to target user (if online). If no
argument is given, you will get a list of your latest messages.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdPage.key">
<code class="sig-name descname">key</code><em class="property"> = 'page'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdPage.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['tell']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdPage.switch_options">
<code class="sig-name descname">switch_options</code><em class="property"> = ('last', 'list')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage.switch_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdPage.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:not pperm(page_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdPage.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdPage.account_caller">
<code class="sig-name descname">account_caller</code><em class="property"> = True</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage.account_caller" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdPage.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdPage.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdPage.func" title="Permalink to this definition"></a></dt>
<dd><p>Implement function using the Msg methods</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdPage.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:not pperm(page_banned)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdPage.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'tell', 'category': 'comms', 'key': 'page', 'tags': '', 'text': &quot;\n send a private message to another account\n\n Usage:\n page[/switches] [&lt;account&gt;,&lt;account&gt;,... = &lt;message&gt;]\n tell ''\n page &lt;number&gt;\n\n Switch:\n last - shows who you last messaged\n list - show your last &lt;number&gt; of tells/pages (default)\n\n Send a message to target user (if online). If no\n argument is given, you will get a list of your latest messages.\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdPage.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdIRC2Chan">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdIRC2Chan</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdIRC2Chan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdIRC2Chan" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>Link an evennia channel to an external IRC channel</p>
<dl>
<dt>Usage:</dt><dd><p>irc2chan[/switches] &lt;evennia_channel&gt; = &lt;ircnetwork&gt; &lt;port&gt; &lt;#irchannel&gt; &lt;botname&gt;[:typeclass]
irc2chan/delete botname|#dbid</p>
</dd>
<dt>Switches:</dt><dd><dl class="option-list">
<dt><kbd><span class="option">/delete</span></kbd></dt>
<dd><ul class="simple">
<li><p>this will delete the bot and remove the irc connection</p></li>
</ul>
<p>to the channel. Requires the botname or #dbid as input.</p>
</dd>
<dt><kbd><span class="option">/remove</span></kbd></dt>
<dd><ul class="simple">
<li><p>alias to /delete</p></li>
</ul>
</dd>
</dl>
<p>/disconnect - alias to /delete
/list - show all irc&lt;-&gt;evennia mappings
/ssl - use an SSL-encrypted connection</p>
</dd>
</dl>
<p class="rubric">Example</p>
<p>irc2chan myircchan = irc.dalnet.net 6667 #mychannel evennia-bot
irc2chan public = irc.freenode.net 6667 #evgaming #evbot:accounts.mybot.MyBot</p>
<p>This creates an IRC bot that connects to a given IRC network and
channel. If a custom typeclass path is given, this will be used
instead of the default bot class.
The bot will relay everything said in the evennia channel to the
IRC channel and vice versa. The bot will automatically connect at
server start, so this command need only be given once. The
/disconnect switch will permanently delete the bot. To only
temporarily deactivate it, use the <a href="#id1"><span class="problematic" id="id2">|</span></a>wservices|n command instead.
Provide an optional bot class path to use a custom bot.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRC2Chan.key">
<code class="sig-name descname">key</code><em class="property"> = 'irc2chan'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRC2Chan.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRC2Chan.switch_options">
<code class="sig-name descname">switch_options</code><em class="property"> = ('delete', 'remove', 'disconnect', 'list', 'ssl')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRC2Chan.switch_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRC2Chan.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:serversetting(IRC_ENABLED) and pperm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRC2Chan.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRC2Chan.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRC2Chan.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdIRC2Chan.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdIRC2Chan.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdIRC2Chan.func" title="Permalink to this definition"></a></dt>
<dd><p>Setup the irc-channel mapping</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRC2Chan.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRC2Chan.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRC2Chan.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:serversetting(IRC_ENABLED) and pperm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRC2Chan.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRC2Chan.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'irc2chan', 'tags': '', 'text': '\n Link an evennia channel to an external IRC channel\n\n Usage:\n irc2chan[/switches] &lt;evennia_channel&gt; = &lt;ircnetwork&gt; &lt;port&gt; &lt;#irchannel&gt; &lt;botname&gt;[:typeclass]\n irc2chan/delete botname|#dbid\n\n Switches:\n /delete - this will delete the bot and remove the irc connection\n to the channel. Requires the botname or #dbid as input.\n /remove - alias to /delete\n /disconnect - alias to /delete\n /list - show all irc&lt;-&gt;evennia mappings\n /ssl - use an SSL-encrypted connection\n\n Example:\n irc2chan myircchan = irc.dalnet.net 6667 #mychannel evennia-bot\n irc2chan public = irc.freenode.net 6667 #evgaming #evbot:accounts.mybot.MyBot\n\n This creates an IRC bot that connects to a given IRC network and\n channel. If a custom typeclass path is given, this will be used\n instead of the default bot class.\n The bot will relay everything said in the evennia channel to the\n IRC channel and vice versa. The bot will automatically connect at\n server start, so this command need only be given once. The\n /disconnect switch will permanently delete the bot. To only\n temporarily deactivate it, use the |wservices|n command instead.\n Provide an optional bot class path to use a custom bot.\n '}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRC2Chan.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdIRCStatus">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdIRCStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdIRCStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdIRCStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>Check and reboot IRC bot.</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>ircstatus [#dbref ping||nicklist||reconnect]</p>
</dd>
</dl>
<p>If not given arguments, will return a list of all bots (like
irc2chan/list). The ‘ping’ argument will ping the IRC network to
see if the connection is still responsive. The ‘nicklist’ argument
(aliases are ‘who’ and ‘users’) will return a list of users on the
remote IRC channel. Finally, ‘reconnect’ will force the client to
disconnect and reconnect again. This may be a last resort if the
client has silently lost connection (this may happen if the remote
network experience network issues). During the reconnection
messages sent to either channel will be lost.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRCStatus.key">
<code class="sig-name descname">key</code><em class="property"> = 'ircstatus'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRCStatus.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRCStatus.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:serversetting(IRC_ENABLED) and perm(ircstatus) or perm(Builder))'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRCStatus.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRCStatus.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRCStatus.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdIRCStatus.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdIRCStatus.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdIRCStatus.func" title="Permalink to this definition"></a></dt>
<dd><p>Handles the functioning of the command.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRCStatus.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRCStatus.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRCStatus.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:serversetting(IRC_ENABLED) and perm(ircstatus) or perm(Builder))'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRCStatus.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdIRCStatus.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'ircstatus', 'tags': '', 'text': &quot;\n Check and reboot IRC bot.\n\n Usage:\n ircstatus [#dbref ping||nicklist||reconnect]\n\n If not given arguments, will return a list of all bots (like\n irc2chan/list). The 'ping' argument will ping the IRC network to\n see if the connection is still responsive. The 'nicklist' argument\n (aliases are 'who' and 'users') will return a list of users on the\n remote IRC channel. Finally, 'reconnect' will force the client to\n disconnect and reconnect again. This may be a last resort if the\n client has silently lost connection (this may happen if the remote\n network experience network issues). During the reconnection\n messages sent to either channel will be lost.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdIRCStatus.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdRSS2Chan">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdRSS2Chan</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdRSS2Chan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdRSS2Chan" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>link an evennia channel to an external RSS feed</p>
<dl>
<dt>Usage:</dt><dd><p>rss2chan[/switches] &lt;evennia_channel&gt; = &lt;rss_url&gt;</p>
</dd>
<dt>Switches:</dt><dd><dl class="simple">
<dt>/disconnect - this will stop the feed and remove the connection to the</dt><dd><p>channel.</p>
</dd>
</dl>
<dl class="option-list">
<dt><kbd><span class="option">/remove</span></kbd></dt>
<dd><ul class="simple">
<li><p>“</p></li>
</ul>
</dd>
<dt><kbd><span class="option">/list</span></kbd></dt>
<dd><ul class="simple">
<li><p>show all rss-&gt;evennia mappings</p></li>
</ul>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Example</p>
<p>rss2chan rsschan = <a class="reference external" href="http://code.google.com/feeds/p/evennia/updates/basic">http://code.google.com/feeds/p/evennia/updates/basic</a></p>
<p>This creates an RSS reader that connects to a given RSS feed url. Updates
will be echoed as a title and news link to the given channel. The rate of
updating is set with the RSS_UPDATE_INTERVAL variable in settings (default
is every 10 minutes).</p>
<p>When disconnecting you need to supply both the channel and url again so as
to identify the connection uniquely.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdRSS2Chan.key">
<code class="sig-name descname">key</code><em class="property"> = 'rss2chan'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdRSS2Chan.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdRSS2Chan.switch_options">
<code class="sig-name descname">switch_options</code><em class="property"> = ('disconnect', 'remove', 'list')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdRSS2Chan.switch_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdRSS2Chan.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:serversetting(RSS_ENABLED) and pperm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdRSS2Chan.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdRSS2Chan.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdRSS2Chan.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdRSS2Chan.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdRSS2Chan.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdRSS2Chan.func" title="Permalink to this definition"></a></dt>
<dd><p>Setup the rss-channel mapping</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdRSS2Chan.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.comms.CmdRSS2Chan.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdRSS2Chan.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:serversetting(RSS_ENABLED) and pperm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdRSS2Chan.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdRSS2Chan.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'rss2chan', 'tags': '', 'text': '\n link an evennia channel to an external RSS feed\n\n Usage:\n rss2chan[/switches] &lt;evennia_channel&gt; = &lt;rss_url&gt;\n\n Switches:\n /disconnect - this will stop the feed and remove the connection to the\n channel.\n /remove - &quot;\n /list - show all rss-&gt;evennia mappings\n\n Example:\n rss2chan rsschan = http://code.google.com/feeds/p/evennia/updates/basic\n\n This creates an RSS reader that connects to a given RSS feed url. Updates\n will be echoed as a title and news link to the given channel. The rate of\n updating is set with the RSS_UPDATE_INTERVAL variable in settings (default\n is every 10 minutes).\n\n When disconnecting you need to supply both the channel and url again so as\n to identify the connection uniquely.\n '}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdRSS2Chan.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.commands.default.comms.CmdGrapevine2Chan">
<em class="property">class </em><code class="sig-prename descclassname">evennia.commands.default.comms.</code><code class="sig-name descname">CmdGrapevine2Chan</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdGrapevine2Chan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdGrapevine2Chan" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
<p>Link an Evennia channel to an exteral Grapevine channel</p>
<dl>
<dt>Usage:</dt><dd><p>grapevine2chan[/switches] &lt;evennia_channel&gt; = &lt;grapevine_channel&gt;
grapevine2chan/disconnect &lt;connection #id&gt;</p>
</dd>
<dt>Switches:</dt><dd><dl class="option-list">
<dt><kbd><span class="option">/list</span></kbd></dt>
<dd><ul class="simple">
<li><p>(or no switch): show existing grapevine &lt;-&gt; Evennia</p></li>
</ul>
<p>mappings and available grapevine chans</p>
</dd>
<dt><kbd><span class="option">/remove</span></kbd></dt>
<dd><ul class="simple">
<li><p>alias to disconnect</p></li>
</ul>
</dd>
<dt><kbd><span class="option">/delete</span></kbd></dt>
<dd><ul class="simple">
<li><p>alias to disconnect</p></li>
</ul>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Example</p>
<p>grapevine2chan mygrapevine = gossip</p>
<p>This creates a link between an in-game Evennia channel and an external
Grapevine channel. The game must be registered with the Grapevine network
(register at <a class="reference external" href="https://grapevine.haus">https://grapevine.haus</a>) and the GRAPEVINE_* auth information
must be added to game settings.</p>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdGrapevine2Chan.key">
<code class="sig-name descname">key</code><em class="property"> = 'grapevine2chan'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdGrapevine2Chan.key" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdGrapevine2Chan.switch_options">
<code class="sig-name descname">switch_options</code><em class="property"> = ('disconnect', 'remove', 'delete', 'list')</em><a class="headerlink" href="#evennia.commands.default.comms.CmdGrapevine2Chan.switch_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdGrapevine2Chan.locks">
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:serversetting(GRAPEVINE_ENABLED) and pperm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdGrapevine2Chan.locks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdGrapevine2Chan.help_category">
<code class="sig-name descname">help_category</code><em class="property"> = 'comms'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdGrapevine2Chan.help_category" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.commands.default.comms.CmdGrapevine2Chan.func">
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/commands/default/comms.html#CmdGrapevine2Chan.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.commands.default.comms.CmdGrapevine2Chan.func" title="Permalink to this definition"></a></dt>
<dd><p>Setup the Grapevine channel mapping</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdGrapevine2Chan.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.commands.default.comms.CmdGrapevine2Chan.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdGrapevine2Chan.lock_storage">
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:serversetting(GRAPEVINE_ENABLED) and pperm(Developer)'</em><a class="headerlink" href="#evennia.commands.default.comms.CmdGrapevine2Chan.lock_storage" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.commands.default.comms.CmdGrapevine2Chan.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'comms', 'key': 'grapevine2chan', 'tags': '', 'text': '\n Link an Evennia channel to an exteral Grapevine channel\n\n Usage:\n grapevine2chan[/switches] &lt;evennia_channel&gt; = &lt;grapevine_channel&gt;\n grapevine2chan/disconnect &lt;connection #id&gt;\n\n Switches:\n /list - (or no switch): show existing grapevine &lt;-&gt; Evennia\n mappings and available grapevine chans\n /remove - alias to disconnect\n /delete - alias to disconnect\n\n Example:\n grapevine2chan mygrapevine = gossip\n\n This creates a link between an in-game Evennia channel and an external\n Grapevine channel. The game must be registered with the Grapevine network\n (register at https://grapevine.haus) and the GRAPEVINE_* auth information\n must be added to game settings.\n '}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdGrapevine2Chan.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="clearer"></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>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.commands.default.comms.rst.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div>
<h3>Versions</h3>
<ul>
<li><a href="evennia.commands.default.comms.html">1.0-dev (develop branch)</a></li>
<li><a href="../../0.9.5/api/evennia.commands.default.comms.html">0.9.5 (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</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.commands.default.comms</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink