Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-20 23:06:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/2.x/api/evennia.contrib.base_systems.godotwebsocket.webclient.html

194 lines
12 KiB
HTML
Raw Normal View History

Updated HTML docs.
2022-12-01 21:58:35 +00:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<title>evennia.contrib.base_systems.godotwebsocket.webclient &#8212; Evennia 2.x documentation</title>
Updated HTML docs.
2022-12-01 21:58:35 +00:00
<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" />
<link rel="next" title="evennia.contrib.base_systems.ingame_python" href="evennia.contrib.base_systems.ingame_python.html" />
<link rel="prev" title="evennia.contrib.base_systems.godotwebsocket.text2bbcode" href="evennia.contrib.base_systems.godotwebsocket.text2bbcode.html" />
</head><body>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
Updated HTML docs.
2022-12-01 21:58:35 +00:00
<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="right" >
<a href="evennia.contrib.base_systems.ingame_python.html" title="evennia.contrib.base_systems.ingame_python"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.godotwebsocket.text2bbcode.html" title="evennia.contrib.base_systems.godotwebsocket.text2bbcode"
accesskey="P">previous</a> |</li>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
Updated HTML docs.
2022-12-01 21:58:35 +00:00
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.base_systems.html" >evennia.contrib.base_systems</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.base_systems.godotwebsocket.html" accesskey="U">evennia.contrib.base_systems.godotwebsocket</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.godotwebsocket.webclient</a></li>
</ul>
Updated HTML docs.
2023-06-10 08:53:19 +00:00
</div>
Updated HTML docs.
2022-12-01 21:58:35 +00:00
<div class="document">
<div class="documentwrapper">
<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>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.godotwebsocket.text2bbcode.html"
title="previous chapter">evennia.contrib.base_systems.godotwebsocket.text2bbcode</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_python.html"
title="next chapter">evennia.contrib.base_systems.ingame_python</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.base_systems.godotwebsocket.webclient.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
Updated HTML docs.
2022-12-01 21:58:35 +00:00
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<h3>Doc Versions</h3>
Updated HTML docs.
2022-12-01 21:58:35 +00:00
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li><a href="evennia.contrib.base_systems.godotwebsocket.webclient.html">2.x (main branch)</a></li>
Updated HTML docs.
2022-12-01 21:58:35 +00:00
<ul>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
Updated HTML docs.
2022-12-01 21:58:35 +00:00
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.base_systems.godotwebsocket.webclient">
<span id="evennia-contrib-base-systems-godotwebsocket-webclient"></span><h1>evennia.contrib.base_systems.godotwebsocket.webclient<a class="headerlink" href="#module-evennia.contrib.base_systems.godotwebsocket.webclient" title="Permalink to this headline"></a></h1>
<p>Godot Websocket - ChrisLR 2022</p>
<p>This file contains the code necessary to dedicate a port to communicate with Godot via Websockets.
It uses the plugin system and should be plugged via settings as detailed in the readme.</p>
<dl class="py class">
<dt id="evennia.contrib.base_systems.godotwebsocket.webclient.GodotWebSocketClient">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.webclient.</code><code class="sig-name descname">GodotWebSocketClient</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/contrib/base_systems/godotwebsocket/webclient.html#GodotWebSocketClient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.godotwebsocket.webclient.GodotWebSocketClient" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.server.portal.webclient.html#evennia.server.portal.webclient.WebSocketClient" title="evennia.server.portal.webclient.WebSocketClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.server.portal.webclient.WebSocketClient</span></code></a></p>
<p>Implements the server-side of the Websocket connection specific to Godot.
It inherits from the basic Websocket implementation and changes only what is necessary.</p>
<dl class="py method">
<dt id="evennia.contrib.base_systems.godotwebsocket.webclient.GodotWebSocketClient.__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/contrib/base_systems/godotwebsocket/webclient.html#GodotWebSocketClient.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.godotwebsocket.webclient.GodotWebSocketClient.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.godotwebsocket.webclient.GodotWebSocketClient.send_text">
<code class="sig-name descname">send_text</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/contrib/base_systems/godotwebsocket/webclient.html#GodotWebSocketClient.send_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.godotwebsocket.webclient.GodotWebSocketClient.send_text" title="Permalink to this definition"></a></dt>
<dd><p>Send text data. This will pre-process the text for
color-replacement, conversion to bbcode etc.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>text</strong> (<em>str</em>) – Text to send.</p>
</dd>
<dt class="field-even">Keyword Arguments</dt>
<dd class="field-even"><p><strong>options</strong> (<em>dict</em>) – Options-dict with the following keys understood:
- nocolor (bool): Clean out all color.
- send_prompt (bool): Send a prompt with parsed bbcode</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt id="evennia.contrib.base_systems.godotwebsocket.webclient.start_plugin_services">
<code class="sig-prename descclassname">evennia.contrib.base_systems.godotwebsocket.webclient.</code><code class="sig-name descname">start_plugin_services</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">portal</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/godotwebsocket/webclient.html#start_plugin_services"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.godotwebsocket.webclient.start_plugin_services" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>
</div>
</div>
</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="right" >
<a href="evennia.contrib.base_systems.ingame_python.html" title="evennia.contrib.base_systems.ingame_python"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.godotwebsocket.text2bbcode.html" title="evennia.contrib.base_systems.godotwebsocket.text2bbcode"
>previous</a> |</li>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
Updated HTML docs.
2022-12-01 21:58:35 +00:00
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.base_systems.html" >evennia.contrib.base_systems</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.base_systems.godotwebsocket.html" >evennia.contrib.base_systems.godotwebsocket</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.godotwebsocket.webclient</a></li>
</ul>
</div>
Updated HTML docs.
2023-10-19 20:22:27 +00:00
Updated HTML docs.
2022-12-01 21:58:35 +00:00
<div class="footer" role="contentinfo">
Updated HTML docs.
2023-10-19 20:22:27 +00:00
&#169; Copyright 2023, The Evennia developer community.
Updated HTML docs.
2022-12-01 21:58:35 +00:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue Copy permalink