Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-07 00:45:22 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs.

Browse source
This commit is contained in:
Evennia docbuilder action 2023-12-20 21:53:26 +00:00
parent 7459519cd4
commit d3d7158540
31 changed files with 164 additions and 106 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/latest/_modules/evennia/contrib/rpg/rpsystem/rpsystem.html
View file

@ -267,7 +267,7 @@
<span class="c1"># The prefix is the (single-character) symbol used to find the start</span>
<span class="c1"># of a object reference, such as /tall (note that</span>
<span class="c1"># the system will understand multi-word references like &#39;/a tall man&#39; too).</span>
<span class="n">_PREFIX</span> <span class="o">=</span> <span class="s2">&quot;/&quot;</span>
<span class="n">_PREFIX</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">settings</span><span class="p">,</span> <span class="s1">&#39;RPSYSTEM_EMOTE_PREFIX&#39;</span><span class="p">,</span> <span class="s2">&quot;/&quot;</span><span class="p">)</span>
<span class="c1"># The num_sep is the (single-character) symbol used to separate the</span>
<span class="c1"># sdesc from the number when trying to separate identical sdescs from</span>
@ -993,11 +993,11 @@
<span class="sd"> emote text</span>
<span class="sd"> Example:</span>
<span class="sd"> emote /me looks around.</span>
<span class="sd"> emote With a flurry /me attacks /tall man with his sword.</span>
<span class="sd"> emote &quot;Hello&quot;, /me says.</span>
<span class="sd"> emote {prefix}me looks around.</span>
<span class="sd"> emote With a flurry {prefix}me attacks {prefix}tall man with his sword.</span>
<span class="sd"> emote &quot;Hello&quot;, {prefix}me says.</span>
<span class="sd"> Describes an event in the world. This allows the use of /ref</span>
<span class="sd"> Describes an event in the world. This allows the use of {prefix}ref</span>
<span class="sd"> markers to replace with the short descriptions or recognized</span>
<span class="sd"> strings of objects in the same room. These will be translated to</span>
<span class="sd"> emotes to match each person seeing it. Use &quot;...&quot; for saying</span>
@ -1011,6 +1011,9 @@
<span class="n">locks</span> <span class="o">=</span> <span class="s2">&quot;cmd:all()&quot;</span>
<span class="n">arg_regex</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<div class="viewcode-block" id="CmdEmote.get_help"><a class="viewcode-back" href="../../../../../api/evennia.contrib.rpg.rpsystem.rpsystem.html#evennia.contrib.rpg.rpsystem.rpsystem.CmdEmote.get_help">[docs]</a> <span class="k">def</span> <span class="nf">get_help</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">caller</span><span class="p">,</span> <span class="n">cmdset</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__doc__</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="n">_PREFIX</span><span class="p">)</span></div>
<div class="viewcode-block" id="CmdEmote.func"><a class="viewcode-back" href="../../../../../api/evennia.contrib.rpg.rpsystem.rpsystem.html#evennia.contrib.rpg.rpsystem.rpsystem.CmdEmote.func">[docs]</a> <span class="k">def</span> <span class="nf">func</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="s2">&quot;Perform the emote.&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">:</span>

11
docs/latest/_modules/evennia/server/portal/webclient.html
View file

@ -156,7 +156,7 @@
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># client will connect with wsurl?csessid&amp;browserid</span>
<span class="c1"># client will connect with wsurl?csessid&amp;page_id&amp;browserid</span>
<span class="n">webarg</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">http_request_uri</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;?&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
<span class="c1"># this may happen for custom webclients not caring for the</span>
@ -170,9 +170,12 @@
<span class="n">logger</span><span class="o">.</span><span class="n">log_trace</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">csessid</span><span class="p">,</span> <span class="o">*</span><span class="n">browserstr</span> <span class="o">=</span> <span class="n">webarg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;&amp;&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="n">browserstr</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">browserstr</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">browserstr</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">csessid</span><span class="p">,</span> <span class="o">*</span><span class="n">cargs</span> <span class="o">=</span> <span class="n">webarg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;&amp;&quot;</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cargs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">browserstr</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">cargs</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">cargs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">page_id</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">cargs</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">browserstr</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">cargs</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">csessid</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_CLIENT_SESSIONS</span><span class="p">(</span><span class="n">session_key</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">csessid</span><span class="p">)</span></div>

35
docs/latest/_modules/evennia/server/portal/webclient_ajax.html
View file

@ -358,6 +358,18 @@
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">html</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="sa">b</span><span class="s2">&quot;csessid&quot;</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">))</span></div>
<div class="viewcode-block" id="AjaxWebClient.get_client_page_id"><a class="viewcode-back" href="../../../../api/evennia.server.portal.webclient_ajax.html#evennia.server.portal.webclient_ajax.AjaxWebClient.get_client_page_id">[docs]</a> <span class="k">def</span> <span class="nf">get_client_page_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Helper to get the client page id out of the request.</span>
<span class="sd"> Args:</span>
<span class="sd"> request (Request): Incoming request object.</span>
<span class="sd"> Returns:</span>
<span class="sd"> csessid (int): The client-page id.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">html</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="sa">b</span><span class="s2">&quot;cuid&quot;</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">))</span></div>
<div class="viewcode-block" id="AjaxWebClient.get_browserstr"><a class="viewcode-back" href="../../../../api/evennia.server.portal.webclient_ajax.html#evennia.server.portal.webclient_ajax.AjaxWebClient.get_browserstr">[docs]</a> <span class="k">def</span> <span class="nf">get_browserstr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get browser-string out of the request.</span>
@ -401,10 +413,10 @@
<div class="viewcode-block" id="AjaxWebClient.client_disconnect"><a class="viewcode-back" href="../../../../api/evennia.server.portal.webclient_ajax.html#evennia.server.portal.webclient_ajax.AjaxWebClient.client_disconnect">[docs]</a> <span class="k">def</span> <span class="nf">client_disconnect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">csessid</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Disconnect session with given csessid.</span>
<span class="sd"> Disconnect session with given id.</span>
<span class="sd"> Args:</span>
<span class="sd"> csessid (int): Session id.</span>
<span class="sd"> csessid (int): Client page+session id.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">csessid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">requests</span><span class="p">:</span>
@ -422,7 +434,8 @@
<span class="sd"> request (Request): Incoming request.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">csessid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_sessid</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="n">session_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_sessid</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="n">page_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_page_id</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="n">browserstr</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_browserstr</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="n">remote_addr</span> <span class="o">=</span> <span class="n">ip_from_request</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
@ -437,9 +450,9 @@
<span class="n">sess</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="bp">self</span>
<span class="n">sess</span><span class="o">.</span><span class="n">init_session</span><span class="p">(</span><span class="s2">&quot;ajax/comet&quot;</span><span class="p">,</span> <span class="n">remote_addr</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">sessionhandler</span><span class="p">)</span>
<span class="n">sess</span><span class="o">.</span><span class="n">csessid</span> <span class="o">=</span> <span class="n">csessid</span>
<span class="n">sess</span><span class="o">.</span><span class="n">csessid</span> <span class="o">=</span> <span class="n">session_id</span><span class="o">+</span><span class="n">page_id</span>
<span class="n">sess</span><span class="o">.</span><span class="n">browserstr</span> <span class="o">=</span> <span class="n">browserstr</span>
<span class="n">csession</span> <span class="o">=</span> <span class="n">_CLIENT_SESSIONS</span><span class="p">(</span><span class="n">session_key</span><span class="o">=</span><span class="n">sess</span><span class="o">.</span><span class="n">csessid</span><span class="p">)</span>
<span class="n">csession</span> <span class="o">=</span> <span class="n">_CLIENT_SESSIONS</span><span class="p">(</span><span class="n">session_key</span><span class="o">=</span><span class="n">session_id</span><span class="p">)</span>
<span class="n">uid</span> <span class="o">=</span> <span class="n">csession</span> <span class="ow">and</span> <span class="n">csession</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;webclient_authenticated_uid&quot;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="k">if</span> <span class="n">uid</span><span class="p">:</span>
<span class="c1"># the client session is already logged in</span>
@ -447,7 +460,7 @@
<span class="n">sess</span><span class="o">.</span><span class="n">logged_in</span> <span class="o">=</span> <span class="kc">True</span>
<span class="c1"># watch for dead links</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_alive</span><span class="p">[</span><span class="n">csessid</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="kc">False</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_alive</span><span class="p">[</span><span class="n">sess</span><span class="o">.</span><span class="n">csessid</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="kc">False</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">keep_alive</span><span class="p">:</span>
<span class="c1"># the keepalive is not running; start it.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">keep_alive</span> <span class="o">=</span> <span class="n">LoopingCall</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_keepalive</span><span class="p">)</span>
@ -461,7 +474,7 @@
<span class="c1"># actually do the connection</span>
<span class="n">sess</span><span class="o">.</span><span class="n">sessionhandler</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">sess</span><span class="p">)</span>
<span class="k">return</span> <span class="n">jsonify</span><span class="p">({</span><span class="s2">&quot;msg&quot;</span><span class="p">:</span> <span class="n">host_string</span><span class="p">,</span> <span class="s2">&quot;csessid&quot;</span><span class="p">:</span> <span class="n">csessid</span><span class="p">})</span></div>
<span class="k">return</span> <span class="n">jsonify</span><span class="p">({</span><span class="s2">&quot;msg&quot;</span><span class="p">:</span> <span class="n">host_string</span><span class="p">,</span> <span class="s2">&quot;csessid&quot;</span><span class="p">:</span> <span class="n">session_id</span><span class="p">})</span></div>
<div class="viewcode-block" id="AjaxWebClient.mode_keepalive"><a class="viewcode-back" href="../../../../api/evennia.server.portal.webclient_ajax.html#evennia.server.portal.webclient_ajax.AjaxWebClient.mode_keepalive">[docs]</a> <span class="k">def</span> <span class="nf">mode_keepalive</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
@ -472,7 +485,7 @@
<span class="sd"> request (Request): Incoming request.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">csessid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_sessid</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="n">csessid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_sessid</span><span class="p">(</span><span class="n">request</span><span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_page_id</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_alive</span><span class="p">[</span><span class="n">csessid</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="kc">False</span><span class="p">)</span>
<span class="k">return</span> <span class="sa">b</span><span class="s1">&#39;&quot;&quot;&#39;</span></div>
@ -485,7 +498,7 @@
<span class="sd"> request (Request): Incoming request.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">csessid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_sessid</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="n">csessid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_sessid</span><span class="p">(</span><span class="n">request</span><span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_page_id</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_alive</span><span class="p">[</span><span class="n">csessid</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="kc">False</span><span class="p">)</span>
<span class="n">cmdarray</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="sa">b</span><span class="s2">&quot;data&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">for</span> <span class="n">sess</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">sessionhandler</span><span class="o">.</span><span class="n">sessions_from_csessid</span><span class="p">(</span><span class="n">csessid</span><span class="p">):</span>
@ -503,7 +516,7 @@
<span class="sd"> request (Request): Incoming request.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">csessid</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="sa">b</span><span class="s2">&quot;csessid&quot;</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">))</span>
<span class="n">csessid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_sessid</span><span class="p">(</span><span class="n">request</span><span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_page_id</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_alive</span><span class="p">[</span><span class="n">csessid</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="kc">False</span><span class="p">)</span>
<span class="n">dataentries</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">databuffer</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">csessid</span><span class="p">)</span>
@ -529,7 +542,7 @@
<span class="sd"> request (Request): Incoming request.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">csessid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_sessid</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="n">csessid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_sessid</span><span class="p">(</span><span class="n">request</span><span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client_page_id</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">sess</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sessionhandler</span><span class="o">.</span><span class="n">sessions_from_csessid</span><span class="p">(</span><span class="n">csessid</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">sess</span><span class="o">.</span><span class="n">sessionhandler</span><span class="o">.</span><span class="n">disconnect</span><span class="p">(</span><span class="n">sess</span><span class="p">)</span>