mirror of
https://github.com/evennia/evennia.git
synced 2026-03-24 00:36:30 +01:00
Updated HTML docs
This commit is contained in:
Griatch
parent
86fb09d6bf
commit
86c930be7a
1221 changed files with 76528 additions and 29095 deletions
|
|
@ -30,6 +30,7 @@
|
|||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.server.sessionhandler</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
|
|
@ -42,8 +43,7 @@
|
|||
<p>This module defines handlers for storing sessions when handles
|
||||
sessions of users connecting to the server.</p>
|
||||
<p>There are two similar but separate stores of sessions:</p>
|
||||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<ul class="simple">
|
||||
<li><dl class="simple">
|
||||
<dt>ServerSessionHandler - this stores generic game sessions</dt><dd><p>for the game. These sessions has no knowledge about
|
||||
how they are connected to the world.</p>
|
||||
|
|
@ -57,7 +57,6 @@ handle network communication but holds no game info.</p>
|
|||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
</div></blockquote>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.server.sessionhandler.DummySession">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.sessionhandler.</code><code class="sig-name descname">DummySession</code><a class="reference internal" href="../_modules/evennia/server/sessionhandler.html#DummySession"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.sessionhandler.DummySession" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -116,35 +115,27 @@ sessions in store.</p>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.server.sessionhandler.SessionHandler.clean_senddata">
|
||||
<code class="sig-name descname">clean_senddata</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session</span></em>, <em class="sig-param"><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/sessionhandler.html#SessionHandler.clean_senddata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.sessionhandler.SessionHandler.clean_senddata" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Clean up data for sending across the AMP wire. Also apply INLINEFUNCS.</p>
|
||||
<dd><p>Clean up data for sending across the AMP wire. Also apply the
|
||||
FuncParser using callables from <strong>settings.FUNCPARSER_OUTGOING_MESSAGES_MODULES</strong>.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>session</strong> (<a class="reference internal" href="evennia.server.session.html#evennia.server.session.Session" title="evennia.server.session.Session"><em>Session</em></a>) – The relevant session instance.</p></li>
|
||||
<li><p><strong>kwargs</strong> (<em>dict</em>) – <p>send-instruction, with the keyword itself being the name
|
||||
of the instruction (like “text”). Suitable values for each
|
||||
keyword are:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">arg</span> <span class="o">-></span> <span class="p">[[</span><span class="n">arg</span><span class="p">],</span> <span class="p">{}]</span>
|
||||
<span class="p">[</span><span class="n">args</span><span class="p">]</span> <span class="o">-></span> <span class="p">[[</span><span class="n">args</span><span class="p">],</span> <span class="p">{}]</span>
|
||||
<span class="p">{</span><span class="n">kwargs</span><span class="p">}</span> <span class="o">-></span> <span class="p">[[],</span> <span class="p">{</span><span class="n">kwargs</span><span class="p">}]</span>
|
||||
<span class="p">[</span><span class="n">args</span><span class="p">,</span> <span class="p">{</span><span class="n">kwargs</span><span class="p">}]</span> <span class="o">-></span> <span class="p">[[</span><span class="n">arg</span><span class="p">],</span> <span class="p">{</span><span class="n">kwargs</span><span class="p">}]</span>
|
||||
<span class="p">[[</span><span class="n">args</span><span class="p">],</span> <span class="p">{</span><span class="n">kwargs</span><span class="p">}]</span> <span class="o">-></span> <span class="p">[[</span><span class="n">args</span><span class="p">],</span> <span class="p">{</span><span class="n">kwargs</span><span class="p">}]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</p></li>
|
||||
<li><p><strong>kwargs</strong> (<em>dict</em>) – the name of the instruction (like “text”). Suitable values for each keyword are:
|
||||
- arg -> [[arg], {}]
|
||||
- [args] -> [[args], {}]
|
||||
- {kwargs} -> [[], {kwargs}]
|
||||
- [args, {kwargs}] -> [[arg], {kwargs}]
|
||||
- [[args], {kwargs}] -> [[args], {kwargs}]</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><p><em>kwargs (dict)</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>A cleaned dictionary of cmdname:[[args],{kwargs}] pairs,</dt><dd><p>where the keys, args and kwargs have all been converted to
|
||||
send-safe entities (strings or numbers), and inlinefuncs have been
|
||||
<dd class="field-even"><p><em>kwargs (dict)</em> – A cleaned dictionary of cmdname:[[args],{kwargs}] pairs,
|
||||
where the keys, args and kwargs have all been converted to
|
||||
send-safe entities (strings or numbers), and funcparser parsing has been
|
||||
applied.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -153,13 +144,10 @@ applied.</p>
|
|||
<dt id="evennia.server.sessionhandler.ServerSessionHandler">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.sessionhandler.</code><code class="sig-name descname">ServerSessionHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <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/server/sessionhandler.html#ServerSessionHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.sessionhandler.ServerSessionHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#evennia.server.sessionhandler.SessionHandler" title="evennia.server.sessionhandler.SessionHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.server.sessionhandler.SessionHandler</span></code></a></p>
|
||||
<p>This object holds the stack of sessions active in the game at
|
||||
any time.</p>
|
||||
<p>A session register with the handler in two steps, first by
|
||||
registering itself with the connect() method. This indicates an
|
||||
non-authenticated session. Whenever the session is authenticated
|
||||
the session together with the related account is sent to the login()
|
||||
method.</p>
|
||||
<p>This object holds the stack of sessions active in the game at any time.</p>
|
||||
<p>A session register with the handler in two steps, first by registering itself with the connect()
|
||||
method. This indicates an non-authenticated session. Whenever the session is authenticated the
|
||||
session together with the related account is sent to the login() method.</p>
|
||||
<dl class="py method">
|
||||
<dt id="evennia.server.sessionhandler.ServerSessionHandler.__init__">
|
||||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <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/server/sessionhandler.html#ServerSessionHandler.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.sessionhandler.ServerSessionHandler.__init__" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -279,9 +267,8 @@ itself down)</p>
|
|||
<dl class="py method">
|
||||
<dt id="evennia.server.sessionhandler.ServerSessionHandler.login">
|
||||
<code class="sig-name descname">login</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session</span></em>, <em class="sig-param"><span class="n">account</span></em>, <em class="sig-param"><span class="n">force</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">testmode</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/sessionhandler.html#ServerSessionHandler.login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.sessionhandler.ServerSessionHandler.login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Log in the previously unloggedin session and the account we by
|
||||
now should know is connected to it. After this point we assume
|
||||
the session to be logged in one way or another.</p>
|
||||
<dd><p>Log in the previously unloggedin session and the account we by now should know is connected
|
||||
to it. After this point we assume the session to be logged in one way or another.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
|
|
@ -463,7 +450,7 @@ object.</p>
|
|||
</dl>
|
||||
<dl class="simple">
|
||||
<dt>Returns.</dt><dd><dl class="simple">
|
||||
<dt>sessions (Session or list): Can be more than one of Object is controlled by</dt><dd><p>more than one Session (MULTISESSION_MODE > 1).</p>
|
||||
<dt>sessions (Session or list): Can be more than one of Object is controlled by more than</dt><dd><p>one Session (MULTISESSION_MODE > 1).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
|
@ -481,7 +468,7 @@ object.</p>
|
|||
</dl>
|
||||
<dl class="simple">
|
||||
<dt>Returns.</dt><dd><dl class="simple">
|
||||
<dt>sessions (Session or list): Can be more than one of Object is controlled by</dt><dd><p>more than one Session (MULTISESSION_MODE > 1).</p>
|
||||
<dt>sessions (Session or list): Can be more than one of Object is controlled by more than</dt><dd><p>one Session (MULTISESSION_MODE > 1).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd>
|
||||
|
|
@ -493,12 +480,13 @@ object.</p>
|
|||
<code class="sig-name descname">sessions_from_csessid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">csessid</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/sessionhandler.html#ServerSessionHandler.sessions_from_csessid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.sessionhandler.ServerSessionHandler.sessions_from_csessid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Given a client identification hash (for session types that offer them)
|
||||
return all sessions with a matching hash.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>csessid</strong> (<em>str</em>) – The session hash.</p>
|
||||
<dl class="simple">
|
||||
<dt>Args</dt><dd><p>csessid (str): The session hash.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p><em>sessions (list)</em> – The sessions with matching .csessid, if any.</p>
|
||||
</dl>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>sessions (list)</em> – The sessions with matching .csessid, if any.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -555,17 +543,17 @@ this class’ <strong>sessionhandler.call_inputfunc</strong> with the
|
|||
<dl class="py method">
|
||||
<dt id="evennia.server.sessionhandler.ServerSessionHandler.call_inputfuncs">
|
||||
<code class="sig-name descname">call_inputfuncs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">session</span></em>, <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/server/sessionhandler.html#ServerSessionHandler.call_inputfuncs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.sessionhandler.ServerSessionHandler.call_inputfuncs" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Split incoming data into its inputfunc counterparts.
|
||||
This should be called by the serversession.data_in
|
||||
as <strong>sessionhandler.call_inputfunc(self, **kwargs)</strong>.</p>
|
||||
<dd><p>Split incoming data into its inputfunc counterparts. This should be
|
||||
called by the <strong>serversession.data_in</strong> as
|
||||
<strong>sessionhandler.call_inputfunc(self, **kwargs)</strong>.</p>
|
||||
<p>We also intercept OOB communication here.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>sessions</strong> (<a class="reference internal" href="evennia.server.session.html#evennia.server.session.Session" title="evennia.server.session.Session"><em>Session</em></a>) – Session.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Keyword Arguments</dt>
|
||||
<dd class="field-even"><p><strong>kwargs</strong> (<em>any</em>) – Incoming data from protocol on
|
||||
the form <strong>{“commandname”: ((args), {kwargs}),…}</strong></p>
|
||||
<dd class="field-even"><p><strong>any</strong> (<em>tuple</em>) – Incoming data from protocol, each
|
||||
on the form <strong>commandname=((args), {kwargs})</strong>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -617,7 +605,6 @@ the form <strong>{“commandname”: ((args), {kwargs}),…}</strong></p>
|
|||
<li><a href="../../0.9.5/api/evennia.server.sessionhandler.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
|
|
@ -634,6 +621,7 @@ the form <strong>{“commandname”: ((args), {kwargs}),…}</strong></p>
|
|||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.server.sessionhandler</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue