mirror of
https://github.com/evennia/evennia.git
synced 2026-03-28 02:36:32 +01:00
Updated HTML docs
This commit is contained in:
Griatch
parent
66d0ad0bc9
commit
7900aad365
2073 changed files with 32986 additions and 41197 deletions
|
|
@ -14,6 +14,8 @@
|
|||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</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" />
|
||||
|
|
@ -621,6 +623,129 @@ object the first time, the query is executed.</p>
|
|||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.comms.models.SubscriptionHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.comms.models.</code><code class="sig-name descname">SubscriptionHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/models.html#SubscriptionHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.models.SubscriptionHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>This handler manages subscriptions to the
|
||||
channel and hides away which type of entity is
|
||||
subscribing (Account or Object)</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.models.SubscriptionHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/models.html#SubscriptionHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.models.SubscriptionHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Initialize the handler</p>
|
||||
<dl class="simple">
|
||||
<dt>Attr:</dt><dd><p>obj (ChannelDB): The channel the handler sits on.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.models.SubscriptionHandler.has">
|
||||
<code class="sig-name descname">has</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">entity</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/models.html#SubscriptionHandler.has"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.models.SubscriptionHandler.has" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Check if the given entity subscribe to this channel</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>entity</strong> (<em>str</em><em>, </em><em>Account</em><em> or </em><em>Object</em>) – The entity to return. If
|
||||
a string, it assumed to be the key or the #dbref
|
||||
of the entity.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>subscriber (Account, Object or None)</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>The given</dt><dd><p>subscriber.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.models.SubscriptionHandler.add">
|
||||
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">entity</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/models.html#SubscriptionHandler.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.models.SubscriptionHandler.add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Subscribe an entity to this channel.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>entity</strong> (<em>Account</em><em>, </em><em>Object</em><em> or </em><em>list</em>) – The entity or
|
||||
list of entities to subscribe to this channel.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<dl class="simple">
|
||||
<dt>No access-checking is done here, this must have</dt><dd><p>been done before calling this method. Also
|
||||
no hooks will be called.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.models.SubscriptionHandler.remove">
|
||||
<code class="sig-name descname">remove</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">entity</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/models.html#SubscriptionHandler.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.models.SubscriptionHandler.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove a subscriber from the channel.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>entity</strong> (<em>Account</em><em>, </em><em>Object</em><em> or </em><em>list</em>) – The entity or
|
||||
entities to un-subscribe from the channel.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.models.SubscriptionHandler.all">
|
||||
<code class="sig-name descname">all</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/models.html#SubscriptionHandler.all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.models.SubscriptionHandler.all" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get all subscriptions to this channel.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><p><em>subscribers (list)</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>The subscribers. This</dt><dd><p>may be a mix of Accounts and Objects!</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.models.SubscriptionHandler.get">
|
||||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#evennia.comms.models.SubscriptionHandler.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get all subscriptions to this channel.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><p><em>subscribers (list)</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>The subscribers. This</dt><dd><p>may be a mix of Accounts and Objects!</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.models.SubscriptionHandler.online">
|
||||
<code class="sig-name descname">online</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/models.html#SubscriptionHandler.online"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.models.SubscriptionHandler.online" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get all online accounts from our cache
|
||||
:returns: <em>subscribers (list)</em> –</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dt>Subscribers who are online or</dt><dd><p>are puppeted by an online account.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.comms.models.SubscriptionHandler.clear">
|
||||
<code class="sig-name descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/comms/models.html#SubscriptionHandler.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.comms.models.SubscriptionHandler.clear" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove all subscribers from channel.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -646,7 +771,7 @@ object the first time, the query is executed.</p>
|
|||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/api/evennia.comms.models.rst.txt"
|
||||
<li><a href="../_sources/api/evennia.comms.models.md.txt"
|
||||
rel="nofollow">Show Page Source</a></li>
|
||||
</ul>
|
||||
</div><h3>Links</h3>
|
||||
|
|
@ -663,7 +788,7 @@ object the first time, the query is executed.</p>
|
|||
<h3>Versions</h3>
|
||||
<ul>
|
||||
<li><a href="evennia.comms.models.html">1.0-dev (develop branch)</a></li>
|
||||
<li><a href="../../0.9.5/api/evennia.comms.models.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
<li><a href="../../0.95/api/evennia.comms.models.html">0.95 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue