<spanid="evennia-comms-comms"></span><h1>evennia.comms.comms<aclass="headerlink"href="#module-evennia.comms.comms"title="Permalink to this headline">¶</a></h1>
<p>Base typeclass for in-game Channels.</p>
<dlclass="py class">
<dtid="evennia.comms.comms.DefaultChannel">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.comms.comms.</code><codeclass="sig-name descname">DefaultChannel</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">objects</code><emclass="property"> = <evennia.comms.managers.ChannelManager object></em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.objects"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">send_to_online_only</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.send_to_online_only"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">log_file</code><emclass="property"> = 'channel_{channelname}.log'</em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.log_file"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">channel_prefix_string</code><emclass="property"> = '[{channelname}] '</em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.channel_prefix_string"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">channel_msg_nick_pattern</code><emclass="property"> = '{alias}\\s*?|{alias}\\s+?(?P<arg1>.+?)'</em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.channel_msg_nick_pattern"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">channel_msg_nick_replacement</code><emclass="property"> = '@channel {channelname} = $1'</em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.channel_msg_nick_replacement"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_first_save</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.at_first_save"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.at_first_save"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the typeclass system the very first time the channel
is saved to the database. Generally, don’t overload this but
<codeclass="sig-name descname">basetype_setup</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.basetype_setup"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.basetype_setup"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_channel_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.at_channel_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.at_channel_creation"title="Permalink to this definition">¶</a></dt>
<dd><p>Called once, when the channel is first created.</p>
<codeclass="sig-name descname">get_log_filename</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.get_log_filename"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.get_log_filename"title="Permalink to this definition">¶</a></dt>
<dd><p>File name to use for channel log.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><p><em>str</em>–</p>
<dlclass="simple">
<dt>The filename to use (this is always assumed to be inside</dt><dd><p>settings.LOG_DIR)</p>
<codeclass="sig-name descname">set_log_filename</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">filename</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.set_log_filename"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.set_log_filename"title="Permalink to this definition">¶</a></dt>
<dd><p>Set a custom log filename.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filename</strong> (<em>str</em>) – The filename to set. This is a path starting from
<codeclass="sig-name descname">has_connection</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">subscriber</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.has_connection"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.has_connection"title="Permalink to this definition">¶</a></dt>
<dd><p>Checks so this account is actually listening
to this channel.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>subscriber</strong> (<em>Account</em><em> or </em><em>Object</em>) – Entity to check.</p>
<emclass="property">property </em><codeclass="sig-name descname">mutelist</code><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.mutelist"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">banlist</code><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.banlist"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">wholist</code><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.wholist"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="evennia.comms.comms.DefaultChannel.mute">
<codeclass="sig-name descname">mute</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">subscriber</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.mute"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.mute"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds an entity to the list of muted subscribers.
A muted subscriber will no longer see channel messages,
but may use channel commands.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>subscriber</strong> (<em>Object</em><em> or </em><em>Account</em>) – Subscriber to mute.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><p><em>bool</em>–</p>
<dlclass="simple">
<dt>True if muting was successful, False if we were already</dt><dd><p>muted.</p>
<codeclass="sig-name descname">unmute</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">subscriber</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.unmute"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.unmute"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes an entity from the list of muted subscribers. A muted subscriber
will no longer see channel messages, but may use channel commands.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>subscriber</strong> (<em>Object</em><em> or </em><em>Account</em>) – The subscriber to unmute.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><p><em>bool</em>–</p>
<dlclass="simple">
<dt>True if unmuting was successful, False if we were already</dt><dd><p>unmuted.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtid="evennia.comms.comms.DefaultChannel.ban">
<codeclass="sig-name descname">ban</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">target</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.ban"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.ban"title="Permalink to this definition">¶</a></dt>
<dd><p>Ban a given user from connecting to the channel. This will not stop
users already connected, so the user must be booted for this to take
effect.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>target</strong> (<em>Object</em><em> or </em><em>Account</em>) – The entity to unmute. This need not
be a subscriber.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><p><em>bool</em>–</p>
<dlclass="simple">
<dt>True if banning was successful, False if target was already</dt><dd><p>banned.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtid="evennia.comms.comms.DefaultChannel.unban">
<codeclass="sig-name descname">unban</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">target</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.unban"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.unban"title="Permalink to this definition">¶</a></dt>
<dd><p>Un-Ban a given user. This will not reconnect them - they will still
have to reconnect and set up aliases anew.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>target</strong> (<em>Object</em><em> or </em><em>Account</em>) – The entity to unmute. This need not
be a subscriber.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><p><em>bool</em>–</p>
<dlclass="simple">
<dt>True if unbanning was successful, False if target was not</dt><dd><p>previously banned.</p>
<codeclass="sig-name descname">connect</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">subscriber</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.connect"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.connect"title="Permalink to this definition">¶</a></dt>
<dd><p>Connect the user to this channel. This checks access.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>subscriber</strong> (<em>Account</em><em> or </em><em>Object</em>) – the entity to subscribe
to this channel.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
<codeclass="sig-name descname">disconnect</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">subscriber</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.disconnect"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.disconnect"title="Permalink to this definition">¶</a></dt>
<dd><p>Disconnect entity from this channel.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>subscriber</strong> (<em>Account of Object</em>) – the
entity to disconnect.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
<codeclass="sig-name descname">access</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">access_type</span><spanclass="o">=</span><spanclass="default_value">'listen'</span></em>, <emclass="sig-param"><spanclass="n">default</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">no_superuser_bypass</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.access"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.access"title="Permalink to this definition">¶</a></dt>
<dd><p>Determines if another object has permission to access.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>accessing_obj</strong> (<em>Object</em>) – Object trying to access this one.</p></li>
<li><p><strong>access_type</strong> (<em>str</em><em>, </em><em>optional</em>) – Type of access sought.</p></li>
<li><p><strong>default</strong> (<em>bool</em><em>, </em><em>optional</em>) – What to return if no lock of access_type was found</p></li>
<li><p><strong>no_superuser_bypass</strong> (<em>bool</em><em>, </em><em>optional</em>) – Turns off superuser
lock bypass. Be careful with this one.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>return (bool)</em>– Result of lock check.</p>
<emclass="property">classmethod </em><codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">key</span></em>, <emclass="sig-param"><spanclass="n">creator</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.create"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a basic Channel with default parameters, unless otherwise
specified or extended.</p>
<p>Provides a friendlier interface to the utils.create_channel() function.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>key</strong> (<em>str</em>) – This must be unique.</p></li>
<li><p><strong>creator</strong> (<em>Account</em><em> or </em><em>Object</em>) – Entity to associate with this channel
(used for tracking)</p></li>
</ul>
</dd>
<dtclass="field-even">Keyword Arguments</dt>
<ddclass="field-even"><ulclass="simple">
<li><p><strong>aliases</strong> (<em>list of str</em>) – List of alternative (likely shorter) keynames.</p></li>
<li><p><strong>description</strong> (<em>str</em>) – A description of the channel, for use in listings.</p></li>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.delete"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes channel.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><p><em>bool</em>–</p>
<dlclass="simple">
<dt>If deletion was successful. Only time it can fail would be</dt><dd><p>if channel was already deleted. Even if it were to fail, all subscribers
<codeclass="sig-name descname">channel_prefix</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.channel_prefix"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.channel_prefix"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. How the channel should prefix itself for users.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><em>str</em>– The channel prefix.</p>
<codeclass="sig-name descname">add_user_channel_alias</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">user</span></em>, <emclass="sig-param"><spanclass="n">alias</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.add_user_channel_alias"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.add_user_channel_alias"title="Permalink to this definition">¶</a></dt>
<dd><p>Add a personal user-alias for this channel to a given subscriber.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>user</strong> (<em>Object</em><em> or </em><em>Account</em>) – The one to alias this channel.</p></li>
<li><p><strong>alias</strong> (<em>str</em>) – The desired alias.</p></li>
</ul>
</dd>
</dl>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This is tightly coupled to the default <strong>channel</strong> command. If you
change that, you need to change this as well.</p>
<p>We add two nicks - one is a plain <strong>alias -> channel.key</strong> that
users need to be able to reference this channel easily. The other
is a templated nick to easily be able to send messages to the
channel without needing to give the full <strong>channel</strong> command. The
structure of this nick is given by <strong>self.channel_msg_nick_pattern</strong>
and <strong>self.channel_msg_nick_replacement</strong>. By default it maps
<strong>alias <msg> -> channel <channelname> = <msg></strong>, so that you can
for example just write <strong>pub Hello</strong> to send a message.</p>
<p>The alias created is <strong>alias $1 -> channel channel = $1</strong>, to allow
for sending to channel using the main channel command.</p>
<emclass="property">classmethod </em><codeclass="sig-name descname">remove_user_channel_alias</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">user</span></em>, <emclass="sig-param"><spanclass="n">alias</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.remove_user_channel_alias"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.remove_user_channel_alias"title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a personal channel alias from a user.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>user</strong> (<em>Object</em><em> or </em><em>Account</em>) – The user to remove an alias from.</p></li>
<li><p><strong>alias</strong> (<em>str</em>) – The alias to remove.</p></li>
<li><p><strong>**kwargs</strong>– Unused by default. Can be used to pass extra variables
into a custom implementation.</p></li>
</ul>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>The channel-alias actually consists of two aliases - one
channel-based one for searching channels with the alias and one
inputline one for doing the ‘channelalias msg’ - call.</p>
<p>This is a classmethod because it doesn’t actually operate on the
channel instance.</p>
<p>It sits on the channel because the nick structure for this is
pretty complex and needs to be located in a central place (rather
<codeclass="sig-name descname">at_pre_msg</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">message</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.at_pre_msg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.at_pre_msg"title="Permalink to this definition">¶</a></dt>
<dd><p>Called before the starting of sending the message to a receiver. This
is called before any hooks on the receiver itself. If this returns
None/False, the sending will be aborted.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>message</strong> (<em>str</em>) – The message to send.</p></li>
<li><p><strong>**kwargs</strong> (<em>any</em>) – Keywords passed on from <strong>.msg</strong>. This includes
<strong>senders</strong>.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><p><em>str, False or None</em>–</p>
<dlclass="simple">
<dt>Any custom changes made to the message. If</dt><dd><p>falsy, no message will be sent.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtid="evennia.comms.comms.DefaultChannel.msg">
<codeclass="sig-name descname">msg</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">message</span></em>, <emclass="sig-param"><spanclass="n">senders</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">bypass_mute</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.msg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.msg"title="Permalink to this definition">¶</a></dt>
<dd><p>Send message to channel, causing it to be distributed to all non-muted
subscribed users of that channel.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>message</strong> (<em>str</em>) – The message to send.</p></li>
<li><p><strong>senders</strong> (<em>Object</em><em>, </em><em>Account</em><em> or </em><em>list</em><em>, </em><em>optional</em>) – If not given, there is
no way to associate one or more senders with the message (like
a broadcast message or similar).</p></li>
<li><p><strong>bypass_mute</strong> (<em>bool</em><em>, </em><em>optional</em>) – If set, always send, regardless of
individual mute-state of subscriber. This can be used for
global announcements or warnings/alerts.</p></li>
<li><p><strong>**kwargs</strong> (<em>any</em>) – This will be passed on to all hooks. Use <strong>no_prefix</strong>
to exclude the channel prefix.</p></li>
</ul>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>The call hook calling sequence is:</p>
<ulclass="simple">
<li><p><strong>msg = channel.at_pre_msg(message, **kwargs)</strong> (aborts for all if return None)</p></li>
<li><p><strong>msg = receiver.at_pre_channel_msg(msg, channel, **kwargs)</strong> (aborts for receiver if return None)</p></li>
<codeclass="sig-name descname">at_post_msg</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">message</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.at_post_msg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.at_post_msg"title="Permalink to this definition">¶</a></dt>
<dd><p>This is called after sending to <em>all</em> valid recipients. It is normally
used for logging/channel history.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>message</strong> (<em>str</em>) – The message sent.</p></li>
<li><p><strong>**kwargs</strong> (<em>any</em>) – Keywords passed on from <strong>msg</strong>, including <strong>senders</strong>.</p></li>
<codeclass="sig-name descname">pre_join_channel</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">joiner</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.pre_join_channel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.pre_join_channel"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. Runs right before a channel is joined. If this
returns a false value, channel joining is aborted.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>joiner</strong> (<em>object</em>) – The joining object.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>should_join (bool)</em>– If <strong>False</strong>, channel joining is aborted.</p>
<codeclass="sig-name descname">post_join_channel</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">joiner</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.post_join_channel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.post_join_channel"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. Runs right after an object or account joins a channel.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>joiner</strong> (<em>object</em>) – The joining object.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>By default this adds the needed channel nicks to the joiner.</p>
<codeclass="sig-name descname">pre_leave_channel</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">leaver</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.pre_leave_channel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.pre_leave_channel"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. Runs right before a user leaves a channel. If this returns a false
value, leaving the channel will be aborted.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>leaver</strong> (<em>object</em>) – The leaving object.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>should_leave (bool)</em>– If <strong>False</strong>, channel parting is aborted.</p>
<codeclass="sig-name descname">post_leave_channel</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">leaver</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.post_leave_channel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.post_leave_channel"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. Runs right after an object or account leaves a channel.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>leaver</strong> (<em>object</em>) – The leaving object.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
<codeclass="sig-name descname">at_init</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.at_init"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.at_init"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. This is always called whenever this channel is
initiated – that is, whenever it its typeclass is cached from
memory. This happens on-demand first time the channel is used
or activated in some way after being created but also after
<codeclass="sig-name descname">web_get_admin_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.web_get_admin_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.web_get_admin_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for the Django Admin page for this object.</p>
<emclass="property">classmethod </em><codeclass="sig-name descname">web_get_create_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.web_get_create_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.web_get_create_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to create new
instances of this object.</p>
<p>ex. Chargen = ‘/characters/create/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘channel-create’ would be referenced by this method.</p>
<codeclass="sig-name descname">web_get_detail_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.web_get_detail_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.web_get_detail_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to view details for
this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘channel-detail’ would be referenced by this method.</p>
<codeclass="sig-name descname">web_get_update_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.web_get_update_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.web_get_update_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to update this
object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/change/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘channel-update’ would be referenced by this method.</p>
<codeclass="sig-name descname">web_get_delete_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.web_get_delete_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.web_get_delete_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to delete this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/delete/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘channel-delete’ would be referenced by this method.</p>
<codeclass="sig-name descname">get_absolute_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.get_absolute_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to view details for
this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘channel-detail’ would be referenced by this method.</p>
<codeclass="sig-name descname">message_transform</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.message_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.message_transform"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">distribute_message</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msgobj</span></em>, <emclass="sig-param"><spanclass="n">online</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.distribute_message"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.distribute_message"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_senders</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">senders</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.format_senders"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.format_senders"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">pose_transform</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msgobj</span></em>, <emclass="sig-param"><spanclass="n">sender_string</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.pose_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.pose_transform"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_external</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msgobj</span></em>, <emclass="sig-param"><spanclass="n">senders</span></em>, <emclass="sig-param"><spanclass="n">emit</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.format_external"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.format_external"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_message</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msgobj</span></em>, <emclass="sig-param"><spanclass="n">emit</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.format_message"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.format_message"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">pre_send_message</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msg</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.pre_send_message"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.pre_send_message"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">post_send_message</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msg</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.post_send_message"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.post_send_message"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.comms.comms.DefaultChannel'</em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'DefaultChannel'</em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.typename"title="Permalink to this definition">¶</a></dt>
